xref: /netbsd/sys/dev/ppbus/ppbus_conf.h (revision 6550d01e)
1 /* $NetBSD: ppbus_conf.h,v 1.11 2008/04/29 14:07:37 cegger Exp $ */
2 
3 /*-
4  * Copyright (c) 1997, 1998, 1999 Nicolas Souchu
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD: src/sys/dev/ppbus/ppbconf.h,v 1.17.2.1 2000/05/24 00:20:57 n_hibma Exp $
29  *
30  */
31 #ifndef __PPBUS_CONF_H
32 #define __PPBUS_CONF_H
33 
34 #include "gpio.h"
35 
36 #include <sys/device.h>
37 #include <sys/mutex.h>
38 #include <sys/queue.h>
39 
40 #include <sys/bus.h>
41 
42 #include <dev/ppbus/ppbus_msq.h>
43 #include <dev/ppbus/ppbus_device.h>
44 
45 #if NGPIO > 0
46 #include <dev/gpio/gpiovar.h>
47 #define PPBUS_NPINS 17
48 #endif
49 
50 /* Function pointer types used for interface */
51 typedef u_char (*PARPORT_IO_T)(device_t, int, u_char *, int, u_char);
52 typedef int (*PARPORT_EXEC_MICROSEQ_T)(device_t,
53 	struct ppbus_microseq **);
54 typedef void (*PARPORT_RESET_EPP_TIMEOUT_T)(device_t);
55 typedef int (*PARPORT_SETMODE_T)(device_t, int);
56 typedef int (*PARPORT_GETMODE_T)(device_t);
57 typedef void (*PARPORT_ECP_SYNC_T)(device_t);
58 typedef int (*PARPORT_READ_T)(device_t, char *, int, int, size_t *);
59 typedef int (*PARPORT_WRITE_T)(device_t, char *, int, int, size_t *);
60 typedef int (*PARPORT_READ_IVAR_T)(device_t, int, unsigned int *);
61 typedef int (*PARPORT_WRITE_IVAR_T)(device_t, int, unsigned int *);
62 typedef int (*PARPORT_DMA_MALLOC_T)(device_t, void **, bus_addr_t *,
63 	bus_size_t);
64 typedef void (*PARPORT_DMA_FREE_T)(device_t, void **, bus_addr_t *,
65 	bus_size_t);
66 typedef int (*PARPORT_ADD_HANDLER_T)(device_t, void (*)(void *),
67 	void *);
68 typedef int (*PARPORT_REMOVE_HANDLER_T)(device_t, void (*)(void *));
69 
70 /* Adapter structure that each parport device needs to implement ppbus */
71 struct parport_adapter {
72 	u_int16_t capabilities;
73 
74 	/* Functions which make up interface */
75 	PARPORT_IO_T parport_io;
76 	PARPORT_EXEC_MICROSEQ_T parport_exec_microseq;
77 	PARPORT_RESET_EPP_TIMEOUT_T parport_reset_epp_timeout;
78 	PARPORT_SETMODE_T parport_setmode;
79 	PARPORT_GETMODE_T parport_getmode;
80 	PARPORT_ECP_SYNC_T parport_ecp_sync;
81 	PARPORT_READ_T parport_read;
82 	PARPORT_WRITE_T parport_write;
83 	PARPORT_READ_IVAR_T parport_read_ivar;
84 	PARPORT_WRITE_IVAR_T parport_write_ivar;
85 	PARPORT_DMA_MALLOC_T parport_dma_malloc;
86 	PARPORT_DMA_FREE_T parport_dma_free;
87 	PARPORT_ADD_HANDLER_T parport_add_handler;
88 	PARPORT_REMOVE_HANDLER_T parport_remove_handler;
89 };
90 
91 /* Parallel Port Bus configuration structure. */
92 struct ppbus_softc {
93         device_t sc_dev;
94 
95 	/* Lock for critical section when requesting/releasing the bus */
96 	kmutex_t sc_lock;
97 
98 #define PPBUS_OK 1
99 #define PPBUS_NOK 0
100 	u_int8_t sc_dev_ok;
101 
102 	/* ppbus capabilities (see ppbus_var.h) */
103 	u_int16_t sc_capabilities;
104 
105 /* PnP device type defined in ppbus_var.h */
106 	int sc_class_id;		/* not a PnP device if class_id < 0 */
107 
108 	/* Defined in pbus_1284.h: error and host side state. */
109 	u_int32_t sc_1284_state;	/* current IEEE1284 state */
110 	u_int32_t sc_1284_error;	/* last IEEE1284 error */
111 
112 	/* Use IEEE 1284 negotiations in mode changes and direction changes */
113 	u_int32_t sc_use_ieee;
114 
115 /* PPBUS mode masks defined in ppbus_var.h. */
116 	u_int32_t sc_mode;		/* IEEE 1284-1994 mode */
117 
118 	/* ppbus_device which owns the bus */
119 	device_t ppbus_owner;
120 
121 	/* Head of list of child devices */
122 	SLIST_HEAD(childlist, ppbus_device_softc) sc_childlist_head;
123 
124 	/* Functions which make up interface */
125 	PARPORT_IO_T ppbus_io;
126 	PARPORT_EXEC_MICROSEQ_T ppbus_exec_microseq;
127 	PARPORT_RESET_EPP_TIMEOUT_T ppbus_reset_epp_timeout;
128 	PARPORT_SETMODE_T ppbus_setmode;
129 	PARPORT_GETMODE_T ppbus_getmode;
130 	PARPORT_ECP_SYNC_T ppbus_ecp_sync;
131 	PARPORT_READ_T ppbus_read;
132 	PARPORT_WRITE_T ppbus_write;
133         PARPORT_READ_IVAR_T ppbus_read_ivar;
134         PARPORT_WRITE_IVAR_T ppbus_write_ivar;
135 	PARPORT_DMA_MALLOC_T ppbus_dma_malloc;
136 	PARPORT_DMA_FREE_T ppbus_dma_free;
137 	PARPORT_ADD_HANDLER_T ppbus_add_handler;
138 	PARPORT_REMOVE_HANDLER_T ppbus_remove_handler;
139 
140 #if NGPIO > 0
141 	struct gpio_chipset_tag sc_gpio_gc;
142 	gpio_pin_t sc_gpio_pins[PPBUS_NPINS];
143 #endif
144 };
145 
146 #if NGPIO > 0
147 void gpio_ppbus_attach(struct ppbus_softc *);
148 #endif
149 
150 #endif /* __PPBUS_CONF_H */
151