Intel IOMMU: PCI generic helper function
[linux-2.6.git] / drivers / pci / search.c
1 /*
2  *      PCI searching functions.
3  *
4  *      Copyright (C) 1993 -- 1997 Drew Eckhardt, Frederic Potter,
5  *                                      David Mosberger-Tang
6  *      Copyright (C) 1997 -- 2000 Martin Mares <mj@ucw.cz>
7  *      Copyright (C) 2003 -- 2004 Greg Kroah-Hartman <greg@kroah.com>
8  */
9
10 #include <linux/init.h>
11 #include <linux/pci.h>
12 #include <linux/module.h>
13 #include <linux/interrupt.h>
14 #include "pci.h"
15
16 DECLARE_RWSEM(pci_bus_sem);
17 /*
18  * find the upstream PCIE-to-PCI bridge of a PCI device
19  * if the device is PCIE, return NULL
20  * if the device isn't connected to a PCIE bridge (that is its parent is a
21  * legacy PCI bridge and the bridge is directly connected to bus 0), return its
22  * parent
23  */
24 struct pci_dev *
25 pci_find_upstream_pcie_bridge(struct pci_dev *pdev)
26 {
27         struct pci_dev *tmp = NULL;
28
29         if (pdev->is_pcie)
30                 return NULL;
31         while (1) {
32                 if (!pdev->bus->self)
33                         break;
34                 pdev = pdev->bus->self;
35                 /* a p2p bridge */
36                 if (!pdev->is_pcie) {
37                         tmp = pdev;
38                         continue;
39                 }
40                 /* PCI device should connect to a PCIE bridge */
41                 if (pdev->pcie_type != PCI_EXP_TYPE_PCI_BRIDGE) {
42                         /* Busted hardware? */
43                         WARN_ON_ONCE(1);
44                         return NULL;
45                 }
46                 return pdev;
47         }
48
49         return tmp;
50 }
51
52 static struct pci_bus *pci_do_find_bus(struct pci_bus *bus, unsigned char busnr)
53 {
54         struct pci_bus* child;
55         struct list_head *tmp;
56
57         if(bus->number == busnr)
58                 return bus;
59
60         list_for_each(tmp, &bus->children) {
61                 child = pci_do_find_bus(pci_bus_b(tmp), busnr);
62                 if(child)
63                         return child;
64         }
65         return NULL;
66 }
67
68 /**
69  * pci_find_bus - locate PCI bus from a given domain and bus number
70  * @domain: number of PCI domain to search
71  * @busnr: number of desired PCI bus
72  *
73  * Given a PCI bus number and domain number, the desired PCI bus is located
74  * in the global list of PCI buses.  If the bus is found, a pointer to its
75  * data structure is returned.  If no bus is found, %NULL is returned.
76  */
77 struct pci_bus * pci_find_bus(int domain, int busnr)
78 {
79         struct pci_bus *bus = NULL;
80         struct pci_bus *tmp_bus;
81
82         while ((bus = pci_find_next_bus(bus)) != NULL)  {
83                 if (pci_domain_nr(bus) != domain)
84                         continue;
85                 tmp_bus = pci_do_find_bus(bus, busnr);
86                 if (tmp_bus)
87                         return tmp_bus;
88         }
89         return NULL;
90 }
91
92 /**
93  * pci_find_next_bus - begin or continue searching for a PCI bus
94  * @from: Previous PCI bus found, or %NULL for new search.
95  *
96  * Iterates through the list of known PCI busses.  A new search is
97  * initiated by passing %NULL as the @from argument.  Otherwise if
98  * @from is not %NULL, searches continue from next device on the
99  * global list.
100  */
101 struct pci_bus * 
102 pci_find_next_bus(const struct pci_bus *from)
103 {
104         struct list_head *n;
105         struct pci_bus *b = NULL;
106
107         WARN_ON(in_interrupt());
108         down_read(&pci_bus_sem);
109         n = from ? from->node.next : pci_root_buses.next;
110         if (n != &pci_root_buses)
111                 b = pci_bus_b(n);
112         up_read(&pci_bus_sem);
113         return b;
114 }
115
116 /**
117  * pci_find_slot - locate PCI device from a given PCI slot
118  * @bus: number of PCI bus on which desired PCI device resides
119  * @devfn: encodes number of PCI slot in which the desired PCI 
120  * device resides and the logical device number within that slot 
121  * in case of multi-function devices.
122  *
123  * Given a PCI bus and slot/function number, the desired PCI device 
124  * is located in system global list of PCI devices.  If the device
125  * is found, a pointer to its data structure is returned.  If no 
126  * device is found, %NULL is returned.
127  */
128 struct pci_dev *
129 pci_find_slot(unsigned int bus, unsigned int devfn)
130 {
131         struct pci_dev *dev = NULL;
132
133         while ((dev = pci_find_device(PCI_ANY_ID, PCI_ANY_ID, dev)) != NULL) {
134                 if (dev->bus->number == bus && dev->devfn == devfn)
135                         return dev;
136         }
137         return NULL;
138 }
139
140 /**
141  * pci_get_slot - locate PCI device for a given PCI slot
142  * @bus: PCI bus on which desired PCI device resides
143  * @devfn: encodes number of PCI slot in which the desired PCI 
144  * device resides and the logical device number within that slot 
145  * in case of multi-function devices.
146  *
147  * Given a PCI bus and slot/function number, the desired PCI device 
148  * is located in the list of PCI devices.
149  * If the device is found, its reference count is increased and this
150  * function returns a pointer to its data structure.  The caller must
151  * decrement the reference count by calling pci_dev_put().
152  * If no device is found, %NULL is returned.
153  */
154 struct pci_dev * pci_get_slot(struct pci_bus *bus, unsigned int devfn)
155 {
156         struct list_head *tmp;
157         struct pci_dev *dev;
158
159         WARN_ON(in_interrupt());
160         down_read(&pci_bus_sem);
161
162         list_for_each(tmp, &bus->devices) {
163                 dev = pci_dev_b(tmp);
164                 if (dev->devfn == devfn)
165                         goto out;
166         }
167
168         dev = NULL;
169  out:
170         pci_dev_get(dev);
171         up_read(&pci_bus_sem);
172         return dev;
173 }
174
175 /**
176  * pci_get_bus_and_slot - locate PCI device from a given PCI bus & slot
177  * @bus: number of PCI bus on which desired PCI device resides
178  * @devfn: encodes number of PCI slot in which the desired PCI
179  * device resides and the logical device number within that slot
180  * in case of multi-function devices.
181  *
182  * Note: the bus/slot search is limited to PCI domain (segment) 0.
183  *
184  * Given a PCI bus and slot/function number, the desired PCI device
185  * is located in system global list of PCI devices.  If the device
186  * is found, a pointer to its data structure is returned.  If no
187  * device is found, %NULL is returned. The returned device has its
188  * reference count bumped by one.
189  */
190
191 struct pci_dev * pci_get_bus_and_slot(unsigned int bus, unsigned int devfn)
192 {
193         struct pci_dev *dev = NULL;
194
195         while ((dev = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, dev)) != NULL) {
196                 if (pci_domain_nr(dev->bus) == 0 &&
197                    (dev->bus->number == bus && dev->devfn == devfn))
198                         return dev;
199         }
200         return NULL;
201 }
202
203 /**
204  * pci_find_subsys - begin or continue searching for a PCI device by vendor/subvendor/device/subdevice id
205  * @vendor: PCI vendor id to match, or %PCI_ANY_ID to match all vendor ids
206  * @device: PCI device id to match, or %PCI_ANY_ID to match all device ids
207  * @ss_vendor: PCI subsystem vendor id to match, or %PCI_ANY_ID to match all vendor ids
208  * @ss_device: PCI subsystem device id to match, or %PCI_ANY_ID to match all device ids
209  * @from: Previous PCI device found in search, or %NULL for new search.
210  *
211  * Iterates through the list of known PCI devices.  If a PCI device is
212  * found with a matching @vendor, @device, @ss_vendor and @ss_device, a
213  * pointer to its device structure is returned.  Otherwise, %NULL is returned.
214  * A new search is initiated by passing %NULL as the @from argument.
215  * Otherwise if @from is not %NULL, searches continue from next device
216  * on the global list.
217  *
218  * NOTE: Do not use this function any more; use pci_get_subsys() instead, as
219  * the PCI device returned by this function can disappear at any moment in
220  * time.
221  */
222 static struct pci_dev * pci_find_subsys(unsigned int vendor,
223                                         unsigned int device,
224                                         unsigned int ss_vendor,
225                                         unsigned int ss_device,
226                                         const struct pci_dev *from)
227 {
228         struct list_head *n;
229         struct pci_dev *dev;
230
231         WARN_ON(in_interrupt());
232
233         /*
234          * pci_find_subsys() can be called on the ide_setup() path, super-early
235          * in boot.  But the down_read() will enable local interrupts, which
236          * can cause some machines to crash.  So here we detect and flag that
237          * situation and bail out early.
238          */
239         if (unlikely(no_pci_devices()))
240                 return NULL;
241         down_read(&pci_bus_sem);
242         n = from ? from->global_list.next : pci_devices.next;
243
244         while (n && (n != &pci_devices)) {
245                 dev = pci_dev_g(n);
246                 if ((vendor == PCI_ANY_ID || dev->vendor == vendor) &&
247                     (device == PCI_ANY_ID || dev->device == device) &&
248                     (ss_vendor == PCI_ANY_ID || dev->subsystem_vendor == ss_vendor) &&
249                     (ss_device == PCI_ANY_ID || dev->subsystem_device == ss_device))
250                         goto exit;
251                 n = n->next;
252         }
253         dev = NULL;
254 exit:
255         up_read(&pci_bus_sem);
256         return dev;
257 }
258
259 /**
260  * pci_find_device - begin or continue searching for a PCI device by vendor/device id
261  * @vendor: PCI vendor id to match, or %PCI_ANY_ID to match all vendor ids
262  * @device: PCI device id to match, or %PCI_ANY_ID to match all device ids
263  * @from: Previous PCI device found in search, or %NULL for new search.
264  *
265  * Iterates through the list of known PCI devices.  If a PCI device is found
266  * with a matching @vendor and @device, a pointer to its device structure is
267  * returned.  Otherwise, %NULL is returned.
268  * A new search is initiated by passing %NULL as the @from argument.
269  * Otherwise if @from is not %NULL, searches continue from next device
270  * on the global list.
271  * 
272  * NOTE: Do not use this function any more; use pci_get_device() instead, as
273  * the PCI device returned by this function can disappear at any moment in
274  * time.
275  */
276 struct pci_dev *
277 pci_find_device(unsigned int vendor, unsigned int device, const struct pci_dev *from)
278 {
279         return pci_find_subsys(vendor, device, PCI_ANY_ID, PCI_ANY_ID, from);
280 }
281
282 /**
283  * pci_get_subsys - begin or continue searching for a PCI device by vendor/subvendor/device/subdevice id
284  * @vendor: PCI vendor id to match, or %PCI_ANY_ID to match all vendor ids
285  * @device: PCI device id to match, or %PCI_ANY_ID to match all device ids
286  * @ss_vendor: PCI subsystem vendor id to match, or %PCI_ANY_ID to match all vendor ids
287  * @ss_device: PCI subsystem device id to match, or %PCI_ANY_ID to match all device ids
288  * @from: Previous PCI device found in search, or %NULL for new search.
289  *
290  * Iterates through the list of known PCI devices.  If a PCI device is found
291  * with a matching @vendor, @device, @ss_vendor and @ss_device, a pointer to its
292  * device structure is returned, and the reference count to the device is
293  * incremented.  Otherwise, %NULL is returned.  A new search is initiated by
294  * passing %NULL as the @from argument.  Otherwise if @from is not %NULL,
295  * searches continue from next device on the global list.
296  * The reference count for @from is always decremented if it is not %NULL.
297  */
298 struct pci_dev * 
299 pci_get_subsys(unsigned int vendor, unsigned int device,
300                unsigned int ss_vendor, unsigned int ss_device,
301                struct pci_dev *from)
302 {
303         struct list_head *n;
304         struct pci_dev *dev;
305
306         WARN_ON(in_interrupt());
307
308         /*
309          * pci_get_subsys() can potentially be called by drivers super-early
310          * in boot.  But the down_read() will enable local interrupts, which
311          * can cause some machines to crash.  So here we detect and flag that
312          * situation and bail out early.
313          */
314         if (unlikely(no_pci_devices()))
315                 return NULL;
316         down_read(&pci_bus_sem);
317         n = from ? from->global_list.next : pci_devices.next;
318
319         while (n && (n != &pci_devices)) {
320                 dev = pci_dev_g(n);
321                 if ((vendor == PCI_ANY_ID || dev->vendor == vendor) &&
322                     (device == PCI_ANY_ID || dev->device == device) &&
323                     (ss_vendor == PCI_ANY_ID || dev->subsystem_vendor == ss_vendor) &&
324                     (ss_device == PCI_ANY_ID || dev->subsystem_device == ss_device))
325                         goto exit;
326                 n = n->next;
327         }
328         dev = NULL;
329 exit:
330         dev = pci_dev_get(dev);
331         up_read(&pci_bus_sem);
332         pci_dev_put(from);
333         return dev;
334 }
335
336 /**
337  * pci_get_device - begin or continue searching for a PCI device by vendor/device id
338  * @vendor: PCI vendor id to match, or %PCI_ANY_ID to match all vendor ids
339  * @device: PCI device id to match, or %PCI_ANY_ID to match all device ids
340  * @from: Previous PCI device found in search, or %NULL for new search.
341  *
342  * Iterates through the list of known PCI devices.  If a PCI device is
343  * found with a matching @vendor and @device, the reference count to the
344  * device is incremented and a pointer to its device structure is returned.
345  * Otherwise, %NULL is returned.  A new search is initiated by passing %NULL
346  * as the @from argument.  Otherwise if @from is not %NULL, searches continue
347  * from next device on the global list.  The reference count for @from is
348  * always decremented if it is not %NULL.
349  */
350 struct pci_dev *
351 pci_get_device(unsigned int vendor, unsigned int device, struct pci_dev *from)
352 {
353         return pci_get_subsys(vendor, device, PCI_ANY_ID, PCI_ANY_ID, from);
354 }
355
356 /**
357  * pci_get_device_reverse - begin or continue searching for a PCI device by vendor/device id
358  * @vendor: PCI vendor id to match, or %PCI_ANY_ID to match all vendor ids
359  * @device: PCI device id to match, or %PCI_ANY_ID to match all device ids
360  * @from: Previous PCI device found in search, or %NULL for new search.
361  *
362  * Iterates through the list of known PCI devices in the reverse order of
363  * pci_get_device.
364  * If a PCI device is found with a matching @vendor and @device, the reference
365  * count to the  device is incremented and a pointer to its device structure
366  * is returned Otherwise, %NULL is returned.  A new search is initiated by
367  * passing %NULL as the @from argument.  Otherwise if @from is not %NULL,
368  * searches continue from next device on the global list.  The reference
369  * count for @from is always decremented if it is not %NULL.
370  */
371 struct pci_dev *
372 pci_get_device_reverse(unsigned int vendor, unsigned int device, struct pci_dev *from)
373 {
374         struct list_head *n;
375         struct pci_dev *dev;
376
377         WARN_ON(in_interrupt());
378         down_read(&pci_bus_sem);
379         n = from ? from->global_list.prev : pci_devices.prev;
380
381         while (n && (n != &pci_devices)) {
382                 dev = pci_dev_g(n);
383                 if ((vendor == PCI_ANY_ID || dev->vendor == vendor) &&
384                     (device == PCI_ANY_ID || dev->device == device))
385                         goto exit;
386                 n = n->prev;
387         }
388         dev = NULL;
389 exit:
390         dev = pci_dev_get(dev);
391         up_read(&pci_bus_sem);
392         pci_dev_put(from);
393         return dev;
394 }
395
396 /**
397  * pci_get_class - begin or continue searching for a PCI device by class
398  * @class: search for a PCI device with this class designation
399  * @from: Previous PCI device found in search, or %NULL for new search.
400  *
401  * Iterates through the list of known PCI devices.  If a PCI device is
402  * found with a matching @class, the reference count to the device is
403  * incremented and a pointer to its device structure is returned.
404  * Otherwise, %NULL is returned.
405  * A new search is initiated by passing %NULL as the @from argument.
406  * Otherwise if @from is not %NULL, searches continue from next device
407  * on the global list.  The reference count for @from is always decremented
408  * if it is not %NULL.
409  */
410 struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from)
411 {
412         struct list_head *n;
413         struct pci_dev *dev;
414
415         WARN_ON(in_interrupt());
416         down_read(&pci_bus_sem);
417         n = from ? from->global_list.next : pci_devices.next;
418
419         while (n && (n != &pci_devices)) {
420                 dev = pci_dev_g(n);
421                 if (dev->class == class)
422                         goto exit;
423                 n = n->next;
424         }
425         dev = NULL;
426 exit:
427         dev = pci_dev_get(dev);
428         up_read(&pci_bus_sem);
429         pci_dev_put(from);
430         return dev;
431 }
432
433 const struct pci_device_id *pci_find_present(const struct pci_device_id *ids)
434 {
435         struct pci_dev *dev;
436         const struct pci_device_id *found = NULL;
437
438         WARN_ON(in_interrupt());
439         down_read(&pci_bus_sem);
440         while (ids->vendor || ids->subvendor || ids->class_mask) {
441                 list_for_each_entry(dev, &pci_devices, global_list) {
442                         if ((found = pci_match_one_device(ids, dev)) != NULL)
443                                 goto exit;
444                 }
445                 ids++;
446         }
447 exit:
448         up_read(&pci_bus_sem);
449         return found;
450 }
451
452 /**
453  * pci_dev_present - Returns 1 if device matching the device list is present, 0 if not.
454  * @ids: A pointer to a null terminated list of struct pci_device_id structures
455  * that describe the type of PCI device the caller is trying to find.
456  *
457  * Obvious fact: You do not have a reference to any device that might be found
458  * by this function, so if that device is removed from the system right after
459  * this function is finished, the value will be stale.  Use this function to
460  * find devices that are usually built into a system, or for a general hint as
461  * to if another device happens to be present at this specific moment in time.
462  */
463 int pci_dev_present(const struct pci_device_id *ids)
464 {
465         return pci_find_present(ids) == NULL ? 0 : 1;
466 }
467
468 EXPORT_SYMBOL(pci_dev_present);
469 EXPORT_SYMBOL(pci_find_present);
470
471 EXPORT_SYMBOL(pci_find_device);
472 EXPORT_SYMBOL(pci_find_slot);
473 /* For boot time work */
474 EXPORT_SYMBOL(pci_find_bus);
475 EXPORT_SYMBOL(pci_find_next_bus);
476 /* For everyone */
477 EXPORT_SYMBOL(pci_get_device);
478 EXPORT_SYMBOL(pci_get_device_reverse);
479 EXPORT_SYMBOL(pci_get_subsys);
480 EXPORT_SYMBOL(pci_get_slot);
481 EXPORT_SYMBOL(pci_get_bus_and_slot);
482 EXPORT_SYMBOL(pci_get_class);