2 * Copyright (c) 2013 The FreeBSD Foundation
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
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.
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
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <bootstrap.h>
33 #include <sys/endian.h>
40 #include <machine/metadata.h>
42 #include "framebuffer.h"
44 static EFI_GUID gop_guid
= EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID
;
45 static EFI_GUID pciio_guid
= EFI_PCI_IO_PROTOCOL_GUID
;
46 static EFI_GUID uga_guid
= EFI_UGA_DRAW_PROTOCOL_GUID
;
49 efifb_color_depth(struct efi_fb
*efifb
)
54 mask
= efifb
->fb_mask_red
| efifb
->fb_mask_green
|
55 efifb
->fb_mask_blue
| efifb
->fb_mask_reserved
;
58 for (depth
= 1; mask
!= 1; depth
++)
64 efifb_mask_from_pixfmt(struct efi_fb
*efifb
, EFI_GRAPHICS_PIXEL_FORMAT pixfmt
,
65 EFI_PIXEL_BITMASK
*pixinfo
)
71 case PixelRedGreenBlueReserved8BitPerColor
:
72 efifb
->fb_mask_red
= 0x000000ff;
73 efifb
->fb_mask_green
= 0x0000ff00;
74 efifb
->fb_mask_blue
= 0x00ff0000;
75 efifb
->fb_mask_reserved
= 0xff000000;
77 case PixelBlueGreenRedReserved8BitPerColor
:
78 efifb
->fb_mask_red
= 0x00ff0000;
79 efifb
->fb_mask_green
= 0x0000ff00;
80 efifb
->fb_mask_blue
= 0x000000ff;
81 efifb
->fb_mask_reserved
= 0xff000000;
84 efifb
->fb_mask_red
= pixinfo
->RedMask
;
85 efifb
->fb_mask_green
= pixinfo
->GreenMask
;
86 efifb
->fb_mask_blue
= pixinfo
->BlueMask
;
87 efifb
->fb_mask_reserved
= pixinfo
->ReservedMask
;
97 efifb_from_gop(struct efi_fb
*efifb
, EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE
*mode
,
98 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*info
)
102 efifb
->fb_addr
= mode
->FrameBufferBase
;
103 efifb
->fb_size
= mode
->FrameBufferSize
;
104 efifb
->fb_height
= info
->VerticalResolution
;
105 efifb
->fb_width
= info
->HorizontalResolution
;
106 efifb
->fb_stride
= info
->PixelsPerScanLine
;
107 result
= efifb_mask_from_pixfmt(efifb
, info
->PixelFormat
,
108 &info
->PixelInformation
);
113 efifb_uga_find_pixel(EFI_UGA_DRAW_PROTOCOL
*uga
, u_int line
,
114 EFI_PCI_IO_PROTOCOL
*pciio
, uint64_t addr
, uint64_t size
)
116 EFI_UGA_PIXEL pix0
, pix1
;
117 uint8_t *data1
, *data2
;
118 size_t count
, maxcount
= 1024;
123 status
= uga
->Blt(uga
, &pix0
, EfiUgaVideoToBltBuffer
,
124 0, line
, 0, 0, 1, 1, 0);
125 if (EFI_ERROR(status
)) {
126 printf("UGA BLT operation failed (video->buffer)");
129 pix1
.Red
= ~pix0
.Red
;
130 pix1
.Green
= ~pix0
.Green
;
131 pix1
.Blue
= ~pix0
.Blue
;
134 data1
= calloc(maxcount
, 2);
136 printf("Unable to allocate memory");
139 data2
= data1
+ maxcount
;
143 count
= min(size
, maxcount
);
145 status
= pciio
->Mem
.Read(pciio
, EfiPciIoWidthUint32
,
146 EFI_PCI_IO_PASS_THROUGH_BAR
, addr
+ ofs
, count
>> 2,
148 if (EFI_ERROR(status
)) {
149 printf("Error reading frame buffer (before)");
152 status
= uga
->Blt(uga
, &pix1
, EfiUgaBltBufferToVideo
,
153 0, 0, 0, line
, 1, 1, 0);
154 if (EFI_ERROR(status
)) {
155 printf("UGA BLT operation failed (modify)");
158 status
= pciio
->Mem
.Read(pciio
, EfiPciIoWidthUint32
,
159 EFI_PCI_IO_PASS_THROUGH_BAR
, addr
+ ofs
, count
>> 2,
161 if (EFI_ERROR(status
)) {
162 printf("Error reading frame buffer (after)");
165 status
= uga
->Blt(uga
, &pix0
, EfiUgaBltBufferToVideo
,
166 0, 0, 0, line
, 1, 1, 0);
167 if (EFI_ERROR(status
)) {
168 printf("UGA BLT operation failed (restore)");
171 for (idx
= 0; idx
< count
; idx
++) {
172 if (data1
[idx
] != data2
[idx
]) {
174 return (ofs
+ (idx
& ~3));
180 printf("No change detected in frame buffer");
183 printf(" -- error %lu\n", EFI_ERROR_CODE(status
));
188 static EFI_PCI_IO_PROTOCOL
*
189 efifb_uga_get_pciio(void)
191 EFI_PCI_IO_PROTOCOL
*pciio
;
192 EFI_HANDLE
*buf
, *hp
;
196 /* Get all handles that support the UGA protocol. */
198 status
= BS
->LocateHandle(ByProtocol
, &uga_guid
, NULL
, &bufsz
, NULL
);
199 if (status
!= EFI_BUFFER_TOO_SMALL
)
202 status
= BS
->LocateHandle(ByProtocol
, &uga_guid
, NULL
, &bufsz
, buf
);
203 if (status
!= EFI_SUCCESS
) {
207 bufsz
/= sizeof(EFI_HANDLE
);
209 /* Get the PCI I/O interface of the first handle that supports it. */
211 for (hp
= buf
; hp
< buf
+ bufsz
; hp
++) {
212 status
= BS
->HandleProtocol(*hp
, &pciio_guid
, (void **)&pciio
);
213 if (status
== EFI_SUCCESS
) {
223 efifb_uga_locate_framebuffer(EFI_PCI_IO_PROTOCOL
*pciio
, uint64_t *addrp
,
232 return (EFI_DEVICE_ERROR
);
234 /* Attempt to get the frame buffer address (imprecise). */
237 for (bar
= 0; bar
< 6; bar
++) {
238 status
= pciio
->GetBarAttributes(pciio
, bar
, NULL
,
240 if (status
!= EFI_SUCCESS
)
242 /* XXX magic offsets and constants. */
243 if (resattr
[0] == 0x87 && resattr
[3] == 0) {
244 /* 32-bit address space descriptor (MEMIO) */
245 addr
= le32dec(resattr
+ 10);
246 size
= le32dec(resattr
+ 22);
247 } else if (resattr
[0] == 0x8a && resattr
[3] == 0) {
248 /* 64-bit address space descriptor (MEMIO) */
249 addr
= le64dec(resattr
+ 14);
250 size
= le64dec(resattr
+ 38);
255 BS
->FreePool(resattr
);
256 if (addr
== 0 || size
== 0)
259 /* We assume the largest BAR is the frame buffer. */
265 return ((*addrp
== 0 || *sizep
== 0) ? EFI_DEVICE_ERROR
: 0);
269 efifb_from_uga(struct efi_fb
*efifb
, EFI_UGA_DRAW_PROTOCOL
*uga
)
271 EFI_PCI_IO_PROTOCOL
*pciio
;
276 uint32_t horiz
, vert
, stride
;
277 uint32_t np
, depth
, refresh
;
279 status
= uga
->GetMode(uga
, &horiz
, &vert
, &depth
, &refresh
);
280 if (EFI_ERROR(status
))
282 efifb
->fb_height
= vert
;
283 efifb
->fb_width
= horiz
;
285 if (efifb
->fb_height
== 0 || efifb
->fb_width
== 0)
288 /* The color masks are fixed AFAICT. */
289 efifb_mask_from_pixfmt(efifb
, PixelBlueGreenRedReserved8BitPerColor
,
292 /* pciio can be NULL on return! */
293 pciio
= efifb_uga_get_pciio();
295 /* Try to find the frame buffer. */
296 status
= efifb_uga_locate_framebuffer(pciio
, &efifb
->fb_addr
,
298 if (EFI_ERROR(status
)) {
304 * There's no reliable way to detect the frame buffer or the
305 * offset within the frame buffer of the visible region, nor
306 * the stride. Our only option is to look at the system and
307 * fill in the blanks based on that. Luckily, UGA was mostly
308 * only used on Apple hardware.
311 ev
= getenv("smbios.system.maker");
312 if (ev
!= NULL
&& !strcmp(ev
, "Apple Inc.")) {
313 ev
= getenv("smbios.system.product");
314 if (ev
!= NULL
&& !strcmp(ev
, "iMac7,1")) {
315 /* These are the expected values we should have. */
319 /* These are the missing bits. */
322 } else if (ev
!= NULL
&& !strcmp(ev
, "MacBook3,1")) {
323 /* These are the expected values we should have. */
327 /* These are the missing bits. */
334 * If this is hardware we know, make sure that it looks familiar
335 * before we accept our hardcoded values.
337 if (offset
>= 0 && efifb
->fb_width
== horiz
&&
338 efifb
->fb_height
== vert
&& efifb
->fb_addr
== fbaddr
) {
339 efifb
->fb_addr
+= offset
;
340 efifb
->fb_size
-= offset
;
341 efifb
->fb_stride
= stride
;
343 } else if (offset
>= 0) {
344 printf("Hardware make/model known, but graphics not "
346 printf("Console may not work!\n");
350 * The stride is equal or larger to the width. Often it's the
351 * next larger power of two. We'll start with that...
353 efifb
->fb_stride
= efifb
->fb_width
;
355 np
= efifb
->fb_stride
& (efifb
->fb_stride
- 1);
357 efifb
->fb_stride
|= (np
- 1);
362 ev
= getenv("hw.efifb.address");
364 if (efifb
->fb_addr
== 0) {
365 printf("Please set hw.efifb.address and "
366 "hw.efifb.stride.\n");
371 * The visible part of the frame buffer may not start at
372 * offset 0, so try to detect it. Note that we may not
373 * always be able to read from the frame buffer, which
374 * means that we may not be able to detect anything. In
375 * that case, we would take a long time scanning for a
376 * pixel change in the frame buffer, which would have it
377 * appear that we're hanging, so we limit the scan to
378 * 1/256th of the frame buffer. This number is mostly
379 * based on PR 202730 and the fact that on a MacBoook,
380 * where we can't read from the frame buffer the offset
381 * of the visible region is 0. In short: we want to scan
382 * enough to handle all adapters that have an offset
383 * larger than 0 and we want to scan as little as we can
384 * to not appear to hang when we can't read from the
387 offset
= efifb_uga_find_pixel(uga
, 0, pciio
, efifb
->fb_addr
,
388 efifb
->fb_size
>> 8);
390 printf("Unable to reliably detect frame buffer.\n");
391 } else if (offset
> 0) {
392 efifb
->fb_addr
+= offset
;
393 efifb
->fb_size
-= offset
;
397 efifb
->fb_size
= efifb
->fb_height
* efifb
->fb_stride
* 4;
398 efifb
->fb_addr
= strtoul(ev
, &p
, 0);
403 ev
= getenv("hw.efifb.stride");
405 if (pciio
!= NULL
&& offset
!= -1) {
406 /* Determine the stride. */
407 offset
= efifb_uga_find_pixel(uga
, 1, pciio
,
408 efifb
->fb_addr
, horiz
* 8);
410 efifb
->fb_stride
= offset
>> 2;
412 printf("Unable to reliably detect the stride.\n");
415 efifb
->fb_stride
= strtoul(ev
, &p
, 0);
421 * We finalized on the stride, so recalculate the size of the
424 efifb
->fb_size
= efifb
->fb_height
* efifb
->fb_stride
* 4;
429 efi_find_framebuffer(struct efi_fb
*efifb
)
431 EFI_GRAPHICS_OUTPUT
*gop
;
432 EFI_UGA_DRAW_PROTOCOL
*uga
;
435 status
= BS
->LocateProtocol(&gop_guid
, NULL
, (VOID
**)&gop
);
436 if (status
== EFI_SUCCESS
)
437 return (efifb_from_gop(efifb
, gop
->Mode
, gop
->Mode
->Info
));
439 status
= BS
->LocateProtocol(&uga_guid
, NULL
, (VOID
**)&uga
);
440 if (status
== EFI_SUCCESS
)
441 return (efifb_from_uga(efifb
, uga
));
447 print_efifb(int mode
, struct efi_fb
*efifb
, int verbose
)
452 printf("mode %d: ", mode
);
453 depth
= efifb_color_depth(efifb
);
454 printf("%ux%ux%u, stride=%u", efifb
->fb_width
, efifb
->fb_height
,
455 depth
, efifb
->fb_stride
);
457 printf("\n frame buffer: address=%jx, size=%jx",
458 (uintmax_t)efifb
->fb_addr
, (uintmax_t)efifb
->fb_size
);
459 printf("\n color mask: R=%08x, G=%08x, B=%08x\n",
460 efifb
->fb_mask_red
, efifb
->fb_mask_green
,
461 efifb
->fb_mask_blue
);
465 COMMAND_SET(gop
, "gop", "graphics output protocol", command_gop
);
468 command_gop(int argc
, char *argv
[])
471 EFI_GRAPHICS_OUTPUT
*gop
;
475 status
= BS
->LocateProtocol(&gop_guid
, NULL
, (VOID
**)&gop
);
476 if (EFI_ERROR(status
)) {
477 snprintf(command_errbuf
, sizeof (command_errbuf
),
478 "%s: Graphics Output Protocol not present (error=%lu)",
479 argv
[0], EFI_ERROR_CODE(status
));
486 if (!strcmp(argv
[1], "set")) {
491 mode
= strtol(argv
[2], &cp
, 0);
493 sprintf(command_errbuf
, "mode is an integer");
496 status
= gop
->SetMode(gop
, mode
);
497 if (EFI_ERROR(status
)) {
498 snprintf(command_errbuf
, sizeof (command_errbuf
),
499 "%s: Unable to set mode to %u (error=%lu)",
500 argv
[0], mode
, EFI_ERROR_CODE(status
));
503 } else if (!strcmp(argv
[1], "get")) {
506 efifb_from_gop(&efifb
, gop
->Mode
, gop
->Mode
->Info
);
507 print_efifb(gop
->Mode
->Mode
, &efifb
, 1);
509 } else if (!strcmp(argv
[1], "list")) {
510 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*info
;
516 for (mode
= 0; mode
< gop
->Mode
->MaxMode
; mode
++) {
517 status
= gop
->QueryMode(gop
, mode
, &infosz
, &info
);
518 if (EFI_ERROR(status
))
520 efifb_from_gop(&efifb
, gop
->Mode
, info
);
521 print_efifb(mode
, &efifb
, 0);
522 if (pager_output("\n"))
530 snprintf(command_errbuf
, sizeof (command_errbuf
),
531 "usage: %s [list | get | set <mode>]", argv
[0]);
535 COMMAND_SET(uga
, "uga", "universal graphics adapter", command_uga
);
538 command_uga(int argc
, char *argv
[])
541 EFI_UGA_DRAW_PROTOCOL
*uga
;
544 status
= BS
->LocateProtocol(&uga_guid
, NULL
, (VOID
**)&uga
);
545 if (EFI_ERROR(status
)) {
546 snprintf(command_errbuf
, sizeof (command_errbuf
),
547 "%s: UGA Protocol not present (error=%lu)",
548 argv
[0], EFI_ERROR_CODE(status
));
555 if (efifb_from_uga(&efifb
, uga
) != CMD_OK
) {
556 snprintf(command_errbuf
, sizeof (command_errbuf
),
557 "%s: Unable to get UGA information", argv
[0]);
561 print_efifb(-1, &efifb
, 1);
566 snprintf(command_errbuf
, sizeof (command_errbuf
), "usage: %s", argv
[0]);