/** * @file * @brief AES driver. */ /****************************************************************************** * Copyright (C) 2023 Maxim Integrated Products, Inc., All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. * * Except as contained in this notice, the name of Maxim Integrated * Products, Inc. shall not be used except as stated in the Maxim Integrated * Products, Inc. Branding Policy. * * The mere transfer of this software does not imply any licenses * of trade secrets, proprietary technology, copyrights, patents, * trademarks, maskwork rights, or any other form of intellectual * property whatsoever. Maxim Integrated Products, Inc. retains all * ownership rights. * ******************************************************************************/ #ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32670_AES_H_ #define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32670_AES_H_ /***** Includes *****/ #include "aes_regs.h" #include "aeskeys_regs.h" #ifdef __cplusplus extern "C" { #endif /** * @defgroup aes AES * @ingroup periphlibs * @{ */ /*@} end of group aes */ /***** Definitions *****/ typedef void (*mxc_aes_complete_t)(void *req, int result); /* ************************************************************************* */ /* Cipher Definitions */ /* ************************************************************************* */ /** * @brief Enumeration type to select AES key * */ typedef enum { MXC_AES_128BITS = MXC_S_AES_CTRL_KEY_SIZE_AES128, ///< Select AES-128 bit key MXC_AES_192BITS = MXC_S_AES_CTRL_KEY_SIZE_AES192, ///< Select AES-192 bit key MXC_AES_256BITS = MXC_S_AES_CTRL_KEY_SIZE_AES256, ///< Select AES-256 bit key } mxc_aes_keys_t; /** * @brief Enumeration type to select AES key source and encryption type * */ typedef enum { MXC_AES_ENCRYPT_EXT_KEY = 0, ///< Encryption using External key MXC_AES_DECRYPT_EXT_KEY = 1, ///< Encryption using internal key MXC_AES_DECRYPT_INT_KEY = 2 ///< Decryption using internal key } mxc_aes_enc_type_t; /** * @brief Structure used to set up AES request * */ typedef struct _mxc_aes_cipher_req_t { uint32_t length; ///< Length of the data uint32_t *inputData; ///< Pointer to input data uint32_t *resultData; ///< Pointer to encrypted data mxc_aes_keys_t keySize; ///< Size of AES key mxc_aes_enc_type_t encryption; ///< Encrytion type or \ref mxc_aes_enc_type_t mxc_aes_complete_t callback; ///< Callback function } mxc_aes_req_t; /***** Function Prototypes *****/ /* ************************************************************************* */ /* Global Control/Configuration functions */ /* ************************************************************************* */ /** * @brief Enable portions of the AES * * @return Success/Fail, see \ref MXC_Error_Codes for a list of return codes. */ int MXC_AES_Init(void); /** * @brief Enable AES Interrupts * * @param interrupt interrupt to enable */ void MXC_AES_EnableInt(uint32_t interrupt); /** * @brief Disable AES Interrupts * * @param interrupt interrupt to disable */ void MXC_AES_DisableInt(uint32_t interrupt); /** * @brief Checks the global AES Busy Status * * @return E_BUSY if busy and E_NO_ERROR otherwise, see \ref MXC_Error_Codes for a list of return codes. */ int MXC_AES_IsBusy(void); /** * @brief Disable and reset portions of the AES * * @return Success/Fail, see \ref MXC_Error_Codes for a list of return codes. */ int MXC_AES_Shutdown(void); /** * @brief This function should be called from the DMA Handler * when using Async functions */ void MXC_AES_DMACallback(int ch, int error); /** * @brief This function should be called before encryption to genrate external key */ void MXC_AES_GenerateKey(void); /** * @brief Set Key size for encryption or decryption * * @param key Key size, see \ref mxc_aes_keys_t for a list of keys */ void MXC_AES_SetKeySize(mxc_aes_keys_t key); /** * @brief Get the currently set key size * * @return mxc_aes_keys_t see \ref mxc_aes_keys_t */ mxc_aes_keys_t MXC_AES_GetKeySize(void); /** * @brief Flush Input Data FIFO * */ void MXC_AES_FlushInputFIFO(void); /** * @brief Flush Output Data FIFO * */ void MXC_AES_FlushOutputFIFO(void); /** * @brief Start AES Calculations * */ void MXC_AES_Start(void); /** * @brief Get Interrupt flags set * * @return return the flags set in intfl register */ uint32_t MXC_AES_GetFlags(void); /** * @brief Clear the interrupts * * @param flags flags to be cleared */ void MXC_AES_ClearFlags(uint32_t flags); /** * @brief * @note The result will be stored in the req structure * * @param req Structure containing data for the encryption * * @return Success/Fail, see \ref MXC_Error_Codes for a list of return codes. */ int MXC_AES_Generic(mxc_aes_req_t *req); /** * @brief Perform an encryption * @note The result will be stored in the req structure * * @param req Structure containing data for the encryption * * @return Success/Fail, see \ref MXC_Error_Codes for a list of return codes. */ int MXC_AES_Encrypt(mxc_aes_req_t *req); /** * @brief Perform a decryption * @note The result will be stored in the req structure * * @param req Structure containing data for the decryption * * @return Success/Fail, see \ref MXC_Error_Codes for a list of return codes. */ int MXC_AES_Decrypt(mxc_aes_req_t *req); /** * @brief Perform AES TX using DMA. Configures DMA request and starts the transmission. * * @param src_addr source address * @param len number of words of data * @return Success/Fail, see \ref MXC_Error_Codes for a list of return codes. */ int MXC_AES_TXDMAConfig(void *src_addr, int len); /** * @brief Perform AES RX using DMA. Configures DMA request and receives data from AES FIFO. * * @param dest_addr destination address * @param len number of words of data * @return Success/Fail, see \ref MXC_Error_Codes for a list of return codes. */ int MXC_AES_RXDMAConfig(void *dest_addr, int len); /** * @brief Perform encryption or decryption using DMA * * @param req The result will be stored in the req structure. The user needs * to call MXC_AES_Handler() in the ISR * @param enc 0 for encryption and 1 for decryption * @return Success/Fail, see \ref MXC_Error_Codes for a list of return codes. */ int MXC_AES_GenericAsync(mxc_aes_req_t *req, uint8_t enc); /** * @brief Perform an encryption using Interrupt * @note The result will be stored in the req structure. The user needs * to call MXC_AES_Handler() in the ISR * * @param req Structure containing data for the encryption * @return Success/Fail, see \ref MXC_Error_Codes for a list of return codes. */ int MXC_AES_EncryptAsync(mxc_aes_req_t *req); /** * @brief Perform a decryption using Interrupt * @note The result will be stored in the req structure. The user needs * to call MXC_AES_Handler() in the ISR * * @param req Structure containing data for the decryption * @return Success/Fail, see \ref MXC_Error_Codes for a list of return codes. */ int MXC_AES_DecryptAsync(mxc_aes_req_t *req); /** * @brief Set the external key * @param key Buffer for the key. * @param len Key size. */ void MXC_AES_SetExtKey(const void *key, mxc_aes_keys_t len); /** * @brief Set the key that will be loaded into the AES key registers on a POR event. * @param key Buffer for the key. * @param len Key size. * @return Success/Fail, see \ref MXC_Error_Codes for a list of return codes. */ int MXC_AES_SetPORKey(const void *key, mxc_aes_keys_t len); /** * @brief Clears the key that will be loaded into the AES key registers on a POR event. * On subsequent POR events after this function is called, the AES key registers * will be loaded with all zeroes. * @return Success/Fail, see \ref MXC_Error_Codes for a list of return codes. */ int MXC_AES_ClearPORKey(); /** * @brief Transfers the POR key from the storage memory to the AES key registers. * This happens automatically after each POR. This function should be used * if application code overwrites the key registers and wants to switch back * to the POR value. * @param len Key size. */ void MXC_AES_CopyPORKeyToKeyRegisters(mxc_aes_keys_t len); /** * @brief Checks to see if a POR key has been programmed. * @return 1 if a key has been installed, 0 if not. */ int MXC_AES_HasPORKey(); #ifdef __cplusplus } #endif /**@} end of group aes */ #endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32670_AES_H_