Update documentation for branch main

ARM-software · Jan 10, 2025 · 8ff0f89 · 8ff0f89
1 parent 06158ed
commit 8ff0f89
Show file tree

Hide file tree

Showing 10 changed files with 65 additions and 30 deletions.
diff --git a/main/footer.js b/main/footer.js
@@ -1,7 +1,7 @@
 function writeHeader() {
-    document.write('Version 3.0.1-dev24');
+    document.write('Version 3.0.1-dev25');
 };
 
 function writeFooter()  {
-    document.write('Generated on Fri Jul  5 2024 05:59:15 for CMSIS-Driver Validation 3.0.1-dev24+ga4e044d. Copyright &copy; 2022-2024 Arm Limited (or its affiliates). All rights reserved.');
+    document.write('Generated on Fri Jan 10 2025 07:05:37 for CMSIS-Driver Validation 3.0.1-dev25+g9fff162. Copyright &copy; 2022-2025 Arm Limited (or its affiliates). All rights reserved.');
 };
diff --git a/main/group__eth__tests.html b/main/group__eth__tests.html
@@ -145,6 +145,9 @@
 <tr class="memitem:ga8097badf5b5a4bf477866955507b0d8c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__tests.html#ga8097badf5b5a4bf477866955507b0d8c">ETH_MAC_SetAddressFilter</a> (void)</td></tr>
 <tr class="memdesc:ga8097badf5b5a4bf477866955507b0d8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: ETH_MAC_SetAddressFilter.  <a href="group__eth__tests.html#ga8097badf5b5a4bf477866955507b0d8c">More...</a><br /></td></tr>
 <tr class="separator:ga8097badf5b5a4bf477866955507b0d8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga445d6c072fd7832564b10502b27373b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__tests.html#ga445d6c072fd7832564b10502b27373b7">ETH_MAC_VLAN_Filter</a> (void)</td></tr>
+<tr class="memdesc:ga445d6c072fd7832564b10502b27373b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: ETH_MAC_VLAN_Filter.  <a href="group__eth__tests.html#ga445d6c072fd7832564b10502b27373b7">More...</a><br /></td></tr>
+<tr class="separator:ga445d6c072fd7832564b10502b27373b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga7b66855efdc91dd963be8cf4e30549a6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__tests.html#ga7b66855efdc91dd963be8cf4e30549a6">ETH_MAC_SignalEvent</a> (void)</td></tr>
 <tr class="memdesc:ga7b66855efdc91dd963be8cf4e30549a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: ETH_MAC_SignalEvent.  <a href="group__eth__tests.html#ga7b66855efdc91dd963be8cf4e30549a6">More...</a><br /></td></tr>
 <tr class="separator:ga7b66855efdc91dd963be8cf4e30549a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -458,6 +461,34 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga8097badf5b5a4bf47786695
 </ul>
 <dl class="section note"><dt>Note</dt><dd>The internal Ethernet MAC loopback is used for the test. </dd></dl>
 
+</div>
+</div>
+<a id="ga445d6c072fd7832564b10502b27373b7" name="ga445d6c072fd7832564b10502b27373b7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga445d6c072fd7832564b10502b27373b7">&#9670;&nbsp;</a></span>ETH_MAC_VLAN_Filter()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void ETH_MAC_VLAN_Filter </td>
+          <td>(</td>
+          <td class="paramtype">void&#160;</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p >The function <b>ETH_MAC_VLAN_Filter</b> verifies the Ethernet MAC Virtual LAN filtering with the following sequence:</p><ul>
+<li>Buffer allocation</li>
+<li>Initialize</li>
+<li>Power on</li>
+<li>Transfer VLAN packets</li>
+<li>Receive VLAN packets</li>
+<li>Power off</li>
+<li>Uninitialize</li>
+</ul>
+<dl class="section note"><dt>Note</dt><dd>The internal Ethernet MAC loopback is used for the test. </dd></dl>
+
 </div>
 </div>
 <a id="ga7b66855efdc91dd963be8cf4e30549a6" name="ga7b66855efdc91dd963be8cf4e30549a6"></a>

diff --git a/main/group__eth__tests.js b/main/group__eth__tests.js
@@ -11,6 +11,7 @@ var group__eth__tests =
     [ "ETH_MAC_Config_CommonParams", "group__eth__tests.html#ga46ab478d3e074e1e2d23430e37583bbc", null ],
     [ "ETH_MAC_Control_Filtering", "group__eth__tests.html#ga2cd78c6396a692e262fec5aee5e3dd87", null ],
     [ "ETH_MAC_SetAddressFilter", "group__eth__tests.html#ga8097badf5b5a4bf477866955507b0d8c", null ],
+    [ "ETH_MAC_VLAN_Filter", "group__eth__tests.html#ga445d6c072fd7832564b10502b27373b7", null ],
     [ "ETH_MAC_SignalEvent", "group__eth__tests.html#ga7b66855efdc91dd963be8cf4e30549a6", null ],
     [ "ETH_PHY_GetVersion", "group__eth__tests.html#gaab75dd5f07d422b2f457f84faaafd94e", null ],
     [ "ETH_PHY_Initialization", "group__eth__tests.html#ga3ed7bdec67ded66d0a0e7d809ef40a32", null ],

diff --git a/main/navtreedata.js b/main/navtreedata.js
@@ -56,7 +56,7 @@ var NAVTREE =
 var NAVTREEINDEX =
 [
 "debugging.html",
-"group__wifi__sock__api.html#ga5b92075e23383e2cdfc08ba17b7930a1"
+"group__wifi__sock__api.html#ga57a2dee261a673a4ee30180613869423"
 ];
 
 var SYNCONMSG = 'click to disable panel synchronisation';

diff --git a/main/navtreeindex0.js b/main/navtreeindex0.js
@@ -34,25 +34,26 @@ var NAVTREEINDEX0 =
 "group__dv__wifi.html":[7,10],
 "group__eth__config.html":[7,1,0],
 "group__eth__tests.html":[7,1,1],
-"group__eth__tests.html#ga03d53d90c6b551f0e72ab1df179e29b4":[7,1,1,16],
-"group__eth__tests.html#ga070d572e482b1b3a619d42f2cda413af":[7,1,1,15],
-"group__eth__tests.html#ga1fa494c698956cc2d69bcee4152752cb":[7,1,1,14],
+"group__eth__tests.html#ga03d53d90c6b551f0e72ab1df179e29b4":[7,1,1,17],
+"group__eth__tests.html#ga070d572e482b1b3a619d42f2cda413af":[7,1,1,16],
+"group__eth__tests.html#ga1fa494c698956cc2d69bcee4152752cb":[7,1,1,15],
 "group__eth__tests.html#ga2cd78c6396a692e262fec5aee5e3dd87":[7,1,1,9],
 "group__eth__tests.html#ga31b9ceedaa57f0283360616a3ad1385f":[7,1,1,6],
 "group__eth__tests.html#ga3292704097c31ebf84ecf3b6e31f97a9":[7,1,1,3],
 "group__eth__tests.html#ga3a2ada14e6cec67e582af5f5fee0069b":[7,1,1,2],
-"group__eth__tests.html#ga3ed7bdec67ded66d0a0e7d809ef40a32":[7,1,1,13],
+"group__eth__tests.html#ga3ed7bdec67ded66d0a0e7d809ef40a32":[7,1,1,14],
+"group__eth__tests.html#ga445d6c072fd7832564b10502b27373b7":[7,1,1,11],
 "group__eth__tests.html#ga46ab478d3e074e1e2d23430e37583bbc":[7,1,1,8],
-"group__eth__tests.html#ga4a59e966d3d92454ad6adc537db182cb":[7,1,1,18],
+"group__eth__tests.html#ga4a59e966d3d92454ad6adc537db182cb":[7,1,1,19],
 "group__eth__tests.html#ga5ee442d253c0f8f790a15b07df4e3d54":[7,1,1,5],
-"group__eth__tests.html#ga7b66855efdc91dd963be8cf4e30549a6":[7,1,1,11],
+"group__eth__tests.html#ga7b66855efdc91dd963be8cf4e30549a6":[7,1,1,12],
 "group__eth__tests.html#ga7c156694d17ba1f8043e6788bc146232":[7,1,1,1],
 "group__eth__tests.html#ga8097badf5b5a4bf477866955507b0d8c":[7,1,1,10],
 "group__eth__tests.html#ga88475f2a9aea1cbbdcfc353d2f498171":[7,1,1,0],
-"group__eth__tests.html#gaab75dd5f07d422b2f457f84faaafd94e":[7,1,1,12],
-"group__eth__tests.html#gacf7d6939bdcebee02896b0e37c96b507":[7,1,1,17],
-"group__eth__tests.html#gad515d00e707fed770179761d957f0e85":[7,1,1,19],
-"group__eth__tests.html#gae5f84ed13e947020911e651523fb23c1":[7,1,1,20],
+"group__eth__tests.html#gaab75dd5f07d422b2f457f84faaafd94e":[7,1,1,13],
+"group__eth__tests.html#gacf7d6939bdcebee02896b0e37c96b507":[7,1,1,18],
+"group__eth__tests.html#gad515d00e707fed770179761d957f0e85":[7,1,1,20],
+"group__eth__tests.html#gae5f84ed13e947020911e651523fb23c1":[7,1,1,21],
 "group__eth__tests.html#gaf1c783ffbc081ced418f87e8e865cef0":[7,1,1,4],
 "group__eth__tests.html#gaf66e2e204207cd16da8d88b70a4e7dee":[7,1,1,7],
 "group__framework__config.html":[7,2,0],
@@ -248,6 +249,5 @@ var NAVTREEINDEX0 =
 "group__wifi__sock__api.html":[7,10,4,2],
 "group__wifi__sock__api.html#ga265967d39cd19c584c2c88a593c19c86":[7,10,4,2,15],
 "group__wifi__sock__api.html#ga365ef23d0c1980535863639bec4be080":[7,10,4,2,17],
-"group__wifi__sock__api.html#ga49b46f7f6a66857c1dc15b12ed179264":[7,10,4,2,2],
-"group__wifi__sock__api.html#ga57a2dee261a673a4ee30180613869423":[7,10,4,2,14]
+"group__wifi__sock__api.html#ga49b46f7f6a66857c1dc15b12ed179264":[7,10,4,2,2]
 };
