blob: 6c0440c20e3199a0a51f2f567b7ffb73379f18f7 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * card.c - contains functions for managing groups of PnP devices
3 *
4 * Copyright 2002 Adam Belay <ambx1@neo.rr.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 */
6
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#include <linux/module.h>
8#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/pnp.h>
10#include "base.h"
11
12LIST_HEAD(pnp_cards);
Adrian Bunkb449f632005-11-07 01:01:48 -080013static LIST_HEAD(pnp_card_drivers);
Linus Torvalds1da177e2005-04-16 15:20:36 -070014
Bjorn Helgaas9dd78462007-07-26 10:41:20 -070015static const struct pnp_card_device_id *match_card(struct pnp_card_driver *drv,
16 struct pnp_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -070017{
Bjorn Helgaas9dd78462007-07-26 10:41:20 -070018 const struct pnp_card_device_id *drv_id = drv->id_table;
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -070019
Bjorn Helgaas9dd78462007-07-26 10:41:20 -070020 while (*drv_id->id) {
21 if (compare_pnp_id(card->id, drv_id->id)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070022 int i = 0;
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -070023
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 for (;;) {
25 int found;
26 struct pnp_dev *dev;
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -070027
Bjorn Helgaas1e0aa9a2007-08-15 10:32:08 -060028 if (i == PNP_MAX_DEVICES ||
29 !*drv_id->devs[i].id)
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 return drv_id;
31 found = 0;
32 card_for_each_dev(card, dev) {
Bjorn Helgaas1e0aa9a2007-08-15 10:32:08 -060033 if (compare_pnp_id(dev->id,
34 drv_id->devs[i].id)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 found = 1;
36 break;
37 }
38 }
Bjorn Helgaas9dd78462007-07-26 10:41:20 -070039 if (!found)
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 break;
41 i++;
42 }
43 }
44 drv_id++;
45 }
46 return NULL;
47}
48
Bjorn Helgaas9dd78462007-07-26 10:41:20 -070049static void card_remove(struct pnp_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -070050{
51 dev->card_link = NULL;
52}
Bjorn Helgaas982c6092006-03-27 01:17:08 -080053
Bjorn Helgaas9dd78462007-07-26 10:41:20 -070054static void card_remove_first(struct pnp_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -070055{
Bjorn Helgaas9dd78462007-07-26 10:41:20 -070056 struct pnp_card_driver *drv = to_pnp_card_driver(dev->driver);
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -070057
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 if (!dev->card || !drv)
59 return;
60 if (drv->remove)
61 drv->remove(dev->card_link);
62 drv->link.remove = &card_remove;
63 kfree(dev->card_link);
64 card_remove(dev);
65}
66
Jesper Juhla9adb8d2006-06-25 05:47:17 -070067static int card_probe(struct pnp_card *card, struct pnp_card_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -070068{
Jesper Juhla9adb8d2006-06-25 05:47:17 -070069 const struct pnp_card_device_id *id;
70 struct pnp_card_link *clink;
71 struct pnp_dev *dev;
72
73 if (!drv->probe)
74 return 0;
Bjorn Helgaas9dd78462007-07-26 10:41:20 -070075 id = match_card(drv, card);
Jesper Juhla9adb8d2006-06-25 05:47:17 -070076 if (!id)
77 return 0;
78
79 clink = pnp_alloc(sizeof(*clink));
80 if (!clink)
81 return 0;
82 clink->card = card;
83 clink->driver = drv;
84 clink->pm_state = PMSG_ON;
85
86 if (drv->probe(clink, id) >= 0)
87 return 1;
88
89 /* Recovery */
90 card_for_each_dev(card, dev) {
91 if (dev->card_link == clink)
92 pnp_release_card_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 }
Jesper Juhla9adb8d2006-06-25 05:47:17 -070094 kfree(clink);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 return 0;
96}
97
98/**
99 * pnp_add_card_id - adds an EISA id to the specified card
100 * @id: pointer to a pnp_id structure
101 * @card: pointer to the desired card
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 */
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700103int pnp_add_card_id(struct pnp_id *id, struct pnp_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104{
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700105 struct pnp_id *ptr;
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -0700106
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 if (!id)
108 return -EINVAL;
109 if (!card)
110 return -EINVAL;
111 id->next = NULL;
112 ptr = card->id;
113 while (ptr && ptr->next)
114 ptr = ptr->next;
115 if (ptr)
116 ptr->next = id;
117 else
118 card->id = id;
119 return 0;
120}
121
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700122static void pnp_free_card_ids(struct pnp_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123{
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700124 struct pnp_id *id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 struct pnp_id *next;
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -0700126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 if (!card)
128 return;
129 id = card->id;
130 while (id) {
131 next = id->next;
132 kfree(id);
133 id = next;
134 }
135}
136
137static void pnp_release_card(struct device *dmdev)
138{
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700139 struct pnp_card *card = to_pnp_card(dmdev);
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -0700140
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 pnp_free_card_ids(card);
142 kfree(card);
143}
144
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700145static ssize_t pnp_show_card_name(struct device *dmdev,
146 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147{
148 char *str = buf;
149 struct pnp_card *card = to_pnp_card(dmdev);
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -0700150
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700151 str += sprintf(str, "%s\n", card->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 return (str - buf);
153}
154
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700155static DEVICE_ATTR(name, S_IRUGO, pnp_show_card_name, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700157static ssize_t pnp_show_card_ids(struct device *dmdev,
158 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159{
160 char *str = buf;
161 struct pnp_card *card = to_pnp_card(dmdev);
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700162 struct pnp_id *pos = card->id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
164 while (pos) {
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700165 str += sprintf(str, "%s\n", pos->id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 pos = pos->next;
167 }
168 return (str - buf);
169}
170
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700171static DEVICE_ATTR(card_id, S_IRUGO, pnp_show_card_ids, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
173static int pnp_interface_attach_card(struct pnp_card *card)
174{
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700175 int rc = device_create_file(&card->dev, &dev_attr_name);
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -0700176
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700177 if (rc)
178 return rc;
Jeff Garzikbfc7ee22006-12-06 20:35:33 -0800179
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700180 rc = device_create_file(&card->dev, &dev_attr_card_id);
181 if (rc)
182 goto err_name;
Jeff Garzikbfc7ee22006-12-06 20:35:33 -0800183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 return 0;
Jeff Garzikbfc7ee22006-12-06 20:35:33 -0800185
Bjorn Helgaas1e0aa9a2007-08-15 10:32:08 -0600186err_name:
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700187 device_remove_file(&card->dev, &dev_attr_name);
Jeff Garzikbfc7ee22006-12-06 20:35:33 -0800188 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189}
190
191/**
192 * pnp_add_card - adds a PnP card to the PnP Layer
193 * @card: pointer to the card to add
194 */
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700195int pnp_add_card(struct pnp_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196{
197 int error;
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700198 struct list_head *pos, *temp;
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -0700199
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 if (!card || !card->protocol)
201 return -EINVAL;
202
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700203 sprintf(card->dev.bus_id, "%02x:%02x", card->protocol->number,
204 card->number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 card->dev.parent = &card->protocol->dev;
206 card->dev.bus = NULL;
207 card->dev.release = &pnp_release_card;
208 error = device_register(&card->dev);
209
210 if (error == 0) {
211 pnp_interface_attach_card(card);
212 spin_lock(&pnp_lock);
213 list_add_tail(&card->global_list, &pnp_cards);
214 list_add_tail(&card->protocol_list, &card->protocol->cards);
215 spin_unlock(&pnp_lock);
216
217 /* we wait until now to add devices in order to ensure the drivers
218 * will be able to use all of the related devices on the card
219 * without waiting any unresonable length of time */
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700220 list_for_each(pos, &card->devices) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 struct pnp_dev *dev = card_to_pnp_dev(pos);
222 __pnp_add_device(dev);
223 }
224
225 /* match with card drivers */
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700226 list_for_each_safe(pos, temp, &pnp_card_drivers) {
227 struct pnp_card_driver *drv =
228 list_entry(pos, struct pnp_card_driver,
229 global_list);
230 card_probe(card, drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 }
232 } else
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700233 pnp_err("sysfs failure, card '%s' will be unavailable",
234 card->dev.bus_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 return error;
236}
237
238/**
239 * pnp_remove_card - removes a PnP card from the PnP Layer
240 * @card: pointer to the card to remove
241 */
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700242void pnp_remove_card(struct pnp_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243{
244 struct list_head *pos, *temp;
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -0700245
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 if (!card)
247 return;
248 device_unregister(&card->dev);
249 spin_lock(&pnp_lock);
250 list_del(&card->global_list);
251 list_del(&card->protocol_list);
252 spin_unlock(&pnp_lock);
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700253 list_for_each_safe(pos, temp, &card->devices) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 struct pnp_dev *dev = card_to_pnp_dev(pos);
255 pnp_remove_card_device(dev);
256 }
257}
258
259/**
260 * pnp_add_card_device - adds a device to the specified card
261 * @card: pointer to the card to add to
262 * @dev: pointer to the device to add
263 */
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700264int pnp_add_card_device(struct pnp_card *card, struct pnp_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265{
266 if (!card || !dev || !dev->protocol)
267 return -EINVAL;
268 dev->dev.parent = &card->dev;
269 dev->card_link = NULL;
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700270 snprintf(dev->dev.bus_id, BUS_ID_SIZE, "%02x:%02x.%02x",
271 dev->protocol->number, card->number, dev->number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 spin_lock(&pnp_lock);
273 dev->card = card;
274 list_add_tail(&dev->card_list, &card->devices);
275 spin_unlock(&pnp_lock);
276 return 0;
277}
278
279/**
280 * pnp_remove_card_device- removes a device from the specified card
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 * @dev: pointer to the device to remove
282 */
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700283void pnp_remove_card_device(struct pnp_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284{
285 spin_lock(&pnp_lock);
286 dev->card = NULL;
287 list_del(&dev->card_list);
288 spin_unlock(&pnp_lock);
289 __pnp_remove_device(dev);
290}
291
292/**
293 * pnp_request_card_device - Searches for a PnP device under the specified card
Martin Waitz3d410882005-06-23 22:05:21 -0700294 * @clink: pointer to the card link, cannot be NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 * @id: pointer to a PnP ID structure that explains the rules for finding the device
296 * @from: Starting place to search from. If NULL it will start from the begining.
297 */
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700298struct pnp_dev *pnp_request_card_device(struct pnp_card_link *clink,
299 const char *id, struct pnp_dev *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300{
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700301 struct list_head *pos;
302 struct pnp_dev *dev;
303 struct pnp_card_driver *drv;
304 struct pnp_card *card;
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -0700305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 if (!clink || !id)
307 goto done;
308 card = clink->card;
309 drv = clink->driver;
310 if (!from) {
311 pos = card->devices.next;
312 } else {
313 if (from->card != card)
314 goto done;
315 pos = from->card_list.next;
316 }
317 while (pos != &card->devices) {
318 dev = card_to_pnp_dev(pos);
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700319 if ((!dev->card_link) && compare_pnp_id(dev->id, id))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 goto found;
321 pos = pos->next;
322 }
323
Bjorn Helgaas1e0aa9a2007-08-15 10:32:08 -0600324done:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 return NULL;
326
Bjorn Helgaas1e0aa9a2007-08-15 10:32:08 -0600327found:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 dev->card_link = clink;
329 dev->dev.driver = &drv->link.driver;
Jeff Garzikbfc7ee22006-12-06 20:35:33 -0800330 if (pnp_bus_type.probe(&dev->dev))
331 goto err_out;
332 if (device_bind_driver(&dev->dev))
333 goto err_out;
334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 return dev;
Jeff Garzikbfc7ee22006-12-06 20:35:33 -0800336
Bjorn Helgaas1e0aa9a2007-08-15 10:32:08 -0600337err_out:
Jeff Garzikbfc7ee22006-12-06 20:35:33 -0800338 dev->dev.driver = NULL;
339 dev->card_link = NULL;
Jeff Garzikbfc7ee22006-12-06 20:35:33 -0800340 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341}
342
343/**
344 * pnp_release_card_device - call this when the driver no longer needs the device
345 * @dev: pointer to the PnP device stucture
346 */
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700347void pnp_release_card_device(struct pnp_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348{
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700349 struct pnp_card_driver *drv = dev->card_link->driver;
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -0700350
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 if (!drv)
352 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 drv->link.remove = &card_remove;
354 device_release_driver(&dev->dev);
355 drv->link.remove = &card_remove_first;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356}
357
Takashi Iwai4c98cfe2005-11-29 09:09:32 +0100358/*
359 * suspend/resume callbacks
360 */
361static int card_suspend(struct pnp_dev *dev, pm_message_t state)
362{
363 struct pnp_card_link *link = dev->card_link;
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -0700364
Takashi Iwai4c98cfe2005-11-29 09:09:32 +0100365 if (link->pm_state.event == state.event)
366 return 0;
367 link->pm_state = state;
368 return link->driver->suspend(link, state);
369}
370
371static int card_resume(struct pnp_dev *dev)
372{
373 struct pnp_card_link *link = dev->card_link;
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -0700374
Takashi Iwai4c98cfe2005-11-29 09:09:32 +0100375 if (link->pm_state.event == PM_EVENT_ON)
376 return 0;
377 link->pm_state = PMSG_ON;
378 link->driver->resume(link);
379 return 0;
380}
381
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382/**
383 * pnp_register_card_driver - registers a PnP card driver with the PnP Layer
384 * @drv: pointer to the driver to register
385 */
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700386int pnp_register_card_driver(struct pnp_card_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387{
Bjorn Helgaas982c6092006-03-27 01:17:08 -0800388 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 struct list_head *pos, *temp;
390
391 drv->link.name = drv->name;
392 drv->link.id_table = NULL; /* this will disable auto matching */
393 drv->link.flags = drv->flags;
394 drv->link.probe = NULL;
395 drv->link.remove = &card_remove_first;
Takashi Iwai4c98cfe2005-11-29 09:09:32 +0100396 drv->link.suspend = drv->suspend ? card_suspend : NULL;
397 drv->link.resume = drv->resume ? card_resume : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
Bjorn Helgaas982c6092006-03-27 01:17:08 -0800399 error = pnp_register_driver(&drv->link);
400 if (error < 0)
401 return error;
Adam Belayd1d051b22006-01-20 09:29:27 +0100402
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 spin_lock(&pnp_lock);
404 list_add_tail(&drv->global_list, &pnp_card_drivers);
405 spin_unlock(&pnp_lock);
Adam Belayd1d051b22006-01-20 09:29:27 +0100406
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700407 list_for_each_safe(pos, temp, &pnp_cards) {
408 struct pnp_card *card =
409 list_entry(pos, struct pnp_card, global_list);
410 card_probe(card, drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 }
Bjorn Helgaas982c6092006-03-27 01:17:08 -0800412 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413}
414
415/**
416 * pnp_unregister_card_driver - unregisters a PnP card driver from the PnP Layer
417 * @drv: pointer to the driver to unregister
418 */
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700419void pnp_unregister_card_driver(struct pnp_card_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420{
421 spin_lock(&pnp_lock);
422 list_del(&drv->global_list);
423 spin_unlock(&pnp_lock);
424 pnp_unregister_driver(&drv->link);
425}
426
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427EXPORT_SYMBOL(pnp_request_card_device);
428EXPORT_SYMBOL(pnp_release_card_device);
429EXPORT_SYMBOL(pnp_register_card_driver);
430EXPORT_SYMBOL(pnp_unregister_card_driver);