source: svn/newcon3bcm2_21bu/nexus/extensions/security/nsk2avk/7552/include/nexus_nsk2avk.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_nsk2avk.h $
 * $brcm_Revision: 1 $
 * $brcm_Date: 9/21/11 1:33p $
 *
 * Module Description:
 *
 * Revision History:
 *
 * $brcm_Log: /nexus/extensions/security/nsk2avk/7422/include/nexus_nsk2avk.h $
 * 
 * 1   9/21/11 1:33p atruong
 * SW7346-495: Add NSK2AVK support
 * 
 *
 ******************************************************************************/

#ifndef NEXUS_NSK2AVK_H__
#define NEXUS_NSK2AVK_H__

#include "nexus_security_datatypes.h"
#include "nexus_security.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

#ifndef NEXUS_KEYLADDER_H__
/**
Summary:
This enum defines the supported root key sources.
**/
typedef enum NEXUS_SecurityRootKeySrc
{
    NEXUS_SecurityRootKeySrc_eCuskey,
    NEXUS_SecurityRootKeySrc_eOtpKeyA,
    NEXUS_SecurityRootKeySrc_eOtpKeyB,
    NEXUS_SecurityRootKeySrc_eOtpKeyC,
                NEXUS_SecurityRootKeySrc_eOtpKeyD,
                NEXUS_SecurityRootKeySrc_eOtpKeyE,
                NEXUS_SecurityRootKeySrc_eOtpKeyF,
    NEXUS_SecurityRootKeySrc_eReserved0,
    NEXUS_SecurityRootKeySrc_eReserved1,
    NEXUS_SecurityRootKeySrc_eReserved2,

    /* Add new key entry type definition before this line */
    NEXUS_SecurityRootKeySrc_eMax
}   NEXUS_SecurityRootKeySrc;

/**
Summary:
This enum defines the supported swizzle types.
**/
typedef enum NEXUS_SecuritySwizzleType
{
    NEXUS_SecuritySwizzleType_eNone,
    NEXUS_SecuritySwizzleType_eSwizzle1,
    NEXUS_SecuritySwizzleType_eSwizzle0,

    /* Add new swizzle type definition before this line */
    NEXUS_SecuritySwizzleType_eMax
}   NEXUS_SecuritySwizzleType;

/**
Summary:
This enum defines the supported swizzle types.
**/
typedef enum NEXUS_SecurityKeyMode
{
    NEXUS_SecurityKeyMode_eRegular,
    NEXUS_SecurityKeyMode_eDes56,
    NEXUS_SecurityKeyMode_eReserved2,
    NEXUS_SecurityKeyMode_eReserved3,
    NEXUS_SecurityKeyMode_eDvbConformance,

    /* Add new swizzle type definition before this line */
    NEXUS_SecurityKeyMode_eMax
}   NEXUS_SecurityKeyMode;
#endif  /* NEXUS_KEYLADDER_H__ */       

typedef enum NEXUS_NSK2AVK_SPROFILE
{
        NEXUS_NSK2AVK_SPROFILE_eA3                                                      =       100,
        NEXUS_NSK2AVK_SPROFILE_eDes                                                     = 101,

        NEXUS_NSK2AVK_SPROFILE_MAX 
} NEXUS_NSK2AVK_SPROFILE;

typedef enum NEXUS_NSK2AVK_M2M_SPROFILE
{                                
        NEXUS_NSK2AVK_M2M_SPROFILE_eDES_ECB_CLR_CLR     =0x13, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eDES_CBC_SCTE52_IV2  =0x14, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eDES_CBC_SCTE52_IV1  =0x15, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eDES_CBC_CLR_CLR     =0x19, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eTDES_ECB_CLR_CLR    =0x25, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eTDES_CBC_SCTE52_IV2 =0x26, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eTDES_CBC_SCTE52_IV1 =0x27, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eTDES_CBC_CLR_CLR    =0x2B, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eAES_ECB_CLR_CLR     =0x36, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eAES_CTR             =0x40, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eAES_CBC_CTS_IV2     =0x37, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eAES_CBC_CTS_CLR     =0x39, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eAES_CBC_SCTE52_IV2  =0x3A, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eAES_CBC_SCTE52_CLR  =0x3C, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eAES_CBC_CLR_CLR     =0x3F, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eRC4                 =0x50, 
        NEXUS_NSK2AVK_M2M_SPROFILE_eMax 
} NEXUS_NSK2AVK_M2M_SPROFILE;         

