4 The CMSIS-Driver specification is a software API that describes peripheral driver interfaces for middleware stacks and user
5 applications. The CMSIS-Driver API is designed to be generic and independent of a specific RTOS making it reusable across a
6 wide range of supported microcontroller devices. The CMSIS-Driver API covers a wide range of use cases for the supported
7 peripheral types, but can not take every potential use-case into account. Over time, it is indented to extend the
8 CMSIS-Driver API with further groups to cover new use-cases.
10 The CMSIS Software Pack publishes the API Interface under the Component Class \b CMSIS \b Driver with header files and a
11 documentation. These header files are the reference for the implementation of the standardized peripheral driver interfaces.
12 These implementations are published typically in the Device Family Pack of a related microcontroller family under the
13 Component Class \b CMSIS \b Driver. A Device Family Pack may contain additional interfaces in the Component Class \b Device
14 to extend the standard Peripheral Drivers covered by this CMSIS-Driver specification with additional device specific
15 interfaces for example for Memory BUS, GPIO, or DMA.
17 The standard peripheral driver interfaces connect microcontroller peripherals for example with middleware that implements
18 communication stacks, file systems, or graphic user interfaces. Each peripheral driver interface may provide multiple
19 instances reflecting the multiple physical interfaces of the same type in a device. For example the two physical SPI
20 interfaces are reflected with a separate \ref AccessStruct for SPI1 and SPI2. The \ref AccessStruct is the interface of a
21 driver to the middleware component or the user application.
23 \image html driver.png "Peripheral Driver Interfaces and Middleware"
25 The following CMSIS-Driver API groups are defined:
26 - \ref can_interface_gr "CAN": Interface to CAN bus peripheral.
27 - \ref eth_interface_gr "Ethernet": Interface to Ethernet MAC and PHY peripheral.
28 - \ref i2c_interface_gr "I2C": Multi-master Serial Single-Ended Bus interface driver.
29 - \ref mci_interface_gr "MCI": Memory Card Interface for SD/MMC memory.
30 - \ref nand_interface_gr "NAND": NAND Flash Memory interface driver.
31 - \ref flash_interface_gr "Flash": Flash Memory interface driver.
32 - \ref sai_interface_gr "SAI": Serial audio interface driver (I2s, PCM, AC'97, TDM, MSB/LSB Justified).
33 - \ref spi_interface_gr "SPI": Serial Peripheral Interface Bus driver.
34 - \ref storage_interface_gr "Storage": Storage device interface driver.
35 - \ref usart_interface_gr "USART": Universal Synchronous and Asynchronous Receiver/Transmitter interface driver.
36 - \ref usb_interface_gr "USB": Interface driver for USB Host and USB Device communication.
37 - \ref gpio_interface_gr "GPIO": General-purpose Input/Output driver.
38 - \ref vio_interface_gr "VIO": API for virtual I/Os (VIO).
39 - \ref wifi_interface_gr "WiFi": Interface driver for wireless communication.
41 A list of current CMSIS-Driver implementations is available \ref listOfImplementations "here".
43 \note Usually, WiFi chips and modules have their own networking stack incorporated. This means that payload data is sent via
44 a serial interface (SPI or USART) to the WiFi chip/module and the Ethernet frames are assembled inside. If you intend to use
45 a TCP/IP stack from a middleware component with a WiFi chip/module, make sure that the WiFi driver has a \ref wifi_bypass_gr.
46 This allows to send the Ethernet frames assembled by the TCP/IP component transparently through the WiFi chip/module.
50 CMSIS-Driver in ARM::CMSIS Pack
51 -------------------------------
53 The following files relevant to CMSIS-Driver are present in the <b>ARM::CMSIS</b> Pack directories:
54 | Directory | Content |
55 |--------------------------------|------------------------------------------------------------------------|
56 |\b CMSIS/Documentation/Driver | This documentation |
57 |\b CMSIS/Driver/Include | Driver header files (Driver_<i>interface</i>.h, Driver_Common.h) |
58 |\b CMSIS/Driver/DriverTemplates | Driver implementation template files (Driver_<i>interface</i>.c) |
63 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
65 \page driver_revisionHistory Revision History of CMSIS-Driver
68 <table class="cmtable" summary="Revision History">
76 - Updated VIO API 1.0.0:
78 - removed: vioSetXYZ, vioGetXYZ
79 - removed: vioSetIPv4, vioGetIPv4, vioSetIPv6, vioGetIPv6
80 - Added GPIO Driver API 1.0.0
86 - Changed: removed volatile from status related typedefs APIs
87 - Enhanced WiFi Interface API with support for polling Socket Receive/Send
88 - Added VIO API 0.1.0 (Preview)
94 - Finalized WiFi Interface API 1.0.0.
100 - Added WiFi Interface API 1.0.0-beta.
101 - Added custom driver selection to simplify implementation of new CMSIS-Driver.
107 - Enhanced CAN-Driver API with explicit BUSOFF state.
108 - Enhanced NAND-Driver API for ECC handling.
114 - Changed: All typedefs related to status have been made volatile.
120 - Added: template files for CAN interface driver.
126 - Added: CAN API for an interface to CAN peripherals
127 - Added: Overview of the \ref driverValidation "CMSIS-Driver Validation" Software Pack.
128 - Enhanced: documentation and clarified behavior of the \ref CallSequence.
134 - Minor API changes, for exact details refer to the header file of each driver.
135 - Added: Flash Interface, NAND interface.
140 <td>API with non-blocking data transfer, independent of CMSIS-RTOS.</td>
144 <td>Initial release</td>
149 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
151 \page listOfImplementations CMSIS-Driver Implementation List
153 The following table shows a list of current CMSIS-Driver implementations. It is regularly updated, so it is subject to change.
155 [CAN]: \ref can_interface_gr "CAN"
156 [Ethernet MAC]: \ref eth_mac_interface_gr "Ethernet MAC".
157 [Ethernet PHY]: \ref eth_phy_interface_gr "Ethernet PHY".
158 [I2C]: \ref i2c_interface_gr "I2C".
159 [MCI]: \ref mci_interface_gr "MCI".
160 [NAND]: \ref nand_interface_gr "NAND".
161 [Flash]: \ref flash_interface_gr "Flash".
162 [SAI]: \ref sai_interface_gr "SAI".
163 [SPI]: \ref spi_interface_gr "SPI".
164 [Storage]: \ref storage_interface_gr "Storage".
165 [USART]: \ref usart_interface_gr "USART".
166 [USB Host]: \ref usbh_interface_gr "USB Host".
167 [USB Device]: \ref usbd_interface_gr "USB Device".
168 [GPIO]: \ref gpio_interface_gr "GPIO".
169 [VIO]: \ref vio_interface_gr "VIO".
170 [WiFi]: \ref wifi_interface_gr "WiFi"
172 <table class="cmtable" summary="CMSIS-Driver Implementation List">
175 <th>Device/Family</th>
177 <th>[Ethernet MAC]</th>
178 <th>[Ethernet PHY]</th>
188 <th>[USB Device]</th>
202 <td><center>√</center></td>
206 <td><center>√</center></td>
222 <td><center>√</center></td>
226 <td><center>√</center></td>
246 <td><center>√</center></td>
259 <td><center>√</center></td>
262 <td><center>√</center></td>
264 <td><center>√</center></td>
266 <td><center>√</center></td>
279 <td><center>√</center></td>
282 <td><center>√</center></td>
284 <td><center>√</center></td>
286 <td><center>√</center></td>
299 <td><center>√</center></td>
302 <td><center>√</center></td>
304 <td><center>√</center></td>
306 <td><center>√</center></td>
331 <td><center>√</center></td>
351 <td><center>√</center></td>
356 <td><center>√</center></td>
359 <td><center>√</center></td>
360 <td><center>√</center></td>
364 <td><center>√</center></td>
366 <td><center>√</center></td>
382 <td><center>√</center></td>
396 <td><center>√</center></td>
399 <td><center>√</center></td>
403 <td><center>√</center></td>
404 <td><center>√</center></td>
406 <td><center>√</center></td>
416 <td><center>√</center></td>
417 <td><center>√</center></td>
418 <td><center>√</center></td>
419 <td><center>√</center></td>
420 <td><center>√</center></td>
423 <td><center>√</center></td>
424 <td><center>√</center></td>
426 <td><center>√</center></td>
427 <td><center>√</center></td>
428 <td><center>√</center></td>
451 <td><center>√</center></td>
458 <td><center>√</center></td>
478 <td><center>√</center></td>
497 <td><center>√</center></td>
498 <td><center>√</center></td>
518 <td><center>√</center></td>
538 <td><center>√</center></td>
558 <td><center>√</center></td>
578 <td><center>√</center></td>
597 <td><center>√</center></td>
598 <td><center>√</center></td>
617 <td><center>√</center></td>
618 <td><center>√</center></td>
642 <td><center>√</center></td>
662 <td><center>√</center></td>
679 <td><center>√</center></td>
684 <td><center>√</center></td>
688 <td><center>√</center></td>
696 <td><center>√</center></td>
697 <td><center>√</center></td>
699 <td><center>√</center></td>
700 <td><center>√</center></td>
703 <td><center>√</center></td>
704 <td><center>√</center></td>
706 <td><center>√</center></td>
707 <td><center>√</center></td>
708 <td><center>√</center></td>
716 <td><center>√</center></td>
717 <td><center>√</center></td>
719 <td><center>√</center></td>
720 <td><center>√</center></td>
723 <td><center>√</center></td>
724 <td><center>√</center></td>
726 <td><center>√</center></td>
727 <td><center>√</center></td>
728 <td><center>√</center></td>
736 <td><center>√</center></td>
737 <td><center>√</center></td>
739 <td><center>√</center></td>
740 <td><center>√</center></td>
743 <td><center>√</center></td>
744 <td><center>√</center></td>
746 <td><center>√</center></td>
747 <td><center>√</center></td>
748 <td><center>√</center></td>
756 <td><center>√</center></td>
757 <td><center>√</center></td>
759 <td><center>√</center></td>
760 <td><center>√</center></td>
763 <td><center>√</center></td>
764 <td><center>√</center></td>
766 <td><center>√</center></td>
767 <td><center>√</center></td>
768 <td><center>√</center></td>
776 <td><center>√</center></td>
777 <td><center>√</center></td>
780 <td><center>√</center></td>
787 <td><center>√</center></td>
788 <td><center>√</center></td>
796 <td><center>√</center></td>
797 <td><center>√</center></td>
800 <td><center>√</center></td>
807 <td><center>√</center></td>
808 <td><center>√</center></td>
816 <td><center>√</center></td>
817 <td><center>√</center></td>
820 <td><center>√</center></td>
827 <td><center>√</center></td>
828 <td><center>√</center></td>
830 <td><center>√</center></td>
839 <td><center>√</center></td>
844 <td><center>√</center></td>
846 <td><center>√</center></td>
859 <td><center>√</center></td>
864 <td><center>√</center></td>
866 <td><center>√</center></td>
879 <td><center>√</center></td>
884 <td><center>√</center></td>
886 <td><center>√</center></td>
899 <td><center>√</center></td>
904 <td><center>√</center></td>
906 <td><center>√</center></td>
919 <td><center>√</center></td>
924 <td><center>√</center></td>
926 <td><center>√</center></td>
939 <td><center>√</center></td>
944 <td><center>√</center></td>
946 <td><center>√</center></td>
959 <td><center>√</center></td>
964 <td><center>√</center></td>
966 <td><center>√</center></td>
979 <td><center>√</center></td>
984 <td><center>√</center></td>
986 <td><center>√</center></td>
999 <td><center>√</center></td>
1004 <td><center>√</center></td>
1006 <td><center>√</center></td>
1019 <td><center>√</center></td>
1024 <td><center>√</center></td>
1026 <td><center>√</center></td>
1039 <td><center>√</center></td>
1044 <td><center>√</center></td>
1046 <td><center>√</center></td>
1059 <td><center>√</center></td>
1064 <td><center>√</center></td>
1066 <td><center>√</center></td>
1079 <td><center>√</center></td>
1084 <td><center>√</center></td>
1086 <td><center>√</center></td>
1099 <td><center>√</center></td>
1103 <td><center>√</center></td>
1104 <td><center>√</center></td>
1106 <td><center>√</center></td>
1108 <td><center>√</center></td>
1119 <td><center>√</center></td>
1124 <td><center>√</center></td>
1126 <td><center>√</center></td>
1139 <td><center>√</center></td>
1144 <td><center>√</center></td>
1146 <td><center>√</center></td>
1159 <td><center>√</center></td>
1164 <td><center>√</center></td>
1166 <td><center>√</center></td>
1179 <td><center>√</center></td>
1184 <td><center>√</center></td>
1186 <td><center>√</center></td>
1199 <td><center>√</center></td>
1204 <td><center>√</center></td>
1206 <td><center>√</center></td>
1219 <td><center>√</center></td>
1224 <td><center>√</center></td>
1226 <td><center>√</center></td>
1239 <td><center>√</center></td>
1244 <td><center>√</center></td>
1246 <td><center>√</center></td>
1259 <td><center>√</center></td>
1264 <td><center>√</center></td>
1266 <td><center>√</center></td>
1279 <td><center>√</center></td>
1284 <td><center>√</center></td>
1286 <td><center>√</center></td>
1299 <td><center>√</center></td>
1304 <td><center>√</center></td>
1306 <td><center>√</center></td>
1319 <td><center>√</center></td>
1324 <td><center>√</center></td>
1326 <td><center>√</center></td>
1339 <td><center>√</center></td>
1344 <td><center>√</center></td>
1346 <td><center>√</center></td>
1359 <td><center>√</center></td>
1364 <td><center>√</center></td>
1366 <td><center>√</center></td>
1379 <td><center>√</center></td>
1384 <td><center>√</center></td>
1386 <td><center>√</center></td>
1399 <td><center>√</center></td>
1404 <td><center>√</center></td>
1406 <td><center>√</center></td>
1419 <td><center>√</center></td>
1424 <td><center>√</center></td>
1426 <td><center>√</center></td>
1439 <td><center>√</center></td>
1444 <td><center>√</center></td>
1446 <td><center>√</center></td>
1459 <td><center>√</center></td>
1464 <td><center>√</center></td>
1466 <td><center>√</center></td>
1479 <td><center>√</center></td>
1484 <td><center>√</center></td>
1486 <td><center>√</center></td>
1499 <td><center>√</center></td>
1504 <td><center>√</center></td>
1506 <td><center>√</center></td>
1519 <td><center>√</center></td>
1524 <td><center>√</center></td>
1526 <td><center>√</center></td>
1539 <td><center>√</center></td>
1544 <td><center>√</center></td>
1546 <td><center>√</center></td>
1559 <td><center>√</center></td>
1564 <td><center>√</center></td>
1566 <td><center>√</center></td>
1579 <td><center>√</center></td>
1584 <td><center>√</center></td>
1586 <td><center>√</center></td>
1599 <td><center>√</center></td>
1604 <td><center>√</center></td>
1606 <td><center>√</center></td>
1619 <td><center>√</center></td>
1624 <td><center>√</center></td>
1626 <td><center>√</center></td>
1639 <td><center>√</center></td>
1644 <td><center>√</center></td>
1646 <td><center>√</center></td>
1659 <td><center>√</center></td>
1664 <td><center>√</center></td>
1666 <td><center>√</center></td>
1679 <td><center>√</center></td>
1684 <td><center>√</center></td>
1686 <td><center>√</center></td>
1699 <td><center>√</center></td>
1704 <td><center>√</center></td>
1706 <td><center>√</center></td>
1719 <td><center>√</center></td>
1724 <td><center>√</center></td>
1726 <td><center>√</center></td>
1739 <td><center>√</center></td>
1744 <td><center>√</center></td>
1746 <td><center>√</center></td>
1759 <td><center>√</center></td>
1764 <td><center>√</center></td>
1766 <td><center>√</center></td>
1779 <td><center>√</center></td>
1784 <td><center>√</center></td>
1786 <td><center>√</center></td>
1799 <td><center>√</center></td>
1804 <td><center>√</center></td>
1806 <td><center>√</center></td>
1819 <td><center>√</center></td>
1824 <td><center>√</center></td>
1826 <td><center>√</center></td>
1839 <td><center>√</center></td>
1844 <td><center>√</center></td>
1846 <td><center>√</center></td>
1857 <td><center>√</center></td>
1858 <td><center>√</center></td>
1859 <td><center>√</center></td>
1864 <td><center>√</center></td>
1866 <td><center>√</center></td>
1877 <td><center>√</center></td>
1878 <td><center>√</center></td>
1879 <td><center>√</center></td>
1884 <td><center>√</center></td>
1886 <td><center>√</center></td>
1898 <td><center>√</center></td>
1899 <td><center>√</center></td>
1904 <td><center>√</center></td>
1906 <td><center>√</center></td>
1917 <td><center>√</center></td>
1918 <td><center>√</center></td>
1919 <td><center>√</center></td>
1924 <td><center>√</center></td>
1926 <td><center>√</center></td>
1937 <td><center>√</center></td>
1938 <td><center>√</center></td>
1939 <td><center>√</center></td>
1944 <td><center>√</center></td>
1946 <td><center>√</center></td>
1957 <td><center>√</center></td>
1958 <td><center>√</center></td>
1959 <td><center>√</center></td>
1964 <td><center>√</center></td>
1966 <td><center>√</center></td>
1979 <td><center>√</center></td>
1984 <td><center>√</center></td>
1986 <td><center>√</center></td>
1995 <td>MIMXRT1061X</td>
1999 <td><center>√</center></td>
2004 <td><center>√</center></td>
2006 <td><center>√</center></td>
2017 <td><center>√</center></td>
2018 <td><center>√</center></td>
2019 <td><center>√</center></td>
2024 <td><center>√</center></td>
2026 <td><center>√</center></td>
2035 <td>MIMXRT1062X</td>
2037 <td><center>√</center></td>
2038 <td><center>√</center></td>
2039 <td><center>√</center></td>
2044 <td><center>√</center></td>
2046 <td><center>√</center></td>
2057 <td><center>√</center></td>
2058 <td><center>√</center></td>
2059 <td><center>√</center></td>
2064 <td><center>√</center></td>
2066 <td><center>√</center></td>
2077 <td><center>√</center></td>
2078 <td><center>√</center></td>
2079 <td><center>√</center></td>
2084 <td><center>√</center></td>
2086 <td><center>√</center></td>
2097 <td><center>√</center></td>
2098 <td><center>√</center></td>
2099 <td><center>√</center></td>
2104 <td><center>√</center></td>
2106 <td><center>√</center></td>
2117 <td><center>√</center></td>
2118 <td><center>√</center></td>
2119 <td><center>√</center></td>
2124 <td><center>√</center></td>
2126 <td><center>√</center></td>
2137 <td><center>√</center></td>
2138 <td><center>√</center></td>
2139 <td><center>√</center></td>
2144 <td><center>√</center></td>
2146 <td><center>√</center></td>
2157 <td><center>√</center></td>
2158 <td><center>√</center></td>
2159 <td><center>√</center></td>
2164 <td><center>√</center></td>
2166 <td><center>√</center></td>
2179 <td><center>√</center></td>
2184 <td><center>√</center></td>
2186 <td><center>√</center></td>
2199 <td><center>√</center></td>
2204 <td><center>√</center></td>
2206 <td><center>√</center></td>
2219 <td><center>√</center></td>
2224 <td><center>√</center></td>
2226 <td><center>√</center></td>
2239 <td><center>√</center></td>
2244 <td><center>√</center></td>
2246 <td><center>√</center></td>
2259 <td><center>√</center></td>
2264 <td><center>√</center></td>
2266 <td><center>√</center></td>
2279 <td><center>√</center></td>
2284 <td><center>√</center></td>
2286 <td><center>√</center></td>
2299 <td><center>√</center></td>
2304 <td><center>√</center></td>
2306 <td><center>√</center></td>
2319 <td><center>√</center></td>
2324 <td><center>√</center></td>
2326 <td><center>√</center></td>
2339 <td><center>√</center></td>
2344 <td><center>√</center></td>
2346 <td><center>√</center></td>
2359 <td><center>√</center></td>
2364 <td><center>√</center></td>
2366 <td><center>√</center></td>
2379 <td><center>√</center></td>
2384 <td><center>√</center></td>
2386 <td><center>√</center></td>
2399 <td><center>√</center></td>
2404 <td><center>√</center></td>
2406 <td><center>√</center></td>
2419 <td><center>√</center></td>
2424 <td><center>√</center></td>
2426 <td><center>√</center></td>
2439 <td><center>√</center></td>
2444 <td><center>√</center></td>
2446 <td><center>√</center></td>
2459 <td><center>√</center></td>
2464 <td><center>√</center></td>
2466 <td><center>√</center></td>
2479 <td><center>√</center></td>
2484 <td><center>√</center></td>
2486 <td><center>√</center></td>
2499 <td><center>√</center></td>
2504 <td><center>√</center></td>
2506 <td><center>√</center></td>
2519 <td><center>√</center></td>
2524 <td><center>√</center></td>
2526 <td><center>√</center></td>
2539 <td><center>√</center></td>
2544 <td><center>√</center></td>
2546 <td><center>√</center></td>
2559 <td><center>√</center></td>
2564 <td><center>√</center></td>
2566 <td><center>√</center></td>
2579 <td><center>√</center></td>
2584 <td><center>√</center></td>
2586 <td><center>√</center></td>
2599 <td><center>√</center></td>
2604 <td><center>√</center></td>
2606 <td><center>√</center></td>
2619 <td><center>√</center></td>
2624 <td><center>√</center></td>
2626 <td><center>√</center></td>
2639 <td><center>√</center></td>
2644 <td><center>√</center></td>
2646 <td><center>√</center></td>
2659 <td><center>√</center></td>
2664 <td><center>√</center></td>
2666 <td><center>√</center></td>
2679 <td><center>√</center></td>
2684 <td><center>√</center></td>
2686 <td><center>√</center></td>
2699 <td><center>√</center></td>
2704 <td><center>√</center></td>
2706 <td><center>√</center></td>
2717 <td><center>√</center></td>
2719 <td><center>√</center></td>
2720 <td><center>√</center></td>
2723 <td><center>√</center></td>
2724 <td><center>√</center></td>
2726 <td><center>√</center></td>
2727 <td><center>√</center></td>
2728 <td><center>√</center></td>
2739 <td><center>√</center></td>
2744 <td><center>√</center></td>
2746 <td><center>√</center></td>
2759 <td><center>√</center></td>
2764 <td><center>√</center></td>
2766 <td><center>√</center></td>
2779 <td><center>√</center></td>
2784 <td><center>√</center></td>
2786 <td><center>√</center></td>
2799 <td><center>√</center></td>
2804 <td><center>√</center></td>
2806 <td><center>√</center></td>
2819 <td><center>√</center></td>
2824 <td><center>√</center></td>
2826 <td><center>√</center></td>
2839 <td><center>√</center></td>
2844 <td><center>√</center></td>
2846 <td><center>√</center></td>
2859 <td><center>√</center></td>
2864 <td><center>√</center></td>
2866 <td><center>√</center></td>
2879 <td><center>√</center></td>
2884 <td><center>√</center></td>
2886 <td><center>√</center></td>
2899 <td><center>√</center></td>
2904 <td><center>√</center></td>
2906 <td><center>√</center></td>
2919 <td><center>√</center></td>
2924 <td><center>√</center></td>
2926 <td><center>√</center></td>
2939 <td><center>√</center></td>
2944 <td><center>√</center></td>
2946 <td><center>√</center></td>
2959 <td><center>√</center></td>
2964 <td><center>√</center></td>
2966 <td><center>√</center></td>
2979 <td><center>√</center></td>
2984 <td><center>√</center></td>
2986 <td><center>√</center></td>
2999 <td><center>√</center></td>
3004 <td><center>√</center></td>
3006 <td><center>√</center></td>
3019 <td><center>√</center></td>
3024 <td><center>√</center></td>
3026 <td><center>√</center></td>
3039 <td><center>√</center></td>
3044 <td><center>√</center></td>
3046 <td><center>√</center></td>
3059 <td><center>√</center></td>
3064 <td><center>√</center></td>
3066 <td><center>√</center></td>
3079 <td><center>√</center></td>
3084 <td><center>√</center></td>
3086 <td><center>√</center></td>
3099 <td><center>√</center></td>
3104 <td><center>√</center></td>
3106 <td><center>√</center></td>
3119 <td><center>√</center></td>
3124 <td><center>√</center></td>
3126 <td><center>√</center></td>
3139 <td><center>√</center></td>
3144 <td><center>√</center></td>
3146 <td><center>√</center></td>
3159 <td><center>√</center></td>
3164 <td><center>√</center></td>
3166 <td><center>√</center></td>
3179 <td><center>√</center></td>
3184 <td><center>√</center></td>
3186 <td><center>√</center></td>
3199 <td><center>√</center></td>
3204 <td><center>√</center></td>
3206 <td><center>√</center></td>
3219 <td><center>√</center></td>
3224 <td><center>√</center></td>
3226 <td><center>√</center></td>
3239 <td><center>√</center></td>
3244 <td><center>√</center></td>
3246 <td><center>√</center></td>
3259 <td><center>√</center></td>
3264 <td><center>√</center></td>
3266 <td><center>√</center></td>
3279 <td><center>√</center></td>
3284 <td><center>√</center></td>
3286 <td><center>√</center></td>
3299 <td><center>√</center></td>
3304 <td><center>√</center></td>
3306 <td><center>√</center></td>
3319 <td><center>√</center></td>
3324 <td><center>√</center></td>
3326 <td><center>√</center></td>
3339 <td><center>√</center></td>
3344 <td><center>√</center></td>
3346 <td><center>√</center></td>
3359 <td><center>√</center></td>
3364 <td><center>√</center></td>
3366 <td><center>√</center></td>
3379 <td><center>√</center></td>
3384 <td><center>√</center></td>
3386 <td><center>√</center></td>
3399 <td><center>√</center></td>
3404 <td><center>√</center></td>
3406 <td><center>√</center></td>
3419 <td><center>√</center></td>
3424 <td><center>√</center></td>
3426 <td><center>√</center></td>
3439 <td><center>√</center></td>
3444 <td><center>√</center></td>
3446 <td><center>√</center></td>
3459 <td><center>√</center></td>
3464 <td><center>√</center></td>
3466 <td><center>√</center></td>
3479 <td><center>√</center></td>
3484 <td><center>√</center></td>
3486 <td><center>√</center></td>
3499 <td><center>√</center></td>
3504 <td><center>√</center></td>
3506 <td><center>√</center></td>
3519 <td><center>√</center></td>
3524 <td><center>√</center></td>
3526 <td><center>√</center></td>
3539 <td><center>√</center></td>
3544 <td><center>√</center></td>
3546 <td><center>√</center></td>
3559 <td><center>√</center></td>
3564 <td><center>√</center></td>
3566 <td><center>√</center></td>
3579 <td><center>√</center></td>
3584 <td><center>√</center></td>
3586 <td><center>√</center></td>
3599 <td><center>√</center></td>
3604 <td><center>√</center></td>
3606 <td><center>√</center></td>
3619 <td><center>√</center></td>
3624 <td><center>√</center></td>
3626 <td><center>√</center></td>
3635 <td>MKV30F12810</td>
3639 <td><center>√</center></td>
3644 <td><center>√</center></td>
3646 <td><center>√</center></td>
3655 <td>MKV31F12810</td>
3659 <td><center>√</center></td>
3664 <td><center>√</center></td>
3666 <td><center>√</center></td>
3675 <td>MKV31F25612</td>
3679 <td><center>√</center></td>
3684 <td><center>√</center></td>
3686 <td><center>√</center></td>
3695 <td>MKV31F51212</td>
3699 <td><center>√</center></td>
3704 <td><center>√</center></td>
3706 <td><center>√</center></td>
3719 <td><center>√</center></td>
3724 <td><center>√</center></td>
3726 <td><center>√</center></td>
3739 <td><center>√</center></td>
3744 <td><center>√</center></td>
3746 <td><center>√</center></td>
3759 <td><center>√</center></td>
3764 <td><center>√</center></td>
3766 <td><center>√</center></td>
3779 <td><center>√</center></td>
3784 <td><center>√</center></td>
3786 <td><center>√</center></td>
3799 <td><center>√</center></td>
3804 <td><center>√</center></td>
3806 <td><center>√</center></td>
3830 <td><center>√</center></td>
3851 <td><center>√</center></td>
3856 <td><center>√</center></td>
3859 <td><center>√</center></td>
3860 <td><center>√</center></td>
3863 <td><center>√</center></td>
3864 <td><center>√</center></td>
3866 <td><center>√</center></td>
3876 <td><center>√</center></td>
3877 <td><center>√</center></td>
3879 <td><center>√</center></td>
3880 <td><center>√</center></td>
3883 <td><center>√</center></td>
3884 <td><center>√</center></td>
3886 <td><center>√</center></td>
3887 <td><center>√</center></td>
3888 <td><center>√</center></td>
3902 <td><center>√</center></td>
3922 <td><center>√</center></td>
3951 <td><center>√</center></td>
3954 <td>STMicroelectronics</td>
3970 <td><center>√</center></td>
3974 <td>STMicroelectronics</td>
3976 <td><center>√</center></td>
3979 <td><center>√</center></td>
3984 <td><center>√</center></td>
3986 <td><center>√</center></td>
3988 <td><center>√</center></td>
3996 <td><center>√</center></td>
3997 <td><center>√</center></td>
3999 <td><center>√</center></td>
4000 <td><center>√</center></td>
4004 <td><center>√</center></td>
4006 <td><center>√</center></td>
4007 <td><center>√</center></td>
4008 <td><center>√</center></td>
4016 <td><center>√</center></td>
4017 <td><center>√</center></td>
4019 <td><center>√</center></td>
4020 <td><center>√</center></td>
4024 <td><center>√</center></td>
4026 <td><center>√</center></td>
4027 <td><center>√</center></td>
4028 <td><center>√</center></td>
4036 <td><center>√</center></td>
4039 <td><center>√</center></td>
4044 <td><center>√</center></td>
4046 <td><center>√</center></td>
4048 <td><center>√</center></td>
4056 <td><center>√</center></td>
4057 <td><center>√</center></td>
4059 <td><center>√</center></td>
4060 <td><center>√</center></td>
4064 <td><center>√</center></td>
4066 <td><center>√</center></td>
4067 <td><center>√</center></td>
4068 <td><center>√</center></td>
4076 <td><center>√</center></td>
4077 <td><center>√</center></td>
4079 <td><center>√</center></td>
4080 <td><center>√</center></td>
4084 <td><center>√</center></td>
4086 <td><center>√</center></td>
4087 <td><center>√</center></td>
4088 <td><center>√</center></td>
4090 <td><center>√</center></td>
4110 <td><center>√</center></td>
4124 <td><center>√</center></td>
4126 <td><center>√</center></td>
4130 <td><center>√</center></td>
4136 <td><center>√</center></td>
4137 <td><center>√</center></td>
4139 <td><center>√</center></td>
4140 <td><center>√</center></td>
4144 <td><center>√</center></td>
4146 <td><center>√</center></td>
4147 <td><center>√</center></td>
4148 <td><center>√</center></td>
4150 <td><center>√</center></td>
4159 <td><center>√</center></td>
4164 <td><center>√</center></td>
4166 <td><center>√</center></td>
4168 <td><center>√</center></td>
4190 <td><center>√</center></td>
4199 <td><center>√</center></td>
4200 <td><center>√</center></td>
4204 <td><center>√</center></td>
4206 <td><center>√</center></td>
4207 <td><center>√</center></td>
4208 <td><center>√</center></td>
4224 <td><center>√</center></td>
4226 <td><center>√</center></td>
4230 <td><center>√</center></td>
4244 <td><center>√</center></td>
4246 <td><center>√</center></td>
4250 <td><center>√</center></td>
4258 <td><center>√</center></td>
4274 <td>Texas Instruments</td>
4278 <td><center>√</center></td>
4311 <td><center>√</center></td>
4315 Last update: 2023-06-13.
4318 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
4320 \page theoryOperation Theory of Operation
4323 This section gives an overview of the general operation of CMSIS-Drivers. It explains the \ref DriverFunctions that are
4324 common in all CMSIS-Drivers along with the \ref CallSequence. The topic \ref Data_Xfer_Functions describes how data
4325 read/write operations to the peripheral are implemented.
4327 Each CMSIS-Driver defines an \ref AccessStruct for calling the various driver functions and each peripheral (that is accessed
4328 via a CMSIS-Driver) has one \ref DriverInstances "Driver Instance".
4331 \section DriverFunctions Common Driver Functions
4333 Each CMSIS-Driver contains these functions:
4335 - \b GetVersion: can be called at any time to obtain version information of the driver interface.
4337 - \b GetCapabilities: can be called at any time to obtain capabilities of the driver interface.
4339 - \b Initialize: must be called before powering the peripheral using \b PowerControl. This function performs the following:
4340 - allocate I/O resources.
4341 - register an optional \b SignalEvent callback function.
4343 - \b SignalEvent: is an optional callback function that is registered with the \b Initialize function. This callback
4344 function is initiated from interrupt service routines and indicates hardware events or the completion of a data block
4347 - \b PowerControl: Controls the power profile of the peripheral and needs to be called after \b Initialize. Typically, three
4348 power options are available:
4349 - \c ARM_POWER_FULL: Peripheral is turned on and fully operational. The driver initializes the peripheral registers, interrupts, and (optionally) DMA.
4350 - \c ARM_POWER_LOW: (optional) Peripheral is in low power mode and partially operational; usually, it can detect
4351 external events and wake-up.
4352 - \c ARM_POWER_OFF: Peripheral is turned off and not operational (pending operations are terminated). This is the state
4355 - \b Uninitialize: Complementary function to Initialize. Releases the I/O pin resources used by the interface.
4357 - \b Control: Several drivers provide a control function to configure communication parameters or execute miscellaneous
4360 The section \ref CallSequence contains more information on the operation of each function. Additional functions are specific
4361 to each driver interface and are described in the individual sections of each driver.
4363 \subsection ProcessorMode Cortex-M Processor Mode
4365 The CMSIS-Driver functions access peripherals and interrupts and are designed to execute in \b Privileged mode.
4366 When calling CMSIS-Driver functions from RTOS threads, it should be ensure that these threads execute in \b Privileged mode.
4369 \section CallSequence Function Call Sequence
4371 For normal operation of the driver, the API functions \b GetVersion, \b GetCapabilities, \b Initialize, \b PowerControl, \b Uninitialize are
4372 called in the following order:
4375 a [label="", textcolor="indigo", linecolor="indigo", arclinecolor="indigo"],
4376 b [label="", textcolor="blue", linecolor="blue", arclinecolor="blue"];
4378 a rbox a [label="Middleware", linecolor="indigo"],
4379 b rbox b [label="Driver", linecolor="blue"];
4380 --- [label="Verify API version"];
4381 a=>b [label="GetVersion ()", textcolor="gray", linecolor="gray"];
4382 --- [label="Obtain driver features"];
4383 a=>b [label="GetCapabilities (...)", textcolor="gray", linecolor="gray"];
4384 --- [label="Setup software resources"];
4385 a=>b [label="Initialize (...)", textcolor="red", linecolor="red"];
4386 --- [label="Setup the peripheral"];
4387 a=>b [label="PowerControl (ARM_POWER_FULL)", textcolor="red", linecolor="red"];
4388 --- [label="Operate with the peripheral"];
4389 a=>b [label="Data Transfer Functions"];
4390 a<=b [label="SignalEvent (...)"];
4391 --- [label="Wait for external hardware events"];
4392 a=>b [label="PowerControl (ARM_POWER_LOW)"];
4393 a<=b [label="SignalEvent (...)"];
4394 --- [label="Stop working with peripheral"];
4395 a=>b [label="PowerControl (ARM_POWER_OFF)", textcolor="red", linecolor="red"];
4396 a=>b [label="Uninitialize (...)", textcolor="red", linecolor="red"];
4399 The functions \b GetVersion and \b GetCapabilities can be called any time to obtain the required information from the driver.
4400 These functions return always the same information.
4403 \subsection CS_start Start Sequence
4405 To start working with a peripheral the functions \b Initialize and \b PowerControl need to be called in this order:
4407 drv->Initialize (...); // Allocate I/O pins
4408 drv->PowerControl (ARM_POWER_FULL); // Power up peripheral, setup IRQ/DMA
4411 - \b Initialize typically allocates the I/O resources (pins) for the peripheral. The function can be called multiple times;
4412 if the I/O resources are already initialized it performs no operation and just returns with \ref ARM_DRIVER_OK.
4413 - \b PowerControl (\c ARM_POWER_FULL) sets the peripheral registers including interrupt (NVIC) and optionally DMA.
4414 The function can be called multiple times; if the registers are already set it performs no operation and just returns with \ref ARM_DRIVER_OK.
4416 \subsection CS_stop Stop Sequence
4418 To stop working with a peripheral the functions \b PowerControl and \b Uninitialize need to be called in this order:
4420 drv->PowerControl (ARM_POWER_OFF); // Terminate any pending transfers, reset IRQ/DMA, power off peripheral
4421 drv->Uninitialize (...); // Release I/O pins
4423 The functions \b PowerControl and \b Uninitialize always execute and can be used to put the peripheral into a <b>Safe State</b>,
4424 for example after any data transmission errors. To restart the peripheral in a error condition, you should first execute
4425 the \ref CS_stop and then the \ref CS_start.
4427 - \b PowerControl (\c ARM_POWER_OFF) terminates any pending data transfers with the peripheral, disables the peripheral and
4428 leaves it in a defined mode (typically the reset state).
4429 - when DMA is used it is disabled (including the interrupts)
4430 - peripheral interrupts are disabled on NVIC level
4431 - the peripheral is reset using a dedicated reset mechanism (if available) or by clearing the peripheral registers
4432 - pending peripheral interrupts are cleared on NVIC level
4433 - driver variables are cleared
4434 - \b Uninitialize always releases I/O pin resources.
4436 \section Share_IO Shared I/O Pins
4438 All CMSIS-Driver provide a \ref CS_start and \ref CS_stop. Therefore two different drivers can share the same I/O pins,
4439 for example UART1 and SPI1 can have overlapping I/O pins. In this case the communication channels can be used as shown below:
4442 SPI1drv->Initialize (...); // Start SPI1
4443 SPI1drv->PowerControl (ARM_POWER_FULL);
4444 ... // Do operations with SPI1
4445 SPI1drv->PowerControl (ARM_POWER_OFF); // Stop SPI1
4446 SPI1drv->Uninitialize ();
4448 USART1drv->Initialize (...); // Start USART1
4449 USART1drv->PowerControl (ARM_POWER_FULL);
4450 ... // Do operations with USART1
4451 USART1drv->PowerControl (ARM_POWER_OFF); // Stop USART1
4452 USART1drv->Uninitialize ();
4455 \section Data_Xfer_Functions Data Transfer Functions
4457 A CMSIS-Driver implements non-blocking functions to transfer data to a peripheral. This means that the driver configures the
4458 read or write access to the peripheral and instantly returns to the calling application. The function names for data
4460 - \b Send to write data to a peripheral.
4461 - \b Receive to read data from a peripheral.
4462 - \b Transfer to indicate combined read/write operations to a peripheral.
4464 During a data transfer, the application can query the number of transferred data items using functions named
4465 <b>Get<i>xxx</i>Count</b>. On completion of a data transfer, the driver calls a callback function with a specific event code.
4467 During the data exchange with the peripheral, the application can decide to:
4468 - Wait (using an RTOS scheduler) for the callback completion event. The RTOS is controlled by the application code which
4469 makes the driver itself RTOS independent.
4470 - Use polling functions that return the number of transferred data items to show progress information or partly read or fill
4471 data transfer buffers.
4472 - Prepare another data transfer buffer for the next data transfer.
4474 The following diagram shows the basic communication flow when using the \b _Send function in an application.
4476 \image html Non_blocking_transmit_small.png "Non-blocking Send Function"
4478 \section AccessStruct Access Struct
4480 A CMSIS-Driver publishes an \ref AccessStruct with the data type name ARM_DRIVER_xxxx that gives to access the driver
4483 \b Code \b Example: \b Function \b Access \b of \b the \b SPI \b driver
4485 typedef struct _ARM_DRIVER_SPI {
4486 ARM_DRIVER_VERSION (*GetVersion) (void);
4487 ARM_SPI_CAPABILITIES (*GetCapabilities) (void);
4488 int32_t (*Initialize) (ARM_SPI_SignalEvent_t cb_event);
4489 int32_t (*Uninitialize) (void);
4490 int32_t (*PowerControl) (ARM_POWER_STATE state);
4491 int32_t (*Send) (const void *data, uint32_t num);
4492 int32_t (*Receive) ( void *data, uint32_t num);
4493 int32_t (*Transfer) (const void *data_out, void *data_in, uint32_t num);
4494 uint32_t (*GetDataCount) (void);
4495 int32_t (*Control) (uint32_t control, uint32_t arg);
4496 ARM_SPI_STATUS (*GetStatus) (void);
4497 } const ARM_DRIVER_SPI;
4500 \subsection DriverInstances Driver Instances
4502 A device may offer several peripherals of the same type. For such devices, the CMSIS-Driver publishes multiple instances
4503 of the \ref AccessStruct. The name of each driver instance reflects the names of the peripheral available in the device.
4505 \b Code \b Example: \ref AccessStruct \b for \b three \b SPIs \b in \b a \b microcontroller \b device.
4507 ARM_DRIVER_SPI Driver_SPI1; // access functions for SPI1 interface
4508 ARM_DRIVER_SPI Driver_SPI2; // access functions for SPI2 interface
4509 ARM_DRIVER_SPI Driver_SPI3; // access functions for SPI3 interface
4512 The access functions can be passed to middleware to specify the driver instance that the middleware should use for communication.
4514 \b Naming \b Convention
4516 The access structs need to follow this naming convention: the keyword "Driver" followed by an underscore "_", the interface
4517 name "IFNAME" (usually in upper case letters), and the instance number "n". Here's the full list of access struct names for
4518 all drivers (n to be replaced with the actual instance number):
4540 void init_middleware (ARM_DRIVER_SPI *Drv_spi) ...
4541 \\ inside the middleware the SPI driver functions are called with:
4542 \\ Drv_spi->function (...);
4547 init_middleware (&Driver_SPI1); // connect middleware to SPI1 interface
4549 init_middleware (&Driver_SPI2); // connect middleware to SPI2 interface
4553 \section DriverConfiguration Driver Configuration
4555 For a device family, the drivers may be configurable. The \ref referenceImplementation stores configuration options in a
4556 central file with the name \b RTE_Device.h. However, the configuration of the drivers itself is not part of the CMSIS-Driver
4559 \section CodeExample Code Example
4561 The following example code shows the usage of the SPI interface.
4566 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
4568 \page referenceImplementation Reference Implementation
4570 The API of the CMSIS-Drivers is published in the \ref DriverHeaderFiles.
4572 To simplify the development of a CMSIS-Driver both \ref DriverTemplates and \ref DriverExamples are provided.
4574 ARM offers also a Software Pack for CMSIS-Driver Validation as described in \ref driverValidation.
4576 \section DriverHeaderFiles Driver Header Files
4578 The API of each CMSIS-Driver is published in a header file. It is recommended to include the header file that is part of the
4579 CMSIS specification in the implementation file of the CMSIS-Driver.
4581 The following header files are available in the directory <b>.\\CMSIS\\Driver\\Include</b>.
4583 | Header File | Description
4584 |----------------------|-------------------------
4585 | %Driver_Common.h | \ref common_drv_gr
4586 | %Driver_CAN.h | \ref can_interface_gr
4587 | %Driver_ETH.h | \ref eth_interface_gr
4588 | %Driver_ETH_MAC.h | \ref eth_mac_interface_gr
4589 | %Driver_ETH_PHY.h | \ref eth_phy_interface_gr
4590 | %Driver_Flash.h | \ref flash_interface_gr
4591 | %Driver_GPIO.h | \ref gpio_interface_gr
4592 | %Driver_I2C.h | \ref i2c_interface_gr
4593 | %Driver_MCI.h | \ref mci_interface_gr
4594 | %Driver_NAND.h | \ref nand_interface_gr
4595 | %Driver_SPI.h | \ref spi_interface_gr
4596 | %Driver_Storage.h | \ref storage_interface_gr
4597 | %Driver_SAI.h | \ref sai_interface_gr
4598 | %Driver_USART.h | \ref usart_interface_gr
4599 | %Driver_USB.h | \ref usb_interface_gr
4600 | %Driver_USBD.h | \ref usbd_interface_gr
4601 | %Driver_USBH.h | \ref usbh_interface_gr
4602 | %Driver_WiFi.h | \ref wifi_interface_gr
4605 \section DriverTemplates Driver Template Files
4607 Driver template files are code skeletons that provide the structure of a CMSIS-Driver. The following templates are
4608 available in the directory <b>.\\CMSIS\\Driver\\DriverTemplates</b>.
4610 | Source File | Description
4611 |-------------------|------------------------------------
4612 | %Driver_CAN.c | \ref can_interface_gr
4613 | %Driver_ETH_MAC.c | \ref eth_mac_interface_gr
4614 | %Driver_ETH_PHY.c | \ref eth_mac_interface_gr
4615 | %Driver_Flash.c | \ref flash_interface_gr
4616 | %Driver_GPIO.c | \ref gpio_interface_gr
4617 | %Driver_I2C.c | \ref i2c_interface_gr
4618 | %Driver_MCI.c | \ref mci_interface_gr
4619 | %Driver_SAI.c | \ref sai_interface_gr
4620 | %Driver_SPI.c | \ref spi_interface_gr
4621 | %Driver_Storage.c | \ref storage_interface_gr
4622 | %Driver_USART.c | \ref usart_interface_gr
4623 | %Driver_USBD.c | \ref usbd_interface_gr
4624 | %Driver_USBH.c | \ref usbh_interface_gr
4627 \section DriverExamples Driver Examples
4629 The driver examples are full working CMSIS-Drivers that may be adapted to a different hardware. Examples are currently
4630 available for the NXP LPC1800 series and provide the implementation of a complete CMSIS-Driver. The following examples are
4631 available in the directory <b>.\\CMSIS\\Pack\\Example\\CMSIS_Driver</b>.
4633 | Source File | Header File | Description
4634 |-------------------|-------------------|-------------------------------
4635 | %EMAC_LPC18xx.c | %EMAC_LPC18xx.h | \ref eth_mac_interface_gr
4636 | %SSP_LPC18xx.c | %SSP_LPC18xx.h | \ref spi_interface_gr
4637 | %I2C_LPC18xx.c | %I2C_LPC18xx.h | \ref i2c_interface_gr
4638 | %I2S_LPC18xx.c | %I2S_LPC18xx.h | \ref sai_interface_gr
4639 | %MCI_LPC18xx.c | %MCI_LPC18xx.h | \ref mci_interface_gr
4640 | %USART_LPC18xx.c | %USART_LPC18xx.h | \ref usart_interface_gr
4641 | %USBn_LPC18xx.c | %USB_LPC18xx.h | common files for \ref usbd_interface_gr and \ref usbh_interface_gr
4642 | %USBDn_LPC18xx.c | <i>none</i> | \ref usbd_interface_gr
4643 | %USBHn_LPC18xx.c | <i>none</i> | \ref usbh_interface_gr
4646 These CMSIS-Drivers use additional modules for GPIO and DMA control:
4648 | Source File | Header File | Description
4649 |-------------------|------------------|---------------------------------------
4650 | %GPIO_LPC18xx.c | %GPIO_LPC18xx.h | GPIO Interface for LPC1800 series
4651 | %GPDMA_LPC18xx.c | <i>none</i> | DMA Interface for LPC1800 series
4652 | %SCU_LPC18xx.c | %SCU_LPC18xx.h | SCU Interface for LPC1800 series
4654 The CMSIS-Drivers for the LPC1800 device have also many configuration options that are controls using \#define statements in
4655 the file <b>.\\CMSIS\\Pack\\Example\\CMSIS_Driver\\Config\\RTE_Device.h</b>. Using this file, the I/O pin and DMA assignment
4656 can be set among other parameters such as USB speed and PHY interfaces.
4658 Further driver reference implementations are available in Device Family Packs (DFP) labeled with version 2.0.0 or higher.
4661 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
4663 \page driverValidation Driver Validation
4665 The <a href="https://www.keil.com/pack/" target=_blank>Software Pack</a> named <b>ARM::CMSIS-Driver_Validation</b> contains the following:
4667 - Source code of a CMSIS-Driver Validation Suite along with configuration file.
4668 - Documentation of the CMSIS-Driver Validation Suite.
4669 - Examples that shows the usage of the CMSIS-Driver Validation Suite on various target platforms.
4671 The CMSIS-Driver Validation Suite performs the following tests:
4672 - Generic Validation of API function calls
4673 - Validation of Configuration Parameters
4674 - Validation of Communication with loopback tests
4675 - Validation of Communication Parameters such as baudrate
4676 - Validation of Event functions
4678 The following CMSIS-Drivers can be tested with the current release:
4679 - \ref can_interface_gr : with loop back test of communication.
4680 - \ref eth_interface_gr : MAC and PHY with loop back test of communication.
4681 - \ref i2c_interface_gr : only API and setup; does not test data transfer.
4682 - \ref mci_interface_gr : only API and setup; does not test data transfer.
4683 - \ref spi_interface_gr : with loop back test of communication.
4684 - \ref usart_interface_gr : with loop back test of communication.
4685 - \ref usbd_interface_gr : only API and setup; does not test data transfer.
4686 - \ref usbh_interface_gr : only API and setup; does not test data transfer.
4687 - \ref wifi_interface_gr : extensive tests for WiFi Driver.
4689 The Driver Validation output can be printed to a console or saved in an XML file, via standard output (usually ITM).
4691 \section test_output Sample Test Output
4693 CMSIS-Driver USART Test Report Dec 6 2019 11:44:30
4695 TEST 01: USART_GetCapabilities PASSED
4696 TEST 02: USART_Initialization PASSED
4697 TEST 03: USART_PowerControl
4698 DV_USART.c (301): [WARNING] Low power is not supported
4700 TEST 04: USART_Config_PolarityPhase PASSED
4701 TEST 05: USART_Config_DataBits
4702 DV_USART.c (387): [WARNING] Data Bits = 9 are not supported
4704 TEST 06: USART_Config_StopBits
4705 DV_USART.c (425): [WARNING] Stop Bits = 1.5 are not supported
4706 DV_USART.c (429): [WARNING] Stop Bits = 0.5 are not supported
4708 TEST 07: USART_Config_Parity PASSED
4709 TEST 08: USART_Config_Baudrate PASSED
4710 TEST 09: USART_Config_CommonParams PASSED
4711 TEST 10: USART_Send PASSED
4712 TEST 11: USART_AsynchronousReceive PASSED
4713 TEST 12: USART_Loopback_CheckBaudrate PASSED
4714 TEST 13: USART_Loopback_Transfer PASSED
4715 TEST 14: USART_CheckInvalidInit PASSED
4717 Test Summary: 14 Tests, 14 Passed, 0 Failed.
4721 \section loop_back_setup Setup for Loop Back Communication
4723 To perform loop back communication tests it is required to connect the input and the output of the peripherals as shown in this table:
4725 Peripheral | Loop Back Configuration
4726 :----------------|:----------------------------
4727 Ethernet | Connect TX+ (Pin 1) with RX+ (Pin 3), TX- (Pin 2) with RX- (Pin 6)
4728 SPI | Connect MISO to MOSI
4729 USART | Connect TX with RX
4731 The following picture shows the necessary external loop back connections for the Keil MCBSTM32F400 evaluation board:
4732 - SPI: PB14 (SPI2_MISO) and PB15 (SPI2_MOSI)
4733 - USART: PB6 (USART1_TX) and PB7 (USART1_RX)
4734 - Ethernet: Pin 1 (TX+) and Pin 3 (RX+), Pin 2 (TX-) and Pin 6 (RX-)
4736 \image html image006.png "Connections for Loop Back Communication Tests on Keil MCBSTM32F400"