diff options
Diffstat (limited to 'static/freebsd/man4/mx25l.4 4.html')
| -rw-r--r-- | static/freebsd/man4/mx25l.4 4.html | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/static/freebsd/man4/mx25l.4 4.html b/static/freebsd/man4/mx25l.4 4.html new file mode 100644 index 00000000..5fe86c5b --- /dev/null +++ b/static/freebsd/man4/mx25l.4 4.html @@ -0,0 +1,152 @@ +<table class="head"> + <tr> + <td class="head-ltitle">MX25L(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">MX25L(4)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">mx25l</code> — <span class="Nd">SpiFlash + compatible non-volatile storage devices driver</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<p class="Pp"><code class="Cd">device mx25l</code></p> +<p class="Pp">In <a class="Xr">loader.conf(5)</a>: + <br/> + <code class="Cd">mx25l_load="YES"</code></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The <code class="Nm">mx25l</code> driver provides support for the + family of non-volatile storage devices known collectively as SpiFlash(tm). + SpiFlash chips typically have part numbers beginning with EN25, IS25, MX25, + S25, SST25, or W25.</p> +<p class="Pp">The <code class="Nm">mx25l</code> driver uses opcode 0x9f to read + the manufacturer and device ID data to determine whether the device is + supported. The device ID is looked up using a table of data within the + driver which describes the attributes of each supported device, such as + block size, sector size, and device capacity. When a supported device is + found, the <code class="Nm">mx25l</code> driver creates a disk device and + makes it accessible at <span class="Pa">/dev/flash/spi?</span>. The new disk + device is then tasted by the available <a class="Xr">geom(4)</a> modules as + with any disk device.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1> +<p class="Pp">The <code class="Nm">mx25l</code> driver supports the following + spi flash memory devices:</p> +<p class="Pp"></p> +<ul class="Bl-bullet Bl-compact"> + <li>AT25DF641</li> + <li>EN25F32</li> + <li>EN25P32</li> + <li>EN25P64</li> + <li>EN25Q32</li> + <li>EN25Q64</li> + <li>GD25Q64</li> + <li>M25P32</li> + <li>M25P64</li> + <li>MX25L1606E</li> + <li>MX25LL128</li> + <li>MX25LL256</li> + <li>MX25LL32</li> + <li>MX25LL64</li> + <li>N25Q64</li> + <li>S25FL032</li> + <li>S25FL064</li> + <li>S25FL128</li> + <li>S25FL256S</li> + <li>SST25VF010A</li> + <li>SST25VF032B</li> + <li>W25Q128</li> + <li>W25Q256</li> + <li>W25Q32</li> + <li>W25Q64</li> + <li>W25Q64BV</li> + <li>W25X32</li> + <li>W25X64</li> +</ul> +</section> +<section class="Sh"> +<h1 class="Sh" id="FDT_CONFIGURATION"><a class="permalink" href="#FDT_CONFIGURATION">FDT + CONFIGURATION</a></h1> +<p class="Pp">On an <a class="Xr">fdt(4)</a> based system, the + <code class="Nm">mx25l</code> device is defined as a slave device subnode of + the SPI bus controller node. All properties documented in the + <var class="Va">spibus.txt</var> bindings document can be used with the + <code class="Nm">mx25l</code> device. The most commonly-used ones are + documented below.</p> +<p class="Pp">The following properties are required in the + <code class="Nm">mx25l</code> device subnode:</p> +<dl class="Bl-tag"> + <dt id="compatible"><var class="Va">compatible</var></dt> + <dd>Must be the string "jedec,spi-nor".</dd> + <dt id="reg"><var class="Va">reg</var></dt> + <dd>Chip select address of device.</dd> + <dt id="spi-max-frequency"><var class="Va">spi-max-frequency</var></dt> + <dd>The maximum bus frequency to use when communicating with this slave + device. Actual bus speed may be lower, depending on the capabilities of + the SPI bus controller hardware.</dd> +</dl> +<p class="Pp">The following properties are optional for the + <code class="Nm">mx25l</code> device subnode:</p> +<dl class="Bl-tag"> + <dt id="spi-cpha"><var class="Va">spi-cpha</var></dt> + <dd>Empty property indicating the slave device requires shifted clock phase + (CPHA) mode.</dd> + <dt id="spi-cpol"><var class="Va">spi-cpol</var></dt> + <dd>Empty property indicating the slave device requires inverse clock polarity + (CPOL) mode.</dd> + <dt id="spi-cs-high"><var class="Va">spi-cs-high</var></dt> + <dd>Empty property indicating the slave device requires chip select active + high.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="HINTS_CONFIGURATION"><a class="permalink" href="#HINTS_CONFIGURATION">HINTS + CONFIGURATION</a></h1> +<p class="Pp">On a <a class="Xr">device.hints(5)</a> based system, such as + <code class="Li">MIPS</code>, these values are configurable for + <code class="Nm">mx25l</code>:</p> +<dl class="Bl-tag"> + <dt id="hint.mx25l._d.at"><var class="Va">hint.mx25l.%d.at</var></dt> + <dd>The spibus the <code class="Nm">mx25l</code> instance is attached to.</dd> + <dt id="hint.mx25l._d.clock"><var class="Va">hint.mx25l.%d.clock</var></dt> + <dd>The maximum bus frequency to use when communicating with this device. + Actual bus speed may be lower, depending on the capabilities of the SPI + bus controller hardware.</dd> + <dt id="hint.mx25l._d.cs"><var class="Va">hint.mx25l.%d.cs</var></dt> + <dd>The chip-select number to assert when performing I/O for this device. Set + the high bit (1 << 31) to invert the logic level of the chip select + line.</dd> + <dt id="hint.mx25l._d.mode"><var class="Va">hint.mx25l.%d.mode</var></dt> + <dd>The SPI mode (0-3) to use when communicating with this device.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1> +<dl class="Bl-tag"> + <dt><span class="Pa">/dev/flash/spi?</span></dt> + <dd>Provides read/write access to the storage device.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">fdt(4)</a>, <a class="Xr">geom(4)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">The <code class="Nm">mx25l</code> driver first appeared in + <span class="Ux">FreeBSD 8.0</span>.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">November 11, 2025</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |