This section documents the basic types that are used by multiple HAL drivers.
API Reference | |
Result Codes | |
HAL specific return codes definitions for all drivers. | |
System Power Management | |
Interface for changing power states and restricting when they are allowed. | |
Clock | |
Interface for getting and changing clock configuration. | |
Enumerations | |
enum | cyhal_async_mode_t { CYHAL_ASYNC_DMA , CYHAL_ASYNC_SW } |
group_hal_results More... | |
enum | cyhal_edge_type_t { CYHAL_EDGE_TYPE_RISING_EDGE , CYHAL_EDGE_TYPE_FALLING_EDGE , CYHAL_EDGE_TYPE_BOTH_EDGES , CYHAL_EDGE_TYPE_LEVEL } |
Enum of signal edge types. More... | |
enum | cyhal_power_level_t { CYHAL_POWER_LEVEL_OFF , CYHAL_POWER_LEVEL_LOW , CYHAL_POWER_LEVEL_MEDIUM , CYHAL_POWER_LEVEL_HIGH , CYHAL_POWER_LEVEL_DEFAULT } |
Selectable power levels. More... | |
enum | cyhal_signal_type_t { CYHAL_SIGNAL_TYPE_LEVEL = 0 , CYHAL_SIGNAL_TYPE_EDGE = 1 } |
Signal trigger type. More... | |
enum cyhal_async_mode_t |
enum cyhal_edge_type_t |
enum cyhal_power_level_t |
Selectable power levels.
Power levels are defined relative to others. Higher power levels offer better performance but consume more power.
Not all hardware supports four discrete power levels. If fewer power levels are supported, the values will be mapped as follows:
4 Levels | 3 Levels | 2 Levels |
---|---|---|
Off | Off | Off |
Low | Low = Medium | Low = Medium = High = Default |
Medium | High = Default | |
High = Default |
See the implementation specific documentation for details.
enum cyhal_signal_type_t |