xref: /openbmc/u-boot/drivers/pci/pci_rom.c (revision 252cdb46)
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_fb.h>
35 #include <linux/screen_info.h>
36 
37 __weak bool board_should_run_oprom(struct udevice *dev)
38 {
39 	return true;
40 }
41 
42 __weak bool board_should_load_oprom(struct udevice *dev)
43 {
44 	return true;
45 }
46 
47 __weak uint32_t board_map_oprom_vendev(uint32_t vendev)
48 {
49 	return vendev;
50 }
51 
52 static int pci_rom_probe(struct udevice *dev, struct pci_rom_header **hdrp)
53 {
54 	struct pci_child_platdata *pplat = dev_get_parent_platdata(dev);
55 	struct pci_rom_header *rom_header;
56 	struct pci_rom_data *rom_data;
57 	u16 rom_vendor, rom_device;
58 	u32 rom_class;
59 	u32 vendev;
60 	u32 mapped_vendev;
61 	u32 rom_address;
62 
63 	vendev = pplat->vendor << 16 | pplat->device;
64 	mapped_vendev = board_map_oprom_vendev(vendev);
65 	if (vendev != mapped_vendev)
66 		debug("Device ID mapped to %#08x\n", mapped_vendev);
67 
68 #ifdef CONFIG_VGA_BIOS_ADDR
69 	rom_address = CONFIG_VGA_BIOS_ADDR;
70 #else
71 
72 	dm_pci_read_config32(dev, PCI_ROM_ADDRESS, &rom_address);
73 	if (rom_address == 0x00000000 || rom_address == 0xffffffff) {
74 		debug("%s: rom_address=%x\n", __func__, rom_address);
75 		return -ENOENT;
76 	}
77 
78 	/* Enable expansion ROM address decoding. */
79 	dm_pci_write_config32(dev, PCI_ROM_ADDRESS,
80 			      rom_address | PCI_ROM_ADDRESS_ENABLE);
81 #endif
82 	debug("Option ROM address %x\n", rom_address);
83 	rom_header = (struct pci_rom_header *)(unsigned long)rom_address;
84 
85 	debug("PCI expansion ROM, signature %#04x, INIT size %#04x, data ptr %#04x\n",
86 	      le16_to_cpu(rom_header->signature),
87 	      rom_header->size * 512, le16_to_cpu(rom_header->data));
88 
89 	if (le16_to_cpu(rom_header->signature) != PCI_ROM_HDR) {
90 		printf("Incorrect expansion ROM header signature %04x\n",
91 		       le16_to_cpu(rom_header->signature));
92 #ifndef CONFIG_VGA_BIOS_ADDR
93 		/* Disable expansion ROM address decoding */
94 		dm_pci_write_config32(dev, PCI_ROM_ADDRESS, rom_address);
95 #endif
96 		return -EINVAL;
97 	}
98 
99 	rom_data = (((void *)rom_header) + le16_to_cpu(rom_header->data));
100 	rom_vendor = le16_to_cpu(rom_data->vendor);
101 	rom_device = le16_to_cpu(rom_data->device);
102 
103 	debug("PCI ROM image, vendor ID %04x, device ID %04x,\n",
104 	      rom_vendor, rom_device);
105 
106 	/* If the device id is mapped, a mismatch is expected */
107 	if ((pplat->vendor != rom_vendor || pplat->device != rom_device) &&
108 	    (vendev == mapped_vendev)) {
109 		printf("ID mismatch: vendor ID %04x, device ID %04x\n",
110 		       rom_vendor, rom_device);
111 		/* Continue anyway */
112 	}
113 
114 	rom_class = (le16_to_cpu(rom_data->class_hi) << 8) | rom_data->class_lo;
115 	debug("PCI ROM image, Class Code %06x, Code Type %02x\n",
116 	      rom_class, rom_data->type);
117 
118 	if (pplat->class != rom_class) {
119 		debug("Class Code mismatch ROM %06x, dev %06x\n",
120 		      rom_class, pplat->class);
121 	}
122 	*hdrp = rom_header;
123 
124 	return 0;
125 }
126 
127 /**
128  * pci_rom_load() - Load a ROM image and return a pointer to it
129  *
130  * @rom_header:		Pointer to ROM image
131  * @ram_headerp:	Returns a pointer to the image in RAM
132  * @allocedp:		Returns true if @ram_headerp was allocated and needs
133  *			to be freed
134  * @return 0 if OK, -ve on error. Note that @allocedp is set up regardless of
135  * the error state. Even if this function returns an error, it may have
136  * allocated memory.
137  */
138 static int pci_rom_load(struct pci_rom_header *rom_header,
139 			struct pci_rom_header **ram_headerp, bool *allocedp)
140 {
141 	struct pci_rom_data *rom_data;
142 	unsigned int rom_size;
143 	unsigned int image_size = 0;
144 	void *target;
145 
146 	*allocedp = false;
147 	do {
148 		/* Get next image, until we see an x86 version */
149 		rom_header = (struct pci_rom_header *)((void *)rom_header +
150 							    image_size);
151 
152 		rom_data = (struct pci_rom_data *)((void *)rom_header +
153 				le16_to_cpu(rom_header->data));
154 
155 		image_size = le16_to_cpu(rom_data->ilen) * 512;
156 	} while ((rom_data->type != 0) && (rom_data->indicator == 0));
157 
158 	if (rom_data->type != 0)
159 		return -EACCES;
160 
161 	rom_size = rom_header->size * 512;
162 
163 #ifdef PCI_VGA_RAM_IMAGE_START
164 	target = (void *)PCI_VGA_RAM_IMAGE_START;
165 #else
166 	target = (void *)malloc(rom_size);
167 	if (!target)
168 		return -ENOMEM;
169 	*allocedp = true;
170 #endif
171 	if (target != rom_header) {
172 		ulong start = get_timer(0);
173 
174 		debug("Copying VGA ROM Image from %p to %p, 0x%x bytes\n",
175 		      rom_header, target, rom_size);
176 		memcpy(target, rom_header, rom_size);
177 		if (memcmp(target, rom_header, rom_size)) {
178 			printf("VGA ROM copy failed\n");
179 			return -EFAULT;
180 		}
181 		debug("Copy took %lums\n", get_timer(start));
182 	}
183 	*ram_headerp = target;
184 
185 	return 0;
186 }
187 
188 struct vbe_mode_info mode_info;
189 
190 int vbe_get_video_info(struct graphic_device *gdev)
191 {
192 #ifdef CONFIG_FRAMEBUFFER_SET_VESA_MODE
193 	struct vesa_mode_info *vesa = &mode_info.vesa;
194 
195 	gdev->winSizeX = vesa->x_resolution;
196 	gdev->winSizeY = vesa->y_resolution;
197 
198 	gdev->plnSizeX = vesa->x_resolution;
199 	gdev->plnSizeY = vesa->y_resolution;
200 
201 	gdev->gdfBytesPP = vesa->bits_per_pixel / 8;
202 
203 	switch (vesa->bits_per_pixel) {
204 	case 32:
205 	case 24:
206 		gdev->gdfIndex = GDF_32BIT_X888RGB;
207 		break;
208 	case 16:
209 		gdev->gdfIndex = GDF_16BIT_565RGB;
210 		break;
211 	default:
212 		gdev->gdfIndex = GDF__8BIT_INDEX;
213 		break;
214 	}
215 
216 	gdev->isaBase = CONFIG_SYS_ISA_IO_BASE_ADDRESS;
217 	gdev->pciBase = vesa->phys_base_ptr;
218 
219 	gdev->frameAdrs = vesa->phys_base_ptr;
220 	gdev->memSize = vesa->bytes_per_scanline * vesa->y_resolution;
221 
222 	gdev->vprBase = vesa->phys_base_ptr;
223 	gdev->cprBase = vesa->phys_base_ptr;
224 
225 	return gdev->winSizeX ? 0 : -ENOSYS;
226 #else
227 	return -ENOSYS;
228 #endif
229 }
230 
231 void setup_video(struct screen_info *screen_info)
232 {
233 	struct vesa_mode_info *vesa = &mode_info.vesa;
234 
235 	/* Sanity test on VESA parameters */
236 	if (!vesa->x_resolution || !vesa->y_resolution)
237 		return;
238 
239 	screen_info->orig_video_isVGA = VIDEO_TYPE_VLFB;
240 
241 	screen_info->lfb_width = vesa->x_resolution;
242 	screen_info->lfb_height = vesa->y_resolution;
243 	screen_info->lfb_depth = vesa->bits_per_pixel;
244 	screen_info->lfb_linelength = vesa->bytes_per_scanline;
245 	screen_info->lfb_base = vesa->phys_base_ptr;
246 	screen_info->lfb_size =
247 		ALIGN(screen_info->lfb_linelength * screen_info->lfb_height,
248 		      65536);
249 	screen_info->lfb_size >>= 16;
250 	screen_info->red_size = vesa->red_mask_size;
251 	screen_info->red_pos = vesa->red_mask_pos;
252 	screen_info->green_size = vesa->green_mask_size;
253 	screen_info->green_pos = vesa->green_mask_pos;
254 	screen_info->blue_size = vesa->blue_mask_size;
255 	screen_info->blue_pos = vesa->blue_mask_pos;
256 	screen_info->rsvd_size = vesa->reserved_mask_size;
257 	screen_info->rsvd_pos = vesa->reserved_mask_pos;
258 }
259 
260 int dm_pci_run_vga_bios(struct udevice *dev, int (*int15_handler)(void),
261 			int exec_method)
262 {
263 	struct pci_child_platdata *pplat = dev_get_parent_platdata(dev);
264 	struct pci_rom_header *rom = NULL, *ram = NULL;
265 	int vesa_mode = -1;
266 	bool emulate, alloced;
267 	int ret;
268 
269 	/* Only execute VGA ROMs */
270 	if (((pplat->class >> 8) ^ PCI_CLASS_DISPLAY_VGA) & 0xff00) {
271 		debug("%s: Class %#x, should be %#x\n", __func__, pplat->class,
272 		      PCI_CLASS_DISPLAY_VGA);
273 		return -ENODEV;
274 	}
275 
276 	if (!board_should_load_oprom(dev))
277 		return -ENXIO;
278 
279 	ret = pci_rom_probe(dev, &rom);
280 	if (ret)
281 		return ret;
282 
283 	ret = pci_rom_load(rom, &ram, &alloced);
284 	if (ret)
285 		goto err;
286 
287 	if (!board_should_run_oprom(dev)) {
288 		ret = -ENXIO;
289 		goto err;
290 	}
291 
292 #if defined(CONFIG_FRAMEBUFFER_SET_VESA_MODE) && \
293 		defined(CONFIG_FRAMEBUFFER_VESA_MODE)
294 	vesa_mode = CONFIG_FRAMEBUFFER_VESA_MODE;
295 #endif
296 	debug("Selected vesa mode %#x\n", vesa_mode);
297 
298 	if (exec_method & PCI_ROM_USE_NATIVE) {
299 #ifdef CONFIG_X86
300 		emulate = false;
301 #else
302 		if (!(exec_method & PCI_ROM_ALLOW_FALLBACK)) {
303 			printf("BIOS native execution is only available on x86\n");
304 			ret = -ENOSYS;
305 			goto err;
306 		}
307 		emulate = true;
308 #endif
309 	} else {
310 #ifdef CONFIG_BIOSEMU
311 		emulate = true;
312 #else
313 		if (!(exec_method & PCI_ROM_ALLOW_FALLBACK)) {
314 			printf("BIOS emulation not available - see CONFIG_BIOSEMU\n");
315 			ret = -ENOSYS;
316 			goto err;
317 		}
318 		emulate = false;
319 #endif
320 	}
321 
322 	if (emulate) {
323 #ifdef CONFIG_BIOSEMU
324 		BE_VGAInfo *info;
325 
326 		ret = biosemu_setup(dev, &info);
327 		if (ret)
328 			goto err;
329 		biosemu_set_interrupt_handler(0x15, int15_handler);
330 		ret = biosemu_run(dev, (uchar *)ram, 1 << 16, info,
331 				  true, vesa_mode, &mode_info);
332 		if (ret)
333 			goto err;
334 #endif
335 	} else {
336 #ifdef CONFIG_X86
337 		bios_set_interrupt_handler(0x15, int15_handler);
338 
339 		bios_run_on_x86(dev, (unsigned long)ram, vesa_mode,
340 				&mode_info);
341 #endif
342 	}
343 	debug("Final vesa mode %#x\n", mode_info.video_mode);
344 	ret = 0;
345 
346 err:
347 	if (alloced)
348 		free(ram);
349 	return ret;
350 }
351