API Reference

Here is a list of all modules:

[detail level 1234]

▼Common Driver Definitions	Definitions common in all driver interfaces (Driver_Common.h)
Status Error Codes	Negative return values of functions indicate errors occurred during execution
Status Error Codes	Negative values indicate errors (NAND has specific codes in addition to common Status Error Codes)
Status Error Codes	Negative values indicate errors (SAI has specific codes in addition to common Status Error Codes)
Status Error Codes	Negative values indicate errors (SPI has specific codes in addition to common Status Error Codes)
Status Error Codes	Negative values indicate errors (USART has specific codes in addition to common Status Error Codes)
▼CAN Interface	Driver API for CAN Bus Peripheral (Driver_CAN.h)
Status Error Codes	Status codes of the CAN driver
CAN Unit Events	Callback unit events notified via ARM_CAN_SignalUnitEvent
CAN Object Events	Callback objects events notified via ARM_CAN_SignalObjectEvent
►CAN Control Codes	Codes to configure the CAN driver
CAN Identifier	Set object to standard or extended
CAN Operation Codes	Set CAN operation modes
CAN Bus Communication Mode	Set or initialize the CAN bus
CAN Bit Timing Codes	Set bit timing
CAN Filter Operation Codes	Set CAN filter manipulation codes
CAN Object Configuration Codes	CAN Object Configuration codes
▼Ethernet Interface	Ethernet common definitions (Driver_ETH.h)
Media Interface Types	Ethernet Media Interface type
►Ethernet MAC Interface	Driver API for Ethernet MAC Peripheral (Driver_ETH_MAC.h)
Ethernet MAC Events	The Ethernet MAC driver generates call back events that are notified via the function ARM_ETH_MAC_SignalEvent
►Ethernet MAC Control Codes	Configure and control the Ethernet MAC using the ARM_ETH_MAC_Control
Ethernet MAC Controls	Configure and control the Ethernet MAC interface
Ethernet MAC Configuration	Specifies speed mode, link mode, checksum, and frame filtering modes
Ethernet MAC Flush Flags	Specify controls to flush a buffer
Ethernet MAC VLAN Filter Flag	Specify whether to compare only the VLAN Identifier
Ethernet MAC Timer Control Codes	Control codes for ARM_ETH_MAC_ControlTimer function
Ethernet MAC Frame Transmit Flags	Specify frame transmit flags
►Ethernet PHY Interface	Driver API for Ethernet PHY Peripheral (Driver_ETH_PHY.h)
Ethernet PHY Mode	Specify operation modes of the Ethernet PHY interface
▼I2C Interface	Driver API for I2C Bus Peripheral (Driver_I2C.h)
I2C Events	The I2C driver generates call back events that are notified via the function ARM_I2C_SignalEvent
►I2C Control Codes	Many parameters of the I2C driver are configured using the ARM_I2C_Control function
I2C Control Codes	Specify operation parameters and various controls
I2C Bus Speed	Specify the I2C bus speed
I2C Address Flags	Specify address flags
▼MCI Interface	Driver API for Memory Card Interface using SD/MMC interface (Driver_MCI.h)
MCI Events	The MCI driver generates call back events that are notified via the function ARM_MCI_SignalEvent
►MCI Control Codes	Configure and control the MCI using the ARM_MCI_Control
MCI Controls	Configure and control the MCI interface
MCI Bus Speed Mode	Specify the bus speed mode
MCI Bus Data Width	Specify the data bus width
MCI CMD Line Mode	Specify the CMD line mode (Push-Pull or Open Drain)
MCI Driver Strength	Specify the driver strength
MCI Send Command Flags	Specify various options for sending commands to the card and the expected response
MCI Transfer Controls	Specify data transfer mode
MCI Card Power Controls	Specify Memory Card Power supply voltage
▼NAND Interface	Driver API for NAND Flash Device Interface (Driver_NAND.h)
Status Error Codes	Negative values indicate errors (NAND has specific codes in addition to common Status Error Codes)
NAND Events	The NAND driver generates call back events that are notified via the function ARM_NAND_SignalEvent
NAND Flags	Specify Flag codes
►NAND Control Codes	Many parameters of the NAND driver are configured using the ARM_NAND_Control function
NAND Mode Controls	Specify operation modes of the NAND interface
NAND Bus Modes	Specify bus mode of the NAND interface
NAND Data Bus Width	Specify data bus width of the NAND interface
NAND Driver Strength	Specify driver strength of the NAND interface
NAND ECC Codes	Specify ECC codes
NAND Sequence Execution Codes	Specify execution codes
▼Flash Interface	Driver API for Flash Device Interface (Driver_Flash.h)
Flash Events	The Flash driver generates call back events that are notified via the function ARM_Flash_SignalEvent
▼SAI Interface	Driver API for Serial Audio Interface (Driver_SAI.h)
Status Error Codes	Negative values indicate errors (SAI has specific codes in addition to common Status Error Codes)
SAI Events	The SAI driver generates call back events that are notified via the function ARM_SAI_SignalEvent
►SAI Control Codes	Many parameters of the SAI driver are configured using the ARM_SAI_Control function
►SAI Configuration	Specify Transmitter/Receiver configuration
SAI Mode	Defines Transmitter/Receiver mode
SAI Synchronization	Defines Transmitter/Receiver synchronization
SAI Protocol	Defines Transmitter/Receiver protocol
SAI Data Size	Defines data size in bits (per channel/slot)
SAI Bit Order	Defines the bit order
SAI Mono Mode	Defines mono mode
SAI Companding	Defines companding
SAI Clock Polarity	Defines clock polarity
SAI Frame	Defines frame
SAI Slot	Defines data slots
SAI Master Clock Pin	Defines MCLK pin
SAI Master Clock Prescaler	Defines MCLK prescaler
SAI Controls	Specifies controls
▼SPI Interface	Driver API for SPI Bus Peripheral (Driver_SPI.h)
Status Error Codes	Negative values indicate errors (SPI has specific codes in addition to common Status Error Codes)
SPI Events	The SPI driver generates call back events that are notified via the function ARM_SPI_SignalEvent
►SPI Control Codes	Many parameters of the SPI driver are configured using the ARM_SPI_Control function
SPI Mode Controls	Specifies SPI mode
SPI Frame Format	Defines the frame format
SPI Data Bits	Defines the number of data bits
SPI Bit Order	Defines the bit order
SPI Slave Select Mode	Specifies SPI slave select mode
SPI Miscellaneous Controls	Specifies additional miscellaneous controls
▼Storage Interface	Driver API for Storage Device Interface (Driver_Storage.h)
Use of Storage APIs
Sample Use of Storage Driver
▼USART Interface	Driver API for Universal Synchronous Asynchronous Receiver/Transmitter (Driver_USART.h)
Status Error Codes	Negative values indicate errors (USART has specific codes in addition to common Status Error Codes)
USART Events	The USART driver generates call back events that are notified via the function ARM_USART_SignalEvent
►USART Control Codes	Many parameters of the USART driver are configured using the ARM_USART_Control function
USART Mode Control	Specify USART mode
USART Miscellaneous Control	Specifies additional miscellaneous controls
USART Data Bits	Defines the number of data bits
USART Parity Bit	Defines the parity bit
USART Stop Bits	Defines the number of stop bits
USART Flow Control	Specifies RTS/CTS flow control
USART Clock Polarity	Defines the clock polarity for the synchronous mode
USART Clock Phase	Defines the clock phase for the synchronous mode
▼USB Interface	USB common definitions (Driver_USB.h)
►USB Device Interface	Driver API for USB Device Peripheral (Driver_USBD.h)
USBD Device Events	The USB Device driver generates Device call back events that are notified via the function ARM_USBD_SignalDeviceEvent
USBD Endpoint Events	The USB Device driver generates Endpoint call back events that are notified via the function ARM_USBD_SignalEndpointEvent
►USB Host Interface	Driver API for USB Host Peripheral (Driver_USBH.h)
►USB Host	Driver API for USB Host
USBH Port Events	The USB Host driver generates Port call back events that are notified via the function ARM_USBH_SignalPortEvent
USBH Pipe Events	The USB Host driver generates Pipe call back events that are notified via the function ARM_USBH_SignalPipeEvent
USBH Packet Information	Specify USB packet information used by the function ARM_USBH_PipeTransfer
USB OHCI/EHCI	Driver API for USB OHCI/EHCI
USB Speed	USB Speed definitions
USB Endpoint Type	USB Endpoint Type definitions
▼VIO	API for Virtual I/O (VIO) (cmsis_vio.h)
Signals	Signal related defines
Value IDs	Value Identifier related defines
▼WiFi Interface	Driver API for WiFi (Driver_WiFi.h)
►WiFi Control	Control functions for the WiFi module
WiFi Events	The WiFi driver generates call back events that are notified via the function ARM_WIFI_SignalEvent
►WiFi Management	Configure and manage the connection to a WiFi access point (AP) or configure and manage the access point (AP)
WiFi Option Codes	WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function
WiFi Security Type	Specifies WiFi security type for ARM_WIFI_Activate
WiFi Protected Setup (WPS) Method	Specifies WiFi WPS method for ARM_WIFI_Activate
WiFi DHCPv6 Mode	Specifies IPv6 Dynamic Host Configuration Protocol (DHCP) Mode
WiFi Bypass Mode	Transfer Ethernet frames by WiFi module
►WiFi Socket	Socket interface to IP stack running on WiFi module
WiFi Socket Address Family definitions	WiFi Socket Address Family definitions
WiFi Socket Type definitions	WiFi Socket Type definitions
WiFi Socket Protocol definitions	WiFi Socket Protocol definitions
WiFi Socket Option definitions	WiFi Socket Option definitions
WiFi Socket Function return codes	WiFi Socket Function return codes