blob: fb124eea4919fbe7ce6c4bf84bddf419ebf03788 [file] [log] [blame]
John Bonesio658f29a2010-11-17 15:28:20 -08001/*
Stephen Warrencd296722012-09-28 21:25:59 +00002 * Copyright 2011 The Chromium Authors, All Rights Reserved.
John Bonesio658f29a2010-11-17 15:28:20 -08003 * Copyright 2008 Jon Loeliger, Freescale Semiconductor, Inc.
4 *
Stephen Warrencd296722012-09-28 21:25:59 +00005 * util_is_printable_string contributed by
6 * Pantelis Antoniou <pantelis.antoniou AT gmail.com>
7 *
John Bonesio658f29a2010-11-17 15:28:20 -08008 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of the
11 * License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21 * USA
22 */
23
Stephen Warrencd296722012-09-28 21:25:59 +000024#include <ctype.h>
John Bonesio658f29a2010-11-17 15:28:20 -080025#include <stdio.h>
26#include <stdlib.h>
27#include <stdarg.h>
28#include <string.h>
Stephen Warrencd296722012-09-28 21:25:59 +000029#include <assert.h>
John Bonesio658f29a2010-11-17 15:28:20 -080030
Stephen Warrencd296722012-09-28 21:25:59 +000031#include <errno.h>
32#include <fcntl.h>
33#include <unistd.h>
34
35#include "libfdt.h"
John Bonesio658f29a2010-11-17 15:28:20 -080036#include "util.h"
Grant Likely73ab39b2014-01-21 12:54:49 +000037#include "version_gen.h"
John Bonesio658f29a2010-11-17 15:28:20 -080038
39char *xstrdup(const char *s)
40{
41 int len = strlen(s) + 1;
Rob Herring47605972015-04-29 16:00:05 -050042 char *d = xmalloc(len);
John Bonesio658f29a2010-11-17 15:28:20 -080043
Rob Herring47605972015-04-29 16:00:05 -050044 memcpy(d, s, len);
John Bonesio658f29a2010-11-17 15:28:20 -080045
Rob Herring47605972015-04-29 16:00:05 -050046 return d;
John Bonesio658f29a2010-11-17 15:28:20 -080047}
48
49char *join_path(const char *path, const char *name)
50{
51 int lenp = strlen(path);
52 int lenn = strlen(name);
53 int len;
54 int needslash = 1;
55 char *str;
56
57 len = lenp + lenn + 2;
58 if ((lenp > 0) && (path[lenp-1] == '/')) {
59 needslash = 0;
60 len--;
61 }
62
63 str = xmalloc(len);
64 memcpy(str, path, lenp);
65 if (needslash) {
66 str[lenp] = '/';
67 lenp++;
68 }
69 memcpy(str+lenp, name, lenn+1);
70 return str;
71}
Stephen Warrencd296722012-09-28 21:25:59 +000072
Rob Herring47605972015-04-29 16:00:05 -050073bool util_is_printable_string(const void *data, int len)
Stephen Warrencd296722012-09-28 21:25:59 +000074{
75 const char *s = data;
Grant Likely73ab39b2014-01-21 12:54:49 +000076 const char *ss, *se;
Stephen Warrencd296722012-09-28 21:25:59 +000077
78 /* zero length is not */
79 if (len == 0)
80 return 0;
81
82 /* must terminate with zero */
83 if (s[len - 1] != '\0')
84 return 0;
85
Grant Likely73ab39b2014-01-21 12:54:49 +000086 se = s + len;
Stephen Warrencd296722012-09-28 21:25:59 +000087
Grant Likely73ab39b2014-01-21 12:54:49 +000088 while (s < se) {
89 ss = s;
Rob Herring47605972015-04-29 16:00:05 -050090 while (s < se && *s && isprint((unsigned char)*s))
Grant Likely73ab39b2014-01-21 12:54:49 +000091 s++;
92
93 /* not zero, or not done yet */
94 if (*s != '\0' || s == ss)
95 return 0;
96
97 s++;
98 }
Stephen Warrencd296722012-09-28 21:25:59 +000099
100 return 1;
101}
102
103/*
104 * Parse a octal encoded character starting at index i in string s. The
105 * resulting character will be returned and the index i will be updated to
106 * point at the character directly after the end of the encoding, this may be
107 * the '\0' terminator of the string.
108 */
109static char get_oct_char(const char *s, int *i)
110{
111 char x[4];
112 char *endx;
113 long val;
114
115 x[3] = '\0';
116 strncpy(x, s + *i, 3);
117
118 val = strtol(x, &endx, 8);
119
120 assert(endx > x);
121
122 (*i) += endx - x;
123 return val;
124}
125
126/*
127 * Parse a hexadecimal encoded character starting at index i in string s. The
128 * resulting character will be returned and the index i will be updated to
129 * point at the character directly after the end of the encoding, this may be
130 * the '\0' terminator of the string.
131 */
132static char get_hex_char(const char *s, int *i)
133{
134 char x[3];
135 char *endx;
136 long val;
137
138 x[2] = '\0';
139 strncpy(x, s + *i, 2);
140
141 val = strtol(x, &endx, 16);
142 if (!(endx > x))
143 die("\\x used with no following hex digits\n");
144
145 (*i) += endx - x;
146 return val;
147}
148
149char get_escape_char(const char *s, int *i)
150{
151 char c = s[*i];
152 int j = *i + 1;
153 char val;
154
Stephen Warrencd296722012-09-28 21:25:59 +0000155 switch (c) {
156 case 'a':
157 val = '\a';
158 break;
159 case 'b':
160 val = '\b';
161 break;
162 case 't':
163 val = '\t';
164 break;
165 case 'n':
166 val = '\n';
167 break;
168 case 'v':
169 val = '\v';
170 break;
171 case 'f':
172 val = '\f';
173 break;
174 case 'r':
175 val = '\r';
176 break;
177 case '0':
178 case '1':
179 case '2':
180 case '3':
181 case '4':
182 case '5':
183 case '6':
184 case '7':
185 j--; /* need to re-read the first digit as
186 * part of the octal value */
187 val = get_oct_char(s, &j);
188 break;
189 case 'x':
190 val = get_hex_char(s, &j);
191 break;
192 default:
193 val = c;
194 }
195
196 (*i) = j;
197 return val;
198}
199
Grant Likely73ab39b2014-01-21 12:54:49 +0000200int utilfdt_read_err_len(const char *filename, char **buffp, off_t *len)
Stephen Warrencd296722012-09-28 21:25:59 +0000201{
202 int fd = 0; /* assume stdin */
203 char *buf = NULL;
204 off_t bufsize = 1024, offset = 0;
205 int ret = 0;
206
207 *buffp = NULL;
208 if (strcmp(filename, "-") != 0) {
209 fd = open(filename, O_RDONLY);
210 if (fd < 0)
211 return errno;
212 }
213
214 /* Loop until we have read everything */
Grant Likely73ab39b2014-01-21 12:54:49 +0000215 buf = xmalloc(bufsize);
Stephen Warrencd296722012-09-28 21:25:59 +0000216 do {
217 /* Expand the buffer to hold the next chunk */
218 if (offset == bufsize) {
219 bufsize *= 2;
Grant Likely73ab39b2014-01-21 12:54:49 +0000220 buf = xrealloc(buf, bufsize);
Stephen Warrencd296722012-09-28 21:25:59 +0000221 }
222
223 ret = read(fd, &buf[offset], bufsize - offset);
224 if (ret < 0) {
225 ret = errno;
226 break;
227 }
228 offset += ret;
229 } while (ret != 0);
230
231 /* Clean up, including closing stdin; return errno on error */
232 close(fd);
233 if (ret)
234 free(buf);
235 else
236 *buffp = buf;
Grant Likely73ab39b2014-01-21 12:54:49 +0000237 *len = bufsize;
Stephen Warrencd296722012-09-28 21:25:59 +0000238 return ret;
239}
240
Grant Likely73ab39b2014-01-21 12:54:49 +0000241int utilfdt_read_err(const char *filename, char **buffp)
242{
243 off_t len;
244 return utilfdt_read_err_len(filename, buffp, &len);
245}
246
247char *utilfdt_read_len(const char *filename, off_t *len)
Stephen Warrencd296722012-09-28 21:25:59 +0000248{
249 char *buff;
Grant Likely73ab39b2014-01-21 12:54:49 +0000250 int ret = utilfdt_read_err_len(filename, &buff, len);
Stephen Warrencd296722012-09-28 21:25:59 +0000251
252 if (ret) {
253 fprintf(stderr, "Couldn't open blob from '%s': %s\n", filename,
254 strerror(ret));
255 return NULL;
256 }
257 /* Successful read */
258 return buff;
259}
260
Grant Likely73ab39b2014-01-21 12:54:49 +0000261char *utilfdt_read(const char *filename)
262{
263 off_t len;
264 return utilfdt_read_len(filename, &len);
265}
266
Stephen Warrencd296722012-09-28 21:25:59 +0000267int utilfdt_write_err(const char *filename, const void *blob)
268{
269 int fd = 1; /* assume stdout */
270 int totalsize;
271 int offset;
272 int ret = 0;
273 const char *ptr = blob;
274
275 if (strcmp(filename, "-") != 0) {
276 fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, 0666);
277 if (fd < 0)
278 return errno;
279 }
280
281 totalsize = fdt_totalsize(blob);
282 offset = 0;
283
284 while (offset < totalsize) {
285 ret = write(fd, ptr + offset, totalsize - offset);
286 if (ret < 0) {
287 ret = -errno;
288 break;
289 }
290 offset += ret;
291 }
292 /* Close the file/stdin; return errno on error */
293 if (fd != 1)
294 close(fd);
295 return ret < 0 ? -ret : 0;
296}
297
298
299int utilfdt_write(const char *filename, const void *blob)
300{
301 int ret = utilfdt_write_err(filename, blob);
302
303 if (ret) {
304 fprintf(stderr, "Couldn't write blob to '%s': %s\n", filename,
305 strerror(ret));
306 }
307 return ret ? -1 : 0;
308}
309
310int utilfdt_decode_type(const char *fmt, int *type, int *size)
311{
312 int qualifier = 0;
313
314 if (!*fmt)
315 return -1;
316
317 /* get the conversion qualifier */
318 *size = -1;
319 if (strchr("hlLb", *fmt)) {
320 qualifier = *fmt++;
321 if (qualifier == *fmt) {
322 switch (*fmt++) {
323/* TODO: case 'l': qualifier = 'L'; break;*/
324 case 'h':
325 qualifier = 'b';
326 break;
327 }
328 }
329 }
330
331 /* we should now have a type */
332 if ((*fmt == '\0') || !strchr("iuxs", *fmt))
333 return -1;
334
335 /* convert qualifier (bhL) to byte size */
336 if (*fmt != 's')
337 *size = qualifier == 'b' ? 1 :
338 qualifier == 'h' ? 2 :
339 qualifier == 'l' ? 4 : -1;
340 *type = *fmt++;
341
342 /* that should be it! */
343 if (*fmt)
344 return -1;
345 return 0;
346}
Grant Likely73ab39b2014-01-21 12:54:49 +0000347
348void utilfdt_print_data(const char *data, int len)
349{
350 int i;
Grant Likely73ab39b2014-01-21 12:54:49 +0000351 const char *s;
352
353 /* no data, don't print */
354 if (len == 0)
355 return;
356
357 if (util_is_printable_string(data, len)) {
358 printf(" = ");
359
360 s = data;
361 do {
362 printf("\"%s\"", s);
363 s += strlen(s) + 1;
364 if (s < data + len)
365 printf(", ");
366 } while (s < data + len);
367
368 } else if ((len % 4) == 0) {
369 const uint32_t *cell = (const uint32_t *)data;
370
371 printf(" = <");
Rob Herring47605972015-04-29 16:00:05 -0500372 for (i = 0, len /= 4; i < len; i++)
Grant Likely73ab39b2014-01-21 12:54:49 +0000373 printf("0x%08x%s", fdt32_to_cpu(cell[i]),
Rob Herring47605972015-04-29 16:00:05 -0500374 i < (len - 1) ? " " : "");
Grant Likely73ab39b2014-01-21 12:54:49 +0000375 printf(">");
376 } else {
Rob Herring91feabc2016-01-26 09:04:11 -0600377 const unsigned char *p = (const unsigned char *)data;
Grant Likely73ab39b2014-01-21 12:54:49 +0000378 printf(" = [");
379 for (i = 0; i < len; i++)
380 printf("%02x%s", *p++, i < len - 1 ? " " : "");
381 printf("]");
382 }
383}
384
385void util_version(void)
386{
387 printf("Version: %s\n", DTC_VERSION);
388 exit(0);
389}
390
391void util_usage(const char *errmsg, const char *synopsis,
392 const char *short_opts, struct option const long_opts[],
393 const char * const opts_help[])
394{
395 FILE *fp = errmsg ? stderr : stdout;
396 const char a_arg[] = "<arg>";
397 size_t a_arg_len = strlen(a_arg) + 1;
398 size_t i;
399 int optlen;
400
401 fprintf(fp,
402 "Usage: %s\n"
403 "\n"
404 "Options: -[%s]\n", synopsis, short_opts);
405
406 /* prescan the --long opt length to auto-align */
407 optlen = 0;
408 for (i = 0; long_opts[i].name; ++i) {
409 /* +1 is for space between --opt and help text */
410 int l = strlen(long_opts[i].name) + 1;
411 if (long_opts[i].has_arg == a_argument)
412 l += a_arg_len;
413 if (optlen < l)
414 optlen = l;
415 }
416
417 for (i = 0; long_opts[i].name; ++i) {
418 /* helps when adding new applets or options */
419 assert(opts_help[i] != NULL);
420
421 /* first output the short flag if it has one */
422 if (long_opts[i].val > '~')
423 fprintf(fp, " ");
424 else
425 fprintf(fp, " -%c, ", long_opts[i].val);
426
427 /* then the long flag */
428 if (long_opts[i].has_arg == no_argument)
429 fprintf(fp, "--%-*s", optlen, long_opts[i].name);
430 else
431 fprintf(fp, "--%s %s%*s", long_opts[i].name, a_arg,
432 (int)(optlen - strlen(long_opts[i].name) - a_arg_len), "");
433
434 /* finally the help text */
435 fprintf(fp, "%s\n", opts_help[i]);
436 }
437
438 if (errmsg) {
439 fprintf(fp, "\nError: %s\n", errmsg);
440 exit(EXIT_FAILURE);
441 } else
442 exit(EXIT_SUCCESS);
443}