share/man/man4/nand.4

   1 .\"
   2 .\" Copyright (c) 2012 The FreeBSD Foundation
   3 .\" All rights reserved.
   4 .\"
   5 .\" This documentation was written by Semihalf under sponsorship from
   6 .\" the FreeBSD Foundation.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 .\" SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd March 8, 2012
  32 .Dt NAND 4
  33 .Os
  34 .Sh NAME
  35 .Nm nand
  36 .Nd NAND Flash framework
  37 .Sh SYNOPSIS
  38 .Cd "device nand"
  39 .Sh DESCRIPTION
  40 The
  41 .Fx
  42 .Nm
  43 framework consists of a set of interfaces that aim to provide an extensible,
  44 object oriented environement for NAND controllers and NAND Flash memory chips
  45 from various hardware vendors, and to allow for uniform and flexible
  46 management of the NAND devices. It comprises of the following major
  47 components:
  48 .Bl -bullet
  49 .It
  50 NAND Flash controller (NFC) interface.
  51 .Pp
  52 Defines methods which allow to send commands as well as send/receive data
  53 between the controller and a NAND chip. Back-end drivers for specific NAND
  54 controllers plug into this interface and implement low-level routines for a
  55 given NAND controller.
  56 .Pp
  57 This layer implements basic functionality of a NAND Flash controller. It
  58 allows to send command and address to chip, drive CS (chip select line), as
  59 well as read/write to the selected NAND chip. This layer is independent of
  60 NAND chip devices actually connected to the controller.
  61 .It
  62 NAND chip interface.
  63 .Pp
  64 Provides basic operations like read page, program page, erase block. Currently
  65 three generic classes of drivers are available, which provide support for the
  66 following chips:
  67 .Bl -bullet
  68 .It
  69 large page
  70 .It
  71 small page
  72 .It
  73 ONFI-compliant
  74 .El
  75 .Pp
  76 This layer implements basic operations to be performed on a NAND chip, like
  77 read, program, erase, get status etc. Since these operations use specific
  78 commands (depending on the vendor), each chip has potentially its own
  79 implementation of the commands set.
  80 .Pp
  81 The framework is extensible so it is also possible to create a custom command
  82 set for a non standard chip support.
  83 .It
  84 NANDbus.
  85 .Pp
  86 This layer is responsible for enumerating NAND chips in the system and
  87 establishing the hierarchy between chips and their supervising controllers.
  88 .Pp
  89 Its main purpose is detecting type of NAND chips connected to a given chip
  90 select (CS line). It also allows manages locking access to the NAND
  91 controller. NANDbus passes requests from an active chip to the chip
  92 controller.
  93 .It
  94 NAND character / GEOM device.
  95 .Pp
  96 For each NAND chip found in a system a character and GEOM devices are created
  97 which allows to read / write directly to a device, as well as perform other
  98 specific operations (like via ioctl).
  99 .Pp
 100 There are two GEOM devices created for each NAND chip:
 101 .Bl -bullet
 102 .It
 103 raw device
 104 .It
 105 normal device
 106 .El
 107 .Pp
 108 Raw device allows to bypass ECC checking when reading/writing to it, while
 109 normal device always uses ECC algorithm to validate the read data.
 110 .Pp
 111 NAND character devices will be created for each NAND chip detected while
 112 probing the NAND controller.
 113 .El
 114 .Sh SEE ALSO
 115 .Xr libnandfs 3 ,
 116 .Xr gnand 4 ,
 117 .Xr nandsim 4 ,
 118 .Xr nandfs 5 ,
 119 .Xr makefs 8 ,
 120 .Xr mount_nandfs 8 ,
 121 .Xr nandfs 8 ,
 122 .Xr nandsim 8 ,
 123 .Xr nandtool 8 ,
 124 .Xr newfs_nandfs 8 ,
 125 .Xr umount_nandfs 8
 126 .Sh STANDARDS
 127 Open NAND Flash Interface Working Group
 128 .Pq Vt ONFI .
 129 .Sh HISTORY
 130 The
 131 .Nm
 132 framework support first appeared in
 133 .Fx 10.0 .
 134 .Sh AUTHOR
 135 The
 136 .Nm
 137 framework was designed and developed by
 138 .An Grzegorz Bernacki .
 139 This manual page was written by
 140 .An Rafal Jaworowski .