1 /*
2 * Any part of this program may be used in documents licensed under
3 * the GNU Free Documentation License, Version 1.1 or any later version
4 * published by the Free Software Foundation.
5 */
6 #ifndef _PARPORT_H_
7 #define _PARPORT_H_
8
9
10 #include <linux/jiffies.h>
11 #include <linux/proc_fs.h>
12 #include <linux/spinlock.h>
13 #include <linux/wait.h>
14 #include <linux/irqreturn.h>
15 #include <linux/semaphore.h>
16 #include <linux/device.h>
17 #include <asm/ptrace.h>
18 #include <uapi/linux/parport.h>
19
20 /* Define this later. */
21 struct parport;
22 struct pardevice;
23
24 struct pc_parport_state {
25 unsigned int ctr;
26 unsigned int ecr;
27 };
28
29 struct ax_parport_state {
30 unsigned int ctr;
31 unsigned int ecr;
32 unsigned int dcsr;
33 };
34
35 /* used by both parport_amiga and parport_mfc3 */
36 struct amiga_parport_state {
37 unsigned char data; /* ciaa.prb */
38 unsigned char datadir; /* ciaa.ddrb */
39 unsigned char status; /* ciab.pra & 7 */
40 unsigned char statusdir;/* ciab.ddrb & 7 */
41 };
42
43 struct ax88796_parport_state {
44 unsigned char cpr;
45 };
46
47 struct ip32_parport_state {
48 unsigned int dcr;
49 unsigned int ecr;
50 };
51
52 struct parport_state {
53 union {
54 struct pc_parport_state pc;
55 /* ARC has no state. */
56 struct ax_parport_state ax;
57 struct amiga_parport_state amiga;
58 struct ax88796_parport_state ax88796;
59 /* Atari has not state. */
60 struct ip32_parport_state ip32;
61 void *misc;
62 } u;
63 };
64
65 struct parport_operations {
66 /* IBM PC-style virtual registers. */
67 void (*write_data)(struct parport *, unsigned char);
68 unsigned char (*read_data)(struct parport *);
69
70 void (*write_control)(struct parport *, unsigned char);
71 unsigned char (*read_control)(struct parport *);
72 unsigned char (*frob_control)(struct parport *, unsigned char mask,
73 unsigned char val);
74
75 unsigned char (*read_status)(struct parport *);
76
77 /* IRQs. */
78 void (*enable_irq)(struct parport *);
79 void (*disable_irq)(struct parport *);
80
81 /* Data direction. */
82 void (*data_forward) (struct parport *);
83 void (*data_reverse) (struct parport *);
84
85 /* For core parport code. */
86 void (*init_state)(struct pardevice *, struct parport_state *);
87 void (*save_state)(struct parport *, struct parport_state *);
88 void (*restore_state)(struct parport *, struct parport_state *);
89
90 /* Block read/write */
91 size_t (*epp_write_data) (struct parport *port, const void *buf,
92 size_t len, int flags);
93 size_t (*epp_read_data) (struct parport *port, void *buf, size_t len,
94 int flags);
95 size_t (*epp_write_addr) (struct parport *port, const void *buf,
96 size_t len, int flags);
97 size_t (*epp_read_addr) (struct parport *port, void *buf, size_t len,
98 int flags);
99
100 size_t (*ecp_write_data) (struct parport *port, const void *buf,
101 size_t len, int flags);
102 size_t (*ecp_read_data) (struct parport *port, void *buf, size_t len,
103 int flags);
104 size_t (*ecp_write_addr) (struct parport *port, const void *buf,
105 size_t len, int flags);
106
107 size_t (*compat_write_data) (struct parport *port, const void *buf,
108 size_t len, int flags);
109 size_t (*nibble_read_data) (struct parport *port, void *buf,
110 size_t len, int flags);
111 size_t (*byte_read_data) (struct parport *port, void *buf,
112 size_t len, int flags);
113 struct module *owner;
114 };
115
116 struct parport_device_info {
117 parport_device_class class;
118 const char *class_name;
119 const char *mfr;
120 const char *model;
121 const char *cmdset;
122 const char *description;
123 };
124
125 /* Each device can have two callback functions:
126 * 1) a preemption function, called by the resource manager to request
127 * that the driver relinquish control of the port. The driver should
128 * return zero if it agrees to release the port, and nonzero if it
129 * refuses. Do not call parport_release() - the kernel will do this
130 * implicitly.
131 *
132 * 2) a wake-up function, called by the resource manager to tell drivers
133 * that the port is available to be claimed. If a driver wants to use
134 * the port, it should call parport_claim() here.
135 */
136
137 /* A parallel port device */
138 struct pardevice {
139 const char *name;
140 struct parport *port;
141 int daisy;
142 int (*preempt)(void *);
143 void (*wakeup)(void *);
144 void *private;
145 void (*irq_func)(void *);
146 unsigned int flags;
147 struct pardevice *next;
148 struct pardevice *prev;
149 struct device dev;
150 bool devmodel;
151 struct parport_state *state; /* saved status over preemption */
152 wait_queue_head_t wait_q;
153 unsigned long int time;
154 unsigned long int timeslice;
155 volatile long int timeout;
156 unsigned long waiting; /* long req'd for set_bit --RR */
157 struct pardevice *waitprev;
158 struct pardevice *waitnext;
159 void * sysctl_table;
160 };
161
162 #define to_pardevice(n) container_of(n, struct pardevice, dev)
163
164 /* IEEE1284 information */
165
166 /* IEEE1284 phases. These are exposed to userland through ppdev IOCTL
167 * PP[GS]ETPHASE, so do not change existing values. */
168 enum ieee1284_phase {
169 IEEE1284_PH_FWD_DATA,
170 IEEE1284_PH_FWD_IDLE,
171 IEEE1284_PH_TERMINATE,
172 IEEE1284_PH_NEGOTIATION,
173 IEEE1284_PH_HBUSY_DNA,
174 IEEE1284_PH_REV_IDLE,
175 IEEE1284_PH_HBUSY_DAVAIL,
176 IEEE1284_PH_REV_DATA,
177 IEEE1284_PH_ECP_SETUP,
178 IEEE1284_PH_ECP_FWD_TO_REV,
179 IEEE1284_PH_ECP_REV_TO_FWD,
180 IEEE1284_PH_ECP_DIR_UNKNOWN,
181 };
182 struct ieee1284_info {
183 int mode;
184 volatile enum ieee1284_phase phase;
185 struct semaphore irq;
186 };
187
188 /* A parallel port */
189 struct parport {
190 unsigned long base; /* base address */
191 unsigned long base_hi; /* base address (hi - ECR) */
192 unsigned int size; /* IO extent */
193 const char *name;
194 unsigned int modes;
195 int irq; /* interrupt (or -1 for none) */
196 int dma;
197 int muxport; /* which muxport (if any) this is */
198 int portnum; /* which physical parallel port (not mux) */
199 struct device *dev; /* Physical device associated with IO/DMA.
200 * This may unfortulately be null if the
201 * port has a legacy driver.
202 */
203 struct device bus_dev; /* to link with the bus */
204 struct parport *physport;
205 /* If this is a non-default mux
206 parport, i.e. we're a clone of a real
207 physical port, this is a pointer to that
208 port. The locking is only done in the
209 real port. For a clone port, the
210 following structure members are
211 meaningless: devices, cad, muxsel,
212 waithead, waittail, flags, pdir,
213 dev, ieee1284, *_lock.
214
215 It this is a default mux parport, or
216 there is no mux involved, this points to
217 ourself. */
218
219 struct pardevice *devices;
220 struct pardevice *cad; /* port owner */
221 int daisy; /* currently selected daisy addr */
222 int muxsel; /* currently selected mux port */
223
224 struct pardevice *waithead;
225 struct pardevice *waittail;
226
227 struct list_head list;
228 unsigned int flags;
229
230 void *sysctl_table;
231 struct parport_device_info probe_info[5]; /* 0-3 + non-IEEE1284.3 */
232 struct ieee1284_info ieee1284;
233
234 struct parport_operations *ops;
235 void *private_data; /* for lowlevel driver */
236
237 int number; /* port index - the `n' in `parportn' */
238 spinlock_t pardevice_lock;
239 spinlock_t waitlist_lock;
240 rwlock_t cad_lock;
241
242 int spintime;
243 atomic_t ref_count;
244
245 unsigned long devflags;
246 #define PARPORT_DEVPROC_REGISTERED 0
247 struct pardevice *proc_device; /* Currently register proc device */
248
249 struct list_head full_list;
250 struct parport *slaves[3];
251 };
252
253 #define to_parport_dev(n) container_of(n, struct parport, bus_dev)
254
255 #define DEFAULT_SPIN_TIME 500 /* us */
256
257 struct parport_driver {
258 const char *name;
259 void (*attach) (struct parport *);
260 void (*detach) (struct parport *);
261 void (*match_port)(struct parport *);
262 int (*probe)(struct pardevice *);
263 struct device_driver driver;
264 bool devmodel;
265 struct list_head list;
266 };
267
268 #define to_parport_driver(n) container_of(n, struct parport_driver, driver)
269
270 int parport_bus_init(void);
271 void parport_bus_exit(void);
272
273 /* parport_register_port registers a new parallel port at the given
274 address (if one does not already exist) and returns a pointer to it.
275 This entails claiming the I/O region, IRQ and DMA. NULL is returned
276 if initialisation fails. */
277 struct parport *parport_register_port(unsigned long base, int irq, int dma,
278 struct parport_operations *ops);
279
280 /* Once a registered port is ready for high-level drivers to use, the
281 low-level driver that registered it should announce it. This will
282 call the high-level drivers' attach() functions (after things like
283 determining the IEEE 1284.3 topology of the port and collecting
284 DeviceIDs). */
285 void parport_announce_port (struct parport *port);
286
287 /* Unregister a port. */
288 extern void parport_remove_port(struct parport *port);
289
290 /* Register a new high-level driver. */
291
292 int __must_check __parport_register_driver(struct parport_driver *,
293 struct module *,
294 const char *mod_name);
295 /*
296 * parport_register_driver must be a macro so that KBUILD_MODNAME can
297 * be expanded
298 */
299 #define parport_register_driver(driver) \
300 __parport_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
301
302 /* Unregister a high-level driver. */
303 extern void parport_unregister_driver (struct parport_driver *);
304 void parport_unregister_driver(struct parport_driver *);
305
306 /* If parport_register_driver doesn't fit your needs, perhaps
307 * parport_find_xxx does. */
308 extern struct parport *parport_find_number (int);
309 extern struct parport *parport_find_base (unsigned long);
310
311 /* generic irq handler, if it suits your needs */
312 extern irqreturn_t parport_irq_handler(int irq, void *dev_id);
313
314 /* Reference counting for ports. */
315 extern struct parport *parport_get_port (struct parport *);
316 extern void parport_put_port (struct parport *);
317 void parport_del_port(struct parport *);
318
319 struct pardev_cb {
320 int (*preempt)(void *);
321 void (*wakeup)(void *);
322 void *private;
323 void (*irq_func)(void *);
324 unsigned int flags;
325 };
326
327 /* parport_register_device declares that a device is connected to a
328 port, and tells the kernel all it needs to know.
329 - pf is the preemption function (may be NULL for no callback)
330 - kf is the wake-up function (may be NULL for no callback)
331 - irq_func is the interrupt handler (may be NULL for no interrupts)
332 - handle is a user pointer that gets handed to callback functions. */
333 struct pardevice *parport_register_device(struct parport *port,
334 const char *name,
335 int (*pf)(void *), void (*kf)(void *),
336 void (*irq_func)(void *),
337 int flags, void *handle);
338
339 struct pardevice *
340 parport_register_dev_model(struct parport *port, const char *name,
341 const struct pardev_cb *par_dev_cb, int cnt);
342
343 /* parport_unregister unlinks a device from the chain. */
344 extern void parport_unregister_device(struct pardevice *dev);
345
346 /* parport_claim tries to gain ownership of the port for a particular
347 driver. This may fail (return non-zero) if another driver is busy.
348 If this driver has registered an interrupt handler, it will be
349 enabled. */
350 extern int parport_claim(struct pardevice *dev);
351
352 /* parport_claim_or_block is the same, but sleeps if the port cannot
353 be claimed. Return value is 1 if it slept, 0 normally and -errno
354 on error. */
355 extern int parport_claim_or_block(struct pardevice *dev);
356
357 /* parport_release reverses a previous parport_claim. This can never
358 fail, though the effects are undefined (except that they are bad)
359 if you didn't previously own the port. Once you have released the
360 port you should make sure that neither your code nor the hardware
361 on the port tries to initiate any communication without first
362 re-claiming the port. If you mess with the port state (enabling
363 ECP for example) you should clean up before releasing the port. */
364
365 extern void parport_release(struct pardevice *dev);
366
367 /**
368 * parport_yield - relinquish a parallel port temporarily
369 * @dev: a device on the parallel port
370 *
371 * This function relinquishes the port if it would be helpful to other
372 * drivers to do so. Afterwards it tries to reclaim the port using
373 * parport_claim(), and the return value is the same as for
374 * parport_claim(). If it fails, the port is left unclaimed and it is
375 * the driver's responsibility to reclaim the port.
376 *
377 * The parport_yield() and parport_yield_blocking() functions are for
378 * marking points in the driver at which other drivers may claim the
379 * port and use their devices. Yielding the port is similar to
380 * releasing it and reclaiming it, but is more efficient because no
381 * action is taken if there are no other devices needing the port. In
382 * fact, nothing is done even if there are other devices waiting but
383 * the current device is still within its "timeslice". The default
384 * timeslice is half a second, but it can be adjusted via the /proc
385 * interface.
386 **/
parport_yield(struct pardevice * dev)387 static __inline__ int parport_yield(struct pardevice *dev)
388 {
389 unsigned long int timeslip = (jiffies - dev->time);
390 if ((dev->port->waithead == NULL) || (timeslip < dev->timeslice))
391 return 0;
392 parport_release(dev);
393 return parport_claim(dev);
394 }
395
396 /**
397 * parport_yield_blocking - relinquish a parallel port temporarily
398 * @dev: a device on the parallel port
399 *
400 * This function relinquishes the port if it would be helpful to other
401 * drivers to do so. Afterwards it tries to reclaim the port using
402 * parport_claim_or_block(), and the return value is the same as for
403 * parport_claim_or_block().
404 **/
parport_yield_blocking(struct pardevice * dev)405 static __inline__ int parport_yield_blocking(struct pardevice *dev)
406 {
407 unsigned long int timeslip = (jiffies - dev->time);
408 if ((dev->port->waithead == NULL) || (timeslip < dev->timeslice))
409 return 0;
410 parport_release(dev);
411 return parport_claim_or_block(dev);
412 }
413
414 /* Flags used to identify what a device does. */
415 #define PARPORT_DEV_TRAN 0 /* WARNING !! DEPRECATED !! */
416 #define PARPORT_DEV_LURK (1<<0) /* WARNING !! DEPRECATED !! */
417 #define PARPORT_DEV_EXCL (1<<1) /* Need exclusive access. */
418
419 #define PARPORT_FLAG_EXCL (1<<1) /* EXCL driver registered. */
420
421 /* IEEE1284 functions */
422 extern void parport_ieee1284_interrupt (void *);
423 extern int parport_negotiate (struct parport *, int mode);
424 extern ssize_t parport_write (struct parport *, const void *buf, size_t len);
425 extern ssize_t parport_read (struct parport *, void *buf, size_t len);
426
427 #define PARPORT_INACTIVITY_O_NONBLOCK 1
428 extern long parport_set_timeout (struct pardevice *, long inactivity);
429
430 extern int parport_wait_event (struct parport *, long timeout);
431 extern int parport_wait_peripheral (struct parport *port,
432 unsigned char mask,
433 unsigned char val);
434 extern int parport_poll_peripheral (struct parport *port,
435 unsigned char mask,
436 unsigned char val,
437 int usec);
438
439 /* For architectural drivers */
440 extern size_t parport_ieee1284_write_compat (struct parport *,
441 const void *, size_t, int);
442 extern size_t parport_ieee1284_read_nibble (struct parport *,
443 void *, size_t, int);
444 extern size_t parport_ieee1284_read_byte (struct parport *,
445 void *, size_t, int);
446 extern size_t parport_ieee1284_ecp_read_data (struct parport *,
447 void *, size_t, int);
448 extern size_t parport_ieee1284_ecp_write_data (struct parport *,
449 const void *, size_t, int);
450 extern size_t parport_ieee1284_ecp_write_addr (struct parport *,
451 const void *, size_t, int);
452 extern size_t parport_ieee1284_epp_write_data (struct parport *,
453 const void *, size_t, int);
454 extern size_t parport_ieee1284_epp_read_data (struct parport *,
455 void *, size_t, int);
456 extern size_t parport_ieee1284_epp_write_addr (struct parport *,
457 const void *, size_t, int);
458 extern size_t parport_ieee1284_epp_read_addr (struct parport *,
459 void *, size_t, int);
460
461 /* IEEE1284.3 functions */
462 extern int parport_daisy_init (struct parport *port);
463 extern void parport_daisy_fini (struct parport *port);
464 extern struct pardevice *parport_open (int devnum, const char *name);
465 extern void parport_close (struct pardevice *dev);
466 extern ssize_t parport_device_id (int devnum, char *buffer, size_t len);
467 extern void parport_daisy_deselect_all (struct parport *port);
468 extern int parport_daisy_select (struct parport *port, int daisy, int mode);
469
470 /* Lowlevel drivers _can_ call this support function to handle irqs. */
parport_generic_irq(struct parport * port)471 static inline void parport_generic_irq(struct parport *port)
472 {
473 parport_ieee1284_interrupt (port);
474 read_lock(&port->cad_lock);
475 if (port->cad && port->cad->irq_func)
476 port->cad->irq_func(port->cad->private);
477 read_unlock(&port->cad_lock);
478 }
479
480 /* Prototypes from parport_procfs */
481 extern int parport_proc_register(struct parport *pp);
482 extern int parport_proc_unregister(struct parport *pp);
483 extern int parport_device_proc_register(struct pardevice *device);
484 extern int parport_device_proc_unregister(struct pardevice *device);
485
486 /* If PC hardware is the only type supported, we can optimise a bit. */
487 #if !defined(CONFIG_PARPORT_NOT_PC)
488
489 #include <linux/parport_pc.h>
490 #define parport_write_data(p,x) parport_pc_write_data(p,x)
491 #define parport_read_data(p) parport_pc_read_data(p)
492 #define parport_write_control(p,x) parport_pc_write_control(p,x)
493 #define parport_read_control(p) parport_pc_read_control(p)
494 #define parport_frob_control(p,m,v) parport_pc_frob_control(p,m,v)
495 #define parport_read_status(p) parport_pc_read_status(p)
496 #define parport_enable_irq(p) parport_pc_enable_irq(p)
497 #define parport_disable_irq(p) parport_pc_disable_irq(p)
498 #define parport_data_forward(p) parport_pc_data_forward(p)
499 #define parport_data_reverse(p) parport_pc_data_reverse(p)
500
501 #else /* !CONFIG_PARPORT_NOT_PC */
502
503 /* Generic operations vector through the dispatch table. */
504 #define parport_write_data(p,x) (p)->ops->write_data(p,x)
505 #define parport_read_data(p) (p)->ops->read_data(p)
506 #define parport_write_control(p,x) (p)->ops->write_control(p,x)
507 #define parport_read_control(p) (p)->ops->read_control(p)
508 #define parport_frob_control(p,m,v) (p)->ops->frob_control(p,m,v)
509 #define parport_read_status(p) (p)->ops->read_status(p)
510 #define parport_enable_irq(p) (p)->ops->enable_irq(p)
511 #define parport_disable_irq(p) (p)->ops->disable_irq(p)
512 #define parport_data_forward(p) (p)->ops->data_forward(p)
513 #define parport_data_reverse(p) (p)->ops->data_reverse(p)
514
515 #endif /* !CONFIG_PARPORT_NOT_PC */
516
517 extern unsigned long parport_default_timeslice;
518 extern int parport_default_spintime;
519
520 #endif /* _PARPORT_H_ */
521