Strip down i386 PCI configuration space I/O to the bare minimum. A
[people/xl0/gpxe.git] / src / drivers / bus / pci.c
1 /*
2  * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * Based in part on pci.c from Etherboot 5.4, by Ken Yap and David
5  * Munro, in turn based on the Linux kernel's PCI implementation.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License as
9  * published by the Free Software Foundation; either version 2 of the
10  * License, or any later version.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  */
21
22 #include <stdint.h>
23 #include <string.h>
24 #include <errno.h>
25 #include <malloc.h>
26 #include <gpxe/tables.h>
27 #include <gpxe/device.h>
28 #include <gpxe/pci.h>
29
30 /** @file
31  *
32  * PCI bus
33  *
34  */
35
36 static struct pci_driver pci_drivers[0] __table_start ( pci_drivers );
37 static struct pci_driver pci_drivers_end[0] __table_end ( pci_drivers );
38
39 static void pcibus_remove ( struct root_device *rootdev );
40
41 /**
42  * Read PCI BAR
43  *
44  * @v pci               PCI device
45  * @v reg               PCI register number
46  * @ret bar             Base address register
47  *
48  * Reads the specified PCI base address register, including the flags
49  * portion.  64-bit BARs will be handled automatically.  If the value
50  * of the 64-bit BAR exceeds the size of an unsigned long (i.e. if the
51  * high dword is non-zero on a 32-bit platform), then the value
52  * returned will be zero plus the flags for a 64-bit BAR.  Unreachable
53  * 64-bit BARs are therefore returned as uninitialised 64-bit BARs.
54  */
55 static unsigned long pci_bar ( struct pci_device *pci, unsigned int reg ) {
56         uint32_t low;
57         uint32_t high;
58
59         pci_read_config_dword ( pci, reg, &low );
60         if ( ( low & (PCI_BASE_ADDRESS_SPACE|PCI_BASE_ADDRESS_MEM_TYPE_MASK) )
61              == (PCI_BASE_ADDRESS_SPACE_MEMORY|PCI_BASE_ADDRESS_MEM_TYPE_64) ){
62                 pci_read_config_dword ( pci, reg + 4, &high );
63                 if ( high ) {
64                         if ( sizeof ( unsigned long ) > sizeof ( uint32_t ) ) {
65                                 return ( ( ( uint64_t ) high << 32 ) | low );
66                         } else {
67                                 DBG ( "Unhandled 64-bit BAR %08x%08x\n",
68                                       high, low );
69                                 return PCI_BASE_ADDRESS_MEM_TYPE_64;
70                         }
71                 }
72         }
73         return low;
74 }
75
76 /**
77  * Find the start of a PCI BAR
78  *
79  * @v pci               PCI device
80  * @v reg               PCI register number
81  * @ret start           BAR start address
82  *
83  * Reads the specified PCI base address register, and returns the
84  * address portion of the BAR (i.e. without the flags).
85  *
86  * If the address exceeds the size of an unsigned long (i.e. if a
87  * 64-bit BAR has a non-zero high dword on a 32-bit machine), the
88  * return value will be zero.
89  */
90 unsigned long pci_bar_start ( struct pci_device *pci, unsigned int reg ) {
91         unsigned long bar;
92
93         bar = pci_bar ( pci, reg );
94         if ( (bar & PCI_BASE_ADDRESS_SPACE) == PCI_BASE_ADDRESS_SPACE_MEMORY ){
95                 return ( bar & PCI_BASE_ADDRESS_MEM_MASK );
96         } else {
97                 return ( bar & PCI_BASE_ADDRESS_IO_MASK );
98         }
99 }
100
101 /**
102  * Read membase and ioaddr for a PCI device
103  *
104  * @v pci               PCI device
105  *
106  * This scans through all PCI BARs on the specified device.  The first
107  * valid memory BAR is recorded as pci_device::membase, and the first
108  * valid IO BAR is recorded as pci_device::ioaddr.
109  *
110  * 64-bit BARs are handled automatically.  On a 32-bit platform, if a
111  * 64-bit BAR has a non-zero high dword, it will be regarded as
112  * invalid.
113  */
114 static void pci_read_bases ( struct pci_device *pci ) {
115         unsigned long bar;
116         int reg;
117
118         for ( reg = PCI_BASE_ADDRESS_0; reg <= PCI_BASE_ADDRESS_5; reg += 4 ) {
119                 bar = pci_bar ( pci, reg );
120                 if ( bar & PCI_BASE_ADDRESS_SPACE_IO ) {
121                         if ( ! pci->ioaddr )
122                                 pci->ioaddr = 
123                                         ( bar & PCI_BASE_ADDRESS_IO_MASK );
124                 } else {
125                         if ( ! pci->membase )
126                                 pci->membase =
127                                         ( bar & PCI_BASE_ADDRESS_MEM_MASK );
128                         /* Skip next BAR if 64-bit */
129                         if ( bar & PCI_BASE_ADDRESS_MEM_TYPE_64 )
130                                 reg += 4;
131                 }
132         }
133 }
134
135 /**
136  * Enable PCI device
137  *
138  * @v pci               PCI device
139  *
140  * Set device to be a busmaster in case BIOS neglected to do so.  Also
141  * adjust PCI latency timer to a reasonable value, 32.
142  */
143 void adjust_pci_device ( struct pci_device *pci ) {
144         unsigned short new_command, pci_command;
145         unsigned char pci_latency;
146
147         pci_read_config_word ( pci, PCI_COMMAND, &pci_command );
148         new_command = pci_command | PCI_COMMAND_MASTER | PCI_COMMAND_IO;
149         if ( pci_command != new_command ) {
150                 DBG ( "PCI BIOS has not enabled device %02x:%02x.%x! "
151                       "Updating PCI command %04x->%04x\n", pci->bus,
152                       PCI_SLOT ( pci->devfn ), PCI_FUNC ( pci->devfn ),
153                       pci_command, new_command );
154                 pci_write_config_word ( pci, PCI_COMMAND, new_command );
155         }
156
157         pci_read_config_byte ( pci, PCI_LATENCY_TIMER, &pci_latency);
158         if ( pci_latency < 32 ) {
159                 DBG ( "PCI device %02x:%02x.%x latency timer is unreasonably "
160                       "low at %d. Setting to 32.\n", pci->bus,
161                       PCI_SLOT ( pci->devfn ), PCI_FUNC ( pci->devfn ),
162                       pci_latency );
163                 pci_write_config_byte ( pci, PCI_LATENCY_TIMER, 32);
164         }
165 }
166
167 /**
168  * Register PCI device
169  *
170  * @v pci               PCI device
171  * @ret rc              Return status code
172  *
173  * Searches for a driver for the PCI device.  If a driver is found,
174  * its probe() routine is called, and the device is added to the
175  * device hierarchy.
176  */
177 static int register_pcidev ( struct pci_device *pci ) {
178         struct pci_driver *driver;
179         struct pci_device_id *id;
180         unsigned int i;
181         int rc;
182
183         DBG ( "Registering PCI device %02x:%02x.%x (%04x:%04x mem %lx "
184               "io %lx irq %d)\n", pci->bus, PCI_SLOT ( pci->devfn ),
185               PCI_FUNC ( pci->devfn ), pci->vendor, pci->device,
186               pci->membase, pci->ioaddr, pci->irq );
187
188         for ( driver = pci_drivers ; driver < pci_drivers_end ; driver++ ) {
189                 for ( i = 0 ; i < driver->id_count ; i++ ) {
190                         id = &driver->ids[i];
191                         if ( ( id->vendor != pci->vendor ) ||
192                              ( id->device != pci->device ) )
193                                 continue;
194                         pci->driver = driver;
195                         pci->name = id->name;
196                         DBG ( "...using driver %s\n", pci->name );
197                         if ( ( rc = driver->probe ( pci, id ) ) != 0 ) {
198                                 DBG ( "......probe failed\n" );
199                                 continue;
200                         }
201                         list_add ( &pci->dev.siblings,
202                                    &pci->dev.parent->children );
203                         return 0;
204                 }
205         }
206
207         DBG ( "...no driver found\n" );
208         return -ENOTTY;
209 }
210
211 /**
212  * Unregister a PCI device
213  *
214  * @v pci               PCI device
215  *
216  * Calls the device's driver's remove() routine, and removes the
217  * device from the device hierarchy.
218  */
219 static void unregister_pcidev ( struct pci_device *pci ) {
220         pci->driver->remove ( pci );
221         list_del ( &pci->dev.siblings );
222         DBG ( "Unregistered PCI device %02x:%02x.%x\n", pci->bus,
223               PCI_SLOT ( pci->devfn ), PCI_FUNC ( pci->devfn ) );
224 }
225
226 /**
227  * Probe PCI root bus
228  *
229  * @v rootdev           PCI bus root device
230  *
231  * Scans the PCI bus for devices and registers all devices it can
232  * find.
233  */
234 static int pcibus_probe ( struct root_device *rootdev ) {
235         struct pci_device *pci = NULL;
236         unsigned int max_bus;
237         unsigned int bus;
238         unsigned int devfn;
239         uint8_t hdrtype = 0;
240         uint32_t tmp;
241         int rc;
242
243         max_bus = pci_max_bus();
244         for ( bus = 0 ; bus <= max_bus ; bus++ ) {
245                 for ( devfn = 0 ; devfn <= 0xff ; devfn++ ) {
246
247                         /* Allocate struct pci_device */
248                         if ( ! pci )
249                                 pci = malloc ( sizeof ( *pci ) );
250                         if ( ! pci ) {
251                                 rc = -ENOMEM;
252                                 goto err;
253                         }
254                         memset ( pci, 0, sizeof ( *pci ) );
255                         pci->bus = bus;
256                         pci->devfn = devfn;
257                         
258                         /* Skip all but the first function on
259                          * non-multifunction cards
260                          */
261                         if ( PCI_FUNC ( devfn ) == 0 ) {
262                                 pci_read_config_byte ( pci, PCI_HEADER_TYPE,
263                                                        &hdrtype );
264                         } else if ( ! ( hdrtype & 0x80 ) ) {
265                                         continue;
266                         }
267
268                         /* Check for physical device presence */
269                         pci_read_config_dword ( pci, PCI_VENDOR_ID, &tmp );
270                         if ( ( tmp == 0xffffffff ) || ( tmp == 0 ) )
271                                 continue;
272                         
273                         /* Populate struct pci_device */
274                         pci->vendor = ( tmp & 0xffff );
275                         pci->device = ( tmp >> 16 );
276                         pci_read_config_dword ( pci, PCI_REVISION, &tmp );
277                         pci->class = ( tmp >> 8 );
278                         pci_read_config_byte ( pci, PCI_INTERRUPT_LINE,
279                                                &pci->irq );
280                         pci_read_bases ( pci );
281                         INIT_LIST_HEAD ( &pci->dev.children );
282                         pci->dev.parent = &rootdev->dev;
283                         
284                         /* Look for a driver */
285                         if ( register_pcidev ( pci ) == 0 ) {
286                                 /* pcidev registered, we can drop our ref */
287                                 pci = NULL;
288                         } else {
289                                 /* Not registered; re-use struct pci_device */
290                         }
291                 }
292         }
293
294         free ( pci );
295         return 0;
296
297  err:
298         free ( pci );
299         pcibus_remove ( rootdev );
300         return rc;
301 }
302
303 /**
304  * Remove PCI root bus
305  *
306  * @v rootdev           PCI bus root device
307  */
308 static void pcibus_remove ( struct root_device *rootdev ) {
309         struct pci_device *pci;
310         struct pci_device *tmp;
311
312         list_for_each_entry_safe ( pci, tmp, &rootdev->dev.children,
313                                    dev.siblings ) {
314                 unregister_pcidev ( pci );
315                 free ( pci );
316         }
317 }
318
319 /** PCI bus root device driver */
320 static struct root_driver pci_root_driver = {
321         .probe = pcibus_probe,
322         .remove = pcibus_remove,
323 };
324
325 /** PCI bus root device */
326 struct root_device pci_root_device __root_device = {
327         .name = "PCI",
328         .driver = &pci_root_driver,
329         .dev = {
330                 .children = LIST_HEAD_INIT ( pci_root_device.dev.children ),
331         },
332 };