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         int err;
  77
  78         if ((err = fdt_check_header(fdt)))
  79                 return err;
  80         if (fdt_version(fdt) < 17)
  81                 return -FDT_ERR_BADVERSION;
  82         if (_blocks_misordered(fdt, sizeof(struct fdt_reserve_entry),
  83                                fdt_size_dt_struct(fdt)))
  84                 return -FDT_ERR_BADLAYOUT;
  85         if (fdt_version(fdt) > 17)
  86                 fdt_set_version(fdt, 17);
  87
  88         return 0;
  89 }
  90
  91 #define RW_CHECK_HEADER(fdt) \
  92         { \
  93                 int err; \
  94                 if ((err = rw_check_header(fdt)) != 0) \
  95                         return err; \
  96         }
  97
  98 static inline int _blob_data_size(void *fdt)
  99 {
 100         return fdt_off_dt_strings(fdt) + fdt_size_dt_strings(fdt);
 101 }
 102
 103 static int _blob_splice(void *fdt, void *p, int oldlen, int newlen)
 104 {
 105         void *end = fdt + _blob_data_size(fdt);
 106
 107         if (((p + oldlen) < p) || ((p + oldlen) > end))
 108                 return -FDT_ERR_BADOFFSET;
 109         if ((end - oldlen + newlen) > (fdt + fdt_totalsize(fdt)))
 110                 return -FDT_ERR_NOSPACE;
 111         memmove(p + newlen, p + oldlen, end - p - oldlen);
 112         return 0;
 113 }
 114
 115 static int _blob_splice_mem_rsv(void *fdt, struct fdt_reserve_entry *p,
 116                                 int oldn, int newn)
 117 {
 118         int delta = (newn - oldn) * sizeof(*p);
 119         int err;
 120         err = _blob_splice(fdt, p, oldn * sizeof(*p), newn * sizeof(*p));
 121         if (err)
 122                 return err;
 123         fdt_set_off_dt_struct(fdt, fdt_off_dt_struct(fdt) + delta);
 124         fdt_set_off_dt_strings(fdt, fdt_off_dt_strings(fdt) + delta);
 125         return 0;
 126 }
 127
 128 static int _blob_splice_struct(void *fdt, void *p,
 129                                int oldlen, int newlen)
 130 {
 131         int delta = newlen - oldlen;
 132         int err;
 133
 134         if ((err = _blob_splice(fdt, p, oldlen, newlen)))
 135                 return err;
 136
 137         fdt_set_size_dt_struct(fdt, fdt_size_dt_struct(fdt) + delta);
 138         fdt_set_off_dt_strings(fdt, fdt_off_dt_strings(fdt) + delta);
 139         return 0;
 140 }
 141
 142 static int _blob_splice_string(void *fdt, int newlen)
 143 {
 144         void *p = fdt + 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         if ((err = rw_check_header(fdt)))
 182                 return err;
 183
 184         re = _fdt_mem_rsv_w(fdt, fdt_num_mem_rsv(fdt));
 185         err = _blob_splice_mem_rsv(fdt, re, 0, 1);
 186         if (err)
 187                 return err;
 188
 189         re->address = cpu_to_fdt64(address);
 190         re->size = cpu_to_fdt64(size);
 191         return 0;
 192 }
 193
 194 int fdt_del_mem_rsv(void *fdt, int n)
 195 {
 196         struct fdt_reserve_entry *re = _fdt_mem_rsv_w(fdt, n);
 197         int err;
 198
 199         if ((err = rw_check_header(fdt)))
 200                 return err;
 201         if (n >= fdt_num_mem_rsv(fdt))
 202                 return -FDT_ERR_NOTFOUND;
 203
 204         err = _blob_splice_mem_rsv(fdt, re, 1, 0);
 205         if (err)
 206                 return err;
 207         return 0;
 208 }
 209
 210 static int _resize_property(void *fdt, int nodeoffset, const char *name, int len,
 211                             struct fdt_property **prop)
 212 {
 213         int oldlen;
 214         int err;
 215
 216         *prop = fdt_get_property_w(fdt, nodeoffset, name, &oldlen);
 217         if (! (*prop))
 218                 return oldlen;
 219
 220         if ((err = _blob_splice_struct(fdt, (*prop)->data,
 221                                        ALIGN(oldlen, FDT_TAGSIZE),
 222                                        ALIGN(len, FDT_TAGSIZE))))
 223                 return err;
 224
 225         (*prop)->len = cpu_to_fdt32(len);
 226         return 0;
 227 }
 228
 229 static int _add_property(void *fdt, int nodeoffset, const char *name, int len,
 230                          struct fdt_property **prop)
 231 {
 232         uint32_t tag;
 233         int proplen;
 234         int nextoffset;
 235         int namestroff;
 236         int err;
 237
 238         tag = fdt_next_tag(fdt, nodeoffset, &nextoffset);
 239         if (tag != FDT_BEGIN_NODE)
 240                 return -FDT_ERR_BADOFFSET;
 241
 242         namestroff = _find_add_string(fdt, name);
 243         if (namestroff < 0)
 244                 return namestroff;
 245
 246         *prop = _fdt_offset_ptr_w(fdt, nextoffset);
 247         proplen = sizeof(**prop) + ALIGN(len, FDT_TAGSIZE);
 248
 249         err = _blob_splice_struct(fdt, *prop, 0, proplen);
 250         if (err)
 251                 return err;
 252
 253         (*prop)->tag = cpu_to_fdt32(FDT_PROP);
 254         (*prop)->nameoff = cpu_to_fdt32(namestroff);
 255         (*prop)->len = cpu_to_fdt32(len);
 256         return 0;
 257 }
 258
 259 int fdt_setprop(void *fdt, int nodeoffset, const char *name,
 260                 const void *val, int len)
 261 {
 262         struct fdt_property *prop;
 263         int err;
 264
 265         if ((err = rw_check_header(fdt)))
 266                 return err;
 267
 268         err = _resize_property(fdt, nodeoffset, name, len, &prop);
 269         if (err == -FDT_ERR_NOTFOUND)
 270                 err = _add_property(fdt, nodeoffset, name, len, &prop);
 271         if (err)
 272                 return err;
 273
 274         memcpy(prop->data, val, len);
 275         return 0;
 276 }
 277
 278 int fdt_delprop(void *fdt, int nodeoffset, const char *name)
 279 {
 280         struct fdt_property *prop;
 281         int len, proplen;
 282
 283         RW_CHECK_HEADER(fdt);
 284
 285         prop = fdt_get_property_w(fdt, nodeoffset, name, &len);
 286         if (! prop)
 287                 return len;
 288
 289         proplen = sizeof(*prop) + ALIGN(len, FDT_TAGSIZE);
 290         return _blob_splice_struct(fdt, prop, proplen, 0);
 291 }
 292
 293 int fdt_add_subnode_namelen(void *fdt, int parentoffset,
 294                             const char *name, int namelen)
 295 {
 296         struct fdt_node_header *nh;
 297         int offset, nextoffset;
 298         int nodelen;
 299         int err;
 300         uint32_t tag;
 301         uint32_t *endtag;
 302
 303         RW_CHECK_HEADER(fdt);
 304
 305         offset = fdt_subnode_offset_namelen(fdt, parentoffset, name, namelen);
 306         if (offset >= 0)
 307                 return -FDT_ERR_EXISTS;
 308         else if (offset != -FDT_ERR_NOTFOUND)
 309                 return offset;
 310
 311         /* Try to place the new node after the parent's properties */
 312         fdt_next_tag(fdt, parentoffset, &nextoffset); /* skip the BEGIN_NODE */
 313         do {
 314                 offset = nextoffset;
 315                 tag = fdt_next_tag(fdt, offset, &nextoffset);
 316         } while (tag == FDT_PROP);
 317
 318         nh = _fdt_offset_ptr_w(fdt, offset);
 319         nodelen = sizeof(*nh) + ALIGN(namelen+1, FDT_TAGSIZE) + FDT_TAGSIZE;
 320
 321         err = _blob_splice_struct(fdt, nh, 0, nodelen);
 322         if (err)
 323                 return err;
 324
 325         nh->tag = cpu_to_fdt32(FDT_BEGIN_NODE);
 326         memset(nh->name, 0, ALIGN(namelen+1, FDT_TAGSIZE));
 327         memcpy(nh->name, name, namelen);
 328         endtag = (uint32_t *)((void *)nh + nodelen - FDT_TAGSIZE);
 329         *endtag = cpu_to_fdt32(FDT_END_NODE);
 330
 331         return offset;
 332 }
 333
 334 int fdt_add_subnode(void *fdt, int parentoffset, const char *name)
 335 {
 336         return fdt_add_subnode_namelen(fdt, parentoffset, name, strlen(name));
 337 }
 338
 339 int fdt_del_node(void *fdt, int nodeoffset)
 340 {
 341         int endoffset;
 342
 343         RW_CHECK_HEADER(fdt);
 344
 345         endoffset = _fdt_node_end_offset(fdt, nodeoffset);
 346         if (endoffset < 0)
 347                 return endoffset;
 348
 349         return _blob_splice_struct(fdt, _fdt_offset_ptr_w(fdt, nodeoffset),
 350                                    endoffset - nodeoffset, 0);
 351 }
 352
 353 static void _packblocks(const void *fdt, void *buf,
 354                        int mem_rsv_size, int struct_size)
 355 {
 356         int mem_rsv_off, struct_off, strings_off;
 357
 358         mem_rsv_off = ALIGN(sizeof(struct fdt_header), 8);
 359         struct_off = mem_rsv_off + mem_rsv_size;
 360         strings_off = struct_off + struct_size;
 361
 362         memmove(buf + mem_rsv_off, fdt + fdt_off_mem_rsvmap(fdt), mem_rsv_size);
 363         fdt_set_off_mem_rsvmap(buf, mem_rsv_off);
 364
 365         memmove(buf + struct_off, fdt + fdt_off_dt_struct(fdt), struct_size);
 366         fdt_set_off_dt_struct(buf, struct_off);
 367         fdt_set_size_dt_struct(buf, struct_size);
 368
 369         memmove(buf + strings_off, fdt + fdt_off_dt_strings(fdt),
 370                 fdt_size_dt_strings(fdt));
 371         fdt_set_off_dt_strings(buf, strings_off);
 372         fdt_set_size_dt_strings(buf, fdt_size_dt_strings(fdt));
 373 }
 374
 375 int fdt_open_into(const void *fdt, void *buf, int bufsize)
 376 {
 377         int err;
 378         int mem_rsv_size, struct_size;
 379         int newsize;
 380         void *tmp;
 381
 382         err = fdt_check_header(fdt);
 383         if (err)
 384                 return err;
 385
 386         mem_rsv_size = (fdt_num_mem_rsv(fdt)+1)
 387                 * sizeof(struct fdt_reserve_entry);
 388
 389         if (fdt_version(fdt) >= 17) {
 390                 struct_size = fdt_size_dt_struct(fdt);
 391         } else {
 392                 struct_size = 0;
 393                 while (fdt_next_tag(fdt, struct_size, &struct_size) != FDT_END)
 394                         ;
 395         }
 396
 397         if (!_blocks_misordered(fdt, mem_rsv_size, struct_size)) {
 398                 /* no further work necessary */
 399                 err = fdt_move(fdt, buf, bufsize);
 400                 if (err)
 401                         return err;
 402                 fdt_set_version(buf, 17);
 403                 fdt_set_size_dt_struct(buf, struct_size);
 404                 fdt_set_totalsize(buf, bufsize);
 405                 return 0;
 406         }
 407
 408         /* Need to reorder */
 409         newsize = ALIGN(sizeof(struct fdt_header), 8) + mem_rsv_size
 410                 + struct_size + fdt_size_dt_strings(fdt);
 411
 412         if (bufsize < newsize)
 413                 return -FDT_ERR_NOSPACE;
 414
 415         if (((buf + newsize) <= fdt)
 416             || (buf >= (fdt + fdt_totalsize(fdt)))) {
 417                 tmp = buf;
 418         } else {
 419                 tmp = (void *)fdt + fdt_totalsize(fdt);
 420                 if ((tmp + newsize) > (buf + bufsize))
 421                         return -FDT_ERR_NOSPACE;
 422         }
 423
 424         _packblocks(fdt, tmp, mem_rsv_size, struct_size);
 425         memmove(buf, tmp, newsize);
 426
 427         fdt_set_magic(buf, FDT_MAGIC);
 428         fdt_set_totalsize(buf, bufsize);
 429         fdt_set_version(buf, 17);
 430         fdt_set_last_comp_version(buf, 16);
 431         fdt_set_boot_cpuid_phys(buf, fdt_boot_cpuid_phys(fdt));
 432
 433         return 0;
 434 }
 435
 436 int fdt_pack(void *fdt)
 437 {
 438         int mem_rsv_size;
 439         int err;
 440
 441         err = rw_check_header(fdt);
 442         if (err)
 443                 return err;
 444
 445         mem_rsv_size = (fdt_num_mem_rsv(fdt)+1)
 446                 * sizeof(struct fdt_reserve_entry);
 447         _packblocks(fdt, fdt, mem_rsv_size, fdt_size_dt_struct(fdt));
 448         fdt_set_totalsize(fdt, _blob_data_size(fdt));
 449
 450         return 0;
 451 }