x86: APIC cleanup
[akaros.git] / kern / arch / x86 / pci.c
1 /* Copyright (c) 2009, 2010 The Regents of the University of California
2  * See LICENSE for details.
3  *
4  * Barret Rhoden <brho@cs.berkeley.edu>
5  * Original by Paul Pearce <pearce@eecs.berkeley.edu> */
6
7 #include <arch/x86.h>
8 #include <arch/pci.h>
9 #include <trap.h>
10 #include <stdio.h>
11 #include <string.h>
12 #include <assert.h>
13 #include <kmalloc.h>
14 #include <arch/pci_defs.h>
15
16 /* List of all discovered devices */
17 struct pcidev_stailq pci_devices = STAILQ_HEAD_INITIALIZER(pci_devices);
18
19 static char STD_PCI_DEV[] = "Standard PCI Device";
20 static char PCI2PCI[] = "PCI-to-PCI Bridge";
21 static char PCI2CARDBUS[] = "PCI-Cardbus Bridge";
22
23 /* memory bars have a little dance you go through to detect what the size of the
24  * memory region is.  for 64 bit bars, i'm assuming you only need to do this to
25  * the lower part (no device will need > 4GB, right?). */
26 uint32_t pci_membar_get_sz(struct pci_device *pcidev, int bar)
27 {
28         /* save the old value, write all 1s, invert, add 1, restore.
29          * http://wiki.osdev.org/PCI for details. */
30         uint8_t bar_off = PCI_BAR0_STD + bar * PCI_BAR_OFF;
31         uint32_t old_val = pcidev_read32(pcidev, bar_off);
32         uint32_t retval;
33         pcidev_write32(pcidev, bar_off, 0xffffffff);
34         /* Don't forget to mask the lower 3 bits! */
35         retval = pcidev_read32(pcidev, bar_off) & PCI_BAR_MEM_MASK;
36         retval = ~retval + 1;
37         pcidev_write32(pcidev, bar_off, old_val);
38         return retval;
39 }
40
41 /* process the bars.  these will tell us what address space (PIO or memory) and
42  * where the base is.  fills results into pcidev.  i don't know if you can have
43  * multiple bars with conflicting/different regions (like two separate PIO
44  * ranges).  I'm assuming you don't, and will warn if we see one. */
45 static void pci_handle_bars(struct pci_device *pcidev)
46 {
47         /* only handling standards for now */
48         uint32_t bar_val;
49         int max_bars = pcidev->header_type == STD_PCI_DEV ? MAX_PCI_BAR : 0;
50         /* TODO: consider aborting for classes 00, 05 (memory ctlr), 06 (bridge) */
51         for (int i = 0; i < max_bars; i++) {
52                 bar_val = pci_getbar(pcidev, i);
53                 pcidev->bar[i].raw_bar = bar_val;
54                 if (!bar_val)   /* (0 denotes no valid data) */
55                         continue;
56                 if (pci_is_iobar(bar_val)) {
57                         pcidev->bar[i].pio_base = pci_getiobar32(bar_val);
58                 } else {
59                         if (pci_is_membar32(bar_val)) {
60                                 pcidev->bar[i].mmio_base32 = bar_val & PCI_BAR_MEM_MASK;
61                                 pcidev->bar[i].mmio_sz = pci_membar_get_sz(pcidev, i);
62                         } else if (pci_is_membar64(bar_val)) {
63                                 /* 64 bit, the lower 32 are in this bar, the upper
64                                  * are in the next bar */
65                                 pcidev->bar[i].mmio_base64 = bar_val & PCI_BAR_MEM_MASK;
66                                 assert(i < max_bars - 1);
67                                 bar_val = pci_getbar(pcidev, i + 1);    /* read next bar */
68                                 /* note we don't check for IO or memsize.  the entire next bar
69                                  * is supposed to be for the upper 32 bits. */
70                                 pcidev->bar[i].mmio_base64 |= (uint64_t)bar_val << 32;
71                                 pcidev->bar[i].mmio_sz = pci_membar_get_sz(pcidev, i);
72                                 i++;
73                         }
74                 }
75                 /* this will track the maximum bar we've had.  it'll include the 64 bit
76                  * uppers, as well as devices that have only higher numbered bars. */
77                 pcidev->nr_bars = i + 1;
78         }
79 }
80
81 /* Scans the PCI bus.  Won't actually work for anything other than bus 0, til we
82  * sort out how to handle bridge devices. */
83 void pci_init(void) {
84         uint32_t result = 0;
85         uint16_t dev_id, ven_id;
86         struct pci_device *pcidev;
87         int max_nr_func;
88         for (int i = 0; i < PCI_MAX_BUS - 1; i++) {     /* phantoms at 0xff */
89                 for (int j = 0; j < PCI_MAX_DEV; j++) {
90                         max_nr_func = 1;
91                         for (int k = 0; k < max_nr_func; k++) {
92                                 result = pci_read32(i, j, k, PCI_DEV_VEND_REG);
93                                 dev_id = result >> 16;
94                                 ven_id = result & 0xffff;
95                                 /* Skip invalid IDs (not a device) */
96                                 if (ven_id == INVALID_VENDOR_ID) 
97                                         break;  /* skip functions too, they won't exist */
98                                 pcidev = kzmalloc(sizeof(struct pci_device), 0);
99                                 pcidev->bus = i;
100                                 pcidev->dev = j;
101                                 pcidev->func = k;
102                                 pcidev->dev_id = dev_id;
103                                 pcidev->ven_id = ven_id;
104                                 /* Get the Class/subclass */
105                                 pcidev->class = pcidev_read8(pcidev, PCI_CLASS_REG);
106                                 pcidev->subclass = pcidev_read8(pcidev, PCI_SUBCLASS_REG);
107                                 pcidev->progif = pcidev_read8(pcidev, PCI_PROGIF_REG);
108                                 /* All device types (0, 1, 2) have the IRQ in the same place */
109                                 /* This is the PIC IRQ the device is wired to */
110                                 pcidev->irqline = pcidev_read8(pcidev, PCI_IRQLINE_STD);
111                                 /* This is the interrupt pin the device uses (INTA# - INTD#) */
112                                 pcidev->irqpin = pcidev_read8(pcidev, PCI_IRQPIN_STD);
113                                 /* bottom 7 bits are header type */
114                                 switch (pcidev_read8(pcidev, PCI_HEADER_REG) & 0x7c) {
115                                         case 0x00:
116                                                 pcidev->header_type = STD_PCI_DEV;
117                                                 break;
118                                         case 0x01:
119                                                 pcidev->header_type = PCI2PCI;
120                                                 break;
121                                         case 0x02:
122                                                 pcidev->header_type = PCI2CARDBUS;
123                                                 break;
124                                         default:
125                                                 pcidev->header_type = "Unknown Header Type";
126                                 }
127                                 pci_handle_bars(pcidev);
128                                 STAILQ_INSERT_TAIL(&pci_devices, pcidev, all_dev);
129                                 #ifdef CONFIG_PCI_VERBOSE
130                                 pcidev_print_info(pcidev, 4);
131                                 #else
132                                 pcidev_print_info(pcidev, 0);
133                                 #endif /* CONFIG_PCI_VERBOSE */
134                                 /* Top bit determines if we have multiple functions on this
135                                  * device.  We can't just check for more functions, since
136                                  * non-multifunction devices exist that respond to different
137                                  * functions with the same underlying device (same bars etc).
138                                  * Note that this style allows for devices that only report
139                                  * multifunction in the first function's header. */
140                                 if (pcidev_read8(pcidev, PCI_HEADER_REG) & 0x80)
141                                         max_nr_func = PCI_MAX_FUNC;
142                         }
143                 }
144         }
145 }
146
147 uint32_t pci_config_addr(uint8_t bus, uint8_t dev, uint8_t func, uint8_t reg)
148 {
149         return (uint32_t)(((uint32_t)bus << 16) |
150                           ((uint32_t)dev << 11) |
151                           ((uint32_t)func << 8) |
152                           (reg & 0xfc) | 0x80000000);
153 }
154
155 /* Helper to read 32 bits from the config space of B:D:F.  'Offset' is how far
156  * into the config space we offset before reading, aka: where we are reading. */
157 uint32_t pci_read32(uint8_t bus, uint8_t dev, uint8_t func, uint8_t offset)
158 {
159         /* Send type 1 requests for everything beyond bus 0.  Note this does nothing
160          * until we configure the PCI bridges (which we don't do yet). */
161         if (bus !=  0)
162                 offset |= 0x1;
163         outl(PCI_CONFIG_ADDR, pci_config_addr(bus, dev, func, offset));
164         return inl(PCI_CONFIG_DATA);
165 }
166
167 /* Same, but writes (doing 32bit at a time).  Never actually tested (not sure if
168  * PCI lets you write back). */
169 void pci_write32(uint8_t bus, uint8_t dev, uint8_t func, uint8_t offset,
170                  uint32_t value)
171 {
172         outl(PCI_CONFIG_ADDR, pci_config_addr(bus, dev, func, offset));
173         outl(PCI_CONFIG_DATA, value);
174 }
175
176 /* Helper to read from a specific device's config space. */
177 uint32_t pcidev_read32(struct pci_device *pcidev, uint8_t offset)
178 {
179         return pci_read32(pcidev->bus, pcidev->dev, pcidev->func, offset);
180 }
181
182 /* Helper to write to a specific device */
183 void pcidev_write32(struct pci_device *pcidev, uint8_t offset, uint32_t value)
184 {
185         pci_write32(pcidev->bus, pcidev->dev, pcidev->func, offset, value);
186 }
187
188 /* For the 16 and 8 functions, we need to access on 32 bit alignments, then
189  * figure out which byte/word we need to read/write.  & 0xfc will give us the 4
190  * byte aligned offset to access in PCI space.  & 0x3 will give the offset
191  * within the 32 bits (number of bytes).  When writing, we also need to x-out
192  * any existing values (and not just |=). */
193
194 /* Returns the 32-bit addr/offset needed to access 'offset'. */
195 static inline uint8_t __pci_off32(uint8_t offset)
196 {
197         return offset & 0xfc;
198 }
199
200 /* Returns the number of bits needed to shift to get the offset's spot in a 32
201  * bit config register. */
202 static inline uint8_t __pci_shift_for(uint8_t offset)
203 {
204         return (offset & 0x3) * 8;
205 }
206
207 uint16_t pcidev_read16(struct pci_device *pcidev, uint8_t offset)
208 {
209         uint32_t retval = pcidev_read32(pcidev, __pci_off32(offset));
210         /* 0x2 would work here, since offset & 0x3 should be 0 or 2 */
211         retval >>= __pci_shift_for(offset);
212         return (uint16_t)(retval & 0xffff);
213 }
214
215 void pcidev_write16(struct pci_device *pcidev, uint8_t offset, uint16_t value)
216 {
217         uint32_t readval = pcidev_read32(pcidev, __pci_off32(offset));
218         uint32_t writeval = (uint32_t)value << __pci_shift_for(offset);
219         readval &= ~(0xffff << __pci_shift_for(offset));
220         pcidev_write32(pcidev, __pci_off32(offset), readval | writeval);
221 }
222
223 uint8_t pcidev_read8(struct pci_device *pcidev, uint8_t offset)
224 {
225         uint32_t retval = pcidev_read32(pcidev, __pci_off32(offset));
226         retval >>= __pci_shift_for(offset);
227         return (uint8_t)(retval & 0xff);
228 }
229
230 void pcidev_write8(struct pci_device *pcidev, uint8_t offset, uint8_t value)
231 {
232         uint32_t readval = pcidev_read32(pcidev, __pci_off32(offset));
233         uint32_t writeval = (uint32_t)value << __pci_shift_for(offset);
234         readval &= ~(0xff << __pci_shift_for(offset));
235         pcidev_write32(pcidev, __pci_off32(offset), readval | writeval);
236 }
237
238 /* Gets any old raw bar, with some catches based on type. */
239 uint32_t pci_getbar(struct pci_device *pcidev, unsigned int bar)
240 {
241         uint32_t type;
242         if (bar >= MAX_PCI_BAR)
243                 panic("Nonexistant bar requested!");
244         type = pcidev_read8(pcidev, PCI_HEADER_REG);
245         /* Only types 0 and 1 have BARS */
246         if ((type != 0x00) && (type != 0x01))
247                 return 0;
248         /* Only type 0 has BAR2 - BAR5 */
249         if ((bar > 1) && (type != 0x00))
250                 return 0;
251         return pcidev_read32(pcidev, PCI_BAR0_STD + bar * PCI_BAR_OFF);
252 }
253
254 /* Determines if a given bar is IO (o/w, it's mem) */
255 bool pci_is_iobar(uint32_t bar)
256 {
257         return bar & PCI_BAR_IO;
258 }
259
260 bool pci_is_membar32(uint32_t bar)
261 {
262         if (pci_is_iobar(bar))
263                 return FALSE;
264         return (bar & PCI_MEMBAR_TYPE) == PCI_MEMBAR_32BIT;
265 }
266
267 bool pci_is_membar64(uint32_t bar)
268 {
269         if (pci_is_iobar(bar))
270                 return FALSE;
271         return (bar & PCI_MEMBAR_TYPE) == PCI_MEMBAR_64BIT;
272 }
273
274 /* Helper to get the address from a membar.  Check the type beforehand */
275 uint32_t pci_getmembar32(uint32_t bar)
276 {
277         uint8_t type = bar & PCI_MEMBAR_TYPE;
278         if (type != PCI_MEMBAR_32BIT) {
279                 warn("Unhandled PCI membar type: %02p\n", type >> 1);
280                 return 0;
281         }
282         return bar & 0xfffffff0;
283 }
284
285 /* Helper to get the address from an IObar.  Check the type beforehand */
286 uint32_t pci_getiobar32(uint32_t bar)
287 {
288         return bar & 0xfffffffc;
289 }
290
291 /* Helper to get the class description strings.  Adapted from
292  * http://www.pcidatabase.com/reports.php?type=c-header */
293 static void pcidev_get_cldesc(struct pci_device *pcidev, char **class,
294                               char **subclass, char **progif)
295 {
296         int     i ;
297         *class = *subclass = *progif = "";
298
299         for (i = 0; i < PCI_CLASSCODETABLE_LEN; i++) {
300                 if (PciClassCodeTable[i].BaseClass == pcidev->class) {
301                         if (!(**class))
302                                 *class = PciClassCodeTable[i].BaseDesc;
303                         if (PciClassCodeTable[i].SubClass == pcidev->subclass) {
304                                 if (!(**subclass))
305                                         *subclass = PciClassCodeTable[i].SubDesc;
306                                 if (PciClassCodeTable[i].ProgIf == pcidev->progif) {
307                                         *progif = PciClassCodeTable[i].ProgDesc;
308                                         break ;
309                                 }
310                         }
311                 }
312         }
313 }
314
315 /* Helper to get the vendor and device description strings */
316 static void pcidev_get_devdesc(struct pci_device *pcidev, char **vend_short,
317                                char **vend_full, char **chip, char **chip_desc)
318 {
319         int     i ;
320         *vend_short = *vend_full = *chip = *chip_desc = "";
321
322         for (i = 0; i < PCI_VENTABLE_LEN; i++) {
323                 if (PciVenTable[i].VenId == pcidev->ven_id) {
324                         *vend_short = PciVenTable[i].VenShort;
325                         *vend_full = PciVenTable[i].VenFull;
326                         break ;
327                 }
328         }
329         for (i = 0; i < PCI_DEVTABLE_LEN; i++) {
330                 if ((PciDevTable[i].VenId == pcidev->ven_id) &&
331                    (PciDevTable[i].DevId == pcidev->dev_id)) {
332                         *chip = PciDevTable[i].Chip;
333                         *chip_desc = PciDevTable[i].ChipDesc;
334                         break ;
335                 }
336         }
337 }
338
339 /* Prints info (like lspci) for a device */
340 void pcidev_print_info(struct pci_device *pcidev, int verbosity)
341 {
342         char *ven_sht, *ven_fl, *chip, *chip_txt, *class, *subcl, *progif;
343         pcidev_get_cldesc(pcidev, &class, &subcl, &progif);
344         pcidev_get_devdesc(pcidev, &ven_sht, &ven_fl, &chip, &chip_txt);
345
346         printk("%02x:%02x.%x %s: %s %s %s: %s\n",
347                pcidev->bus,
348                pcidev->dev,
349                pcidev->func,
350                subcl,
351                ven_sht,
352                chip,
353                chip_txt,
354                    pcidev->header_type);
355         if (verbosity < 1)      /* whatever */
356                 return;
357         printk("\tIRQ: %02d IRQ pin: 0x%02x\n",
358                pcidev->irqline,
359                pcidev->irqpin);
360         printk("\tVendor Id: 0x%04x Device Id: 0x%04x\n",
361                pcidev->ven_id,
362                pcidev->dev_id);
363         printk("\t%s %s %s\n",
364                class,
365                progif,
366                ven_fl);
367         for (int i = 0; i < pcidev->nr_bars; i++) {
368                 if (pcidev->bar[i].raw_bar == 0)
369                         continue;
370                 printk("\tBAR %d: ", i);
371                 if (pci_is_iobar(pcidev->bar[i].raw_bar)) {
372                         assert(pcidev->bar[i].pio_base);
373                         printk("IO port 0x%04x\n", pcidev->bar[i].pio_base);
374                 } else {
375                         bool bar_is_64 = pci_is_membar64(pcidev->bar[i].raw_bar);
376                         printk("MMIO Base %p, MMIO Size %p\n",
377                                bar_is_64 ? pcidev->bar[i].mmio_base64 :
378                                            pcidev->bar[i].mmio_base32,
379                                pcidev->bar[i].mmio_sz);
380                         /* Takes up two bars */
381                         if (bar_is_64) {
382                                 assert(!pcidev->bar[i].mmio_base32);    /* double-check */
383                                 i++;
384                         }
385                 }
386         }
387 }
388
389 void pci_set_bus_master(struct pci_device *pcidev)
390 {
391         pcidev_write16(pcidev, PCI_CMD_REG, pcidev_read16(pcidev, PCI_CMD_REG) |
392                                             PCI_CMD_BUS_MAS);
393 }