CryptoCC26XX.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2018, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_drivers_crypto_CryptoCC26XX__include
#define ti_drivers_crypto_CryptoCC26XX__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>

#include <ti/drivers/Power.h>

#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(driverlib/crypto.h)

#if DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X2_CC26X2
    #warning "This driver is deprecated for the CC26x2 and CC13x2 families.\
              It is superceded by AESECB and AESCCM."
#endif

/* Add CryptoCC26XX_STATUS_* macros here */

/* Add CryptoCC26XX_CMD_* macros here */

#define CRYPTOCC26XX_TIMEOUT 20 
#define CRYPTOCC26XX_STATUS_SUCCESS        0  
#define CRYPTOCC26XX_STATUS_ERROR         -1  
#define CRYPTOCC26XX_STATUS_UNDEFINEDCMD  -2  
#define CRYPTOCC26XX_OP_AES_CCM_ENCRYPT             0   
#define CRYPTOCC26XX_OP_AES_CCM_ENCRYPT_AAD_ONLY    1   
#define CRYPTOCC26XX_OP_AES_CCM_DECRYPT             2   
#define CRYPTOCC26XX_OP_AES_CCM_DECRYPT_AAD_ONLY    3   
#define CRYPTOCC26XX_OP_AES_ECB_ENCRYPT             4   
#define CRYPTOCC26XX_OP_AES_ECB_DECRYPT             5   
#define CRYPTOCC26XX_OP_AES_CBC_ENCRYPT             6   
#define CRYPTOCC26XX_OP_AES_CBC_DECRYPT             7   
/* Deprecated operation mode names */
#define CRYPTOCC26XX_OP_AES_CCM                 CRYPTOCC26XX_OP_AES_CCM_ENCRYPT
#define CRYPTOCC26XX_OP_AES_CCM_NOCRYPT         CRYPTOCC26XX_OP_AES_CCM_ENCRYPT_AAD_ONLY
#define CRYPTOCC26XX_OP_AES_CCMINV              CRYPTOCC26XX_OP_AES_CCM_DECRYPT
#define CRYPTOCC26XX_OP_AES_CCMINV_NOCRYPT      CRYPTOCC26XX_OP_AES_CCM_DECRYPT_AAD_ONLY
#define CRYPTOCC26XX_OP_AES_ECB                 CRYPTOCC26XX_OP_AES_ECB_ENCRYPT
#define CRYPTOCC26XX_OP_AES_ECB_NOCRYPT         CRYPTOCC26XX_OP_AES_ECB_DECRYPT


#include <ti/drivers/dpl/HwiP.h>
#include <ti/drivers/dpl/SemaphoreP.h>

typedef struct CryptoCC26XX_Config      *CryptoCC26XX_Handle;

typedef enum CryptoCC26XX_Mode {
    CRYPTOCC26XX_MODE_BLOCKING,

    CRYPTOCC26XX_MODE_POLLING
} CryptoCC26XX_Mode;

typedef uint8_t CryptoCC26XX_Operation;

typedef enum CryptoCC26XX_KeyLocation {
    CRYPTOCC26XX_KEY_0 = 0,
    CRYPTOCC26XX_KEY_1,
    CRYPTOCC26XX_KEY_2,
    CRYPTOCC26XX_KEY_3,
    CRYPTOCC26XX_KEY_4,
    CRYPTOCC26XX_KEY_5,
    CRYPTOCC26XX_KEY_6,
    CRYPTOCC26XX_KEY_7,
    CRYPTOCC26XX_KEY_COUNT,
    CRYPTOCC26XX_KEY_ANY,
} CryptoCC26XX_KeyLocation;

typedef struct CryptoCC26XX_Params {
    uint32_t        timeout;  
} CryptoCC26XX_Params;

typedef uint8_t CryptoCC26XX_KeyStore;

