 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP gpio and top earlgrey. More...
#include "hw/top/dt/dt_api.h"#include <stdint.h>Go to the source code of this file.
Macros | |
| #define | OPENTITAN_GPIO_HAS_IN_INTR_CTRL 1 |
| List of supported hardware features. | |
| #define | OPENTITAN_GPIO_HAS_IN_FILTER 1 |
| #define | OPENTITAN_GPIO_HAS_OUT_MASK 1 |
Typedefs | |
| typedef enum dt_gpio | dt_gpio_t |
| List of instances. | |
| typedef enum dt_gpio_reg_block | dt_gpio_reg_block_t |
| List of register blocks. | |
| typedef enum dt_gpio_memory | dt_gpio_memory_t |
| List of memories. | |
| typedef enum dt_gpio_irq | dt_gpio_irq_t |
| List of IRQs. | |
| typedef enum dt_gpio_alert | dt_gpio_alert_t |
| List of Alerts. | |
| typedef enum dt_gpio_clock | dt_gpio_clock_t |
| List of clock ports. | |
| typedef enum dt_gpio_reset | dt_gpio_reset_t |
| List of reset ports. | |
| typedef enum dt_gpio_periph_io | dt_gpio_periph_io_t |
| List of peripheral I/O. | |
Enumerations | |
| enum | dt_gpio { kDtGpio = 0 , kDtGpioFirst = 0 , kDtGpioCount = 1 } |
| List of instances. More... | |
| enum | dt_gpio_reg_block { kDtGpioRegBlockCore = 0 , kDtGpioRegBlockCount = 1 } |
| List of register blocks. More... | |
| enum | dt_gpio_memory { kDtGpioMemoryCount = 0 } |
| List of memories. More... | |
| enum | dt_gpio_irq { kDtGpioIrqGpio0 = 0 , kDtGpioIrqGpio1 = 1 , kDtGpioIrqGpio2 = 2 , kDtGpioIrqGpio3 = 3 , kDtGpioIrqGpio4 = 4 , kDtGpioIrqGpio5 = 5 , kDtGpioIrqGpio6 = 6 , kDtGpioIrqGpio7 = 7 , kDtGpioIrqGpio8 = 8 , kDtGpioIrqGpio9 = 9 , kDtGpioIrqGpio10 = 10 , kDtGpioIrqGpio11 = 11 , kDtGpioIrqGpio12 = 12 , kDtGpioIrqGpio13 = 13 , kDtGpioIrqGpio14 = 14 , kDtGpioIrqGpio15 = 15 , kDtGpioIrqGpio16 = 16 , kDtGpioIrqGpio17 = 17 , kDtGpioIrqGpio18 = 18 , kDtGpioIrqGpio19 = 19 , kDtGpioIrqGpio20 = 20 , kDtGpioIrqGpio21 = 21 , kDtGpioIrqGpio22 = 22 , kDtGpioIrqGpio23 = 23 , kDtGpioIrqGpio24 = 24 , kDtGpioIrqGpio25 = 25 , kDtGpioIrqGpio26 = 26 , kDtGpioIrqGpio27 = 27 , kDtGpioIrqGpio28 = 28 , kDtGpioIrqGpio29 = 29 , kDtGpioIrqGpio30 = 30 , kDtGpioIrqGpio31 = 31 , kDtGpioIrqCount = 32 } |
| List of IRQs. More... | |
| enum | dt_gpio_alert { kDtGpioAlertFatalFault = 0 , kDtGpioAlertCount = 1 } |
| List of Alerts. More... | |
| enum | dt_gpio_clock { kDtGpioClockClk = 0 , kDtGpioClockCount = 1 } |
| List of clock ports. More... | |
| enum | dt_gpio_reset { kDtGpioResetRst = 0 , kDtGpioResetCount = 1 } |
| List of reset ports. More... | |
| enum | dt_gpio_periph_io { kDtGpioPeriphIoGpio0 = 0 , kDtGpioPeriphIoGpio1 = 1 , kDtGpioPeriphIoGpio2 = 2 , kDtGpioPeriphIoGpio3 = 3 , kDtGpioPeriphIoGpio4 = 4 , kDtGpioPeriphIoGpio5 = 5 , kDtGpioPeriphIoGpio6 = 6 , kDtGpioPeriphIoGpio7 = 7 , kDtGpioPeriphIoGpio8 = 8 , kDtGpioPeriphIoGpio9 = 9 , kDtGpioPeriphIoGpio10 = 10 , kDtGpioPeriphIoGpio11 = 11 , kDtGpioPeriphIoGpio12 = 12 , kDtGpioPeriphIoGpio13 = 13 , kDtGpioPeriphIoGpio14 = 14 , kDtGpioPeriphIoGpio15 = 15 , kDtGpioPeriphIoGpio16 = 16 , kDtGpioPeriphIoGpio17 = 17 , kDtGpioPeriphIoGpio18 = 18 , kDtGpioPeriphIoGpio19 = 19 , kDtGpioPeriphIoGpio20 = 20 , kDtGpioPeriphIoGpio21 = 21 , kDtGpioPeriphIoGpio22 = 22 , kDtGpioPeriphIoGpio23 = 23 , kDtGpioPeriphIoGpio24 = 24 , kDtGpioPeriphIoGpio25 = 25 , kDtGpioPeriphIoGpio26 = 26 , kDtGpioPeriphIoGpio27 = 27 , kDtGpioPeriphIoGpio28 = 28 , kDtGpioPeriphIoGpio29 = 29 , kDtGpioPeriphIoGpio30 = 30 , kDtGpioPeriphIoGpio31 = 31 , kDtGpioPeriphIoCount = 32 } |
| List of peripheral I/O. More... | |
Functions | |
| dt_gpio_t | dt_gpio_from_instance_id (dt_instance_id_t inst_id) |
| Get the gpio instance from an instance ID. | |
| dt_instance_id_t | dt_gpio_instance_id (dt_gpio_t dt) |
| Get the instance ID of an instance. | |
| uint32_t | dt_gpio_reg_block (dt_gpio_t dt, dt_gpio_reg_block_t reg_block) |
| Get the register base address of an instance. | |
| uint32_t | dt_gpio_memory_base (dt_gpio_t dt, dt_gpio_memory_t mem) |
| Get the base address of a memory. | |
| uint32_t | dt_gpio_memory_size (dt_gpio_t dt, dt_gpio_memory_t mem) |
| Get the size of a memory. | |
| dt_plic_irq_id_t | dt_gpio_irq_to_plic_id (dt_gpio_t dt, dt_gpio_irq_t irq) |
| Get the PLIC ID of a gpio IRQ for a given instance. | |
| dt_gpio_irq_t | dt_gpio_irq_from_plic_id (dt_gpio_t dt, dt_plic_irq_id_t irq) |
| Convert a global IRQ ID to a local gpio IRQ type. | |
| dt_alert_id_t | dt_gpio_alert_to_alert_id (dt_gpio_t dt, dt_gpio_alert_t alert) |
| Get the alert ID of a gpio alert for a given instance. | |
| dt_gpio_alert_t | dt_gpio_alert_from_alert_id (dt_gpio_t dt, dt_alert_id_t alert) |
| Convert a global alert ID to a local gpio alert type. | |
| dt_periph_io_t | dt_gpio_periph_io (dt_gpio_t dt, dt_gpio_periph_io_t sig) |
| Get the peripheral I/O description of an instance. | |
| dt_clock_t | dt_gpio_clock (dt_gpio_t dt, dt_gpio_clock_t clk) |
| Get the clock signal connected to a clock port of an instance. | |
| dt_reset_t | dt_gpio_reset (dt_gpio_t dt, dt_gpio_reset_t rst) |
| Get the reset signal connected to a reset port of an instance. | |
| uint8_t | dt_gpio_input_period_counter_count (dt_gpio_t dt) |
| Get the number of input period counters. | |
Device Tables (DT) for IP gpio and top earlgrey.
This file contains the type definitions and global functions of the gpio.
Definition in file dt_gpio.h.
| #define OPENTITAN_GPIO_HAS_IN_INTR_CTRL 1 |
| typedef enum dt_gpio_alert dt_gpio_alert_t |
List of Alerts.
Alerts are guaranteed to be numbered consecutively from 0.
| typedef enum dt_gpio_clock dt_gpio_clock_t |
List of clock ports.
Clock ports are guaranteed to be numbered consecutively from 0.
| typedef enum dt_gpio_irq dt_gpio_irq_t |
List of IRQs.
IRQs are guaranteed to be numbered consecutively from 0.
| typedef enum dt_gpio_memory dt_gpio_memory_t |
List of memories.
Memories are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_gpio_periph_io dt_gpio_periph_io_t |
List of peripheral I/O.
Peripheral I/O are guaranteed to be numbered consecutively from 0.
| typedef enum dt_gpio_reg_block dt_gpio_reg_block_t |
List of register blocks.
Register blocks are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_gpio_reset dt_gpio_reset_t |
List of reset ports.
Reset ports are guaranteed to be numbered consecutively from 0.
| enum dt_gpio_alert |
| enum dt_gpio_clock |
| enum dt_gpio_irq |
List of IRQs.
IRQs are guaranteed to be numbered consecutively from 0.
| enum dt_gpio_memory |
| enum dt_gpio_periph_io |
| enum dt_gpio_reg_block |
| enum dt_gpio_reset |
| dt_gpio_alert_t dt_gpio_alert_from_alert_id | ( | dt_gpio_t | dt, |
| dt_alert_id_t | alert ) |
Convert a global alert ID to a local gpio alert type.
| dt | Instance of gpio. |
| alert | A global alert ID that belongs to this instance. |
kDtGpioAlertCount.Note: This function assumes that the global alert ID belongs to the instance of gpio passed in parameter. In other words, it must be the case that dt_gpio_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtGpioAlertCount.
| dt_alert_id_t dt_gpio_alert_to_alert_id | ( | dt_gpio_t | dt, |
| dt_gpio_alert_t | alert ) |
Get the alert ID of a gpio 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 gpio. |
| alert | A gpio alert. |
| dt_clock_t dt_gpio_clock | ( | dt_gpio_t | dt, |
| dt_gpio_clock_t | clk ) |
| dt_gpio_t dt_gpio_from_instance_id | ( | dt_instance_id_t | inst_id | ) |
Get the gpio 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 gpio, otherwise the returned value is unspecified.
| uint8_t dt_gpio_input_period_counter_count | ( | dt_gpio_t | dt | ) |
| dt_instance_id_t dt_gpio_instance_id | ( | dt_gpio_t | dt | ) |
| dt_gpio_irq_t dt_gpio_irq_from_plic_id | ( | dt_gpio_t | dt, |
| dt_plic_irq_id_t | irq ) |
Convert a global IRQ ID to a local gpio IRQ type.
| dt | Instance of gpio. |
| irq | A PLIC ID that belongs to this instance. |
kDtGpioIrqCount.Note: This function assumes that the PLIC ID belongs to the instance of gpio passed in parameter. In other words, it must be the case that dt_gpio_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtGpioIrqCount.
| dt_plic_irq_id_t dt_gpio_irq_to_plic_id | ( | dt_gpio_t | dt, |
| dt_gpio_irq_t | irq ) |
| uint32_t dt_gpio_memory_base | ( | dt_gpio_t | dt, |
| dt_gpio_memory_t | mem ) |
| uint32_t dt_gpio_memory_size | ( | dt_gpio_t | dt, |
| dt_gpio_memory_t | mem ) |
| dt_periph_io_t dt_gpio_periph_io | ( | dt_gpio_t | dt, |
| dt_gpio_periph_io_t | sig ) |
| uint32_t dt_gpio_reg_block | ( | dt_gpio_t | dt, |
| dt_gpio_reg_block_t | reg_block ) |
| dt_reset_t dt_gpio_reset | ( | dt_gpio_t | dt, |
| dt_gpio_reset_t | rst ) |