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 #include <fdt.h>
  54 #include <libfdt.h>
  55
  56 #include "libfdt_internal.h"
  57
  58 static int _blocks_misordered(const void *fdt,
  59                               int mem_rsv_size, int struct_size)
  60 {
  61         return (fdt_off_mem_rsvmap(fdt) < ALIGN(sizeof(struct fdt_header), 8))
  62                 || (fdt_off_dt_struct(fdt) <
  63                     (fdt_off_mem_rsvmap(fdt) + mem_rsv_size))
  64                 || (fdt_off_dt_strings(fdt) <
  65                     (fdt_off_dt_struct(fdt) + struct_size))
  66                 || (fdt_totalsize(fdt) <
  67                     (fdt_off_dt_strings(fdt) + fdt_size_dt_strings(fdt)));
  68 }
  69
  70 static int rw_check_header(void *fdt)
  71 {
  72         int err;
  73
  74         if ((err = fdt_check_header(fdt)))
  75                 return err;
  76         if (fdt_version(fdt) < 17)
  77                 return -FDT_ERR_BADVERSION;
  78         if (_blocks_misordered(fdt, sizeof(struct fdt_reserve_entry),
  79                                fdt_size_dt_struct(fdt)))
  80                 return -FDT_ERR_BADLAYOUT;
  81         if (fdt_version(fdt) > 17)
  82                 fdt_set_version(fdt, 17);
  83
  84         return 0;
  85 }
  86
  87 #define RW_CHECK_HEADER(fdt) \
  88         { \
  89                 int err; \
  90                 if ((err = rw_check_header(fdt)) != 0) \
  91                         return err; \
  92         }
  93
  94 static inline int _blob_data_size(void *fdt)
  95 {
  96         return fdt_off_dt_strings(fdt) + fdt_size_dt_strings(fdt);
  97 }
  98
  99 static int _blob_splice(void *fdt, void *p, int oldlen, int newlen)
 100 {
 101         void *end = fdt + _blob_data_size(fdt);
 102
 103         if (((p + oldlen) < p) || ((p + oldlen) > end))
 104                 return -FDT_ERR_BADOFFSET;
 105         if ((end - oldlen + newlen) > (fdt + fdt_totalsize(fdt)))
 106                 return -FDT_ERR_NOSPACE;
 107         memmove(p + newlen, p + oldlen, end - p - oldlen);
 108         return 0;
 109 }
 110
 111 static int _blob_splice_mem_rsv(void *fdt, struct fdt_reserve_entry *p,
 112                                 int oldn, int newn)
 113 {
 114         int delta = (newn - oldn) * sizeof(*p);
 115         int err;
 116         err = _blob_splice(fdt, p, oldn * sizeof(*p), newn * sizeof(*p));
 117         if (err)
 118                 return err;
 119         fdt_set_off_dt_struct(fdt, fdt_off_dt_struct(fdt) + delta);
 120         fdt_set_off_dt_strings(fdt, fdt_off_dt_strings(fdt) + delta);
 121         return 0;
 122 }
 123
 124 static int _blob_splice_struct(void *fdt, void *p,
 125                                int oldlen, int newlen)
 126 {
 127         int delta = newlen - oldlen;
 128         int err;
 129
 130         if ((err = _blob_splice(fdt, p, oldlen, newlen)))
 131                 return err;
 132
 133         fdt_set_size_dt_struct(fdt, fdt_size_dt_struct(fdt) + delta);
 134         fdt_set_off_dt_strings(fdt, fdt_off_dt_strings(fdt) + delta);
 135         return 0;
 136 }
 137
 138 static int _blob_splice_string(void *fdt, int newlen)
 139 {
 140         void *p = fdt + fdt_off_dt_strings(fdt) + fdt_size_dt_strings(fdt);
 141         int err;
 142
 143         if ((err = _blob_splice(fdt, p, 0, newlen)))
 144                 return err;
 145
 146         fdt_set_size_dt_strings(fdt, fdt_size_dt_strings(fdt) + newlen);
 147         return 0;
 148 }
 149
 150 static int _find_add_string(void *fdt, const char *s)
 151 {
 152         char *strtab = (char *)fdt + fdt_off_dt_strings(fdt);
 153         const char *p;
 154         char *new;
 155         int len = strlen(s) + 1;
 156         int err;
 157
 158         p = _fdt_find_string(strtab, fdt_size_dt_strings(fdt), s);
 159         if (p)
 160                 /* found it */
 161                 return (p - strtab);
 162
 163         new = strtab + fdt_size_dt_strings(fdt);
 164         err = _blob_splice_string(fdt, len);
 165         if (err)
 166                 return err;
 167
 168         memcpy(new, s, len);
 169         return (new - strtab);
 170 }
 171
 172 int fdt_add_mem_rsv(void *fdt, uint64_t address, uint64_t size)
 173 {
 174         struct fdt_reserve_entry *re;
 175         int err;
 176
 177         if ((err = rw_check_header(fdt)))
 178                 return err;
 179
 180         re = _fdt_mem_rsv_w(fdt, fdt_num_mem_rsv(fdt));
 181         err = _blob_splice_mem_rsv(fdt, re, 0, 1);
 182         if (err)
 183                 return err;
 184
 185         re->address = cpu_to_fdt64(address);
 186         re->size = cpu_to_fdt64(size);
 187         return 0;
 188 }
 189
 190 int fdt_del_mem_rsv(void *fdt, int n)
 191 {
 192         struct fdt_reserve_entry *re = _fdt_mem_rsv_w(fdt, n);
 193         int err;
 194
 195         if ((err = rw_check_header(fdt)))
 196                 return err;
 197         if (n >= fdt_num_mem_rsv(fdt))
 198                 return -FDT_ERR_NOTFOUND;
 199
 200         err = _blob_splice_mem_rsv(fdt, re, 1, 0);
 201         if (err)
 202                 return err;
 203         return 0;
 204 }
 205
 206 static int _resize_property(void *fdt, int nodeoffset, const char *name, int len,
 207                             struct fdt_property **prop)
 208 {
 209         int oldlen;
 210         int err;
 211
 212         *prop = fdt_get_property_w(fdt, nodeoffset, name, &oldlen);
 213         if (! (*prop))
 214                 return oldlen;
 215
 216         if ((err = _blob_splice_struct(fdt, (*prop)->data,
 217                                        ALIGN(oldlen, FDT_TAGSIZE),
 218                                        ALIGN(len, FDT_TAGSIZE))))
 219                 return err;
 220
 221         (*prop)->len = cpu_to_fdt32(len);
 222         return 0;
 223 }
 224
 225 static int _add_property(void *fdt, int nodeoffset, const char *name, int len,
 226                          struct fdt_property **prop)
 227 {
 228         uint32_t tag;
 229         int proplen;
 230         int nextoffset;
 231         int namestroff;
 232         int err;
 233
 234         tag = fdt_next_tag(fdt, nodeoffset, &nextoffset);
 235         if (tag != FDT_BEGIN_NODE)
 236                 return -FDT_ERR_BADOFFSET;
 237
 238         namestroff = _find_add_string(fdt, name);
 239         if (namestroff < 0)
 240                 return namestroff;
 241
 242         *prop = _fdt_offset_ptr_w(fdt, nextoffset);
 243         proplen = sizeof(**prop) + ALIGN(len, FDT_TAGSIZE);
 244
 245         err = _blob_splice_struct(fdt, *prop, 0, proplen);
 246         if (err)
 247                 return err;
 248
 249         (*prop)->tag = cpu_to_fdt32(FDT_PROP);
 250         (*prop)->nameoff = cpu_to_fdt32(namestroff);
 251         (*prop)->len = cpu_to_fdt32(len);
 252         return 0;
 253 }
 254
 255 int fdt_set_name(void *fdt, int nodeoffset, const char *name)
 256 {
 257         char *namep;
 258         int oldlen, newlen;
 259         int err;
 260
 261         if ((err = rw_check_header(fdt)))
 262                 return err;
 263
 264         namep = (char *)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         if ((err = rw_check_header(fdt)))
 286                 return err;
 287
 288         err = _resize_property(fdt, nodeoffset, name, len, &prop);
 289         if (err == -FDT_ERR_NOTFOUND)
 290                 err = _add_property(fdt, nodeoffset, name, len, &prop);
 291         if (err)
 292                 return err;
 293
 294         memcpy(prop->data, val, len);
 295         return 0;
 296 }
 297
 298 int fdt_delprop(void *fdt, int nodeoffset, const char *name)
 299 {
 300         struct fdt_property *prop;
 301         int len, proplen;
 302
 303         RW_CHECK_HEADER(fdt);
 304
 305         prop = fdt_get_property_w(fdt, nodeoffset, name, &len);
 306         if (! prop)
 307                 return len;
 308
 309         proplen = sizeof(*prop) + ALIGN(len, FDT_TAGSIZE);
 310         return _blob_splice_struct(fdt, prop, proplen, 0);
 311 }
 312
 313 int fdt_add_subnode_namelen(void *fdt, int parentoffset,
 314                             const char *name, int namelen)
 315 {
 316         struct fdt_node_header *nh;
 317         int offset, nextoffset;
 318         int nodelen;
 319         int err;
 320         uint32_t tag;
 321         uint32_t *endtag;
 322
 323         RW_CHECK_HEADER(fdt);
 324
 325         offset = fdt_subnode_offset_namelen(fdt, parentoffset, name, namelen);
 326         if (offset >= 0)
 327                 return -FDT_ERR_EXISTS;
 328         else if (offset != -FDT_ERR_NOTFOUND)
 329                 return offset;
 330
 331         /* Try to place the new node after the parent's properties */
 332         fdt_next_tag(fdt, parentoffset, &nextoffset); /* skip the BEGIN_NODE */
 333         do {
 334                 offset = nextoffset;
 335                 tag = fdt_next_tag(fdt, offset, &nextoffset);
 336         } while ((tag == FDT_PROP) || (tag == FDT_NOP));
 337
 338         nh = _fdt_offset_ptr_w(fdt, offset);
 339         nodelen = sizeof(*nh) + ALIGN(namelen+1, FDT_TAGSIZE) + FDT_TAGSIZE;
 340
 341         err = _blob_splice_struct(fdt, nh, 0, nodelen);
 342         if (err)
 343                 return err;
 344
 345         nh->tag = cpu_to_fdt32(FDT_BEGIN_NODE);
 346         memset(nh->name, 0, ALIGN(namelen+1, FDT_TAGSIZE));
 347         memcpy(nh->name, name, namelen);
 348         endtag = (uint32_t *)((void *)nh + nodelen - FDT_TAGSIZE);
 349         *endtag = cpu_to_fdt32(FDT_END_NODE);
 350
 351         return offset;
 352 }
 353
 354 int fdt_add_subnode(void *fdt, int parentoffset, const char *name)
 355 {
 356         return fdt_add_subnode_namelen(fdt, parentoffset, name, strlen(name));
 357 }
 358
 359 int fdt_del_node(void *fdt, int nodeoffset)
 360 {
 361         int endoffset;
 362
 363         RW_CHECK_HEADER(fdt);
 364
 365         endoffset = _fdt_node_end_offset(fdt, nodeoffset);
 366         if (endoffset < 0)
 367                 return endoffset;
 368
 369         return _blob_splice_struct(fdt, _fdt_offset_ptr_w(fdt, nodeoffset),
 370                                    endoffset - nodeoffset, 0);
 371 }
 372
 373 static void _packblocks(const void *fdt, void *buf,
 374                        int mem_rsv_size, int struct_size)
 375 {
 376         int mem_rsv_off, struct_off, strings_off;
 377
 378         mem_rsv_off = ALIGN(sizeof(struct fdt_header), 8);
 379         struct_off = mem_rsv_off + mem_rsv_size;
 380         strings_off = struct_off + struct_size;
 381
 382         memmove(buf + mem_rsv_off, fdt + fdt_off_mem_rsvmap(fdt), mem_rsv_size);
 383         fdt_set_off_mem_rsvmap(buf, mem_rsv_off);
 384
 385         memmove(buf + struct_off, fdt + fdt_off_dt_struct(fdt), struct_size);
 386         fdt_set_off_dt_struct(buf, struct_off);
 387         fdt_set_size_dt_struct(buf, struct_size);
 388
 389         memmove(buf + strings_off, fdt + fdt_off_dt_strings(fdt),
 390                 fdt_size_dt_strings(fdt));
 391         fdt_set_off_dt_strings(buf, strings_off);
 392         fdt_set_size_dt_strings(buf, fdt_size_dt_strings(fdt));
 393 }
 394
 395 int fdt_open_into(const void *fdt, void *buf, int bufsize)
 396 {
 397         int err;
 398         int mem_rsv_size, struct_size;
 399         int newsize;
 400         void *tmp;
 401
 402         err = fdt_check_header(fdt);
 403         if (err)
 404                 return err;
 405
 406         mem_rsv_size = (fdt_num_mem_rsv(fdt)+1)
 407                 * sizeof(struct fdt_reserve_entry);
 408
 409         if (fdt_version(fdt) >= 17) {
 410                 struct_size = fdt_size_dt_struct(fdt);
 411         } else {
 412                 struct_size = 0;
 413                 while (fdt_next_tag(fdt, struct_size, &struct_size) != FDT_END)
 414                         ;
 415         }
 416
 417         if (!_blocks_misordered(fdt, mem_rsv_size, struct_size)) {
 418                 /* no further work necessary */
 419                 err = fdt_move(fdt, buf, bufsize);
 420                 if (err)
 421                         return err;
 422                 fdt_set_version(buf, 17);
 423                 fdt_set_size_dt_struct(buf, struct_size);
 424                 fdt_set_totalsize(buf, bufsize);
 425                 return 0;
 426         }
 427
 428         /* Need to reorder */
 429         newsize = ALIGN(sizeof(struct fdt_header), 8) + mem_rsv_size
 430                 + struct_size + fdt_size_dt_strings(fdt);
 431
 432         if (bufsize < newsize)
 433                 return -FDT_ERR_NOSPACE;
 434
 435         if (((buf + newsize) <= fdt)
 436             || (buf >= (fdt + fdt_totalsize(fdt)))) {
 437                 tmp = buf;
 438         } else {
 439                 tmp = (void *)fdt + fdt_totalsize(fdt);
 440                 if ((tmp + newsize) > (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         int err;
 460
 461         err = rw_check_header(fdt);
 462         if (err)
 463                 return err;
 464
 465         mem_rsv_size = (fdt_num_mem_rsv(fdt)+1)
 466                 * sizeof(struct fdt_reserve_entry);
 467         _packblocks(fdt, fdt, mem_rsv_size, fdt_size_dt_struct(fdt));
 468         fdt_set_totalsize(fdt, _blob_data_size(fdt));
 469
 470         return 0;
 471 }