mtd/ubi/ubi.h

80 /* The volume ID/LEB number/erase counter is unknown */
118  * MOVE_CANCEL_RACE: canceled because the volume is being deleted, the source
184  * @vol_id: volume ID of the locked logical eraseblock
204  * struct ubi_rename_entry - volume re-name description data structure.
205  * @new_name_len: new volume name length
206  * @new_name: new volume name
207  * @remove: if not zero, this volume should be removed, not re-named
208  * @desc: descriptor of the volume
211  * This data structure is utilized in the multiple volume re-name code. Namely,
262  * struct ubi_volume - UBI volume description data structure.
266  * @vol_id: volume ID
267  * @ref_count: volume reference count
268  * @readers: number of users holding this volume in read-only mode
269  * @writers: number of users holding this volume in read-write mode
270  * @exclusive: whether somebody holds this volume in exclusive mode
271  * @metaonly: whether somebody is altering only meta data of this volume
273  * @reserved_pebs: how many physical eraseblocks are reserved for this volume
274  * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
276  * @used_ebs: how many logical eraseblocks in this volume contain data
278  * @used_bytes: how many bytes of data this volume contains
279  * @alignment: volume alignment
282  * @name_len: volume name length
283  * @name: volume name
288  * @upd_bytes: how many bytes are expected to be received for volume update or
290  * @upd_received: how many bytes were already received for volume update or
295  * @eba_tbl: EBA table of this volume (LEB->PEB mapping)
296  * @checked: %1 if this static volume was checked
297  * @corrupted: %1 if the volume is corrupted (static volumes only)
298  * @upd_marker: %1 if the update marker is set for this volume
299  * @updating: %1 if the volume is being updated
301  * @direct_writes: %1 if direct writes are enabled for this volume
303  * The @corrupted field indicates that the volume's contents is corrupted.
308  * The @upd_marker flag indicates that this volume is either being updated at
353  * struct ubi_volume_desc - UBI volume descriptor returned when it is opened.
354  * @vol: reference to the corresponding volume description object
436  * @autoresize_vol_id: ID of the volume which has to be auto-resized at the end
438  * @vtbl_slots: how many slots are available in the volume table
439  * @vtbl_size: size of the volume table in bytes
440  * @vtbl: in-RAM volume table copy
441  * @device_mutex: protects on-flash volume table and serializes volume
511  * @vid_hdr_offset: starting offset of the volume identifier header (might be
525  * @ckvol_mutex: serializes static volume checking when opening
633  * @vol_id: ID of the volume this LEB belongs to
639  * @u.rb: link in the per-volume RB-tree of &struct ubi_ainf_peb objects
644  * volume, the @vol_id and @lnum fields are initialized to %UBI_UNKNOWN.
661  * struct ubi_ainf_volume - attaching information about a volume.
662  * @vol_id: volume ID
663  * @highest_lnum: highest logical eraseblock number in this volume
664  * @leb_count: number of logical eraseblocks in this volume
665  * @vol_type: volume type
666  * @used_ebs: number of used logical eraseblocks in this volume (only for
669  *                  volume (always equivalent to the usable logical eraseblock
671  * @data_pad: how many bytes at the end of logical eraseblocks of this volume
672  *            are not used (due to volume alignment)
673  * @compat: compatibility flags of this volume
674  * @rb: link in the volume RB-tree
676  *        volume (&struct ubi_ainf_peb objects)
678  * One object of this type is allocated for each volume when attaching an MTD
696  * @volumes: root of the volume RB-tree
710  * @highest_vol_id: highest volume ID
752  * @vol_id: the volume ID on which this erasure is being performed
1002  * ubi_move_aeb_to_list - move a PEB from the volume tree to a list.
1004  * @av: volume attaching information
1017  * ubi_zalloc_vid_hdr - allocate a volume identifier header object.
1022  * volume identifier header object in case of success and %NULL in case of
1042  * ubi_free_vid_hdr - free a volume identifier header object.
1095  * vol_id2idx - get table index by volume ID.
1097  * @vol_id: volume ID
1108  * idx2vol_id - get volume ID by table index.