xref: /OK3568_Linux_fs/kernel/drivers/firmware/efi/earlycon.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright (C) 2013 Intel Corporation; author Matt Fleming
4*4882a593Smuzhiyun  */
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun #include <linux/console.h>
7*4882a593Smuzhiyun #include <linux/efi.h>
8*4882a593Smuzhiyun #include <linux/font.h>
9*4882a593Smuzhiyun #include <linux/io.h>
10*4882a593Smuzhiyun #include <linux/kernel.h>
11*4882a593Smuzhiyun #include <linux/serial_core.h>
12*4882a593Smuzhiyun #include <linux/screen_info.h>
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #include <asm/early_ioremap.h>
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun static const struct console *earlycon_console __initdata;
17*4882a593Smuzhiyun static const struct font_desc *font;
18*4882a593Smuzhiyun static u32 efi_x, efi_y;
19*4882a593Smuzhiyun static u64 fb_base;
20*4882a593Smuzhiyun static bool fb_wb;
21*4882a593Smuzhiyun static void *efi_fb;
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun /*
24*4882a593Smuzhiyun  * EFI earlycon needs to use early_memremap() to map the framebuffer.
25*4882a593Smuzhiyun  * But early_memremap() is not usable for 'earlycon=efifb keep_bootcon',
26*4882a593Smuzhiyun  * memremap() should be used instead. memremap() will be available after
27*4882a593Smuzhiyun  * paging_init() which is earlier than initcall callbacks. Thus adding this
28*4882a593Smuzhiyun  * early initcall function early_efi_map_fb() to map the whole EFI framebuffer.
29*4882a593Smuzhiyun  */
efi_earlycon_remap_fb(void)30*4882a593Smuzhiyun static int __init efi_earlycon_remap_fb(void)
31*4882a593Smuzhiyun {
32*4882a593Smuzhiyun 	/* bail if there is no bootconsole or it has been disabled already */
33*4882a593Smuzhiyun 	if (!earlycon_console || !(earlycon_console->flags & CON_ENABLED))
34*4882a593Smuzhiyun 		return 0;
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun 	efi_fb = memremap(fb_base, screen_info.lfb_size,
37*4882a593Smuzhiyun 			  fb_wb ? MEMREMAP_WB : MEMREMAP_WC);
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun 	return efi_fb ? 0 : -ENOMEM;
40*4882a593Smuzhiyun }
41*4882a593Smuzhiyun early_initcall(efi_earlycon_remap_fb);
42*4882a593Smuzhiyun 
efi_earlycon_unmap_fb(void)43*4882a593Smuzhiyun static int __init efi_earlycon_unmap_fb(void)
44*4882a593Smuzhiyun {
45*4882a593Smuzhiyun 	/* unmap the bootconsole fb unless keep_bootcon has left it enabled */
46*4882a593Smuzhiyun 	if (efi_fb && !(earlycon_console->flags & CON_ENABLED))
47*4882a593Smuzhiyun 		memunmap(efi_fb);
48*4882a593Smuzhiyun 	return 0;
49*4882a593Smuzhiyun }
50*4882a593Smuzhiyun late_initcall(efi_earlycon_unmap_fb);
51*4882a593Smuzhiyun 
efi_earlycon_map(unsigned long start,unsigned long len)52*4882a593Smuzhiyun static __ref void *efi_earlycon_map(unsigned long start, unsigned long len)
53*4882a593Smuzhiyun {
54*4882a593Smuzhiyun 	pgprot_t fb_prot;
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun 	if (efi_fb)
57*4882a593Smuzhiyun 		return efi_fb + start;
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun 	fb_prot = fb_wb ? PAGE_KERNEL : pgprot_writecombine(PAGE_KERNEL);
60*4882a593Smuzhiyun 	return early_memremap_prot(fb_base + start, len, pgprot_val(fb_prot));
61*4882a593Smuzhiyun }
62*4882a593Smuzhiyun 
efi_earlycon_unmap(void * addr,unsigned long len)63*4882a593Smuzhiyun static __ref void efi_earlycon_unmap(void *addr, unsigned long len)
64*4882a593Smuzhiyun {
65*4882a593Smuzhiyun 	if (efi_fb)
66*4882a593Smuzhiyun 		return;
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun 	early_memunmap(addr, len);
69*4882a593Smuzhiyun }
70*4882a593Smuzhiyun 
efi_earlycon_clear_scanline(unsigned int y)71*4882a593Smuzhiyun static void efi_earlycon_clear_scanline(unsigned int y)
72*4882a593Smuzhiyun {
73*4882a593Smuzhiyun 	unsigned long *dst;
74*4882a593Smuzhiyun 	u16 len;
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun 	len = screen_info.lfb_linelength;
77*4882a593Smuzhiyun 	dst = efi_earlycon_map(y*len, len);
78*4882a593Smuzhiyun 	if (!dst)
79*4882a593Smuzhiyun 		return;
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun 	memset(dst, 0, len);
82*4882a593Smuzhiyun 	efi_earlycon_unmap(dst, len);
83*4882a593Smuzhiyun }
84*4882a593Smuzhiyun 
efi_earlycon_scroll_up(void)85*4882a593Smuzhiyun static void efi_earlycon_scroll_up(void)
86*4882a593Smuzhiyun {
87*4882a593Smuzhiyun 	unsigned long *dst, *src;
88*4882a593Smuzhiyun 	u16 len;
89*4882a593Smuzhiyun 	u32 i, height;
90*4882a593Smuzhiyun 
91*4882a593Smuzhiyun 	len = screen_info.lfb_linelength;
92*4882a593Smuzhiyun 	height = screen_info.lfb_height;
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun 	for (i = 0; i < height - font->height; i++) {
95*4882a593Smuzhiyun 		dst = efi_earlycon_map(i*len, len);
96*4882a593Smuzhiyun 		if (!dst)
97*4882a593Smuzhiyun 			return;
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun 		src = efi_earlycon_map((i + font->height) * len, len);
100*4882a593Smuzhiyun 		if (!src) {
101*4882a593Smuzhiyun 			efi_earlycon_unmap(dst, len);
102*4882a593Smuzhiyun 			return;
103*4882a593Smuzhiyun 		}
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun 		memmove(dst, src, len);
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun 		efi_earlycon_unmap(src, len);
108*4882a593Smuzhiyun 		efi_earlycon_unmap(dst, len);
109*4882a593Smuzhiyun 	}
110*4882a593Smuzhiyun }
111*4882a593Smuzhiyun 
efi_earlycon_write_char(u32 * dst,unsigned char c,unsigned int h)112*4882a593Smuzhiyun static void efi_earlycon_write_char(u32 *dst, unsigned char c, unsigned int h)
113*4882a593Smuzhiyun {
114*4882a593Smuzhiyun 	const u32 color_black = 0x00000000;
115*4882a593Smuzhiyun 	const u32 color_white = 0x00ffffff;
116*4882a593Smuzhiyun 	const u8 *src;
117*4882a593Smuzhiyun 	int m, n, bytes;
118*4882a593Smuzhiyun 	u8 x;
119*4882a593Smuzhiyun 
120*4882a593Smuzhiyun 	bytes = BITS_TO_BYTES(font->width);
121*4882a593Smuzhiyun 	src = font->data + c * font->height * bytes + h * bytes;
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun 	for (m = 0; m < font->width; m++) {
124*4882a593Smuzhiyun 		n = m % 8;
125*4882a593Smuzhiyun 		x = *(src + m / 8);
126*4882a593Smuzhiyun 		if ((x >> (7 - n)) & 1)
127*4882a593Smuzhiyun 			*dst = color_white;
128*4882a593Smuzhiyun 		else
129*4882a593Smuzhiyun 			*dst = color_black;
130*4882a593Smuzhiyun 		dst++;
131*4882a593Smuzhiyun 	}
132*4882a593Smuzhiyun }
133*4882a593Smuzhiyun 
134*4882a593Smuzhiyun static void
efi_earlycon_write(struct console * con,const char * str,unsigned int num)135*4882a593Smuzhiyun efi_earlycon_write(struct console *con, const char *str, unsigned int num)
136*4882a593Smuzhiyun {
137*4882a593Smuzhiyun 	struct screen_info *si;
138*4882a593Smuzhiyun 	unsigned int len;
139*4882a593Smuzhiyun 	const char *s;
140*4882a593Smuzhiyun 	void *dst;
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun 	si = &screen_info;
143*4882a593Smuzhiyun 	len = si->lfb_linelength;
144*4882a593Smuzhiyun 
145*4882a593Smuzhiyun 	while (num) {
146*4882a593Smuzhiyun 		unsigned int linemax;
147*4882a593Smuzhiyun 		unsigned int h, count = 0;
148*4882a593Smuzhiyun 
149*4882a593Smuzhiyun 		for (s = str; *s && *s != '\n'; s++) {
150*4882a593Smuzhiyun 			if (count == num)
151*4882a593Smuzhiyun 				break;
152*4882a593Smuzhiyun 			count++;
153*4882a593Smuzhiyun 		}
154*4882a593Smuzhiyun 
155*4882a593Smuzhiyun 		linemax = (si->lfb_width - efi_x) / font->width;
156*4882a593Smuzhiyun 		if (count > linemax)
157*4882a593Smuzhiyun 			count = linemax;
158*4882a593Smuzhiyun 
159*4882a593Smuzhiyun 		for (h = 0; h < font->height; h++) {
160*4882a593Smuzhiyun 			unsigned int n, x;
161*4882a593Smuzhiyun 
162*4882a593Smuzhiyun 			dst = efi_earlycon_map((efi_y + h) * len, len);
163*4882a593Smuzhiyun 			if (!dst)
164*4882a593Smuzhiyun 				return;
165*4882a593Smuzhiyun 
166*4882a593Smuzhiyun 			s = str;
167*4882a593Smuzhiyun 			n = count;
168*4882a593Smuzhiyun 			x = efi_x;
169*4882a593Smuzhiyun 
170*4882a593Smuzhiyun 			while (n-- > 0) {
171*4882a593Smuzhiyun 				efi_earlycon_write_char(dst + x*4, *s, h);
172*4882a593Smuzhiyun 				x += font->width;
173*4882a593Smuzhiyun 				s++;
174*4882a593Smuzhiyun 			}
175*4882a593Smuzhiyun 
176*4882a593Smuzhiyun 			efi_earlycon_unmap(dst, len);
177*4882a593Smuzhiyun 		}
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun 		num -= count;
180*4882a593Smuzhiyun 		efi_x += count * font->width;
181*4882a593Smuzhiyun 		str += count;
182*4882a593Smuzhiyun 
183*4882a593Smuzhiyun 		if (num > 0 && *s == '\n') {
184*4882a593Smuzhiyun 			efi_x = 0;
185*4882a593Smuzhiyun 			efi_y += font->height;
186*4882a593Smuzhiyun 			str++;
187*4882a593Smuzhiyun 			num--;
188*4882a593Smuzhiyun 		}
189*4882a593Smuzhiyun 
190*4882a593Smuzhiyun 		if (efi_x + font->width > si->lfb_width) {
191*4882a593Smuzhiyun 			efi_x = 0;
192*4882a593Smuzhiyun 			efi_y += font->height;
193*4882a593Smuzhiyun 		}
194*4882a593Smuzhiyun 
195*4882a593Smuzhiyun 		if (efi_y + font->height > si->lfb_height) {
196*4882a593Smuzhiyun 			u32 i;
197*4882a593Smuzhiyun 
198*4882a593Smuzhiyun 			efi_y -= font->height;
199*4882a593Smuzhiyun 			efi_earlycon_scroll_up();
200*4882a593Smuzhiyun 
201*4882a593Smuzhiyun 			for (i = 0; i < font->height; i++)
202*4882a593Smuzhiyun 				efi_earlycon_clear_scanline(efi_y + i);
203*4882a593Smuzhiyun 		}
204*4882a593Smuzhiyun 	}
205*4882a593Smuzhiyun }
206*4882a593Smuzhiyun 
efi_earlycon_setup(struct earlycon_device * device,const char * opt)207*4882a593Smuzhiyun static int __init efi_earlycon_setup(struct earlycon_device *device,
208*4882a593Smuzhiyun 				     const char *opt)
209*4882a593Smuzhiyun {
210*4882a593Smuzhiyun 	struct screen_info *si;
211*4882a593Smuzhiyun 	u16 xres, yres;
212*4882a593Smuzhiyun 	u32 i;
213*4882a593Smuzhiyun 
214*4882a593Smuzhiyun 	if (screen_info.orig_video_isVGA != VIDEO_TYPE_EFI)
215*4882a593Smuzhiyun 		return -ENODEV;
216*4882a593Smuzhiyun 
217*4882a593Smuzhiyun 	fb_base = screen_info.lfb_base;
218*4882a593Smuzhiyun 	if (screen_info.capabilities & VIDEO_CAPABILITY_64BIT_BASE)
219*4882a593Smuzhiyun 		fb_base |= (u64)screen_info.ext_lfb_base << 32;
220*4882a593Smuzhiyun 
221*4882a593Smuzhiyun 	fb_wb = opt && !strcmp(opt, "ram");
222*4882a593Smuzhiyun 
223*4882a593Smuzhiyun 	si = &screen_info;
224*4882a593Smuzhiyun 	xres = si->lfb_width;
225*4882a593Smuzhiyun 	yres = si->lfb_height;
226*4882a593Smuzhiyun 
227*4882a593Smuzhiyun 	/*
228*4882a593Smuzhiyun 	 * efi_earlycon_write_char() implicitly assumes a framebuffer with
229*4882a593Smuzhiyun 	 * 32 bits per pixel.
230*4882a593Smuzhiyun 	 */
231*4882a593Smuzhiyun 	if (si->lfb_depth != 32)
232*4882a593Smuzhiyun 		return -ENODEV;
233*4882a593Smuzhiyun 
234*4882a593Smuzhiyun 	font = get_default_font(xres, yres, -1, -1);
235*4882a593Smuzhiyun 	if (!font)
236*4882a593Smuzhiyun 		return -ENODEV;
237*4882a593Smuzhiyun 
238*4882a593Smuzhiyun 	efi_y = rounddown(yres, font->height) - font->height;
239*4882a593Smuzhiyun 	for (i = 0; i < (yres - efi_y) / font->height; i++)
240*4882a593Smuzhiyun 		efi_earlycon_scroll_up();
241*4882a593Smuzhiyun 
242*4882a593Smuzhiyun 	device->con->write = efi_earlycon_write;
243*4882a593Smuzhiyun 	earlycon_console = device->con;
244*4882a593Smuzhiyun 	return 0;
245*4882a593Smuzhiyun }
246*4882a593Smuzhiyun EARLYCON_DECLARE(efifb, efi_earlycon_setup);
247