 |
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 |
| ►System Power Management | Interface for changing power states and restricting when they are allowed |
| ►Clock | Interface for getting and changing clock configuration |
| 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 |
| ▼ADC (Analog to Digital Converter) | High level interface for interacting with the analog to digital converter (ADC) |
| ADC HAL Results | ADC specific return codes |
| ▼Clock | Interface for getting and changing clock configuration |
| Clock HAL Results | Clock specific return codes |
| Group_hal_tolerance | |
| ▼COMP (Analog Comparator) | High level interface for interacting with an analog Comparator |
| Comparator HAL Results | Comparator specific return codes |
| ▼DMA (Direct Memory Access) | High level interface for interacting with the direct memory access (DMA) |
| DMA HAL Results | DMA specific return codes |
| ▼EZI2C (Inter-Integrated Circuit) | High level interface for interacting with the Cypress EZ Inter-Integrated Circuit (EZI2C) |
| EZI2C HAL Results | EZI2C specific return codes |
| ▼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 |
| ▼I2S (Inter-IC Sound) | High level interface for interacting with the Inter-IC Sound (I2S) |
| I2S HAL Results | I2S specific return codes |
| ▼I3C (Improved Inter-Integrated Circuit) | High level interface for interacting with the Infineon I3C |
| ►Result Codes | HAL specific return codes definitions for all drivers |
| ▼Interconnect (Internal Digital Routing) | High level interface to the Infineon digital routing |
| Interconnect HAL Results | Interconnect 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 |
| ▼PDM/PCM (Pulse-Density Modulation to Pulse-Code Modulation Converter) | High level interface for interacting with the pulse-density modulation to pulse-code modulation (PDM/PCM) converter |
| PDM/PCM HAL Results | PDM/PCM specific return codes |
| ▼PWM (Pulse Width Modulator) | High level interface for interacting with the pulse width modulator (PWM) hardware resource |
| PWM HAL Results | PWM specific return codes |
| ▼QSPI (Quad Serial Peripheral Interface) | High level interface for interacting with the Quad-SPI interface |
| QSPI HAL Results | QSPI specific return codes |
| ▼Quadrature Decoder | High level interface for interacting with the Quadrature Decoder hardware resource |
| Quadrature Decoder HAL Results | Quadrature Decoder specific return codes |
| ▼RTC (Real-Time Clock) | High level interface for interacting with the real-time clock (RTC) |
| RTC HAL Results | RTC specific return codes |
| ▼SDIO (Secure Digital Input Output) | High level interface to the Secure Digital Input Output (SDIO) |
| SDIO HAL Results | SDIO 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 |
| ▼TDM (Time Division Multiplexed) | High level interface for interacting with the Time Division Multiplexed controller (TDM) |
| TDM HAL Results | TDM 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 |
| T2Timer | |
| ▼CAT5 (AIROC™) Implementation Specific | This section provides details about the CAT5 (AIROC™) implementation of the Cypress HAL |
| Clocks | Implementation specific interface for using the Clock driver |
| DMA (Direct Memory Access) | DMA allows transferring data without CPU intervention |
| HAL Driver Availability Macros | |
| CAT5 Specific Hardware Types | Aliases for types which are part of the public HAL interface but whose representations need to vary per HAL implementation |
| Pins | Definitions for the pinout for each supported device |
| RTC (Real-Time Clock) | |
| Syspm | |
| ADC (Analog Digital Converter) | |
| COMP (Analog Comparator) | On CAT5, the comparator driver is used to control the x2 LPComp (Low Power Comparator) HW blocks |
| PDM/PCM (Pulse Density Modulation to Pulse Code Modulation Converter) | The CAT5 PDM/PCM Supports the following conversion parameters: |
| PWM (Pulse Width Modulator) | |
| QSPI (Quad Serial Peripheral Interface) | |
| QuadDec (Quadrature Decoder) | |
| SDIO (Secure Digital Input Output) | The SDIO device HAL implemenation for CAT5 is available only for CYW955900 family of devices |
| SPI (Serial Peripheral Interface) | |
| Trigger Connections | Trigger connections for supported device families: |