 |
Hardware Abstraction Layer (HAL)
|
|
Hardware Abstraction Layer (HAL)
|
| ▼HAL General Types/Macros | This section documents the basic types and macros that are used by multiple HAL drivers |
| Result Type | |
| ▼General Types | This section documents the basic types that are used by multiple HAL drivers |
| ▼Result Codes | HAL specific return codes definitions for all drivers |
| Clock HAL Results | Clock specific return codes |
| DMA HAL Results | DMA specific return codes |
| Ethernet HAL Results | Ethernet specific return codes |
| GPIO HAL Results | GPIO specific return codes |
| HWMGR HAL Results | HWMGR specific return codes |
| I2C HAL Results | I2C specific return codes |
| IPC HAL Results | IPC specific return codes |
| LPTimer HAL Results | LPTimer specific return codes |
| PWM HAL Results | PWM specific return codes |
| SPI HAL Results | SPI specific return codes |
| SYSPM HAL Results | SYSPM specific return codes |
| SYSTEM HAL Results | SYSTEM specific return codes |
| Timer HAL Results | Timer specific return codes |
| UART HAL Results | UART specific return codes |
| WDT HAL Results | WDT specific return codes |
| ▼System Power Management | Interface for changing power states and restricting when they are allowed |
| SYSPM HAL Results | SYSPM specific return codes |
| ▼Clock | Interface for getting and changing clock configuration |
| Clock HAL Results | Clock specific return codes |
| Group_hal_tolerance | |
| Overrideable Macros | These macros can be defined to a custom value globally to modify the behavior of the HAL |
| Implementation Specific Types | The following types are used by the HAL, but are defined by the implementation |
| HAL Driver Availability | This section documents the macros that can be used to check if a specific driver is available for the current device |
| ▼HAL Drivers | This section documents the drivers which form the stable API of the ModusToolbox™ HAL |
| ▼Clock | Interface for getting and changing clock configuration |
| Clock HAL Results | Clock specific return codes |
| Group_hal_tolerance | |
| ▼DMA (Direct Memory Access) | High level interface for interacting with the direct memory access (DMA) |
| DMA HAL Results | DMA specific return codes |
| ▼Ethernet (Ethernet interface) | High level interface for interacting with the Ethernet |
| Ethernet HAL Results | Ethernet specific return codes |
| Group_hal_ethernet_header | Some Ethernet Header types (see IEEE 802.3 for full list) |
| ▼System Power Management | Interface for changing power states and restricting when they are allowed |
| SYSPM HAL Results | SYSPM specific return codes |
| ▼GPIO (General Purpose Input Output) | High level interface for configuring and interacting with general purpose input/outputs (GPIO) |
| GPIO HAL Results | GPIO specific return codes |
| ▼HWMGR (Hardware Manager) | High level interface to the Hardware Manager |
| HWMGR HAL Results | HWMGR specific return codes |
| ▼I2C (Inter-Integrated Circuit) | High level interface for interacting with the I2C resource |
| I2C HAL Results | I2C specific return codes |
| ▼IPC (Inter-Processor Communication) | High level interface for communicating between processors on a multi-core device |
| IPC HAL Results | IPC specific return codes |
| ▼LPTimer (Low-Power Timer) | High level interface for interacting with the low-power timer (LPTimer) |
| LPTimer HAL Results | LPTimer specific return codes |
| M2M DMA (Memory-to-Memory Direct Memory Access) | High level interface for interacting with the memory-to-memory direct memory access (DMA) |
| ▼PWM (Pulse Width Modulator) | High level interface for interacting with the pulse width modulator (PWM) hardware resource |
| PWM HAL Results | PWM specific return codes |
| ▼SPI (Serial Peripheral Interface) | High level interface for interacting with the Serial Peripheral Interface (SPI) |
| SPI HAL Results | SPI specific return codes |
| ▼System | High level interface for interacting with reset and delays |
| SYSTEM HAL Results | SYSTEM specific return codes |
| ▼Timer (Timer/Counter) | High level interface for interacting with the Timer/Counter hardware resource |
| Timer HAL Results | Timer specific return codes |
| ▼UART (Universal Asynchronous Receiver-Transmitter) | High level interface for interacting with the Universal Asynchronous Receiver-Transmitter (UART) |
| UART HAL Results | UART specific return codes |
| ▼WDT (Watchdog Timer) | High level interface to the Watchdog Timer (WDT) |
| WDT HAL Results | WDT specific return codes |
| ▼CAT4 (4390X) Implementation Specific | This section provides details about the 4390X implementation of the Cypress HAL |
| Clocks | Implementation specific interface for using the Clock driver |
| DMA (Direct Memory Access) | DMA allows transferring data in SRAM without CPU intervention |
| ▼4390X Specific Hardware Types | Aliases for types which are part of the public HAL interface but whose representations need to vary per HAL implementation |
| Group_hal_ethernet_header | Some Ethernet Header types (see IEEE 802.3 for full list) |
| M2M DMA (Memory-to-Memory Direct Memory Access) | M2M DMA allows transferring data between memory regions without CPU intervention |
| Pins | Definitions for the pinout for each supported device |
| System | Routines for accessing global resources shared across multiple drivers |
| Triggers | Trigger connections for supported device families |
| I2C | |
| PWM (Pulse Width Modulator) | |
| SPI | |
| Power Management | CAT4 (CYW943907 and CYW954907) devices use SLEEP and DEEPSLEEP |
| Timer | |
| UART |