xref: /openbmc/u-boot/drivers/pci/pci_rom.c (revision d928664f)
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 <errno.h>
29 #include <malloc.h>
30 #include <pci.h>
31 #include <pci_rom.h>
32 #include <vbe.h>
33 #include <video_fb.h>
34 
35 #ifdef CONFIG_HAVE_ACPI_RESUME
36 #include <asm/acpi.h>
37 #endif
38 
39 __weak bool board_should_run_oprom(pci_dev_t dev)
40 {
41 	return true;
42 }
43 
44 static bool should_load_oprom(pci_dev_t dev)
45 {
46 #ifdef CONFIG_HAVE_ACPI_RESUME
47 	if (acpi_get_slp_type() == 3)
48 		return false;
49 #endif
50 	if (IS_ENABLED(CONFIG_ALWAYS_LOAD_OPROM))
51 		return 1;
52 	if (board_should_run_oprom(dev))
53 		return 1;
54 
55 	return 0;
56 }
57 
58 __weak uint32_t board_map_oprom_vendev(uint32_t vendev)
59 {
60 	return vendev;
61 }
62 
63 static int pci_rom_probe(pci_dev_t dev, uint class,
64 			 struct pci_rom_header **hdrp)
65 {
66 	struct pci_rom_header *rom_header;
67 	struct pci_rom_data *rom_data;
68 	u16 vendor, device;
69 	u32 vendev;
70 	u32 mapped_vendev;
71 	u32 rom_address;
72 
73 	pci_read_config_word(dev, PCI_VENDOR_ID, &vendor);
74 	pci_read_config_word(dev, PCI_DEVICE_ID, &device);
75 	vendev = vendor << 16 | device;
76 	mapped_vendev = board_map_oprom_vendev(vendev);
77 	if (vendev != mapped_vendev)
78 		debug("Device ID mapped to %#08x\n", mapped_vendev);
79 
80 #ifdef CONFIG_X86_OPTION_ROM_ADDR
81 	rom_address = CONFIG_X86_OPTION_ROM_ADDR;
82 #else
83 	pci_write_config_dword(dev, PCI_ROM_ADDRESS, (u32)PCI_ROM_ADDRESS_MASK);
84 	pci_read_config_dword(dev, PCI_ROM_ADDRESS, &rom_address);
85 	if (rom_address == 0x00000000 || rom_address == 0xffffffff) {
86 		debug("%s: rom_address=%x\n", __func__, rom_address);
87 		return -ENOENT;
88 	}
89 
90 	/* Enable expansion ROM address decoding. */
91 	pci_write_config_dword(dev, PCI_ROM_ADDRESS,
92 			       rom_address | PCI_ROM_ADDRESS_ENABLE);
93 #endif
94 	debug("Option ROM address %x\n", rom_address);
95 	rom_header = (struct pci_rom_header *)rom_address;
96 
97 	debug("PCI expansion ROM, signature %#04x, INIT size %#04x, data ptr %#04x\n",
98 	      le32_to_cpu(rom_header->signature),
99 	      rom_header->size * 512, le32_to_cpu(rom_header->data));
100 
101 	if (le32_to_cpu(rom_header->signature) != PCI_ROM_HDR) {
102 		printf("Incorrect expansion ROM header signature %04x\n",
103 		       le32_to_cpu(rom_header->signature));
104 		return -EINVAL;
105 	}
106 
107 	rom_data = (((void *)rom_header) + le32_to_cpu(rom_header->data));
108 
109 	debug("PCI ROM image, vendor ID %04x, device ID %04x,\n",
110 	      rom_data->vendor, rom_data->device);
111 
112 	/* If the device id is mapped, a mismatch is expected */
113 	if ((vendor != rom_data->vendor || device != rom_data->device) &&
114 	    (vendev == mapped_vendev)) {
115 		printf("ID mismatch: vendor ID %04x, device ID %04x\n",
116 		       rom_data->vendor, rom_data->device);
117 		return -EPERM;
118 	}
119 
120 	debug("PCI ROM image, Class Code %04x%02x, Code Type %02x\n",
121 	      rom_data->class_hi, rom_data->class_lo, rom_data->type);
122 
123 	if (class != ((rom_data->class_hi << 8) | rom_data->class_lo)) {
124 		debug("Class Code mismatch ROM %08x, dev %08x\n",
125 		      (rom_data->class_hi << 8) | rom_data->class_lo,
126 		      class);
127 	}
128 	*hdrp = rom_header;
129 
130 	return 0;
131 }
132 
133 int pci_rom_load(uint16_t class, struct pci_rom_header *rom_header,
134 		 struct pci_rom_header **ram_headerp)
135 {
136 	struct pci_rom_data *rom_data;
137 	unsigned int rom_size;
138 	unsigned int image_size = 0;
139 	void *target;
140 
141 	do {
142 		/* Get next image, until we see an x86 version */
143 		rom_header = (struct pci_rom_header *)((void *)rom_header +
144 							    image_size);
145 
146 		rom_data = (struct pci_rom_data *)((void *)rom_header +
147 				le32_to_cpu(rom_header->data));
148 
149 		image_size = le32_to_cpu(rom_data->ilen) * 512;
150 	} while ((rom_data->type != 0) && (rom_data->indicator != 0));
151 
152 	if (rom_data->type != 0)
153 		return -EACCES;
154 
155 	rom_size = rom_header->size * 512;
156 
157 	target = (void *)PCI_VGA_RAM_IMAGE_START;
158 	if (target != rom_header) {
159 		ulong start = get_timer(0);
160 
161 		debug("Copying VGA ROM Image from %p to %p, 0x%x bytes\n",
162 		      rom_header, target, rom_size);
163 		memcpy(target, rom_header, rom_size);
164 		if (memcmp(target, rom_header, rom_size)) {
165 			printf("VGA ROM copy failed\n");
166 			return -EFAULT;
167 		}
168 		debug("Copy took %lums\n", get_timer(start));
169 	}
170 	*ram_headerp = target;
171 
172 	return 0;
173 }
174 
175 static struct vbe_mode_info mode_info;
176 
177 int vbe_get_video_info(struct graphic_device *gdev)
178 {
179 #ifdef CONFIG_FRAMEBUFFER_SET_VESA_MODE
180 	struct vesa_mode_info *vesa = &mode_info.vesa;
181 
182 	gdev->winSizeX = vesa->x_resolution;
183 	gdev->winSizeY = vesa->y_resolution;
184 
185 	gdev->plnSizeX = vesa->x_resolution;
186 	gdev->plnSizeY = vesa->y_resolution;
187 
188 	gdev->gdfBytesPP = vesa->bits_per_pixel / 8;
189 
190 	switch (vesa->bits_per_pixel) {
191 	case 24:
192 		gdev->gdfIndex = GDF_32BIT_X888RGB;
193 		break;
194 	case 16:
195 		gdev->gdfIndex = GDF_16BIT_565RGB;
196 		break;
197 	default:
198 		gdev->gdfIndex = GDF__8BIT_INDEX;
199 		break;
200 	}
201 
202 	gdev->isaBase = CONFIG_SYS_ISA_IO_BASE_ADDRESS;
203 	gdev->pciBase = vesa->phys_base_ptr;
204 
205 	gdev->frameAdrs = vesa->phys_base_ptr;
206 	gdev->memSize = vesa->bytes_per_scanline * vesa->y_resolution;
207 
208 	gdev->vprBase = vesa->phys_base_ptr;
209 	gdev->cprBase = vesa->phys_base_ptr;
210 
211 	return gdev->winSizeX ? 0 : -ENOSYS;
212 #else
213 	return -ENOSYS;
214 #endif
215 }
216 
217 int pci_run_vga_bios(pci_dev_t dev, int (*int15_handler)(void), bool emulate)
218 {
219 	struct pci_rom_header *rom, *ram;
220 	int vesa_mode = -1;
221 	uint16_t class;
222 	int ret;
223 
224 	/* Only execute VGA ROMs */
225 	pci_read_config_word(dev, PCI_CLASS_DEVICE, &class);
226 	if ((class ^ PCI_CLASS_DISPLAY_VGA) & 0xff00) {
227 		debug("%s: Class %#x, should be %#x\n", __func__, class,
228 		      PCI_CLASS_DISPLAY_VGA);
229 		return -ENODEV;
230 	}
231 
232 	if (!should_load_oprom(dev))
233 		return -ENXIO;
234 
235 	ret = pci_rom_probe(dev, class, &rom);
236 	if (ret)
237 		return ret;
238 
239 	ret = pci_rom_load(class, rom, &ram);
240 	if (ret)
241 		return ret;
242 
243 	if (!board_should_run_oprom(dev))
244 		return -ENXIO;
245 
246 #if defined(CONFIG_FRAMEBUFFER_SET_VESA_MODE) && \
247 		defined(CONFIG_FRAMEBUFFER_VESA_MODE)
248 	vesa_mode = CONFIG_FRAMEBUFFER_VESA_MODE;
249 #endif
250 	debug("Selected vesa mode %#x\n", vesa_mode);
251 	if (emulate) {
252 #ifdef CONFIG_BIOSEMU
253 		BE_VGAInfo *info;
254 
255 		ret = biosemu_setup(dev, &info);
256 		if (ret)
257 			return ret;
258 		biosemu_set_interrupt_handler(0x15, int15_handler);
259 		ret = biosemu_run(dev, (uchar *)ram, 1 << 16, info, true,
260 				  vesa_mode, &mode_info);
261 		if (ret)
262 			return ret;
263 #else
264 		printf("BIOS emulation not available - see CONFIG_BIOSEMU\n");
265 		return -ENOSYS;
266 #endif
267 	} else {
268 #ifdef CONFIG_X86
269 		bios_set_interrupt_handler(0x15, int15_handler);
270 
271 		bios_run_on_x86(dev, (unsigned long)ram, vesa_mode,
272 				&mode_info);
273 #else
274 		printf("BIOS native execution is only available on x86\n");
275 		return -ENOSYS;
276 #endif
277 	}
278 	debug("Final vesa mode %#x\n", mode_info.video_mode);
279 
280 	return 0;
281 }
282