| ▼SYSPM Callback API Reference | |
| DMA Deep Sleep Callback | Implementation of the DMA Deep Sleep callbacks |
| I2S and TDM Deep Sleep Callback | Implementation of the I2S and TDM Deep Sleep callback |
| NVM Deep Sleep Callback | Implementation of the NVM Deep Sleep callback |
| PDL Aliases | All the following deepsleep callbacks are defined in the PDL and this file only reports the documentation about them as weel as the redefinition to match the asset's signature |
| PDM PCM Deep Sleep Callback | Implementation of the PDM PCM Deep Sleep callback |
| SCB UART Deep Sleep Callback | Implementation of the SCB UART Deep Sleep callback |
| SMIF Deep Sleep Callback | Implementation of the SMIF Deep Sleep callback |
| SYSPM Callbacks Availability | This section documents the macros that can be used to check if a specific callback is available for the current device |
| TCPWM Deep Sleep Callback | Implementation of the TCPWM Deep Sleep callback |
| ▼HAL API Reference | |
| ►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 |
| ►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 |
| ►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 |
| ►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 |
| Comparator HAL Results | Comparator 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 |
| ►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 maximum number of ticks that can set to an LPTimer is 0xFFF0FFFF |
| System Power Management | The Power Management has the following characteristics:
MTB_HAL_SYSPM_CB_SYSTEM_HIGH equates to the High Power mode
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) | |
| NVM (Onboard Non-Volatile Memory) | File Name: mtb_hal_nvm_mxs22rramc.c |
| 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) | |
| ▼PDL API Reference | |
| ►AUTONOMOUS ANALOG (Autonomous Analog Block) | This driver provides API functions to configure the Autonomous Analog |
| ►AC (Autonomous Controller) | This driver provides API functions to configure the Autonomous Controller (AC) subsystem within the Autonomous Analog |
| Macros | |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►CTB (Continuous Time Block) | This driver provides API functions to configure the CTB subsystem of the Autonomous Analog |
| Macros | |
| ►Functions | |
| Initialization Functions | This set of functions is used to configure the CTB |
| Data Structures | |
| Enumerated Types | |
| ►PTComp (Programmable Threshold Comparator) | This driver provides API functions to configure the PTComp subsystem of the Autonomous Analog |
| Macros | |
| ►Functions | |
| Initialization Functions | This set of functions is used to configure the PTComp |
| Data Structures | |
| Enumerated Types | |
| ►CT DAC (Continuous Time Digital to Analog Converter) | This driver provides API functions to configure the CT DAC subsystem of the Autonomous Analog |
| Macros | |
| ►Functions | |
| Initialization Functions | This set of functions is used to configure the DAC |
| LUT Functions | This set of functions is used for data handling in the DAC look-up table |
| Data Structures | |
| Enumerated Types | |
| ►SAR ADC (Successive-Approximation Register Analog to Digital Converter) | This driver provides the API functions to configure the successive approximation register analog-to-digital converter (SAR ADC) subsystem of the Autonomous Analog |
| ►Macros | |
| High Speed Channels and Masks | The ADC HS mode: can be ORed together and applied to the cy_stc_autanalog_sar_seq_tab_hs_t::chanEn |
| Low Power Channels and Masks | The ADC LP mode |
| FIR filter Channels and Masks | |
| ►Functions | |
| Initialization Functions | This set of functions is used to configure the ADC |
| Status Functions | |
| Conversion Functions | |
| FIR Filter Functions | |
| Data Structures | |
| Enumerated Types | |
| ►FIFO (The buffer block to store collected data) | The FIFO subsystem is used to store the ADC data or the FIR filter results |
| Macros | |
| ►Functions | |
| Initialization Functions | This set of functions is used to configure the FIFO |
| Interrupt Functions | This set of functions is used to handle interrupts in the FIFO |
| Data Structures | |
| Enumerated Types | |
| ►General section of the API | |
| Macros | |
| ►Functions | |
| Initialization/Deinitialization Functions | This set of functions is used to Init/Deinit the Autonomous Analog |
| Interrupt Functions | This set of functions is used to handle general interrupts in the Autonomous Analog |
| Data Structures | |
| Enumerated Types | |
| ►AXIDMAC (AXI Direct Memory Access Controller) | Configures the AXIDMA Controller block, channels and descriptors |
| ►Macros | |
| Interrupt Masks | |
| Interrupt Masks | |
| ►Functions | |
| Block Functions | |
| Channel Functions | |
| Descriptor Functions | |
| Data Structures | |
| Enumerated Types | |
| ►CAN FD (CAN with Flexible Data-Rate) | The CAN FD driver provides an easy method to access the CAN FD IP block registers and provides simple functionality for sending and receiving data between devices in the CAN FD network |
| ►Macros | This section describes the CAN FD Macros |
| RX Interrupt masks | This section contains interrupt bit masks to be used with: |
| TX Interrupt masks | This section contains interrupt bit masks to use with: |
| Error Interrupt masks | This section contains interrupt bit masks to be used with: |
| Interrupt line selection masks | Interrupt line selection masks |
| Protocol Status Register (PSR) masks | Masks and bit positions of the Protocol Status Register (PSR) fields |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►CMSIS Utilities | This module provides wrapper functions and configuration structs to facilitate the initialization of the following standard ARM hardware blocks: |
| Functions | |
| Data Structures | |
| ►Crypto (Cryptography) | |
| ►Direct Crypto Core Access | Use the low-level API for direct access to the Crypto hardware |
| ►Control and Status | |
| Functions | |
| ►Symmetric Key Algorithms (AES, GCM, DES, TDES) | |
| Functions | |
| ►Asymmetric Key Algorithms (RSA, ECP, ECDSA, EDDSA) | |
| Functions | |
| Enumerated Types | |
| ►Hash Operations (SHA) | |
| Functions | |
| ►Message Authentication Code (CMAC, HMAC) | |
| Functions | |
| ►Key Derivative Function (HKDF) | |
| Functions | |
| ►Cyclic Redundancy Code (CRC) | |
| Functions | |
| ►Random Number Generation (TRNG, PRNG) | |
| Functions | |
| ►Vector Unit (VU) | |
| Functions | |
| ►Memory Streaming Functions | |
| Functions | |
| Common Data Structures | |
| Common Enumerated Types | |
| Common macro defines | |
| ►DMA (Direct Memory Access) | |
| Macros | |
| ►Functions | |
| Block Functions | |
| Channel Functions | |
| Descriptor Functions | |
| Data Structures | |
| Enumerated Types | |
| ►EMAC (Ethernet MAC) | |
| Macros | |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►EPHY (Ethernet PHY) | The PHY chip is outside of SoC |
| Macros | |
| Functions | |
| Enumerated Types | |
| Data Structures | |
| ►GFXSS (Graphics Sub System) | The Graphics Sub System driver provides an application interface for configuring graphics IP |
| ►Macros | |
| Interrupt Mask | |
| Functions | Following section describes the functions available in graphics subsystem |
| Data Structures | |
| Enumerated Types | |
| ►GPIO (General Purpose Input Output) | The GPIO driver provides an API to configure and access device Input/Output pins |
| ►Macros | |
| Pin drive mode | Constants to be used for setting the drive mode of the pin |
| Voltage trip mode | Constants to be used for setting the voltage trip type on the pin |
| Slew Rate Mode | Constants to be used for setting the slew rate of the pin |
| Pin drive strength | Constants to be used for setting the drive strength of the pin |
| Interrupt trigger type | Constants to be used for setting the interrupt trigger type on the pin |
| SIO output buffer mode | Constants to be used for setting the SIO output buffer mode on the pin |
| SIO input buffer mode | Constants to be used for setting the SIO input buffer mode on the pin |
| SIO input buffer trip-point | Constants to be used for setting the SIO input buffer trip-point of the pin |
| SIO reference voltage for input buffer trip-point | Constants to be used for setting the reference voltage of SIO input buffer trip-point |
| Regulated output voltage level (Voh) and input buffer trip-point of an SIO pair | Constants to be used for setting the Voh and input buffer trip-point of an SIO pair |
| Pull-up mode | Constants to be used for setting the Pull-up mode on the pin |
| ►Functions | |
| Initialization Functions | |
| GPIO Functions | |
| SIO Functions | |
| Port Interrupt Functions | |
| Data Structures | |
| Enumerated Types | |
| ►I3C (I3C) | Driver API for I3C Bus Peripheral |
| ►Macros | |
| Interrupt Status | |
| I3C Controller Status | Macros to check current I3C controller status returned by Cy_I3C_GetBusStatus function |
| I3C Target Status | Macros to check current I3C target status returned by Cy_I3C_GetBusStatus function |
| I3C Callback Events | Macros to check I3C events passed by cy_cb_i3c_handle_events_t callback |
| ►Common Macros | |
| GetStatus CCC Fields | |
| Enumerated Types | |
| Data Structures | |
| ►Functions | |
| General | |
| Target | |
| Controller | |
| Secondary Controller | |
| Interrupt | |
| Low Power Callbacks | |
| ►IPC (Inter Process Communication) | The inter-processor communication (IPC) driver provides a safe and reliable method to transfer data between CPUs |
| ►IPC driver layer (IPC_DRV) | The functions of this layer are used in the higher IPC levels (Semaphores and Pipes) |
| Macros | Macro definitions are used in the driver |
| Functions | Functions are used in the driver |
| Data Structures | Data structures are used in the driver |
| Enumerated Types | Enumerations are used in the driver |
| ►IPC semaphores layer (IPC_SEMA) | The semaphores layer functions made use of a single IPC channel to allow multiple semaphores that can be used by system or user function calls |
| Macros | Macro definitions are used in the driver |
| Functions | Functions are used in the driver |
| Enumerated Types | Enumerations are used in the driver |
| ►IPC pipes layer (IPC_PIPE) | The Pipe functions provide a method to transfer one or more words of data between CPUs or tasks |
| Macros | Macro definitions are used in the driver |
| Functions | Functions are used in the driver |
| Data Structures | Data structures are used in the driver |
| Enumerated Types | Enumerations are used in the driver |
| ►LPComp (Low Power Comparator) | Provides access to low-power comparators implemented using the fixed-function, LP comparator block |
| Macros | |
| ►Functions | |
| Low Power Callback | The driver supports the SysPm callback for Deep Sleep and Hibernate transition |
| Data Structures | |
| Enumerated Types | |
| ►LVD (Low-Voltage-Detect) | The LVD driver provides an API to manage the Low Voltage Detection block |
| Macros | |
| ►Functions | |
| Low Power Callback | The driver supports SysPm callback for Deep Sleep transition |
| Enumerated Types | |
| ►MCWDT (Multi-Counter Watchdog) | A MCWDT has two 16-bit counters and one 32-bit counter |
| Macros | |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►MIPI DSI (MIPI Display Serial Interface) | MIPI DSI driver provides an application interface for configuring MIPI DSI IP Block |
| ►Macros | |
| Version Macros | |
| Mode Flags | |
| Display Parameter Flags | |
| Interrupt Mask Macros | |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►NNLITE HW Accelerator (NNLITE) | This driver provides NNLite accelerator pdl defines and API function definitions |
| Macro | |
| Functions | |
| Data structures | |
| Enumerated types | |
| ►MPC (Memory Protection Controller) | The Memory Protection Controller (MPC) driver allows to configure memory regions as secure or non-secure, helping to protect sensitive data and code in the application |
| Macros | |
| Functions | |
| Data Structures | |
| Enumerated Types | Prot Driver error codes |
| ►MS_CTL (Master Security Controller) | MSC is the Master Security Controller which helps to protect the transactions initiated on the bus |
| Macros | |
| Functions | |
| Enumerated Types | |
| ►PDM_PCM_v2 (PDM-PCM Converter) | |
| ►Macros | |
| Interrupt Masks | |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►PPC (Peripheral Protection Controller) | The Peripheral Protection Controller (PPC) is a hardware block designed to enforce security policies for peripheral access, utilizing Protection Contexts (PC) and ARM TrustZone-M technology |
| Macros | |
| Functions | |
| Data Structures | |
| Enumerated Types | PPC Driver error codes |
| ►RTC (Real-Time Clock) | The Real-Time Clock (RTC) driver provides an application interface for keeping track of time and date |
| ►Macros | |
| Day of the week definitions | Definitions of days in the week |
| Week of month definitions | Week of Month setting constants definitions for Daylight Saving Time feature |
| Month definitions | Constants definition for Months |
| Number of days in month definitions | Definition of days in current month |
| RTC Interrupt sources | Definitions for RTC interrupt sources |
| RTC Status definitions | Definitions for indicating the RTC BUSY bit |
| ►Functions | |
| General | |
| Alarm | |
| DST functions | |
| Low-Level | |
| Interrupt | |
| Low Power Callbacks | |
| Data Structures | |
| Enumerated Types | |
| ►RRAM (Resistive Random Access Memory) | Resistive Random Access Memory (RRAM) is a type of non-volatile memory which is going to replace FLASH and OTP memory in MXS22 platform |
| Macros | |
| Enums | |
| Functions | |
| ►SCB (Serial Communication Block) | The Serial Communications Block (SCB) supports three serial communication protocols: Serial Peripheral Interface (SPI), Universal Asynchronous Receiver Transmitter (UART), and Inter Integrated Circuit (I2C or IIC) |
| ►Common | Common API for the Serial Communication Block |
| ►Macros | |
| SCB Interrupt Causes | |
| TX Interrupt Statuses | |
| RX Interrupt Statuses | |
| Slave Interrupt Statuses | |
| Master Interrupt Statuses | |
| I2C Interrupt Statuses | |
| SPI Interrupt Statuses | |
| Functions | |
| Data Structures | |
| ►EZI2C (SCB) | Driver API for EZI2C Slave Peripheral |
| ►Macros | |
| EZI2C Activity Status | Macros to check current EZI2C activity slave status returned by Cy_SCB_EZI2C_GetActivity function |
| ►Functions | |
| General | |
| Slave | |
| Low Power Callbacks | |
| Data Structures | |
| Enumerated Types | |
| ►I2C (SCB) | Driver API for I2C Bus Peripheral |
| ►Macros | |
| I2C Slave Status | Macros to check current I2C slave status returned by Cy_SCB_I2C_SlaveGetStatus function |
| I2C Master Status | Macros to check current I2C master status returned by Cy_SCB_I2C_MasterGetStatus function |
| I2C Callback Events | Macros to check I2C events passed by cy_cb_scb_i2c_handle_events_t callback |
| I2C Address Callback Events | Macros to check I2C address events passed by cy_cb_scb_i2c_handle_addr_t callback |
| ►Functions | |
| General | |
| Slave | |
| Master High-Level | |
| Master Low-Level | |
| Interrupt | |
| Low Power Callbacks | |
| Data Structures | |
| Enumerated Types | |
| ►SPI (SCB) | Driver API for SPI Peripheral |
| ►Macros | |
| SPI TX FIFO Statuses | Macros to check SPI TX FIFO status returned by Cy_SCB_SPI_GetTxFifoStatus function or assign mask for Cy_SCB_SPI_ClearTxFifoStatus function |
| SPI RX FIFO Statuses | Macros to check SPI RX FIFO status returned by Cy_SCB_SPI_GetRxFifoStatus function or assign mask for Cy_SCB_SPI_ClearRxFifoStatus function |
| SPI Master and Slave Statuses | Macros to check SPI Mater and Slave status returned by Cy_SCB_SPI_GetSlaveMasterStatus function or assign mask for Cy_SCB_SPI_ClearSlaveMasterStatus function |
| SPI Transfer Status | Macros to check current SPI transfer status returned by Cy_SCB_SPI_GetTransferStatus function |
| SPI Callback Events | Macros to check SPI events passed by cy_cb_scb_spi_handle_events_t callback |
| ►Functions | |
| General | |
| High-Level | |
| Low-Level | |
| Interrupt | |
| Low Power Callbacks | |
| Data Structures | |
| Enumerated Types | |
| ►UART (SCB) | Driver API for UART |
| ►Macros | |
| UART IRDA Low Power Oversample factors | |
| UART RX FIFO status. | Macros to check UART RX FIFO status returned by Cy_SCB_UART_GetRxFifoStatus function or assign mask for Cy_SCB_UART_ClearRxFifoStatus function |
| UART TX FIFO Statuses | Macros to check UART TX FIFO status returned by Cy_SCB_UART_GetTxFifoStatus function or assign mask for Cy_SCB_UART_ClearTxFifoStatus function |
| UART Receive Statuses | Macros to check current UART receive status returned by Cy_SCB_UART_GetReceiveStatus function |
| UART Transmit Status | Macros to check current UART transmit status returned by Cy_SCB_UART_GetTransmitStatus function |
| UART Callback Events | Macros to check UART events passed by cy_cb_scb_uart_handle_events_t callback |
| ►Functions | |
| General | |
| High-Level | |
| Low-Level | |
| Interrupt | |
| Low Power Callbacks | |
| Data Structures | |
| Enumerated Types | |
| ►SD Host (SD Host Controller) | This driver provides the user an easy method for accessing standard Host Controller Interface (HCI) registers and provides some simple functionality on top of the HCI for reading and writing data to an SD card, eMMc card or a SDIO device |
| ►Macros | |
| General Purpose Macros | |
| Card States | The masks below can be used to check the CURRENT_STATE bitfield of the Cy_SD_Host_GetCardStatus function return value |
| Card Status (CMD13) Bits | The masks below can be used with the Cy_SD_Host_GetCardStatus function |
| SCR Register Masks | The masks below can be used with the Cy_SD_Host_GetScr function |
| CID Register Masks | The masks below can be used with the Cy_SD_Host_GetCid function |
| CSD Register Masks | The masks below are for CSD Register Version 2.0 and can be used with the Cy_SD_Host_GetCsd function |
| SD Host Events | The constants below can be used with Cy_SD_Host_GetNormalInterruptStatus, Cy_SD_Host_ClearNormalInterruptStatus, Cy_SD_Host_GetErrorInterruptStatus and Cy_SD_Host_ClearErrorInterruptStatus functions |
| SD Host Present Status | The constants below can be used with the Cy_SD_Host_GetPresentState function |
| ►Functions | |
| High-Level | |
| Low-Level | |
| Interrupt | |
| Data Structures | |
| Enumerated Types | |
| ►SmartIO (Smart I/O) | The Smart I/O driver provides an API to configure and access the Smart I/O hardware present between the GPIOs (pins) and HSIOMs (pin muxes) on select device ports |
| ►Macros | |
| Smart I/O channel selection | Constants for selecting the Smart I/O channels |
| ►Functions | |
| Initialization Functions | |
| General Functions | |
| LUT Functions | |
| Data Unit Functions | |
| Data Structures | |
| Enumerated Types | |
| ►SMIF (Serial Memory Interface) | The SPI-based communication interface to the external quad SPI (QSPI) high-speed memory devices |
| ►Macros | |
| Status Macros | |
| Command Macros | |
| External Memory Flags | |
| SFDP Macros | |
| Interrupt Macros | |
| ►Functions | |
| ►Low Level Functions | The SMIF interface can be used to transmit different types of commands |
| Low Power Callback | The driver supports SysPm callback for Deep Sleep and Hibernate transition |
| Memory Slot Functions | |
| Low Power Callback | The driver supports SysPm callback for Deep Sleep and Hibernate transition |
| ►Data Structures | |
| SMIF Memory Description Structures | General hierarchy of memory structures are: |
| Enumerated Types | |
| SMIFNUM (Serial MemoryNum Interface) | |
| ►Startup | Provides device startup, system configuration, and linker script files |
| ►Functions | |
| System Functions | |
| Global Variables | |
| ►SysClk (System Clock) | The System Clock (SysClk) driver contains the API for configuring system and peripheral clocks |
| Macros | |
| ►General Enumerated Types | |
| Function return values | |
| ►External Clock Source (EXTCLK) | The External Clock Source (EXTCLK) is a clock source routed into SOC through a GPIO pin |
| Functions | |
| ►External Crystal Oscillator (ECO) | The External Crystal Oscillator (ECO) is a clock source that consists of an oscillator circuit that drives an external crystal through its dedicated ECO pins |
| ►Macros | |
| ECO status | Constants used for expressing ECO status |
| Functions | |
| Data Structures | |
| ►Clock Path Source | Clock paths are a series of multiplexers that allow a source clock to drive multiple clocking resources down the chain |
| Functions | |
| Enumerated Types | |
| ►Phase Locked Loop (PLL) | The PLL is a clock generation circuit that can be used to produce a higher frequency clock from a reference clock |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►Precision Internal Low-Speed Oscillator (PILO) | PILO provides a higher accuracy 32.768 kHz clock than the ILO |
| Functions | |
| ►Clock Measurement | These functions measure the frequency of a specified clock relative to a reference clock |
| Functions | |
| Enumerated Types | |
| Data Structures | |
| ►Low Power Callback | Entering and exiting low power modes require compatible clock configurations to be set before entering low power and restored upon wake-up and exit |
| Functions | |
| ►Watch Crystal Oscillator (WCO) | The WCO is a highly accurate 32.768 kHz clock source capable of operating in all power modes (excluding the Off mode) |
| Functions | BWC |
| Enumerated Types | |
| ►High-Frequency Clocks | Multiple high frequency clocks (CLK_HF) are available in the device |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►Peripherals Clock Dividers | There are multiple peripheral clock dividers that, in effect, create multiple separate peripheral clocks |
| Functions | |
| Enumerated Types | |
| ►Peripheral Group(MMIO Group) Controls | All the peripherals in the SOC belongs to certain MMIO groups |
| Functions | |
| Enumerated Types | |
| ►Low-Frequency Clock | The low-frequency clock is the source clock for the MCWDT (Multi-Counter Watchdog) and can be the source clock for Backup Domain Clock, which drives the RTC (Real-Time Clock) |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►Backup Domain Clock | The backup domain clock drives the RTC (Real-Time Clock) |
| Functions | |
| Enumerated Types | |
| ►Internal High Frequency(IHO) Clock | The IHO Clock is Internal High-speed Oscillator, which is present in CAT1B(48MHz) and PSE8(50MHz) devices |
| Functions | |
| ►SysFault (System Fault) | The SysFault driver provides an API to configure the Fault reporting structure |
| Macros | |
| Enums | |
| Data Structures | |
| Functions | |
| ►SysInt (System Interrupt) | The SysInt driver provides an API to configure the device peripheral interrupts |
| Macros | |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►SysLib (System Library) | The system libraries provide APIs that can be called in the user application to handle the timing, logical checking or register |
| ►Macros | |
| CPU Type Macros | |
| Status codes | Function status type codes |
| Version Macros | |
| Section Macros | |
| Assert Classes and Levels | Define end of shared data to be placed to the SOCMEMSRAM area by the linker |
| Helper Macros | Defines for the Helper Macros |
| Reset cause | Define RESET_CAUSE mask values |
| Unique ID | Unique ID fields positions |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►SysPm (System Power Management) | Use the System Power Management (SysPm) driver to change power modes and reduce system power consumption in power sensitive designs |
| ►PDCM (Power Dependency Control Matrix) | PDCM driver provides APIs for controlling the Power Dependency Control Matrix across Power Domains |
| Macros | |
| Functions | |
| Enumerated Types | |
| ►PPU (Power Policy Unit) | Power Domain PPU driver is a platform dependent driver on top of ARM PPU Driver |
| Macros | |
| Functions | |
| Enumerated Types | |
| ►Macros | |
| The Power Mode Status Defines | Defines for the CPU and system power modes status |
| Defines to skip the callbacks modes | Defines for the SysPm callbacks modes that can be skipped during execution |
| ►Functions | |
| General | |
| Power Modes | |
| Power Status | |
| I/Os Freeze | |
| ►Core Voltage Regulation | |
| LDO | |
| Buck | |
| Low Power Callbacks | |
| Data Structures | |
| Enumerated Types | |
| ►SysTick (Arm® System Timer) | Provides vendor-specific SysTick API |
| Macros | |
| Functions | |
| Data Structures | |
| ►TCPWM (Timer Counter PWM) | The TCPWM driver is a multifunction driver that implements Timer Counter, PWM, Quadrature Decoder, Shift Register and Motion Interface functionality using the TCPWM block |
| ►Common | Common API for the Timer Counter PWM Block |
| ►Macros | |
| TCPWM Input Selection | INTERNAL |
| Input Modes | Configures how TCPWM inputs behave |
| Output Trigger Modes | Configures how TCPWM output triggers behave (TCPWM_v2 only) |
| Interrupt Sources | Interrupt Sources |
| Default registers constants | Default constants for CNT Registers |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►Timer/Counter (TCPWM) | Driver API for Timer/Counter |
| ►Macros | |
| Counter Run Modes | Run modes for the counter timer |
| Counter Direction | The counter directions |
| Counter CLK Prescalers | The clock prescaler values |
| Counter Compare Capture | A compare or capture mode |
| Counter Status | The counter status |
| Functions | |
| Data Structures | |
| ►PWM (TCPWM) | Driver API for PWM |
| ►Macros | |
| PWM run modes | Run modes for the pwm timer |
| PWM modes | Sets the PWM modes |
| PWM Alignment | Sets the alignment of the PWM |
| PWM kill modes | Sets the kill mode for the PWM |
| PWM Disabled Output | Specifies the behavior of the PWM outputs while PWM is disabled |
| PWM Output Lines | Specifies the PWM output line |
| PWM CLK Prescaler values | Clock prescaler values |
| PWM output invert | Output invert modes |
| PWM Status | The counter status |
| Functions | |
| Data Structures | |
| ►Quadrature Decoder (TCPWM) | Driver API for Quadrature Decoder |
| ►Macros | |
| QuadDec Mode | The quadrature decoder mode |
| QuadDec Resolution | The quadrature decoder resolution |
| QuadDec CaptureMode | The quadrature capture modes |
| QuadDec Status | The quaddec status |
| Functions | |
| Data Structures | |
| ►Shift Register (TCPWM) | Driver API for Shift Register |
| ►Macros | |
| Shift Register CLK Prescaler values | Clock prescaler values |
| Shift Register Output Lines | Specifies the Shift Register output line |
| Shift Register output invert | Output invert modes |
| Shift Register Disabled Output | Specifies the behavior of the Shift Register outputs while Shift Register is disabled |
| Shift Register Status | The Shift Register status |
| Functions | |
| Data Structures | |
| ►TDM/I2S (Time Division Multiplexing/Inter-IC Sound) | |
| Interrupt Masks | |
| Data Structures | |
| Enumerated Types | |
| Macros | |
| Functions | |
| ►TrigMux (Trigger Multiplexer) | The trigger multiplexer provides access to the multiplexer that selects a set of trigger output signals from different peripheral blocks to route them to the specific trigger input of another peripheral block |
| Macros | |
| Functions | |
| Enumerated Types | |
| ►WDT (Watchdog Timer) | The Watchdog timer (WDT) has a 16-bit free-running up-counter |
| Macros | |
| Enums | |
| Functions | |
| ►PDL SRF (PDL Secure Request Framework) | This file contains the cy_pdl_srf_module_register API |
| ►PDL SRF Common (PDL Secure Request Framework Common) | Internal helpers for common code between the Secure Aware PDL drivers |
| Functions | |
| Data Structures | |
| ►RTC SRF (RTC Secure Request Framework) | Internal operation declarations to enable Secure Aware RTC |
| Enums | |
| ►SMIF SRF (SMIF Secure Request Framework) | Internal operation declarations to enable Secure Aware SMIF |
| Enums | |
| ►SYSCLK SRF (SYSCLK Secure Request Framework) | Internal operation declarations to enable Secure Aware SYSCLK |
| Enums | |
| ►SYSPM SRF (SYSPM Secure Request Framework) | Internal operation declarations to enable Secure Aware SYSPM |
| Enums | |
| Macros | |
| Enums | |
| Functions | |
| ▼NNLITE HW Accelerator KERNEL LIB | This driver provides NN Kernel level defines and API function definitions for NNLITE Lite HW accelerator |
| Macros | |
| Enums | |
| Structures | |
| functions | |
