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 *splicepoint, int oldlen, int newlen)
 102 {
 103         char *p = splicepoint;
 104         char *end = (char *)fdt + _blob_data_size(fdt);
 105
 106         if (((p + oldlen) < p) || ((p + oldlen) > end))
 107                 return -FDT_ERR_BADOFFSET;
 108         if ((end - oldlen + newlen) > ((char *)fdt + fdt_totalsize(fdt)))
 109                 return -FDT_ERR_NOSPACE;
 110         memmove(p + newlen, p + oldlen, end - p - oldlen);
 111         return 0;
 112 }
 113
 114 static int _blob_splice_mem_rsv(void *fdt, struct fdt_reserve_entry *p,
 115                                 int oldn, int newn)
 116 {
 117         int delta = (newn - oldn) * sizeof(*p);
 118         int err;
 119         err = _blob_splice(fdt, p, oldn * sizeof(*p), newn * sizeof(*p));
 120         if (err)
 121                 return err;
 122         fdt_set_off_dt_struct(fdt, fdt_off_dt_struct(fdt) + delta);
 123         fdt_set_off_dt_strings(fdt, fdt_off_dt_strings(fdt) + delta);
 124         return 0;
 125 }
 126
 127 static int _blob_splice_struct(void *fdt, void *p,
 128                                int oldlen, int newlen)
 129 {
 130         int delta = newlen - oldlen;
 131         int err;
 132
 133         if ((err = _blob_splice(fdt, p, oldlen, newlen)))
 134                 return err;
 135
 136         fdt_set_size_dt_struct(fdt, fdt_size_dt_struct(fdt) + delta);
 137         fdt_set_off_dt_strings(fdt, fdt_off_dt_strings(fdt) + delta);
 138         return 0;
 139 }
 140
 141 static int _blob_splice_string(void *fdt, int newlen)
 142 {
 143         void *p = (char *)fdt
 144                 + fdt_off_dt_strings(fdt) + fdt_size_dt_strings(fdt);
 145         int err;
 146
 147         if ((err = _blob_splice(fdt, p, 0, newlen)))
 148                 return err;
 149
 150         fdt_set_size_dt_strings(fdt, fdt_size_dt_strings(fdt) + newlen);
 151         return 0;
 152 }
 153
 154 static int _find_add_string(void *fdt, const char *s)
 155 {
 156         char *strtab = (char *)fdt + fdt_off_dt_strings(fdt);
 157         const char *p;
 158         char *new;
 159         int len = strlen(s) + 1;
 160         int err;
 161
 162         p = _fdt_find_string(strtab, fdt_size_dt_strings(fdt), s);
 163         if (p)
 164                 /* found it */
 165                 return (p - strtab);
 166
 167         new = strtab + fdt_size_dt_strings(fdt);
 168         err = _blob_splice_string(fdt, len);
 169         if (err)
 170                 return err;
 171
 172         memcpy(new, s, len);
 173         return (new - strtab);
 174 }
 175
 176 int fdt_add_mem_rsv(void *fdt, uint64_t address, uint64_t size)
 177 {
 178         struct fdt_reserve_entry *re;
 179         int err;
 180
 181         RW_CHECK_HEADER(fdt);
 182
 183         re = _fdt_mem_rsv_w(fdt, fdt_num_mem_rsv(fdt));
 184         err = _blob_splice_mem_rsv(fdt, re, 0, 1);
 185         if (err)
 186                 return err;
 187
 188         re->address = cpu_to_fdt64(address);
 189         re->size = cpu_to_fdt64(size);
 190         return 0;
 191 }
 192
 193 int fdt_del_mem_rsv(void *fdt, int n)
 194 {
 195         struct fdt_reserve_entry *re = _fdt_mem_rsv_w(fdt, n);
 196         int err;
 197
 198         RW_CHECK_HEADER(fdt);
 199
 200         if (n >= fdt_num_mem_rsv(fdt))
 201                 return -FDT_ERR_NOTFOUND;
 202
 203         err = _blob_splice_mem_rsv(fdt, re, 1, 0);
 204         if (err)
 205                 return err;
 206         return 0;
 207 }
 208
 209 static int _resize_property(void *fdt, int nodeoffset, const char *name, int len,
 210                             struct fdt_property **prop)
 211 {
 212         int oldlen;
 213         int err;
 214
 215         *prop = fdt_get_property_w(fdt, nodeoffset, name, &oldlen);
 216         if (! (*prop))
 217                 return oldlen;
 218
 219         if ((err = _blob_splice_struct(fdt, (*prop)->data,
 220                                        ALIGN(oldlen, FDT_TAGSIZE),
 221                                        ALIGN(len, FDT_TAGSIZE))))
 222                 return err;
 223
 224         (*prop)->len = cpu_to_fdt32(len);
 225         return 0;
 226 }
 227
 228 static int _add_property(void *fdt, int nodeoffset, const char *name, int len,
 229                          struct fdt_property **prop)
 230 {
 231         int proplen;
 232         int nextoffset;
 233         int namestroff;
 234         int err;
 235
 236         if ((nextoffset = _fdt_check_node_offset(fdt, nodeoffset)) < 0)
 237                 return nextoffset;
 238
 239         namestroff = _find_add_string(fdt, name);
 240         if (namestroff < 0)
 241                 return namestroff;
 242
 243         *prop = _fdt_offset_ptr_w(fdt, nextoffset);
 244         proplen = sizeof(**prop) + ALIGN(len, FDT_TAGSIZE);
 245
 246         err = _blob_splice_struct(fdt, *prop, 0, proplen);
 247         if (err)
 248                 return err;
 249
 250         (*prop)->tag = cpu_to_fdt32(FDT_PROP);
 251         (*prop)->nameoff = cpu_to_fdt32(namestroff);
 252         (*prop)->len = cpu_to_fdt32(len);
 253         return 0;
 254 }
 255
 256 int fdt_set_name(void *fdt, int nodeoffset, const char *name)
 257 {
 258         char *namep;
 259         int oldlen, newlen;
 260         int err;
 261
 262         RW_CHECK_HEADER(fdt);
 263
 264         namep = (char *)(uintptr_t)fdt_get_name(fdt, nodeoffset, &oldlen);
 265         if (!namep)
 266                 return oldlen;
 267
 268         newlen = strlen(name);
 269
 270         err = _blob_splice_struct(fdt, namep, ALIGN(oldlen+1, FDT_TAGSIZE),
 271                                   ALIGN(newlen+1, FDT_TAGSIZE));
 272         if (err)
 273                 return err;
 274
 275         memcpy(namep, name, newlen+1);
 276         return 0;
 277 }
 278
 279 int fdt_setprop(void *fdt, int nodeoffset, const char *name,
 280                 const void *val, int len)
 281 {
 282         struct fdt_property *prop;
 283         int err;
 284
 285         RW_CHECK_HEADER(fdt);
 286
 287         err = _resize_property(fdt, nodeoffset, name, len, &prop);
 288         if (err == -FDT_ERR_NOTFOUND)
 289                 err = _add_property(fdt, nodeoffset, name, len, &prop);
 290         if (err)
 291                 return err;
 292
 293         memcpy(prop->data, val, len);
 294         return 0;
 295 }
 296
 297 int fdt_delprop(void *fdt, int nodeoffset, const char *name)
 298 {
 299         struct fdt_property *prop;
 300         int len, proplen;
 301
 302         RW_CHECK_HEADER(fdt);
 303
 304         prop = fdt_get_property_w(fdt, nodeoffset, name, &len);
 305         if (! prop)
 306                 return len;
 307
 308         proplen = sizeof(*prop) + ALIGN(len, FDT_TAGSIZE);
 309         return _blob_splice_struct(fdt, prop, proplen, 0);
 310 }
 311
 312 int fdt_add_subnode_namelen(void *fdt, int parentoffset,
 313                             const char *name, int namelen)
 314 {
 315         struct fdt_node_header *nh;
 316         int offset, nextoffset;
 317         int nodelen;
 318         int err;
 319         uint32_t tag;
 320         uint32_t *endtag;
 321
 322         RW_CHECK_HEADER(fdt);
 323
 324         offset = fdt_subnode_offset_namelen(fdt, parentoffset, name, namelen);
 325         if (offset >= 0)
 326                 return -FDT_ERR_EXISTS;
 327         else if (offset != -FDT_ERR_NOTFOUND)
 328                 return offset;
 329
 330         /* Try to place the new node after the parent's properties */
 331         fdt_next_tag(fdt, parentoffset, &nextoffset); /* skip the BEGIN_NODE */
 332         do {
 333                 offset = nextoffset;
 334                 tag = fdt_next_tag(fdt, offset, &nextoffset);
 335         } while ((tag == FDT_PROP) || (tag == FDT_NOP));
 336
 337         nh = _fdt_offset_ptr_w(fdt, offset);
 338         nodelen = sizeof(*nh) + ALIGN(namelen+1, FDT_TAGSIZE) + FDT_TAGSIZE;
 339
 340         err = _blob_splice_struct(fdt, nh, 0, nodelen);
 341         if (err)
 342                 return err;
 343
 344         nh->tag = cpu_to_fdt32(FDT_BEGIN_NODE);
 345         memset(nh->name, 0, ALIGN(namelen+1, FDT_TAGSIZE));
 346         memcpy(nh->name, name, namelen);
 347         endtag = (uint32_t *)((char *)nh + nodelen - FDT_TAGSIZE);
 348         *endtag = cpu_to_fdt32(FDT_END_NODE);
 349
 350         return offset;
 351 }
 352
 353 int fdt_add_subnode(void *fdt, int parentoffset, const char *name)
 354 {
 355         return fdt_add_subnode_namelen(fdt, parentoffset, name, strlen(name));
 356 }
 357
 358 int fdt_del_node(void *fdt, int nodeoffset)
 359 {
 360         int endoffset;
 361
 362         RW_CHECK_HEADER(fdt);
 363
 364         endoffset = _fdt_node_end_offset(fdt, nodeoffset);
 365         if (endoffset < 0)
 366                 return endoffset;
 367
 368         return _blob_splice_struct(fdt, _fdt_offset_ptr_w(fdt, nodeoffset),
 369                                    endoffset - nodeoffset, 0);
 370 }
 371
 372 static void _packblocks(const char *old, char *new,
 373                        int mem_rsv_size, int struct_size)
 374 {
 375         int mem_rsv_off, struct_off, strings_off;
 376
 377         mem_rsv_off = ALIGN(sizeof(struct fdt_header), 8);
 378         struct_off = mem_rsv_off + mem_rsv_size;
 379         strings_off = struct_off + struct_size;
 380
 381         memmove(new + mem_rsv_off, old + fdt_off_mem_rsvmap(old), mem_rsv_size);
 382         fdt_set_off_mem_rsvmap(new, mem_rsv_off);
 383
 384         memmove(new + struct_off, old + fdt_off_dt_struct(old), struct_size);
 385         fdt_set_off_dt_struct(new, struct_off);
 386         fdt_set_size_dt_struct(new, struct_size);
 387
 388         memmove(new + strings_off, old + fdt_off_dt_strings(old),
 389                 fdt_size_dt_strings(old));
 390         fdt_set_off_dt_strings(new, strings_off);
 391         fdt_set_size_dt_strings(new, fdt_size_dt_strings(old));
 392 }
 393
 394 int fdt_open_into(const void *fdt, void *buf, int bufsize)
 395 {
 396         int err;
 397         int mem_rsv_size, struct_size;
 398         int newsize;
 399         const char *fdtstart = fdt;
 400         const char *fdtend = fdtstart + fdt_totalsize(fdt);
 401         char *tmp;
 402
 403         CHECK_HEADER(fdt);
 404
 405         mem_rsv_size = (fdt_num_mem_rsv(fdt)+1)
 406                 * sizeof(struct fdt_reserve_entry);
 407
 408         if (fdt_version(fdt) >= 17) {
 409                 struct_size = fdt_size_dt_struct(fdt);
 410         } else {
 411                 struct_size = 0;
 412                 while (fdt_next_tag(fdt, struct_size, &struct_size) != FDT_END)
 413                         ;
 414         }
 415
 416         if (!_blocks_misordered(fdt, mem_rsv_size, struct_size)) {
 417                 /* no further work necessary */
 418                 err = fdt_move(fdt, buf, bufsize);
 419                 if (err)
 420                         return err;
 421                 fdt_set_version(buf, 17);
 422                 fdt_set_size_dt_struct(buf, struct_size);
 423                 fdt_set_totalsize(buf, bufsize);
 424                 return 0;
 425         }
 426
 427         /* Need to reorder */
 428         newsize = ALIGN(sizeof(struct fdt_header), 8) + mem_rsv_size
 429                 + struct_size + fdt_size_dt_strings(fdt);
 430
 431         if (bufsize < newsize)
 432                 return -FDT_ERR_NOSPACE;
 433
 434         /* First attempt to build converted tree at beginning of buffer */
 435         tmp = buf;
 436         /* But if that overlaps with the old tree... */
 437         if (((tmp + newsize) > fdtstart) && (tmp < fdtend)) {
 438                 /* Try right after the old tree instead */
 439                 tmp = (char *)(uintptr_t)fdtend;
 440                 if ((tmp + newsize) > ((char *)buf + bufsize))
 441                         return -FDT_ERR_NOSPACE;
 442         }
 443
 444         _packblocks(fdt, tmp, mem_rsv_size, struct_size);
 445         memmove(buf, tmp, newsize);
 446
 447         fdt_set_magic(buf, FDT_MAGIC);
 448         fdt_set_totalsize(buf, bufsize);
 449         fdt_set_version(buf, 17);
 450         fdt_set_last_comp_version(buf, 16);
 451         fdt_set_boot_cpuid_phys(buf, fdt_boot_cpuid_phys(fdt));
 452
 453         return 0;
 454 }
 455
 456 int fdt_pack(void *fdt)
 457 {
 458         int mem_rsv_size;
 459
 460         RW_CHECK_HEADER(fdt);
 461
 462         mem_rsv_size = (fdt_num_mem_rsv(fdt)+1)
 463                 * sizeof(struct fdt_reserve_entry);
 464         _packblocks(fdt, fdt, mem_rsv_size, fdt_size_dt_struct(fdt));
 465         fdt_set_totalsize(fdt, _blob_data_size(fdt));
 466
 467         return 0;
 468 }