Google Git
Sign in
fuchsia / reference-docs / main / . / f10 / sdk / fidl / fuchsia.hwinfo / README.md
blob: 286d4a9cef128e131a15e774a11dded896196467 [file] [log] [blame] [view]
<link rel="stylesheet" href="../style.css" />
[TOC]
# fuchsia.hwinfo
<div class="fidl-version-div"><span class="fidl-attribute fidl-version">Added: 7</span></div>
## **PROTOCOLS**
## Board {#Board}
*Defined in [fuchsia.hwinfo/hwinfo.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hwinfo/hwinfo.fidl;l=69)*
<p>Board provides an interface to retrieve hardware-specific information.</p>
### GetInfo {#Board.GetInfo}
#### Request {#Board.GetInfo_Request}
&lt;EMPTY&gt;
#### Response {#Board.GetInfo_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>info</code></td>
<td>
<code><a class='link' href='#BoardInfo'>BoardInfo</a></code>
</td>
</tr>
</table>
## Device {#Device}
*Defined in [fuchsia.hwinfo/hwinfo.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hwinfo/hwinfo.fidl;l=53)*
<p>Device provides an interface to retrieve device-specific properties.</p>
### GetInfo {#Device.GetInfo}
#### Request {#Device.GetInfo_Request}
&lt;EMPTY&gt;
#### Response {#Device.GetInfo_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>info</code></td>
<td>
<code><a class='link' href='#DeviceInfo'>DeviceInfo</a></code>
</td>
</tr>
</table>
## Product {#Product}
*Defined in [fuchsia.hwinfo/hwinfo.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hwinfo/hwinfo.fidl;l=61)*
<p>Product provides an interface to retrieve product-specific properties.</p>
### GetInfo {#Product.GetInfo}
#### Request {#Product.GetInfo_Request}
&lt;EMPTY&gt;
#### Response {#Product.GetInfo_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>info</code></td>
<td>
<code><a class='link' href='#ProductInfo'>ProductInfo</a></code>
</td>
</tr>
</table>
## **ENUMS**
### Architecture [flexible](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Architecture data-text="Architecture"}
Type: <code>uint32</code>
*Defined in [fuchsia.hwinfo/hwinfo.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hwinfo/hwinfo.fidl;l=10)*
<table>
<tr><th>Name</th><th>Value</th><th>Description</th></tr>
<tr id="Architecture.X64">
<td><h3 id="Architecture.X64" class="add-link hide-from-toc">X64</h3></td>
<td><code>1</code></td>
<td></td>
</tr>
<tr id="Architecture.ARM64">
<td><h3 id="Architecture.ARM64" class="add-link hide-from-toc">ARM64</h3></td>
<td><code>2</code></td>
<td></td>
</tr>
</table>
## **TABLES**
### BoardInfo {#BoardInfo data-text="BoardInfo"}
*Defined in [fuchsia.hwinfo/hwinfo.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hwinfo/hwinfo.fidl;l=45)*
<p>Collection of properties that are common among a set of devices based on
hardware type</p>
<table>
<tr><th>Ordinal</th><th>Field</th><th>Type</th><th>Description</th></tr>
<tr id="BoardInfo.name">
<td><h3 id="BoardInfo.name" class="add-link hide-from-toc">1</h3></td>
<td><code>name</code></td>
<td>
<code>string</code>
</td>
<td></td>
</tr>
<tr id="BoardInfo.revision">
<td><h3 id="BoardInfo.revision" class="add-link hide-from-toc">2</h3></td>
<td><code>revision</code></td>
<td>
<code>string</code>
</td>
<td></td>
</tr>
<tr id="BoardInfo.cpu_architecture">
<td><h3 id="BoardInfo.cpu_architecture" class="add-link hide-from-toc">3</h3></td>
<td><code>cpu_architecture</code></td>
<td>
<code><a class='link' href='#Architecture'>Architecture</a></code>
</td>
<td></td>
</tr>
</table>
### DeviceInfo {#DeviceInfo data-text="DeviceInfo"}
*Defined in [fuchsia.hwinfo/hwinfo.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hwinfo/hwinfo.fidl;l=16)*
<p>Collection of properties that is unique per device.</p>
<table>
<tr><th>Ordinal</th><th>Field</th><th>Type</th><th>Description</th></tr>
<tr id="DeviceInfo.serial_number">
<td><h3 id="DeviceInfo.serial_number" class="add-link hide-from-toc">1</h3></td>
<td><code>serial_number</code></td>
<td>
<code>string[255]</code>
</td>
<td></td>
</tr>
<tr id="DeviceInfo.is_retail_demo">
<td><h3 id="DeviceInfo.is_retail_demo" class="add-link hide-from-toc">2</h3></td>
<td><code>is_retail_demo</code></td>
<td>
<code>bool</code>
</td>
<td></td>
</tr>
<tr id="DeviceInfo.retail_sku">
<td><h3 id="DeviceInfo.retail_sku" class="add-link hide-from-toc">3</h3></td>
<td><code>retail_sku</code></td>
<td>
<code>string[255]</code>
</td>
<td></td>
</tr>
</table>
### ProductInfo {#ProductInfo data-text="ProductInfo"}
*Defined in [fuchsia.hwinfo/hwinfo.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hwinfo/hwinfo.fidl;l=24)*
<p>Collection of properties that is shared with other devices within the same
product line.</p>
<table>
<tr><th>Ordinal</th><th>Field</th><th>Type</th><th>Description</th></tr>
<tr id="ProductInfo.sku">
<td><h3 id="ProductInfo.sku" class="add-link hide-from-toc">1</h3></td>
<td><code>sku</code></td>
<td>
<code>string</code>
</td>
<td></td>
</tr>
<tr id="ProductInfo.language">
<td><h3 id="ProductInfo.language" class="add-link hide-from-toc">2</h3></td>
<td><code>language</code></td>
<td>
<code>string</code>
</td>
<td></td>
</tr>
<tr id="ProductInfo.regulatory_domain">
<td><h3 id="ProductInfo.regulatory_domain" class="add-link hide-from-toc">3</h3></td>
<td><code>regulatory_domain</code></td>
<td>
<code><a class='link' href='../fuchsia.intl/'>fuchsia.intl</a>/<a class='link' href='../fuchsia.intl/#RegulatoryDomain'>RegulatoryDomain</a></code>
</td>
<td></td>
</tr>
<tr id="ProductInfo.locale_list">
<td><h3 id="ProductInfo.locale_list" class="add-link hide-from-toc">4</h3></td>
<td><code>locale_list</code></td>
<td>
<code>vector&lt;<a class='link' href='../fuchsia.intl/'>fuchsia.intl</a>/<a class='link' href='../fuchsia.intl/#LocaleId'>LocaleId</a>&gt;</code>
</td>
<td></td>
</tr>
<tr id="ProductInfo.name">
<td><h3 id="ProductInfo.name" class="add-link hide-from-toc">5</h3></td>
<td><code>name</code></td>
<td>
<code>string</code>
</td>
<td></td>
</tr>
<tr id="ProductInfo.model">
<td><h3 id="ProductInfo.model" class="add-link hide-from-toc">6</h3></td>
<td><code>model</code></td>
<td>
<code>string</code>
</td>
<td></td>
</tr>
<tr id="ProductInfo.manufacturer">
<td><h3 id="ProductInfo.manufacturer" class="add-link hide-from-toc">7</h3></td>
<td><code>manufacturer</code></td>
<td>
<code>string</code>
</td>
<td></td>
</tr>
<tr id="ProductInfo.build_date">
<td><h3 id="ProductInfo.build_date" class="add-link hide-from-toc">8</h3></td>
<td><code>build_date</code></td>
<td>
<code>string</code>
</td>
<td></td>
</tr>
<tr id="ProductInfo.build_name">
<td><h3 id="ProductInfo.build_name" class="add-link hide-from-toc">9</h3></td>
<td><code>build_name</code></td>
<td>
<code>string[255]</code>
</td>
<td></td>
</tr>
<tr id="ProductInfo.colorway">
<td><h3 id="ProductInfo.colorway" class="add-link hide-from-toc">10</h3></td>
<td><code>colorway</code></td>
<td>
<code>string[255]</code>
</td>
<td></td>
</tr>
<tr id="ProductInfo.display">
<td><h3 id="ProductInfo.display" class="add-link hide-from-toc">11</h3></td>
<td><code>display</code></td>
<td>
<code>string[255]</code>
</td>
<td></td>
</tr>
<tr id="ProductInfo.memory">
<td><h3 id="ProductInfo.memory" class="add-link hide-from-toc">12</h3></td>
<td><code>memory</code></td>
<td>
<code>string[255]</code>
</td>
<td></td>
</tr>
<tr id="ProductInfo.nand_storage">
<td><h3 id="ProductInfo.nand_storage" class="add-link hide-from-toc">13</h3></td>
<td><code>nand_storage</code></td>
<td>
<code>string[255]</code>
</td>
<td></td>
</tr>
<tr id="ProductInfo.emmc_storage">
<td><h3 id="ProductInfo.emmc_storage" class="add-link hide-from-toc">14</h3></td>
<td><code>emmc_storage</code></td>
<td>
<code>string[255]</code>
</td>
<td></td>
</tr>
<tr id="ProductInfo.microphone">
<td><h3 id="ProductInfo.microphone" class="add-link hide-from-toc">15</h3></td>
<td><code>microphone</code></td>
<td>
<code>string[255]</code>
</td>
<td></td>
</tr>
<tr id="ProductInfo.audio_amplifier">
<td><h3 id="ProductInfo.audio_amplifier" class="add-link hide-from-toc">16</h3></td>
<td><code>audio_amplifier</code></td>
<td>
<code>string[255]</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_VALUE_SIZE">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hwinfo/hwinfo.fidl;l=8">MAX_VALUE_SIZE</a></td>
<td>
<code>255</code>
</td>
<td><code>uint8</code></td>
<td></td>
</tr>
</table>