1 #ifndef _UTIL_H
2 #define _UTIL_H
3
4 #include <stdarg.h>
5 #include <stdbool.h>
6 #include <getopt.h>
7
8 /*
9 * Copyright 2011 The Chromium Authors, All Rights Reserved.
10 * Copyright 2008 Jon Loeliger, Freescale Semiconductor, Inc.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License as
14 * published by the Free Software Foundation; either version 2 of the
15 * License, or (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
25 * USA
26 */
27
28 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
29
die(const char * str,...)30 static inline void __attribute__((noreturn)) die(const char *str, ...)
31 {
32 va_list ap;
33
34 va_start(ap, str);
35 fprintf(stderr, "FATAL ERROR: ");
36 vfprintf(stderr, str, ap);
37 exit(1);
38 }
39
xmalloc(size_t len)40 static inline void *xmalloc(size_t len)
41 {
42 void *new = malloc(len);
43
44 if (!new)
45 die("malloc() failed\n");
46
47 return new;
48 }
49
xrealloc(void * p,size_t len)50 static inline void *xrealloc(void *p, size_t len)
51 {
52 void *new = realloc(p, len);
53
54 if (!new)
55 die("realloc() failed (len=%d)\n", len);
56
57 return new;
58 }
59
60 extern char *xstrdup(const char *s);
61 extern char *join_path(const char *path, const char *name);
62
63 /**
64 * Check a property of a given length to see if it is all printable and
65 * has a valid terminator. The property can contain either a single string,
66 * or multiple strings each of non-zero length.
67 *
68 * @param data The string to check
69 * @param len The string length including terminator
70 * @return 1 if a valid printable string, 0 if not
71 */
72 bool util_is_printable_string(const void *data, int len);
73
74 /*
75 * Parse an escaped character starting at index i in string s. The resulting
76 * character will be returned and the index i will be updated to point at the
77 * character directly after the end of the encoding, this may be the '\0'
78 * terminator of the string.
79 */
80 char get_escape_char(const char *s, int *i);
81
82 /**
83 * Read a device tree file into a buffer. This will report any errors on
84 * stderr.
85 *
86 * @param filename The filename to read, or - for stdin
87 * @return Pointer to allocated buffer containing fdt, or NULL on error
88 */
89 char *utilfdt_read(const char *filename);
90
91 /**
92 * Like utilfdt_read(), but also passes back the size of the file read.
93 *
94 * @param len If non-NULL, the amount of data we managed to read
95 */
96 char *utilfdt_read_len(const char *filename, off_t *len);
97
98 /**
99 * Read a device tree file into a buffer. Does not report errors, but only
100 * returns them. The value returned can be passed to strerror() to obtain
101 * an error message for the user.
102 *
103 * @param filename The filename to read, or - for stdin
104 * @param buffp Returns pointer to buffer containing fdt
105 * @return 0 if ok, else an errno value representing the error
106 */
107 int utilfdt_read_err(const char *filename, char **buffp);
108
109 /**
110 * Like utilfdt_read_err(), but also passes back the size of the file read.
111 *
112 * @param len If non-NULL, the amount of data we managed to read
113 */
114 int utilfdt_read_err_len(const char *filename, char **buffp, off_t *len);
115
116 /**
117 * Write a device tree buffer to a file. This will report any errors on
118 * stderr.
119 *
120 * @param filename The filename to write, or - for stdout
121 * @param blob Poiner to buffer containing fdt
122 * @return 0 if ok, -1 on error
123 */
124 int utilfdt_write(const char *filename, const void *blob);
125
126 /**
127 * Write a device tree buffer to a file. Does not report errors, but only
128 * returns them. The value returned can be passed to strerror() to obtain
129 * an error message for the user.
130 *
131 * @param filename The filename to write, or - for stdout
132 * @param blob Poiner to buffer containing fdt
133 * @return 0 if ok, else an errno value representing the error
134 */
135 int utilfdt_write_err(const char *filename, const void *blob);
136
137 /**
138 * Decode a data type string. The purpose of this string
139 *
140 * The string consists of an optional character followed by the type:
141 * Modifier characters:
142 * hh or b 1 byte
143 * h 2 byte
144 * l 4 byte, default
145 *
146 * Type character:
147 * s string
148 * i signed integer
149 * u unsigned integer
150 * x hex
151 *
152 * TODO: Implement ll modifier (8 bytes)
153 * TODO: Implement o type (octal)
154 *
155 * @param fmt Format string to process
156 * @param type Returns type found(s/d/u/x), or 0 if none
157 * @param size Returns size found(1,2,4,8) or 4 if none
158 * @return 0 if ok, -1 on error (no type given, or other invalid format)
159 */
160 int utilfdt_decode_type(const char *fmt, int *type, int *size);
161
162 /*
163 * This is a usage message fragment for the -t option. It is the format
164 * supported by utilfdt_decode_type.
165 */
166
167 #define USAGE_TYPE_MSG \
168 "<type>\ts=string, i=int, u=unsigned, x=hex\n" \
169 "\tOptional modifier prefix:\n" \
170 "\t\thh or b=byte, h=2 byte, l=4 byte (default)";
171
172 /**
173 * Print property data in a readable format to stdout
174 *
175 * Properties that look like strings will be printed as strings. Otherwise
176 * the data will be displayed either as cells (if len is a multiple of 4
177 * bytes) or bytes.
178 *
179 * If len is 0 then this function does nothing.
180 *
181 * @param data Pointers to property data
182 * @param len Length of property data
183 */
184 void utilfdt_print_data(const char *data, int len);
185
186 /**
187 * Show source version and exit
188 */
189 void util_version(void) __attribute__((noreturn));
190
191 /**
192 * Show usage and exit
193 *
194 * This helps standardize the output of various utils. You most likely want
195 * to use the usage() helper below rather than call this.
196 *
197 * @param errmsg If non-NULL, an error message to display
198 * @param synopsis The initial example usage text (and possible examples)
199 * @param short_opts The string of short options
200 * @param long_opts The structure of long options
201 * @param opts_help An array of help strings (should align with long_opts)
202 */
203 void util_usage(const char *errmsg, const char *synopsis,
204 const char *short_opts, struct option const long_opts[],
205 const char * const opts_help[]) __attribute__((noreturn));
206
207 /**
208 * Show usage and exit
209 *
210 * If you name all your usage variables with usage_xxx, then you can call this
211 * help macro rather than expanding all arguments yourself.
212 *
213 * @param errmsg If non-NULL, an error message to display
214 */
215 #define usage(errmsg) \
216 util_usage(errmsg, usage_synopsis, usage_short_opts, \
217 usage_long_opts, usage_opts_help)
218
219 /**
220 * Call getopt_long() with standard options
221 *
222 * Since all util code runs getopt in the same way, provide a helper.
223 */
224 #define util_getopt_long() getopt_long(argc, argv, usage_short_opts, \
225 usage_long_opts, NULL)
226
227 /* Helper for aligning long_opts array */
228 #define a_argument required_argument
229
230 /* Helper for usage_short_opts string constant */
231 #define USAGE_COMMON_SHORT_OPTS "hV"
232
233 /* Helper for usage_long_opts option array */
234 #define USAGE_COMMON_LONG_OPTS \
235 {"help", no_argument, NULL, 'h'}, \
236 {"version", no_argument, NULL, 'V'}, \
237 {NULL, no_argument, NULL, 0x0}
238
239 /* Helper for usage_opts_help array */
240 #define USAGE_COMMON_OPTS_HELP \
241 "Print this help and exit", \
242 "Print version and exit", \
243 NULL
244
245 /* Helper for getopt case statements */
246 #define case_USAGE_COMMON_FLAGS \
247 case 'h': usage(NULL); \
248 case 'V': util_version(); \
249 case '?': usage("unknown option");
250
251 #endif /* _UTIL_H */
252