Defines all functions of mcuxClCss_Common. More...
Defines all functions of mcuxClCss_Common.
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_GetHwVersion | ( | mcuxClCss_HwVersion_t * | result | ) |
Determines the version of the underlying CSS hardware IP.
[out] | result | Pointer which will be filled with the CSS hardware version |
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_GetHwConfig | ( | mcuxClCss_HwConfig_t * | result | ) |
Determines the hardware configuration of the underlying CSS hardware IP.
[out] | result | Pointer which will be filled with the CSS hardware configuration |
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_GetHwState | ( | mcuxClCss_HwState_t * | result | ) |
Determines the current state of the CSS.
[out] | result | Pointer which will be filled with the CSS status information |
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_Enable_Async | ( | void | ) |
Enables the CSS.
Call mcuxClCss_WaitForOperation to complete the operation.
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_Reset_Async | ( | mcuxClCss_ResetOption_t | options | ) |
Perform a synchronous reset of the CSS.
This means that:
Call mcuxClCss_WaitForOperation to complete the operation.
[in] | options | A value indicating whether any running CSS operations shall be canceled |
MCUXCLCSS_STATUS_SW_CANNOT_INTERRUPT | if a running operation prevented the reset |
MCUXCLCSS_STATUS_OK_WAIT | on successful request |
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_Disable | ( | void | ) |
Disable the CSSv2.
This is useful as a power saving mechanism.
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_SetIntEnableFlags | ( | mcuxClCss_InterruptOptionEn_t | options | ) |
Set interrupt enable flags.
[in] | options | The command options, determining which interrupts should be enabled or disabled. For more information, see mcuxClCss_InterruptOptionEn_t. |
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_GetIntEnableFlags | ( | mcuxClCss_InterruptOptionEn_t * | result | ) |
Get interrupt enable flags.
[out] | result | Pointer which is filled with the configuration of the interrupts enable register. |
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_ResetIntFlags | ( | mcuxClCss_InterruptOptionRst_t | options | ) |
Clear the interrupt status register.
[in] | options | The command options, determining which interrupt status bits should be cleared. For more information, see mcuxClCss_InterruptOptionRst_t. |
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_SetIntFlags | ( | mcuxClCss_InterruptOptionSet_t | options | ) |
Set the interrupt status register, for debug and testing purposes.
[in] | options | The command options, determining which interrupt status bits should be set. For more information, see mcuxClCss_InterruptOptionSet_t. |
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_WaitForOperation | ( | mcuxClCss_ErrorHandling_t | errorHandling | ) |
Wait for a CSS operation and optionally clear the error status.
If a CSS operation is active, this function waits for completion of that operation. For this, the busy flag of CSS is polled. Additionally, this function checks and returns any applicable error indication. If no operation is active, the function returns immediately.
[in] | errorHandling | Define if error flags shall be cleared. |
MCUXCLCSS_STATUS_OK | if the last operation was successful, or no operation was active |
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_LimitedWaitForOperation | ( | uint32_t | counterLimit, |
mcuxClCss_ErrorHandling_t | errorHandling | ||
) |
Await the completion of a CSS operation for a limited amount of time and optionally clear the error status.
If a CSS operation is active, this function waits for completion of that operation until a counter expires. For this, the busy flag of CSS is polled. The counting mechanism behaves like a simple for-loop from counterLimit
to one. This counter does not have a well-defined relationship to real-world time. Additionally, this function checks and returns any applicable error indication. If no operation is active, the function returns immediately.
[in] | counterLimit | The limit of the wait counter. |
[in] | errorHandling | Define if error flags shall be cleared. |
MCUXCLCSS_STATUS_OK | if the last operation was successful, or no operation was active |
MCUXCLCSS_STATUS_SW_COUNTER_EXPIRED | if the counter expired while waiting for the operation to complete |
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_ResetErrorFlags | ( | void | ) |
Resets all error flags that have been set by a previous operation.
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_GetErrorCode | ( | mcuxClCss_ErrorHandling_t | errorHandling | ) |
Get the last CSS error code and optionally clear the error status.
[in] | errorHandling | Define if error flags shall be cleared. |
MCUXCLCSS_STATUS_OK | if the last operation was successful or no operation was active |
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_GetErrorLevel | ( | mcuxClCss_ErrorHandling_t | errorHandling, |
uint32_t * | errorLevel | ||
) |
Get the last CSS error code and level and optionally clear the error status.
[in] | errorHandling | Define if error flags shall be cleared. |
[out] | errorLevel | Pointer to the location that will receive the value of the error level. |
MCUXCLCSS_STATUS_OK | if the last operation was successful or no operation was active |
#MCUXCLCSS_STATUS_ | if the last operation resulted in an error |
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_SetRandomStartDelay | ( | uint32_t | delay | ) |
Set the random start delay for AES based operations.
This impacts mcuxClCss_Aead_*, mcuxClCss_Cipher_*, mcuxClCss_Cmac_*, ncpClCss_Ckdf_*, mcuxClCss_KeyImport_Async, mcuxClCss_KeyExport_Async
[in] | delay | Define the max random start delay. Acceptable values are a power of 2 minus one, starting from 0 to 1023 (0, 1, 3, 7, ..., 1023). |
MCUXCLCSS_STATUS_OK | if the operation was successful |
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_GetRandomStartDelay | ( | uint32_t * | delay | ) |
Get the random start delay for AES based operations.
[out] | delay | Pointer to store random start delay configuration. |
MCUXCLCSS_STATUS_OK | if the operation was successful |