pci: Configure expansion ROM during auto config process
[platform/kernel/u-boot.git] / drivers / pci / pci_rom.c
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 #include <linux/screen_info.h>
35
36 #ifdef CONFIG_HAVE_ACPI_RESUME
37 #include <asm/acpi.h>
38 #endif
39
40 __weak bool board_should_run_oprom(pci_dev_t dev)
41 {
42         return true;
43 }
44
45 static bool should_load_oprom(pci_dev_t dev)
46 {
47 #ifdef CONFIG_HAVE_ACPI_RESUME
48         if (acpi_get_slp_type() == 3)
49                 return false;
50 #endif
51         if (IS_ENABLED(CONFIG_ALWAYS_LOAD_OPROM))
52                 return 1;
53         if (board_should_run_oprom(dev))
54                 return 1;
55
56         return 0;
57 }
58
59 __weak uint32_t board_map_oprom_vendev(uint32_t vendev)
60 {
61         return vendev;
62 }
63
64 static int pci_rom_probe(pci_dev_t dev, uint class,
65                          struct pci_rom_header **hdrp)
66 {
67         struct pci_rom_header *rom_header;
68         struct pci_rom_data *rom_data;
69         u16 vendor, device;
70         u16 rom_vendor, rom_device;
71         u32 rom_class;
72         u32 vendev;
73         u32 mapped_vendev;
74         u32 rom_address;
75
76         pci_read_config_word(dev, PCI_VENDOR_ID, &vendor);
77         pci_read_config_word(dev, PCI_DEVICE_ID, &device);
78         vendev = vendor << 16 | 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         pci_read_config_dword(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         pci_write_config_dword(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                 return -EINVAL;
108         }
109
110         rom_data = (((void *)rom_header) + le16_to_cpu(rom_header->data));
111         rom_vendor = le16_to_cpu(rom_data->vendor);
112         rom_device = le16_to_cpu(rom_data->device);
113
114         debug("PCI ROM image, vendor ID %04x, device ID %04x,\n",
115               rom_vendor, rom_device);
116
117         /* If the device id is mapped, a mismatch is expected */
118         if ((vendor != rom_vendor || device != rom_device) &&
119             (vendev == mapped_vendev)) {
120                 printf("ID mismatch: vendor ID %04x, device ID %04x\n",
121                        rom_vendor, rom_device);
122                 /* Continue anyway */
123         }
124
125         rom_class = (le16_to_cpu(rom_data->class_hi) << 8) | rom_data->class_lo;
126         debug("PCI ROM image, Class Code %06x, Code Type %02x\n",
127               rom_class, rom_data->type);
128
129         if (class != rom_class) {
130                 debug("Class Code mismatch ROM %06x, dev %06x\n",
131                       rom_class, class);
132         }
133         *hdrp = rom_header;
134
135         return 0;
136 }
137
138 int pci_rom_load(struct pci_rom_header *rom_header,
139                  struct pci_rom_header **ram_headerp)
140 {
141         struct pci_rom_data *rom_data;
142         unsigned int rom_size;
143         unsigned int image_size = 0;
144         void *target;
145
146         do {
147                 /* Get next image, until we see an x86 version */
148                 rom_header = (struct pci_rom_header *)((void *)rom_header +
149                                                             image_size);
150
151                 rom_data = (struct pci_rom_data *)((void *)rom_header +
152                                 le16_to_cpu(rom_header->data));
153
154                 image_size = le16_to_cpu(rom_data->ilen) * 512;
155         } while ((rom_data->type != 0) && (rom_data->indicator == 0));
156
157         if (rom_data->type != 0)
158                 return -EACCES;
159
160         rom_size = rom_header->size * 512;
161
162 #ifdef PCI_VGA_RAM_IMAGE_START
163         target = (void *)PCI_VGA_RAM_IMAGE_START;
164 #else
165         target = (void *)malloc(rom_size);
166         if (!target)
167                 return -ENOMEM;
168 #endif
169         if (target != rom_header) {
170                 ulong start = get_timer(0);
171
172                 debug("Copying VGA ROM Image from %p to %p, 0x%x bytes\n",
173                       rom_header, target, rom_size);
174                 memcpy(target, rom_header, rom_size);
175                 if (memcmp(target, rom_header, rom_size)) {
176                         printf("VGA ROM copy failed\n");
177                         return -EFAULT;
178                 }
179                 debug("Copy took %lums\n", get_timer(start));
180         }
181         *ram_headerp = target;
182
183         return 0;
184 }
185
186 static struct vbe_mode_info mode_info;
187
188 int vbe_get_video_info(struct graphic_device *gdev)
189 {
190 #ifdef CONFIG_FRAMEBUFFER_SET_VESA_MODE
191         struct vesa_mode_info *vesa = &mode_info.vesa;
192
193         gdev->winSizeX = vesa->x_resolution;
194         gdev->winSizeY = vesa->y_resolution;
195
196         gdev->plnSizeX = vesa->x_resolution;
197         gdev->plnSizeY = vesa->y_resolution;
198
199         gdev->gdfBytesPP = vesa->bits_per_pixel / 8;
200
201         switch (vesa->bits_per_pixel) {
202         case 32:
203         case 24:
204                 gdev->gdfIndex = GDF_32BIT_X888RGB;
205                 break;
206         case 16:
207                 gdev->gdfIndex = GDF_16BIT_565RGB;
208                 break;
209         default:
210                 gdev->gdfIndex = GDF__8BIT_INDEX;
211                 break;
212         }
213
214         gdev->isaBase = CONFIG_SYS_ISA_IO_BASE_ADDRESS;
215         gdev->pciBase = vesa->phys_base_ptr;
216
217         gdev->frameAdrs = vesa->phys_base_ptr;
218         gdev->memSize = vesa->bytes_per_scanline * vesa->y_resolution;
219
220         gdev->vprBase = vesa->phys_base_ptr;
221         gdev->cprBase = vesa->phys_base_ptr;
222
223         return gdev->winSizeX ? 0 : -ENOSYS;
224 #else
225         return -ENOSYS;
226 #endif
227 }
228
229 void setup_video(struct screen_info *screen_info)
230 {
231 #ifdef CONFIG_FRAMEBUFFER_SET_VESA_MODE
232         struct vesa_mode_info *vesa = &mode_info.vesa;
233
234         screen_info->orig_video_isVGA = VIDEO_TYPE_VLFB;
235
236         screen_info->lfb_width = vesa->x_resolution;
237         screen_info->lfb_height = vesa->y_resolution;
238         screen_info->lfb_depth = vesa->bits_per_pixel;
239         screen_info->lfb_linelength = vesa->bytes_per_scanline;
240         screen_info->lfb_base = vesa->phys_base_ptr;
241         screen_info->lfb_size =
242                 ALIGN(screen_info->lfb_linelength * screen_info->lfb_height,
243                       65536);
244         screen_info->lfb_size >>= 16;
245         screen_info->red_size = vesa->red_mask_size;
246         screen_info->red_pos = vesa->red_mask_pos;
247         screen_info->green_size = vesa->green_mask_size;
248         screen_info->green_pos = vesa->green_mask_pos;
249         screen_info->blue_size = vesa->blue_mask_size;
250         screen_info->blue_pos = vesa->blue_mask_pos;
251         screen_info->rsvd_size = vesa->reserved_mask_size;
252         screen_info->rsvd_pos = vesa->reserved_mask_pos;
253 #endif
254 }
255
256 int pci_run_vga_bios(pci_dev_t dev, int (*int15_handler)(void), int exec_method)
257 {
258         struct pci_rom_header *rom, *ram;
259         int vesa_mode = -1;
260         uint class;
261         bool emulate;
262         int ret;
263
264         /* Only execute VGA ROMs */
265         pci_read_config_dword(dev, PCI_REVISION_ID, &class);
266         if (((class >> 16) ^ PCI_CLASS_DISPLAY_VGA) & 0xff00) {
267                 debug("%s: Class %#x, should be %#x\n", __func__, class,
268                       PCI_CLASS_DISPLAY_VGA);
269                 return -ENODEV;
270         }
271         class >>= 8;
272
273         if (!should_load_oprom(dev))
274                 return -ENXIO;
275
276         ret = pci_rom_probe(dev, class, &rom);
277         if (ret)
278                 return ret;
279
280         ret = pci_rom_load(rom, &ram);
281         if (ret)
282                 return ret;
283
284         if (!board_should_run_oprom(dev))
285                 return -ENXIO;
286
287 #if defined(CONFIG_FRAMEBUFFER_SET_VESA_MODE) && \
288                 defined(CONFIG_FRAMEBUFFER_VESA_MODE)
289         vesa_mode = CONFIG_FRAMEBUFFER_VESA_MODE;
290 #endif
291         debug("Selected vesa mode %#x\n", vesa_mode);
292
293         if (exec_method & PCI_ROM_USE_NATIVE) {
294 #ifdef CONFIG_X86
295                 emulate = false;
296 #else
297                 if (!(exec_method & PCI_ROM_ALLOW_FALLBACK)) {
298                         printf("BIOS native execution is only available on x86\n");
299                         return -ENOSYS;
300                 }
301                 emulate = true;
302 #endif
303         } else {
304 #ifdef CONFIG_BIOSEMU
305                 emulate = true;
306 #else
307                 if (!(exec_method & PCI_ROM_ALLOW_FALLBACK)) {
308                         printf("BIOS emulation not available - see CONFIG_BIOSEMU\n");
309                         return -ENOSYS;
310                 }
311                 emulate = false;
312 #endif
313         }
314
315         if (emulate) {
316 #ifdef CONFIG_BIOSEMU
317                 BE_VGAInfo *info;
318
319                 ret = biosemu_setup(dev, &info);
320                 if (ret)
321                         return ret;
322                 biosemu_set_interrupt_handler(0x15, int15_handler);
323                 ret = biosemu_run(dev, (uchar *)ram, 1 << 16, info, true,
324                                   vesa_mode, &mode_info);
325                 if (ret)
326                         return ret;
327 #endif
328         } else {
329 #ifdef CONFIG_X86
330                 bios_set_interrupt_handler(0x15, int15_handler);
331
332                 bios_run_on_x86(dev, (unsigned long)ram, vesa_mode,
333                                 &mode_info);
334 #endif
335         }
336         debug("Final vesa mode %#x\n", mode_info.video_mode);
337
338         return 0;
339 }