stm32l4xx_hal_pka.h 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568
  1. /**
  2. ******************************************************************************
  3. * @file stm32l4xx_hal_pka.h
  4. * @author MCD Application Team
  5. * @brief Header file of PKA HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * Copyright (c) 2017 STMicroelectronics.
  10. * All rights reserved.
  11. *
  12. * This software is licensed under terms that can be found in the LICENSE file
  13. * in the root directory of this software component.
  14. * If no LICENSE file comes with this software, it is provided AS-IS.
  15. *
  16. ******************************************************************************
  17. */
  18. /* Define to prevent recursive inclusion -------------------------------------*/
  19. #ifndef STM32L4xx_HAL_PKA_H
  20. #define STM32L4xx_HAL_PKA_H
  21. #ifdef __cplusplus
  22. extern "C" {
  23. #endif
  24. /* Includes ------------------------------------------------------------------*/
  25. #include "stm32l4xx_hal_def.h"
  26. /** @addtogroup STM32L4xx_HAL_Driver
  27. * @{
  28. */
  29. #if defined(PKA) && defined(HAL_PKA_MODULE_ENABLED)
  30. /** @addtogroup PKA
  31. * @{
  32. */
  33. /* Exported types ------------------------------------------------------------*/
  34. /** @defgroup PKA_Exported_Types PKA Exported Types
  35. * @{
  36. */
  37. /** @defgroup HAL_state_structure_definition HAL state structure definition
  38. * @brief HAL State structures definition
  39. * @{
  40. */
  41. typedef enum
  42. {
  43. HAL_PKA_STATE_RESET = 0x00U, /*!< PKA not yet initialized or disabled */
  44. HAL_PKA_STATE_READY = 0x01U, /*!< PKA initialized and ready for use */
  45. HAL_PKA_STATE_BUSY = 0x02U, /*!< PKA internal processing is ongoing */
  46. HAL_PKA_STATE_ERROR = 0x03U, /*!< PKA error state */
  47. }
  48. HAL_PKA_StateTypeDef;
  49. /**
  50. * @}
  51. */
  52. #if (USE_HAL_PKA_REGISTER_CALLBACKS == 1)
  53. /** @defgroup HAL_callback_id HAL callback ID enumeration
  54. * @{
  55. */
  56. typedef enum
  57. {
  58. HAL_PKA_OPERATION_COMPLETE_CB_ID = 0x00U, /*!< PKA End of operation callback ID */
  59. HAL_PKA_ERROR_CB_ID = 0x01U, /*!< PKA Error callback ID */
  60. HAL_PKA_MSPINIT_CB_ID = 0x02U, /*!< PKA Msp Init callback ID */
  61. HAL_PKA_MSPDEINIT_CB_ID = 0x03U /*!< PKA Msp DeInit callback ID */
  62. } HAL_PKA_CallbackIDTypeDef;
  63. /**
  64. * @}
  65. */
  66. #endif /* USE_HAL_PKA_REGISTER_CALLBACKS */
  67. /** @defgroup PKA_Error_Code_definition PKA Error Code definition
  68. * @brief PKA Error Code definition
  69. * @{
  70. */
  71. #define HAL_PKA_ERROR_NONE (0x00000000U)
  72. #define HAL_PKA_ERROR_ADDRERR (0x00000001U)
  73. #define HAL_PKA_ERROR_RAMERR (0x00000002U)
  74. #define HAL_PKA_ERROR_TIMEOUT (0x00000004U)
  75. #define HAL_PKA_ERROR_OPERATION (0x00000008U)
  76. #if (USE_HAL_PKA_REGISTER_CALLBACKS == 1)
  77. #define HAL_PKA_ERROR_INVALID_CALLBACK (0x00000010U) /*!< Invalid Callback error */
  78. #endif /* USE_HAL_PKA_REGISTER_CALLBACKS */
  79. /**
  80. * @}
  81. */
  82. /** @defgroup PKA_handle_Structure_definition PKA handle Structure definition
  83. * @brief PKA handle Structure definition
  84. * @{
  85. */
  86. #if (USE_HAL_PKA_REGISTER_CALLBACKS == 1)
  87. typedef struct __PKA_HandleTypeDef
  88. #else
  89. typedef struct
  90. #endif /* USE_HAL_PKA_REGISTER_CALLBACKS */
  91. {
  92. PKA_TypeDef *Instance; /*!< Register base address */
  93. __IO HAL_PKA_StateTypeDef State; /*!< PKA state */
  94. __IO uint32_t ErrorCode; /*!< PKA Error code */
  95. #if (USE_HAL_PKA_REGISTER_CALLBACKS == 1)
  96. void (* OperationCpltCallback)(struct __PKA_HandleTypeDef *hpka); /*!< PKA End of operation callback */
  97. void (* ErrorCallback)(struct __PKA_HandleTypeDef *hpka); /*!< PKA Error callback */
  98. void (* MspInitCallback)(struct __PKA_HandleTypeDef *hpka); /*!< PKA Msp Init callback */
  99. void (* MspDeInitCallback)(struct __PKA_HandleTypeDef *hpka); /*!< PKA Msp DeInit callback */
  100. #endif /* USE_HAL_PKA_REGISTER_CALLBACKS */
  101. } PKA_HandleTypeDef;
  102. /**
  103. * @}
  104. */
  105. #if (USE_HAL_PKA_REGISTER_CALLBACKS == 1)
  106. /** @defgroup PKA_Callback_definition PKA Callback pointer definition
  107. * @brief PKA Callback pointer definition
  108. * @{
  109. */
  110. typedef void (*pPKA_CallbackTypeDef)(PKA_HandleTypeDef *hpka); /*!< Pointer to a PKA callback function */
  111. /**
  112. * @}
  113. */
  114. #endif /* USE_HAL_PKA_REGISTER_CALLBACKS */
  115. /** @defgroup PKA_Operation PKA operation structure definition
  116. * @brief Input and output data definition
  117. * @{
  118. */
  119. typedef struct
  120. {
  121. uint32_t scalarMulSize; /*!< Number of element in scalarMul array */
  122. uint32_t modulusSize; /*!< Number of element in modulus, coefA, pointX and pointY arrays */
  123. uint32_t coefSign; /*!< Curve coefficient a sign */
  124. const uint8_t *coefA; /*!< Pointer to curve coefficient |a| (Array of modulusSize elements) */
  125. const uint8_t *modulus; /*!< Pointer to curve modulus value p (Array of modulusSize elements) */
  126. const uint8_t *pointX; /*!< Pointer to point P coordinate xP (Array of modulusSize elements) */
  127. const uint8_t *pointY; /*!< Pointer to point P coordinate yP (Array of modulusSize elements) */
  128. const uint8_t *scalarMul; /*!< Pointer to scalar multiplier k (Array of scalarMulSize elements) */
  129. const uint32_t *pMontgomeryParam; /*!< Pointer to Montgomery parameter (Array of modulusSize/4 elements) */
  130. } PKA_ECCMulFastModeInTypeDef;
  131. typedef struct
  132. {
  133. uint32_t scalarMulSize; /*!< Number of element in scalarMul array */
  134. uint32_t modulusSize; /*!< Number of element in modulus, coefA, pointX and pointY arrays */
  135. uint32_t coefSign; /*!< Curve coefficient a sign */
  136. const uint8_t *coefA; /*!< Pointer to curve coefficient |a| (Array of modulusSize elements) */
  137. const uint8_t *modulus; /*!< Pointer to curve modulus value p (Array of modulusSize elements) */
  138. const uint8_t *pointX; /*!< Pointer to point P coordinate xP (Array of modulusSize elements) */
  139. const uint8_t *pointY; /*!< Pointer to point P coordinate yP (Array of modulusSize elements) */
  140. const uint8_t *scalarMul; /*!< Pointer to scalar multiplier k (Array of scalarMulSize elements) */
  141. } PKA_ECCMulInTypeDef;
  142. typedef struct
  143. {
  144. uint32_t modulusSize; /*!< Number of element in coefA, coefB, modulus, pointX and pointY arrays */
  145. uint32_t coefSign; /*!< Curve coefficient a sign */
  146. const uint8_t *coefA; /*!< Pointer to curve coefficient |a| (Array of modulusSize elements) */
  147. const uint8_t *coefB; /*!< Pointer to curve coefficient b (Array of modulusSize elements) */
  148. const uint8_t *modulus; /*!< Pointer to curve modulus value p (Array of modulusSize elements) */
  149. const uint8_t *pointX; /*!< Pointer to point P coordinate xP (Array of modulusSize elements) */
  150. const uint8_t *pointY; /*!< Pointer to point P coordinate yP (Array of modulusSize elements) */
  151. } PKA_PointCheckInTypeDef;
  152. typedef struct
  153. {
  154. uint32_t size; /*!< Number of element in popA array */
  155. const uint8_t *pOpDp; /*!< Pointer to operand dP (Array of size/2 elements) */
  156. const uint8_t *pOpDq; /*!< Pointer to operand dQ (Array of size/2 elements) */
  157. const uint8_t *pOpQinv; /*!< Pointer to operand qinv (Array of size/2 elements) */
  158. const uint8_t *pPrimeP; /*!< Pointer to prime p (Array of size/2 elements) */
  159. const uint8_t *pPrimeQ; /*!< Pointer to prime Q (Array of size/2 elements) */
  160. const uint8_t *popA; /*!< Pointer to operand A (Array of size elements) */
  161. } PKA_RSACRTExpInTypeDef;
  162. typedef struct
  163. {
  164. uint32_t primeOrderSize; /*!< Number of element in primeOrder array */
  165. uint32_t modulusSize; /*!< Number of element in modulus array */
  166. uint32_t coefSign; /*!< Curve coefficient a sign */
  167. const uint8_t *coef; /*!< Pointer to curve coefficient |a| (Array of modulusSize elements) */
  168. const uint8_t *modulus; /*!< Pointer to curve modulus value p (Array of modulusSize elements) */
  169. const uint8_t *basePointX; /*!< Pointer to curve base point xG (Array of modulusSize elements) */
  170. const uint8_t *basePointY; /*!< Pointer to curve base point yG (Array of modulusSize elements) */
  171. const uint8_t *pPubKeyCurvePtX; /*!< Pointer to public-key curve point xQ (Array of modulusSize elements) */
  172. const uint8_t *pPubKeyCurvePtY; /*!< Pointer to public-key curve point yQ (Array of modulusSize elements) */
  173. const uint8_t *RSign; /*!< Pointer to signature part r (Array of primeOrderSize elements) */
  174. const uint8_t *SSign; /*!< Pointer to signature part s (Array of primeOrderSize elements) */
  175. const uint8_t *hash; /*!< Pointer to hash of the message e (Array of primeOrderSize elements) */
  176. const uint8_t *primeOrder; /*!< Pointer to order of the curve n (Array of primeOrderSize elements) */
  177. } PKA_ECDSAVerifInTypeDef;
  178. typedef struct
  179. {
  180. uint32_t primeOrderSize; /*!< Number of element in primeOrder array */
  181. uint32_t modulusSize; /*!< Number of element in modulus array */
  182. uint32_t coefSign; /*!< Curve coefficient a sign */
  183. const uint8_t *coef; /*!< Pointer to curve coefficient |a| (Array of modulusSize elements) */
  184. const uint8_t *modulus; /*!< Pointer to curve modulus value p (Array of modulusSize elements) */
  185. const uint8_t *integer; /*!< Pointer to random integer k (Array of primeOrderSize elements) */
  186. const uint8_t *basePointX; /*!< Pointer to curve base point xG (Array of modulusSize elements) */
  187. const uint8_t *basePointY; /*!< Pointer to curve base point yG (Array of modulusSize elements) */
  188. const uint8_t *hash; /*!< Pointer to hash of the message (Array of primeOrderSize elements) */
  189. const uint8_t *privateKey; /*!< Pointer to private key d (Array of primeOrderSize elements) */
  190. const uint8_t *primeOrder; /*!< Pointer to order of the curve n (Array of primeOrderSize elements) */
  191. } PKA_ECDSASignInTypeDef;
  192. typedef struct
  193. {
  194. uint8_t *RSign; /*!< Pointer to signature part r (Array of modulusSize elements) */
  195. uint8_t *SSign; /*!< Pointer to signature part s (Array of modulusSize elements) */
  196. } PKA_ECDSASignOutTypeDef;
  197. typedef struct
  198. {
  199. uint8_t *ptX; /*!< Pointer to point P coordinate xP (Array of modulusSize elements) */
  200. uint8_t *ptY; /*!< Pointer to point P coordinate yP (Array of modulusSize elements) */
  201. } PKA_ECDSASignOutExtParamTypeDef, PKA_ECCMulOutTypeDef;
  202. typedef struct
  203. {
  204. uint32_t expSize; /*!< Number of element in pExp array */
  205. uint32_t OpSize; /*!< Number of element in pOp1 and pMod arrays */
  206. const uint8_t *pExp; /*!< Pointer to Exponent (Array of expSize elements) */
  207. const uint8_t *pOp1; /*!< Pointer to Operand (Array of OpSize elements) */
  208. const uint8_t *pMod; /*!< Pointer to modulus (Array of OpSize elements) */
  209. } PKA_ModExpInTypeDef;
  210. typedef struct
  211. {
  212. uint32_t expSize; /*!< Number of element in pExp and pMontgomeryParam arrays */
  213. uint32_t OpSize; /*!< Number of element in pOp1 and pMod arrays */
  214. const uint8_t *pExp; /*!< Pointer to Exponent (Array of expSize elements) */
  215. const uint8_t *pOp1; /*!< Pointer to Operand (Array of OpSize elements) */
  216. const uint8_t *pMod; /*!< Pointer to modulus (Array of OpSize elements) */
  217. const uint32_t *pMontgomeryParam; /*!< Pointer to Montgomery parameter (Array of expSize/4 elements) */
  218. } PKA_ModExpFastModeInTypeDef;
  219. typedef struct
  220. {
  221. uint32_t size; /*!< Number of element in pOp1 array */
  222. const uint8_t *pOp1; /*!< Pointer to Operand (Array of size elements) */
  223. } PKA_MontgomeryParamInTypeDef;
  224. typedef struct
  225. {
  226. uint32_t size; /*!< Number of element in pOp1 and pOp2 arrays */
  227. const uint32_t *pOp1; /*!< Pointer to Operand 1 (Array of size elements) */
  228. const uint32_t *pOp2; /*!< Pointer to Operand 2 (Array of size elements) */
  229. } PKA_AddInTypeDef, PKA_SubInTypeDef, PKA_MulInTypeDef, PKA_CmpInTypeDef;
  230. typedef struct
  231. {
  232. uint32_t size; /*!< Number of element in pOp1 array */
  233. const uint32_t *pOp1; /*!< Pointer to Operand 1 (Array of size elements) */
  234. const uint8_t *pMod; /*!< Pointer to modulus value n (Array of size*4 elements) */
  235. } PKA_ModInvInTypeDef;
  236. typedef struct
  237. {
  238. uint32_t OpSize; /*!< Number of element in pOp1 array */
  239. uint32_t modSize; /*!< Number of element in pMod array */
  240. const uint32_t *pOp1; /*!< Pointer to Operand 1 (Array of OpSize elements) */
  241. const uint8_t *pMod; /*!< Pointer to modulus value n (Array of modSize elements) */
  242. } PKA_ModRedInTypeDef;
  243. typedef struct
  244. {
  245. uint32_t size; /*!< Number of element in pOp1 and pOp2 arrays */
  246. const uint32_t *pOp1; /*!< Pointer to Operand 1 (Array of size elements) */
  247. const uint32_t *pOp2; /*!< Pointer to Operand 2 (Array of size elements) */
  248. const uint8_t *pOp3; /*!< Pointer to Operand 3 (Array of size*4 elements) */
  249. } PKA_ModAddInTypeDef, PKA_ModSubInTypeDef, PKA_MontgomeryMulInTypeDef;
  250. /**
  251. * @}
  252. */
  253. /**
  254. * @}
  255. */
  256. /* Exported constants --------------------------------------------------------*/
  257. /** @defgroup PKA_Exported_Constants PKA Exported Constants
  258. * @{
  259. */
  260. /** @defgroup PKA_Mode PKA mode
  261. * @{
  262. */
  263. #define PKA_MODE_MONTGOMERY_PARAM (0x00000001U)
  264. #define PKA_MODE_MODULAR_EXP (0x00000000U)
  265. #define PKA_MODE_MODULAR_EXP_FAST_MODE (0x00000002U)
  266. #define PKA_MODE_ECC_MUL (0x00000020U)
  267. #define PKA_MODE_ECC_MUL_FAST_MODE (0x00000022U)
  268. #define PKA_MODE_ECDSA_SIGNATURE (0x00000024U)
  269. #define PKA_MODE_ECDSA_VERIFICATION (0x00000026U)
  270. #define PKA_MODE_POINT_CHECK (0x00000028U)
  271. #define PKA_MODE_RSA_CRT_EXP (0x00000007U)
  272. #define PKA_MODE_MODULAR_INV (0x00000008U)
  273. #define PKA_MODE_ARITHMETIC_ADD (0x00000009U)
  274. #define PKA_MODE_ARITHMETIC_SUB (0x0000000AU)
  275. #define PKA_MODE_ARITHMETIC_MUL (0x0000000BU)
  276. #define PKA_MODE_COMPARISON (0x0000000CU)
  277. #define PKA_MODE_MODULAR_RED (0x0000000DU)
  278. #define PKA_MODE_MODULAR_ADD (0x0000000EU)
  279. #define PKA_MODE_MODULAR_SUB (0x0000000FU)
  280. #define PKA_MODE_MONTGOMERY_MUL (0x00000010U)
  281. /**
  282. * @}
  283. */
  284. /** @defgroup PKA_Interrupt_configuration_definition PKA Interrupt configuration definition
  285. * @brief PKA Interrupt definition
  286. * @{
  287. */
  288. #define PKA_IT_PROCEND PKA_CR_PROCENDIE
  289. #define PKA_IT_ADDRERR PKA_CR_ADDRERRIE
  290. #define PKA_IT_RAMERR PKA_CR_RAMERRIE
  291. /**
  292. * @}
  293. */
  294. /** @defgroup PKA_Flag_definition PKA Flag definition
  295. * @{
  296. */
  297. #define PKA_FLAG_PROCEND PKA_SR_PROCENDF
  298. #define PKA_FLAG_ADDRERR PKA_SR_ADDRERRF
  299. #define PKA_FLAG_RAMERR PKA_SR_RAMERRF
  300. /**
  301. * @}
  302. */
  303. /**
  304. * @}
  305. */
  306. /* Exported macros -----------------------------------------------------------*/
  307. /** @defgroup PKA_Exported_Macros PKA Exported Macros
  308. * @{
  309. */
  310. /** @brief Reset PKA handle state.
  311. * @param __HANDLE__ specifies the PKA Handle
  312. * @retval None
  313. */
  314. #if (USE_HAL_PKA_REGISTER_CALLBACKS == 1)
  315. #define __HAL_PKA_RESET_HANDLE_STATE(__HANDLE__) do{ \
  316. (__HANDLE__)->State = HAL_PKA_STATE_RESET; \
  317. (__HANDLE__)->MspInitCallback = NULL; \
  318. (__HANDLE__)->MspDeInitCallback = NULL; \
  319. } while(0)
  320. #else
  321. #define __HAL_PKA_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_PKA_STATE_RESET)
  322. #endif /* USE_HAL_PKA_REGISTER_CALLBACKS */
  323. /** @brief Enable the specified PKA interrupt.
  324. * @param __HANDLE__ specifies the PKA Handle
  325. * @param __INTERRUPT__ specifies the interrupt source to enable.
  326. * This parameter can be one of the following values:
  327. * @arg @ref PKA_IT_PROCEND End Of Operation interrupt enable
  328. * @arg @ref PKA_IT_ADDRERR Address error interrupt enable
  329. * @arg @ref PKA_IT_RAMERR RAM error interrupt enable
  330. * @retval None
  331. */
  332. #define __HAL_PKA_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR |= (__INTERRUPT__))
  333. /** @brief Disable the specified PKA interrupt.
  334. * @param __HANDLE__ specifies the PKA Handle
  335. * @param __INTERRUPT__ specifies the interrupt source to disable.
  336. * This parameter can be one of the following values:
  337. * @arg @ref PKA_IT_PROCEND End Of Operation interrupt enable
  338. * @arg @ref PKA_IT_ADDRERR Address error interrupt enable
  339. * @arg @ref PKA_IT_RAMERR RAM error interrupt enable
  340. * @retval None
  341. */
  342. #define __HAL_PKA_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR &= (~(__INTERRUPT__)))
  343. /** @brief Check whether the specified PKA interrupt source is enabled or not.
  344. * @param __HANDLE__ specifies the PKA Handle
  345. * @param __INTERRUPT__ specifies the PKA interrupt source to check.
  346. * This parameter can be one of the following values:
  347. * @arg @ref PKA_IT_PROCEND End Of Operation interrupt enable
  348. * @arg @ref PKA_IT_ADDRERR Address error interrupt enable
  349. * @arg @ref PKA_IT_RAMERR RAM error interrupt enable
  350. * @retval The new state of __INTERRUPT__ (SET or RESET)
  351. */
  352. #define __HAL_PKA_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR\
  353. & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  354. /** @brief Check whether the specified PKA flag is set or not.
  355. * @param __HANDLE__ specifies the PKA Handle
  356. * @param __FLAG__ specifies the flag to check.
  357. * This parameter can be one of the following values:
  358. * @arg @ref PKA_FLAG_PROCEND End Of Operation
  359. * @arg @ref PKA_FLAG_ADDRERR Address error
  360. * @arg @ref PKA_FLAG_RAMERR RAM error
  361. * @retval The new state of __FLAG__ (SET or RESET)
  362. */
  363. #define __HAL_PKA_GET_FLAG(__HANDLE__, __FLAG__) (((((__HANDLE__)->Instance->SR)\
  364. & (__FLAG__)) == (__FLAG__)) ? SET : RESET)
  365. /** @brief Clear the PKA pending flags which are cleared by writing 1 in a specific bit.
  366. * @param __HANDLE__ specifies the PKA Handle
  367. * @param __FLAG__ specifies the flag to clear.
  368. * This parameter can be any combination of the following values:
  369. * @arg @ref PKA_FLAG_PROCEND End Of Operation
  370. * @arg @ref PKA_FLAG_ADDRERR Address error
  371. * @arg @ref PKA_FLAG_RAMERR RAM error
  372. * @retval None
  373. */
  374. #define __HAL_PKA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->CLRFR = (__FLAG__))
  375. /** @brief Enable the specified PKA peripheral.
  376. * @param __HANDLE__ specifies the PKA Handle
  377. * @retval None
  378. */
  379. #define __HAL_PKA_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR, PKA_CR_EN))
  380. /** @brief Disable the specified PKA peripheral.
  381. * @param __HANDLE__ specifies the PKA Handle
  382. * @retval None
  383. */
  384. #define __HAL_PKA_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->CR, PKA_CR_EN))
  385. /** @brief Start a PKA operation.
  386. * @param __HANDLE__ specifies the PKA Handle
  387. * @retval None
  388. */
  389. #define __HAL_PKA_START(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR, PKA_CR_START))
  390. /**
  391. * @}
  392. */
  393. /* Private macros --------------------------------------------------------*/
  394. /* Exported functions --------------------------------------------------------*/
  395. /** @addtogroup PKA_Exported_Functions
  396. * @{
  397. */
  398. /** @addtogroup PKA_Exported_Functions_Group1
  399. * @{
  400. */
  401. /* Initialization and de-initialization functions *****************************/
  402. HAL_StatusTypeDef HAL_PKA_Init(PKA_HandleTypeDef *hpka);
  403. HAL_StatusTypeDef HAL_PKA_DeInit(PKA_HandleTypeDef *hpka);
  404. void HAL_PKA_MspInit(PKA_HandleTypeDef *hpka);
  405. void HAL_PKA_MspDeInit(PKA_HandleTypeDef *hpka);
  406. #if (USE_HAL_PKA_REGISTER_CALLBACKS == 1)
  407. /* Callbacks Register/UnRegister functions ***********************************/
  408. HAL_StatusTypeDef HAL_PKA_RegisterCallback(PKA_HandleTypeDef *hpka, HAL_PKA_CallbackIDTypeDef CallbackID,
  409. pPKA_CallbackTypeDef pCallback);
  410. HAL_StatusTypeDef HAL_PKA_UnRegisterCallback(PKA_HandleTypeDef *hpka, HAL_PKA_CallbackIDTypeDef CallbackID);
  411. #endif /* USE_HAL_PKA_REGISTER_CALLBACKS */
  412. /**
  413. * @}
  414. */
  415. /** @addtogroup PKA_Exported_Functions_Group2
  416. * @{
  417. */
  418. /* IO operation functions *****************************************************/
  419. /* High Level Functions *******************************************************/
  420. HAL_StatusTypeDef HAL_PKA_ModExp(PKA_HandleTypeDef *hpka, PKA_ModExpInTypeDef *in, uint32_t Timeout);
  421. HAL_StatusTypeDef HAL_PKA_ModExp_IT(PKA_HandleTypeDef *hpka, PKA_ModExpInTypeDef *in);
  422. HAL_StatusTypeDef HAL_PKA_ModExpFastMode(PKA_HandleTypeDef *hpka, PKA_ModExpFastModeInTypeDef *in, uint32_t Timeout);
  423. HAL_StatusTypeDef HAL_PKA_ModExpFastMode_IT(PKA_HandleTypeDef *hpka, PKA_ModExpFastModeInTypeDef *in);
  424. void HAL_PKA_ModExp_GetResult(PKA_HandleTypeDef *hpka, uint8_t *pRes);
  425. HAL_StatusTypeDef HAL_PKA_ECDSASign(PKA_HandleTypeDef *hpka, PKA_ECDSASignInTypeDef *in, uint32_t Timeout);
  426. HAL_StatusTypeDef HAL_PKA_ECDSASign_IT(PKA_HandleTypeDef *hpka, PKA_ECDSASignInTypeDef *in);
  427. void HAL_PKA_ECDSASign_GetResult(PKA_HandleTypeDef *hpka, PKA_ECDSASignOutTypeDef *out,
  428. PKA_ECDSASignOutExtParamTypeDef *outExt);
  429. HAL_StatusTypeDef HAL_PKA_ECDSAVerif(PKA_HandleTypeDef *hpka, PKA_ECDSAVerifInTypeDef *in, uint32_t Timeout);
  430. HAL_StatusTypeDef HAL_PKA_ECDSAVerif_IT(PKA_HandleTypeDef *hpka, PKA_ECDSAVerifInTypeDef *in);
  431. uint32_t HAL_PKA_ECDSAVerif_IsValidSignature(PKA_HandleTypeDef const *const hpka);
  432. HAL_StatusTypeDef HAL_PKA_RSACRTExp(PKA_HandleTypeDef *hpka, PKA_RSACRTExpInTypeDef *in, uint32_t Timeout);
  433. HAL_StatusTypeDef HAL_PKA_RSACRTExp_IT(PKA_HandleTypeDef *hpka, PKA_RSACRTExpInTypeDef *in);
  434. void HAL_PKA_RSACRTExp_GetResult(PKA_HandleTypeDef *hpka, uint8_t *pRes);
  435. HAL_StatusTypeDef HAL_PKA_PointCheck(PKA_HandleTypeDef *hpka, PKA_PointCheckInTypeDef *in, uint32_t Timeout);
  436. HAL_StatusTypeDef HAL_PKA_PointCheck_IT(PKA_HandleTypeDef *hpka, PKA_PointCheckInTypeDef *in);
  437. uint32_t HAL_PKA_PointCheck_IsOnCurve(PKA_HandleTypeDef const *const hpka);
  438. HAL_StatusTypeDef HAL_PKA_ECCMul(PKA_HandleTypeDef *hpka, PKA_ECCMulInTypeDef *in, uint32_t Timeout);
  439. HAL_StatusTypeDef HAL_PKA_ECCMul_IT(PKA_HandleTypeDef *hpka, PKA_ECCMulInTypeDef *in);
  440. HAL_StatusTypeDef HAL_PKA_ECCMulFastMode(PKA_HandleTypeDef *hpka, PKA_ECCMulFastModeInTypeDef *in, uint32_t Timeout);
  441. HAL_StatusTypeDef HAL_PKA_ECCMulFastMode_IT(PKA_HandleTypeDef *hpka, PKA_ECCMulFastModeInTypeDef *in);
  442. void HAL_PKA_ECCMul_GetResult(PKA_HandleTypeDef *hpka, PKA_ECCMulOutTypeDef *out);
  443. HAL_StatusTypeDef HAL_PKA_Add(PKA_HandleTypeDef *hpka, PKA_AddInTypeDef *in, uint32_t Timeout);
  444. HAL_StatusTypeDef HAL_PKA_Add_IT(PKA_HandleTypeDef *hpka, PKA_AddInTypeDef *in);
  445. HAL_StatusTypeDef HAL_PKA_Sub(PKA_HandleTypeDef *hpka, PKA_SubInTypeDef *in, uint32_t Timeout);
  446. HAL_StatusTypeDef HAL_PKA_Sub_IT(PKA_HandleTypeDef *hpka, PKA_SubInTypeDef *in);
  447. HAL_StatusTypeDef HAL_PKA_Cmp(PKA_HandleTypeDef *hpka, PKA_CmpInTypeDef *in, uint32_t Timeout);
  448. HAL_StatusTypeDef HAL_PKA_Cmp_IT(PKA_HandleTypeDef *hpka, PKA_CmpInTypeDef *in);
  449. HAL_StatusTypeDef HAL_PKA_Mul(PKA_HandleTypeDef *hpka, PKA_MulInTypeDef *in, uint32_t Timeout);
  450. HAL_StatusTypeDef HAL_PKA_Mul_IT(PKA_HandleTypeDef *hpka, PKA_MulInTypeDef *in);
  451. HAL_StatusTypeDef HAL_PKA_ModAdd(PKA_HandleTypeDef *hpka, PKA_ModAddInTypeDef *in, uint32_t Timeout);
  452. HAL_StatusTypeDef HAL_PKA_ModAdd_IT(PKA_HandleTypeDef *hpka, PKA_ModAddInTypeDef *in);
  453. HAL_StatusTypeDef HAL_PKA_ModSub(PKA_HandleTypeDef *hpka, PKA_ModSubInTypeDef *in, uint32_t Timeout);
  454. HAL_StatusTypeDef HAL_PKA_ModSub_IT(PKA_HandleTypeDef *hpka, PKA_ModSubInTypeDef *in);
  455. HAL_StatusTypeDef HAL_PKA_ModInv(PKA_HandleTypeDef *hpka, PKA_ModInvInTypeDef *in, uint32_t Timeout);
  456. HAL_StatusTypeDef HAL_PKA_ModInv_IT(PKA_HandleTypeDef *hpka, PKA_ModInvInTypeDef *in);
  457. HAL_StatusTypeDef HAL_PKA_ModRed(PKA_HandleTypeDef *hpka, PKA_ModRedInTypeDef *in, uint32_t Timeout);
  458. HAL_StatusTypeDef HAL_PKA_ModRed_IT(PKA_HandleTypeDef *hpka, PKA_ModRedInTypeDef *in);
  459. HAL_StatusTypeDef HAL_PKA_MontgomeryMul(PKA_HandleTypeDef *hpka, PKA_MontgomeryMulInTypeDef *in, uint32_t Timeout);
  460. HAL_StatusTypeDef HAL_PKA_MontgomeryMul_IT(PKA_HandleTypeDef *hpka, PKA_MontgomeryMulInTypeDef *in);
  461. void HAL_PKA_Arithmetic_GetResult(PKA_HandleTypeDef *hpka, uint32_t *pRes);
  462. HAL_StatusTypeDef HAL_PKA_MontgomeryParam(PKA_HandleTypeDef *hpka, PKA_MontgomeryParamInTypeDef *in, uint32_t Timeout);
  463. HAL_StatusTypeDef HAL_PKA_MontgomeryParam_IT(PKA_HandleTypeDef *hpka, PKA_MontgomeryParamInTypeDef *in);
  464. void HAL_PKA_MontgomeryParam_GetResult(PKA_HandleTypeDef *hpka, uint32_t *pRes);
  465. HAL_StatusTypeDef HAL_PKA_Abort(PKA_HandleTypeDef *hpka);
  466. void HAL_PKA_RAMReset(PKA_HandleTypeDef *hpka);
  467. void HAL_PKA_OperationCpltCallback(PKA_HandleTypeDef *hpka);
  468. void HAL_PKA_ErrorCallback(PKA_HandleTypeDef *hpka);
  469. void HAL_PKA_IRQHandler(PKA_HandleTypeDef *hpka);
  470. /**
  471. * @}
  472. */
  473. /** @addtogroup PKA_Exported_Functions_Group3
  474. * @{
  475. */
  476. /* Peripheral State and Error functions ***************************************/
  477. HAL_PKA_StateTypeDef HAL_PKA_GetState(const PKA_HandleTypeDef *hpka);
  478. uint32_t HAL_PKA_GetError(const PKA_HandleTypeDef *hpka);
  479. /**
  480. * @}
  481. */
  482. /**
  483. * @}
  484. */
  485. /**
  486. * @}
  487. */
  488. #endif /* defined(PKA) && defined(HAL_PKA_MODULE_ENABLED) */
  489. /**
  490. * @}
  491. */
  492. #ifdef __cplusplus
  493. }
  494. #endif
  495. #endif /* STM32L4xx_HAL_PKA_H */