1 /*-
2 * Copyright (c) 2013 The FreeBSD Foundation
3 * All rights reserved.
4 *
5 * This software was developed by Benno Rice under sponsorship from
6 * the FreeBSD Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31
32 #include <bootstrap.h>
33 #include <sys/endian.h>
34 #include <stand.h>
35
36 #include <efi.h>
37 #include <efilib.h>
38 #include <efiuga.h>
39 #include <efipciio.h>
40 #include <machine/metadata.h>
41
42 static EFI_GUID gop_guid = EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID;
43 static EFI_GUID pciio_guid = EFI_PCI_IO_PROTOCOL_GUID;
44 static EFI_GUID uga_guid = EFI_UGA_DRAW_PROTOCOL_GUID;
45
46 static u_int
efifb_color_depth(struct efi_fb * efifb)47 efifb_color_depth(struct efi_fb *efifb)
48 {
49 uint32_t mask;
50 u_int depth;
51
52 mask = efifb->fb_mask_red | efifb->fb_mask_green |
53 efifb->fb_mask_blue | efifb->fb_mask_reserved;
54 if (mask == 0)
55 return (0);
56 for (depth = 1; mask != 1; depth++)
57 mask >>= 1;
58 return (depth);
59 }
60
61 static int
efifb_mask_from_pixfmt(struct efi_fb * efifb,EFI_GRAPHICS_PIXEL_FORMAT pixfmt,EFI_PIXEL_BITMASK * pixinfo)62 efifb_mask_from_pixfmt(struct efi_fb *efifb, EFI_GRAPHICS_PIXEL_FORMAT pixfmt,
63 EFI_PIXEL_BITMASK *pixinfo)
64 {
65 int result;
66
67 result = 0;
68 switch (pixfmt) {
69 case PixelRedGreenBlueReserved8BitPerColor:
70 efifb->fb_mask_red = 0x000000ff;
71 efifb->fb_mask_green = 0x0000ff00;
72 efifb->fb_mask_blue = 0x00ff0000;
73 efifb->fb_mask_reserved = 0xff000000;
74 break;
75 case PixelBlueGreenRedReserved8BitPerColor:
76 efifb->fb_mask_red = 0x00ff0000;
77 efifb->fb_mask_green = 0x0000ff00;
78 efifb->fb_mask_blue = 0x000000ff;
79 efifb->fb_mask_reserved = 0xff000000;
80 break;
81 case PixelBitMask:
82 efifb->fb_mask_red = pixinfo->RedMask;
83 efifb->fb_mask_green = pixinfo->GreenMask;
84 efifb->fb_mask_blue = pixinfo->BlueMask;
85 efifb->fb_mask_reserved = pixinfo->ReservedMask;
86 break;
87 default:
88 result = 1;
89 break;
90 }
91 return (result);
92 }
93
94 static int
efifb_from_gop(struct efi_fb * efifb,EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE * mode,EFI_GRAPHICS_OUTPUT_MODE_INFORMATION * info)95 efifb_from_gop(struct efi_fb *efifb, EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE *mode,
96 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *info)
97 {
98 int result;
99
100 efifb->fb_addr = mode->FrameBufferBase;
101 efifb->fb_size = mode->FrameBufferSize;
102 efifb->fb_height = info->VerticalResolution;
103 efifb->fb_width = info->HorizontalResolution;
104 efifb->fb_stride = info->PixelsPerScanLine;
105 result = efifb_mask_from_pixfmt(efifb, info->PixelFormat,
106 &info->PixelInformation);
107 return (result);
108 }
109
110 static ssize_t
efifb_uga_find_pixel(EFI_UGA_DRAW_PROTOCOL * uga,u_int line,EFI_PCI_IO_PROTOCOL * pciio,uint64_t addr,uint64_t size)111 efifb_uga_find_pixel(EFI_UGA_DRAW_PROTOCOL *uga, u_int line,
112 EFI_PCI_IO_PROTOCOL *pciio, uint64_t addr, uint64_t size)
113 {
114 EFI_UGA_PIXEL pix0, pix1;
115 uint8_t *data1, *data2;
116 size_t count, maxcount = 1024;
117 ssize_t ofs;
118 EFI_STATUS status;
119 u_int idx;
120
121 status = uga->Blt(uga, &pix0, EfiUgaVideoToBltBuffer,
122 0, line, 0, 0, 1, 1, 0);
123 if (EFI_ERROR(status)) {
124 printf("UGA BLT operation failed (video->buffer)");
125 return (-1);
126 }
127 pix1.Red = ~pix0.Red;
128 pix1.Green = ~pix0.Green;
129 pix1.Blue = ~pix0.Blue;
130 pix1.Reserved = 0;
131
132 data1 = calloc(maxcount, 2);
133 if (data1 == NULL) {
134 printf("Unable to allocate memory");
135 return (-1);
136 }
137 data2 = data1 + maxcount;
138
139 ofs = 0;
140 while (size > 0) {
141 count = min(size, maxcount);
142
143 status = pciio->Mem.Read(pciio, EfiPciIoWidthUint32,
144 EFI_PCI_IO_PASS_THROUGH_BAR, addr + ofs, count >> 2,
145 data1);
146 if (EFI_ERROR(status)) {
147 printf("Error reading frame buffer (before)");
148 goto fail;
149 }
150 status = uga->Blt(uga, &pix1, EfiUgaBltBufferToVideo,
151 0, 0, 0, line, 1, 1, 0);
152 if (EFI_ERROR(status)) {
153 printf("UGA BLT operation failed (modify)");
154 goto fail;
155 }
156 status = pciio->Mem.Read(pciio, EfiPciIoWidthUint32,
157 EFI_PCI_IO_PASS_THROUGH_BAR, addr + ofs, count >> 2,
158 data2);
159 if (EFI_ERROR(status)) {
160 printf("Error reading frame buffer (after)");
161 goto fail;
162 }
163 status = uga->Blt(uga, &pix0, EfiUgaBltBufferToVideo,
164 0, 0, 0, line, 1, 1, 0);
165 if (EFI_ERROR(status)) {
166 printf("UGA BLT operation failed (restore)");
167 goto fail;
168 }
169 for (idx = 0; idx < count; idx++) {
170 if (data1[idx] != data2[idx]) {
171 free(data1);
172 return (ofs + (idx & ~3));
173 }
174 }
175 ofs += count;
176 size -= count;
177 }
178 printf("No change detected in frame buffer");
179
180 fail:
181 printf(" -- error %lu\n", EFI_ERROR_CODE(status));
182 free(data1);
183 return (-1);
184 }
185
186 static EFI_PCI_IO_PROTOCOL *
efifb_uga_get_pciio(void)187 efifb_uga_get_pciio(void)
188 {
189 EFI_PCI_IO_PROTOCOL *pciio;
190 EFI_HANDLE *buf, *hp;
191 EFI_STATUS status;
192 UINTN bufsz;
193
194 /* Get all handles that support the UGA protocol. */
195 bufsz = 0;
196 status = BS->LocateHandle(ByProtocol, &uga_guid, NULL, &bufsz, NULL);
197 if (status != EFI_BUFFER_TOO_SMALL)
198 return (NULL);
199 buf = malloc(bufsz);
200 status = BS->LocateHandle(ByProtocol, &uga_guid, NULL, &bufsz, buf);
201 if (status != EFI_SUCCESS) {
202 free(buf);
203 return (NULL);
204 }
205 bufsz /= sizeof(EFI_HANDLE);
206
207 /* Get the PCI I/O interface of the first handle that supports it. */
208 pciio = NULL;
209 for (hp = buf; hp < buf + bufsz; hp++) {
210 status = BS->HandleProtocol(*hp, &pciio_guid, (void **)&pciio);
211 if (status == EFI_SUCCESS) {
212 free(buf);
213 return (pciio);
214 }
215 }
216 free(buf);
217 return (NULL);
218 }
219
220 static EFI_STATUS
efifb_uga_locate_framebuffer(EFI_PCI_IO_PROTOCOL * pciio,uint64_t * addrp,uint64_t * sizep)221 efifb_uga_locate_framebuffer(EFI_PCI_IO_PROTOCOL *pciio, uint64_t *addrp,
222 uint64_t *sizep)
223 {
224 uint8_t *resattr;
225 uint64_t addr, size;
226 EFI_STATUS status;
227 u_int bar;
228
229 if (pciio == NULL)
230 return (EFI_DEVICE_ERROR);
231
232 /* Attempt to get the frame buffer address (imprecise). */
233 *addrp = 0;
234 *sizep = 0;
235 for (bar = 0; bar < 6; bar++) {
236 status = pciio->GetBarAttributes(pciio, bar, NULL,
237 (void **)&resattr);
238 if (status != EFI_SUCCESS)
239 continue;
240 /* XXX magic offsets and constants. */
241 if (resattr[0] == 0x87 && resattr[3] == 0) {
242 /* 32-bit address space descriptor (MEMIO) */
243 addr = le32dec(resattr + 10);
244 size = le32dec(resattr + 22);
245 } else if (resattr[0] == 0x8a && resattr[3] == 0) {
246 /* 64-bit address space descriptor (MEMIO) */
247 addr = le64dec(resattr + 14);
248 size = le64dec(resattr + 38);
249 } else {
250 addr = 0;
251 size = 0;
252 }
253 BS->FreePool(resattr);
254 if (addr == 0 || size == 0)
255 continue;
256
257 /* We assume the largest BAR is the frame buffer. */
258 if (size > *sizep) {
259 *addrp = addr;
260 *sizep = size;
261 }
262 }
263 return ((*addrp == 0 || *sizep == 0) ? EFI_DEVICE_ERROR : 0);
264 }
265
266 static int
efifb_from_uga(struct efi_fb * efifb,EFI_UGA_DRAW_PROTOCOL * uga)267 efifb_from_uga(struct efi_fb *efifb, EFI_UGA_DRAW_PROTOCOL *uga)
268 {
269 EFI_PCI_IO_PROTOCOL *pciio;
270 char *ev, *p;
271 EFI_STATUS status;
272 ssize_t offset;
273 uint64_t fbaddr, fbsize;
274 uint32_t horiz, vert, stride;
275 uint32_t np, depth, refresh;
276
277 status = uga->GetMode(uga, &horiz, &vert, &depth, &refresh);
278 if (EFI_ERROR(status))
279 return (1);
280 efifb->fb_height = vert;
281 efifb->fb_width = horiz;
282 /* Paranoia... */
283 if (efifb->fb_height == 0 || efifb->fb_width == 0)
284 return (1);
285
286 /* The color masks are fixed AFAICT. */
287 efifb_mask_from_pixfmt(efifb, PixelBlueGreenRedReserved8BitPerColor,
288 NULL);
289
290 /* pciio can be NULL on return! */
291 pciio = efifb_uga_get_pciio();
292
293 /* Try to find the frame buffer. */
294 status = efifb_uga_locate_framebuffer(pciio, &efifb->fb_addr,
295 &efifb->fb_size);
296 if (EFI_ERROR(status)) {
297 efifb->fb_addr = 0;
298 efifb->fb_size = 0;
299 }
300
301 /*
302 * There's no reliable way to detect the frame buffer or the
303 * offset within the frame buffer of the visible region, nor
304 * the stride. Our only option is to look at the system and
305 * fill in the blanks based on that. Luckily, UGA was mostly
306 * only used on Apple hardware.
307 */
308 offset = -1;
309 ev = getenv("smbios.system.maker");
310 if (ev != NULL && !strcmp(ev, "Apple Inc.")) {
311 ev = getenv("smbios.system.product");
312 if (ev != NULL && !strcmp(ev, "iMac7,1")) {
313 /* These are the expected values we should have. */
314 horiz = 1680;
315 vert = 1050;
316 fbaddr = 0xc0000000;
317 /* These are the missing bits. */
318 offset = 0x10000;
319 stride = 1728;
320 } else if (ev != NULL && !strcmp(ev, "MacBook3,1")) {
321 /* These are the expected values we should have. */
322 horiz = 1280;
323 vert = 800;
324 fbaddr = 0xc0000000;
325 /* These are the missing bits. */
326 offset = 0x0;
327 stride = 2048;
328 }
329 }
330
331 /*
332 * If this is hardware we know, make sure that it looks familiar
333 * before we accept our hardcoded values.
334 */
335 if (offset >= 0 && efifb->fb_width == horiz &&
336 efifb->fb_height == vert && efifb->fb_addr == fbaddr) {
337 efifb->fb_addr += offset;
338 efifb->fb_size -= offset;
339 efifb->fb_stride = stride;
340 return (0);
341 } else if (offset >= 0) {
342 printf("Hardware make/model known, but graphics not "
343 "as expected.\n");
344 printf("Console may not work!\n");
345 }
346
347 /*
348 * The stride is equal or larger to the width. Often it's the
349 * next larger power of two. We'll start with that...
350 */
351 efifb->fb_stride = efifb->fb_width;
352 do {
353 np = efifb->fb_stride & (efifb->fb_stride - 1);
354 if (np) {
355 efifb->fb_stride |= (np - 1);
356 efifb->fb_stride++;
357 }
358 } while (np);
359
360 ev = getenv("hw.efifb.address");
361 if (ev == NULL) {
362 if (efifb->fb_addr == 0) {
363 printf("Please set hw.efifb.address and "
364 "hw.efifb.stride.\n");
365 return (1);
366 }
367
368 /*
369 * The visible part of the frame buffer may not start at
370 * offset 0, so try to detect it. Note that we may not
371 * always be able to read from the frame buffer, which
372 * means that we may not be able to detect anything. In
373 * that case, we would take a long time scanning for a
374 * pixel change in the frame buffer, which would have it
375 * appear that we're hanging, so we limit the scan to
376 * 1/256th of the frame buffer. This number is mostly
377 * based on PR 202730 and the fact that on a MacBoook,
378 * where we can't read from the frame buffer the offset
379 * of the visible region is 0. In short: we want to scan
380 * enough to handle all adapters that have an offset
381 * larger than 0 and we want to scan as little as we can
382 * to not appear to hang when we can't read from the
383 * frame buffer.
384 */
385 offset = efifb_uga_find_pixel(uga, 0, pciio, efifb->fb_addr,
386 efifb->fb_size >> 8);
387 if (offset == -1) {
388 printf("Unable to reliably detect frame buffer.\n");
389 } else if (offset > 0) {
390 efifb->fb_addr += offset;
391 efifb->fb_size -= offset;
392 }
393 } else {
394 offset = 0;
395 efifb->fb_size = efifb->fb_height * efifb->fb_stride * 4;
396 efifb->fb_addr = strtoul(ev, &p, 0);
397 if (*p != '\0')
398 return (1);
399 }
400
401 ev = getenv("hw.efifb.stride");
402 if (ev == NULL) {
403 if (pciio != NULL && offset != -1) {
404 /* Determine the stride. */
405 offset = efifb_uga_find_pixel(uga, 1, pciio,
406 efifb->fb_addr, horiz * 8);
407 if (offset != -1)
408 efifb->fb_stride = offset >> 2;
409 } else {
410 printf("Unable to reliably detect the stride.\n");
411 }
412 } else {
413 efifb->fb_stride = strtoul(ev, &p, 0);
414 if (*p != '\0')
415 return (1);
416 }
417
418 /*
419 * We finalized on the stride, so recalculate the size of the
420 * frame buffer.
421 */
422 efifb->fb_size = efifb->fb_height * efifb->fb_stride * 4;
423 return (0);
424 }
425
426 int
efi_find_framebuffer(struct efi_fb * efifb)427 efi_find_framebuffer(struct efi_fb *efifb)
428 {
429 EFI_GRAPHICS_OUTPUT *gop;
430 EFI_UGA_DRAW_PROTOCOL *uga;
431 EFI_STATUS status;
432
433 status = BS->LocateProtocol(&gop_guid, NULL, (VOID **)&gop);
434 if (status == EFI_SUCCESS)
435 return (efifb_from_gop(efifb, gop->Mode, gop->Mode->Info));
436
437 status = BS->LocateProtocol(&uga_guid, NULL, (VOID **)&uga);
438 if (status == EFI_SUCCESS)
439 return (efifb_from_uga(efifb, uga));
440
441 return (1);
442 }
443
444 static void
print_efifb(int mode,struct efi_fb * efifb,int verbose)445 print_efifb(int mode, struct efi_fb *efifb, int verbose)
446 {
447 u_int depth;
448
449 if (mode >= 0)
450 printf("mode %d: ", mode);
451 depth = efifb_color_depth(efifb);
452 printf("%ux%ux%u, stride=%u", efifb->fb_width, efifb->fb_height,
453 depth, efifb->fb_stride);
454 if (verbose) {
455 printf("\n frame buffer: address=%jx, size=%jx",
456 (uintmax_t)efifb->fb_addr, (uintmax_t)efifb->fb_size);
457 printf("\n color mask: R=%08x, G=%08x, B=%08x\n",
458 efifb->fb_mask_red, efifb->fb_mask_green,
459 efifb->fb_mask_blue);
460 }
461 }
462
463 COMMAND_SET(gop, "gop", "graphics output protocol", command_gop);
464
465 static int
command_gop(int argc,char * argv[])466 command_gop(int argc, char *argv[])
467 {
468 struct efi_fb efifb;
469 EFI_GRAPHICS_OUTPUT *gop;
470 EFI_STATUS status;
471 u_int mode;
472
473 status = BS->LocateProtocol(&gop_guid, NULL, (VOID **)&gop);
474 if (EFI_ERROR(status)) {
475 sprintf(command_errbuf, "%s: Graphics Output Protocol not "
476 "present (error=%lu)", argv[0], EFI_ERROR_CODE(status));
477 return (CMD_ERROR);
478 }
479
480 if (argc < 2)
481 goto usage;
482
483 if (!strcmp(argv[1], "set")) {
484 char *cp;
485
486 if (argc != 3)
487 goto usage;
488 mode = strtol(argv[2], &cp, 0);
489 if (cp[0] != '\0') {
490 sprintf(command_errbuf, "mode is an integer");
491 return (CMD_ERROR);
492 }
493 status = gop->SetMode(gop, mode);
494 if (EFI_ERROR(status)) {
495 sprintf(command_errbuf, "%s: Unable to set mode to "
496 "%u (error=%lu)", argv[0], mode,
497 EFI_ERROR_CODE(status));
498 return (CMD_ERROR);
499 }
500 } else if (!strcmp(argv[1], "get")) {
501 if (argc != 2)
502 goto usage;
503 efifb_from_gop(&efifb, gop->Mode, gop->Mode->Info);
504 print_efifb(gop->Mode->Mode, &efifb, 1);
505 printf("\n");
506 } else if (!strcmp(argv[1], "list")) {
507 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *info;
508 UINTN infosz;
509
510 if (argc != 2)
511 goto usage;
512 pager_open();
513 for (mode = 0; mode < gop->Mode->MaxMode; mode++) {
514 status = gop->QueryMode(gop, mode, &infosz, &info);
515 if (EFI_ERROR(status))
516 continue;
517 efifb_from_gop(&efifb, gop->Mode, info);
518 print_efifb(mode, &efifb, 0);
519 if (pager_output("\n"))
520 break;
521 }
522 pager_close();
523 }
524 return (CMD_OK);
525
526 usage:
527 sprintf(command_errbuf, "usage: %s [list | get | set <mode>]",
528 argv[0]);
529 return (CMD_ERROR);
530 }
531
532 COMMAND_SET(uga, "uga", "universal graphics adapter", command_uga);
533
534 static int
command_uga(int argc,char * argv[])535 command_uga(int argc, char *argv[])
536 {
537 struct efi_fb efifb;
538 EFI_UGA_DRAW_PROTOCOL *uga;
539 EFI_STATUS status;
540
541 status = BS->LocateProtocol(&uga_guid, NULL, (VOID **)&uga);
542 if (EFI_ERROR(status)) {
543 sprintf(command_errbuf, "%s: UGA Protocol not present "
544 "(error=%lu)", argv[0], EFI_ERROR_CODE(status));
545 return (CMD_ERROR);
546 }
547
548 if (argc != 1)
549 goto usage;
550
551 if (efifb_from_uga(&efifb, uga) != CMD_OK) {
552 sprintf(command_errbuf, "%s: Unable to get UGA information",
553 argv[0]);
554 return (CMD_ERROR);
555 }
556
557 print_efifb(-1, &efifb, 1);
558 printf("\n");
559 return (CMD_OK);
560
561 usage:
562 sprintf(command_errbuf, "usage: %s", argv[0]);
563 return (CMD_ERROR);
564 }
565