 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP hmac and top earlgrey. More...
Go to the source code of this file.
Macros | |
| #define | OPENTITAN_HMAC_HAS_MODE_SHA2 1 |
| List of supported hardware features. | |
| #define | OPENTITAN_HMAC_HAS_MODE_HMAC 1 |
| #define | OPENTITAN_HMAC_HAS_DIGEST_SIZE_SHA2_256 1 |
| #define | OPENTITAN_HMAC_HAS_DIGEST_SIZE_SHA2_384 1 |
| #define | OPENTITAN_HMAC_HAS_DIGEST_SIZE_SHA2_512 1 |
| #define | OPENTITAN_HMAC_HAS_KEY_LENGTH_KEY_128 1 |
| #define | OPENTITAN_HMAC_HAS_KEY_LENGTH_KEY_256 1 |
| #define | OPENTITAN_HMAC_HAS_KEY_LENGTH_KEY_384 1 |
| #define | OPENTITAN_HMAC_HAS_KEY_LENGTH_KEY_512 1 |
| #define | OPENTITAN_HMAC_HAS_KEY_LENGTH_KEY_1024 1 |
| #define | OPENTITAN_HMAC_HAS_ENDIANNESS_MESSAGE 1 |
| #define | OPENTITAN_HMAC_HAS_ENDIANNESS_DIGEST 1 |
| #define | OPENTITAN_HMAC_HAS_SECURE_WIPE 1 |
Typedefs | |
| typedef enum dt_hmac | dt_hmac_t |
| List of instances. | |
| typedef enum dt_hmac_reg_block | dt_hmac_reg_block_t |
| List of register blocks. | |
| typedef enum dt_hmac_irq | dt_hmac_irq_t |
| List of IRQs. | |
| typedef enum dt_hmac_alert | dt_hmac_alert_t |
| List of Alerts. | |
| typedef enum dt_hmac_clock | dt_hmac_clock_t |
| List of clock ports. | |
| typedef enum dt_hmac_reset | dt_hmac_reset_t |
| List of reset ports. | |
Enumerations | |
| enum | dt_hmac { kDtHmac = 0 , kDtHmacFirst = 0 , kDtHmacCount = 1 } |
| List of instances. More... | |
| enum | dt_hmac_reg_block { kDtHmacRegBlockCore = 0 , kDtHmacRegBlockCount = 1 } |
| List of register blocks. More... | |
| enum | dt_hmac_irq { kDtHmacIrqHmacDone = 0 , kDtHmacIrqFifoEmpty = 1 , kDtHmacIrqHmacErr = 2 , kDtHmacIrqCount = 3 } |
| List of IRQs. More... | |
| enum | dt_hmac_alert { kDtHmacAlertFatalFault = 0 , kDtHmacAlertCount = 1 } |
| List of Alerts. More... | |
| enum | dt_hmac_clock { kDtHmacClockClk = 0 , kDtHmacClockCount = 1 } |
| List of clock ports. More... | |
| enum | dt_hmac_reset { kDtHmacResetRst = 0 , kDtHmacResetCount = 1 } |
| List of reset ports. More... | |
Functions | |
| dt_hmac_t | dt_hmac_from_instance_id (dt_instance_id_t inst_id) |
| Get the hmac instance from an instance ID. | |
| dt_instance_id_t | dt_hmac_instance_id (dt_hmac_t dt) |
| Get the instance ID of an instance. | |
| uint32_t | dt_hmac_reg_block (dt_hmac_t dt, dt_hmac_reg_block_t reg_block) |
| Get the register base address of an instance. | |
| dt_plic_irq_id_t | dt_hmac_irq_to_plic_id (dt_hmac_t dt, dt_hmac_irq_t irq) |
| Get the PLIC ID of a hmac IRQ for a given instance. | |
| dt_hmac_irq_t | dt_hmac_irq_from_plic_id (dt_hmac_t dt, dt_plic_irq_id_t irq) |
| Convert a global IRQ ID to a local hmac IRQ type. | |
| dt_alert_id_t | dt_hmac_alert_to_alert_id (dt_hmac_t dt, dt_hmac_alert_t alert) |
| Get the alert ID of a hmac alert for a given instance. | |
| dt_hmac_alert_t | dt_hmac_alert_from_alert_id (dt_hmac_t dt, dt_alert_id_t alert) |
| Convert a global alert ID to a local hmac alert type. | |
| dt_clock_t | dt_hmac_clock (dt_hmac_t dt, dt_hmac_clock_t clk) |
| Get the clock signal connected to a clock port of an instance. | |
| dt_reset_t | dt_hmac_reset (dt_hmac_t dt, dt_hmac_reset_t rst) |
| Get the reset signal connected to a reset port of an instance. | |
Device Tables (DT) for IP hmac and top earlgrey.
This file contains the type definitions and global functions of the hmac.
Definition in file dt_hmac.h.
| #define OPENTITAN_HMAC_HAS_MODE_SHA2 1 |
| typedef enum dt_hmac_alert dt_hmac_alert_t |
List of Alerts.
Alerts are guaranteed to be numbered consecutively from 0.
| typedef enum dt_hmac_clock dt_hmac_clock_t |
List of clock ports.
Clock ports are guaranteed to be numbered consecutively from 0.
| typedef enum dt_hmac_irq dt_hmac_irq_t |
List of IRQs.
IRQs are guaranteed to be numbered consecutively from 0.
| typedef enum dt_hmac_reg_block dt_hmac_reg_block_t |
List of register blocks.
Register blocks are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_hmac_reset dt_hmac_reset_t |
List of reset ports.
Reset ports are guaranteed to be numbered consecutively from 0.
| enum dt_hmac_alert |
| enum dt_hmac_clock |
| enum dt_hmac_irq |
List of IRQs.
IRQs are guaranteed to be numbered consecutively from 0.
| enum dt_hmac_reg_block |
| enum dt_hmac_reset |
| dt_hmac_alert_t dt_hmac_alert_from_alert_id | ( | dt_hmac_t | dt, |
| dt_alert_id_t | alert ) |
Convert a global alert ID to a local hmac alert type.
| dt | Instance of hmac. |
| alert | A global alert ID that belongs to this instance. |
kDtHmacAlertCount.Note: This function assumes that the global alert ID belongs to the instance of hmac passed in parameter. In other words, it must be the case that dt_hmac_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtHmacAlertCount.
| dt_alert_id_t dt_hmac_alert_to_alert_id | ( | dt_hmac_t | dt, |
| dt_hmac_alert_t | alert ) |
Get the alert ID of a hmac 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 hmac. |
| alert | A hmac alert. |
| dt_clock_t dt_hmac_clock | ( | dt_hmac_t | dt, |
| dt_hmac_clock_t | clk ) |
| dt_hmac_t dt_hmac_from_instance_id | ( | dt_instance_id_t | inst_id | ) |
Get the hmac 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 hmac, otherwise the returned value is unspecified.
| dt_instance_id_t dt_hmac_instance_id | ( | dt_hmac_t | dt | ) |
| dt_hmac_irq_t dt_hmac_irq_from_plic_id | ( | dt_hmac_t | dt, |
| dt_plic_irq_id_t | irq ) |
Convert a global IRQ ID to a local hmac IRQ type.
| dt | Instance of hmac. |
| irq | A PLIC ID that belongs to this instance. |
kDtHmacIrqCount.Note: This function assumes that the PLIC ID belongs to the instance of hmac passed in parameter. In other words, it must be the case that dt_hmac_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtHmacIrqCount.
| dt_plic_irq_id_t dt_hmac_irq_to_plic_id | ( | dt_hmac_t | dt, |
| dt_hmac_irq_t | irq ) |
| uint32_t dt_hmac_reg_block | ( | dt_hmac_t | dt, |
| dt_hmac_reg_block_t | reg_block ) |
| dt_reset_t dt_hmac_reset | ( | dt_hmac_t | dt, |
| dt_hmac_reset_t | rst ) |