libfdt/fdt_rw.c

   1 /*
   2  * libfdt - Flat Device Tree manipulation
   3  * Copyright (C) 2006 David Gibson, IBM Corporation.
   4  *
   5  * libfdt is dual licensed: you can use it either under the terms of
   6  * the GPL, or the BSD license, at your option.
   7  *
   8  *  a) This library 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 library 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
  16  *     GNU General Public License for more details.
  17  *
  18  *     You should have received a copy of the GNU General Public
  19  *     License along with this library; if not, write to the Free
  20  *     Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
  21  *     MA 02110-1301 USA
  22  *
  23  * Alternatively,
  24  *
  25  *  b) Redistribution and use in source and binary forms, with or
  26  *     without modification, are permitted provided that the following
  27  *     conditions are met:
  28  *
  29  *     1. Redistributions of source code must retain the above
  30  *        copyright notice, this list of conditions and the following
  31  *        disclaimer.
  32  *     2. Redistributions in binary form must reproduce the above
  33  *        copyright notice, this list of conditions and the following
  34  *        disclaimer in the documentation and/or other materials
  35  *        provided with the distribution.
  36  *
  37  *     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  38  *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  39  *     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  40  *     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  41  *     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  42  *     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43  *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44  *     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45  *     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46  *     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  47  *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  48  *     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  49  *     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  50  */
  51 #include "libfdt_env.h"
  52
  53 #ifndef USE_HOSTCC
  54 #include <fdt.h>
  55 #include <libfdt.h>
  56 #else
  57 #include "fdt_host.h"
  58 #endif
  59
  60 #include "libfdt_internal.h"
  61
  62 static int _blocks_misordered(const void *fdt,
  63                               int mem_rsv_size, int struct_size)
  64 {
  65         return (fdt_off_mem_rsvmap(fdt) < ALIGN(sizeof(struct fdt_header), 8))
  66                 || (fdt_off_dt_struct(fdt) <
  67                     (fdt_off_mem_rsvmap(fdt) + mem_rsv_size))
  68                 || (fdt_off_dt_strings(fdt) <
  69                     (fdt_off_dt_struct(fdt) + struct_size))
  70                 || (fdt_totalsize(fdt) <
  71                     (fdt_off_dt_strings(fdt) + fdt_size_dt_strings(fdt)));
  72 }
  73
  74 static int rw_check_header(void *fdt)
  75 {
  76         CHECK_HEADER(fdt);
  77
  78         if (fdt_version(fdt) < 17)
  79                 return -FDT_ERR_BADVERSION;
  80         if (_blocks_misordered(fdt, sizeof(struct fdt_reserve_entry),
  81                                fdt_size_dt_struct(fdt)))
  82                 return -FDT_ERR_BADLAYOUT;
  83         if (fdt_version(fdt) > 17)
  84                 fdt_set_version(fdt, 17);
  85
  86         return 0;
  87 }
  88
  89 #define RW_CHECK_HEADER(fdt) \
  90         { \
  91                 int err; \
  92                 if ((err = rw_check_header(fdt)) != 0) \
  93                         return err; \
  94         }
  95
  96 static inline int _blob_data_size(void *fdt)
  97 {
  98         return fdt_off_dt_strings(fdt) + fdt_size_dt_strings(fdt);
  99 }
 100
 101 static int _blob_splice(void *fdt, void *p, int oldlen, int newlen)
 102 {
 103         void *end = fdt + _blob_data_size(fdt);
 104
 105         if (((p + oldlen) < p) || ((p + oldlen) > end))
 106                 return -FDT_ERR_BADOFFSET;
 107         if ((end - oldlen + newlen) > (fdt + fdt_totalsize(fdt)))
 108                 return -FDT_ERR_NOSPACE;
 109         memmove(p + newlen, p + oldlen, end - p - oldlen);
 110         return 0;
 111 }
 112
 113 static int _blob_splice_mem_rsv(void *fdt, struct fdt_reserve_entry *p,
 114                                 int oldn, int newn)
 115 {
 116         int delta = (newn - oldn) * sizeof(*p);
 117         int err;
 118         err = _blob_splice(fdt, p, oldn * sizeof(*p), newn * sizeof(*p));
 119         if (err)
 120                 return err;
 121         fdt_set_off_dt_struct(fdt, fdt_off_dt_struct(fdt) + delta);
 122         fdt_set_off_dt_strings(fdt, fdt_off_dt_strings(fdt) + delta);
 123         return 0;
 124 }
 125
 126 static int _blob_splice_struct(void *fdt, void *p,
 127                                int oldlen, int newlen)
 128 {
 129         int delta = newlen - oldlen;
 130         int err;
 131
 132         if ((err = _blob_splice(fdt, p, oldlen, newlen)))
 133                 return err;
 134
 135         fdt_set_size_dt_struct(fdt, fdt_size_dt_struct(fdt) + delta);
 136         fdt_set_off_dt_strings(fdt, fdt_off_dt_strings(fdt) + delta);
 137         return 0;
 138 }
 139
 140 static int _blob_splice_string(void *fdt, int newlen)
 141 {
 142         void *p = fdt + fdt_off_dt_strings(fdt) + fdt_size_dt_strings(fdt);
 143         int err;
 144
 145         if ((err = _blob_splice(fdt, p, 0, newlen)))
 146                 return err;
 147
 148         fdt_set_size_dt_strings(fdt, fdt_size_dt_strings(fdt) + newlen);
 149         return 0;
 150 }
 151
 152 static int _find_add_string(void *fdt, const char *s)
 153 {
 154         char *strtab = (char *)fdt + fdt_off_dt_strings(fdt);
 155         const char *p;
 156         char *new;
 157         int len = strlen(s) + 1;
 158         int err;
 159
 160         p = _fdt_find_string(strtab, fdt_size_dt_strings(fdt), s);
 161         if (p)
 162                 /* found it */
 163                 return (p - strtab);
 164
 165         new = strtab + fdt_size_dt_strings(fdt);
 166         err = _blob_splice_string(fdt, len);
 167         if (err)
 168                 return err;
 169
 170         memcpy(new, s, len);
 171         return (new - strtab);
 172 }
 173
 174 int fdt_add_mem_rsv(void *fdt, uint64_t address, uint64_t size)
 175 {
 176         struct fdt_reserve_entry *re;
 177         int err;
 178
 179         RW_CHECK_HEADER(fdt);
 180
 181         re = _fdt_mem_rsv_w(fdt, fdt_num_mem_rsv(fdt));
 182         err = _blob_splice_mem_rsv(fdt, re, 0, 1);
 183         if (err)
 184                 return err;
 185
 186         re->address = cpu_to_fdt64(address);
 187         re->size = cpu_to_fdt64(size);
 188         return 0;
 189 }
 190
 191 int fdt_del_mem_rsv(void *fdt, int n)
 192 {
 193         struct fdt_reserve_entry *re = _fdt_mem_rsv_w(fdt, n);
 194         int err;
 195
 196         RW_CHECK_HEADER(fdt);
 197
 198         if (n >= fdt_num_mem_rsv(fdt))
 199                 return -FDT_ERR_NOTFOUND;
 200
 201         err = _blob_splice_mem_rsv(fdt, re, 1, 0);
 202         if (err)
 203                 return err;
 204         return 0;
 205 }
 206
 207 static int _resize_property(void *fdt, int nodeoffset, const char *name, int len,
 208                             struct fdt_property **prop)
 209 {
 210         int oldlen;
 211         int err;
 212
 213         *prop = fdt_get_property_w(fdt, nodeoffset, name, &oldlen);
 214         if (! (*prop))
 215                 return oldlen;
 216
 217         if ((err = _blob_splice_struct(fdt, (*prop)->data,
 218                                        ALIGN(oldlen, FDT_TAGSIZE),
 219                                        ALIGN(len, FDT_TAGSIZE))))
 220                 return err;
 221
 222         (*prop)->len = cpu_to_fdt32(len);
 223         return 0;
 224 }
 225
 226 static int _add_property(void *fdt, int nodeoffset, const char *name, int len,
 227                          struct fdt_property **prop)
 228 {
 229         int proplen;
 230         int nextoffset;
 231         int namestroff;
 232         int err;
 233
 234         if ((nextoffset = _fdt_check_node_offset(fdt, nodeoffset)) < 0)
 235                 return nextoffset;
 236
 237         namestroff = _find_add_string(fdt, name);
 238         if (namestroff < 0)
 239                 return namestroff;
 240
 241         *prop = _fdt_offset_ptr_w(fdt, nextoffset);
 242         proplen = sizeof(**prop) + ALIGN(len, FDT_TAGSIZE);
 243
 244         err = _blob_splice_struct(fdt, *prop, 0, proplen);
 245         if (err)
 246                 return err;
 247
 248         (*prop)->tag = cpu_to_fdt32(FDT_PROP);
 249         (*prop)->nameoff = cpu_to_fdt32(namestroff);
 250         (*prop)->len = cpu_to_fdt32(len);
 251         return 0;
 252 }
 253
 254 int fdt_set_name(void *fdt, int nodeoffset, const char *name)
 255 {
 256         char *namep;
 257         int oldlen, newlen;
 258         int err;
 259
 260         RW_CHECK_HEADER(fdt);
 261
 262         namep = (char *)fdt_get_name(fdt, nodeoffset, &oldlen);
 263         if (!namep)
 264                 return oldlen;
 265
 266         newlen = strlen(name);
 267
 268         err = _blob_splice_struct(fdt, namep, ALIGN(oldlen+1, FDT_TAGSIZE),
 269                                   ALIGN(newlen+1, FDT_TAGSIZE));
 270         if (err)
 271                 return err;
 272
 273         memcpy(namep, name, newlen+1);
 274         return 0;
 275 }
 276
 277 int fdt_setprop(void *fdt, int nodeoffset, const char *name,
 278                 const void *val, int len)
 279 {
 280         struct fdt_property *prop;
 281         int err;
 282
 283         RW_CHECK_HEADER(fdt);
 284
 285         err = _resize_property(fdt, nodeoffset, name, len, &prop);
 286         if (err == -FDT_ERR_NOTFOUND)
 287                 err = _add_property(fdt, nodeoffset, name, len, &prop);
 288         if (err)
 289                 return err;
 290
 291         memcpy(prop->data, val, len);
 292         return 0;
 293 }
 294
 295 int fdt_delprop(void *fdt, int nodeoffset, const char *name)
 296 {
 297         struct fdt_property *prop;
 298         int len, proplen;
 299
 300         RW_CHECK_HEADER(fdt);
 301
 302         prop = fdt_get_property_w(fdt, nodeoffset, name, &len);
 303         if (! prop)
 304                 return len;
 305
 306         proplen = sizeof(*prop) + ALIGN(len, FDT_TAGSIZE);
 307         return _blob_splice_struct(fdt, prop, proplen, 0);
 308 }
 309
 310 int fdt_add_subnode_namelen(void *fdt, int parentoffset,
 311                             const char *name, int namelen)
 312 {
 313         struct fdt_node_header *nh;
 314         int offset, nextoffset;
 315         int nodelen;
 316         int err;
 317         uint32_t tag;
 318         uint32_t *endtag;
 319
 320         RW_CHECK_HEADER(fdt);
 321
 322         offset = fdt_subnode_offset_namelen(fdt, parentoffset, name, namelen);
 323         if (offset >= 0)
 324                 return -FDT_ERR_EXISTS;
 325         else if (offset != -FDT_ERR_NOTFOUND)
 326                 return offset;
 327
 328         /* Try to place the new node after the parent's properties */
 329         fdt_next_tag(fdt, parentoffset, &nextoffset); /* skip the BEGIN_NODE */
 330         do {
 331                 offset = nextoffset;
 332                 tag = fdt_next_tag(fdt, offset, &nextoffset);
 333         } while ((tag == FDT_PROP) || (tag == FDT_NOP));
 334
 335         nh = _fdt_offset_ptr_w(fdt, offset);
 336         nodelen = sizeof(*nh) + ALIGN(namelen+1, FDT_TAGSIZE) + FDT_TAGSIZE;
 337
 338         err = _blob_splice_struct(fdt, nh, 0, nodelen);
 339         if (err)
 340                 return err;
 341
 342         nh->tag = cpu_to_fdt32(FDT_BEGIN_NODE);
 343         memset(nh->name, 0, ALIGN(namelen+1, FDT_TAGSIZE));
 344         memcpy(nh->name, name, namelen);
 345         endtag = (uint32_t *)((void *)nh + nodelen - FDT_TAGSIZE);
 346         *endtag = cpu_to_fdt32(FDT_END_NODE);
 347
 348         return offset;
 349 }
 350
 351 int fdt_add_subnode(void *fdt, int parentoffset, const char *name)
 352 {
 353         return fdt_add_subnode_namelen(fdt, parentoffset, name, strlen(name));
 354 }
 355
 356 int fdt_del_node(void *fdt, int nodeoffset)
 357 {
 358         int endoffset;
 359
 360         RW_CHECK_HEADER(fdt);
 361
 362         endoffset = _fdt_node_end_offset(fdt, nodeoffset);
 363         if (endoffset < 0)
 364                 return endoffset;
 365
 366         return _blob_splice_struct(fdt, _fdt_offset_ptr_w(fdt, nodeoffset),
 367                                    endoffset - nodeoffset, 0);
 368 }
 369
 370 static void _packblocks(const void *fdt, void *buf,
 371                        int mem_rsv_size, int struct_size)
 372 {
 373         int mem_rsv_off, struct_off, strings_off;
 374
 375         mem_rsv_off = ALIGN(sizeof(struct fdt_header), 8);
 376         struct_off = mem_rsv_off + mem_rsv_size;
 377         strings_off = struct_off + struct_size;
 378
 379         memmove(buf + mem_rsv_off, fdt + fdt_off_mem_rsvmap(fdt), mem_rsv_size);
 380         fdt_set_off_mem_rsvmap(buf, mem_rsv_off);
 381
 382         memmove(buf + struct_off, fdt + fdt_off_dt_struct(fdt), struct_size);
 383         fdt_set_off_dt_struct(buf, struct_off);
 384         fdt_set_size_dt_struct(buf, struct_size);
 385
 386         memmove(buf + strings_off, fdt + fdt_off_dt_strings(fdt),
 387                 fdt_size_dt_strings(fdt));
 388         fdt_set_off_dt_strings(buf, strings_off);
 389         fdt_set_size_dt_strings(buf, fdt_size_dt_strings(fdt));
 390 }
 391
 392 int fdt_open_into(const void *fdt, void *buf, int bufsize)
 393 {
 394         int err;
 395         int mem_rsv_size, struct_size;
 396         int newsize;
 397         void *tmp;
 398
 399         CHECK_HEADER(fdt);
 400
 401         mem_rsv_size = (fdt_num_mem_rsv(fdt)+1)
 402                 * sizeof(struct fdt_reserve_entry);
 403
 404         if (fdt_version(fdt) >= 17) {
 405                 struct_size = fdt_size_dt_struct(fdt);
 406         } else {
 407                 struct_size = 0;
 408                 while (fdt_next_tag(fdt, struct_size, &struct_size) != FDT_END)
 409                         ;
 410         }
 411
 412         if (!_blocks_misordered(fdt, mem_rsv_size, struct_size)) {
 413                 /* no further work necessary */
 414                 err = fdt_move(fdt, buf, bufsize);
 415                 if (err)
 416                         return err;
 417                 fdt_set_version(buf, 17);
 418                 fdt_set_size_dt_struct(buf, struct_size);
 419                 fdt_set_totalsize(buf, bufsize);
 420                 return 0;
 421         }
 422
 423         /* Need to reorder */
 424         newsize = ALIGN(sizeof(struct fdt_header), 8) + mem_rsv_size
 425                 + struct_size + fdt_size_dt_strings(fdt);
 426
 427         if (bufsize < newsize)
 428                 return -FDT_ERR_NOSPACE;
 429
 430         if (((buf + newsize) <= fdt)
 431             || (buf >= (fdt + fdt_totalsize(fdt)))) {
 432                 tmp = buf;
 433         } else {
 434                 tmp = (void *)fdt + fdt_totalsize(fdt);
 435                 if ((tmp + newsize) > (buf + bufsize))
 436                         return -FDT_ERR_NOSPACE;
 437         }
 438
 439         _packblocks(fdt, tmp, mem_rsv_size, struct_size);
 440         memmove(buf, tmp, newsize);
 441
 442         fdt_set_magic(buf, FDT_MAGIC);
 443         fdt_set_totalsize(buf, bufsize);
 444         fdt_set_version(buf, 17);
 445         fdt_set_last_comp_version(buf, 16);
 446         fdt_set_boot_cpuid_phys(buf, fdt_boot_cpuid_phys(fdt));
 447
 448         return 0;
 449 }
 450
 451 int fdt_pack(void *fdt)
 452 {
 453         int mem_rsv_size;
 454
 455         RW_CHECK_HEADER(fdt);
 456
 457         mem_rsv_size = (fdt_num_mem_rsv(fdt)+1)
 458                 * sizeof(struct fdt_reserve_entry);
 459         _packblocks(fdt, fdt, mem_rsv_size, fdt_size_dt_struct(fdt));
 460         fdt_set_totalsize(fdt, _blob_data_size(fdt));
 461
 462         return 0;
 463 }