xref: /openbmc/linux/drivers/firmware/efi/libstub/gop.c (revision 2fcdad2a)
1 // SPDX-License-Identifier: GPL-2.0
2 /* -----------------------------------------------------------------------
3  *
4  *   Copyright 2011 Intel Corporation; author Matt Fleming
5  *
6  * ----------------------------------------------------------------------- */
7 
8 #include <linux/efi.h>
9 #include <linux/screen_info.h>
10 #include <asm/efi.h>
11 #include <asm/setup.h>
12 
13 #include "efistub.h"
14 
15 static void find_bits(unsigned long mask, u8 *pos, u8 *size)
16 {
17 	u8 first, len;
18 
19 	first = 0;
20 	len = 0;
21 
22 	if (mask) {
23 		while (!(mask & 0x1)) {
24 			mask = mask >> 1;
25 			first++;
26 		}
27 
28 		while (mask & 0x1) {
29 			mask = mask >> 1;
30 			len++;
31 		}
32 	}
33 
34 	*pos = first;
35 	*size = len;
36 }
37 
38 static void
39 setup_pixel_info(struct screen_info *si, u32 pixels_per_scan_line,
40 		 efi_pixel_bitmask_t pixel_info, int pixel_format)
41 {
42 	if (pixel_format == PIXEL_RGB_RESERVED_8BIT_PER_COLOR) {
43 		si->lfb_depth = 32;
44 		si->lfb_linelength = pixels_per_scan_line * 4;
45 		si->red_size = 8;
46 		si->red_pos = 0;
47 		si->green_size = 8;
48 		si->green_pos = 8;
49 		si->blue_size = 8;
50 		si->blue_pos = 16;
51 		si->rsvd_size = 8;
52 		si->rsvd_pos = 24;
53 	} else if (pixel_format == PIXEL_BGR_RESERVED_8BIT_PER_COLOR) {
54 		si->lfb_depth = 32;
55 		si->lfb_linelength = pixels_per_scan_line * 4;
56 		si->red_size = 8;
57 		si->red_pos = 16;
58 		si->green_size = 8;
59 		si->green_pos = 8;
60 		si->blue_size = 8;
61 		si->blue_pos = 0;
62 		si->rsvd_size = 8;
63 		si->rsvd_pos = 24;
64 	} else if (pixel_format == PIXEL_BIT_MASK) {
65 		find_bits(pixel_info.red_mask, &si->red_pos, &si->red_size);
66 		find_bits(pixel_info.green_mask, &si->green_pos,
67 			  &si->green_size);
68 		find_bits(pixel_info.blue_mask, &si->blue_pos, &si->blue_size);
69 		find_bits(pixel_info.reserved_mask, &si->rsvd_pos,
70 			  &si->rsvd_size);
71 		si->lfb_depth = si->red_size + si->green_size +
72 			si->blue_size + si->rsvd_size;
73 		si->lfb_linelength = (pixels_per_scan_line * si->lfb_depth) / 8;
74 	} else {
75 		si->lfb_depth = 4;
76 		si->lfb_linelength = si->lfb_width / 2;
77 		si->red_size = 0;
78 		si->red_pos = 0;
79 		si->green_size = 0;
80 		si->green_pos = 0;
81 		si->blue_size = 0;
82 		si->blue_pos = 0;
83 		si->rsvd_size = 0;
84 		si->rsvd_pos = 0;
85 	}
86 }
87 
88 #define efi_gop_attr(table, attr, instance) \
89 	(efi_table_attr(efi_graphics_output_protocol##table, attr, instance))
90 
91 static efi_status_t
92 setup_gop(efi_system_table_t *sys_table_arg, struct screen_info *si,
93 	  efi_guid_t *proto, unsigned long size, void **handles)
94 {
95 	efi_graphics_output_protocol_t *gop, *first_gop;
96 	u16 width, height;
97 	u32 pixels_per_scan_line;
98 	u32 ext_lfb_base;
99 	efi_physical_addr_t fb_base;
100 	efi_pixel_bitmask_t pixel_info;
101 	int pixel_format;
102 	efi_status_t status;
103 	efi_handle_t h;
104 	int i;
105 
106 	first_gop = NULL;
107 	gop = NULL;
108 
109 	for_each_efi_handle(h, handles, size, i) {
110 		efi_graphics_output_protocol_mode_t *mode;
111 		efi_graphics_output_mode_info_t *info = NULL;
112 		efi_guid_t conout_proto = EFI_CONSOLE_OUT_DEVICE_GUID;
113 		bool conout_found = false;
114 		void *dummy = NULL;
115 		efi_physical_addr_t current_fb_base;
116 
117 		status = efi_call_early(handle_protocol, h,
118 					proto, (void **)&gop);
119 		if (status != EFI_SUCCESS)
120 			continue;
121 
122 		status = efi_call_early(handle_protocol, h,
123 					&conout_proto, &dummy);
124 		if (status == EFI_SUCCESS)
125 			conout_found = true;
126 
127 		mode = (void *)(unsigned long)efi_gop_attr(, mode, gop);
128 		info = (void *)(unsigned long)efi_gop_attr(_mode, info, mode);
129 		current_fb_base = efi_gop_attr(_mode, frame_buffer_base, mode);
130 
131 		if ((!first_gop || conout_found) &&
132 		    info->pixel_format != PIXEL_BLT_ONLY) {
133 			/*
134 			 * Systems that use the UEFI Console Splitter may
135 			 * provide multiple GOP devices, not all of which are
136 			 * backed by real hardware. The workaround is to search
137 			 * for a GOP implementing the ConOut protocol, and if
138 			 * one isn't found, to just fall back to the first GOP.
139 			 */
140 			width = info->horizontal_resolution;
141 			height = info->vertical_resolution;
142 			pixel_format = info->pixel_format;
143 			pixel_info = info->pixel_information;
144 			pixels_per_scan_line = info->pixels_per_scan_line;
145 			fb_base = current_fb_base;
146 
147 			/*
148 			 * Once we've found a GOP supporting ConOut,
149 			 * don't bother looking any further.
150 			 */
151 			first_gop = gop;
152 			if (conout_found)
153 				break;
154 		}
155 	}
156 
157 	/* Did we find any GOPs? */
158 	if (!first_gop)
159 		return EFI_NOT_FOUND;
160 
161 	/* EFI framebuffer */
162 	si->orig_video_isVGA = VIDEO_TYPE_EFI;
163 
164 	si->lfb_width = width;
165 	si->lfb_height = height;
166 	si->lfb_base = fb_base;
167 
168 	ext_lfb_base = (u64)(unsigned long)fb_base >> 32;
169 	if (ext_lfb_base) {
170 		si->capabilities |= VIDEO_CAPABILITY_64BIT_BASE;
171 		si->ext_lfb_base = ext_lfb_base;
172 	}
173 
174 	si->pages = 1;
175 
176 	setup_pixel_info(si, pixels_per_scan_line, pixel_info, pixel_format);
177 
178 	si->lfb_size = si->lfb_linelength * si->lfb_height;
179 
180 	si->capabilities |= VIDEO_CAPABILITY_SKIP_QUIRKS;
181 
182 	return EFI_SUCCESS;
183 }
184 
185 /*
186  * See if we have Graphics Output Protocol
187  */
188 efi_status_t efi_setup_gop(efi_system_table_t *sys_table_arg,
189 			   struct screen_info *si, efi_guid_t *proto,
190 			   unsigned long size)
191 {
192 	efi_status_t status;
193 	void **gop_handle = NULL;
194 
195 	status = efi_call_early(allocate_pool, EFI_LOADER_DATA,
196 				size, (void **)&gop_handle);
197 	if (status != EFI_SUCCESS)
198 		return status;
199 
200 	status = efi_call_early(locate_handle,
201 				EFI_LOCATE_BY_PROTOCOL,
202 				proto, NULL, &size, gop_handle);
203 	if (status != EFI_SUCCESS)
204 		goto free_handle;
205 
206 	status = setup_gop(sys_table_arg, si, proto, size, gop_handle);
207 
208 free_handle:
209 	efi_call_early(free_pool, gop_handle);
210 	return status;
211 }
212