* clean up all but two warnings on artecgroup dbe61
[coreboot.git] / src / devices / oprom / x86.c
1 /*
2  * This file is part of the coreboot project.
3  *
4  * Copyright (C) 2007 Advanced Micro Devices, Inc.
5  * Copyright (C) 2009-2010 coresystems GmbH
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; version 2 of the License.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
19  */
20
21 #include <device/pci.h>
22 #include <string.h>
23
24 #include <arch/io.h>
25 #include <arch/registers.h>
26 #include <console/console.h>
27 #include <arch/interrupt.h>
28
29 #define REALMODE_BASE ((void *)0x600)
30
31 struct realmode_idt {
32         u16 offset, cs;
33 };
34
35 void x86_exception(struct eregs *info);
36
37 extern unsigned char __idt_handler, __idt_handler_size;
38 extern unsigned char __realmode_code, __realmode_code_size;
39 extern unsigned char __run_optionrom, __run_interrupt;
40 extern unsigned char __run_vsa;
41
42 void (*run_optionrom)(u32 devfn) __attribute__((regparm(0))) = (void *)&__run_optionrom;
43 void (*vga_enable_console)(void) __attribute__((regparm(0))) = (void *)&__run_interrupt;
44 void (*run_vsa)(u32 smm, u32 sysmem) __attribute__((regparm(0))) = (void *)&__run_vsa;
45
46 int (*intXX_handler[256])(struct eregs *regs) = { NULL };
47
48 static int intXX_exception_handler(struct eregs *regs)
49 {
50         printk(BIOS_INFO, "Oops, exception %d while executing option rom\n", 
51                         regs->vector);
52         x86_exception(regs);    // Call coreboot exception handler 
53
54         return 0;               // Never returns?
55 }
56
57 static int intXX_unknown_handler(struct eregs *regs)
58 {
59         printk(BIOS_INFO, "Unsupported software interrupt #0x%x\n", 
60                         regs->vector);
61
62         return -1;
63 }
64
65 /* setup interrupt handlers for mainboard */
66 void mainboard_interrupt_handlers(int intXX, void *intXX_func)
67 {
68         intXX_handler[intXX] = intXX_func;
69 }
70
71 int int12_handler(struct eregs *regs);
72 int int15_handler(struct eregs *regs);
73 int int1a_handler(struct eregs *regs);
74
75 static void setup_interrupt_handlers(void)
76 {
77         int i;
78
79         /* The first 16 intXX functions are not BIOS services, 
80          * but the CPU-generated exceptions ("hardware interrupts")
81          */
82         for (i = 0; i < 0x10; i++)
83                 intXX_handler[i] = &intXX_exception_handler;
84         
85         /* Mark all other intXX calls as unknown first */
86         for (i = 0x10; i < 0x100; i++)
87         {
88                 /* If the mainboard_interrupt_handler isn't called first.
89                  */
90                 if(!intXX_handler[i])
91                 {
92                         /* Now set the default functions that are actually
93                          * needed to initialize the option roms. This is very
94                          * slick, as it allows us to implement mainboard specific
95                          * interrupt handlers, such as the int15
96                          */
97                         switch (i) {
98                         case 0x12:
99                                 intXX_handler[0x12] = &int12_handler;
100                                 break;
101                         case 0x15:
102                                 intXX_handler[0x15] = &int15_handler;
103                                 break;
104                         case 0x1a:
105                                 intXX_handler[0x1a] = &int1a_handler;
106                                 break;
107                         default:
108                                 intXX_handler[i] = &intXX_unknown_handler;
109                                 break;
110                         }
111                 }
112         }
113 }
114
115 static void write_idt_stub(void *target, u8 intnum)
116 {
117         unsigned char *codeptr;
118         codeptr = (unsigned char *) target;
119         memcpy(codeptr, &__idt_handler, (size_t)&__idt_handler_size);
120         codeptr[3] = intnum; /* modify int# in the code stub. */
121 }
122
123 static void setup_realmode_idt(void)
124 {
125         struct realmode_idt *idts = (struct realmode_idt *) 0;
126         int i;
127
128         /* Copy IDT stub code for each interrupt. This might seem wasteful
129          * but it is really simple
130          */
131          for (i = 0; i < 256; i++) {
132                 idts[i].cs = 0;
133                 idts[i].offset = 0x1000 + (i * (u32)&__idt_handler_size);
134                 write_idt_stub((void *)((u32 )idts[i].offset), i);
135         }
136
137         /* Many option ROMs use the hard coded interrupt entry points in the
138          * system bios. So install them at the known locations. 
139          * Only need int10 so far.
140          */
141         
142         /* int42 is the relocated int10 */
143         write_idt_stub((void *)0xff065, 0x42); 
144 }
145
146 void run_bios(struct device *dev, unsigned long addr)
147 {
148         /* clear vga bios data area */
149         memset((void *)0x400, 0, 0x200);
150
151         /* Set up C interrupt handlers */
152         setup_interrupt_handlers();
153
154         /* Setting up realmode IDT */
155         setup_realmode_idt();
156
157         memcpy(REALMODE_BASE, &__realmode_code, (size_t)&__realmode_code_size);
158         printk(BIOS_SPEW, "Real mode stub @%p: %d bytes\n", REALMODE_BASE,
159                         (u32)&__realmode_code_size);
160
161         printk(BIOS_DEBUG, "Calling Option ROM...\n");
162         run_optionrom((dev->bus->secondary << 8) | dev->path.pci.devfn);
163         printk(BIOS_DEBUG, "... Option ROM returned.\n");
164 }
165
166 #if defined(CONFIG_GEODE_VSA) && CONFIG_GEODE_VSA
167 #include <cpu/amd/lxdef.h>
168 #include <cpu/amd/vr.h>
169 #include <cbfs.h>
170
171 #define VSA2_BUFFER             0x60000
172 #define VSA2_ENTRY_POINT        0x60020
173
174 // TODO move to a header file.
175 void do_vsmbios(void);
176
177 /* VSA virtual register helper */
178 static u32 VSA_vrRead(u16 classIndex)
179 {
180         u32 eax, ebx, ecx, edx;
181         asm volatile (
182                 "movw   $0x0AC1C, %%dx\n"
183                 "orl    $0x0FC530000, %%eax\n"
184                 "outl   %%eax, %%dx\n"
185                 "addb   $2, %%dl\n"
186                 "inw    %%dx, %%ax\n"
187                 : "=a" (eax), "=b"(ebx), "=c"(ecx), "=d"(edx) 
188                 : "a"(classIndex)
189         );
190
191         return eax;
192 }
193
194 void do_vsmbios(void)
195 {
196         printk(BIOS_DEBUG, "Preparing for VSA...\n");
197
198         /* clear bios data area */
199         memset((void *)0x400, 0, 0x200);
200
201         /* Set up C interrupt handlers */
202         setup_interrupt_handlers();
203
204         /* Setting up realmode IDT */
205         setup_realmode_idt();
206
207         memcpy(REALMODE_BASE, &__realmode_code, (size_t)&__realmode_code_size);
208         printk(BIOS_SPEW, "VSA: Real mode stub @%p: %d bytes\n", REALMODE_BASE,
209                         (u32)&__realmode_code_size);
210
211         if ((unsigned int)cbfs_load_stage("vsa") != VSA2_ENTRY_POINT) {
212                 printk(BIOS_ERR, "Failed to load VSA.\n");
213                 return;
214         }
215
216         unsigned char *buf = (unsigned char *)VSA2_BUFFER;
217         printk(BIOS_DEBUG, "VSA: Buffer @%p *[0k]=%02x\n", buf, buf[0]);
218         printk(BIOS_DEBUG, "VSA: Signature *[0x20-0x23] is %02x:%02x:%02x:%02x\n",
219                      buf[0x20], buf[0x21], buf[0x22], buf[0x23]);
220
221         /* Check for code to emit POST code at start of VSA. */
222         if ((buf[0x20] != 0xb0) || (buf[0x21] != 0x10) ||
223             (buf[0x22] != 0xe6) || (buf[0x23] != 0x80)) {
224                 printk(BIOS_WARNING, "VSA: Signature incorrect. Install failed.\n");
225                 return;
226         }
227
228         printk(BIOS_DEBUG, "Calling VSA module...\n");
229         /* ECX gets SMM, EDX gets SYSMEM */
230         run_vsa(MSR_GLIU0_SMM, MSR_GLIU0_SYSMEM);
231         printk(BIOS_DEBUG, "... VSA module returned.\n");
232
233         /* Restart timer 1 */
234         outb(0x56, 0x43);
235         outb(0x12, 0x41);
236
237         /* Check that VSA is running OK */
238         if (VSA_vrRead(SIGNATURE) == VSA2_SIGNATURE)
239                 printk(BIOS_DEBUG, "VSM: VSA2 VR signature verified.\n");
240         else
241                 printk(BIOS_ERR, "VSM: VSA2 VR signature not valid. Install failed.\n");
242 }
243 #endif
244
245 /* interrupt_handler() is called from assembler code only, 
246  * so there is no use in putting the prototype into a header file.
247  */
248 int __attribute__((regparm(0))) interrupt_handler(u32 intnumber,
249             u32 gsfs, u32 dses,
250             u32 edi, u32 esi,
251             u32 ebp, u32 esp,
252             u32 ebx, u32 edx,
253             u32 ecx, u32 eax,
254             u32 cs_ip, u16 stackflags);
255
256 int __attribute__((regparm(0))) interrupt_handler(u32 intnumber,
257             u32 gsfs, u32 dses,
258             u32 edi, u32 esi,
259             u32 ebp, u32 esp,
260             u32 ebx, u32 edx,
261             u32 ecx, u32 eax,
262             u32 cs_ip, u16 stackflags)
263 {
264         u32 ip;
265         u32 cs;
266         u32 flags;
267         int ret = -1;
268         struct eregs reg_info;
269
270         ip = cs_ip & 0xffff;
271         cs = cs_ip >> 16;
272         flags = stackflags;
273
274         printk(BIOS_DEBUG, "oprom: INT# 0x%x\n", intnumber);
275         printk(BIOS_DEBUG, "oprom: eax: %08x ebx: %08x ecx: %08x edx: %08x\n",
276                       eax, ebx, ecx, edx);
277         printk(BIOS_DEBUG, "oprom: ebp: %08x esp: %08x edi: %08x esi: %08x\n",
278                      ebp, esp, edi, esi);
279         printk(BIOS_DEBUG, "oprom:  ip: %04x      cs: %04x   flags: %08x\n",
280                      ip, cs, flags);
281
282         // Fetch arguments from the stack and put them into
283         // a structure that we want to pass on to our sub interrupt
284         // handlers.
285         reg_info = (struct eregs) {
286                 .eax=eax,
287                 .ecx=ecx,
288                 .edx=edx,
289                 .ebx=ebx,
290                 .esp=esp,
291                 .ebp=ebp,
292                 .esi=esi,
293                 .edi=edi,
294                 .vector=intnumber,
295                 .error_code=0, // ??
296                 .eip=ip,
297                 .cs=cs,
298                 .eflags=flags // ??
299         };
300
301         // Call the interrupt handler for this int#
302         ret = intXX_handler[intnumber](&reg_info);
303
304         // Put registers back on the stack. The assembler code
305         // will later pop them.
306         // What happens here is that we force (volatile!) changing
307         // the values of the parameters of this function. We do this
308         // because we know that they stay alive on the stack after 
309         // we leave this function. Don't say this is bollocks.
310         *(volatile u32 *)&eax = reg_info.eax;
311         *(volatile u32 *)&ecx = reg_info.ecx;
312         *(volatile u32 *)&edx = reg_info.edx;
313         *(volatile u32 *)&ebx = reg_info.ebx;
314         *(volatile u32 *)&esi = reg_info.esi;
315         *(volatile u32 *)&edi = reg_info.edi;
316         flags = reg_info.eflags;
317
318         /* Pass errors back to our caller via the CARRY flag */
319         if (ret) {
320                 printk(BIOS_DEBUG,"error!\n");
321                 flags |= 1;  // error: set carry
322         }else{
323                 flags &= ~1; // no error: clear carry
324         }
325         *(volatile u16 *)&stackflags = flags;
326
327         return ret;
328 }
329