source: svn/newcon3bcm2_21bu/nexus/extensions/security/avkeyladder/7552/include/nexus_avkeyladder.h

/***************************************************************************
 *     (c)2007-2011 Broadcom Corporation
 *
 *  This program is the proprietary software of Broadcom Corporation and/or its licensors,
 *  and may only be used, duplicated, modified or distributed pursuant to the terms and
 *  conditions of a separate, written license agreement executed between you and Broadcom
 *  (an "Authorized License").  Except as set forth in an Authorized License, Broadcom grants
 *  no license (express or implied), right to use, or waiver of any kind with respect to the
 *  Software, and Broadcom expressly reserves all rights in and to the Software and all
 *  intellectual property rights therein.  IF YOU HAVE NO AUTHORIZED LICENSE, THEN YOU
 *  HAVE NO RIGHT TO USE THIS SOFTWARE IN ANY WAY, AND SHOULD IMMEDIATELY
 *  NOTIFY BROADCOM AND DISCONTINUE ALL USE OF THE SOFTWARE.
 *
 *  Except as expressly set forth in the Authorized License,
 *
 *  1.     This program, including its structure, sequence and organization, constitutes the valuable trade
 *  secrets of Broadcom, and you shall use all reasonable efforts to protect the confidentiality thereof,
 *  and to use this information only in connection with your use of Broadcom integrated circuit products.
 *
 *  2.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
 *  AND WITH ALL FAULTS AND BROADCOM MAKES NO PROMISES, REPRESENTATIONS OR
 *  WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
 *  THE SOFTWARE.  BROADCOM SPECIFICALLY DISCLAIMS ANY AND ALL IMPLIED WARRANTIES
 *  OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE,
 *  LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION
 *  OR CORRESPONDENCE TO DESCRIPTION. YOU ASSUME THE ENTIRE RISK ARISING OUT OF
 *  USE OR PERFORMANCE OF THE SOFTWARE.
 *
 *  3.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, IN NO EVENT SHALL BROADCOM OR ITS
 *  LICENSORS BE LIABLE FOR (i) CONSEQUENTIAL, INCIDENTAL, SPECIAL, INDIRECT, OR
 *  EXEMPLARY DAMAGES WHATSOEVER ARISING OUT OF OR IN ANY WAY RELATING TO YOUR
 *  USE OF OR INABILITY TO USE THE SOFTWARE EVEN IF BROADCOM HAS BEEN ADVISED OF
 *  THE POSSIBILITY OF SUCH DAMAGES; OR (ii) ANY AMOUNT IN EXCESS OF THE AMOUNT
 *  ACTUALLY PAID FOR THE SOFTWARE ITSELF OR U.S. $1, WHICHEVER IS GREATER. THESE
 *  LIMITATIONS SHALL APPLY NOTWITHSTANDING ANY FAILURE OF ESSENTIAL PURPOSE OF
 *  ANY LIMITED REMEDY.
 *
 * $brcm_Workfile: nexus_avkeyladder.h $
 * $brcm_Revision: 2 $
 * $brcm_Date: 5/25/11 11:40a $
 *
 * Module Description:
 *
 * Revision History:
 *
 * $brcm_Log: /nexus/extensions/security/avkeyladder/7422/include/nexus_avkeyladder.h $
 * 
 * 2   5/25/11 11:40a atruong
 * SW7342-341: Support for AV Command chain
 * 
 * 1   1/28/11 5:47p atruong
 * SW7422-235: Enable Nexus Security extension modules for 97422
 *
 ******************************************************************************/

#ifndef NEXUS_AVKEYLADDER_H__
#define NEXUS_AVKEYLADDER_H__

#include "nexus_security_datatypes.h"
#include "nexus_security.h"
#include "nexus_keyladder.h"

