TI BLE5-Stack API Documentation  1.00.01.04
ECCROMCC26XX.h
Go to the documentation of this file.
1 /******************************************************************************
2 
3  @file ECCROMCC26XX.h
4 
5  @brief This file contains the interface to the ECC in ROM Driver.
6 
7  Group: WCS, BTS
8  $Target Device: DEVICES $
9 
10  ******************************************************************************
11  $License: BSD3 2016 $
12  ******************************************************************************
13  $Release Name: PACKAGE NAME $
14  $Release Date: PACKAGE RELEASE DATE $
15  *****************************************************************************/
16 
195 #ifndef ti_drivers_ECCROMCC26XX__include
196 #define ti_drivers_ECCROMCC26XX__include
197 
198 #ifdef __cplusplus
199 extern "C" {
200 #endif
201 
202 #include <stdint.h>
203 
209 /* Add ECCROMCC26XX_STATUS_* macros here */
210 #define ECCROMCC26XX_STATUS_SUCCESS 0
211 #define ECCROMCC26XX_STATUS_MALLOC_FAIL -1
212 #define ECCROMCC26XX_STATUS_ILLEGAL_PARAM -2
213 #define ECCROMCC26XX_STATUS_TIMEOUT -3
215 /* ECC status error codes from module */
216 #define ECCROMCC26XX_STATUS_MODULUS_EVEN 0xDC
217 #define ECCROMCC26XX_STATUS_MODULUS_LARGER_THAN_255_WORDS 0xD2
218 #define ECCROMCC26XX_STATUS_MODULUS_LENGTH_ZERO 0x08
219 #define ECCROMCC26XX_STATUS_MODULUS_MSW_IS_ZERO 0x30
220 #define ECCROMCC26XX_STATUS_SCALAR_TOO_LONG 0x35
221 #define ECCROMCC26XX_STATUS_SCALAR_LENGTH_ZERO 0x53
222 #define ECCROMCC26XX_STATUS_ORDER_TOO_LONG 0xC6
223 #define ECCROMCC26XX_STATUS_ORDER_LENGTH_ZERO 0x6C
224 #define ECCROMCC26XX_STATUS_X_COORD_TOO_LONG 0x3C
225 #define ECCROMCC26XX_STATUS_X_COORD_LENGTH_ZERO 0xC3
226 #define ECCROMCC26XX_STATUS_Y_COORD_TOO_LONG 0x65
227 #define ECCROMCC26XX_STATUS_Y_COORD_LENGTH_ZERO 0x56
228 #define ECCROMCC26XX_STATUS_A_COEF_TOO_LONG 0x5C
229 #define ECCROMCC26XX_STATUS_A_COEF_LENGTH_ZERO 0xC5
230 #define ECCROMCC26XX_STATUS_BAD_WINDOW_SIZE 0x66
231 #define ECCROMCC26XX_STATUS_SCALAR_MUL_OK 0x99
233 #define ECCROMCC26XX_STATUS_ORDER_LARGER_THAN_255_WORDS 0x28
234 #define ECCROMCC26XX_STATUS_ORDER_EVEN 0x82
235 #define ECCROMCC26XX_STATUS_ORDER_MSW_IS_ZERO 0x23
236 #define ECCROMCC26XX_STATUS_ECCROMCC26XX_STATUS_KEY_TOO_LONG 0x25
237 #define ECCROMCC26XX_STATUS_ECCROMCC26XX_STATUS_KEY_LENGTH_ZERO 0x52
238 #define ECCROMCC26XX_STATUS_DIGEST_TOO_LONG 0x27
239 #define ECCROMCC26XX_STATUS_DIGEST_LENGTH_ZERO 0x72
240 #define ECCROMCC26XX_STATUS_ECDSA_SIGN_OK 0x32
241 #define ECCROMCC26XX_STATUS_ECDSA_INVALID_SIGNATURE 0x5A
242 #define ECCROMCC26XX_STATUS_ECDSA_VALID_SIGNATURE 0xA5
243 #define ECCROMCC26XX_STATUS_SIG_P1_TOO_LONG 0x11
244 #define ECCROMCC26XX_STATUS_SIG_P1_LENGTH_ZERO 0x12
245 #define ECCROMCC26XX_STATUS_SIG_P2_TOO_LONG 0x22
246 #define ECCROMCC26XX_STATUS_SIG_P2_LENGTH_ZERO 0x21
248 #define ECCROMCC26XX_STATUS_ECDH_KEYGEN_OK ECCROMCC26XX_STATUS_SCALAR_MUL_OK
249 #define ECCROMCC26XX_STATUS_ECDH_COMMON_KEY_OK ECCROMCC26XX_STATUS_SCALAR_MUL_OK
257 #define ECCROMCC26XX_NIST_P256_WORKZONE_LEN_IN_BYTES 684
258 
262 #define ECCROMCC26XX_NIST_P256_KEY_LEN_IN_BYTES 32
263 
273 #define ECCROMCC26XX_WORKZONE_LEN_IN_BYTES(len, win) (4 * ((13 * (len)) + 13 + (3 * (len) * (1 << ((win) - 2)))))
274 
282 {
283  uint8_t keyLen;
284  uint16_t workzoneLen;
285  uint8_t windowSize;
286  uint32_t *param_p;
287  uint32_t *param_r;
288  uint32_t *param_a;
289  uint32_t *param_b;
290  uint32_t *param_gx;
291  uint32_t *param_gy;
293 
303 typedef uint8_t *(*ECCROMCC26XX_MallocCB)(uint16_t len);
304 
314 typedef void (*ECCROMCC26XX_FreeCB)(uint8_t *pBuf);
315 
321 typedef struct ECCROMCC26XX_Params {
325  uint32_t timeout;
326  int8_t status;
328 
337 void ECCROMCC26XX_init(void);
338 
353 
384 int8_t ECCROMCC26XX_genKeys(uint8_t *privateKey, uint8_t *publicKeyX,
385  uint8_t *publicKeyY, ECCROMCC26XX_Params *params);
386 
424 int8_t ECCROMCC26XX_genDHKey(uint8_t *privateKey, uint8_t *publicKeyX,
425  uint8_t *publicKeyY, uint8_t *dHKeyX,
426  uint8_t *dHKeyY, ECCROMCC26XX_Params *params);
427 
428 #ifdef __cplusplus
429 }
430 #endif
431 
432 #endif /* ti_drivers_ECCROMCC26XX__include */
433 
ECCROMCC26XX Parameters.
Definition: ECCROMCC26XX.h:321
struct ECCROMCC26XX_CurveParams ECCROMCC26XX_CurveParams
ECCROMCC26XX Curve Parameters.
uint32_t * param_gy
Definition: ECCROMCC26XX.h:291
int8_t status
Definition: ECCROMCC26XX.h:326
uint8_t windowSize
Definition: ECCROMCC26XX.h:285
void ECCROMCC26XX_Params_init(ECCROMCC26XX_Params *params)
Function to initialize the ECCROMCC26XX_Params struct to its defaults. params should not be modified ...
ECCROMCC26XX_MallocCB malloc
Definition: ECCROMCC26XX.h:323
uint32_t * param_r
Definition: ECCROMCC26XX.h:287
struct ECCROMCC26XX_Params ECCROMCC26XX_Params
ECCROMCC26XX Parameters.
uint32_t * param_a
Definition: ECCROMCC26XX.h:288
int8_t ECCROMCC26XX_genKeys(uint8_t *privateKey, uint8_t *publicKeyX, uint8_t *publicKeyY, ECCROMCC26XX_Params *params)
Generate Public Key X and Y Coordinates.
uint32_t * param_gx
Definition: ECCROMCC26XX.h:290
uint16_t workzoneLen
Definition: ECCROMCC26XX.h:284
ECCROMCC26XX_CurveParams curve
Definition: ECCROMCC26XX.h:322
void ECCROMCC26XX_init(void)
Initializes module&#39;s synchronization resources. Only needs to be called once, but safe to call multip...
uint32_t timeout
Definition: ECCROMCC26XX.h:325
void(* ECCROMCC26XX_FreeCB)(uint8_t *pBuf)
ECCROMCC26XX Free Callback.
Definition: ECCROMCC26XX.h:314
ECCROMCC26XX_FreeCB free
Definition: ECCROMCC26XX.h:324
ECCROMCC26XX Curve Parameters.
Definition: ECCROMCC26XX.h:281
uint32_t * param_b
Definition: ECCROMCC26XX.h:289
uint32_t * param_p
Definition: ECCROMCC26XX.h:286
uint8_t keyLen
Definition: ECCROMCC26XX.h:283
int8_t ECCROMCC26XX_genDHKey(uint8_t *privateKey, uint8_t *publicKeyX, uint8_t *publicKeyY, uint8_t *dHKeyX, uint8_t *dHKeyY, ECCROMCC26XX_Params *params)
Generate Diffie-Hellman Shared Secret Key X and Y Coordinates.
uint8_t *(* ECCROMCC26XX_MallocCB)(uint16_t len)
ECCROMCC26XX Malloc Callback.
Definition: ECCROMCC26XX.h:303
Copyright 2017, Texas Instruments Incorporated