typedef enum NEXUS_NSK2AVK_EsaCode
{
    NEXUS_NSK2AVK_EsaCode_eAes                                                  = 0,
    NEXUS_NSK2AVK_EsaCode_eDvbCsa2                                      = 1,
    NEXUS_NSK2AVK_EsaCode_eDes                                                  = 2,
    NEXUS_NSK2AVK_EsaCode_e3Des                                                 = 3,
    NEXUS_NSK2AVK_EsaCode_eMulti2                                               = 4,
    NEXUS_NSK2AVK_EsaCode_eDvbCsa2Conformance     = 5,
    NEXUS_NSK2AVK_EsaCode_eDvbCsa3                                      = 6

} NEXUS_NSK2AVK_EsaCode;

typedef enum NEXUS_NSK2AVK_EsaSubSelectCode
{
    NEXUS_NSK2AVK_EsaSubSelectCode_eLSACBCMDI                                   = 0,
    NEXUS_NSK2AVK_EsaSubSelectCode_eSYNAMEDIAAES        = 1,
    NEXUS_NSK2AVK_EsaSubSelectCode_eA3                                                  = 2,
    NEXUS_NSK2AVK_EsaSubSelectCode_eAESECBClearTail             = 3,
    NEXUS_NSK2AVK_EsaSubSelectCode_eAESCBCCIPlus                = 4,
    NEXUS_NSK2AVK_EsaSubSelectCode_eReserved5                                   = 5,
    NEXUS_NSK2AVK_EsaSubSelectCode_eOther                                                       = 6,
    NEXUS_NSK2AVK_EsaSubSelectCode_eAny                                                         = 7
} NEXUS_NSK2AVK_EsaSubSelectCode;

typedef enum NEXUS_NSK2AVK_InlineCode_e
{
    NEXUS_NSK2AVK_InlineCode_eLSACBCMDI_MSC4            = 0,
    NEXUS_NSK2AVK_InlineCode_eLSACBCMDI_MSC18           = 1,
    NEXUS_NSK2AVK_InlineCode_eLSACBCMDD_MSC4            = 2,
    NEXUS_NSK2AVK_InlineCode_eLSACBCMDD_MSC18           = 3,
    NEXUS_NSK2AVK_InlineCode_eLSARCBCMDI                                = 4,
    NEXUS_NSK2AVK_InlineCode_eLSARCBCMDD                                = 6,
    NEXUS_NSK2AVK_InlineCode_eAESECB_MSC12_18           = 8,
    NEXUS_NSK2AVK_InlineCode_eAESECB_MSC28_2            = 9,
    NEXUS_NSK2AVK_InlineCode_eAESECBClearTail           = 0xC

} NEXUS_NSK2AVK_InlineCode;

typedef enum NEXUS_NSK2AVK_CMCHANNEL_PARITY
{
        NEXUS_NSK2AVK_CMCHANNEL_PARITY_eCLEAR            = 0x01U,                       /*!< @brief the key can be set for the clear parity */                    
        NEXUS_NSK2AVK_CMCHANNEL_PARITY_eEVEN             = 0x02U,                       /*!< @brief the key can be set for the even parity */                     
        NEXUS_NSK2AVK_CMCHANNEL_PARITY_eEVEN_CLEAR       = 0x04U,                       /*!< @brief the same key can be set for the clear  and even parity */     
        NEXUS_NSK2AVK_CMCHANNEL_PARITY_eODD              = 0x08U,                       /*!< @brief the key can be set for the odd parity */                      
        NEXUS_NSK2AVK_CMCHANNEL_PARITY_eODD_CLEAR        = 0x10U,                       /*!< @brief the same key can be set for the clear and odd parity */       
        NEXUS_NSK2AVK_CMCHANNEL_PARITY_eODD_EVEN         = 0x20U,                       /*!< @brief the same key can be set for the odd and even parity */        
        NEXUS_NSK2AVK_CMCHANNEL_PARITY_eODD_EVEN_CLEAR   = 0x40U                        /*!< @brief the same key can be set for the clear, odd and even  parity */
} NEXUS_NSK2AVK_CMCHANNEL_PARITY;


typedef enum NEXUS_NSK2AVK_SC_VALUE
{
        NEXUS_NSK2AVK_SC_VALUE_eCLEAR           = 0x00,
        NEXUS_NSK2AVK_SC_VALUE_eEVEN            = 0x02,
        NEXUS_NSK2AVK_SC_VALUE_eODD             = 0x03
} NEXUS_NSK2AVK_SC_VALUE;

typedef enum NEXUS_NSK2AVK_CmChannel_Destination
{
    NEXUS_NSK2AVK_CmChannel_Destination_eCPD  = 0,
                NEXUS_NSK2AVK_CmChannel_Destination_eCA,                        
    NEXUS_NSK2AVK_CmChannel_Destination_eCPS,               
    NEXUS_NSK2AVK_CmChannel_Destination_eMax
} NEXUS_NSK2AVK_CmChannel_Destination;

/**
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 or
    NEXUS_SecurityKeyType_eClear

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