PSoC 4 Peripheral Driver Library - Alpha
PDL API Reference
The following provides a list of driver API documentation
[detail level 1234]
 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
 Functions
 Data Structures
 Enumerated Types
 GPIO (General Purpose Input Output)The GPIO driver provides an API to configure and access the device Input/Output pins
 Macros
 Functions
 Data Structures
 Enumerated Types
 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)
 CommonCommon API for the Serial Communication Block
 EZI2C (SCB)Driver API for EZI2C Slave Peripheral
 I2C (SCB)Driver API for I2C Bus Peripheral
 SPI (SCB)Driver API for SPI Peripheral
 UART (SCB)Driver API for UART
 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
 Internal Main Oscillator (IMO)The Internal Main Oscillator (IMO) is a primary clock source for the CPU core and most of the peripherals
 External Clock Source (EXTCLK)The External Clock Source (EXTCLK) is a clock source routed into PSoC through a GPIO pin
 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
 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
 Internal Low-Speed Oscillator (ILO)The ILO operates with no external components and outputs a clock signal at roughly 40 kHz
 Low Power CallbackEntering and exiting low power modes require compatible clock configurations to be set before entering low power and restored upon wake-up and exit
 Watch Crystal Oscillator (WCO)
 High-Frequency ClocksThe high frequency clock ClkHf is a source for the system clock for CPU and the peropheral clock didviders
 Peripherals Clock DividersThere are multiple peripheral clock dividers that, in effect, create multiple separate peripheral clocks:
 System ClockThe system clock is the source clock for CPU core (Cortex-M0+ in PSoC 4)
 Pump ClockThe pump clock is a clock source used to provide analog precision in low voltage applications
 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
 Functions
 Data Structures
 Enumerated Types
 SysPm (System Power Management) - Not supported in Alpha releaseUse the System Power Management (SysPm) driver to change power modes and reduce system power consumption in power sensitive designs
 Macros
 Functions
 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
 CommonCommon API for the Timer Counter PWM Block
 Timer/Counter (TCPWM)Driver API for Timer/Counter
 PWM (TCPWM)Driver API for PWM
 Quadrature Decoder (TCPWM)Driver API for Quadrature Decoder
 TrigMux (Trigger Multiplexer) - Not supported in Alpha releaseThe 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
 Functions