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