 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP dma and top darjeeling. More...
Go to the source code of this file.
Typedefs | |
| typedef enum dt_dma | dt_dma_t |
| List of instances. | |
| typedef enum dt_dma_reg_block | dt_dma_reg_block_t |
| List of register blocks. | |
| typedef enum dt_dma_irq | dt_dma_irq_t |
| List of IRQs. | |
| typedef enum dt_dma_alert | dt_dma_alert_t |
| List of Alerts. | |
| typedef enum dt_dma_clock | dt_dma_clock_t |
| List of clock ports. | |
| typedef enum dt_dma_reset | dt_dma_reset_t |
| List of reset ports. | |
Enumerations | |
| enum | dt_dma { kDtDma = 0 , kDtDmaFirst = 0 , kDtDmaCount = 1 } |
| List of instances. More... | |
| enum | dt_dma_reg_block { kDtDmaRegBlockCore = 0 , kDtDmaRegBlockCount = 1 } |
| List of register blocks. More... | |
| enum | dt_dma_irq { kDtDmaIrqDmaDone = 0 , kDtDmaIrqDmaChunkDone = 1 , kDtDmaIrqDmaError = 2 , kDtDmaIrqCount = 3 } |
| List of IRQs. More... | |
| enum | dt_dma_alert { kDtDmaAlertFatalFault = 0 , kDtDmaAlertCount = 1 } |
| List of Alerts. More... | |
| enum | dt_dma_clock { kDtDmaClockClk = 0 , kDtDmaClockCount = 1 } |
| List of clock ports. More... | |
| enum | dt_dma_reset { kDtDmaResetRst = 0 , kDtDmaResetCount = 1 } |
| List of reset ports. More... | |
Functions | |
| dt_dma_t | dt_dma_from_instance_id (dt_instance_id_t inst_id) |
| Get the dma instance from an instance ID. | |
| dt_instance_id_t | dt_dma_instance_id (dt_dma_t dt) |
| Get the instance ID of an instance. | |
| uint32_t | dt_dma_reg_block (dt_dma_t dt, dt_dma_reg_block_t reg_block) |
| Get the register base address of an instance. | |
| dt_plic_irq_id_t | dt_dma_irq_to_plic_id (dt_dma_t dt, dt_dma_irq_t irq) |
| Get the PLIC ID of a dma IRQ for a given instance. | |
| dt_dma_irq_t | dt_dma_irq_from_plic_id (dt_dma_t dt, dt_plic_irq_id_t irq) |
| Convert a global IRQ ID to a local dma IRQ type. | |
| dt_alert_id_t | dt_dma_alert_to_alert_id (dt_dma_t dt, dt_dma_alert_t alert) |
| Get the alert ID of a dma alert for a given instance. | |
| dt_dma_alert_t | dt_dma_alert_from_alert_id (dt_dma_t dt, dt_alert_id_t alert) |
| Convert a global alert ID to a local dma alert type. | |
| dt_clock_t | dt_dma_clock (dt_dma_t dt, dt_dma_clock_t clk) |
| Get the clock signal connected to a clock port of an instance. | |
| dt_reset_t | dt_dma_reset (dt_dma_t dt, dt_dma_reset_t rst) |
| Get the reset signal connected to a reset port of an instance. | |
Device Tables (DT) for IP dma and top darjeeling.
This file contains the type definitions and global functions of the dma.
Definition in file dt_dma.h.
| typedef enum dt_dma_alert dt_dma_alert_t |
List of Alerts.
Alerts are guaranteed to be numbered consecutively from 0.
| typedef enum dt_dma_clock dt_dma_clock_t |
List of clock ports.
Clock ports are guaranteed to be numbered consecutively from 0.
| typedef enum dt_dma_irq dt_dma_irq_t |
List of IRQs.
IRQs are guaranteed to be numbered consecutively from 0.
| typedef enum dt_dma_reg_block dt_dma_reg_block_t |
List of register blocks.
Register blocks are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_dma_reset dt_dma_reset_t |
List of reset ports.
Reset ports are guaranteed to be numbered consecutively from 0.
| enum dt_dma_alert |
| enum dt_dma_clock |
| enum dt_dma_irq |
List of IRQs.
IRQs are guaranteed to be numbered consecutively from 0.
| enum dt_dma_reg_block |
| enum dt_dma_reset |
| dt_dma_alert_t dt_dma_alert_from_alert_id | ( | dt_dma_t | dt, |
| dt_alert_id_t | alert ) |
Convert a global alert ID to a local dma alert type.
| dt | Instance of dma. |
| alert | A global alert ID that belongs to this instance. |
kDtDmaAlertCount.Note: This function assumes that the global alert ID belongs to the instance of dma passed in parameter. In other words, it must be the case that dt_dma_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtDmaAlertCount.
| dt_alert_id_t dt_dma_alert_to_alert_id | ( | dt_dma_t | dt, |
| dt_dma_alert_t | alert ) |
Get the alert ID of a dma 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 dma. |
| alert | A dma alert. |
| dt_clock_t dt_dma_clock | ( | dt_dma_t | dt, |
| dt_dma_clock_t | clk ) |
| dt_dma_t dt_dma_from_instance_id | ( | dt_instance_id_t | inst_id | ) |
Get the dma 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 dma, otherwise the returned value is unspecified.
| dt_instance_id_t dt_dma_instance_id | ( | dt_dma_t | dt | ) |
| dt_dma_irq_t dt_dma_irq_from_plic_id | ( | dt_dma_t | dt, |
| dt_plic_irq_id_t | irq ) |
Convert a global IRQ ID to a local dma IRQ type.
| dt | Instance of dma. |
| irq | A PLIC ID that belongs to this instance. |
kDtDmaIrqCount.Note: This function assumes that the PLIC ID belongs to the instance of dma passed in parameter. In other words, it must be the case that dt_dma_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtDmaIrqCount.
| dt_plic_irq_id_t dt_dma_irq_to_plic_id | ( | dt_dma_t | dt, |
| dt_dma_irq_t | irq ) |
| uint32_t dt_dma_reg_block | ( | dt_dma_t | dt, |
| dt_dma_reg_block_t | reg_block ) |
| dt_reset_t dt_dma_reset | ( | dt_dma_t | dt, |
| dt_dma_reset_t | rst ) |