aboutsummaryrefslogtreecommitdiff
path: root/ubi-utils/src/libubiold_int.h
blob: 830a6823242568b14becbc365e64e4c0f0fba150 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/*
 * Copyright (c) International Business Machines Corp., 2006
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
 * the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/*
 * UBI (Unsorted Block Images) library.
 *
 * Author: Artem B. Bityutskiy
 */

#ifndef __UBI_INT_H__
#define __UBI_INT_H__
/*
 * Enable/disable UBI library debugging messages.
 */
#undef UBILIB_DEBUG

/*
 * UBI library error message.
 */
#define ubi_err(fmt, ...) do {						\
		fprintf(stderr, "UBI Library Error at %s: ", __func__); \
		fprintf(stderr, fmt, ##__VA_ARGS__);			\
		fprintf(stderr, "\n");					\
	} while (0)

#ifdef UBILIB_DEBUG
#define ubi_dbg(fmt, ...) do {						\
		fprintf(stderr, "UBI Debug: %s: ", __func__);		\
		fprintf(stderr, fmt, ##__VA_ARGS__);			\
		fprintf(stderr, "\n");					\
	} while (0)

#else
#define ubi_dbg(fmt, ...) do { } while (0)
#endif

/**
 * SYSFS Entries.
 *
 * @def UBI_ROOT
 *	@brief Name of the root UBI directory in sysfs.
 *
 * @def UBI_NLEN_MAX
 *	@brief Name of syfs file containing the maximum UBI volume name length.
 *
 * @def UBI_VER
 *      @brief Name of sysfs file containing UBI version.
 *
 * @def UBI_WEAR
 *	@brief Name of sysfs file containing wear level of an UBI device.
 *
 * @def UBI_VOL_COUNT
 *	@brief Name of sysfs file contaning the of volume on an UBI device
 *
 * @def UBI_TOT_EBS
 *	@brief Name of sysfs file contaning the total number of
 *	eraseblocks on an UBI device.
 *
 * @def UBI_AVAIL_EBS
 *	@brief Name of sysfs file contaning the number of unused eraseblocks on
 *	an UBI device.
 *
 * @def UBI_EB_SIZE
 *	@brief Name of sysfs file containing size of UBI eraseblocks.
 *
 * @def UBI_NUMS
 *      @brief Name of sysfs file containing major and minor numbers
 *      of an UBI device or an UBI volume device.
 *
 * @def UBI_VBYTES
 *	@brief Name of sysfs file containing size of an UBI volume device in
 *	bytes.
 *
 * @def UBI_VEBS
 *	@brief Name of sysfs file containing size of an UBI volume device in
 *	eraseblocks.
 *
 * @def UBI_VTYPE
 *	@brief Name of sysfs file containing type of an UBI volume device.
 *
 * @def UBI_VNAME
 *	@brief Name of sysfs file containing name of an UBI volume device.
 **/
#define UBI_ROOT	"ubi"
#define UBI_NLEN_MAX	"volume_name_max"
#define UBI_VER		"version"
#define UBI_WEAR	"wear"
#define UBI_VOL_COUNT	"volumes_count"
#define UBI_TOT_EBS	"total_eraseblocks"
#define UBI_AVAIL_EBS	"avail_eraseblocks"
#define UBI_EB_SIZE	"eraseblock_size"
#define UBI_NUMS	"dev"
#define UBI_VBYTES	"bytes"
#define UBI_VEBS	"eraseblocks"
#define UBI_VTYPE	"type"
#define UBI_VNAME	"name"

#define UBI_CDEV_PATH	"/dev/ubi%d"
#define UBI_VOL_CDEV_PATH "/dev/ubi%d_%d"
#define UBI_SYSFS_ROOT	"/sys/class"

#define UBI_MAX_ID_SIZE	9

#endif /* !__UBI_INT_H__ */