 |
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 |
| ADC HAL Results | ADC specific return codes |
| Clock HAL Results | Clock specific return codes |
| DMA HAL Results | DMA specific return codes |
| GPIO HAL Results | GPIO specific return codes |
| I2C HAL Results | I2C specific return codes |
| LPTimer HAL Results | LPTimer specific return codes |
| MemorySPI HAL Results | MemorySPI specific return codes |
| NVM HAL Results | NVM specific return codes |
| PWM HAL Results | PWM specific return codes |
| RTC HAL Results | RTC specific return codes |
| SDHC HAL Results | SDHC specific return codes |
| SDIO HAL Results | SDIO 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 |
| TRNG HAL Results | TRNG specific return codes |
| UART HAL Results | UART specific return codes |
| 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 enabling or disabling the clock and updating the clock frequency |
| Clock HAL Results | Clock 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 |
| ▼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 |
| ▼I2C (Inter-Integrated Circuit) | High level interface for interacting with the I2C resource |
| I2C HAL Results | I2C 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 |
| ▼MemorySPI (Memory Serial Peripheral Interface) | High level interface for interacting with the Memory SPI interface |
| MemorySPI HAL Results | MemorySPI specific return codes |
| ▼NVM (Onboard Non-Volatile Memory) | High level interface to the onboard Non-Volatile memory (Internal Flash, RRAM, OTP region) |
| NVM HAL Results | NVM 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 |
| ▼RTC (Real-Time Clock) | High level interface for interacting with the real-time clock (RTC) |
| RTC HAL Results | RTC specific return codes |
| ▼SDHC (SD Host Controller) | High level interface to the Secure Digital Host Controller (SDHC) |
| SDHC HAL Results | SDHC 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 Power Management | Interface for changing power states and restricting when they are allowed |
| SYSPM HAL Results | SYSPM 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 |
| ▼TRNG (True Random Number Generator) | High level interface to the True Random Number Generator (TRNG) |
| TRNG HAL Results | TRNG 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 |
| ▼Implementation Specific | This section provides details about the implementation of the Infineon HAL |
| ▼DMA (Direct Memory Access) | DW (DataWire) is one of two DMA hardware implementations |
| DMAC (Direct Memory Access Controller) | Implementation specific interface for using the DMAC peripheral |
| Specific Hardware Types | Aliases for types which are part of the public HAL interface but whose representations need to vary per HAL implementation |
| LPTimer (Low-Power Timer) | The the maximum number of ticks that can be set to an LPTimer is 0xFFFFFFFF since C0 and C1 do not cascade |
| System Power Management | The Power Management has the following characteristics: MTB_HAL_SYSPM_CB_SYSTEM_NORMAL equates to the Low Power mode MTB_HAL_SYSPM_CB_SYSTEM_LOW equates to the Ultra Low Power mode |
| TRNG (True Random Number Generator) | Initialization polynomial values for the True Random Number Generator |
| MemorySPI (Memory Serial Peripheral Interface) | |
| RTC (Real Time Clock) | Internally the RTC only stores the year as a two digit BCD value (0-99); no century information is stored |
| SDHC (SD Host Controller) | The PDL has the following weak functions to support the use of dedicated pins for card detect, write protect, pwr en, and io select signals |
| SPI (Serial Peripheral Interface) |