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