From 96d6da4e252b06dcfdc041e7df23e86161c33007 Mon Sep 17 00:00:00 2001 From: rihab kouki Date: Tue, 28 Jul 2020 11:24:49 +0100 Subject: Official ARM version: v5.6.0 --- docs/Driver/html/modules.html | 171 +++++++++++++++++++++++------------------- 1 file changed, 93 insertions(+), 78 deletions(-) (limited to 'docs/Driver/html/modules.html') diff --git a/docs/Driver/html/modules.html b/docs/Driver/html/modules.html index aba474a..ee56ac7 100644 --- a/docs/Driver/html/modules.html +++ b/docs/Driver/html/modules.html @@ -32,7 +32,7 @@ Logo
CMSIS-Driver -  Version 2.6.0 +  Version 2.7.1
Peripheral Interface for Middleware and Application Code
@@ -119,40 +119,40 @@ $(document).ready(function(){initNavTree('modules.html','');}); |oStatus Error CodesStatus codes of the CAN driver |oCAN Unit EventsCallback unit events notified via ARM_CAN_SignalUnitEvent |oCAN Object EventsCallback objects events notified via ARM_CAN_SignalObjectEvent -|\CAN Control CodesCodes to configure the CAN driver -| oCAN IdentifierSet object to standard or extended -| oCAN Operation CodesSet CAN operation modes -| oCAN Bus Communication ModeSet or initialize the CAN bus -| oCAN Bit Timing CodesSet bit timing -| oCAN Filter Operation CodesSet CAN filter manipulation codes -| \CAN Object Configuration CodesCAN Object Configuration codes +|\CAN Control CodesCodes to configure the CAN driver +| oCAN IdentifierSet object to standard or extended +| oCAN Operation CodesSet CAN operation modes +| oCAN Bus Communication ModeSet or initialize the CAN bus +| oCAN Bit Timing CodesSet bit timing +| oCAN Filter Operation CodesSet CAN filter manipulation codes +| \CAN Object Configuration CodesCAN Object Configuration codes oEthernet InterfaceEthernet common definitions (Driver_ETH.h) |oMedia Interface TypesEthernet Media Interface type -|oEthernet MAC InterfaceDriver API for Ethernet MAC Peripheral (Driver_ETH_MAC.h) -||oEthernet MAC EventsThe Ethernet MAC driver generates call back events that are notified via the function ARM_ETH_MAC_SignalEvent -||oEthernet MAC Control CodesConfigure and control the Ethernet MAC using the ARM_ETH_MAC_Control +|oEthernet MAC InterfaceDriver API for Ethernet MAC Peripheral (Driver_ETH_MAC.h) +||oEthernet MAC EventsThe Ethernet MAC driver generates call back events that are notified via the function ARM_ETH_MAC_SignalEvent +||oEthernet MAC Control CodesConfigure and control the Ethernet MAC using the ARM_ETH_MAC_Control |||oEthernet MAC ControlsConfigure and control the Ethernet MAC interface |||oEthernet MAC ConfigurationSpecifies speed mode, link mode, checksum, and frame filtering modes |||oEthernet MAC Flush FlagsSpecify controls to flush a buffer |||\Ethernet MAC VLAN Filter FlagSpecify whether to compare only the VLAN Identifier -||oEthernet MAC Timer Control CodesControl codes for ARM_ETH_MAC_ControlTimer function -||\Ethernet MAC Frame Transmit FlagsSpecify frame transmit flags -|\Ethernet PHY InterfaceDriver API for Ethernet PHY Peripheral (Driver_ETH_PHY.h) -| \Ethernet PHY ModeSpecify operation modes of the Ethernet PHY interface -oI2C InterfaceDriver API for I2C Bus Peripheral (Driver_I2C.h) -|oI2C EventsThe I2C driver generates call back events that are notified via the function ARM_I2C_SignalEvent -|oI2C Control CodesMany parameters of the I2C driver are configured using the ARM_I2C_Control function -||oI2C Control CodesSpecify operation parameters and various controls -||\I2C Bus SpeedSpecify the I2C bus speed -|\I2C Address FlagsSpecify address flags -oMCI InterfaceDriver API for Memory Card Interface using SD/MMC interface (Driver_MCI.h) -|oMCI EventsThe MCI driver generates call back events that are notified via the function ARM_MCI_SignalEvent -|oMCI Control CodesConfigure and control the MCI using the ARM_MCI_Control -||oMCI ControlsConfigure and control the MCI interface -||oMCI Bus Speed ModeSpecify the bus speed mode -||oMCI Bus Data WidthSpecify the data bus width -||oMCI CMD Line ModeSpecify the CMD line mode (Push-Pull or Open Drain) -||\MCI Driver StrengthSpecify the driver strength +||oEthernet MAC Timer Control CodesControl codes for ARM_ETH_MAC_ControlTimer function +||\Ethernet MAC Frame Transmit FlagsSpecify frame transmit flags +|\Ethernet PHY InterfaceDriver API for Ethernet PHY Peripheral (Driver_ETH_PHY.h) +| \Ethernet PHY ModeSpecify operation modes of the Ethernet PHY interface +oI2C InterfaceDriver API for I2C Bus Peripheral (Driver_I2C.h) +|oI2C EventsThe I2C driver generates call back events that are notified via the function ARM_I2C_SignalEvent +|oI2C Control CodesMany parameters of the I2C driver are configured using the ARM_I2C_Control function +||oI2C Control CodesSpecify operation parameters and various controls +||\I2C Bus SpeedSpecify the I2C bus speed +|\I2C Address FlagsSpecify address flags +oMCI InterfaceDriver API for Memory Card Interface using SD/MMC interface (Driver_MCI.h) +|oMCI EventsThe MCI driver generates call back events that are notified via the function ARM_MCI_SignalEvent +|oMCI Control CodesConfigure and control the MCI using the ARM_MCI_Control +||oMCI ControlsConfigure and control the MCI interface +||oMCI Bus Speed ModeSpecify the bus speed mode +||oMCI Bus Data WidthSpecify the data bus width +||oMCI CMD Line ModeSpecify the CMD line mode (Push-Pull or Open Drain) +||\MCI Driver StrengthSpecify the driver strength |oMCI Send Command FlagsSpecify various options for sending commands to the card and the expected response |oMCI Transfer ControlsSpecify data transfer mode |\MCI Card Power ControlsSpecify Memory Card Power supply voltage @@ -160,11 +160,11 @@ $(document).ready(function(){initNavTree('modules.html','');}); |oStatus Error CodesNegative values indicate errors (NAND has specific codes in addition to common Status Error Codes) |oNAND EventsThe NAND driver generates call back events that are notified via the function ARM_NAND_SignalEvent |oNAND FlagsSpecify Flag codes -|oNAND Control CodesMany parameters of the NAND driver are configured using the ARM_NAND_Control function -||oNAND Mode ControlsSpecify operation modes of the NAND interface -||oNAND Bus ModesSpecify bus mode of the NAND interface -||oNAND Data Bus WidthSpecify data bus width of the NAND interface -||\NAND Driver StrengthSpecify driver strength of the NAND interface +|oNAND Control CodesMany parameters of the NAND driver are configured using the ARM_NAND_Control function +||oNAND Mode ControlsSpecify operation modes of the NAND interface +||oNAND Bus ModesSpecify bus mode of the NAND interface +||oNAND Data Bus WidthSpecify data bus width of the NAND interface +||\NAND Driver StrengthSpecify driver strength of the NAND interface |oNAND ECC CodesSpecify ECC codes |\NAND Sequence Execution CodesSpecify execution codes oFlash InterfaceDriver API for Flash Device Interface (Driver_Flash.h) @@ -172,58 +172,73 @@ $(document).ready(function(){initNavTree('modules.html','');}); oSAI InterfaceDriver API for Serial Audio Interface (Driver_SAI.h) |oStatus Error CodesNegative values indicate errors (SAI has specific codes in addition to common Status Error Codes) |oSAI EventsThe SAI driver generates call back events that are notified via the function ARM_SAI_SignalEvent -|\SAI Control CodesMany parameters of the SAI driver are configured using the ARM_SAI_Control function -| oSAI ConfigurationSpecify Transmitter/Receiver configuration -| |oSAI ModeDefines Transmitter/Receiver mode -| |oSAI SynchronizationDefines Transmitter/Receiver synchronization -| |oSAI ProtocolDefines Transmitter/Receiver protocol -| |oSAI Data SizeDefines data size in bits (per channel/slot) -| |oSAI Bit OrderDefines the bit order -| |oSAI Mono ModeDefines mono mode -| |oSAI CompandingDefines companding -| |oSAI Clock PolarityDefines clock polarity -| |oSAI FrameDefines frame -| |oSAI SlotDefines data slots -| |oSAI Master Clock PinDefines MCLK pin -| |\SAI Master Clock PrescalerDefines MCLK prescaler -| \SAI ControlsSpecifies controls +|\SAI Control CodesMany parameters of the SAI driver are configured using the ARM_SAI_Control function +| oSAI ConfigurationSpecify Transmitter/Receiver configuration +| |oSAI ModeDefines Transmitter/Receiver mode +| |oSAI SynchronizationDefines Transmitter/Receiver synchronization +| |oSAI ProtocolDefines Transmitter/Receiver protocol +| |oSAI Data SizeDefines data size in bits (per channel/slot) +| |oSAI Bit OrderDefines the bit order +| |oSAI Mono ModeDefines mono mode +| |oSAI CompandingDefines companding +| |oSAI Clock PolarityDefines clock polarity +| |oSAI FrameDefines frame +| |oSAI SlotDefines data slots +| |oSAI Master Clock PinDefines MCLK pin +| |\SAI Master Clock PrescalerDefines MCLK prescaler +| \SAI ControlsSpecifies controls oSPI InterfaceDriver API for SPI Bus Peripheral (Driver_SPI.h) |oStatus Error CodesNegative values indicate errors (SPI has specific codes in addition to common Status Error Codes) |oSPI EventsThe SPI driver generates call back events that are notified via the function ARM_SPI_SignalEvent -|\SPI Control CodesMany parameters of the SPI driver are configured using the ARM_SPI_Control function -| oSPI Mode ControlsSpecifies SPI mode -| oSPI Frame FormatDefines the frame format -| oSPI Data BitsDefines the number of data bits -| oSPI Bit OrderDefines the bit order -| oSPI Slave Select ModeSpecifies SPI slave select mode -| \SPI Miscellaneous ControlsSpecifies additional miscellaneous controls +|\SPI Control CodesMany parameters of the SPI driver are configured using the ARM_SPI_Control function +| oSPI Mode ControlsSpecifies SPI mode +| oSPI Frame FormatDefines the frame format +| oSPI Data BitsDefines the number of data bits +| oSPI Bit OrderDefines the bit order +| oSPI Slave Select ModeSpecifies SPI slave select mode +| \SPI Miscellaneous ControlsSpecifies additional miscellaneous controls oStorage InterfaceDriver API for Storage Device Interface (Driver_Storage.h) |oUse of Storage APIs |\Sample Use of Storage Driver oUSART InterfaceDriver API for Universal Synchronous Asynchronous Receiver/Transmitter (Driver_USART.h) |oStatus Error CodesNegative values indicate errors (USART has specific codes in addition to common Status Error Codes) |oUSART EventsThe USART driver generates call back events that are notified via the function ARM_USART_SignalEvent -|\USART Control CodesMany parameters of the USART driver are configured using the ARM_USART_Control function -| oUSART Mode ControlSpecify USART mode -| oUSART Miscellaneous ControlSpecifies additional miscellaneous controls -| oUSART Data BitsDefines the number of data bits -| oUSART Parity BitDefines the parity bit -| oUSART Stop BitsDefines the number of stop bits -| oUSART Flow ControlSpecifies RTS/CTS flow control -| oUSART Clock PolarityDefines the clock polarity for the synchronous mode -| \USART Clock PhaseDefines the clock phase for the synchronous mode -\USB InterfaceUSB common definitions (Driver_USB.h) - oUSB Device InterfaceDriver API for USB Device Peripheral (Driver_USBD.h) - |oUSBD Device EventsThe USB Device driver generates Device call back events that are notified via the function ARM_USBD_SignalDeviceEvent - |\USBD Endpoint EventsThe USB Device driver generates Endpoint call back events that are notified via the function ARM_USBD_SignalEndpointEvent - oUSB Host InterfaceDriver API for USB Host Peripheral (Driver_USBH.h) - |oUSB HostDriver API for USB Host - ||oUSBH Port EventsThe USB Host driver generates Port call back events that are notified via the function ARM_USBH_SignalPortEvent - ||oUSBH Pipe EventsThe USB Host driver generates Pipe call back events that are notified via the function ARM_USBH_SignalPipeEvent - ||\USBH Packet InformationSpecify USB packet information used by the function ARM_USBH_PipeTransfer - |\USB OHCI/EHCIDriver API for USB OHCI/EHCI - oUSB SpeedUSB Speed definitions - \USB Endpoint TypeUSB Endpoint Type definitions +|\USART Control CodesMany parameters of the USART driver are configured using the ARM_USART_Control function +| oUSART Mode ControlSpecify USART mode +| oUSART Miscellaneous ControlSpecifies additional miscellaneous controls +| oUSART Data BitsDefines the number of data bits +| oUSART Parity BitDefines the parity bit +| oUSART Stop BitsDefines the number of stop bits +| oUSART Flow ControlSpecifies RTS/CTS flow control +| oUSART Clock PolarityDefines the clock polarity for the synchronous mode +| \USART Clock PhaseDefines the clock phase for the synchronous mode +oUSB InterfaceUSB common definitions (Driver_USB.h) +|oUSB Device InterfaceDriver API for USB Device Peripheral (Driver_USBD.h) +||oUSBD Device EventsThe USB Device driver generates Device call back events that are notified via the function ARM_USBD_SignalDeviceEvent +||\USBD Endpoint EventsThe USB Device driver generates Endpoint call back events that are notified via the function ARM_USBD_SignalEndpointEvent +|oUSB Host InterfaceDriver API for USB Host Peripheral (Driver_USBH.h) +||oUSB HostDriver API for USB Host +|||oUSBH Port EventsThe USB Host driver generates Port call back events that are notified via the function ARM_USBH_SignalPortEvent +|||oUSBH Pipe EventsThe USB Host driver generates Pipe call back events that are notified via the function ARM_USBH_SignalPipeEvent +|||\USBH Packet InformationSpecify USB packet information used by the function ARM_USBH_PipeTransfer +||\USB OHCI/EHCIDriver API for USB OHCI/EHCI +|oUSB SpeedUSB Speed definitions +|\USB Endpoint TypeUSB Endpoint Type definitions +\WiFi InterfaceDriver API for WiFi (Driver_WiFi.h) + oWiFi ControlControl functions for the WiFi module + |\WiFi EventsThe WiFi driver generates call back events that are notified via the function ARM_WIFI_SignalEvent + oWiFi ManagementConfigure and manage the connection to a WiFi access point (AP) or configure and manage the access point (AP) + |oWiFi Option CodesWiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function + |oWiFi Security TypeSpecifies WiFi security type for ARM_WIFI_Activate + |oWiFi Protected Setup (WPS) MethodSpecifies WiFi WPS method for ARM_WIFI_Activate + |\WiFi DHCPv6 ModeSpecifies IPv6 Dynamic Host Configuration Protocol (DHCP) Mode + oWiFi Bypass ModeTransfer Ethernet frames by WiFi module + \WiFi SocketSocket interface to IP stack running on WiFi module +  oWiFi Socket Address Family definitionsWiFi Socket Address Family definitions +  oWiFi Socket Type definitionsWiFi Socket Type definitions +  oWiFi Socket Protocol definitionsWiFi Socket Protocol definitions +  oWiFi Socket Option definitionsWiFi Socket Option definitions +  \WiFi Socket Function return codesWiFi Socket Function return codes @@ -231,7 +246,7 @@ $(document).ready(function(){initNavTree('modules.html','');});