blob: 153a493b5413e06482dd9909bf0301e6d26eae1f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * driver.c - device id matching, driver model, etc.
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/string.h>
8#include <linux/list.h>
9#include <linux/module.h>
10#include <linux/ctype.h>
11#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/pnp.h>
13#include "base.h"
14
15static int compare_func(const char *ida, const char *idb)
16{
17 int i;
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -070018
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 /* we only need to compare the last 4 chars */
Bjorn Helgaas9dd78462007-07-26 10:41:20 -070020 for (i = 3; i < 7; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 if (ida[i] != 'X' &&
Bjorn Helgaas9dd78462007-07-26 10:41:20 -070022 idb[i] != 'X' && toupper(ida[i]) != toupper(idb[i]))
Linus Torvalds1da177e2005-04-16 15:20:36 -070023 return 0;
24 }
25 return 1;
26}
27
28int compare_pnp_id(struct pnp_id *pos, const char *id)
29{
30 if (!pos || !id || (strlen(id) != 7))
31 return 0;
Bjorn Helgaas9dd78462007-07-26 10:41:20 -070032 if (memcmp(id, "ANYDEVS", 7) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 return 1;
Bjorn Helgaas9dd78462007-07-26 10:41:20 -070034 while (pos) {
35 if (memcmp(pos->id, id, 3) == 0)
36 if (compare_func(pos->id, id) == 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 return 1;
38 pos = pos->next;
39 }
40 return 0;
41}
42
Bjorn Helgaas9dd78462007-07-26 10:41:20 -070043static const struct pnp_device_id *match_device(struct pnp_driver *drv,
44 struct pnp_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -070045{
46 const struct pnp_device_id *drv_id = drv->id_table;
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -070047
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 if (!drv_id)
49 return NULL;
50
51 while (*drv_id->id) {
52 if (compare_pnp_id(dev->id, drv_id->id))
53 return drv_id;
54 drv_id++;
55 }
56 return NULL;
57}
58
59int pnp_device_attach(struct pnp_dev *pnp_dev)
60{
Rafael J. Wysocki38f6b382015-03-18 22:39:55 +010061 mutex_lock(&pnp_lock);
Bjorn Helgaas9dd78462007-07-26 10:41:20 -070062 if (pnp_dev->status != PNP_READY) {
Rafael J. Wysocki38f6b382015-03-18 22:39:55 +010063 mutex_unlock(&pnp_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 return -EBUSY;
65 }
66 pnp_dev->status = PNP_ATTACHED;
Rafael J. Wysocki38f6b382015-03-18 22:39:55 +010067 mutex_unlock(&pnp_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 return 0;
69}
70
71void pnp_device_detach(struct pnp_dev *pnp_dev)
72{
Rafael J. Wysocki38f6b382015-03-18 22:39:55 +010073 mutex_lock(&pnp_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 if (pnp_dev->status == PNP_ATTACHED)
75 pnp_dev->status = PNP_READY;
Rafael J. Wysocki38f6b382015-03-18 22:39:55 +010076 mutex_unlock(&pnp_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 pnp_disable_dev(pnp_dev);
78}
79
80static int pnp_device_probe(struct device *dev)
81{
82 int error;
83 struct pnp_driver *pnp_drv;
84 struct pnp_dev *pnp_dev;
85 const struct pnp_device_id *dev_id = NULL;
86 pnp_dev = to_pnp_dev(dev);
87 pnp_drv = to_pnp_driver(dev->driver);
88
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 error = pnp_device_attach(pnp_dev);
90 if (error < 0)
91 return error;
92
93 if (pnp_dev->active == 0) {
94 if (!(pnp_drv->flags & PNP_DRIVER_RES_DO_NOT_CHANGE)) {
95 error = pnp_activate_dev(pnp_dev);
96 if (error < 0)
97 return error;
98 }
99 } else if ((pnp_drv->flags & PNP_DRIVER_RES_DISABLE)
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700100 == PNP_DRIVER_RES_DISABLE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 error = pnp_disable_dev(pnp_dev);
102 if (error < 0)
103 return error;
104 }
105 error = 0;
106 if (pnp_drv->probe) {
107 dev_id = match_device(pnp_drv, pnp_dev);
108 if (dev_id != NULL)
109 error = pnp_drv->probe(pnp_dev, dev_id);
110 }
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700111 if (error >= 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 pnp_dev->driver = pnp_drv;
113 error = 0;
114 } else
115 goto fail;
Bjorn Helgaasa05d0782007-10-16 23:31:10 -0700116
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 return error;
118
Bjorn Helgaas1e0aa9a2007-08-15 10:32:08 -0600119fail:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 pnp_device_detach(pnp_dev);
121 return error;
122}
123
124static int pnp_device_remove(struct device *dev)
125{
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700126 struct pnp_dev *pnp_dev = to_pnp_dev(dev);
127 struct pnp_driver *drv = pnp_dev->driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129 if (drv) {
130 if (drv->remove)
131 drv->remove(pnp_dev);
132 pnp_dev->driver = NULL;
133 }
134 pnp_device_detach(pnp_dev);
135 return 0;
136}
137
David Härdemanabd66332009-09-21 17:04:52 -0700138static void pnp_device_shutdown(struct device *dev)
139{
140 struct pnp_dev *pnp_dev = to_pnp_dev(dev);
141 struct pnp_driver *drv = pnp_dev->driver;
142
143 if (drv && drv->shutdown)
144 drv->shutdown(pnp_dev);
145}
146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147static int pnp_bus_match(struct device *dev, struct device_driver *drv)
148{
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700149 struct pnp_dev *pnp_dev = to_pnp_dev(dev);
150 struct pnp_driver *pnp_drv = to_pnp_driver(drv);
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -0700151
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 if (match_device(pnp_drv, pnp_dev) == NULL)
153 return 0;
154 return 1;
155}
156
Shuah Khaneaf140b2013-07-26 15:07:26 -0600157static int __pnp_bus_suspend(struct device *dev, pm_message_t state)
Takashi Iwai4c98cfe2005-11-29 09:09:32 +0100158{
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700159 struct pnp_dev *pnp_dev = to_pnp_dev(dev);
160 struct pnp_driver *pnp_drv = pnp_dev->driver;
Pierre Ossman68094e32005-11-29 09:09:32 +0100161 int error;
Takashi Iwai4c98cfe2005-11-29 09:09:32 +0100162
Pierre Ossman68094e32005-11-29 09:09:32 +0100163 if (!pnp_drv)
164 return 0;
165
Shuah Khan729377d2013-09-11 14:23:09 -0700166 if (pnp_drv->driver.pm && pnp_drv->driver.pm->suspend) {
167 error = pnp_drv->driver.pm->suspend(dev);
168 suspend_report_result(pnp_drv->driver.pm->suspend, error);
169 if (error)
170 return error;
171 }
172
Pierre Ossman68094e32005-11-29 09:09:32 +0100173 if (pnp_drv->suspend) {
174 error = pnp_drv->suspend(pnp_dev, state);
175 if (error)
176 return error;
177 }
178
Rene Herman5d389982008-02-06 01:40:05 -0800179 if (pnp_can_disable(pnp_dev)) {
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700180 error = pnp_stop_dev(pnp_dev);
181 if (error)
182 return error;
Pierre Ossman68094e32005-11-29 09:09:32 +0100183 }
184
Peter Hurley01395d72015-01-22 11:50:24 -0500185 if (pnp_can_suspend(pnp_dev))
Shaohua Lifc30e682007-07-20 10:03:20 +0800186 pnp_dev->protocol->suspend(pnp_dev, state);
Takashi Iwai4c98cfe2005-11-29 09:09:32 +0100187 return 0;
188}
189
Shuah Khaneaf140b2013-07-26 15:07:26 -0600190static int pnp_bus_suspend(struct device *dev)
191{
192 return __pnp_bus_suspend(dev, PMSG_SUSPEND);
193}
194
195static int pnp_bus_freeze(struct device *dev)
196{
197 return __pnp_bus_suspend(dev, PMSG_FREEZE);
198}
199
Dmitry Torokhov8a37ea52013-12-05 02:01:55 +0100200static int pnp_bus_poweroff(struct device *dev)
201{
202 return __pnp_bus_suspend(dev, PMSG_HIBERNATE);
203}
204
Pierre Ossman68094e32005-11-29 09:09:32 +0100205static int pnp_bus_resume(struct device *dev)
Takashi Iwai4c98cfe2005-11-29 09:09:32 +0100206{
Bjorn Helgaas9dd78462007-07-26 10:41:20 -0700207 struct pnp_dev *pnp_dev = to_pnp_dev(dev);
208 struct pnp_driver *pnp_drv = pnp_dev->driver;
Pierre Ossman68094e32005-11-29 09:09:32 +0100209 int error;
Takashi Iwai4c98cfe2005-11-29 09:09:32 +0100210
Pierre Ossman68094e32005-11-29 09:09:32 +0100211 if (!pnp_drv)
212 return 0;
213
Rafael J. Wysockicc8e7a32011-01-10 21:23:16 +0100214 if (pnp_dev->protocol->resume) {
215 error = pnp_dev->protocol->resume(pnp_dev);
216 if (error)
217 return error;
218 }
Shaohua Lifc30e682007-07-20 10:03:20 +0800219
Rene Herman5d389982008-02-06 01:40:05 -0800220 if (pnp_can_write(pnp_dev)) {
Pierre Ossman68094e32005-11-29 09:09:32 +0100221 error = pnp_start_dev(pnp_dev);
222 if (error)
223 return error;
224 }
225
Shuah Khan729377d2013-09-11 14:23:09 -0700226 if (pnp_drv->driver.pm && pnp_drv->driver.pm->resume) {
227 error = pnp_drv->driver.pm->resume(dev);
228 if (error)
229 return error;
230 }
231
Rene Herman5d389982008-02-06 01:40:05 -0800232 if (pnp_drv->resume) {
233 error = pnp_drv->resume(pnp_dev);
234 if (error)
235 return error;
236 }
Pierre Ossman68094e32005-11-29 09:09:32 +0100237
238 return 0;
Takashi Iwai4c98cfe2005-11-29 09:09:32 +0100239}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Shuah Khaneaf140b2013-07-26 15:07:26 -0600241static const struct dev_pm_ops pnp_bus_dev_pm_ops = {
Dmitry Torokhov8a37ea52013-12-05 02:01:55 +0100242 /* Suspend callbacks */
Shuah Khaneaf140b2013-07-26 15:07:26 -0600243 .suspend = pnp_bus_suspend,
Shuah Khaneaf140b2013-07-26 15:07:26 -0600244 .resume = pnp_bus_resume,
Dmitry Torokhov8a37ea52013-12-05 02:01:55 +0100245 /* Hibernate callbacks */
246 .freeze = pnp_bus_freeze,
247 .thaw = pnp_bus_resume,
248 .poweroff = pnp_bus_poweroff,
249 .restore = pnp_bus_resume,
Shuah Khaneaf140b2013-07-26 15:07:26 -0600250};
251
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252struct bus_type pnp_bus_type = {
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -0700253 .name = "pnp",
254 .match = pnp_bus_match,
255 .probe = pnp_device_probe,
256 .remove = pnp_device_remove,
David Härdemanabd66332009-09-21 17:04:52 -0700257 .shutdown = pnp_device_shutdown,
Shuah Khaneaf140b2013-07-26 15:07:26 -0600258 .pm = &pnp_bus_dev_pm_ops,
Greg Kroah-Hartman2df43902013-10-06 23:55:42 -0700259 .dev_groups = pnp_dev_groups,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260};
261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262int pnp_register_driver(struct pnp_driver *drv)
263{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 drv->driver.name = drv->name;
265 drv->driver.bus = &pnp_bus_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
Bjorn Helgaas982c6092006-03-27 01:17:08 -0800267 return driver_register(&drv->driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268}
269
270void pnp_unregister_driver(struct pnp_driver *drv)
271{
272 driver_unregister(&drv->driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273}
274
275/**
276 * pnp_add_id - adds an EISA id to the specified device
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 * @dev: pointer to the desired device
Bjorn Helgaas772defc2008-04-28 16:33:52 -0600278 * @id: pointer to an EISA id string
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 */
Thomas Renninger620e1122010-10-01 10:54:00 +0200280struct pnp_id *pnp_add_id(struct pnp_dev *dev, const char *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281{
Bjorn Helgaas772defc2008-04-28 16:33:52 -0600282 struct pnp_id *dev_id, *ptr;
Bjorn Helgaas07d4e9a2007-07-26 10:41:21 -0700283
Bjorn Helgaas772defc2008-04-28 16:33:52 -0600284 dev_id = kzalloc(sizeof(struct pnp_id), GFP_KERNEL);
285 if (!dev_id)
286 return NULL;
287
288 dev_id->id[0] = id[0];
289 dev_id->id[1] = id[1];
290 dev_id->id[2] = id[2];
291 dev_id->id[3] = tolower(id[3]);
292 dev_id->id[4] = tolower(id[4]);
293 dev_id->id[5] = tolower(id[5]);
294 dev_id->id[6] = tolower(id[6]);
295 dev_id->id[7] = '\0';
296
297 dev_id->next = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 ptr = dev->id;
299 while (ptr && ptr->next)
300 ptr = ptr->next;
301 if (ptr)
Bjorn Helgaas772defc2008-04-28 16:33:52 -0600302 ptr->next = dev_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 else
Bjorn Helgaas772defc2008-04-28 16:33:52 -0600304 dev->id = dev_id;
305
306 return dev_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307}
308
309EXPORT_SYMBOL(pnp_register_driver);
310EXPORT_SYMBOL(pnp_unregister_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311EXPORT_SYMBOL(pnp_device_attach);
312EXPORT_SYMBOL(pnp_device_detach);