fdt.c 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
  1. // SPDX-License-Identifier: (GPL-2.0-or-later OR BSD-2-Clause)
  2. /*
  3. * libfdt - Flat Device Tree manipulation
  4. * Copyright (C) 2006 David Gibson, IBM Corporation.
  5. */
  6. #include "libfdt_env.h"
  7. #include <fdt.h>
  8. #include <libfdt.h>
  9. #include "libfdt_internal.h"
  10. /*
  11. * Minimal sanity check for a read-only tree. fdt_ro_probe_() checks
  12. * that the given buffer contains what appears to be a flattened
  13. * device tree with sane information in its header.
  14. */
  15. int32_t fdt_ro_probe_(const void *fdt)
  16. {
  17. uint32_t totalsize = fdt_totalsize(fdt);
  18. if (can_assume(VALID_DTB))
  19. return totalsize;
  20. /* The device tree must be at an 8-byte aligned address */
  21. if ((uintptr_t)fdt & 7)
  22. return -FDT_ERR_ALIGNMENT;
  23. if (fdt_magic(fdt) == FDT_MAGIC) {
  24. /* Complete tree */
  25. if (!can_assume(LATEST)) {
  26. if (fdt_version(fdt) < FDT_FIRST_SUPPORTED_VERSION)
  27. return -FDT_ERR_BADVERSION;
  28. if (fdt_last_comp_version(fdt) >
  29. FDT_LAST_SUPPORTED_VERSION)
  30. return -FDT_ERR_BADVERSION;
  31. }
  32. } else if (fdt_magic(fdt) == FDT_SW_MAGIC) {
  33. /* Unfinished sequential-write blob */
  34. if (!can_assume(VALID_INPUT) && fdt_size_dt_struct(fdt) == 0)
  35. return -FDT_ERR_BADSTATE;
  36. } else {
  37. return -FDT_ERR_BADMAGIC;
  38. }
  39. if (fdt_off_dt_struct(fdt) > (UINT_MAX - fdt_size_dt_struct(fdt)))
  40. return FDT_ERR_BADOFFSET;
  41. if (fdt_off_dt_strings(fdt) > (UINT_MAX - fdt_size_dt_strings(fdt)))
  42. return FDT_ERR_BADOFFSET;
  43. if ((fdt_off_dt_struct(fdt) + fdt_size_dt_struct(fdt))
  44. > fdt_totalsize(fdt))
  45. return FDT_ERR_BADOFFSET;
  46. if ((fdt_off_dt_strings(fdt) + fdt_size_dt_strings(fdt))
  47. > fdt_totalsize(fdt))
  48. return FDT_ERR_BADOFFSET;
  49. if (totalsize < INT32_MAX)
  50. return totalsize;
  51. else
  52. return -FDT_ERR_TRUNCATED;
  53. }
  54. static int check_off_(uint32_t hdrsize, uint32_t totalsize, uint32_t off)
  55. {
  56. return (off >= hdrsize) && (off <= totalsize);
  57. }
  58. static int check_block_(uint32_t hdrsize, uint32_t totalsize,
  59. uint32_t base, uint32_t size)
  60. {
  61. if (!check_off_(hdrsize, totalsize, base))
  62. return 0; /* block start out of bounds */
  63. if ((base + size) < base)
  64. return 0; /* overflow */
  65. if (!check_off_(hdrsize, totalsize, base + size))
  66. return 0; /* block end out of bounds */
  67. return 1;
  68. }
  69. size_t fdt_header_size_(uint32_t version)
  70. {
  71. if (version <= 1)
  72. return FDT_V1_SIZE;
  73. else if (version <= 2)
  74. return FDT_V2_SIZE;
  75. else if (version <= 3)
  76. return FDT_V3_SIZE;
  77. else if (version <= 16)
  78. return FDT_V16_SIZE;
  79. else
  80. return FDT_V17_SIZE;
  81. }
  82. size_t fdt_header_size(const void *fdt)
  83. {
  84. return can_assume(LATEST) ? FDT_V17_SIZE :
  85. fdt_header_size_(fdt_version(fdt));
  86. }
  87. int fdt_check_header(const void *fdt)
  88. {
  89. size_t hdrsize;
  90. /* The device tree must be at an 8-byte aligned address */
  91. if ((uintptr_t)fdt & 7)
  92. return -FDT_ERR_ALIGNMENT;
  93. if (fdt_magic(fdt) != FDT_MAGIC)
  94. return -FDT_ERR_BADMAGIC;
  95. if (!can_assume(LATEST)) {
  96. if ((fdt_version(fdt) < FDT_FIRST_SUPPORTED_VERSION)
  97. || (fdt_last_comp_version(fdt) >
  98. FDT_LAST_SUPPORTED_VERSION))
  99. return -FDT_ERR_BADVERSION;
  100. if (fdt_version(fdt) < fdt_last_comp_version(fdt))
  101. return -FDT_ERR_BADVERSION;
  102. }
  103. hdrsize = fdt_header_size(fdt);
  104. if (!can_assume(VALID_DTB)) {
  105. if ((fdt_totalsize(fdt) < hdrsize)
  106. || (fdt_totalsize(fdt) > INT_MAX))
  107. return -FDT_ERR_TRUNCATED;
  108. /* Bounds check memrsv block */
  109. if (!check_off_(hdrsize, fdt_totalsize(fdt),
  110. fdt_off_mem_rsvmap(fdt)))
  111. return -FDT_ERR_TRUNCATED;
  112. }
  113. if (!can_assume(VALID_DTB)) {
  114. /* Bounds check structure block */
  115. if (!can_assume(LATEST) && fdt_version(fdt) < 17) {
  116. if (!check_off_(hdrsize, fdt_totalsize(fdt),
  117. fdt_off_dt_struct(fdt)))
  118. return -FDT_ERR_TRUNCATED;
  119. } else {
  120. if (!check_block_(hdrsize, fdt_totalsize(fdt),
  121. fdt_off_dt_struct(fdt),
  122. fdt_size_dt_struct(fdt)))
  123. return -FDT_ERR_TRUNCATED;
  124. }
  125. /* Bounds check strings block */
  126. if (!check_block_(hdrsize, fdt_totalsize(fdt),
  127. fdt_off_dt_strings(fdt),
  128. fdt_size_dt_strings(fdt)))
  129. return -FDT_ERR_TRUNCATED;
  130. }
  131. return 0;
  132. }
  133. const void *fdt_offset_ptr(const void *fdt, int offset, unsigned int len)
  134. {
  135. unsigned int uoffset = offset;
  136. unsigned int absoffset = offset + fdt_off_dt_struct(fdt);
  137. if (offset < 0)
  138. return NULL;
  139. if (!can_assume(VALID_INPUT))
  140. if ((absoffset < uoffset)
  141. || ((absoffset + len) < absoffset)
  142. || (absoffset + len) > fdt_totalsize(fdt))
  143. return NULL;
  144. if (can_assume(LATEST) || fdt_version(fdt) >= 0x11)
  145. if (((uoffset + len) < uoffset)
  146. || ((offset + len) > fdt_size_dt_struct(fdt)))
  147. return NULL;
  148. return fdt_offset_ptr_(fdt, offset);
  149. }
  150. uint32_t fdt_next_tag(const void *fdt, int startoffset, int *nextoffset)
  151. {
  152. const fdt32_t *tagp, *lenp;
  153. uint32_t tag;
  154. int offset = startoffset;
  155. const char *p;
  156. *nextoffset = -FDT_ERR_TRUNCATED;
  157. tagp = fdt_offset_ptr(fdt, offset, FDT_TAGSIZE);
  158. if (!can_assume(VALID_DTB) && !tagp)
  159. return FDT_END; /* premature end */
  160. tag = fdt32_to_cpu(*tagp);
  161. offset += FDT_TAGSIZE;
  162. *nextoffset = -FDT_ERR_BADSTRUCTURE;
  163. switch (tag) {
  164. case FDT_BEGIN_NODE:
  165. /* skip name */
  166. do {
  167. p = fdt_offset_ptr(fdt, offset++, 1);
  168. } while (p && (*p != '\0'));
  169. if (!can_assume(VALID_DTB) && !p)
  170. return FDT_END; /* premature end */
  171. break;
  172. case FDT_PROP:
  173. lenp = fdt_offset_ptr(fdt, offset, sizeof(*lenp));
  174. if (!can_assume(VALID_DTB) && !lenp)
  175. return FDT_END; /* premature end */
  176. /* skip-name offset, length and value */
  177. offset += sizeof(struct fdt_property) - FDT_TAGSIZE
  178. + fdt32_to_cpu(*lenp);
  179. if (!can_assume(LATEST) &&
  180. fdt_version(fdt) < 0x10 && fdt32_to_cpu(*lenp) >= 8 &&
  181. ((offset - fdt32_to_cpu(*lenp)) % 8) != 0)
  182. offset += 4;
  183. break;
  184. case FDT_END:
  185. case FDT_END_NODE:
  186. case FDT_NOP:
  187. break;
  188. default:
  189. return FDT_END;
  190. }
  191. if (!fdt_offset_ptr(fdt, startoffset, offset - startoffset))
  192. return FDT_END; /* premature end */
  193. *nextoffset = FDT_TAGALIGN(offset);
  194. return tag;
  195. }
  196. int fdt_check_node_offset_(const void *fdt, int offset)
  197. {
  198. if (!can_assume(VALID_INPUT)
  199. && ((offset < 0) || (offset % FDT_TAGSIZE)))
  200. return -FDT_ERR_BADOFFSET;
  201. if (fdt_next_tag(fdt, offset, &offset) != FDT_BEGIN_NODE)
  202. return -FDT_ERR_BADOFFSET;
  203. return offset;
  204. }
  205. int fdt_check_prop_offset_(const void *fdt, int offset)
  206. {
  207. if (!can_assume(VALID_INPUT)
  208. && ((offset < 0) || (offset % FDT_TAGSIZE)))
  209. return -FDT_ERR_BADOFFSET;
  210. if (fdt_next_tag(fdt, offset, &offset) != FDT_PROP)
  211. return -FDT_ERR_BADOFFSET;
  212. return offset;
  213. }
  214. int fdt_next_node(const void *fdt, int offset, int *depth)
  215. {
  216. int nextoffset = 0;
  217. uint32_t tag;
  218. if (offset >= 0)
  219. if ((nextoffset = fdt_check_node_offset_(fdt, offset)) < 0)
  220. return nextoffset;
  221. do {
  222. offset = nextoffset;
  223. tag = fdt_next_tag(fdt, offset, &nextoffset);
  224. switch (tag) {
  225. case FDT_PROP:
  226. case FDT_NOP:
  227. break;
  228. case FDT_BEGIN_NODE:
  229. if (depth)
  230. (*depth)++;
  231. break;
  232. case FDT_END_NODE:
  233. if (depth && ((--(*depth)) < 0))
  234. return nextoffset;
  235. break;
  236. case FDT_END:
  237. if ((nextoffset >= 0)
  238. || ((nextoffset == -FDT_ERR_TRUNCATED) && !depth))
  239. return -FDT_ERR_NOTFOUND;
  240. else
  241. return nextoffset;
  242. }
  243. } while (tag != FDT_BEGIN_NODE);
  244. return offset;
  245. }
  246. int fdt_first_subnode(const void *fdt, int offset)
  247. {
  248. int depth = 0;
  249. offset = fdt_next_node(fdt, offset, &depth);
  250. if (offset < 0 || depth != 1)
  251. return -FDT_ERR_NOTFOUND;
  252. return offset;
  253. }
  254. int fdt_next_subnode(const void *fdt, int offset)
  255. {
  256. int depth = 1;
  257. /*
  258. * With respect to the parent, the depth of the next subnode will be
  259. * the same as the last.
  260. */
  261. do {
  262. offset = fdt_next_node(fdt, offset, &depth);
  263. if (offset < 0 || depth < 1)
  264. return -FDT_ERR_NOTFOUND;
  265. } while (depth > 1);
  266. return offset;
  267. }
  268. const char *fdt_find_string_(const char *strtab, int tabsize, const char *s)
  269. {
  270. int len = strlen(s) + 1;
  271. const char *last = strtab + tabsize - len;
  272. const char *p;
  273. for (p = strtab; p <= last; p++)
  274. if (memcmp(p, s, len) == 0)
  275. return p;
  276. return NULL;
  277. }
  278. int fdt_move(const void *fdt, void *buf, int bufsize)
  279. {
  280. if (!can_assume(VALID_INPUT) && bufsize < 0)
  281. return -FDT_ERR_NOSPACE;
  282. FDT_RO_PROBE(fdt);
  283. if (fdt_totalsize(fdt) > (unsigned int)bufsize)
  284. return -FDT_ERR_NOSPACE;
  285. memmove(buf, fdt, fdt_totalsize(fdt));
  286. return 0;
  287. }