share/man/man4/nandsim.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 NANDSIM 4
  33 .Os
  34 .Sh NAME
  35 .Nm nandsim
  36 .Nd NAND Flash simulator driver
  37 .Sh SYNOPSIS
  38 .Cd "device nand"
  39 .Cd "device nandsim"
  40 .Cd "options ALQ"
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 is part of the
  45 .Fx
  46 NAND framework
  47 .Xr nand 4
  48 and can be characterized with the following highlights:
  49 .Bl -bullet
  50 .It
  51 plugs into the
  52 .Xr nand 4
  53 framework APIs as if it were a hardware controller (hanging on the nexus bus)
  54 with real NAND chips connected to it
  55 .It
  56 physically part of the kernel code (either statically linked into the kernel
  57 image or built as a module)
  58 .It
  59 controlled with a user space program
  60 .Xr nandsim 8
  61 .El
  62 .Pp
  63 From the user perspective, the
  64 .Nm
  65 allows for imitating ONFI-compliant NAND Flash devices as if they were
  66 attached to the system via a virtual controller.
  67 .Pp
  68 Some
  69 .Nm
  70 features rely on the ability to log contents to a file, which is achieved
  71 through the
  72 .Xr alq 9
  73 facility.
  74 .Sh SEE ALSO
  75 .Xr nand 4 ,
  76 .Xr nandsim.conf 5 ,
  77 .Xr nandsim 8
  78 .Sh STANDARDS
  79 Open NAND Flash Interface Working Group
  80 .Pq Vt ONFI .
  81 .Sh HISTORY
  82 The
  83 .Nm
  84 support first appeared in
  85 .Fx 10.0 .
  86 .Sh AUTHOR
  87 The
  88 .Nm
  89 kernel driver was developed by
  90 .An Grzegorz Bernacki .
  91 This manual page was written by
  92 .An Rafal Jaworowski .