xref: /openbmc/u-boot/drivers/pci/pci_rom.c (revision e895e996)
1 /*
2  * Copyright (C) 2014 Google, Inc
3  *
4  * From coreboot, originally based on the Linux kernel (drivers/pci/pci.c).
5  *
6  * Modifications are:
7  * Copyright (C) 2003-2004 Linux Networx
8  * (Written by Eric Biederman <ebiederman@lnxi.com> for Linux Networx)
9  * Copyright (C) 2003-2006 Ronald G. Minnich <rminnich@gmail.com>
10  * Copyright (C) 2004-2005 Li-Ta Lo <ollie@lanl.gov>
11  * Copyright (C) 2005-2006 Tyan
12  * (Written by Yinghai Lu <yhlu@tyan.com> for Tyan)
13  * Copyright (C) 2005-2009 coresystems GmbH
14  * (Written by Stefan Reinauer <stepan@coresystems.de> for coresystems GmbH)
15  *
16  * PCI Bus Services, see include/linux/pci.h for further explanation.
17  *
18  * Copyright 1993 -- 1997 Drew Eckhardt, Frederic Potter,
19  * David Mosberger-Tang
20  *
21  * Copyright 1997 -- 1999 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
22 
23  * SPDX-License-Identifier:	GPL-2.0
24  */
25 
26 #include <common.h>
27 #include <bios_emul.h>
28 #include <dm.h>
29 #include <errno.h>
30 #include <malloc.h>
31 #include <pci.h>
32 #include <pci_rom.h>
33 #include <vbe.h>
34 #include <video.h>
35 #include <video_fb.h>
36 #include <linux/screen_info.h>
37 
38 #ifdef CONFIG_X86
39 #include <asm/acpi_s3.h>
40 DECLARE_GLOBAL_DATA_PTR;
41 #endif
42 
43 __weak bool board_should_run_oprom(struct udevice *dev)
44 {
45 #if defined(CONFIG_X86) && defined(CONFIG_HAVE_ACPI_RESUME)
46 	if (gd->arch.prev_sleep_state == ACPI_S3) {
47 		if (IS_ENABLED(CONFIG_S3_VGA_ROM_RUN))
48 			return true;
49 		else
50 			return false;
51 	}
52 #endif
53 
54 	return true;
55 }
56 
57 __weak bool board_should_load_oprom(struct udevice *dev)
58 {
59 	return true;
60 }
61 
62 __weak uint32_t board_map_oprom_vendev(uint32_t vendev)
63 {
64 	return vendev;
65 }
66 
67 static int pci_rom_probe(struct udevice *dev, struct pci_rom_header **hdrp)
68 {
69 	struct pci_child_platdata *pplat = dev_get_parent_platdata(dev);
70 	struct pci_rom_header *rom_header;
71 	struct pci_rom_data *rom_data;
72 	u16 rom_vendor, rom_device;
73 	u32 rom_class;
74 	u32 vendev;
75 	u32 mapped_vendev;
76 	u32 rom_address;
77 
78 	vendev = pplat->vendor << 16 | pplat->device;
79 	mapped_vendev = board_map_oprom_vendev(vendev);
80 	if (vendev != mapped_vendev)
81 		debug("Device ID mapped to %#08x\n", mapped_vendev);
82 
83 #ifdef CONFIG_VGA_BIOS_ADDR
84 	rom_address = CONFIG_VGA_BIOS_ADDR;
85 #else
86 
87 	dm_pci_read_config32(dev, PCI_ROM_ADDRESS, &rom_address);
88 	if (rom_address == 0x00000000 || rom_address == 0xffffffff) {
89 		debug("%s: rom_address=%x\n", __func__, rom_address);
90 		return -ENOENT;
91 	}
92 
93 	/* Enable expansion ROM address decoding. */
94 	dm_pci_write_config32(dev, PCI_ROM_ADDRESS,
95 			      rom_address | PCI_ROM_ADDRESS_ENABLE);
96 #endif
97 	debug("Option ROM address %x\n", rom_address);
98 	rom_header = (struct pci_rom_header *)(unsigned long)rom_address;
99 
100 	debug("PCI expansion ROM, signature %#04x, INIT size %#04x, data ptr %#04x\n",
101 	      le16_to_cpu(rom_header->signature),
102 	      rom_header->size * 512, le16_to_cpu(rom_header->data));
103 
104 	if (le16_to_cpu(rom_header->signature) != PCI_ROM_HDR) {
105 		printf("Incorrect expansion ROM header signature %04x\n",
106 		       le16_to_cpu(rom_header->signature));
107 #ifndef CONFIG_VGA_BIOS_ADDR
108 		/* Disable expansion ROM address decoding */
109 		dm_pci_write_config32(dev, PCI_ROM_ADDRESS, rom_address);
110 #endif
111 		return -EINVAL;
112 	}
113 
114 	rom_data = (((void *)rom_header) + le16_to_cpu(rom_header->data));
115 	rom_vendor = le16_to_cpu(rom_data->vendor);
116 	rom_device = le16_to_cpu(rom_data->device);
117 
118 	debug("PCI ROM image, vendor ID %04x, device ID %04x,\n",
119 	      rom_vendor, rom_device);
120 
121 	/* If the device id is mapped, a mismatch is expected */
122 	if ((pplat->vendor != rom_vendor || pplat->device != rom_device) &&
123 	    (vendev == mapped_vendev)) {
124 		printf("ID mismatch: vendor ID %04x, device ID %04x\n",
125 		       rom_vendor, rom_device);
126 		/* Continue anyway */
127 	}
128 
129 	rom_class = (le16_to_cpu(rom_data->class_hi) << 8) | rom_data->class_lo;
130 	debug("PCI ROM image, Class Code %06x, Code Type %02x\n",
131 	      rom_class, rom_data->type);
132 
133 	if (pplat->class != rom_class) {
134 		debug("Class Code mismatch ROM %06x, dev %06x\n",
135 		      rom_class, pplat->class);
136 	}
137 	*hdrp = rom_header;
138 
139 	return 0;
140 }
141 
142 /**
143  * pci_rom_load() - Load a ROM image and return a pointer to it
144  *
145  * @rom_header:		Pointer to ROM image
146  * @ram_headerp:	Returns a pointer to the image in RAM
147  * @allocedp:		Returns true if @ram_headerp was allocated and needs
148  *			to be freed
149  * @return 0 if OK, -ve on error. Note that @allocedp is set up regardless of
150  * the error state. Even if this function returns an error, it may have
151  * allocated memory.
152  */
153 static int pci_rom_load(struct pci_rom_header *rom_header,
154 			struct pci_rom_header **ram_headerp, bool *allocedp)
155 {
156 	struct pci_rom_data *rom_data;
157 	unsigned int rom_size;
158 	unsigned int image_size = 0;
159 	void *target;
160 
161 	*allocedp = false;
162 	do {
163 		/* Get next image, until we see an x86 version */
164 		rom_header = (struct pci_rom_header *)((void *)rom_header +
165 							    image_size);
166 
167 		rom_data = (struct pci_rom_data *)((void *)rom_header +
168 				le16_to_cpu(rom_header->data));
169 
170 		image_size = le16_to_cpu(rom_data->ilen) * 512;
171 	} while ((rom_data->type != 0) && (rom_data->indicator == 0));
172 
173 	if (rom_data->type != 0)
174 		return -EACCES;
175 
176 	rom_size = rom_header->size * 512;
177 
178 #ifdef PCI_VGA_RAM_IMAGE_START
179 	target = (void *)PCI_VGA_RAM_IMAGE_START;
180 #else
181 	target = (void *)malloc(rom_size);
182 	if (!target)
183 		return -ENOMEM;
184 	*allocedp = true;
185 #endif
186 	if (target != rom_header) {
187 		ulong start = get_timer(0);
188 
189 		debug("Copying VGA ROM Image from %p to %p, 0x%x bytes\n",
190 		      rom_header, target, rom_size);
191 		memcpy(target, rom_header, rom_size);
192 		if (memcmp(target, rom_header, rom_size)) {
193 			printf("VGA ROM copy failed\n");
194 			return -EFAULT;
195 		}
196 		debug("Copy took %lums\n", get_timer(start));
197 	}
198 	*ram_headerp = target;
199 
200 	return 0;
201 }
202 
203 struct vbe_mode_info mode_info;
204 
205 void setup_video(struct screen_info *screen_info)
206 {
207 	struct vesa_mode_info *vesa = &mode_info.vesa;
208 
209 	/* Sanity test on VESA parameters */
210 	if (!vesa->x_resolution || !vesa->y_resolution)
211 		return;
212 
213 	screen_info->orig_video_isVGA = VIDEO_TYPE_VLFB;
214 
215 	screen_info->lfb_width = vesa->x_resolution;
216 	screen_info->lfb_height = vesa->y_resolution;
217 	screen_info->lfb_depth = vesa->bits_per_pixel;
218 	screen_info->lfb_linelength = vesa->bytes_per_scanline;
219 	screen_info->lfb_base = vesa->phys_base_ptr;
220 	screen_info->lfb_size =
221 		ALIGN(screen_info->lfb_linelength * screen_info->lfb_height,
222 		      65536);
223 	screen_info->lfb_size >>= 16;
224 	screen_info->red_size = vesa->red_mask_size;
225 	screen_info->red_pos = vesa->red_mask_pos;
226 	screen_info->green_size = vesa->green_mask_size;
227 	screen_info->green_pos = vesa->green_mask_pos;
228 	screen_info->blue_size = vesa->blue_mask_size;
229 	screen_info->blue_pos = vesa->blue_mask_pos;
230 	screen_info->rsvd_size = vesa->reserved_mask_size;
231 	screen_info->rsvd_pos = vesa->reserved_mask_pos;
232 }
233 
234 int dm_pci_run_vga_bios(struct udevice *dev, int (*int15_handler)(void),
235 			int exec_method)
236 {
237 	struct pci_child_platdata *pplat = dev_get_parent_platdata(dev);
238 	struct pci_rom_header *rom = NULL, *ram = NULL;
239 	int vesa_mode = -1;
240 	bool emulate, alloced;
241 	int ret;
242 
243 	/* Only execute VGA ROMs */
244 	if (((pplat->class >> 8) ^ PCI_CLASS_DISPLAY_VGA) & 0xff00) {
245 		debug("%s: Class %#x, should be %#x\n", __func__, pplat->class,
246 		      PCI_CLASS_DISPLAY_VGA);
247 		return -ENODEV;
248 	}
249 
250 	if (!board_should_load_oprom(dev))
251 		return -ENXIO;
252 
253 	ret = pci_rom_probe(dev, &rom);
254 	if (ret)
255 		return ret;
256 
257 	ret = pci_rom_load(rom, &ram, &alloced);
258 	if (ret)
259 		goto err;
260 
261 	if (!board_should_run_oprom(dev)) {
262 		ret = -ENXIO;
263 		goto err;
264 	}
265 
266 #if defined(CONFIG_FRAMEBUFFER_SET_VESA_MODE) && \
267 		defined(CONFIG_FRAMEBUFFER_VESA_MODE)
268 	vesa_mode = CONFIG_FRAMEBUFFER_VESA_MODE;
269 #endif
270 	debug("Selected vesa mode %#x\n", vesa_mode);
271 
272 	if (exec_method & PCI_ROM_USE_NATIVE) {
273 #ifdef CONFIG_X86
274 		emulate = false;
275 #else
276 		if (!(exec_method & PCI_ROM_ALLOW_FALLBACK)) {
277 			printf("BIOS native execution is only available on x86\n");
278 			ret = -ENOSYS;
279 			goto err;
280 		}
281 		emulate = true;
282 #endif
283 	} else {
284 #ifdef CONFIG_BIOSEMU
285 		emulate = true;
286 #else
287 		if (!(exec_method & PCI_ROM_ALLOW_FALLBACK)) {
288 			printf("BIOS emulation not available - see CONFIG_BIOSEMU\n");
289 			ret = -ENOSYS;
290 			goto err;
291 		}
292 		emulate = false;
293 #endif
294 	}
295 
296 	if (emulate) {
297 #ifdef CONFIG_BIOSEMU
298 		BE_VGAInfo *info;
299 
300 		ret = biosemu_setup(dev, &info);
301 		if (ret)
302 			goto err;
303 		biosemu_set_interrupt_handler(0x15, int15_handler);
304 		ret = biosemu_run(dev, (uchar *)ram, 1 << 16, info,
305 				  true, vesa_mode, &mode_info);
306 		if (ret)
307 			goto err;
308 #endif
309 	} else {
310 #if defined(CONFIG_X86) && CONFIG_IS_ENABLED(X86_32BIT_INIT)
311 		bios_set_interrupt_handler(0x15, int15_handler);
312 
313 		bios_run_on_x86(dev, (unsigned long)ram, vesa_mode,
314 				&mode_info);
315 #endif
316 	}
317 	debug("Final vesa mode %#x\n", mode_info.video_mode);
318 	ret = 0;
319 
320 err:
321 	if (alloced)
322 		free(ram);
323 	return ret;
324 }
325 
326 #ifdef CONFIG_DM_VIDEO
327 int vbe_setup_video_priv(struct vesa_mode_info *vesa,
328 			 struct video_priv *uc_priv,
329 			 struct video_uc_platdata *plat)
330 {
331 	if (!vesa->x_resolution)
332 		return -ENXIO;
333 	uc_priv->xsize = vesa->x_resolution;
334 	uc_priv->ysize = vesa->y_resolution;
335 	switch (vesa->bits_per_pixel) {
336 	case 32:
337 	case 24:
338 		uc_priv->bpix = VIDEO_BPP32;
339 		break;
340 	case 16:
341 		uc_priv->bpix = VIDEO_BPP16;
342 		break;
343 	default:
344 		return -EPROTONOSUPPORT;
345 	}
346 	plat->base = vesa->phys_base_ptr;
347 	plat->size = vesa->bytes_per_scanline * vesa->y_resolution;
348 
349 	return 0;
350 }
351 
352 int vbe_setup_video(struct udevice *dev, int (*int15_handler)(void))
353 {
354 	struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
355 	struct video_priv *uc_priv = dev_get_uclass_priv(dev);
356 	int ret;
357 
358 	printf("Video: ");
359 
360 	/* If we are running from EFI or coreboot, this can't work */
361 	if (!ll_boot_init()) {
362 		printf("Not available (previous bootloader prevents it)\n");
363 		return -EPERM;
364 	}
365 	bootstage_start(BOOTSTAGE_ID_ACCUM_LCD, "vesa display");
366 	ret = dm_pci_run_vga_bios(dev, int15_handler, PCI_ROM_USE_NATIVE |
367 					PCI_ROM_ALLOW_FALLBACK);
368 	bootstage_accum(BOOTSTAGE_ID_ACCUM_LCD);
369 	if (ret) {
370 		debug("failed to run video BIOS: %d\n", ret);
371 		return ret;
372 	}
373 
374 	ret = vbe_setup_video_priv(&mode_info.vesa, uc_priv, plat);
375 	if (ret) {
376 		debug("No video mode configured\n");
377 		return ret;
378 	}
379 
380 	printf("%dx%dx%d\n", uc_priv->xsize, uc_priv->ysize,
381 	       mode_info.vesa.bits_per_pixel);
382 
383 	return 0;
384 }
385 #endif
386