[tables] Redefine methods for accessing linker tables
[people/lynusvaz/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 <stdlib.h>
24 #include <stdio.h>
25 #include <string.h>
26 #include <errno.h>
27 #include <gpxe/tables.h>
28 #include <gpxe/device.h>
29 #include <gpxe/pci.h>
30
31 /** @file
32  *
33  * PCI bus
34  *
35  */
36
37 static void pcibus_remove ( struct root_device *rootdev );
38
39 /**
40  * Read PCI BAR
41  *
42  * @v pci               PCI device
43  * @v reg               PCI register number
44  * @ret bar             Base address register
45  *
46  * Reads the specified PCI base address register, including the flags
47  * portion.  64-bit BARs will be handled automatically.  If the value
48  * of the 64-bit BAR exceeds the size of an unsigned long (i.e. if the
49  * high dword is non-zero on a 32-bit platform), then the value
50  * returned will be zero plus the flags for a 64-bit BAR.  Unreachable
51  * 64-bit BARs are therefore returned as uninitialised 64-bit BARs.
52  */
53 static unsigned long pci_bar ( struct pci_device *pci, unsigned int reg ) {
54         uint32_t low;
55         uint32_t high;
56
57         pci_read_config_dword ( pci, reg, &low );
58         if ( ( low & (PCI_BASE_ADDRESS_SPACE|PCI_BASE_ADDRESS_MEM_TYPE_MASK) )
59              == (PCI_BASE_ADDRESS_SPACE_MEMORY|PCI_BASE_ADDRESS_MEM_TYPE_64) ){
60                 pci_read_config_dword ( pci, reg + 4, &high );
61                 if ( high ) {
62                         if ( sizeof ( unsigned long ) > sizeof ( uint32_t ) ) {
63                                 return ( ( ( uint64_t ) high << 32 ) | low );
64                         } else {
65                                 DBG ( "Unhandled 64-bit BAR %08x%08x\n",
66                                       high, low );
67                                 return PCI_BASE_ADDRESS_MEM_TYPE_64;
68                         }
69                 }
70         }
71         return low;
72 }
73
74 /**
75  * Find the start of a PCI BAR
76  *
77  * @v pci               PCI device
78  * @v reg               PCI register number
79  * @ret start           BAR start address
80  *
81  * Reads the specified PCI base address register, and returns the
82  * address portion of the BAR (i.e. without the flags).
83  *
84  * If the address exceeds the size of an unsigned long (i.e. if a
85  * 64-bit BAR has a non-zero high dword on a 32-bit machine), the
86  * return value will be zero.
87  */
88 unsigned long pci_bar_start ( struct pci_device *pci, unsigned int reg ) {
89         unsigned long bar;
90
91         bar = pci_bar ( pci, reg );
92         if ( (bar & PCI_BASE_ADDRESS_SPACE) == PCI_BASE_ADDRESS_SPACE_MEMORY ){
93                 return ( bar & PCI_BASE_ADDRESS_MEM_MASK );
94         } else {
95                 return ( bar & PCI_BASE_ADDRESS_IO_MASK );
96         }
97 }
98
99 /**
100  * Read membase and ioaddr for a PCI device
101  *
102  * @v pci               PCI device
103  *
104  * This scans through all PCI BARs on the specified device.  The first
105  * valid memory BAR is recorded as pci_device::membase, and the first
106  * valid IO BAR is recorded as pci_device::ioaddr.
107  *
108  * 64-bit BARs are handled automatically.  On a 32-bit platform, if a
109  * 64-bit BAR has a non-zero high dword, it will be regarded as
110  * invalid.
111  */
112 static void pci_read_bases ( struct pci_device *pci ) {
113         unsigned long bar;
114         int reg;
115
116         for ( reg = PCI_BASE_ADDRESS_0; reg <= PCI_BASE_ADDRESS_5; reg += 4 ) {
117                 bar = pci_bar ( pci, reg );
118                 if ( bar & PCI_BASE_ADDRESS_SPACE_IO ) {
119                         if ( ! pci->ioaddr )
120                                 pci->ioaddr = 
121                                         ( bar & PCI_BASE_ADDRESS_IO_MASK );
122                 } else {
123                         if ( ! pci->membase )
124                                 pci->membase =
125                                         ( bar & PCI_BASE_ADDRESS_MEM_MASK );
126                         /* Skip next BAR if 64-bit */
127                         if ( bar & PCI_BASE_ADDRESS_MEM_TYPE_64 )
128                                 reg += 4;
129                 }
130         }
131 }
132
133 /**
134  * Enable PCI device
135  *
136  * @v pci               PCI device
137  *
138  * Set device to be a busmaster in case BIOS neglected to do so.  Also
139  * adjust PCI latency timer to a reasonable value, 32.
140  */
141 void adjust_pci_device ( struct pci_device *pci ) {
142         unsigned short new_command, pci_command;
143         unsigned char pci_latency;
144
145         pci_read_config_word ( pci, PCI_COMMAND, &pci_command );
146         new_command = ( pci_command | PCI_COMMAND_MASTER |
147                         PCI_COMMAND_MEM | PCI_COMMAND_IO );
148         if ( pci_command != new_command ) {
149                 DBG ( "PCI BIOS has not enabled device %02x:%02x.%x! "
150                       "Updating PCI command %04x->%04x\n", pci->bus,
151                       PCI_SLOT ( pci->devfn ), PCI_FUNC ( pci->devfn ),
152                       pci_command, new_command );
153                 pci_write_config_word ( pci, PCI_COMMAND, new_command );
154         }
155
156         pci_read_config_byte ( pci, PCI_LATENCY_TIMER, &pci_latency);
157         if ( pci_latency < 32 ) {
158                 DBG ( "PCI device %02x:%02x.%x latency timer is unreasonably "
159                       "low at %d. Setting to 32.\n", pci->bus,
160                       PCI_SLOT ( pci->devfn ), PCI_FUNC ( pci->devfn ),
161                       pci_latency );
162                 pci_write_config_byte ( pci, PCI_LATENCY_TIMER, 32);
163         }
164 }
165
166 /**
167  * Probe a PCI device
168  *
169  * @v pci               PCI device
170  * @ret rc              Return status code
171  *
172  * Searches for a driver for the PCI device.  If a driver is found,
173  * its probe() routine is called.
174  */
175 static int pci_probe ( struct pci_device *pci ) {
176         struct pci_driver *driver;
177         struct pci_device_id *id;
178         unsigned int i;
179         int rc;
180
181         DBG ( "Adding PCI device %02x:%02x.%x (%04x:%04x mem %lx io %lx "
182               "irq %d)\n", pci->bus, PCI_SLOT ( pci->devfn ),
183               PCI_FUNC ( pci->devfn ), pci->vendor, pci->device,
184               pci->membase, pci->ioaddr, pci->irq );
185
186         for_each_table_entry ( driver, PCI_DRIVERS ) {
187                 for ( i = 0 ; i < driver->id_count ; i++ ) {
188                         id = &driver->ids[i];
189                         if ( ( id->vendor != PCI_ANY_ID ) &&
190                              ( id->vendor != pci->vendor ) )
191                                 continue;
192                         if ( ( id->device != PCI_ANY_ID ) &&
193                              ( id->device != pci->device ) )
194                                 continue;
195                         pci->driver = driver;
196                         pci->driver_name = id->name;
197                         DBG ( "...using driver %s\n", pci->driver_name );
198                         if ( ( rc = driver->probe ( pci, id ) ) != 0 ) {
199                                 DBG ( "......probe failed\n" );
200                                 continue;
201                         }
202                         return 0;
203                 }
204         }
205
206         DBG ( "...no driver found\n" );
207         return -ENOTTY;
208 }
209
210 /**
211  * Remove a PCI device
212  *
213  * @v pci               PCI device
214  */
215 static void pci_remove ( struct pci_device *pci ) {
216         pci->driver->remove ( pci );
217         DBG ( "Removed PCI device %02x:%02x.%x\n", pci->bus,
218               PCI_SLOT ( pci->devfn ), PCI_FUNC ( pci->devfn ) );
219 }
220
221 /**
222  * Probe PCI root bus
223  *
224  * @v rootdev           PCI bus root device
225  *
226  * Scans the PCI bus for devices and registers all devices it can
227  * find.
228  */
229 static int pcibus_probe ( struct root_device *rootdev ) {
230         struct pci_device *pci = NULL;
231         unsigned int max_bus;
232         unsigned int bus;
233         unsigned int devfn;
234         uint8_t hdrtype = 0;
235         uint32_t tmp;
236         int rc;
237
238         max_bus = pci_max_bus();
239         for ( bus = 0 ; bus <= max_bus ; bus++ ) {
240                 for ( devfn = 0 ; devfn <= 0xff ; devfn++ ) {
241
242                         /* Allocate struct pci_device */
243                         if ( ! pci )
244                                 pci = malloc ( sizeof ( *pci ) );
245                         if ( ! pci ) {
246                                 rc = -ENOMEM;
247                                 goto err;
248                         }
249                         memset ( pci, 0, sizeof ( *pci ) );
250                         pci->bus = bus;
251                         pci->devfn = devfn;
252                         
253                         /* Skip all but the first function on
254                          * non-multifunction cards
255                          */
256                         if ( PCI_FUNC ( devfn ) == 0 ) {
257                                 pci_read_config_byte ( pci, PCI_HEADER_TYPE,
258                                                        &hdrtype );
259                         } else if ( ! ( hdrtype & 0x80 ) ) {
260                                         continue;
261                         }
262
263                         /* Check for physical device presence */
264                         pci_read_config_dword ( pci, PCI_VENDOR_ID, &tmp );
265                         if ( ( tmp == 0xffffffff ) || ( tmp == 0 ) )
266                                 continue;
267                         
268                         /* Populate struct pci_device */
269                         pci->vendor = ( tmp & 0xffff );
270                         pci->device = ( tmp >> 16 );
271                         pci_read_config_dword ( pci, PCI_REVISION, &tmp );
272                         pci->class = ( tmp >> 8 );
273                         pci_read_config_byte ( pci, PCI_INTERRUPT_LINE,
274                                                &pci->irq );
275                         pci_read_bases ( pci );
276
277                         /* Add to device hierarchy */
278                         snprintf ( pci->dev.name, sizeof ( pci->dev.name ),
279                                    "PCI%02x:%02x.%x", bus,
280                                    PCI_SLOT ( devfn ), PCI_FUNC ( devfn ) );
281                         pci->dev.desc.bus_type = BUS_TYPE_PCI;
282                         pci->dev.desc.location = PCI_BUSDEVFN (bus, devfn);
283                         pci->dev.desc.vendor = pci->vendor;
284                         pci->dev.desc.device = pci->device;
285                         pci->dev.desc.class = pci->class;
286                         pci->dev.desc.ioaddr = pci->ioaddr;
287                         pci->dev.desc.irq = pci->irq;
288                         pci->dev.parent = &rootdev->dev;
289                         list_add ( &pci->dev.siblings, &rootdev->dev.children);
290                         INIT_LIST_HEAD ( &pci->dev.children );
291                         
292                         /* Look for a driver */
293                         if ( pci_probe ( pci ) == 0 ) {
294                                 /* pcidev registered, we can drop our ref */
295                                 pci = NULL;
296                         } else {
297                                 /* Not registered; re-use struct pci_device */
298                                 list_del ( &pci->dev.siblings );
299                         }
300                 }
301         }
302
303         free ( pci );
304         return 0;
305
306  err:
307         free ( pci );
308         pcibus_remove ( rootdev );
309         return rc;
310 }
311
312 /**
313  * Remove PCI root bus
314  *
315  * @v rootdev           PCI bus root device
316  */
317 static void pcibus_remove ( struct root_device *rootdev ) {
318         struct pci_device *pci;
319         struct pci_device *tmp;
320
321         list_for_each_entry_safe ( pci, tmp, &rootdev->dev.children,
322                                    dev.siblings ) {
323                 pci_remove ( pci );
324                 list_del ( &pci->dev.siblings );
325                 free ( pci );
326         }
327 }
328
329 /** PCI bus root device driver */
330 static struct root_driver pci_root_driver = {
331         .probe = pcibus_probe,
332         .remove = pcibus_remove,
333 };
334
335 /** PCI bus root device */
336 struct root_device pci_root_device __root_device = {
337         .dev = { .name = "PCI" },
338         .driver = &pci_root_driver,
339 };