Documentation/ABI/stable/sysfs-class-ubi

   1 What:           /sys/class/ubi/
   2 Date:           July 2006
   3 KernelVersion:  2.6.22
   4 Contact:        Artem Bityutskiy <dedekind@infradead.org>
   5 Description:
   6                 The ubi/ class sub-directory belongs to the UBI subsystem and
   7                 provides general UBI information, per-UBI device information
   8                 and per-UBI volume information.
   9
  10 What:           /sys/class/ubi/version
  11 Date:           July 2006
  12 KernelVersion:  2.6.22
  13 Contact:        Artem Bityutskiy <dedekind@infradead.org>
  14 Description:
  15                 This file contains version of the latest supported UBI on-media
  16                 format. Currently it is 1, and there is no plan to change this.
  17                 However, if in the future UBI needs on-flash format changes
  18                 which cannot be done in a compatible manner, a new format
  19                 version will be added. So this is a mechanism for possible
  20                 future backward-compatible (but forward-incompatible)
  21                 improvements.
  22
  23 What:           /sys/class/ubiX/
  24 Date:           July 2006
  25 KernelVersion:  2.6.22
  26 Contact:        Artem Bityutskiy <dedekind@infradead.org>
  27 Description:
  28                 The /sys/class/ubi0, /sys/class/ubi1, etc directories describe
  29                 UBI devices (UBI device 0, 1, etc). They contain general UBI
  30                 device information and per UBI volume information (each UBI
  31                 device may have many UBI volumes)
  32
  33 What:           /sys/class/ubi/ubiX/avail_eraseblocks
  34 Date:           July 2006
  35 KernelVersion:  2.6.22
  36 Contact:        Artem Bityutskiy <dedekind@infradead.org>
  37 Description:
  38                 Amount of available logical eraseblock. For example, one may
  39                 create a new UBI volume which has this amount of logical
  40                 eraseblocks.
  41
  42 What:           /sys/class/ubi/ubiX/bad_peb_count
  43 Date:           July 2006
  44 KernelVersion:  2.6.22
  45 Contact:        Artem Bityutskiy <dedekind@infradead.org>
  46 Description:
  47                 Count of bad physical eraseblocks on the underlying MTD device.
  48
  49 What:           /sys/class/ubi/ubiX/bgt_enabled
  50 Date:           July 2006
  51 KernelVersion:  2.6.22
  52 Contact:        Artem Bityutskiy <dedekind@infradead.org>
  53 Description:
  54                 Contains ASCII "0\n" if the UBI background thread is disabled,
  55                 and ASCII "1\n" if it is enabled.
  56
  57 What:           /sys/class/ubi/ubiX/dev
  58 Date:           July 2006
  59 KernelVersion:  2.6.22
  60 Contact:        Artem Bityutskiy <dedekind@infradead.org>
  61 Description:
  62                 Major and minor numbers of the character device corresponding
  63                 to this UBI device (in <major>:<minor> format).
  64
  65 What:           /sys/class/ubi/ubiX/eraseblock_size
  66 Date:           July 2006
  67 KernelVersion:  2.6.22
  68 Contact:        Artem Bityutskiy <dedekind@infradead.org>
  69 Description:
  70                 Maximum logical eraseblock size this UBI device may provide. UBI
  71                 volumes may have smaller logical eraseblock size because of their
  72                 alignment.
  73
  74 What:           /sys/class/ubi/ubiX/max_ec
  75 Date:           July 2006
  76 KernelVersion:  2.6.22
  77 Contact:        Artem Bityutskiy <dedekind@infradead.org>
  78 Description:
  79                 Maximum physical eraseblock erase counter value.
  80
  81 What:           /sys/class/ubi/ubiX/max_vol_count
  82 Date:           July 2006
  83 KernelVersion:  2.6.22
  84 Contact:        Artem Bityutskiy <dedekind@infradead.org>
  85 Description:
  86                 Maximum number of volumes which this UBI device may have.
  87
  88 What:           /sys/class/ubi/ubiX/min_io_size
  89 Date:           July 2006
  90 KernelVersion:  2.6.22
  91 Contact:        Artem Bityutskiy <dedekind@infradead.org>
  92 Description:
  93                 Minimum input/output unit size. All the I/O may only be done
  94                 in fractions of the contained number.
  95
  96 What:           /sys/class/ubi/ubiX/mtd_num
  97 Date:           January 2008
  98 KernelVersion:  2.6.25
  99 Contact:        Artem Bityutskiy <dedekind@infradead.org>
 100 Description:
 101                 Number of the underlying MTD device.
 102
 103 What:           /sys/class/ubi/ubiX/reserved_for_bad
 104 Date:           July 2006
 105 KernelVersion:  2.6.22
 106 Contact:        Artem Bityutskiy <dedekind@infradead.org>
 107 Description:
 108                 Number of physical eraseblocks reserved for bad block handling.
 109
 110 What:           /sys/class/ubi/ubiX/total_eraseblocks
 111 Date:           July 2006
 112 KernelVersion:  2.6.22
 113 Contact:        Artem Bityutskiy <dedekind@infradead.org>
 114 Description:
 115                 Total number of good (not marked as bad) physical eraseblocks on
 116                 the underlying MTD device.
 117
 118 What:           /sys/class/ubi/ubiX/volumes_count
 119 Date:           July 2006
 120 KernelVersion:  2.6.22
 121 Contact:        Artem Bityutskiy <dedekind@infradead.org>
 122 Description:
 123                 Count of volumes on this UBI device.
 124
 125 What:           /sys/class/ubi/ubiX/ubiX_Y/
 126 Date:           July 2006
 127 KernelVersion:  2.6.22
 128 Contact:        Artem Bityutskiy <dedekind@infradead.org>
 129 Description:
 130                 The /sys/class/ubi/ubiX/ubiX_0/, /sys/class/ubi/ubiX/ubiX_1/,
 131                 etc directories describe UBI volumes on UBI device X (volumes
 132                 0, 1, etc).
 133
 134 What:           /sys/class/ubi/ubiX/ubiX_Y/alignment
 135 Date:           July 2006
 136 KernelVersion:  2.6.22
 137 Contact:        Artem Bityutskiy <dedekind@infradead.org>
 138 Description:
 139                 Volume alignment - the value the logical eraseblock size of
 140                 this volume has to be aligned on. For example, 2048 means that
 141                 logical eraseblock size is multiple of 2048. In other words,
 142                 volume logical eraseblock size is UBI device logical eraseblock
 143                 size aligned to the alignment value.
 144
 145 What:           /sys/class/ubi/ubiX/ubiX_Y/corrupted
 146 Date:           July 2006
 147 KernelVersion:  2.6.22
 148 Contact:        Artem Bityutskiy <dedekind@infradead.org>
 149 Description:
 150                 Contains ASCII "0\n" if the UBI volume is OK, and ASCII "1\n"
 151                 if it is corrupted (e.g., due to an interrupted volume update).
 152
 153 What:           /sys/class/ubi/ubiX/ubiX_Y/data_bytes
 154 Date:           July 2006
 155 KernelVersion:  2.6.22
 156 Contact:        Artem Bityutskiy <dedekind@infradead.org>
 157 Description:
 158                 The amount of data this volume contains. This value makes sense
 159                 only for static volumes, and for dynamic volume it equivalent
 160                 to the total volume size in bytes.
 161
 162 What:           /sys/class/ubi/ubiX/ubiX_Y/dev
 163 Date:           July 2006
 164 KernelVersion:  2.6.22
 165 Contact:        Artem Bityutskiy <dedekind@infradead.org>
 166 Description:
 167                 Major and minor numbers of the character device corresponding
 168                 to this UBI volume (in <major>:<minor> format).
 169
 170 What:           /sys/class/ubi/ubiX/ubiX_Y/name
 171 Date:           July 2006
 172 KernelVersion:  2.6.22
 173 Contact:        Artem Bityutskiy <dedekind@infradead.org>
 174 Description:
 175                 Volume name.
 176
 177 What:           /sys/class/ubi/ubiX/ubiX_Y/reserved_ebs
 178 Date:           July 2006
 179 KernelVersion:  2.6.22
 180 Contact:        Artem Bityutskiy <dedekind@infradead.org>
 181 Description:
 182                 Count of physical eraseblock reserved for this volume.
 183                 Equivalent to the volume size in logical eraseblocks.
 184
 185 What:           /sys/class/ubi/ubiX/ubiX_Y/type
 186 Date:           July 2006
 187 KernelVersion:  2.6.22
 188 Contact:        Artem Bityutskiy <dedekind@infradead.org>
 189 Description:
 190                 Volume type. Contains ASCII "dynamic\n" for dynamic volumes and
 191                 "static\n" for static volumes.
 192
 193 What:           /sys/class/ubi/ubiX/ubiX_Y/upd_marker
 194 Date:           July 2006
 195 KernelVersion:  2.6.22
 196 Contact:        Artem Bityutskiy <dedekind@infradead.org>
 197 Description:
 198                 Contains ASCII "0\n" if the update marker is not set for this
 199                 volume, and "1\n" if it is set. The update marker is set when
 200                 volume update starts, and cleaned when it ends. So the presence
 201                 of the update marker indicates that the volume is being updated
 202                 at the moment of the update was interrupted. The later may be
 203                 checked using the "corrupted" sysfs file.
 204
 205 What:           /sys/class/ubi/ubiX/ubiX_Y/usable_eb_size
 206 Date:           July 2006
 207 KernelVersion:  2.6.22
 208 Contact:        Artem Bityutskiy <dedekind@infradead.org>
 209 Description:
 210                 Logical eraseblock size of this volume. Equivalent to logical
 211                 eraseblock size of the device aligned on the volume alignment
 212                 value.