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