share/man/man5/nandfs.5

   1 .\"
   2 .\" Copyright (c) 2010 Semihalf
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd Nov 11, 2010
  29 .Dt NANDFS 5
  30 .Os
  31 .Sh NAME
  32 .Nm nandfs
  33 .Nd NAND Flash file system
  34 .Sh SYNOPSIS
  35 To compile support for the
  36 .Nm ,
  37 place the following in your kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "options NANDFS"
  40 .Ed
  41 .Pp
  42 Even though the NAND FS can be used with any storage media, it has been
  43 optimized and designed towards NAND Flash devices, so typically the following
  44 driver is used:
  45 .Bd -ragged -offset indent
  46 .Cd "device nand"
  47 .Ed
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 driver enables
  52 .Fx
  53 with support for NAND-oriented file system.
  54 .Pp
  55 It is a log-structured style file system with the following major features and
  56 characteristics:
  57 .Bl -bullet
  58 .It
  59 Hard links, symbolic links support
  60 .It
  61 Block journaling
  62 .It
  63 Copy-On-Write
  64 .It
  65 Snapshots (continuous, taken automatically, simultaneously mountable)
  66 .It
  67 Quick crash recovery at mount time
  68 .It
  69 64-bit data structures; supports many files, large files and volumes
  70 .It
  71 POSIX file permissions
  72 .It
  73 Checksum / ECC
  74 .El
  75 .Sh EXAMPLES
  76 The most common usage is mounting the file system:
  77 .Pp
  78 .Dl "mount -t nandfs /dev/<gnandN> /mnt"
  79 .Pp
  80 or:
  81 .Dl "mount_nandfs /dev/<gnandN> /mnt"
  82 .Pp
  83 where
  84 .Ar gnandN
  85 is the GEOM device representing a Flash partition (slice) containing the
  86 .Nm
  87 structure, and
  88 .Pa /mnt
  89 is a mount point.
  90 .Pp
  91 It is possible to define an entry in
  92 .Pa /etc/fstab
  93 for the
  94 .Nm :
  95 .Bd -literal
  96 /dev/gnand0             /flash  nandfs          rw      0       0
  97 .Ed
  98 .Pp
  99 This will mount a
 100 .Nm
 101 partition at the specified mount point during system boot.
 102 .Sh SEE ALSO
 103 .Xr gnand 4 ,
 104 .Xr nand 4 ,
 105 .Xr mount_nandfs 8 ,
 106 .Xr nandfs 8 ,
 107 .Xr nandsim 8 ,
 108 .Xr nandtool 8 ,
 109 .Xr umount_nandfs 8
 110 .Sh HISTORY
 111 The NAND FS concepts are based on NILFS principles and initial implementation
 112 was derived from early NILFS NetBSD code (read only). Since then the NAND FS
 113 code diverged significantly and is by no means compatible with NILFS.
 114 .Pp
 115 The NAND Flash file system first appeared in
 116 .Fx 10.0 .
 117 .Sh AUTHOR
 118 The NAND FS was written by
 119 .An Grzegorz Bernacki with the help of
 120 .An Mateusz Guzik ,
 121 based on the NetBSD code created by
 122 .An Reinoud Zandijk .
 123 Additional help and support by
 124 .An Lukasz Plachno ,
 125 .An Jan Sieka and
 126 .An Lukasz Wojcik .
 127 This manual page was written by
 128 .An Rafal Jaworowski .