 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP pwm 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_PWM_HAS_DUTYCYCLE 1 |
| List of supported hardware features. | |
| #define | OPENTITAN_PWM_HAS_BLINK 1 |
| #define | OPENTITAN_PWM_HAS_HEARTBEAT 1 |
| #define | OPENTITAN_PWM_HAS_POLARITY 1 |
| #define | OPENTITAN_PWM_HAS_CLOCKDIVIDER 1 |
| #define | OPENTITAN_PWM_HAS_PHASEDELAY 1 |
Typedefs | |
| typedef enum dt_pwm | dt_pwm_t |
| List of instances. | |
| typedef enum dt_pwm_reg_block | dt_pwm_reg_block_t |
| List of register blocks. | |
| typedef enum dt_pwm_memory | dt_pwm_memory_t |
| List of memories. | |
| typedef enum dt_pwm_alert | dt_pwm_alert_t |
| List of Alerts. | |
| typedef enum dt_pwm_clock | dt_pwm_clock_t |
| List of clock ports. | |
| typedef enum dt_pwm_reset | dt_pwm_reset_t |
| List of reset ports. | |
| typedef enum dt_pwm_periph_io | dt_pwm_periph_io_t |
| List of peripheral I/O. | |
Enumerations | |
| enum | dt_pwm { kDtPwmAon = 0 , kDtPwmFirst = 0 , kDtPwmCount = 1 } |
| List of instances. More... | |
| enum | dt_pwm_reg_block { kDtPwmRegBlockCore = 0 , kDtPwmRegBlockCount = 1 } |
| List of register blocks. More... | |
| enum | dt_pwm_memory { kDtPwmMemoryCount = 0 } |
| List of memories. More... | |
| enum | dt_pwm_alert { kDtPwmAlertFatalFault = 0 , kDtPwmAlertCount = 1 } |
| List of Alerts. More... | |
| enum | dt_pwm_clock { kDtPwmClockClk = 0 , kDtPwmClockCore = 1 , kDtPwmClockCount = 2 } |
| List of clock ports. More... | |
| enum | dt_pwm_reset { kDtPwmResetRst = 0 , kDtPwmResetCore = 1 , kDtPwmResetCount = 2 } |
| List of reset ports. More... | |
| enum | dt_pwm_periph_io { kDtPwmPeriphIoPwm0 = 0 , kDtPwmPeriphIoPwm1 = 1 , kDtPwmPeriphIoPwm2 = 2 , kDtPwmPeriphIoPwm3 = 3 , kDtPwmPeriphIoPwm4 = 4 , kDtPwmPeriphIoPwm5 = 5 , kDtPwmPeriphIoCount = 6 } |
| List of peripheral I/O. More... | |
Functions | |
| dt_pwm_t | dt_pwm_from_instance_id (dt_instance_id_t inst_id) |
| Get the pwm instance from an instance ID. | |
| dt_instance_id_t | dt_pwm_instance_id (dt_pwm_t dt) |
| Get the instance ID of an instance. | |
| uint32_t | dt_pwm_reg_block (dt_pwm_t dt, dt_pwm_reg_block_t reg_block) |
| Get the register base address of an instance. | |
| uint32_t | dt_pwm_memory_base (dt_pwm_t dt, dt_pwm_memory_t mem) |
| Get the base address of a memory. | |
| uint32_t | dt_pwm_memory_size (dt_pwm_t dt, dt_pwm_memory_t mem) |
| Get the size of a memory. | |
| dt_alert_id_t | dt_pwm_alert_to_alert_id (dt_pwm_t dt, dt_pwm_alert_t alert) |
| Get the alert ID of a pwm alert for a given instance. | |
| dt_pwm_alert_t | dt_pwm_alert_from_alert_id (dt_pwm_t dt, dt_alert_id_t alert) |
| Convert a global alert ID to a local pwm alert type. | |
| dt_periph_io_t | dt_pwm_periph_io (dt_pwm_t dt, dt_pwm_periph_io_t sig) |
| Get the peripheral I/O description of an instance. | |
| dt_clock_t | dt_pwm_clock (dt_pwm_t dt, dt_pwm_clock_t clk) |
| Get the clock signal connected to a clock port of an instance. | |
| dt_reset_t | dt_pwm_reset (dt_pwm_t dt, dt_pwm_reset_t rst) |
| Get the reset signal connected to a reset port of an instance. | |
| uint8_t | dt_pwm_output_channel_count (dt_pwm_t dt) |
| Get the Number of output channels. | |
Device Tables (DT) for IP pwm and top earlgrey.
This file contains the type definitions and global functions of the pwm.
Definition in file dt_pwm.h.
| #define OPENTITAN_PWM_HAS_DUTYCYCLE 1 |
| typedef enum dt_pwm_alert dt_pwm_alert_t |
List of Alerts.
Alerts are guaranteed to be numbered consecutively from 0.
| typedef enum dt_pwm_clock dt_pwm_clock_t |
List of clock ports.
Clock ports are guaranteed to be numbered consecutively from 0.
| typedef enum dt_pwm_memory dt_pwm_memory_t |
List of memories.
Memories are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_pwm_periph_io dt_pwm_periph_io_t |
List of peripheral I/O.
Peripheral I/O are guaranteed to be numbered consecutively from 0.
| typedef enum dt_pwm_reg_block dt_pwm_reg_block_t |
List of register blocks.
Register blocks are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_pwm_reset dt_pwm_reset_t |
List of reset ports.
Reset ports are guaranteed to be numbered consecutively from 0.
| enum dt_pwm_alert |
| enum dt_pwm_clock |
| enum dt_pwm_memory |
| enum dt_pwm_periph_io |
| enum dt_pwm_reg_block |
| enum dt_pwm_reset |
| dt_pwm_alert_t dt_pwm_alert_from_alert_id | ( | dt_pwm_t | dt, |
| dt_alert_id_t | alert ) |
Convert a global alert ID to a local pwm alert type.
| dt | Instance of pwm. |
| alert | A global alert ID that belongs to this instance. |
kDtPwmAlertCount.Note: This function assumes that the global alert ID belongs to the instance of pwm passed in parameter. In other words, it must be the case that dt_pwm_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtPwmAlertCount.
| dt_alert_id_t dt_pwm_alert_to_alert_id | ( | dt_pwm_t | dt, |
| dt_pwm_alert_t | alert ) |
Get the alert ID of a pwm 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 pwm. |
| alert | A pwm alert. |
| dt_clock_t dt_pwm_clock | ( | dt_pwm_t | dt, |
| dt_pwm_clock_t | clk ) |
| dt_pwm_t dt_pwm_from_instance_id | ( | dt_instance_id_t | inst_id | ) |
Get the pwm 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 pwm, otherwise the returned value is unspecified.
| dt_instance_id_t dt_pwm_instance_id | ( | dt_pwm_t | dt | ) |
| uint32_t dt_pwm_memory_base | ( | dt_pwm_t | dt, |
| dt_pwm_memory_t | mem ) |
| uint32_t dt_pwm_memory_size | ( | dt_pwm_t | dt, |
| dt_pwm_memory_t | mem ) |
| uint8_t dt_pwm_output_channel_count | ( | dt_pwm_t | dt | ) |
| dt_periph_io_t dt_pwm_periph_io | ( | dt_pwm_t | dt, |
| dt_pwm_periph_io_t | sig ) |
| uint32_t dt_pwm_reg_block | ( | dt_pwm_t | dt, |
| dt_pwm_reg_block_t | reg_block ) |
| dt_reset_t dt_pwm_reset | ( | dt_pwm_t | dt, |
| dt_pwm_reset_t | rst ) |