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