 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP kmac 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_KMAC_HAS_MODE_SHA3 1 |
| List of supported hardware features. | |
| #define | OPENTITAN_KMAC_HAS_MODE_SHAKE 1 |
| #define | OPENTITAN_KMAC_HAS_MODE_CSHAKE 1 |
| #define | OPENTITAN_KMAC_HAS_MODE_KMAC 1 |
| #define | OPENTITAN_KMAC_HAS_MODE_XOF 1 |
| #define | OPENTITAN_KMAC_HAS_ENDIANNESS_MESSAGE 1 |
| #define | OPENTITAN_KMAC_HAS_ENDIANNESS_DIGEST 1 |
| #define | OPENTITAN_KMAC_HAS_KEY_SIDELOAD 1 |
| #define | OPENTITAN_KMAC_HAS_ENTROPY_MODES 1 |
Typedefs | |
| typedef enum dt_kmac | dt_kmac_t |
| List of instances. | |
| typedef enum dt_kmac_reg_block | dt_kmac_reg_block_t |
| List of register blocks. | |
| typedef enum dt_kmac_memory | dt_kmac_memory_t |
| List of memories. | |
| typedef enum dt_kmac_irq | dt_kmac_irq_t |
| List of IRQs. | |
| typedef enum dt_kmac_alert | dt_kmac_alert_t |
| List of Alerts. | |
| typedef enum dt_kmac_clock | dt_kmac_clock_t |
| List of clock ports. | |
| typedef enum dt_kmac_reset | dt_kmac_reset_t |
| List of reset ports. | |
Enumerations | |
| enum | dt_kmac { kDtKmac = 0 , kDtKmacFirst = 0 , kDtKmacCount = 1 } |
| List of instances. More... | |
| enum | dt_kmac_reg_block { kDtKmacRegBlockCore = 0 , kDtKmacRegBlockCount = 1 } |
| List of register blocks. More... | |
| enum | dt_kmac_memory { kDtKmacMemoryCount = 0 } |
| List of memories. More... | |
| enum | dt_kmac_irq { kDtKmacIrqKmacDone = 0 , kDtKmacIrqFifoEmpty = 1 , kDtKmacIrqKmacErr = 2 , kDtKmacIrqCount = 3 } |
| List of IRQs. More... | |
| enum | dt_kmac_alert { kDtKmacAlertRecovOperationErr = 0 , kDtKmacAlertFatalFaultErr = 1 , kDtKmacAlertCount = 2 } |
| List of Alerts. More... | |
| enum | dt_kmac_clock { kDtKmacClockClk = 0 , kDtKmacClockEdn = 1 , kDtKmacClockCount = 2 } |
| List of clock ports. More... | |
| enum | dt_kmac_reset { kDtKmacResetRst = 0 , kDtKmacResetEdn = 1 , kDtKmacResetCount = 2 } |
| List of reset ports. More... | |
Functions | |
| dt_kmac_t | dt_kmac_from_instance_id (dt_instance_id_t inst_id) |
| Get the kmac instance from an instance ID. | |
| dt_instance_id_t | dt_kmac_instance_id (dt_kmac_t dt) |
| Get the instance ID of an instance. | |
| uint32_t | dt_kmac_reg_block (dt_kmac_t dt, dt_kmac_reg_block_t reg_block) |
| Get the register base address of an instance. | |
| uint32_t | dt_kmac_memory_base (dt_kmac_t dt, dt_kmac_memory_t mem) |
| Get the base address of a memory. | |
| uint32_t | dt_kmac_memory_size (dt_kmac_t dt, dt_kmac_memory_t mem) |
| Get the size of a memory. | |
| dt_plic_irq_id_t | dt_kmac_irq_to_plic_id (dt_kmac_t dt, dt_kmac_irq_t irq) |
| Get the PLIC ID of a kmac IRQ for a given instance. | |
| dt_kmac_irq_t | dt_kmac_irq_from_plic_id (dt_kmac_t dt, dt_plic_irq_id_t irq) |
| Convert a global IRQ ID to a local kmac IRQ type. | |
| dt_alert_id_t | dt_kmac_alert_to_alert_id (dt_kmac_t dt, dt_kmac_alert_t alert) |
| Get the alert ID of a kmac alert for a given instance. | |
| dt_kmac_alert_t | dt_kmac_alert_from_alert_id (dt_kmac_t dt, dt_alert_id_t alert) |
| Convert a global alert ID to a local kmac alert type. | |
| dt_clock_t | dt_kmac_clock (dt_kmac_t dt, dt_kmac_clock_t clk) |
| Get the clock signal connected to a clock port of an instance. | |
| dt_reset_t | dt_kmac_reset (dt_kmac_t dt, dt_kmac_reset_t rst) |
| Get the reset signal connected to a reset port of an instance. | |
Device Tables (DT) for IP kmac and top darjeeling.
This file contains the type definitions and global functions of the kmac.
Definition in file dt_kmac.h.
| #define OPENTITAN_KMAC_HAS_MODE_SHA3 1 |
| typedef enum dt_kmac_alert dt_kmac_alert_t |
List of Alerts.
Alerts are guaranteed to be numbered consecutively from 0.
| typedef enum dt_kmac_clock dt_kmac_clock_t |
List of clock ports.
Clock ports are guaranteed to be numbered consecutively from 0.
| typedef enum dt_kmac_irq dt_kmac_irq_t |
List of IRQs.
IRQs are guaranteed to be numbered consecutively from 0.
| typedef enum dt_kmac_memory dt_kmac_memory_t |
List of memories.
Memories are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_kmac_reg_block dt_kmac_reg_block_t |
List of register blocks.
Register blocks are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_kmac_reset dt_kmac_reset_t |
List of reset ports.
Reset ports are guaranteed to be numbered consecutively from 0.
| enum dt_kmac_alert |
List of Alerts.
Alerts are guaranteed to be numbered consecutively from 0.
| enum dt_kmac_clock |
| enum dt_kmac_irq |
List of IRQs.
IRQs are guaranteed to be numbered consecutively from 0.
| enum dt_kmac_memory |
| enum dt_kmac_reg_block |
| enum dt_kmac_reset |
| dt_kmac_alert_t dt_kmac_alert_from_alert_id | ( | dt_kmac_t | dt, |
| dt_alert_id_t | alert ) |
Convert a global alert ID to a local kmac alert type.
| dt | Instance of kmac. |
| alert | A global alert ID that belongs to this instance. |
kDtKmacAlertCount.Note: This function assumes that the global alert ID belongs to the instance of kmac passed in parameter. In other words, it must be the case that dt_kmac_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtKmacAlertCount.
| dt_alert_id_t dt_kmac_alert_to_alert_id | ( | dt_kmac_t | dt, |
| dt_kmac_alert_t | alert ) |
Get the alert ID of a kmac 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 kmac. |
| alert | A kmac alert. |
| dt_clock_t dt_kmac_clock | ( | dt_kmac_t | dt, |
| dt_kmac_clock_t | clk ) |
| dt_kmac_t dt_kmac_from_instance_id | ( | dt_instance_id_t | inst_id | ) |
Get the kmac 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 kmac, otherwise the returned value is unspecified.
| dt_instance_id_t dt_kmac_instance_id | ( | dt_kmac_t | dt | ) |
| dt_kmac_irq_t dt_kmac_irq_from_plic_id | ( | dt_kmac_t | dt, |
| dt_plic_irq_id_t | irq ) |
Convert a global IRQ ID to a local kmac IRQ type.
| dt | Instance of kmac. |
| irq | A PLIC ID that belongs to this instance. |
kDtKmacIrqCount.Note: This function assumes that the PLIC ID belongs to the instance of kmac passed in parameter. In other words, it must be the case that dt_kmac_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtKmacIrqCount.
| dt_plic_irq_id_t dt_kmac_irq_to_plic_id | ( | dt_kmac_t | dt, |
| dt_kmac_irq_t | irq ) |
| uint32_t dt_kmac_memory_base | ( | dt_kmac_t | dt, |
| dt_kmac_memory_t | mem ) |
| uint32_t dt_kmac_memory_size | ( | dt_kmac_t | dt, |
| dt_kmac_memory_t | mem ) |
| uint32_t dt_kmac_reg_block | ( | dt_kmac_t | dt, |
| dt_kmac_reg_block_t | reg_block ) |
| dt_reset_t dt_kmac_reset | ( | dt_kmac_t | dt, |
| dt_kmac_reset_t | rst ) |