Minor fixups
[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  * 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 ( "%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 ( "%hhx:%hhx.%d : PCI BIOS has not enabled this device! "
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 ( "%hhx:%hhx.%d : PCI latency timer (CFLT) "
104                       "is unreasonably low at %d. Setting to 32 clocks.\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  * Obtain a struct pci * from a struct dev *
113  *
114  * If dev has not previously been used for a PCI device scan, blank
115  * out dev.pci
116  */
117 struct pci_device * pci_device ( struct dev *dev ) {
118         struct pci_device *pci = &dev->pci;
119
120         if ( dev->devid.bus_type != PCI_BUS_TYPE ) {
121                 memset ( pci, 0, sizeof ( *pci ) );
122                 dev->devid.bus_type = PCI_BUS_TYPE;
123         }
124         pci->dev = dev;
125         return pci;
126 }
127
128 /*
129  * Find a PCI device matching the specified driver
130  *
131  */
132 int find_pci_device ( struct pci_device *pci,
133                       struct pci_driver *driver ) {
134         int i;
135
136         /* Iterate through all possible PCI bus:dev.fn combinations,
137          * starting where we left off.
138          */
139         for ( ; pci->busdevfn <= 0xffff ; pci->busdevfn++ ) {
140                 /* If we've already used this device, skip it */
141                 if ( pci->already_tried ) {
142                         pci->already_tried = 0;
143                         continue;
144                 }
145                 
146                 /* Fill in device parameters, if device present */
147                 if ( ! fill_pci_device ( pci ) ) {
148                         continue;
149                 }
150                 
151                 /* Fix up PCI device */
152                 adjust_pci_device ( pci );
153                 
154                 /* Fill in dev structure, if present */
155                 if ( pci->dev ) {
156                         pci->dev->name = driver->name;
157                         pci->dev->devid.vendor_id = htons ( pci->vendor );
158                         pci->dev->devid.device_id = htons ( pci->dev_id );
159                 }
160
161                 /* If driver has a class, and class matches, use it */
162                 if ( driver->class && 
163                      ( driver->class == pci->class ) ) {
164                         DBG ( "Driver %s matches class %hx\n",
165                               driver->name, driver->class );
166                         pci->already_tried = 1;
167                         return 1;
168                 }
169                 
170                 /* If any of driver's IDs match, use it */
171                 for ( i = 0 ; i < driver->id_count; i++ ) {
172                         struct pci_id *id = &driver->ids[i];
173                         
174                         if ( ( pci->vendor == id->vendor ) &&
175                              ( pci->dev_id == id->dev_id ) ) {
176                                 DBG ( "Device %s (driver %s) matches "
177                                       "ID %hx:%hx\n", id->name, driver->name,
178                                       id->vendor, id->dev_id );
179                                 if ( pci->dev )
180                                         pci->dev->name = id->name;
181                                 pci->already_tried = 1;
182                                 return 1;
183                         }
184                 }
185
186                 DBG ( "No match in driver %s\n", driver->name );
187         }
188
189         /* No device found */
190         return 0;
191 }
192
193 /*
194  * Find the start of a pci resource.
195  */
196 unsigned long pci_bar_start ( struct pci_device *pci, unsigned int index ) {
197         uint32_t lo, hi;
198         unsigned long bar;
199
200         pci_read_config_dword ( pci, index, &lo );
201         if ( lo & PCI_BASE_ADDRESS_SPACE_IO ) {
202                 bar = lo & PCI_BASE_ADDRESS_IO_MASK;
203         } else {
204                 bar = 0;
205                 if ( ( lo & PCI_BASE_ADDRESS_MEM_TYPE_MASK ) ==
206                      PCI_BASE_ADDRESS_MEM_TYPE_64) {
207                         pci_read_config_dword ( pci, index + 4, &hi );
208                         if ( hi ) {
209 #if ULONG_MAX > 0xffffffff
210                                         bar = hi;
211                                         bar <<= 32;
212 #else
213                                         printf ( "Unhandled 64bit BAR\n" );
214                                         return -1UL;
215 #endif
216                         }
217                 }
218                 bar |= lo & PCI_BASE_ADDRESS_MEM_MASK;
219         }
220         return bar + pci_bus_base ( pci );
221 }
222
223 /*
224  * Find the size of a pci resource.
225  */
226 unsigned long pci_bar_size ( struct pci_device *pci, unsigned int bar ) {
227         uint32_t start, size;
228
229         /* Save the original bar */
230         pci_read_config_dword ( pci, bar, &start );
231         /* Compute which bits can be set */
232         pci_write_config_dword ( pci, bar, ~0 );
233         pci_read_config_dword ( pci, bar, &size );
234         /* Restore the original size */
235         pci_write_config_dword ( pci, bar, start );
236         /* Find the significant bits */
237         if ( start & PCI_BASE_ADDRESS_SPACE_IO ) {
238                 size &= PCI_BASE_ADDRESS_IO_MASK;
239         } else {
240                 size &= PCI_BASE_ADDRESS_MEM_MASK;
241         }
242         /* Find the lowest bit set */
243         size = size & ~( size - 1 );
244         return size;
245 }
246
247 /**
248  * pci_find_capability - query for devices' capabilities 
249  * @pci: PCI device to query
250  * @cap: capability code
251  *
252  * Tell if a device supports a given PCI capability.
253  * Returns the address of the requested capability structure within the
254  * device's PCI configuration space or 0 in case the device does not
255  * support it.  Possible values for @cap:
256  *
257  *  %PCI_CAP_ID_PM           Power Management 
258  *
259  *  %PCI_CAP_ID_AGP          Accelerated Graphics Port 
260  *
261  *  %PCI_CAP_ID_VPD          Vital Product Data 
262  *
263  *  %PCI_CAP_ID_SLOTID       Slot Identification 
264  *
265  *  %PCI_CAP_ID_MSI          Message Signalled Interrupts
266  *
267  *  %PCI_CAP_ID_CHSWP        CompactPCI HotSwap 
268  */
269 int pci_find_capability ( struct pci_device *pci, int cap ) {
270         uint16_t status;
271         uint8_t pos, id;
272         uint8_t hdr_type;
273         int ttl = 48;
274
275         pci_read_config_word ( pci, PCI_STATUS, &status );
276         if ( ! ( status & PCI_STATUS_CAP_LIST ) )
277                 return 0;
278
279         pci_read_config_byte ( pci, PCI_HEADER_TYPE, &hdr_type );
280         switch ( hdr_type & 0x7F ) {
281         case PCI_HEADER_TYPE_NORMAL:
282         case PCI_HEADER_TYPE_BRIDGE:
283         default:
284                 pci_read_config_byte ( pci, PCI_CAPABILITY_LIST, &pos );
285                 break;
286         case PCI_HEADER_TYPE_CARDBUS:
287                 pci_read_config_byte ( pci, PCI_CB_CAPABILITY_LIST, &pos );
288                 break;
289         }
290         while ( ttl-- && pos >= 0x40 ) {
291                 pos &= ~3;
292                 pci_read_config_byte ( pci, pos + PCI_CAP_LIST_ID, &id );
293                 DBG ( "Capability: %d\n", id );
294                 if ( id == 0xff )
295                         break;
296                 if ( id == cap )
297                         return pos;
298                 pci_read_config_byte ( pci, pos + PCI_CAP_LIST_NEXT, &pos );
299         }
300         return 0;
301 }