xref: /freebsd/sys/dev/ppc/ppc_isa.c (revision 1d386b48)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 1997-2000 Nicolas Souchu
5  * Copyright (c) 2001 Alcove - Nicolas Souchu
6  * Copyright (c) 2006 Marcel Moolenaar
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 #include <sys/cdefs.h>
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/lock.h>
36 #include <sys/module.h>
37 #include <sys/mutex.h>
38 #include <sys/bus.h>
39 #include <machine/bus.h>
40 #include <sys/malloc.h>
41 #include <sys/rman.h>
42 
43 #include <isa/isavar.h>
44 
45 #include <dev/ppbus/ppbconf.h>
46 #include <dev/ppbus/ppb_msq.h>
47 #include <dev/ppc/ppcvar.h>
48 #include <dev/ppc/ppcreg.h>
49 
50 #include "ppbus_if.h"
51 
52 static int ppc_isa_probe(device_t dev);
53 
54 int ppc_isa_attach(device_t dev);
55 int ppc_isa_write(device_t, char *, int, int);
56 
57 static device_method_t ppc_isa_methods[] = {
58 	/* device interface */
59 	DEVMETHOD(device_probe,		ppc_isa_probe),
60 	DEVMETHOD(device_attach,	ppc_isa_attach),
61 	DEVMETHOD(device_detach,	ppc_detach),
62 
63 	/* bus interface */
64 	DEVMETHOD(bus_read_ivar,	ppc_read_ivar),
65 	DEVMETHOD(bus_write_ivar,	ppc_write_ivar),
66 	DEVMETHOD(bus_alloc_resource,	ppc_alloc_resource),
67 	DEVMETHOD(bus_release_resource,	ppc_release_resource),
68 
69 	/* ppbus interface */
70 	DEVMETHOD(ppbus_io,		ppc_io),
71 	DEVMETHOD(ppbus_exec_microseq,	ppc_exec_microseq),
72 	DEVMETHOD(ppbus_reset_epp,	ppc_reset_epp),
73 	DEVMETHOD(ppbus_setmode,	ppc_setmode),
74 	DEVMETHOD(ppbus_ecp_sync,	ppc_ecp_sync),
75 	DEVMETHOD(ppbus_read,		ppc_read),
76 	DEVMETHOD(ppbus_write,		ppc_isa_write),
77 	{ 0, 0 }
78 };
79 
80 static driver_t ppc_isa_driver = {
81 	ppc_driver_name,
82 	ppc_isa_methods,
83 	sizeof(struct ppc_data),
84 };
85 
86 static struct isa_pnp_id lpc_ids[] = {
87 	{ 0x0004d041, "Standard parallel printer port" },	/* PNP0400 */
88 	{ 0x0104d041, "ECP parallel printer port" },		/* PNP0401 */
89 	{ 0 }
90 };
91 
92 static void
93 ppc_isa_dmadone(struct ppc_data *ppc)
94 {
95 	isa_dmadone(ppc->ppc_dmaflags, ppc->ppc_dmaddr, ppc->ppc_dmacnt,
96 	    ppc->ppc_dmachan);
97 }
98 
99 int
100 ppc_isa_attach(device_t dev)
101 {
102 	struct ppc_data *ppc = device_get_softc(dev);
103 
104 	if ((ppc->ppc_avm & PPB_ECP) && (ppc->ppc_dmachan > 0)) {
105 		/* acquire the DMA channel forever */   /* XXX */
106 		isa_dma_acquire(ppc->ppc_dmachan);
107 		isa_dmainit(ppc->ppc_dmachan, 1024); /* nlpt.BUFSIZE */
108 		ppc->ppc_dmadone = ppc_isa_dmadone;
109 	}
110 
111 	return (ppc_attach(dev));
112 }
113 
114 static int
115 ppc_isa_probe(device_t dev)
116 {
117 	device_t parent;
118 	int error;
119 
120 	parent = device_get_parent(dev);
121 
122 	error = ISA_PNP_PROBE(parent, dev, lpc_ids);
123 	if (error == ENXIO)
124 		return (ENXIO);
125 	if (error != 0)		/* XXX shall be set after detection */
126 		device_set_desc(dev, "Parallel port");
127 
128 	return (ppc_probe(dev, 0));
129 }
130 
131 /*
132  * Call this function if you want to send data in any advanced mode
133  * of your parallel port: FIFO, DMA
134  *
135  * If what you want is not possible (no ECP, no DMA...),
136  * EINVAL is returned
137  */
138 int
139 ppc_isa_write(device_t dev, char *buf, int len, int how)
140 {
141 	struct ppc_data *ppc = device_get_softc(dev);
142 	char ecr, ecr_sav, ctr, ctr_sav;
143 	int error = 0;
144 	int spin;
145 
146 	PPC_ASSERT_LOCKED(ppc);
147 	if (!(ppc->ppc_avm & PPB_ECP))
148 		return (EINVAL);
149 	if (ppc->ppc_dmachan == 0)
150 		return (EINVAL);
151 
152 #ifdef PPC_DEBUG
153 	printf("w");
154 #endif
155 
156 	ecr_sav = r_ecr(ppc);
157 	ctr_sav = r_ctr(ppc);
158 
159 	/*
160 	 * Send buffer with DMA, FIFO and interrupts
161 	 */
162 
163 	/* byte mode, no intr, no DMA, dir=0, flush fifo */
164 	ecr = PPC_ECR_STD | PPC_DISABLE_INTR;
165 	w_ecr(ppc, ecr);
166 
167 	/* disable nAck interrupts */
168 	ctr = r_ctr(ppc);
169 	ctr &= ~IRQENABLE;
170 	w_ctr(ppc, ctr);
171 
172 	ppc->ppc_dmaflags = 0;
173 	ppc->ppc_dmaddr = (caddr_t)buf;
174 	ppc->ppc_dmacnt = (u_int)len;
175 
176 	switch (ppc->ppc_mode) {
177 	case PPB_COMPATIBLE:
178 		/* compatible mode with FIFO, no intr, DMA, dir=0 */
179 		ecr = PPC_ECR_FIFO | PPC_DISABLE_INTR | PPC_ENABLE_DMA;
180 		break;
181 	case PPB_ECP:
182 		ecr = PPC_ECR_ECP | PPC_DISABLE_INTR | PPC_ENABLE_DMA;
183 		break;
184 	default:
185 		error = EINVAL;
186 		goto error;
187 	}
188 
189 	w_ecr(ppc, ecr);
190 	ecr = r_ecr(ppc);
191 
192 	ppc->ppc_dmastat = PPC_DMA_INIT;
193 
194 	/* enable interrupts */
195 	ecr &= ~PPC_SERVICE_INTR;
196 	ppc->ppc_irqstat = PPC_IRQ_DMA;
197 	w_ecr(ppc, ecr);
198 
199 	isa_dmastart(ppc->ppc_dmaflags, ppc->ppc_dmaddr, ppc->ppc_dmacnt,
200 		     ppc->ppc_dmachan);
201 	ppc->ppc_dmastat = PPC_DMA_STARTED;
202 
203 #ifdef PPC_DEBUG
204 	printf("s%d", ppc->ppc_dmacnt);
205 #endif
206 
207 	/* Wait for the DMA completed interrupt. We hope we won't
208 	 * miss it, otherwise a signal will be necessary to unlock the
209 	 * process.
210 	 */
211 	do {
212 		/* release CPU */
213 		error = mtx_sleep(ppc, &ppc->ppc_lock, PPBPRI | PCATCH,
214 		    "ppcdma", 0);
215 	} while (error == EWOULDBLOCK);
216 
217 	if (error) {
218 #ifdef PPC_DEBUG
219 		printf("i");
220 #endif
221 		/* stop DMA */
222 		isa_dmadone(ppc->ppc_dmaflags, ppc->ppc_dmaddr,
223 			    ppc->ppc_dmacnt, ppc->ppc_dmachan);
224 
225 		/* no dma, no interrupt, flush the fifo */
226 		w_ecr(ppc, PPC_ECR_RESET);
227 
228 		ppc->ppc_dmastat = PPC_DMA_INTERRUPTED;
229 		goto error;
230 	}
231 
232 	/* wait for an empty fifo */
233 	while (!(r_ecr(ppc) & PPC_FIFO_EMPTY)) {
234 		for (spin=100; spin; spin--)
235 			if (r_ecr(ppc) & PPC_FIFO_EMPTY)
236 				goto fifo_empty;
237 #ifdef PPC_DEBUG
238 		printf("Z");
239 #endif
240 		error = mtx_sleep(ppc, &ppc->ppc_lock, PPBPRI | PCATCH,
241 		    "ppcfifo", hz / 100);
242 		if (error != EWOULDBLOCK) {
243 #ifdef PPC_DEBUG
244 			printf("I");
245 #endif
246 			/* no dma, no interrupt, flush the fifo */
247 			w_ecr(ppc, PPC_ECR_RESET);
248 
249 			ppc->ppc_dmastat = PPC_DMA_INTERRUPTED;
250 			error = EINTR;
251 			goto error;
252 		}
253 	}
254 
255 fifo_empty:
256 	/* no dma, no interrupt, flush the fifo */
257 	w_ecr(ppc, PPC_ECR_RESET);
258 
259 error:
260 	/* PDRQ must be kept unasserted until nPDACK is
261 	 * deasserted for a minimum of 350ns (SMC datasheet)
262 	 *
263 	 * Consequence may be a FIFO that never empty
264 	 */
265 	DELAY(1);
266 
267 	w_ecr(ppc, ecr_sav);
268 	w_ctr(ppc, ctr_sav);
269 	return (error);
270 }
271 
272 DRIVER_MODULE(ppc, isa, ppc_isa_driver, 0, 0);
273 ISA_PNP_INFO(lpc_ids);
274