PDL API Reference

The following provides a list of driver API documentation

[detail level 1234]

▼ADCcomp (ADCCOMP, LPCOMP / NTD - Noise Threshold Detector)	ADCCOMP, LPCOMP / NTD - Noise Threshold Detector
Macros
Functions
Data Structures
▼DMAC (Direct Memory Access Controller)	Direct Memory Access Controller
Macros
Functions
Data Structures
▼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
General
Slave
Low Power Callbacks
►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
General
Slave
Master High-Level
Master Low-Level
Interrupt
Low Power Callbacks
►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
General
High-Level
Low-Level
Interrupt
Low Power Callbacks
►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
General
High-Level
Low-Level
Interrupt
Low Power Callbacks
▼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
►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
▼SysClk (System Clock)	System Clock
Macros
Functions
Data Structures
▼SysInt (System Interrupt)	System Interrupt(s)
Macros
Functions
Data Structures
▼SysPm (System Power Management)	System Power Management
Macros
Functions
Data Structures
▼TCPWM (Timer Counter PWM)	The TCPWM driver is a multifunction driver that implements Timer Counter, PWM, Quadrature Decoder and Shift Register 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
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
▼WDT (Watchdog Timer)	ARM Watchdog Timer
Macros
Functions
Data Structures
Group_pdm_pcm_enums
Group_pdm_pcm_data_structures
Group_pdm_pcm_functions