scripts/dtc/util.h

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