1 /*
2 * Linux Plug and Play Support
3 * Copyright by Adam Belay <ambx1@neo.rr.com>
4 * Copyright (C) 2008 Hewlett-Packard Development Company, L.P.
5 * Bjorn Helgaas <bjorn.helgaas@hp.com>
6 */
7
8 #ifndef _LINUX_PNP_H
9 #define _LINUX_PNP_H
10
11 #include <linux/device.h>
12 #include <linux/list.h>
13 #include <linux/errno.h>
14 #include <linux/mod_devicetable.h>
15
16 #define PNP_NAME_LEN 50
17
18 struct pnp_protocol;
19 struct pnp_dev;
20
21 /*
22 * Resource Management
23 */
24 #ifdef CONFIG_PNP
25 struct resource *pnp_get_resource(struct pnp_dev *dev, unsigned long type,
26 unsigned int num);
27 #else
28 static inline struct resource *pnp_get_resource(struct pnp_dev *dev,
29 unsigned long type, unsigned int num)
30 {
31 return NULL;
32 }
33 #endif
34
35 static inline int pnp_resource_valid(struct resource *res)
36 {
37 if (res)
38 return 1;
39 return 0;
40 }
41
42 static inline int pnp_resource_enabled(struct resource *res)
43 {
44 if (res && !(res->flags & IORESOURCE_DISABLED))
45 return 1;
46 return 0;
47 }
48
49 static inline resource_size_t pnp_resource_len(struct resource *res)
50 {
51 if (res->start == 0 && res->end == 0)
52 return 0;
53 return res->end - res->start + 1;
54 }
55
56
57 static inline resource_size_t pnp_port_start(struct pnp_dev *dev,
58 unsigned int bar)
59 {
60 struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
61
62 if (pnp_resource_valid(res))
63 return res->start;
64 return 0;
65 }
66
67 static inline resource_size_t pnp_port_end(struct pnp_dev *dev,
68 unsigned int bar)
69 {
70 struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
71
72 if (pnp_resource_valid(res))
73 return res->end;
74 return 0;
75 }
76
77 static inline unsigned long pnp_port_flags(struct pnp_dev *dev,
78 unsigned int bar)
79 {
80 struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
81
82 if (pnp_resource_valid(res))
83 return res->flags;
84 return IORESOURCE_IO | IORESOURCE_AUTO;
85 }
86
87 static inline int pnp_port_valid(struct pnp_dev *dev, unsigned int bar)
88 {
89 return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_IO, bar));
90 }
91
92 static inline resource_size_t pnp_port_len(struct pnp_dev *dev,
93 unsigned int bar)
94 {
95 struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
96
97 if (pnp_resource_valid(res))
98 return pnp_resource_len(res);
99 return 0;
100 }
101
102
103 static inline resource_size_t pnp_mem_start(struct pnp_dev *dev,
104 unsigned int bar)
105 {
106 struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
107
108 if (pnp_resource_valid(res))
109 return res->start;
110 return 0;
111 }
112
113 static inline resource_size_t pnp_mem_end(struct pnp_dev *dev,
114 unsigned int bar)
115 {
116 struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
117
118 if (pnp_resource_valid(res))
119 return res->end;
120 return 0;
121 }
122
123 static inline unsigned long pnp_mem_flags(struct pnp_dev *dev, unsigned int bar)
124 {
125 struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
126
127 if (pnp_resource_valid(res))
128 return res->flags;
129 return IORESOURCE_MEM | IORESOURCE_AUTO;
130 }
131
132 static inline int pnp_mem_valid(struct pnp_dev *dev, unsigned int bar)
133 {
134 return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_MEM, bar));
135 }
136
137 static inline resource_size_t pnp_mem_len(struct pnp_dev *dev,
138 unsigned int bar)
139 {
140 struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
141
142 if (pnp_resource_valid(res))
143 return pnp_resource_len(res);
144 return 0;
145 }
146
147
148 static inline resource_size_t pnp_irq(struct pnp_dev *dev, unsigned int bar)
149 {
150 struct resource *res = pnp_get_resource(dev, IORESOURCE_IRQ, bar);
151
152 if (pnp_resource_valid(res))
153 return res->start;
154 return -1;
155 }
156
157 static inline unsigned long pnp_irq_flags(struct pnp_dev *dev, unsigned int bar)
158 {
159 struct resource *res = pnp_get_resource(dev, IORESOURCE_IRQ, bar);
160
161 if (pnp_resource_valid(res))
162 return res->flags;
163 return IORESOURCE_IRQ | IORESOURCE_AUTO;
164 }
165
166 static inline int pnp_irq_valid(struct pnp_dev *dev, unsigned int bar)
167 {
168 return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_IRQ, bar));
169 }
170
171
172 static inline resource_size_t pnp_dma(struct pnp_dev *dev, unsigned int bar)
173 {
174 struct resource *res = pnp_get_resource(dev, IORESOURCE_DMA, bar);
175
176 if (pnp_resource_valid(res))
177 return res->start;
178 return -1;
179 }
180
181 static inline unsigned long pnp_dma_flags(struct pnp_dev *dev, unsigned int bar)
182 {
183 struct resource *res = pnp_get_resource(dev, IORESOURCE_DMA, bar);
184
185 if (pnp_resource_valid(res))
186 return res->flags;
187 return IORESOURCE_DMA | IORESOURCE_AUTO;
188 }
189
190 static inline int pnp_dma_valid(struct pnp_dev *dev, unsigned int bar)
191 {
192 return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_DMA, bar));
193 }
194
195
196 /*
197 * Device Management
198 */
199
200 struct pnp_card {
201 struct device dev; /* Driver Model device interface */
202 unsigned char number; /* used as an index, must be unique */
203 struct list_head global_list; /* node in global list of cards */
204 struct list_head protocol_list; /* node in protocol's list of cards */
205 struct list_head devices; /* devices attached to the card */
206
207 struct pnp_protocol *protocol;
208 struct pnp_id *id; /* contains supported EISA IDs */
209
210 char name[PNP_NAME_LEN]; /* contains a human-readable name */
211 unsigned char pnpver; /* Plug & Play version */
212 unsigned char productver; /* product version */
213 unsigned int serial; /* serial number */
214 unsigned char checksum; /* if zero - checksum passed */
215 struct proc_dir_entry *procdir; /* directory entry in /proc/bus/isapnp */
216 };
217
218 #define global_to_pnp_card(n) list_entry(n, struct pnp_card, global_list)
219 #define protocol_to_pnp_card(n) list_entry(n, struct pnp_card, protocol_list)
220 #define to_pnp_card(n) container_of(n, struct pnp_card, dev)
221 #define pnp_for_each_card(card) \
222 for((card) = global_to_pnp_card(pnp_cards.next); \
223 (card) != global_to_pnp_card(&pnp_cards); \
224 (card) = global_to_pnp_card((card)->global_list.next))
225
226 struct pnp_card_link {
227 struct pnp_card *card;
228 struct pnp_card_driver *driver;
229 void *driver_data;
230 pm_message_t pm_state;
231 };
232
233 static inline void *pnp_get_card_drvdata(struct pnp_card_link *pcard)
234 {
235 return pcard->driver_data;
236 }
237
238 static inline void pnp_set_card_drvdata(struct pnp_card_link *pcard, void *data)
239 {
240 pcard->driver_data = data;
241 }
242
243 struct pnp_dev {
244 struct device dev; /* Driver Model device interface */
245 u64 dma_mask;
246 unsigned int number; /* used as an index, must be unique */
247 int status;
248
249 struct list_head global_list; /* node in global list of devices */
250 struct list_head protocol_list; /* node in list of device's protocol */
251 struct list_head card_list; /* node in card's list of devices */
252 struct list_head rdev_list; /* node in cards list of requested devices */
253
254 struct pnp_protocol *protocol;
255 struct pnp_card *card; /* card the device is attached to, none if NULL */
256 struct pnp_driver *driver;
257 struct pnp_card_link *card_link;
258
259 struct pnp_id *id; /* supported EISA IDs */
260
261 int active;
262 int capabilities;
263 unsigned int num_dependent_sets;
264 struct list_head resources;
265 struct list_head options;
266
267 char name[PNP_NAME_LEN]; /* contains a human-readable name */
268 int flags; /* used by protocols */
269 struct proc_dir_entry *procent; /* device entry in /proc/bus/isapnp */
270 void *data;
271 };
272
273 #define global_to_pnp_dev(n) list_entry(n, struct pnp_dev, global_list)
274 #define card_to_pnp_dev(n) list_entry(n, struct pnp_dev, card_list)
275 #define protocol_to_pnp_dev(n) list_entry(n, struct pnp_dev, protocol_list)
276 #define to_pnp_dev(n) container_of(n, struct pnp_dev, dev)
277 #define pnp_for_each_dev(dev) \
278 for((dev) = global_to_pnp_dev(pnp_global.next); \
279 (dev) != global_to_pnp_dev(&pnp_global); \
280 (dev) = global_to_pnp_dev((dev)->global_list.next))
281 #define card_for_each_dev(card,dev) \
282 for((dev) = card_to_pnp_dev((card)->devices.next); \
283 (dev) != card_to_pnp_dev(&(card)->devices); \
284 (dev) = card_to_pnp_dev((dev)->card_list.next))
285 #define pnp_dev_name(dev) (dev)->name
286
287 static inline void *pnp_get_drvdata(struct pnp_dev *pdev)
288 {
289 return dev_get_drvdata(&pdev->dev);
290 }
291
292 static inline void pnp_set_drvdata(struct pnp_dev *pdev, void *data)
293 {
294 dev_set_drvdata(&pdev->dev, data);
295 }
296
297 struct pnp_fixup {
298 char id[7];
299 void (*quirk_function) (struct pnp_dev * dev); /* fixup function */
300 };
301
302 /* config parameters */
303 #define PNP_CONFIG_NORMAL 0x0001
304 #define PNP_CONFIG_FORCE 0x0002 /* disables validity checking */
305
306 /* capabilities */
307 #define PNP_READ 0x0001
308 #define PNP_WRITE 0x0002
309 #define PNP_DISABLE 0x0004
310 #define PNP_CONFIGURABLE 0x0008
311 #define PNP_REMOVABLE 0x0010
312
313 #define pnp_can_read(dev) (((dev)->protocol->get) && \
314 ((dev)->capabilities & PNP_READ))
315 #define pnp_can_write(dev) (((dev)->protocol->set) && \
316 ((dev)->capabilities & PNP_WRITE))
317 #define pnp_can_disable(dev) (((dev)->protocol->disable) && \
318 ((dev)->capabilities & PNP_DISABLE))
319 #define pnp_can_configure(dev) ((!(dev)->active) && \
320 ((dev)->capabilities & PNP_CONFIGURABLE))
321
322 #ifdef CONFIG_ISAPNP
323 extern struct pnp_protocol isapnp_protocol;
324 #define pnp_device_is_isapnp(dev) ((dev)->protocol == (&isapnp_protocol))
325 #else
326 #define pnp_device_is_isapnp(dev) 0
327 #endif
328 extern struct mutex pnp_res_mutex;
329
330 #ifdef CONFIG_PNPBIOS
331 extern struct pnp_protocol pnpbios_protocol;
332 #define pnp_device_is_pnpbios(dev) ((dev)->protocol == (&pnpbios_protocol))
333 #else
334 #define pnp_device_is_pnpbios(dev) 0
335 #endif
336
337 /* status */
338 #define PNP_READY 0x0000
339 #define PNP_ATTACHED 0x0001
340 #define PNP_BUSY 0x0002
341 #define PNP_FAULTY 0x0004
342
343 /* isapnp specific macros */
344
345 #define isapnp_card_number(dev) ((dev)->card ? (dev)->card->number : -1)
346 #define isapnp_csn_number(dev) ((dev)->number)
347
348 /*
349 * Driver Management
350 */
351
352 struct pnp_id {
353 char id[PNP_ID_LEN];
354 struct pnp_id *next;
355 };
356
357 struct pnp_driver {
358 char *name;
359 const struct pnp_device_id *id_table;
360 unsigned int flags;
361 int (*probe) (struct pnp_dev *dev, const struct pnp_device_id *dev_id);
362 void (*remove) (struct pnp_dev *dev);
363 int (*suspend) (struct pnp_dev *dev, pm_message_t state);
364 int (*resume) (struct pnp_dev *dev);
365 struct device_driver driver;
366 };
367
368 #define to_pnp_driver(drv) container_of(drv, struct pnp_driver, driver)
369
370 struct pnp_card_driver {
371 struct list_head global_list;
372 char *name;
373 const struct pnp_card_device_id *id_table;
374 unsigned int flags;
375 int (*probe) (struct pnp_card_link *card,
376 const struct pnp_card_device_id *card_id);
377 void (*remove) (struct pnp_card_link *card);
378 int (*suspend) (struct pnp_card_link *card, pm_message_t state);
379 int (*resume) (struct pnp_card_link *card);
380 struct pnp_driver link;
381 };
382
383 #define to_pnp_card_driver(drv) container_of(drv, struct pnp_card_driver, link)
384
385 /* pnp driver flags */
386 #define PNP_DRIVER_RES_DO_NOT_CHANGE 0x0001 /* do not change the state of the device */
387 #define PNP_DRIVER_RES_DISABLE 0x0003 /* ensure the device is disabled */
388
389 /*
390 * Protocol Management
391 */
392
393 struct pnp_protocol {
394 struct list_head protocol_list;
395 char *name;
396
397 /* resource control functions */
398 int (*get) (struct pnp_dev *dev);
399 int (*set) (struct pnp_dev *dev);
400 int (*disable) (struct pnp_dev *dev);
401
402 /* protocol specific suspend/resume */
403 int (*suspend) (struct pnp_dev * dev, pm_message_t state);
404 int (*resume) (struct pnp_dev * dev);
405
406 /* used by pnp layer only (look but don't touch) */
407 unsigned char number; /* protocol number */
408 struct device dev; /* link to driver model */
409 struct list_head cards;
410 struct list_head devices;
411 };
412
413 #define to_pnp_protocol(n) list_entry(n, struct pnp_protocol, protocol_list)
414 #define protocol_for_each_card(protocol,card) \
415 for((card) = protocol_to_pnp_card((protocol)->cards.next); \
416 (card) != protocol_to_pnp_card(&(protocol)->cards); \
417 (card) = protocol_to_pnp_card((card)->protocol_list.next))
418 #define protocol_for_each_dev(protocol,dev) \
419 for((dev) = protocol_to_pnp_dev((protocol)->devices.next); \
420 (dev) != protocol_to_pnp_dev(&(protocol)->devices); \
421 (dev) = protocol_to_pnp_dev((dev)->protocol_list.next))
422
423 extern struct bus_type pnp_bus_type;
424
425 #if defined(CONFIG_PNP)
426
427 /* device management */
428 int pnp_device_attach(struct pnp_dev *pnp_dev);
429 void pnp_device_detach(struct pnp_dev *pnp_dev);
430 extern struct list_head pnp_global;
431 extern int pnp_platform_devices;
432
433 /* multidevice card support */
434 struct pnp_dev *pnp_request_card_device(struct pnp_card_link *clink,
435 const char *id, struct pnp_dev *from);
436 void pnp_release_card_device(struct pnp_dev *dev);
437 int pnp_register_card_driver(struct pnp_card_driver *drv);
438 void pnp_unregister_card_driver(struct pnp_card_driver *drv);
439 extern struct list_head pnp_cards;
440
441 /* resource management */
442 int pnp_possible_config(struct pnp_dev *dev, int type, resource_size_t base,
443 resource_size_t size);
444 int pnp_auto_config_dev(struct pnp_dev *dev);
445 int pnp_start_dev(struct pnp_dev *dev);
446 int pnp_stop_dev(struct pnp_dev *dev);
447 int pnp_activate_dev(struct pnp_dev *dev);
448 int pnp_disable_dev(struct pnp_dev *dev);
449 int pnp_range_reserved(resource_size_t start, resource_size_t end);
450
451 /* protocol helpers */
452 int pnp_is_active(struct pnp_dev *dev);
453 int compare_pnp_id(struct pnp_id *pos, const char *id);
454 int pnp_register_driver(struct pnp_driver *drv);
455 void pnp_unregister_driver(struct pnp_driver *drv);
456
457 #else
458
459 /* device management */
460 static inline int pnp_device_attach(struct pnp_dev *pnp_dev) { return -ENODEV; }
461 static inline void pnp_device_detach(struct pnp_dev *pnp_dev) { }
462
463 #define pnp_platform_devices 0
464
465 /* multidevice card support */
466 static inline struct pnp_dev *pnp_request_card_device(struct pnp_card_link *clink, const char *id, struct pnp_dev *from) { return NULL; }
467 static inline void pnp_release_card_device(struct pnp_dev *dev) { }
468 static inline int pnp_register_card_driver(struct pnp_card_driver *drv) { return -ENODEV; }
469 static inline void pnp_unregister_card_driver(struct pnp_card_driver *drv) { }
470
471 /* resource management */
472 static inline int pnp_possible_config(struct pnp_dev *dev, int type,
473 resource_size_t base,
474 resource_size_t size) { return 0; }
475 static inline int pnp_auto_config_dev(struct pnp_dev *dev) { return -ENODEV; }
476 static inline int pnp_start_dev(struct pnp_dev *dev) { return -ENODEV; }
477 static inline int pnp_stop_dev(struct pnp_dev *dev) { return -ENODEV; }
478 static inline int pnp_activate_dev(struct pnp_dev *dev) { return -ENODEV; }
479 static inline int pnp_disable_dev(struct pnp_dev *dev) { return -ENODEV; }
480 static inline int pnp_range_reserved(resource_size_t start, resource_size_t end) { return 0;}
481
482 /* protocol helpers */
483 static inline int pnp_is_active(struct pnp_dev *dev) { return 0; }
484 static inline int compare_pnp_id(struct pnp_id *pos, const char *id) { return -ENODEV; }
485 static inline int pnp_register_driver(struct pnp_driver *drv) { return -ENODEV; }
486 static inline void pnp_unregister_driver(struct pnp_driver *drv) { }
487
488 #endif /* CONFIG_PNP */
489
490 #endif /* _LINUX_PNP_H */
491
|
This page was automatically generated by the
LXR engine.
|