2 * Linux Plug and Play Support
3 * Copyright by Adam Belay <ambx1@neo.rr.com>
11 #include <linux/device.h>
12 #include <linux/list.h>
13 #include <linux/errno.h>
14 #include <linux/mod_devicetable.h>
16 #define PNP_NAME_LEN 50
20 struct pnp_resource_table;
25 struct resource *pnp_get_resource(struct pnp_dev *, unsigned int, unsigned int);
27 static inline int pnp_resource_valid(struct resource *res)
29 if (res && !(res->flags & IORESOURCE_UNSET))
34 static inline resource_size_t pnp_resource_len(struct resource *res)
36 if (res->start == 0 && res->end == 0)
38 return res->end - res->start + 1;
42 static inline resource_size_t pnp_port_start(struct pnp_dev *dev,
45 return pnp_get_resource(dev, IORESOURCE_IO, bar)->start;
48 static inline resource_size_t pnp_port_end(struct pnp_dev *dev,
51 return pnp_get_resource(dev, IORESOURCE_IO, bar)->end;
54 static inline unsigned long pnp_port_flags(struct pnp_dev *dev,
57 return pnp_get_resource(dev, IORESOURCE_IO, bar)->flags;
60 static inline int pnp_port_valid(struct pnp_dev *dev, unsigned int bar)
62 return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_IO, bar));
65 static inline resource_size_t pnp_port_len(struct pnp_dev *dev,
68 return pnp_resource_len(pnp_get_resource(dev, IORESOURCE_IO, bar));
72 static inline resource_size_t pnp_mem_start(struct pnp_dev *dev,
75 return pnp_get_resource(dev, IORESOURCE_MEM, bar)->start;
78 static inline resource_size_t pnp_mem_end(struct pnp_dev *dev,
81 return pnp_get_resource(dev, IORESOURCE_MEM, bar)->end;
84 static inline unsigned long pnp_mem_flags(struct pnp_dev *dev, unsigned int bar)
86 return pnp_get_resource(dev, IORESOURCE_MEM, bar)->flags;
89 static inline int pnp_mem_valid(struct pnp_dev *dev, unsigned int bar)
91 return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_MEM, bar));
94 static inline resource_size_t pnp_mem_len(struct pnp_dev *dev,
97 return pnp_resource_len(pnp_get_resource(dev, IORESOURCE_MEM, bar));
101 static inline resource_size_t pnp_irq(struct pnp_dev *dev, unsigned int bar)
103 return pnp_get_resource(dev, IORESOURCE_IRQ, bar)->start;
106 static inline unsigned long pnp_irq_flags(struct pnp_dev *dev, unsigned int bar)
108 return pnp_get_resource(dev, IORESOURCE_IRQ, bar)->flags;
111 static inline int pnp_irq_valid(struct pnp_dev *dev, unsigned int bar)
113 return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_IRQ, bar));
117 static inline resource_size_t pnp_dma(struct pnp_dev *dev, unsigned int bar)
119 return pnp_get_resource(dev, IORESOURCE_DMA, bar)->start;
122 static inline unsigned long pnp_dma_flags(struct pnp_dev *dev, unsigned int bar)
124 return pnp_get_resource(dev, IORESOURCE_DMA, bar)->flags;
127 static inline int pnp_dma_valid(struct pnp_dev *dev, unsigned int bar)
129 return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_DMA, bar));
133 #define PNP_PORT_FLAG_16BITADDR (1<<0)
134 #define PNP_PORT_FLAG_FIXED (1<<1)
137 unsigned short min; /* min base number */
138 unsigned short max; /* max base number */
139 unsigned char align; /* align boundary */
140 unsigned char size; /* size of range */
141 unsigned char flags; /* port flags */
142 unsigned char pad; /* pad */
143 struct pnp_port *next; /* next port */
146 #define PNP_IRQ_NR 256
148 DECLARE_BITMAP(map, PNP_IRQ_NR); /* bitmask for IRQ lines */
149 unsigned char flags; /* IRQ flags */
150 unsigned char pad; /* pad */
151 struct pnp_irq *next; /* next IRQ */
155 unsigned char map; /* bitmask for DMA channels */
156 unsigned char flags; /* DMA flags */
157 struct pnp_dma *next; /* next port */
161 unsigned int min; /* min base number */
162 unsigned int max; /* max base number */
163 unsigned int align; /* align boundary */
164 unsigned int size; /* size of range */
165 unsigned char flags; /* memory flags */
166 unsigned char pad; /* pad */
167 struct pnp_mem *next; /* next memory resource */
170 #define PNP_RES_PRIORITY_PREFERRED 0
171 #define PNP_RES_PRIORITY_ACCEPTABLE 1
172 #define PNP_RES_PRIORITY_FUNCTIONAL 2
173 #define PNP_RES_PRIORITY_INVALID 65535
176 unsigned short priority; /* priority */
177 struct pnp_port *port; /* first port */
178 struct pnp_irq *irq; /* first IRQ */
179 struct pnp_dma *dma; /* first DMA */
180 struct pnp_mem *mem; /* first memory resource */
181 struct pnp_option *next; /* used to chain dependent resources */
189 struct device dev; /* Driver Model device interface */
190 unsigned char number; /* used as an index, must be unique */
191 struct list_head global_list; /* node in global list of cards */
192 struct list_head protocol_list; /* node in protocol's list of cards */
193 struct list_head devices; /* devices attached to the card */
195 struct pnp_protocol *protocol;
196 struct pnp_id *id; /* contains supported EISA IDs */
198 char name[PNP_NAME_LEN]; /* contains a human-readable name */
199 unsigned char pnpver; /* Plug & Play version */
200 unsigned char productver; /* product version */
201 unsigned int serial; /* serial number */
202 unsigned char checksum; /* if zero - checksum passed */
203 struct proc_dir_entry *procdir; /* directory entry in /proc/bus/isapnp */
206 #define global_to_pnp_card(n) list_entry(n, struct pnp_card, global_list)
207 #define protocol_to_pnp_card(n) list_entry(n, struct pnp_card, protocol_list)
208 #define to_pnp_card(n) container_of(n, struct pnp_card, dev)
209 #define pnp_for_each_card(card) \
210 for((card) = global_to_pnp_card(pnp_cards.next); \
211 (card) != global_to_pnp_card(&pnp_cards); \
212 (card) = global_to_pnp_card((card)->global_list.next))
214 struct pnp_card_link {
215 struct pnp_card *card;
216 struct pnp_card_driver *driver;
218 pm_message_t pm_state;
221 static inline void *pnp_get_card_drvdata(struct pnp_card_link *pcard)
223 return pcard->driver_data;
226 static inline void pnp_set_card_drvdata(struct pnp_card_link *pcard, void *data)
228 pcard->driver_data = data;
232 struct device dev; /* Driver Model device interface */
234 unsigned int number; /* used as an index, must be unique */
237 struct list_head global_list; /* node in global list of devices */
238 struct list_head protocol_list; /* node in list of device's protocol */
239 struct list_head card_list; /* node in card's list of devices */
240 struct list_head rdev_list; /* node in cards list of requested devices */
242 struct pnp_protocol *protocol;
243 struct pnp_card *card; /* card the device is attached to, none if NULL */
244 struct pnp_driver *driver;
245 struct pnp_card_link *card_link;
247 struct pnp_id *id; /* supported EISA IDs */
251 struct pnp_option *independent;
252 struct pnp_option *dependent;
253 struct pnp_resource_table *res;
255 char name[PNP_NAME_LEN]; /* contains a human-readable name */
256 int flags; /* used by protocols */
257 struct proc_dir_entry *procent; /* device entry in /proc/bus/isapnp */
261 #define global_to_pnp_dev(n) list_entry(n, struct pnp_dev, global_list)
262 #define card_to_pnp_dev(n) list_entry(n, struct pnp_dev, card_list)
263 #define protocol_to_pnp_dev(n) list_entry(n, struct pnp_dev, protocol_list)
264 #define to_pnp_dev(n) container_of(n, struct pnp_dev, dev)
265 #define pnp_for_each_dev(dev) \
266 for((dev) = global_to_pnp_dev(pnp_global.next); \
267 (dev) != global_to_pnp_dev(&pnp_global); \
268 (dev) = global_to_pnp_dev((dev)->global_list.next))
269 #define card_for_each_dev(card,dev) \
270 for((dev) = card_to_pnp_dev((card)->devices.next); \
271 (dev) != card_to_pnp_dev(&(card)->devices); \
272 (dev) = card_to_pnp_dev((dev)->card_list.next))
273 #define pnp_dev_name(dev) (dev)->name
275 static inline void *pnp_get_drvdata(struct pnp_dev *pdev)
277 return dev_get_drvdata(&pdev->dev);
280 static inline void pnp_set_drvdata(struct pnp_dev *pdev, void *data)
282 dev_set_drvdata(&pdev->dev, data);
287 void (*quirk_function) (struct pnp_dev * dev); /* fixup function */
290 /* config parameters */
291 #define PNP_CONFIG_NORMAL 0x0001
292 #define PNP_CONFIG_FORCE 0x0002 /* disables validity checking */
295 #define PNP_READ 0x0001
296 #define PNP_WRITE 0x0002
297 #define PNP_DISABLE 0x0004
298 #define PNP_CONFIGURABLE 0x0008
299 #define PNP_REMOVABLE 0x0010
301 #define pnp_can_read(dev) (((dev)->protocol->get) && \
302 ((dev)->capabilities & PNP_READ))
303 #define pnp_can_write(dev) (((dev)->protocol->set) && \
304 ((dev)->capabilities & PNP_WRITE))
305 #define pnp_can_disable(dev) (((dev)->protocol->disable) && \
306 ((dev)->capabilities & PNP_DISABLE))
307 #define pnp_can_configure(dev) ((!(dev)->active) && \
308 ((dev)->capabilities & PNP_CONFIGURABLE))
311 extern struct pnp_protocol isapnp_protocol;
312 #define pnp_device_is_isapnp(dev) ((dev)->protocol == (&isapnp_protocol))
314 #define pnp_device_is_isapnp(dev) 0
316 extern struct mutex pnp_res_mutex;
318 #ifdef CONFIG_PNPBIOS
319 extern struct pnp_protocol pnpbios_protocol;
320 #define pnp_device_is_pnpbios(dev) ((dev)->protocol == (&pnpbios_protocol))
322 #define pnp_device_is_pnpbios(dev) 0
326 #define PNP_READY 0x0000
327 #define PNP_ATTACHED 0x0001
328 #define PNP_BUSY 0x0002
329 #define PNP_FAULTY 0x0004
331 /* isapnp specific macros */
333 #define isapnp_card_number(dev) ((dev)->card ? (dev)->card->number : -1)
334 #define isapnp_csn_number(dev) ((dev)->number)
347 const struct pnp_device_id *id_table;
349 int (*probe) (struct pnp_dev *dev, const struct pnp_device_id *dev_id);
350 void (*remove) (struct pnp_dev *dev);
351 int (*suspend) (struct pnp_dev *dev, pm_message_t state);
352 int (*resume) (struct pnp_dev *dev);
353 struct device_driver driver;
356 #define to_pnp_driver(drv) container_of(drv, struct pnp_driver, driver)
358 struct pnp_card_driver {
359 struct list_head global_list;
361 const struct pnp_card_device_id *id_table;
363 int (*probe) (struct pnp_card_link *card,
364 const struct pnp_card_device_id *card_id);
365 void (*remove) (struct pnp_card_link *card);
366 int (*suspend) (struct pnp_card_link *card, pm_message_t state);
367 int (*resume) (struct pnp_card_link *card);
368 struct pnp_driver link;
371 #define to_pnp_card_driver(drv) container_of(drv, struct pnp_card_driver, link)
373 /* pnp driver flags */
374 #define PNP_DRIVER_RES_DO_NOT_CHANGE 0x0001 /* do not change the state of the device */
375 #define PNP_DRIVER_RES_DISABLE 0x0003 /* ensure the device is disabled */
378 * Protocol Management
381 struct pnp_protocol {
382 struct list_head protocol_list;
385 /* resource control functions */
386 int (*get) (struct pnp_dev *dev);
387 int (*set) (struct pnp_dev *dev);
388 int (*disable) (struct pnp_dev *dev);
390 /* protocol specific suspend/resume */
391 int (*suspend) (struct pnp_dev * dev, pm_message_t state);
392 int (*resume) (struct pnp_dev * dev);
394 /* used by pnp layer only (look but don't touch) */
395 unsigned char number; /* protocol number */
396 struct device dev; /* link to driver model */
397 struct list_head cards;
398 struct list_head devices;
401 #define to_pnp_protocol(n) list_entry(n, struct pnp_protocol, protocol_list)
402 #define protocol_for_each_card(protocol,card) \
403 for((card) = protocol_to_pnp_card((protocol)->cards.next); \
404 (card) != protocol_to_pnp_card(&(protocol)->cards); \
405 (card) = protocol_to_pnp_card((card)->protocol_list.next))
406 #define protocol_for_each_dev(protocol,dev) \
407 for((dev) = protocol_to_pnp_dev((protocol)->devices.next); \
408 (dev) != protocol_to_pnp_dev(&(protocol)->devices); \
409 (dev) = protocol_to_pnp_dev((dev)->protocol_list.next))
411 extern struct bus_type pnp_bus_type;
413 #if defined(CONFIG_PNP)
415 /* device management */
416 int pnp_device_attach(struct pnp_dev *pnp_dev);
417 void pnp_device_detach(struct pnp_dev *pnp_dev);
418 extern struct list_head pnp_global;
419 extern int pnp_platform_devices;
421 /* multidevice card support */
422 struct pnp_dev *pnp_request_card_device(struct pnp_card_link *clink,
423 const char *id, struct pnp_dev *from);
424 void pnp_release_card_device(struct pnp_dev *dev);
425 int pnp_register_card_driver(struct pnp_card_driver *drv);
426 void pnp_unregister_card_driver(struct pnp_card_driver *drv);
427 extern struct list_head pnp_cards;
429 /* resource management */
430 int pnp_auto_config_dev(struct pnp_dev *dev);
431 int pnp_start_dev(struct pnp_dev *dev);
432 int pnp_stop_dev(struct pnp_dev *dev);
433 int pnp_activate_dev(struct pnp_dev *dev);
434 int pnp_disable_dev(struct pnp_dev *dev);
436 /* protocol helpers */
437 int pnp_is_active(struct pnp_dev *dev);
438 int compare_pnp_id(struct pnp_id *pos, const char *id);
439 int pnp_register_driver(struct pnp_driver *drv);
440 void pnp_unregister_driver(struct pnp_driver *drv);
444 /* device management */
445 static inline int pnp_device_attach(struct pnp_dev *pnp_dev) { return -ENODEV; }
446 static inline void pnp_device_detach(struct pnp_dev *pnp_dev) { }
448 #define pnp_platform_devices 0
450 /* multidevice card support */
451 static inline struct pnp_dev *pnp_request_card_device(struct pnp_card_link *clink, const char *id, struct pnp_dev *from) { return NULL; }
452 static inline void pnp_release_card_device(struct pnp_dev *dev) { }
453 static inline int pnp_register_card_driver(struct pnp_card_driver *drv) { return -ENODEV; }
454 static inline void pnp_unregister_card_driver(struct pnp_card_driver *drv) { }
456 /* resource management */
457 static inline int pnp_auto_config_dev(struct pnp_dev *dev) { return -ENODEV; }
458 static inline int pnp_start_dev(struct pnp_dev *dev) { return -ENODEV; }
459 static inline int pnp_stop_dev(struct pnp_dev *dev) { return -ENODEV; }
460 static inline int pnp_activate_dev(struct pnp_dev *dev) { return -ENODEV; }
461 static inline int pnp_disable_dev(struct pnp_dev *dev) { return -ENODEV; }
463 /* protocol helpers */
464 static inline int pnp_is_active(struct pnp_dev *dev) { return 0; }
465 static inline int compare_pnp_id(struct pnp_id *pos, const char *id) { return -ENODEV; }
466 static inline int pnp_register_driver(struct pnp_driver *drv) { return -ENODEV; }
467 static inline void pnp_unregister_driver(struct pnp_driver *drv) { }
469 #endif /* CONFIG_PNP */
471 #define pnp_err(format, arg...) printk(KERN_ERR "pnp: " format "\n" , ## arg)
472 #define pnp_info(format, arg...) printk(KERN_INFO "pnp: " format "\n" , ## arg)
473 #define pnp_warn(format, arg...) printk(KERN_WARNING "pnp: " format "\n" , ## arg)
475 #ifdef CONFIG_PNP_DEBUG
476 #define pnp_dbg(format, arg...) printk(KERN_DEBUG "pnp: " format "\n" , ## arg)
478 #define pnp_dbg(format, arg...) do {} while (0)
481 #endif /* __KERNEL__ */
483 #endif /* _LINUX_PNP_H */