efifdt.c revision 1.15 1 /* $NetBSD: efifdt.c,v 1.15 2019/04/21 22:30:41 thorpej Exp $ */
2
3 /*-
4 * Copyright (c) 2019 Jason R. Thorpe
5 * Copyright (c) 2018 Jared McNeill <jmcneill (at) invisible.ca>
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30 #include "efiboot.h"
31 #include "efifdt.h"
32 #include "efiblock.h"
33
34 #include <libfdt.h>
35
36 #define FDT_TABLE_GUID \
37 { 0xb1b621d5, 0xf19c, 0x41a5, { 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0 } }
38 static EFI_GUID FdtTableGuid = FDT_TABLE_GUID;
39
40 #define FDT_MEMORY_NODE_PATH "/memory"
41 #define FDT_MEMORY_NODE_NAME "memory"
42 #define FDT_CHOSEN_NODE_PATH "/chosen"
43 #define FDT_CHOSEN_NODE_NAME "chosen"
44
45 #define FDT_MEMORY_USABLE(_md) \
46 ((_md)->Type == EfiLoaderCode || (_md)->Type == EfiLoaderData || \
47 (_md)->Type == EfiBootServicesCode || (_md)->Type == EfiBootServicesData || \
48 (_md)->Type == EfiConventionalMemory)
49
50 static void *fdt_data = NULL;
51
52 int
53 efi_fdt_probe(void)
54 {
55 EFI_STATUS status;
56
57 status = LibGetSystemConfigurationTable(&FdtTableGuid, &fdt_data);
58 if (EFI_ERROR(status))
59 return EIO;
60
61 if (fdt_check_header(fdt_data) != 0) {
62 fdt_data = NULL;
63 return EINVAL;
64 }
65
66 return 0;
67 }
68
69 int
70 efi_fdt_set_data(void *data)
71 {
72 if (fdt_check_header(data) != 0)
73 return EINVAL;
74
75 fdt_data = data;
76 return 0;
77 }
78
79 void *
80 efi_fdt_data(void)
81 {
82 return fdt_data;
83 }
84
85 int
86 efi_fdt_size(void)
87 {
88 return fdt_data == NULL ? 0 : fdt_totalsize(fdt_data);
89 }
90
91 bool
92 efi_fdt_overlay_is_compatible(void *dtbo)
93 {
94 const int system_root = fdt_path_offset(fdt_data, "/");
95 const int overlay_root = fdt_path_offset(dtbo, "/");
96
97 if (system_root < 0 || overlay_root < 0)
98 return false;
99
100 const int system_ncompat = fdt_stringlist_count(fdt_data, system_root,
101 "compatible");
102 const int overlay_ncompat = fdt_stringlist_count(dtbo, overlay_root,
103 "compatible");
104
105 if (system_ncompat <= 0 || overlay_ncompat <= 0)
106 return false;
107
108 const char *system_compatible, *overlay_compatible;
109 int si, oi;
110
111 for (si = 0; si < system_ncompat; si++) {
112 system_compatible = fdt_stringlist_get(fdt_data,
113 system_root, "compatible", si, NULL);
114 if (system_compatible == NULL)
115 continue;
116 for (oi = 0; oi < overlay_ncompat; oi++) {
117 overlay_compatible = fdt_stringlist_get(dtbo,
118 overlay_root, "compatible", oi, NULL);
119 if (overlay_compatible == NULL)
120 continue;
121 if (strcmp(system_compatible, overlay_compatible) == 0)
122 return true;
123 }
124 }
125
126 return false;
127 }
128
129 int
130 efi_fdt_overlay_apply(void *dtbo, int *fdterr)
131 {
132 int err = fdt_overlay_apply(fdt_data, dtbo);
133 if (fdterr)
134 *fdterr = err;
135 return err == 0 ? 0 : EIO;
136 }
137
138 void
139 efi_fdt_init(u_long addr, u_long len)
140 {
141 int error;
142
143 error = fdt_open_into(fdt_data, (void *)addr, len);
144 if (error < 0)
145 panic("fdt_open_into failed: %d", error);
146
147 fdt_data = (void *)addr;
148 }
149
150 void
151 efi_fdt_fini(void)
152 {
153 int error;
154
155 error = fdt_pack(fdt_data);
156 if (error < 0)
157 panic("fdt_pack failed: %d", error);
158 }
159
160 void
161 efi_fdt_show(void)
162 {
163 const char *model, *compat;
164 int n, ncompat;
165
166 if (fdt_data == NULL)
167 return;
168
169 model = fdt_getprop(fdt_data, fdt_path_offset(fdt_data, "/"), "model", NULL);
170 if (model)
171 printf("FDT: %s [", model);
172 ncompat = fdt_stringlist_count(fdt_data, fdt_path_offset(fdt_data, "/"), "compatible");
173 for (n = 0; n < ncompat; n++) {
174 compat = fdt_stringlist_get(fdt_data, fdt_path_offset(fdt_data, "/"),
175 "compatible", n, NULL);
176 printf("%s%s", n == 0 ? "" : ", ", compat);
177 }
178 printf("]\n");
179 }
180
181 void
182 efi_fdt_memory_map(void)
183 {
184 UINTN nentries = 0, mapkey, descsize;
185 EFI_MEMORY_DESCRIPTOR *md, *memmap;
186 UINT32 descver;
187 UINT64 phys_start, phys_size;
188 int n, memory;
189
190 memory = fdt_path_offset(fdt_data, FDT_MEMORY_NODE_PATH);
191 if (memory < 0)
192 memory = fdt_add_subnode(fdt_data, fdt_path_offset(fdt_data, "/"), FDT_MEMORY_NODE_NAME);
193 if (memory < 0)
194 panic("FDT: Failed to create " FDT_MEMORY_NODE_PATH " node");
195
196 fdt_delprop(fdt_data, memory, "reg");
197
198 const int address_cells = fdt_address_cells(fdt_data, fdt_path_offset(fdt_data, "/"));
199 const int size_cells = fdt_size_cells(fdt_data, fdt_path_offset(fdt_data, "/"));
200
201 memmap = LibMemoryMap(&nentries, &mapkey, &descsize, &descver);
202 for (n = 0, md = memmap; n < nentries; n++, md = NextMemoryDescriptor(md, descsize)) {
203 if ((md->Attribute & EFI_MEMORY_RUNTIME) != 0)
204 continue;
205 if ((md->Attribute & EFI_MEMORY_WB) == 0)
206 continue;
207 if (!FDT_MEMORY_USABLE(md))
208 continue;
209 if ((address_cells == 1 || size_cells == 1) && md->PhysicalStart + (md->NumberOfPages * EFI_PAGE_SIZE) > 0xffffffff)
210 continue;
211 if (md->NumberOfPages <= 1)
212 continue;
213
214 phys_start = md->PhysicalStart;
215 phys_size = md->NumberOfPages * EFI_PAGE_SIZE;
216
217 if (phys_start & EFI_PAGE_MASK) {
218 /* UEFI spec says these should be 4KB aligned, but U-Boot doesn't always.. */
219 phys_start = (phys_start + EFI_PAGE_SIZE) & ~EFI_PAGE_MASK;
220 phys_size -= (EFI_PAGE_SIZE * 2);
221 if (phys_size == 0)
222 continue;
223 }
224
225 if (address_cells == 1)
226 fdt_appendprop_u32(fdt_data, fdt_path_offset(fdt_data, FDT_MEMORY_NODE_PATH),
227 "reg", (uint32_t)phys_start);
228 else
229 fdt_appendprop_u64(fdt_data, fdt_path_offset(fdt_data, FDT_MEMORY_NODE_PATH),
230 "reg", phys_start);
231
232 if (size_cells == 1)
233 fdt_appendprop_u32(fdt_data, fdt_path_offset(fdt_data, FDT_MEMORY_NODE_PATH),
234 "reg", (uint32_t)phys_size);
235 else
236 fdt_appendprop_u64(fdt_data, fdt_path_offset(fdt_data, FDT_MEMORY_NODE_PATH),
237 "reg", phys_size);
238 }
239 }
240
241 void
242 efi_fdt_bootargs(const char *bootargs)
243 {
244 struct efi_block_part *bpart = efi_block_boot_part();
245 uint8_t macaddr[6];
246 int chosen;
247
248 chosen = fdt_path_offset(fdt_data, FDT_CHOSEN_NODE_PATH);
249 if (chosen < 0)
250 chosen = fdt_add_subnode(fdt_data, fdt_path_offset(fdt_data, "/"), FDT_CHOSEN_NODE_NAME);
251 if (chosen < 0)
252 panic("FDT: Failed to create " FDT_CHOSEN_NODE_PATH " node");
253
254 if (*bootargs)
255 fdt_setprop_string(fdt_data, chosen, "bootargs", bootargs);
256
257 if (bpart) {
258 switch (bpart->type) {
259 case EFI_BLOCK_PART_DISKLABEL:
260 fdt_setprop(fdt_data, chosen, "netbsd,mbr",
261 bpart->hash, sizeof(bpart->hash));
262 fdt_setprop_u32(fdt_data, chosen, "netbsd,partition",
263 bpart->index);
264 break;
265 case EFI_BLOCK_PART_GPT:
266 if (bpart->gpt.ent.ent_name[0] == 0x0000) {
267 fdt_setprop(fdt_data, chosen, "netbsd,gpt-guid",
268 bpart->hash, sizeof(bpart->hash));
269 } else {
270 char *label = NULL;
271 int rv = ucs2_to_utf8(bpart->gpt.ent.ent_name, &label);
272 if (rv == 0) {
273 fdt_setprop_string(fdt_data, chosen, "netbsd,gpt-label", label);
274 FreePool(label);
275 }
276 }
277 break;
278 default:
279 break;
280 }
281 } else if (efi_net_get_booted_macaddr(macaddr) == 0) {
282 fdt_setprop(fdt_data, chosen, "netbsd,booted-mac-address", macaddr, sizeof(macaddr));
283 }
284 }
285
286 void
287 efi_fdt_initrd(u_long initrd_addr, u_long initrd_size)
288 {
289 int chosen;
290
291 if (initrd_size == 0)
292 return;
293
294 chosen = fdt_path_offset(fdt_data, FDT_CHOSEN_NODE_PATH);
295 if (chosen < 0)
296 chosen = fdt_add_subnode(fdt_data, fdt_path_offset(fdt_data, "/"), FDT_CHOSEN_NODE_NAME);
297 if (chosen < 0)
298 panic("FDT: Failed to create " FDT_CHOSEN_NODE_PATH " node");
299
300 fdt_setprop_u64(fdt_data, chosen, "linux,initrd-start", initrd_addr);
301 fdt_setprop_u64(fdt_data, chosen, "linux,initrd-end", initrd_addr + initrd_size);
302 }
303