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