| ►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 | |
| ►Crypto (Cryptography) | The Crypto driver provides a public API to perform cryptographic and hash operations, as well as generate both true and pseudo random numbers |
| Macros | |
| Enums | |
| Structures | |
| ►Functions | |
| Control and status | |
| Symmetric key algorithms (AES) | |
| Hash operations (SHA) | |
| Cyclic redundancy code (CRC) | |
| Random number generation (TRNG, PRNG) | |
| ►CryptoLite (Cryptography) | The Cryptolite driver provides a public API to configure the Cryptolite IP block and perform cryptographic and hash operations, as well as generate true random numbers and perform arithmetic/logical operations |
| ►Common | Cryptolite Common |
| Macros | |
| Enums | |
| ►SHA | Secure Hash Algorithm (SHA) |
| Macros | |
| Enums | |
| Structures | |
| Functions | |
| ►AES | Advanced Encryption Standard (AES) |
| Macros | |
| Structures | |
| Functions | |
| ►VU | Vector Unit (VU) |
| Macros | |
| Structures | |
| Functions | |
| ►TRNG | True Random Number Generator (TRNG) |
| Macros | |
| Structures | |
| Functions | |
| ►RSA | RSA algorithm which decrypts user data using public key provided |
| Structures | |
| Functions | |
| ►CRWDT (Challenge Response Watchdog Timer) | The Challenge Response Watchdog Timer (CRWDT) uses challenge/response inter-operations during a measured window to ensure that software is in control |
| ►Macros | |
| Actions | |
| Functions | |
| ►CSD (CAPSENSE™ Sigma Delta) | The CSD HW block enables multiple sensing capabilities on PSOC™ devices, including self-cap and mutual-cap capacitive touch sensing solutions, a 10-bit ADC, IDAC, and Comparator |
| ►Macros | |
| Registers Constants | |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►CTB (Continuous Time Block) | This driver provides API functions to configure and use the analog CTB |
| ►Macros | |
| OpAmp Switch Macros | |
| SAR Sequencer Controlled Switch Macros | |
| ►Functions | |
| Initialization Functions | This set of functions is for initializing, enabling, and disabling the CTB |
| Basic Configuration Functions | This set of functions is for configuring basic usage of the CTB |
| Comparator Functions | This set of functions is specific to Comparator mode |
| Interrupt Functions | This set of functions is related to the comparator interrupts |
| Switch Control Functions | This set of functions is for controlling routing switches |
| Offset and Slope Trim Functions | These are advanced functions for trimming the offset and slope of the opamps |
| Data Structures | |
| Enumerated Types | |
| ►DMAC (Direct Memory Access Controller) | Configures the DMA Controller block, channels and descriptors |
| ►Macros | |
| Interrupt Masks | |
| Interrupt Masks | |
| ►Functions | |
| Block Functions | |
| Channel Functions | |
| Descriptor Functions | |
| Data Structures | |
| Enumerated Types | |
| ►Flash (Flash System Routine) | Internal Flash and Supervisory Flash memory programming |
| ►Macros | |
| Flash general parameters | Provides general definitions |
| Flash Configuration | Provides device-specific definitions |
| Functions | |
| Enumerated Types | |
| ►GPIO (General Purpose Input Output) | The GPIO driver provides an API to configure and access the 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 |
| Interrupt trigger type | Constants to be used for setting the interrupt trigger type on the pin |
| ►Functions | |
| Initialization Functions | |
| GPIO Functions | |
| Port Interrupt Functions | |
| Data Structures | |
| Enumerated Types | |
| ►I2S (Inter-IC Sound) | The I2S driver provides a function API to manage Inter-IC Sound |
| ►Macros | |
| Interrupt Masks | |
| Current State | |
| ►Functions | |
| Low Power Callback | The driver supports the SysPm callback for Deep Sleep transition |
| Data Structures | |
| Enumerated Types | |
| ►HVSS (High-Voltage Subsystem) | High-Voltage Subsystem (HVSS) |
| ►Macros | |
| HVSS general parameters | |
| HV regulator status | |
| HVSS interrupts | |
| Functions | |
| Data Structure | |
| Enumerated Types | |
| ►LIN (Local Interconnect Network) | The LIN driver provides a function API to manage Local Interconnect Network |
| ►Macros | |
| LIN Command Type Definition | Specifies the parameter values passed to LIN command API |
| LIN ALL Interrupt Mask Definition | Specifies the mask value for interrupt status/mask |
| LIN Common Macros | LIN Specific common Macros |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►LPCOMP (Low Power Comparator) | Provides access to the low-power comparators implemented using the fixed-function low-power comparator block |
| Macros | |
| ►Functions | |
| Low Power Callback | The driver supports SysPm callback for Deep Sleep transition |
| Data Structures | |
| Enumerated Types | |
| ►LTC (Lifetime Counter) | Provides a basic 32-bit lifetime counter with a prescaler (/2 to /32) |
| Macros | |
| Enumerated Types | |
| Functions | |
| ►MSC (Multi-Sense Converter) | The MSC HW block represents the devices of the fifth CAPSENSE™ generation |
| ►Macros | |
| Registers Constants | |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►MSCLP (Multi-Sense Converter Low-Power) | The MSCLP HW block represents the low power family of the fifth-generation CAPSENSE™ devices |
| ►Macros | |
| Registers Constants | |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►RAM (RAM System Routine) | Error Correction Code (ECC) for RAM |
| ►Macros | |
| RAM general parameters | |
| RAM initialization parameters | |
| Functions | |
| Data Structure | |
| Enumerated Types | |
| ►SAR (SAR ADC) | This driver configures and controls the SAR ADC subsystem block |
| ►Macros | |
| Interrupt Masks | |
| SARMUX Switch Control Register Masks | Mask definitions of SARMUX switches that can be controlled by the SARSEQ |
| EXPMUX/DIAGMUX Switch Control Register Masks | Mask definitions of EXPMUX/DIAGMUX switches that can be controlled by the SARSEQ |
| ►Functions | |
| Initialization and Basic Functions | This set of functions is for initialization and basic usage |
| Low Power Callback | This set of functions is for Deep Sleep entry and exit |
| Run-time Configuration Functions | This set of functions allows changes to the SAR configuration after initialization |
| Counts Conversion Functions | This set of functions performs counts to *volts conversions |
| Interrupt Functions | This set of functions are related to SAR interrupts |
| SARMUX Switch Control Functions | This set of functions is for controlling/querying the SARMUX switches |
| Useful Configuration Query Functions | This set of functions is for useful configuration query |
| Data Structures | |
| ►Enumerated Types | |
| Control Register Enums | |
| Sample Control Register Enums | |
| Sample Time Register Enums | |
| Range Interrupt Register Enums | This set of enumerations aids in configuring the SAR RANGE* registers |
| Channel Configuration Register Enums | This set of enumerations aids in configuring the SAR CHAN_CONFIG and INJ_CHAN_CONFIG registers |
| ►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 |
| EZI2C Deep Sleep Callback | Events Macros to check deep sleep event by cy_cb_scb_ezi2c_handle_deep_sleep_mode_t callback |
| ►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 |
| I2C Deep Sleep Callback Events | Macros to check deep sleep event by cy_cb_scb_i2c_handle_deep_sleep_mode_t callback |
| I2C High-speed mode Callback Events | Macros to check I2C HS event by cy_cb_scb_i2c_handle_hs_mode_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 |
| SPI Deep Sleep Callback Events | Macros to check deep sleep event by cy_cb_scb_spi_handle_deep_sleep_mode_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 | |
| ►SegLCD (Segment LCD) | The Segment LCD Driver provides an API to configure and operate the M0S8LCD hardware block |
| Macros | |
| ►Functions | |
| Block Configuration Functions | |
| Frame/Pixel Management Functions | |
| Display/Character Management Functions | |
| Data Structures | |
| Global Data | |
| 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 | SmartIO initialization functions |
| General Functions | General SmartIO functions |
| LUT Functions | SmartIO Look Up Table (LUT) functions |
| Data Unit Functions | SmartIO Data Unit (DU) functions |
| Data Structures | |
| Enumerated Types | |
| ►Startup (System Configuration Files) | Provides device startup, system configuration, and linker script files |
| 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 | |
| ►Internal Main Oscillator (IMO) | The Internal Main Oscillator (IMO) is a primary clock source for the CPU core and most of the peripherals |
| Functions | |
| Enumerated Types | |
| ►External Clock Source (EXTCLK) | The External Clock Source (EXTCLK) is a clock source routed into PSOC through a GPIO pin |
| Functions | |
| ►External PLL Reference Clock Source (EXTREF) | The External PLL Reference Clock Source (EXTREF) is a clock source routed into PSOC 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 |
| 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 | |
| ►Internal Low-Speed Oscillator (ILO) | The ILO operates with no external components and outputs a clock signal at roughly 40 kHz |
| Functions | |
| ►Precision Internal Low-speed Oscillator (PILO) | The Precision Internal Low-speed Oscillator (PILO operates with no external components and outputs a clock signal at nominal 32768 Hz with 5% accuracy when not tracking HPOSC and 1% accuracy when tracking HPOSC |
| Functions | |
| ►High-Precision Oscillator (HPOSC) | The high-precision internal oscillator (HPOSC) operates with no external components and outputs a clock signal at roughly 2 MHz |
| Functions | |
| ►Low-Frequency Clock | The low-frequency clock is the source clock for the WDT (Watchdog Timer), and other peripherals which depends on certain chip |
| Enumerated Types | |
| Functions | |
| ►Clock Calibration | Clock calibration allows measuring the number of clock cycles (counter 2) that occur within a time window |
| Functions | |
| Enumerated Types | |
| ►Clock Trim (IMO, PILO) | These functions perform a single trim operation on the IMO or PILO |
| Functions | |
| Enumerated Types | |
| ►Watch Crystal Oscillator (WCO) | The WCO is a highly accurate 32.768 kHz clock source capable of operating in all power modes |
| Functions | |
| ►High-Frequency Clock | The high frequency clock HFCLK is a source for the system clock for CPU and the peripheral clock dividers |
| Functions | |
| Enumerated Types | |
| ►Peripherals Clock Dividers | There are multiple peripheral clock dividers that, in effect, create multiple separate peripheral clocks: |
| Macros | |
| Functions | |
| Enumerated Types | |
| ►System Clock | The system clock is the source clock for CPU core (Cortex-M0+ in PSOC 4) |
| Functions | |
| ►Pump Clock | The pump clock is a clock source used to provide analog precision in low voltage applications |
| Functions | |
| Enumerated Types | |
| ►Clock Supervision Block (CSV) | The clock supervision block uses a reference clock (IMO clock) to check that a monitored clock (clk_exco) is within an allowed frequency window |
| Functions | |
| Data Structures | |
| ►Programmable Delay Block (PGM_DELAY) | The PGM_DELAY block is a 16-bit down counter clocked by IMO clock and being triggered by the CSV |
| Functions | |
| ►Interrupts | This API is to manage a few interrupt sources |
| Interrupt Masks | |
| Functions | |
| ►Low Power Callback | Entering and exiting low power modes require compatible clock configurations to be set before entering low power and restored upon wakeup and exit |
| Callback Timeout Events | |
| Data Structures | |
| 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 | |
| Global variables | |
| 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 | |
| Status codes | Function status type codes |
| Assert Classes and Levels | Defines for the Assert Classes and Levels |
| Reset cause | Define RESET_CAUSE mask values |
| 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 |
| ►Macros | |
| Defines to skip the callbacks modes | Defines for the SysPm callbacks modes that can be skipped during execution |
| ►Functions | |
| Power Modes | |
| Low Power Callbacks | |
| BOD/OVD monitoring | The power supply includes monitoring to ensure that the required voltage levels exist |
| 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, and Quadrature Decoder functionality using the TCPWM block |
| ►Common | Common API for the Timer Counter PWM Block |
| ►Macros | |
| TCPWM Input Selection | Selects which input to use |
| Input Modes | Configures how TCPWM inputs behave |
| 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 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 Resolution | The quadrature decoder resolution |
| QuadDec Status | The counter status |
| Functions | |
| Data Structures | |
| ►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 | |
| ►USBFS (USB Full-Speed Device) | The USBFS driver provides APIs to configure and access the USBFS hardware block on the EZ-PD PMG1 family of devices |
| ►Macros | |
| Interrupt Level | |
| Interrupt Cause | |
| Transfer Errors | |
| ►Functions | |
| Initialization Functions | The Initialization functions provide an API to begin the USBFS driver operation (configure and enable) and to stop operation (disable and de-initialize) |
| Interrupt Functions | The Functions Interrupt functions provide an API to register callbacks for interrupt events provided by the USB block, interrupt handler, and configuration functions |
| Endpoint 0 Service Functions | The Endpoint 0 Service functions provide an API to establish communication with the USB Host using control endpoint 0 |
| Data Endpoint Configuration Functions | The Data Endpoint Configuration Functions provide an API to allocate and release hardware resources and override the memcpy function for the data endpoints |
| Data Endpoint Transfer Functions | The Data Endpoint Transfer functions provide an API to establish communication with the USB Host using data endpoint |
| Low Power Functions | The Low-power functions provide an API to implement Low-power callback at the application level |
| Data Structures | |
| Enumerated Types | |
| ►USBPD (USB Power Delivery) | The USBPD driver provides APIs to configure and access the M0S8-USBPD and MX-USBPD IP block on the EZ-PD PMG1 family of devices into a high-quality, versatile analog front-end for PD applications |
| ►Common | USBPD driver common data structures |
| Macros | |
| Enumerated Types | |
| Data Structures | |
| ►HPD (USBPD) | USBPD Hot-Plug Detect driver |
| Macros | |
| Functions | |
| ►Legacy Charging (USBPD) | USBPD Legacy Charging driver |
| Macros | |
| Enumerated Types | |
| Functions | The functions provide a set of APIs to handle battery charging operations |
| ►MUX (USBPD) | USBPD MUX Control driver |
| Functions | |
| ►Phy (USBPD) | USBPD Phy transceiver driver |
| Functions | |
| ►Type C (USBPD) | USBPD Type C driver |
| Macros | |
| Functions | |
| Group_usbpd_typec_enum | |
| ►VBus Ctrl (USBPD) | USBPD VBus Control driver |
| Enumerated Types | |
| Functions | |
| ►IDAC (USBPD) | USBPD IDAC Control driver |
| Macro | |
| Functions | |
| ►Buck Boost (USBPD) | USBPD VBus Buck Boost driver |
| Functions | |
| ►LF Counter (USBPD) | USBPD LF Counter driver |
| Functions | |
| ►WDC (Watchdog Counters) | Watchdog Counters (WDC) are general-purpose timers clocked from a low- frequency clock source and capable of generating interrupts |
| ►Macros | |
| Cascading Masks | The WDC cascading settings |
| Functions | |
| Data Structures | |
| Enumerated Types | |
| ►WDT (Watchdog Timer) | The Watchdog timer (WDT) has a 16-bit (or 32-bit resolution for PSOC4 HVMS/PA devices) free-running up-counter with programmable limit values |
| Macros | |
| Enumerated Types | |
| Functions | |