#ifdef __cplusplus
extern "C" {
#endif

#define NEXUS_AVKEYLADDER_KEY_DATA_LEN       16
#define NEXUS_AVKEYLADDER_SCD_DATA_LEN           8
#define NEXUS_AVKEYLADDER_CMD_CHAIN_LEN          4


/**
Summary:
This enum defines the sub commands for AVCMD
**/
typedef enum NEXUS_AvKeyLadderSubCmdType
{
    NEXUS_AvKeyLadderSubCmdType_eNoOp       = 0,
    NEXUS_AvKeyLadderSubCmdType_eDecryptEFK = 1,
        NEXUS_AvKeyLadderSubCmdType_eDecryptEPK = 2,
        NEXUS_AvKeyLadderSubCmdType_eDecryptECW = 3,
        NEXUS_AvKeyLadderSubCmdType_eDecryptCID = 4,
        NEXUS_AvKeyLadderSubCmdType_eReadSCN    = 5,
        NEXUS_AvKeyLadderSubCmdType_eLoadCW     = 6,

    NEXUS_AvKeyLadderSubCmdType_eMax

}       NEXUS_AvKeyLadderSubCmdType;

/**
Summary:
This structure provides the parameters for an AV Reset command

Description:
See Also:
NEXUS_AvKeyLadder_AvResetCmd

**/
typedef struct NEXUS_AvKeyLadderAvResetCmdParm 
{
    NEXUS_SecurityOtpId          otpIdSelect;
    uint32_t                     caVendorId;
    NEXUS_SecurityKey2Select     key2Select;
    NEXUS_SecurityRootKeySrc     rootKeySrc;
    bool                         bASKMMode;

}       NEXUS_AvKeyLadderAvResetCmdParm;



/**
Summary:
This function initializes the AV states and logics.

Description: 
This function is normally called once after bootup to reset the AV states and logics.
The chip will not function if this function is called too frequently.

**/

NEXUS_Error NEXUS_AvKeyLadder_AvResetCmd(
    const NEXUS_AvKeyLadderAvResetCmdParm        *pResetCmdParm                 
    );

/**
Summary:
This structure provides the parameters for an AV regular command

Description:
See Also:
NEXUS_AvKeyLadder_AvCmd

**/

typedef struct NEXUS_AvKeyLadderAvCmdParm 
{
        NEXUS_AvKeyLadderSubCmdType             avSubCmd;
        NEXUS_SecurityEngine            cryptoEngine;
        NEXUS_SecurityKeyType           cryptoKeyType;
    NEXUS_SecurityKeyIVType         destIV;
        NEXUS_SecuritySwizzleType       swizzleType;
        unsigned char                   swizzle1Index;
        NEXUS_SecurityKeyMode           keyMode;
        /* AES key ladder - 128-bit CW key is used            */
        /* DES-ECB CA    -   64-bit key is used bit[64-127] */ 
        unsigned char                   encryptedKeyData[NEXUS_AVKEYLADDER_KEY_DATA_LEN];
        unsigned int                    keyDataLen;

}       NEXUS_AvKeyLadderAvCmdParm;


/**
Summary:
This structure defines the output for the AV subcommand NEXUS_AvKeyLadderSubCmdType_eReadSCN

Description:
See Also:
NEXUS_AvKeyLadder_AvCmd

**/

typedef struct NEXUS_AvKeyLadderAvCmdOutput 
{
        unsigned char                   scnData[NEXUS_AVKEYLADDER_SCD_DATA_LEN];
        unsigned int                    scnDataLen;

}       NEXUS_AvKeyLadderAvCmdOutput;



/**
Summary:
This function is used to communicate with the BSP AV module, as defined by DirecTV.

Description:
This function is used to generate a key based on the DIRECTV AV module.  The keys
generated by the AV module are used by both CA and M2M descramblers.  
  -   CA commands :  NEXUS_AvKeyLadderSubCmdType_eDecryptEPK.
                             NEXUS_AvKeyLadderSubCmdType_eDecryptECW.  
  - M2M commands : NEXUS_AvKeyLadderSubCmdType_eDecryptEFK.
                             NEXUS_AvKeyLadderSubCmdType_eDecryptCID.
The following command sequences should be used:
*** Generating CPCW (M2M) ***
NEXUS_AvKeyLadderSubCmdType_eReadSCN,
NEXUS_AvKeyLadderSubCmdType_eDecryptEFK,
NEXUS_AvKeyLadderSubCmdType_eDecryptCID.

*** Generating CW (CA) ***
NEXUS_AvKeyLadderSubCmdType_eReadSCN,
NEXUS_AvKeyLadderSubCmdType_eDecryptEPK,
NEXUS_AvKeyLadderSubCmdType_eDecryptECW.

*** Loading Clear Key ***
NEXUS_AvKeyLadderSubCmdType_eReadSCN,
NEXUS_AvKeyLadderSubCmdType_eLoadCW.


The following parameter settings are currently supported:

NEXUS_SecurityEngine            cryptoEngine
    NEXUS_SecurityEngine_eCA or 
    NEXUS_SecurityEngine_eM2m

NEXUS_SecurityKeyType           cryptoKeyType
    NEXUS_SecurityKeyType_eEven or
    NEXUS_SecurityKeyType_eOdd

NEXUS_SecuritySwizzleType       swizzleType
    NEXUS_SecuritySwizzleType_eNone

unsigned char                          swizzle1Index
    Not used

NEXUS_SecurityKeySlotType       caKeySlotType
    Any type except NEXUS_SecurityKeySlotType_eType6

NEXUS_SecurityKeyMode           keyMode
    NEXUS_SecurityKeyMode_eRegular or
    NEXUS_SecurityKeyMode_eDes56  or
    NEXUS_SecurityKeyMode_eDvbConformance

SCN Identifier (OTP A ID) is returned only for AVCMD subcommand 
NEXUS_AvKeyLadderSubCmdType_eReadSCN
as pAvCmdDataOutput->scnData[].

**/
NEXUS_Error NEXUS_AvKeyLadder_AvCmd(
        NEXUS_KeySlotHandle                                     keyHandle,
    const NEXUS_AvKeyLadderAvCmdParm    *pAvCmd,
    NEXUS_AvKeyLadderAvCmdOutput                *pAvCmdDataOutput   /* [out] */
    );


typedef struct NEXUS_AvKeyLadderAvCmdChain 
{
    int                             cmdCount;
    NEXUS_KeySlotHandle             keyHandle[NEXUS_AVKEYLADDER_CMD_CHAIN_LEN];
    NEXUS_AvKeyLadderAvCmdParm      avCmdParm[NEXUS_AVKEYLADDER_CMD_CHAIN_LEN];

}       NEXUS_AvKeyLadderAvCmdChain;


typedef struct NEXUS_AvKeyLadderAvCmdChainOutput 
{
    int                                 respCount;
    NEXUS_AvKeyLadderAvCmdOutput        avCmdOutput[NEXUS_AVKEYLADDER_CMD_CHAIN_LEN];

}       NEXUS_AvKeyLadderAvCmdChainOutput;



NEXUS_Error NEXUS_AvKeyLadder_AvCmdChain(
    const NEXUS_AvKeyLadderAvCmdChain       *pAvCmdChain,
    NEXUS_AvKeyLadderAvCmdChainOutput       *pAvCmdChainOutput   /* [out] */
    );


#ifdef __cplusplus
}
#endif

#endif