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