e109d03066f7f2639ad69a6464feffbb3391a88d
[people/xl0/gpxe.git] / src / drivers / bus / pci.c
1 #include "stdint.h"
2 #include "string.h"
3 #include "console.h"
4 #include "pci.h"
5
6 /*
7  * Ensure that there is sufficient space in the shared dev_bus
8  * structure for a struct pci_device.
9  *
10  */
11 DEV_BUS( struct pci_device, pci_dev );
12 static char pci_magic[0]; /* guaranteed unique symbol */
13
14 /*
15  * pci_io.c may know how many buses we have, in which case it can
16  * overwrite this value.
17  *
18  */
19 unsigned int pci_max_bus = 0xff;
20
21 /*
22  * Fill in parameters (vendor & device ids, class, membase etc.) for a
23  * PCI device based on bus & devfn.
24  *
25  * Returns 1 if a device was found, 0 for no device present.
26  */
27 static int fill_pci_device ( struct pci_device *pci ) {
28         static struct {
29                 uint16_t devfn0;
30                 int is_present;
31         } cache = { 0, 1 };
32         uint32_t l;
33         int reg;
34
35         /* Check bus is within range */
36         if ( PCI_BUS ( pci->busdevfn ) > pci_max_bus ) {
37                 return 0;
38         }
39
40         /* Check to see if we've cached the result that this is a
41          * non-zero function on a non-existent card.  This is done to
42          * increase scan speed by a factor of 8.
43          */
44         if ( ( PCI_FUNC ( pci->busdevfn ) != 0 ) &&
45              ( PCI_FN0 ( pci->busdevfn ) == cache.devfn0 ) &&
46              ( ! cache.is_present ) ) {
47                 return 0;
48         }
49         
50         /* Check to see if there's anything physically present.
51          */
52         pci_read_config_dword ( pci, PCI_VENDOR_ID, &l );
53         /* some broken boards return 0 if a slot is empty: */
54         if ( ( l == 0xffffffff ) || ( l == 0x00000000 ) ) {
55                 if ( PCI_FUNC ( pci->busdevfn ) == 0 ) {
56                         /* Don't look for subsequent functions if the
57                          * card itself is not present.
58                          */
59                         cache.devfn0 = pci->busdevfn;
60                         cache.is_present = 0;
61                 }
62                 return 0;
63         }
64         pci->vendor = l & 0xffff;
65         pci->dev_id = ( l >> 16 ) & 0xffff;
66         
67         /* Check that we're not a duplicate function on a
68          * non-multifunction device.
69          */
70         if ( PCI_FUNC ( pci->busdevfn ) != 0 ) {
71                 uint16_t save_busdevfn = pci->busdevfn;
72                 uint8_t header_type;
73
74                 pci->busdevfn &= PCI_FN0 ( pci->busdevfn );
75                 pci_read_config_byte ( pci, PCI_HEADER_TYPE, &header_type );
76                 pci->busdevfn = save_busdevfn;
77
78                 if ( ! ( header_type & 0x80 ) ) {
79                         return 0;
80                 }
81         }
82         
83         /* Get device class */
84         pci_read_config_word ( pci, PCI_SUBCLASS_CODE, &pci->class );
85
86         /* Get revision */
87         pci_read_config_byte ( pci, PCI_REVISION, &pci->revision );
88
89         /* Get the "membase" */
90         pci_read_config_dword ( pci, PCI_BASE_ADDRESS_1, &pci->membase );
91                                 
92         /* Get the "ioaddr" */
93         pci->ioaddr = 0;
94         for ( reg = PCI_BASE_ADDRESS_0; reg <= PCI_BASE_ADDRESS_5; reg += 4 ) {
95                 pci_read_config_dword ( pci, reg, &pci->ioaddr );
96                 if ( pci->ioaddr & PCI_BASE_ADDRESS_SPACE_IO ) {
97                         pci->ioaddr &= PCI_BASE_ADDRESS_IO_MASK;
98                         if ( pci->ioaddr ) {
99                                 break;
100                         }
101                 }
102                 pci->ioaddr = 0;
103         }
104
105         /* Get the irq */
106         pci_read_config_byte ( pci, PCI_INTERRUPT_PIN, &pci->irq );
107         if ( pci->irq ) {
108                 pci_read_config_byte ( pci, PCI_INTERRUPT_LINE, &pci->irq );
109         }
110
111         DBG ( "PCI found device %hhx:%hhx.%d Class %hx: %hx:%hx (rev %hhx)\n",
112               PCI_BUS ( pci->busdevfn ), PCI_DEV ( pci->busdevfn ),
113               PCI_FUNC ( pci->busdevfn ), pci->class, pci->vendor, pci->dev_id,
114               pci->revision );
115
116         return 1;
117 }
118
119 /*
120  * Set device to be a busmaster in case BIOS neglected to do so.  Also
121  * adjust PCI latency timer to a reasonable value, 32.
122  */
123 void adjust_pci_device ( struct pci_device *pci ) {
124         unsigned short  new_command, pci_command;
125         unsigned char   pci_latency;
126
127         pci_read_config_word ( pci, PCI_COMMAND, &pci_command );
128         new_command = pci_command | PCI_COMMAND_MASTER | PCI_COMMAND_IO;
129         if ( pci_command != new_command ) {
130                 DBG ( "PCI BIOS has not enabled device %hhx:%hhx.%d! "
131                       "Updating PCI command %hX->%hX\n",
132                       PCI_BUS ( pci->busdevfn ), PCI_DEV ( pci->busdevfn ),
133                       PCI_FUNC ( pci->busdevfn ), pci_command, new_command );
134                 pci_write_config_word ( pci, PCI_COMMAND, new_command );
135         }
136         pci_read_config_byte ( pci, PCI_LATENCY_TIMER, &pci_latency);
137         if ( pci_latency < 32 ) {
138                 DBG ( "PCI device %hhx:%hhx.%d latency timer is "
139                       "unreasonably low at %d. Setting to 32.\n",
140                       PCI_BUS ( pci->busdevfn ), PCI_DEV ( pci->busdevfn ),
141                       PCI_FUNC ( pci->busdevfn ), pci_latency );
142                 pci_write_config_byte ( pci, PCI_LATENCY_TIMER, 32);
143         }
144 }
145
146 /*
147  * Set PCI device to use.
148  *
149  * This routine can be called by e.g. the ROM prefix to specify that
150  * the first device to be tried should be the device on which the ROM
151  * was physically located.
152  *
153  */
154 void set_pci_device ( uint16_t busdevfn ) {
155         pci_dev.magic = pci_magic;
156         pci_dev.busdevfn = busdevfn;
157         pci_dev.already_tried = 0;
158 }
159
160 /*
161  * Find a PCI device matching the specified driver
162  *
163  */
164 int find_pci_device ( struct pci_device *pci,
165                       struct pci_driver *driver ) {
166         int i;
167
168         /* Initialise struct pci if it's the first time it's been used. */
169         if ( pci->magic != pci_magic ) {
170                 memset ( pci, 0, sizeof ( *pci ) );
171                 pci->magic = pci_magic;
172         }
173
174         /* Iterate through all possible PCI bus:dev.fn combinations,
175          * starting where we left off.
176          */
177         DBG ( "PCI searching for device matching driver %s\n", driver->name );
178         do {
179                 /* If we've already used this device, skip it */
180                 if ( pci->already_tried ) {
181                         pci->already_tried = 0;
182                         continue;
183                 }
184                 
185                 /* Fill in device parameters, if device present */
186                 if ( ! fill_pci_device ( pci ) ) {
187                         continue;
188                 }
189                 
190                 /* If driver has a class, and class matches, use it */
191                 if ( driver->class && 
192                      ( driver->class == pci->class ) ) {
193                         DBG ( "PCI found class %hx matching driver %s\n",
194                               driver->class, driver->name );
195                         pci->name = driver->name;
196                         pci->already_tried = 1;
197                         return 1;
198                 }
199                 
200                 /* If any of driver's IDs match, use it */
201                 for ( i = 0 ; i < driver->id_count; i++ ) {
202                         struct pci_id *id = &driver->ids[i];
203                         
204                         if ( ( pci->vendor == id->vendor ) &&
205                              ( pci->dev_id == id->dev_id ) ) {
206                                 DBG ( "PCI found ID %hx:%hx (device %s) "
207                                       "matching driver %s\n", id->vendor,
208                                       id->dev_id, id->name, driver->name );
209                                 pci->name = id->name;
210                                 pci->already_tried = 1;
211                                 return 1;
212                         }
213                 }
214         } while ( ++pci->busdevfn );
215
216         /* No device found */
217         DBG ( "PCI found no device matching driver %s\n", driver->name );
218         return 0;
219 }
220
221 /*
222  * Find the next PCI device that can be used to boot using the
223  * specified driver.
224  *
225  */
226 int find_pci_boot_device ( struct dev *dev, struct pci_driver *driver ) {
227         struct pci_device *pci = ( struct pci_device * )dev->bus;
228
229         if ( ! find_pci_device ( pci, driver ) )
230                 return 0;
231
232         dev->name = pci->name;
233         dev->devid.bus_type = PCI_BUS_TYPE;
234         dev->devid.vendor_id = pci->vendor;
235         dev->devid.device_id = pci->dev_id;
236
237         return 1;
238 }
239
240 /*
241  * Find the start of a pci resource.
242  */
243 unsigned long pci_bar_start ( struct pci_device *pci, unsigned int index ) {
244         uint32_t lo, hi;
245         unsigned long bar;
246
247         pci_read_config_dword ( pci, index, &lo );
248         if ( lo & PCI_BASE_ADDRESS_SPACE_IO ) {
249                 bar = lo & PCI_BASE_ADDRESS_IO_MASK;
250         } else {
251                 bar = 0;
252                 if ( ( lo & PCI_BASE_ADDRESS_MEM_TYPE_MASK ) ==
253                      PCI_BASE_ADDRESS_MEM_TYPE_64) {
254                         pci_read_config_dword ( pci, index + 4, &hi );
255                         if ( hi ) {
256 #if ULONG_MAX > 0xffffffff
257                                         bar = hi;
258                                         bar <<= 32;
259 #else
260                                         printf ( "Unhandled 64bit BAR\n" );
261                                         return -1UL;
262 #endif
263                         }
264                 }
265                 bar |= lo & PCI_BASE_ADDRESS_MEM_MASK;
266         }
267         return bar + pci_bus_base ( pci );
268 }
269
270 /*
271  * Find the size of a pci resource.
272  */
273 unsigned long pci_bar_size ( struct pci_device *pci, unsigned int bar ) {
274         uint32_t start, size;
275
276         /* Save the original bar */
277         pci_read_config_dword ( pci, bar, &start );
278         /* Compute which bits can be set */
279         pci_write_config_dword ( pci, bar, ~0 );
280         pci_read_config_dword ( pci, bar, &size );
281         /* Restore the original size */
282         pci_write_config_dword ( pci, bar, start );
283         /* Find the significant bits */
284         if ( start & PCI_BASE_ADDRESS_SPACE_IO ) {
285                 size &= PCI_BASE_ADDRESS_IO_MASK;
286         } else {
287                 size &= PCI_BASE_ADDRESS_MEM_MASK;
288         }
289         /* Find the lowest bit set */
290         size = size & ~( size - 1 );
291         return size;
292 }
293
294 /**
295  * pci_find_capability - query for devices' capabilities 
296  * @pci: PCI device to query
297  * @cap: capability code
298  *
299  * Tell if a device supports a given PCI capability.
300  * Returns the address of the requested capability structure within the
301  * device's PCI configuration space or 0 in case the device does not
302  * support it.  Possible values for @cap:
303  *
304  *  %PCI_CAP_ID_PM           Power Management 
305  *
306  *  %PCI_CAP_ID_AGP          Accelerated Graphics Port 
307  *
308  *  %PCI_CAP_ID_VPD          Vital Product Data 
309  *
310  *  %PCI_CAP_ID_SLOTID       Slot Identification 
311  *
312  *  %PCI_CAP_ID_MSI          Message Signalled Interrupts
313  *
314  *  %PCI_CAP_ID_CHSWP        CompactPCI HotSwap 
315  */
316 int pci_find_capability ( struct pci_device *pci, int cap ) {
317         uint16_t status;
318         uint8_t pos, id;
319         uint8_t hdr_type;
320         int ttl = 48;
321
322         pci_read_config_word ( pci, PCI_STATUS, &status );
323         if ( ! ( status & PCI_STATUS_CAP_LIST ) )
324                 return 0;
325
326         pci_read_config_byte ( pci, PCI_HEADER_TYPE, &hdr_type );
327         switch ( hdr_type & 0x7F ) {
328         case PCI_HEADER_TYPE_NORMAL:
329         case PCI_HEADER_TYPE_BRIDGE:
330         default:
331                 pci_read_config_byte ( pci, PCI_CAPABILITY_LIST, &pos );
332                 break;
333         case PCI_HEADER_TYPE_CARDBUS:
334                 pci_read_config_byte ( pci, PCI_CB_CAPABILITY_LIST, &pos );
335                 break;
336         }
337         while ( ttl-- && pos >= 0x40 ) {
338                 pos &= ~3;
339                 pci_read_config_byte ( pci, pos + PCI_CAP_LIST_ID, &id );
340                 DBG ( "Capability: %d\n", id );
341                 if ( id == 0xff )
342                         break;
343                 if ( id == cap )
344                         return pos;
345                 pci_read_config_byte ( pci, pos + PCI_CAP_LIST_NEXT, &pos );
346         }
347         return 0;
348 }