Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MX25L(4)		 BSD Kernel Interfaces Manual		      MX25L(4)

NAME
     mx25l -- driver for SpiFlash(tm) compatible non-volatile storage devices

SYNOPSIS
     To	compile	this driver into the kernel, place the following line in your
     kernel configuration file:

	   device mx25l

     Alternatively, to load the	driver as a module at boot time, place the
     following line in loader.conf(5):

	   mx25l_load="YES"

DESCRIPTION
     The mx25l 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.

     The mx25l 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 at-
     tributes of each supported	device,	such as	block size, sector size, and
     device capacity.  When a supported	device is found, the mx25l driver cre-
     ates a disk device	and makes it accessible	at /dev/flash/mx25l?.  The new
     disk device is then tasted	by the available geom(4) modules as with any
     disk device.

HARDWARE
     The mx25l driver provides support for the following devices:

     +o	 AT25DF641
     +o	 EN25F32
     +o	 EN25P32
     +o	 EN25P64
     +o	 EN25Q32
     +o	 EN25Q64
     +o	 GD25Q64
     +o	 M25P32
     +o	 M25P64
     +o	 MX25L1606E
     +o	 MX25LL128
     +o	 MX25LL256
     +o	 MX25LL32
     +o	 MX25LL64
     +o	 S25FL032
     +o	 S25FL064
     +o	 S25FL128
     +o	 S25FL256S
     +o	 SST25VF010A
     +o	 SST25VF032B
     +o	 W25Q128
     +o	 W25Q256
     +o	 W25Q32
     +o	 W25Q64
     +o	 W25Q64BV
     +o	 W25X32
     +o	 W25X64

FDT CONFIGURATION
     On	an fdt(4) based	system,	the mx25l device is defined as a slave device
     subnode of	the SPI	bus controller node.  All properties documented	in the
     spibus.txt	bindings document can be used with the mx25l device.  The most
     commonly-used ones	are documented below.

     The following properties are required in the mx25l	device subnode:

     compatible
	     Must be the string	"jedec,spi-nor".

     reg     Chip select address of device.

     spi-max-frequency
	     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.

     The following properties are optional for the mx25l device	subnode:

     spi-cpha
	     Empty property indicating the slave device	requires shifted clock
	     phase (CPHA) mode.

     spi-cpol
	     Empty property indicating the slave device	requires inverse clock
	     polarity (CPOL) mode.

     spi-cs-high
	     Empty property indicating the slave device	requires chip select
	     active high.

HINTS CONFIGURATION
     On	a device.hints(5) based	system,	such as	MIPS, these values are config-
     urable for	mx25l:

     hint.mx25l.%d.at
	     The spibus	the mx25l instance is attached to.

     hint.mx25l.%d.clock
	     The maximum bus frequency to use when communicating with this de-
	     vice.  Actual bus speed may be lower, depending on	the capabili-
	     ties of the SPI bus controller hardware.

     hint.mx25l.%d.cs
	     The chip-select number to assert when performing I/O for this de-
	     vice.  Set	the high bit (1	<< 31) to invert the logic level of
	     the chip select line.

     hint.mx25l.%d.mode
	     The SPI mode (0-3)	to use when communicating with this device.

FILES
     /dev/flash/mx25l?	Provides read/write access to the storage device.

     /dev/flash/spi?	An alias for the /dev/mx25l? device, for backwards
			compatibility with older versions of the driver.

SEE ALSO
     fdt(4), geom(4)

HISTORY
     The mx25l driver first appeared in	FreeBSD	8.0.

BSD			       February	26, 2019			   BSD

NAME | SYNOPSIS | DESCRIPTION | HARDWARE | FDT CONFIGURATION | HINTS CONFIGURATION | FILES | SEE ALSO | HISTORY

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=mx25l&sektion=4&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help