blob: c73955d92e44bf67564fdf24d08af5ac51027ab7 [file] [log] [blame] [view]
<link rel="stylesheet" href="../style.css" />
[TOC]
# fuchsia.factory.wlan
<div class="fidl-version-div"><span class="fidl-attribute fidl-version">Added: 7</span></div>
## **PROTOCOLS**
## Iovar {#Iovar}
*Defined in [fuchsia.factory.wlan/iovar.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.factory.wlan/iovar.fidl;l=13)*
<p>Allows the factory testing tool to communicate to the firmware via the driver using
a pre-formatted command buffer to observe and/or control the WLAN hardware's behavior.</p>
### Get {#Iovar.Get}
<ul>
<li>request <code>iface_idx</code> interface index in the firmware</li>
<li>request <code>cmd</code> pre-defined command index specified by the manufacturer</li>
<li>request <code>request</code> additional data associated with the command</li>
</ul>
<ul>
<li>response <code>result</code> pre-formatted response data retrieved from firmware</li>
</ul>
<ul>
<li>error a status code indicating why the request could not be completed.</li>
</ul>
#### Request {#Iovar.Get_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>iface_idx</code></td>
<td>
<code>int32</code>
</td>
</tr>
<tr>
<td><code>cmd</code></td>
<td>
<code>int32</code>
</td>
</tr>
<tr>
<td><code>request</code></td>
<td>
<code>vector&lt;uint8&gt;[16384]</code>
</td>
</tr>
</table>
#### Response {#Iovar.Get_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Iovar_Get_Result'>Iovar_Get_Result</a></code>
</td>
</tr>
</table>
### Set {#Iovar.Set}
<ul>
<li>request <code>iface_idx</code> interface index in the firmware</li>
<li>request <code>cmd</code> pre-defined command index specified by the manufacturer</li>
<li>request <code>request</code> additional data associated with the command</li>
</ul>
<ul>
<li>error a status code indicating why the request could not be completed.</li>
</ul>
#### Request {#Iovar.Set_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>iface_idx</code></td>
<td>
<code>int32</code>
</td>
</tr>
<tr>
<td><code>cmd</code></td>
<td>
<code>int32</code>
</td>
</tr>
<tr>
<td><code>request</code></td>
<td>
<code>vector&lt;uint8&gt;[16384]</code>
</td>
</tr>
</table>
#### Response {#Iovar.Set_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Iovar_Set_Result'>Iovar_Set_Result</a></code>
</td>
</tr>
</table>
## **STRUCTS**
### Iovar_Get_Response {#Iovar_Get_Response data-text="Iovar_Get_Response"}
*Defined in [fuchsia.factory.wlan/iovar.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.factory.wlan/iovar.fidl;l=24)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Iovar_Get_Response.result">
<td><code>result</code></td>
<td>
<code>vector&lt;uint8&gt;[16384]</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Iovar_Set_Response {#Iovar_Set_Response data-text="Iovar_Set_Response"}
*Defined in [fuchsia.factory.wlan/iovar.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.factory.wlan/iovar.fidl;l=36)*
&lt;EMPTY&gt;
## **UNIONS**
### Iovar_Get_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Iovar_Get_Result data-text="Iovar_Get_Result"}
*Defined in [fuchsia.factory.wlan/iovar.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.factory.wlan/iovar.fidl;l=24)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Iovar_Get_Result.response">
<td><h3 id="Iovar_Get_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Iovar_Get_Response'>Iovar_Get_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Iovar_Get_Result.err">
<td><h3 id="Iovar_Get_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='../zx/'>zx</a>/<a class='link' href='../zx/#status'>status</a></code>
</td>
<td></td>
</tr>
</table>
### Iovar_Set_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Iovar_Set_Result data-text="Iovar_Set_Result"}
*Defined in [fuchsia.factory.wlan/iovar.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.factory.wlan/iovar.fidl;l=36)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Iovar_Set_Result.response">
<td><h3 id="Iovar_Set_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Iovar_Set_Response'>Iovar_Set_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Iovar_Set_Result.err">
<td><h3 id="Iovar_Set_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='../zx/'>zx</a>/<a class='link' href='../zx/#status'>status</a></code>
</td>
<td></td>
</tr>
</table>
## **CONSTANTS**
<table>
<tr><th>Name</th><th>Value</th><th>Type</th><th>Description</th></tr>
<tr id="MAX_BUFFER_SIZE">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.factory.wlan/iovar.fidl;l=9">MAX_BUFFER_SIZE</a></td>
<td>
<code>16384</code>
</td>
<td><code>uint64</code></td>
<td></td>
</tr>
</table>