typedef struct CryptoCC26XX_Transaction {
    CryptoCC26XX_Operation    opType;          
    CryptoCC26XX_Mode         mode;            
    uint8_t                   data[];          
} CryptoCC26XX_Transaction;

typedef struct CryptoCC26XX_AESCCM_Transaction {
    CryptoCC26XX_Operation  opType;         
    CryptoCC26XX_Mode       mode;           
    uint8_t                 keyIndex;       
    uint8_t                 authLength;     
    char                   *nonce;          
    char                   *msgIn;          
    char                   *header;         
    void                   *msgOut;         
    uint8_t                 fieldLength;    
    uint16_t                msgInLength;    
    uint16_t                headerLength;   
} CryptoCC26XX_AESCCM_Transaction;

typedef struct CryptoCC26XX_AESCBC_Transaction {
    CryptoCC26XX_Operation  opType;         
    CryptoCC26XX_Mode       mode;           
    uint8_t                 keyIndex;       
    void                    *nonce;         
    void                    *msgIn;         
    void                    *msgOut;        
    uint16_t                msgInLength;    
} CryptoCC26XX_AESCBC_Transaction;

typedef struct CryptoCC26XX_AESECB_Transaction {
    CryptoCC26XX_Operation    opType;    
    CryptoCC26XX_Mode         mode;      
    uint8_t                   keyIndex;  
    void                     *msgIn;     
    void                     *msgOut;    
} CryptoCC26XX_AESECB_Transaction;

typedef struct CryptoCC26XX_HWAttrs {
    uint32_t   baseAddr;
    int        powerMngrId;
    int        intNum;
    uint8_t    intPriority;
} CryptoCC26XX_HWAttrs;

typedef struct CryptoCC26XX_Object {
    /* CryptoCC26XX control variables */
    int                       openCnt;          
    uint32_t                  timeout;          
    CryptoCC26XX_KeyStore     keyStore;         
    CryptoCC26XX_Transaction *currentTransact;  
    /* Crypto transaction pointers for CryptoCC26XX_MODE_CALLBACK */
    CryptoCC26XX_Transaction *headPtr;          
    CryptoCC26XX_Transaction *tailPtr;          
    Power_NotifyObj           cryptoNotiObj;

    /* CryptoCC26XX SYS/BIOS objects */
    HwiP_Struct hwi;      
    SemaphoreP_Struct                    transSem; 
    SemaphoreP_Struct                    waitSem;  
} CryptoCC26XX_Object;

typedef struct CryptoCC26XX_Config {
    void                   *object;

    void          const    *hwAttrs;
} CryptoCC26XX_Config;

int CryptoCC26XX_close(CryptoCC26XX_Handle handle);

void CryptoCC26XX_init(void);

CryptoCC26XX_Handle CryptoCC26XX_open(unsigned int index, bool exclusiveAccess, CryptoCC26XX_Params *params);

void CryptoCC26XX_Params_init(CryptoCC26XX_Params *params);

void CryptoCC26XX_Transac_init(CryptoCC26XX_Transaction *trans, CryptoCC26XX_Operation opType);

int CryptoCC26XX_allocateKey(CryptoCC26XX_Handle handle, CryptoCC26XX_KeyLocation keyLocation, const uint32_t *keySrc);


int CryptoCC26XX_loadKey(CryptoCC26XX_Handle handle, int keyIndex, const uint32_t *keySrc);

int CryptoCC26XX_releaseKey(CryptoCC26XX_Handle handle, int *keyIndex);

int CryptoCC26XX_transact(CryptoCC26XX_Handle handle, CryptoCC26XX_Transaction *transaction);

int CryptoCC26XX_transactPolling(CryptoCC26XX_Handle handle, CryptoCC26XX_Transaction *transaction);

int CryptoCC26XX_transactCallback(CryptoCC26XX_Handle handle, CryptoCC26XX_Transaction *transaction);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_crypto_CryptoCC26XX__include */