 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP aes and top darjeeling. More...
#include "hw/top/dt/dt_api.h"#include <stdint.h>Go to the source code of this file.
Macros | |
| #define | OPENTITAN_AES_HAS_KEY_LEN_128 1 |
| List of supported hardware features. | |
| #define | OPENTITAN_AES_HAS_KEY_LEN_192 1 |
| #define | OPENTITAN_AES_HAS_KEY_LEN_256 1 |
| #define | OPENTITAN_AES_HAS_MODE_ECB 1 |
| #define | OPENTITAN_AES_HAS_MODE_CBC 1 |
| #define | OPENTITAN_AES_HAS_MODE_CFB_128 1 |
| #define | OPENTITAN_AES_HAS_MODE_OFB 1 |
| #define | OPENTITAN_AES_HAS_MODE_CTR 1 |
| #define | OPENTITAN_AES_HAS_KEY_SIDELOAD 1 |
| #define | OPENTITAN_AES_HAS_CLEAR_DATA_OUT 1 |
| #define | OPENTITAN_AES_HAS_CLEAR_KEY_IV_DATA_IN 1 |
| #define | OPENTITAN_AES_HAS_PRNG_RESEED_RATE 1 |
| #define | OPENTITAN_AES_HAS_PRNG_KEY_TOUCH_FORCES_RESEED 1 |
| #define | OPENTITAN_AES_HAS_PRNG_FORCE_MASKS 1 |
| #define | OPENTITAN_AES_HAS_MANUAL_OPERATION 1 |
Typedefs | |
| typedef enum dt_aes | dt_aes_t |
| List of instances. | |
| typedef enum dt_aes_reg_block | dt_aes_reg_block_t |
| List of register blocks. | |
| typedef enum dt_aes_memory | dt_aes_memory_t |
| List of memories. | |
| typedef enum dt_aes_alert | dt_aes_alert_t |
| List of Alerts. | |
| typedef enum dt_aes_clock | dt_aes_clock_t |
| List of clock ports. | |
| typedef enum dt_aes_reset | dt_aes_reset_t |
| List of reset ports. | |
Enumerations | |
| enum | dt_aes { kDtAes = 0 , kDtAesFirst = 0 , kDtAesCount = 1 } |
| List of instances. More... | |
| enum | dt_aes_reg_block { kDtAesRegBlockCore = 0 , kDtAesRegBlockCount = 1 } |
| List of register blocks. More... | |
| enum | dt_aes_memory { kDtAesMemoryCount = 0 } |
| List of memories. More... | |
| enum | dt_aes_alert { kDtAesAlertRecovCtrlUpdateErr = 0 , kDtAesAlertFatalFault = 1 , kDtAesAlertCount = 2 } |
| List of Alerts. More... | |
| enum | dt_aes_clock { kDtAesClockClk = 0 , kDtAesClockEdn = 1 , kDtAesClockCount = 2 } |
| List of clock ports. More... | |
| enum | dt_aes_reset { kDtAesResetRst = 0 , kDtAesResetEdn = 1 , kDtAesResetCount = 2 } |
| List of reset ports. More... | |
Functions | |
| dt_aes_t | dt_aes_from_instance_id (dt_instance_id_t inst_id) |
| Get the aes instance from an instance ID. | |
| dt_instance_id_t | dt_aes_instance_id (dt_aes_t dt) |
| Get the instance ID of an instance. | |
| uint32_t | dt_aes_reg_block (dt_aes_t dt, dt_aes_reg_block_t reg_block) |
| Get the register base address of an instance. | |
| uint32_t | dt_aes_memory_base (dt_aes_t dt, dt_aes_memory_t mem) |
| Get the base address of a memory. | |
| uint32_t | dt_aes_memory_size (dt_aes_t dt, dt_aes_memory_t mem) |
| Get the size of a memory. | |
| dt_alert_id_t | dt_aes_alert_to_alert_id (dt_aes_t dt, dt_aes_alert_t alert) |
| Get the alert ID of a aes alert for a given instance. | |
| dt_aes_alert_t | dt_aes_alert_from_alert_id (dt_aes_t dt, dt_alert_id_t alert) |
| Convert a global alert ID to a local aes alert type. | |
| dt_clock_t | dt_aes_clock (dt_aes_t dt, dt_aes_clock_t clk) |
| Get the clock signal connected to a clock port of an instance. | |
| dt_reset_t | dt_aes_reset (dt_aes_t dt, dt_aes_reset_t rst) |
| Get the reset signal connected to a reset port of an instance. | |
Device Tables (DT) for IP aes and top darjeeling.
This file contains the type definitions and global functions of the aes.
Definition in file dt_aes.h.
| #define OPENTITAN_AES_HAS_KEY_LEN_128 1 |
| typedef enum dt_aes_alert dt_aes_alert_t |
List of Alerts.
Alerts are guaranteed to be numbered consecutively from 0.
| typedef enum dt_aes_clock dt_aes_clock_t |
List of clock ports.
Clock ports are guaranteed to be numbered consecutively from 0.
| typedef enum dt_aes_memory dt_aes_memory_t |
List of memories.
Memories are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_aes_reg_block dt_aes_reg_block_t |
List of register blocks.
Register blocks are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_aes_reset dt_aes_reset_t |
List of reset ports.
Reset ports are guaranteed to be numbered consecutively from 0.
| enum dt_aes_alert |
List of Alerts.
Alerts are guaranteed to be numbered consecutively from 0.
| enum dt_aes_clock |
| enum dt_aes_memory |
| enum dt_aes_reg_block |
| enum dt_aes_reset |
| dt_aes_alert_t dt_aes_alert_from_alert_id | ( | dt_aes_t | dt, |
| dt_alert_id_t | alert ) |
Convert a global alert ID to a local aes alert type.
| dt | Instance of aes. |
| alert | A global alert ID that belongs to this instance. |
kDtAesAlertCount.Note: This function assumes that the global alert ID belongs to the instance of aes passed in parameter. In other words, it must be the case that dt_aes_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtAesAlertCount.
| dt_alert_id_t dt_aes_alert_to_alert_id | ( | dt_aes_t | dt, |
| dt_aes_alert_t | alert ) |
Get the alert ID of a aes alert for a given instance.
Note: This function only makes sense if the instance is connected to the Alert Handler. For any instances where the instance is not connected, the return value is unspecified.
| dt | Instance of aes. |
| alert | A aes alert. |
| dt_clock_t dt_aes_clock | ( | dt_aes_t | dt, |
| dt_aes_clock_t | clk ) |
| dt_aes_t dt_aes_from_instance_id | ( | dt_instance_id_t | inst_id | ) |
Get the aes instance from an instance ID.
For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.
| inst_id | Instance ID. |
Note: This function only makes sense if the instance ID has device type aes, otherwise the returned value is unspecified.
| dt_instance_id_t dt_aes_instance_id | ( | dt_aes_t | dt | ) |
| uint32_t dt_aes_memory_base | ( | dt_aes_t | dt, |
| dt_aes_memory_t | mem ) |
| uint32_t dt_aes_memory_size | ( | dt_aes_t | dt, |
| dt_aes_memory_t | mem ) |
| uint32_t dt_aes_reg_block | ( | dt_aes_t | dt, |
| dt_aes_reg_block_t | reg_block ) |
| dt_reset_t dt_aes_reset | ( | dt_aes_t | dt, |
| dt_aes_reset_t | rst ) |