mtd/ubi/ubi.h

28 #include <linux/mtd/ubi.h>
31 #include "ubi-media.h"
37 #define UBI_NAME_STR "ubi"
43 void ubi_msg(const struct ubi_device *ubi, const char *fmt, ...);
47 void ubi_warn(const struct ubi_device *ubi, const char *fmt, ...);
51 void ubi_err(const struct ubi_device *ubi, const char *fmt, ...);
79  * The UBI debugfs directory name pattern and maximum name length (3 for "ubi"
82 #define UBI_DFS_DIR_NAME "ubi%d"
190  * &struct ubi_ltree_entry object is inserted to the lock tree (@ubi->ltree).
278  * @ubi: reference to the UBI device description object
333 	struct ubi_device *ubi;
803 	int (*func)(struct ubi_device *ubi, struct ubi_work *wrk, int shutdown);
825 int ubi_add_to_av(struct ubi_device *ubi, struct ubi_attach_info *ai, int pnum,
831 struct ubi_ainf_peb *ubi_early_get_peb(struct ubi_device *ubi,
833 int ubi_attach(struct ubi_device *ubi, int force_scan);
837 int ubi_change_vtbl_record(struct ubi_device *ubi, int idx,
839 int ubi_vtbl_rename_volumes(struct ubi_device *ubi,
841 int ubi_read_volume_table(struct ubi_device *ubi, struct ubi_attach_info *ai);
844 int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req);
847 int ubi_rename_volumes(struct ubi_device *ubi, struct list_head *rename_list);
848 int ubi_add_volume(struct ubi_device *ubi, struct ubi_volume *vol);
849 void ubi_free_volume(struct ubi_device *ubi, struct ubi_volume *vol);
852 int ubi_start_update(struct ubi_device *ubi, struct ubi_volume *vol,
854 int ubi_more_update_data(struct ubi_device *ubi, struct ubi_volume *vol,
856 int ubi_start_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
858 int ubi_more_leb_change_data(struct ubi_device *ubi, struct ubi_volume *vol,
862 int ubi_calc_data_len(const struct ubi_device *ubi, const void *buf,
864 int ubi_check_volume(struct ubi_device *ubi, int vol_id);
865 void ubi_update_reserved(struct ubi_device *ubi);
866 void ubi_calculate_reserved(struct ubi_device *ubi);
884 int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol,
886 int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
888 int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol,
891 int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
893 int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
895 int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
897 int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
899 int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai);
900 unsigned long long ubi_next_sqnum(struct ubi_device *ubi);
901 int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
905 int ubi_sync_erase(struct ubi_device *ubi, struct ubi_wl_entry *e, int torture);
906 int ubi_wl_get_peb(struct ubi_device *ubi);
907 int ubi_wl_put_peb(struct ubi_device *ubi, int vol_id, int lnum,
909 int ubi_wl_flush(struct ubi_device *ubi, int vol_id, int lnum);
910 int ubi_wl_scrub_peb(struct ubi_device *ubi, int pnum);
911 int ubi_wl_init(struct ubi_device *ubi, struct ubi_attach_info *ai);
912 void ubi_wl_close(struct ubi_device *ubi);
914 struct ubi_wl_entry *ubi_wl_get_fm_peb(struct ubi_device *ubi, int anchor);
915 int ubi_wl_put_fm_peb(struct ubi_device *ubi, struct ubi_wl_entry *used_e,
918 void ubi_refill_pools_and_lock(struct ubi_device *ubi);
919 int ubi_ensure_anchor_pebs(struct ubi_device *ubi);
920 int ubi_bitflip_check(struct ubi_device *ubi, int pnum, int force_scrub);
923 int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset,
925 int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset,
927 int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture);
928 int ubi_io_is_bad(const struct ubi_device *ubi, int pnum);
929 int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum);
930 int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum,
932 int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum,
934 int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum,
936 int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum,
945 void ubi_put_device(struct ubi_device *ubi);
948 int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol,
950 int ubi_notify_all(struct ubi_device *ubi, int ntype,
953 void ubi_free_all_volumes(struct ubi_device *ubi);
954 void ubi_free_internal_volumes(struct ubi_device *ubi);
957 void ubi_do_get_device_info(struct ubi_device *ubi, struct ubi_device_info *di);
958 void ubi_do_get_volume_info(struct ubi_device *ubi, struct ubi_volume *vol,
962 int ubi_compare_lebs(struct ubi_device *ubi, const struct ubi_ainf_peb *aeb,
967 size_t ubi_calc_fm_size(struct ubi_device *ubi);
968 int ubi_update_fastmap(struct ubi_device *ubi);
969 int ubi_scan_fastmap(struct ubi_device *ubi, struct ubi_attach_info *ai,
974 static inline int ubi_update_fastmap(struct ubi_device *ubi) { return 0; }
1000  * @ubi: UBI device description object
1004 #define ubi_for_each_free_peb(ubi, e, tmp_rb)	\
1005 	ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->free, u.rb)
1009  * @ubi: UBI device description object
1013 #define ubi_for_each_used_peb(ubi, e, tmp_rb)	\
1014 	ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->used, u.rb)
1018  * @ubi: UBI device description object
1022 #define ubi_for_each_scrub_peb(ubi, e, tmp_rb)	\
1023 	ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->scrub, u.rb)
1027  * @ubi: UBI device description object
1031 #define ubi_for_each_protected_peb(ubi, i, e)	\
1033 		list_for_each_entry((e), &(ubi->pq[(i)]), u.list)
1066  * @ubi: the UBI device
1070 static inline void ubi_init_vid_buf(const struct ubi_device *ubi,
1075 		memset(buf, 0, ubi->vid_hdr_alsize);
1078 	vidb->hdr = buf + ubi->vid_hdr_shift;
1083  * @ubi: the UBI device
1087 ubi_alloc_vid_buf(const struct ubi_device *ubi, gfp_t gfp_flags)
1096 	buf = kmalloc(ubi->vid_hdr_alsize, gfp_flags);
1102 	ubi_init_vid_buf(ubi, vidb, buf);
1131  * @ubi: UBI device description object
1133 static inline void ubi_ro_mode(struct ubi_device *ubi)
1135 	if (!ubi->ro_mode) {
1136 		ubi->ro_mode = 1;
1137 		ubi_warn(ubi, "switch to read-only mode");
1147 static inline int ubi_io_read_data(const struct ubi_device *ubi, void *buf,
1151 	return ubi_io_read(ubi, buf, pnum, offset + ubi->leb_start, len);
1159 static inline int ubi_io_write_data(struct ubi_device *ubi, const void *buf,
1164 	if (ubi_dbg_power_cut(ubi, MASK_POWER_CUT_DATA)) {
1165 		ubi_warn(ubi, "XXXXX emulating a power cut when writing data XXXXX");
1166 		ubi_ro_mode(ubi);
1169 	return ubi_io_write(ubi, buf, pnum, offset + ubi->leb_start, len);
1174  * @ubi: UBI device description object
1177 static inline int vol_id2idx(const struct ubi_device *ubi, int vol_id)
1180 		return vol_id - UBI_INTERNAL_VOL_START + ubi->vtbl_slots;
1187  * @ubi: UBI device description object
1190 static inline int idx2vol_id(const struct ubi_device *ubi, int idx)
1192 	if (idx >= ubi->vtbl_slots)
1193 		return idx - ubi->vtbl_slots + UBI_INTERNAL_VOL_START;
1215  * @ubi: UBI device description object
1221 static inline struct ubi_wl_entry *ubi_find_fm_block(const struct ubi_device *ubi,
1226 	if (ubi->fm) {
1227 		for (i = 0; i < ubi->fm->used_blocks; i++) {
1228 			if (ubi->fm->e[i]->pnum == pnum)
1229 				return ubi->fm->e[i];