Add comment for nexus_pcib_write_config.
[dragonfly.git] / sys / bus / pci / i386 / pcibus.c
1 /*
2  * Copyright (c) 1997, Stefan Esser <se@freebsd.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice unmodified, this list of conditions, and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/i386/isa/pcibus.c,v 1.57.2.11 2002/11/13 21:40:40 peter Exp $
27  * $DragonFly: src/sys/bus/pci/i386/pcibus.c,v 1.7 2004/01/15 20:45:09 joerg Exp $
28  *
29  */
30
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/bus.h>
34 #include <sys/kernel.h>
35 #include <sys/malloc.h>
36
37 #include <bus/pci/pcivar.h>
38 #include <bus/pci/pcireg.h>
39 #include <bus/pci/i386/pcibus.h>
40 #include <bus/isa/isavar.h>
41 #include <bus/pci/i386/pci_cfgreg.h>
42 #include <machine/md_var.h>
43 #include <machine/nexusvar.h>
44
45 #include "pcib_if.h"
46
47 static int
48 nexus_pcib_maxslots(device_t dev)
49 {
50         return 31;
51 }
52
53 /*
54  * Read configuration space register.
55  */
56 static u_int32_t
57 nexus_pcib_read_config(device_t dev, int bus, int slot, int func,
58                        int reg, int bytes)
59 {
60         return (pci_cfgregread(bus, slot, func, reg, bytes));
61 }
62
63 /*
64  * Write configuration space register.
65  */
66 static void
67 nexus_pcib_write_config(device_t dev, int bus, int slot, int func,
68                         int reg, u_int32_t data, int bytes)
69 {
70         pci_cfgregwrite(bus, slot, func, reg, data, bytes);
71 }
72
73 static devclass_t       pcib_devclass;
74
75 static const char *
76 nexus_pcib_is_host_bridge(int bus, int slot, int func,
77                           u_int32_t id, u_int8_t class, u_int8_t subclass,
78                           u_int8_t *busnum)
79 {
80         const char *s = NULL;
81         static u_int8_t pxb[4]; /* hack for 450nx */
82
83         *busnum = 0;
84
85         switch (id) {
86         case 0x12258086:
87                 s = "Intel 824?? host to PCI bridge";
88                 /* XXX This is a guess */
89                 /* *busnum = nexus_pcib_read_config(0, bus, slot, func, 0x41, 1); */
90                 *busnum = bus;
91                 break;
92         case 0x71208086:
93                 s = "Intel 82810 (i810 GMCH) Host To Hub bridge";
94                 break;
95         case 0x71228086:
96                 s = "Intel 82810-DC100 (i810-DC100 GMCH) Host To Hub bridge";
97                 break;
98         case 0x71248086:
99                 s = "Intel 82810E (i810E GMCH) Host To Hub bridge";
100                 break;
101         case 0x71808086:
102                 s = "Intel 82443LX (440 LX) host to PCI bridge";
103                 break;
104         case 0x71908086:
105                 s = "Intel 82443BX (440 BX) host to PCI bridge";
106                 break;
107         case 0x71928086:
108                 s = "Intel 82443BX host to PCI bridge (AGP disabled)";
109                 break;
110         case 0x71948086:
111                 s = "Intel 82443MX host to PCI bridge";
112                 break;
113         case 0x71a08086:
114                 s = "Intel 82443GX host to PCI bridge";
115                 break;
116         case 0x71a18086:
117                 s = "Intel 82443GX host to AGP bridge";
118                 break;
119         case 0x71a28086:
120                 s = "Intel 82443GX host to PCI bridge (AGP disabled)";
121                 break;
122         case 0x84c48086:
123                 s = "Intel 82454KX/GX (Orion) host to PCI bridge";
124                 *busnum = nexus_pcib_read_config(0, bus, slot, func, 0x4a, 1);
125                 break;
126         case 0x84ca8086:
127                 /*
128                  * For the 450nx chipset, there is a whole bundle of
129                  * things pretending to be host bridges. The MIOC will 
130                  * be seen first and isn't really a pci bridge (the
131                  * actual busses are attached to the PXB's). We need to 
132                  * read the registers of the MIOC to figure out the
133                  * bus numbers for the PXB channels.
134                  *
135                  * Since the MIOC doesn't have a pci bus attached, we
136                  * pretend it wasn't there.
137                  */
138                 pxb[0] = nexus_pcib_read_config(0, bus, slot, func,
139                                                 0xd0, 1); /* BUSNO[0] */
140                 pxb[1] = nexus_pcib_read_config(0, bus, slot, func,
141                                                 0xd1, 1) + 1;   /* SUBA[0]+1 */
142                 pxb[2] = nexus_pcib_read_config(0, bus, slot, func,
143                                                 0xd3, 1); /* BUSNO[1] */
144                 pxb[3] = nexus_pcib_read_config(0, bus, slot, func,
145                                                 0xd4, 1) + 1;   /* SUBA[1]+1 */
146                 return NULL;
147         case 0x84cb8086:
148                 switch (slot) {
149                 case 0x12:
150                         s = "Intel 82454NX PXB#0, Bus#A";
151                         *busnum = pxb[0];
152                         break;
153                 case 0x13:
154                         s = "Intel 82454NX PXB#0, Bus#B";
155                         *busnum = pxb[1];
156                         break;
157                 case 0x14:
158                         s = "Intel 82454NX PXB#1, Bus#A";
159                         *busnum = pxb[2];
160                         break;
161                 case 0x15:
162                         s = "Intel 82454NX PXB#1, Bus#B";
163                         *busnum = pxb[3];
164                         break;
165                 }
166                 break;
167         case 0x1A308086:
168                 s = "Intel 82845 Host to PCI bridge";
169                 break;
170
171                 /* AMD -- vendor 0x1022 */
172         case 0x30001022:
173                 s = "AMD Elan SC520 host to PCI bridge";
174 #ifdef CPU_ELAN
175                 init_AMD_Elan_sc520();
176 #else
177                 printf("*** WARNING: kernel option CPU_ELAN missing");
178                 printf("-- timekeeping may be wrong\n");
179 #endif
180                 break;
181         case 0x70061022:
182                 s = "AMD-751 host to PCI bridge";
183                 break;
184         case 0x700e1022:
185                 s = "AMD-761 host to PCI bridge";
186                 break;
187
188                 /* SiS -- vendor 0x1039 */
189         case 0x04961039:
190                 s = "SiS 85c496";
191                 break;
192         case 0x04061039:
193                 s = "SiS 85c501";
194                 break;
195         case 0x06011039:
196                 s = "SiS 85c601";
197                 break;
198         case 0x55911039:
199                 s = "SiS 5591 host to PCI bridge";
200                 break;
201         case 0x00011039:
202                 s = "SiS 5591 host to AGP bridge";
203                 break;
204
205                 /* VLSI -- vendor 0x1004 */
206         case 0x00051004:
207                 s = "VLSI 82C592 Host to PCI bridge";
208                 break;
209
210                 /* XXX Here is MVP3, I got the datasheet but NO M/B to test it  */
211                 /* totally. Please let me know if anything wrong.            -F */
212                 /* XXX need info on the MVP3 -- any takers? */
213         case 0x05981106:
214                 s = "VIA 82C598MVP (Apollo MVP3) host bridge";
215                 break;
216
217                 /* AcerLabs -- vendor 0x10b9 */
218                 /* Funny : The datasheet told me vendor id is "10b8",sub-vendor */
219                 /* id is '10b9" but the register always shows "10b9". -Foxfair  */
220         case 0x154110b9:
221                 s = "AcerLabs M1541 (Aladdin-V) PCI host bridge";
222                 break;
223
224                 /* OPTi -- vendor 0x1045 */
225         case 0xc7011045:
226                 s = "OPTi 82C700 host to PCI bridge";
227                 break;
228         case 0xc8221045:
229                 s = "OPTi 82C822 host to PCI Bridge";
230                 break;
231
232                 /* ServerWorks -- vendor 0x1166 */
233         case 0x00051166:
234                 s = "ServerWorks NB6536 2.0HE host to PCI bridge";
235                 *busnum = nexus_pcib_read_config(0, bus, slot, func, 0x44, 1);
236                 break;
237         
238         case 0x00061166:
239                 /* FALLTHROUGH */
240         case 0x00081166:
241                 s = "ServerWorks host to PCI bridge";
242                 *busnum = nexus_pcib_read_config(0, bus, slot, func, 0x44, 1);
243                 break;
244
245         case 0x00091166:
246                 s = "ServerWorks NB6635 3.0LE host to PCI bridge";
247                 *busnum = nexus_pcib_read_config(0, bus, slot, func, 0x44, 1);
248                 break;
249
250         case 0x00101166:
251                 s = "ServerWorks CIOB30 host to PCI bridge";
252                 *busnum = nexus_pcib_read_config(0, bus, slot, func, 0x44, 1);
253                 break;
254
255                 /* XXX unknown chipset, but working */
256         case 0x00171166:
257                 /* FALLTHROUGH */
258         case 0x01011166:
259                 s = "ServerWorks host to PCI bridge(unknown chipset)";
260                 *busnum = nexus_pcib_read_config(0, bus, slot, func, 0x44, 1);
261                 break;
262
263                 /* Integrated Micro Solutions -- vendor 0x10e0 */
264         case 0x884910e0:
265                 s = "Integrated Micro Solutions VL Bridge";
266                 break;
267
268         default:
269                 if (class == PCIC_BRIDGE && subclass == PCIS_BRIDGE_HOST)
270                         s = "Host to PCI bridge";
271                 break;
272         }
273
274         return s;
275 }
276
277 /*
278  * Scan the first pci bus for host-pci bridges and add pcib instances
279  * to the nexus for each bridge.
280  */
281 static void
282 nexus_pcib_identify(driver_t *driver, device_t parent)
283 {
284         int bus, slot, func;
285         u_int8_t  hdrtype;
286         int found = 0;
287         int pcifunchigh;
288         int found824xx = 0;
289         device_t child;
290         devclass_t pci_devclass;
291
292         if (pci_cfgregopen() == 0)
293                 return;
294         /*
295          * Check to see if we haven't already had a PCI bus added
296          * via some other means. If we have, bail since otherwise
297          * we're going to end up duplicating it.
298          */
299         if ((pci_devclass = devclass_find("pci")) &&
300             devclass_get_device(pci_devclass,0))
301                 return;
302         
303         bus = 0;
304  retry:
305         for (slot = 0; slot <= PCI_SLOTMAX; slot++) {
306                 func = 0;
307                 hdrtype = nexus_pcib_read_config(0, bus, slot, func,
308                                                  PCIR_HEADERTYPE, 1);
309                 if (hdrtype & PCIM_MFDEV)
310                         pcifunchigh = 7;
311                 else
312                         pcifunchigh = 0;
313                 for (func = 0; func <= pcifunchigh; func++) {
314                         /*
315                          * Read the IDs and class from the device.
316                          */
317                         u_int32_t id;
318                         u_int8_t class, subclass, busnum;
319                         const char *s;
320                         device_t *devs;
321                         int ndevs, i;
322
323                         id = nexus_pcib_read_config(0, bus, slot, func,
324                                                     PCIR_DEVVENDOR, 4);
325                         if (id == -1)
326                                 continue;
327                         class = nexus_pcib_read_config(0, bus, slot, func,
328                                                        PCIR_CLASS, 1);
329                         subclass = nexus_pcib_read_config(0, bus, slot, func,
330                                                           PCIR_SUBCLASS, 1);
331
332                         s = nexus_pcib_is_host_bridge(bus, slot, func,
333                                                       id, class, subclass,
334                                                       &busnum);
335                         if (s == NULL)
336                                 continue;
337
338                         /*
339                          * Check to see if the physical bus has already
340                          * been seen. Eg: hybrid 32 and 64 bit host
341                          * bridges to the same logical bus.
342                          */
343                         if (device_get_children(parent, &devs, &ndevs) == 0) {
344                                 for (i = 0; s != NULL && i < ndevs; i++) {
345                                         if (strcmp(device_get_name(devs[i]),
346                                             "pcib") != 0)
347                                                 continue;
348                                         if (nexus_get_pcibus(devs[i]) == busnum)
349                                                 s = NULL;
350                                 }
351                                 free(devs, M_TEMP);
352                         }
353
354                         if (s == NULL)
355                                 continue;
356                         /*
357                          * Add at priority 100 to make sure we
358                          * go after any motherboard resources
359                          */
360                         child = BUS_ADD_CHILD(parent, 100,
361                                               "pcib", busnum);
362                         device_set_desc(child, s);
363                         nexus_set_pcibus(child, busnum);
364
365                         found = 1;
366                         if (id == 0x12258086)
367                                 found824xx = 1;
368                 }
369         }
370         if (found824xx && bus == 0) {
371                 bus++;
372                 goto retry;
373         }
374
375         /*
376          * Make sure we add at least one bridge since some old
377          * hardware doesn't actually have a host-pci bridge device.
378          * Note that pci_cfgregopen() thinks we have PCI devices..
379          */
380         if (!found) {
381                 if (bootverbose)
382                         printf(
383         "nexus_pcib_identify: no bridge found, adding pcib0 anyway\n");
384                 child = BUS_ADD_CHILD(parent, 100, "pcib", 0);
385                 nexus_set_pcibus(child, 0);
386         }
387 }
388
389 static int
390 nexus_pcib_probe(device_t dev)
391 {
392         devclass_t pci_devclass;
393
394         if (pci_cfgregopen() == 0)
395                 return (ENXIO);
396         /*
397          * Check to see if we haven't already had a PCI bus added
398          * via some other means.  If we have, bail since otherwise
399          * we're going to end up duplicating it.
400          */
401         if ((pci_devclass = devclass_find("pci")) && 
402                 devclass_get_device(pci_devclass, device_get_unit(dev)))
403                 return (ENXIO);
404
405         return (0);
406 }
407
408 static int
409 nexus_pcib_attach(device_t dev)
410 {
411         device_t child;
412
413         child = device_add_child(dev, "pci", device_get_unit(dev));
414
415         return (bus_generic_attach(dev));
416 }
417
418 static int
419 nexus_pcib_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
420 {
421         switch (which) {
422         case  PCIB_IVAR_BUS:
423                 *result = nexus_get_pcibus(dev);
424                 return (0);
425         }
426         return (ENOENT);
427 }
428
429 static int
430 nexus_pcib_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
431 {
432         switch (which) {
433         case  PCIB_IVAR_BUS:
434                 nexus_set_pcibus(dev, value);
435                 return (0);
436         }
437         return (ENOENT);
438 }
439
440 /* route interrupt */
441
442 static int
443 nexus_pcib_route_interrupt(device_t pcib, device_t dev, int pin)
444 {
445         return(pci_cfgintr(pci_get_bus(dev), pci_get_slot(dev), pin, 
446                            pci_get_irq(dev)));
447 }
448
449 static device_method_t nexus_pcib_methods[] = {
450         /* Device interface */
451         DEVMETHOD(device_identify,      nexus_pcib_identify),
452         DEVMETHOD(device_probe,         nexus_pcib_probe),
453         DEVMETHOD(device_attach,        nexus_pcib_attach),
454         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
455         DEVMETHOD(device_suspend,       bus_generic_suspend),
456         DEVMETHOD(device_resume,        bus_generic_resume),
457
458         /* Bus interface */
459         DEVMETHOD(bus_print_child,      bus_generic_print_child),
460         DEVMETHOD(bus_read_ivar,        nexus_pcib_read_ivar),
461         DEVMETHOD(bus_write_ivar,       nexus_pcib_write_ivar),
462         DEVMETHOD(bus_alloc_resource,   bus_generic_alloc_resource),
463         DEVMETHOD(bus_release_resource, bus_generic_release_resource),
464         DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
465         DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
466         DEVMETHOD(bus_setup_intr,       bus_generic_setup_intr),
467         DEVMETHOD(bus_teardown_intr,    bus_generic_teardown_intr),
468
469         /* pcib interface */
470         DEVMETHOD(pcib_maxslots,        nexus_pcib_maxslots),
471         DEVMETHOD(pcib_read_config,     nexus_pcib_read_config),
472         DEVMETHOD(pcib_write_config,    nexus_pcib_write_config),
473         DEVMETHOD(pcib_route_interrupt, nexus_pcib_route_interrupt),
474
475         { 0, 0 }
476 };
477
478 static driver_t nexus_pcib_driver = {
479         "pcib",
480         nexus_pcib_methods,
481         1,
482 };
483
484 DRIVER_MODULE(pcib, nexus, nexus_pcib_driver, pcib_devclass, 0, 0);
485
486
487 /*
488  * Provide a device to "eat" the host->pci bridges that we dug up above
489  * and stop them showing up twice on the probes.  This also stops them
490  * showing up as 'none' in pciconf -l.
491  */
492 static int
493 pci_hostb_probe(device_t dev)
494 {
495         if (pci_get_class(dev) == PCIC_BRIDGE &&
496             pci_get_subclass(dev) == PCIS_BRIDGE_HOST) {
497                 device_set_desc(dev, "Host to PCI bridge");
498                 device_quiet(dev);
499                 return 0;
500         }
501         return (ENXIO);
502 }
503
504 static int
505 pci_hostb_attach(device_t dev)
506 {
507         return (0);
508 }
509
510 static device_method_t pci_hostb_methods[] = {
511         /* Device interface */
512         DEVMETHOD(device_probe,         pci_hostb_probe),
513         DEVMETHOD(device_attach,        pci_hostb_attach),
514         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
515         DEVMETHOD(device_suspend,       bus_generic_suspend),
516         DEVMETHOD(device_resume,        bus_generic_resume),
517
518         { 0, 0 }
519 };
520 static driver_t pci_hostb_driver = {
521         "hostb",
522         pci_hostb_methods,
523         1,
524 };
525 static devclass_t pci_hostb_devclass;
526
527 DRIVER_MODULE(hostb, pci, pci_hostb_driver, pci_hostb_devclass, 0, 0);
528
529
530 /*
531  * Install placeholder to claim the resources owned by the
532  * PCI bus interface.  This could be used to extract the 
533  * config space registers in the extreme case where the PnP
534  * ID is available and the PCI BIOS isn't, but for now we just
535  * eat the PnP ID and do nothing else.
536  *
537  * XXX we should silence this probe, as it will generally confuse 
538  * people.
539  */
540 static struct isa_pnp_id pcibus_pnp_ids[] = {
541         { 0x030ad041 /* PNP030A */, "PCI Bus" },
542         { 0 }
543 };
544
545 static int
546 pcibus_pnp_probe(device_t dev)
547 {
548         int result;
549         
550         if ((result = ISA_PNP_PROBE(device_get_parent(dev), dev, pcibus_pnp_ids)) <= 0)
551                 device_quiet(dev);
552         return (result);
553 }
554
555 static int
556 pcibus_pnp_attach(device_t dev)
557 {
558         return(0);
559 }
560
561 static device_method_t pcibus_pnp_methods[] = {
562         /* Device interface */
563         DEVMETHOD(device_probe,         pcibus_pnp_probe),
564         DEVMETHOD(device_attach,        pcibus_pnp_attach),
565         DEVMETHOD(device_detach,        bus_generic_detach),
566         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
567         DEVMETHOD(device_suspend,       bus_generic_suspend),
568         DEVMETHOD(device_resume,        bus_generic_resume),
569         { 0, 0 }
570 };
571
572 static driver_t pcibus_pnp_driver = {
573         "pcibus_pnp",
574         pcibus_pnp_methods,
575         1,              /* no softc */
576 };
577
578 static devclass_t pcibus_pnp_devclass;
579
580 DRIVER_MODULE(pcibus_pnp, isa, pcibus_pnp_driver, pcibus_pnp_devclass, 0, 0);