diff --git a/main/navtreeindex1.js b/main/navtreeindex1.js
@@ -1,5 +1,6 @@
 var NAVTREEINDEX1 =
 {
+"group__wifi__sock__api.html#ga57a2dee261a673a4ee30180613869423":[7,10,4,2,14],
 "group__wifi__sock__api.html#ga5b92075e23383e2cdfc08ba17b7930a1":[7,10,4,2,9],
 "group__wifi__sock__api.html#ga67a1bb12d358a227080e43629ee911c3":[7,10,4,2,1],
 "group__wifi__sock__api.html#ga7c87e23d2ccc67b8b4b1bd030a045786":[7,10,4,2,8],

diff --git a/main/rev_hist.html b/main/rev_hist.html
@@ -111,7 +111,7 @@
 <tr>
 <th>Version </th><th>Description  </th></tr>
 <tr>
-<td>v3.0.1-dev24+ga4e044d </td><td>Active Development ...<ul>
+<td>v3.0.1-dev25+g9fff162 </td><td>Active Development ...<ul>
 <li>Add GPIO Driver validation</li>
 <li>Improve Ethernet driver validation</li>
 <li>Minor update to SPI driver validation</li>

diff --git a/main/search/all_2.js b/main/search/all_2.js
diff --git a/main/search/functions_1.js b/main/search/functions_1.js
diff --git a/version.js b/version.js
@@ -1,6 +1,6 @@
 //--- list of versions ---
 const versions = {
-    "main": "3.0.1-dev24",
+    "main": "3.0.1-dev25",
     "latest": "3.0.0",
     "3.0.0": "3.0.0"
 }