xref: /linux/drivers/parport/parport_mfc3.c (revision 24168c5e6dfbdd5b414f048f47f75d64533296ca)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /* Low-level parallel port routines for the Multiface 3 card
3  *
4  * Author: Joerg Dorchain <joerg@dorchain.net>
5  *
6  * (C) The elitist m68k Users(TM)
7  *
8  * based on the existing parport_amiga and lp_mfc
9  *
10  *
11  * From the MFC3 documentation:
12  *
13  * Miscellaneous PIA Details
14  * -------------------------
15  *
16  * 	The two open-drain interrupt outputs /IRQA and /IRQB are routed to
17  * /INT2 of the Z2 bus.
18  *
19  * 	The CPU data bus of the PIA (D0-D7) is connected to D8-D15 on the Z2
20  * bus. This means that any PIA registers are accessed at even addresses.
21  *
22  * Centronics Pin Connections for the PIA
23  * --------------------------------------
24  *
25  * 	The following table shows the connections between the PIA and the
26  * Centronics interface connector. These connections implement a single, but
27  * very complete, Centronics type interface. The Pin column gives the pin
28  * numbers of the PIA. The Centronics pin numbers can be found in the section
29  * "Parallel Connectors".
30  *
31  *
32  *    Pin | PIA | Dir | Centronics Names
33  * -------+-----+-----+---------------------------------------------------------
34  *     19 | CB2 | --> | /STROBE (aka /DRDY)
35  *  10-17 | PBx | <-> | DATA0 - DATA7
36  *     18 | CB1 | <-- | /ACK
37  *     40 | CA1 | <-- | BUSY
38  *      3 | PA1 | <-- | PAPER-OUT (aka POUT)
39  *      4 | PA2 | <-- | SELECTED (aka SEL)
40  *      9 | PA7 | --> | /INIT (aka /RESET or /INPUT-PRIME)
41  *      6 | PA4 | <-- | /ERROR (aka /FAULT)
42  *      7 | PA5 | --> | DIR (aka /SELECT-IN)
43  *      8 | PA6 | --> | /AUTO-FEED-XT
44  *     39 | CA2 | --> | open
45  *      5 | PA3 | <-- | /ACK (same as CB1!)
46  *      2 | PA0 | <-- | BUSY (same as CA1!)
47  * -------+-----+-----+---------------------------------------------------------
48  *
49  * Should be enough to understand some of the driver.
50  *
51  * Per convention for normal use the port registers are visible.
52  * If you need the data direction registers, restore the value in the
53  * control register.
54  */
55 
56 #include "multiface.h"
57 #include <linux/module.h>
58 #include <linux/init.h>
59 #include <linux/parport.h>
60 #include <linux/delay.h>
61 #include <linux/mc6821.h>
62 #include <linux/zorro.h>
63 #include <linux/interrupt.h>
64 #include <asm/setup.h>
65 #include <asm/amigahw.h>
66 #include <asm/irq.h>
67 #include <asm/amigaints.h>
68 
69 /* Maximum Number of Cards supported */
70 #define MAX_MFC 5
71 
72 #undef DEBUG
73 
74 static struct parport *this_port[MAX_MFC] = {NULL, };
75 static volatile int dummy; /* for trigger readds */
76 
77 #define pia(dev) ((struct pia *)(dev->base))
78 static struct parport_operations pp_mfc3_ops;
79 
80 static void mfc3_write_data(struct parport *p, unsigned char data)
81 {
82 	pr_debug("write_data %c\n", data);
83 
84 	dummy = pia(p)->pprb; /* clears irq bit */
85 	/* Triggers also /STROBE.*/
86 	pia(p)->pprb = data;
87 }
88 
89 static unsigned char mfc3_read_data(struct parport *p)
90 {
91 	/* clears interrupt bit. Triggers also /STROBE. */
92 	return pia(p)->pprb;
93 }
94 
95 static unsigned char control_pc_to_mfc3(unsigned char control)
96 {
97 	unsigned char ret = 32|64;
98 
99 	if (control & PARPORT_CONTROL_SELECT) /* XXX: What is SELECP? */
100 		ret &= ~32; /* /SELECT_IN */
101 	if (control & PARPORT_CONTROL_INIT) /* INITP */
102 		ret |= 128;
103 	if (control & PARPORT_CONTROL_AUTOFD) /* AUTOLF */
104 		ret &= ~64;
105 	/* PARPORT_CONTROL_STROBE handled directly by hardware */
106 	return ret;
107 }
108 
109 static unsigned char control_mfc3_to_pc(unsigned char control)
110 {
111 	unsigned char ret = PARPORT_CONTROL_STROBE
112 			  | PARPORT_CONTROL_AUTOFD | PARPORT_CONTROL_SELECT;
113 
114 	if (control & 128) /* /INITP */
115 		ret |= PARPORT_CONTROL_INIT;
116 	if (control & 64) /* /AUTOLF */
117 		ret &= ~PARPORT_CONTROL_AUTOFD;
118 	if (control & 32) /* /SELECT_IN */
119 		ret &= ~PARPORT_CONTROL_SELECT;
120 	return ret;
121 }
122 
123 static void mfc3_write_control(struct parport *p, unsigned char control)
124 {
125 	pr_debug("write_control %02x\n", control);
126 	pia(p)->ppra = (pia(p)->ppra & 0x1f) | control_pc_to_mfc3(control);
127 }
128 
129 static unsigned char mfc3_read_control( struct parport *p)
130 {
131 	pr_debug("read_control\n");
132 	return control_mfc3_to_pc(pia(p)->ppra & 0xe0);
133 }
134 
135 static unsigned char mfc3_frob_control( struct parport *p, unsigned char mask, unsigned char val)
136 {
137 	unsigned char old;
138 
139 	pr_debug("frob_control mask %02x, value %02x\n", mask, val);
140 	old = mfc3_read_control(p);
141 	mfc3_write_control(p, (old & ~mask) ^ val);
142 	return old;
143 }
144 
145 static unsigned char status_mfc3_to_pc(unsigned char status)
146 {
147 	unsigned char ret = PARPORT_STATUS_BUSY;
148 
149 	if (status & 1) /* Busy */
150 		ret &= ~PARPORT_STATUS_BUSY;
151 	if (status & 2) /* PaperOut */
152 		ret |= PARPORT_STATUS_PAPEROUT;
153 	if (status & 4) /* Selected */
154 		ret |= PARPORT_STATUS_SELECT;
155 	if (status & 8) /* Ack */
156 		ret |= PARPORT_STATUS_ACK;
157 	if (status & 16) /* /ERROR */
158 		ret |= PARPORT_STATUS_ERROR;
159 
160 	return ret;
161 }
162 
163 static unsigned char mfc3_read_status(struct parport *p)
164 {
165 	unsigned char status;
166 
167 	status = status_mfc3_to_pc(pia(p)->ppra & 0x1f);
168 	pr_debug("read_status %02x\n", status);
169 	return status;
170 }
171 
172 static int use_cnt;
173 
174 static irqreturn_t mfc3_interrupt(int irq, void *dev_id)
175 {
176 	int i;
177 
178 	for( i = 0; i < MAX_MFC; i++)
179 		if (this_port[i] != NULL)
180 			if (pia(this_port[i])->crb & 128) { /* Board caused interrupt */
181 				dummy = pia(this_port[i])->pprb; /* clear irq bit */
182 				parport_generic_irq(this_port[i]);
183 			}
184 	return IRQ_HANDLED;
185 }
186 
187 static void mfc3_enable_irq(struct parport *p)
188 {
189 	pia(p)->crb |= PIA_C1_ENABLE_IRQ;
190 }
191 
192 static void mfc3_disable_irq(struct parport *p)
193 {
194 	pia(p)->crb &= ~PIA_C1_ENABLE_IRQ;
195 }
196 
197 static void mfc3_data_forward(struct parport *p)
198 {
199 	pr_debug("forward\n");
200 	pia(p)->crb &= ~PIA_DDR; /* make data direction register visible */
201 	pia(p)->pddrb = 255; /* all pins output */
202 	pia(p)->crb |= PIA_DDR; /* make data register visible - default */
203 }
204 
205 static void mfc3_data_reverse(struct parport *p)
206 {
207 	pr_debug("reverse\n");
208 	pia(p)->crb &= ~PIA_DDR; /* make data direction register visible */
209 	pia(p)->pddrb = 0; /* all pins input */
210 	pia(p)->crb |= PIA_DDR; /* make data register visible - default */
211 }
212 
213 static void mfc3_init_state(struct pardevice *dev, struct parport_state *s)
214 {
215 	s->u.amiga.data = 0;
216 	s->u.amiga.datadir = 255;
217 	s->u.amiga.status = 0;
218 	s->u.amiga.statusdir = 0xe0;
219 }
220 
221 static void mfc3_save_state(struct parport *p, struct parport_state *s)
222 {
223 	s->u.amiga.data = pia(p)->pprb;
224 	pia(p)->crb &= ~PIA_DDR;
225 	s->u.amiga.datadir = pia(p)->pddrb;
226 	pia(p)->crb |= PIA_DDR;
227 	s->u.amiga.status = pia(p)->ppra;
228 	pia(p)->cra &= ~PIA_DDR;
229 	s->u.amiga.statusdir = pia(p)->pddrb;
230 	pia(p)->cra |= PIA_DDR;
231 }
232 
233 static void mfc3_restore_state(struct parport *p, struct parport_state *s)
234 {
235 	pia(p)->pprb = s->u.amiga.data;
236 	pia(p)->crb &= ~PIA_DDR;
237 	pia(p)->pddrb = s->u.amiga.datadir;
238 	pia(p)->crb |= PIA_DDR;
239 	pia(p)->ppra = s->u.amiga.status;
240 	pia(p)->cra &= ~PIA_DDR;
241 	pia(p)->pddrb = s->u.amiga.statusdir;
242 	pia(p)->cra |= PIA_DDR;
243 }
244 
245 static struct parport_operations pp_mfc3_ops = {
246 	.write_data	= mfc3_write_data,
247 	.read_data	= mfc3_read_data,
248 
249 	.write_control	= mfc3_write_control,
250 	.read_control	= mfc3_read_control,
251 	.frob_control	= mfc3_frob_control,
252 
253 	.read_status	= mfc3_read_status,
254 
255 	.enable_irq	= mfc3_enable_irq,
256 	.disable_irq	= mfc3_disable_irq,
257 
258 	.data_forward	= mfc3_data_forward,
259 	.data_reverse	= mfc3_data_reverse,
260 
261 	.init_state	= mfc3_init_state,
262 	.save_state	= mfc3_save_state,
263 	.restore_state	= mfc3_restore_state,
264 
265 	.epp_write_data	= parport_ieee1284_epp_write_data,
266 	.epp_read_data	= parport_ieee1284_epp_read_data,
267 	.epp_write_addr	= parport_ieee1284_epp_write_addr,
268 	.epp_read_addr	= parport_ieee1284_epp_read_addr,
269 
270 	.ecp_write_data	= parport_ieee1284_ecp_write_data,
271 	.ecp_read_data	= parport_ieee1284_ecp_read_data,
272 	.ecp_write_addr	= parport_ieee1284_ecp_write_addr,
273 
274 	.compat_write_data	= parport_ieee1284_write_compat,
275 	.nibble_read_data	= parport_ieee1284_read_nibble,
276 	.byte_read_data		= parport_ieee1284_read_byte,
277 
278 	.owner		= THIS_MODULE,
279 };
280 
281 /* ----------- Initialisation code --------------------------------- */
282 
283 static int __init parport_mfc3_init(void)
284 {
285 	struct parport *p;
286 	int pias = 0;
287 	struct pia *pp;
288 	struct zorro_dev *z = NULL;
289 
290 	if (!MACH_IS_AMIGA)
291 		return -ENODEV;
292 
293 	while ((z = zorro_find_device(ZORRO_PROD_BSC_MULTIFACE_III, z))) {
294 		unsigned long piabase = z->resource.start+PIABASE;
295 		if (!request_mem_region(piabase, sizeof(struct pia), "PIA"))
296 			continue;
297 
298 		pp = ZTWO_VADDR(piabase);
299 		pp->crb = 0;
300 		pp->pddrb = 255; /* all data pins output */
301 		pp->crb = PIA_DDR|32|8;
302 		dummy = pp->pddrb; /* reading clears interrupt */
303 		pp->cra = 0;
304 		pp->pddra = 0xe0; /* /RESET,  /DIR ,/AUTO-FEED output */
305 		pp->cra = PIA_DDR;
306 		pp->ppra = 0; /* reset printer */
307 		udelay(10);
308 		pp->ppra = 128;
309 		p = parport_register_port((unsigned long)pp, IRQ_AMIGA_PORTS,
310 					  PARPORT_DMA_NONE, &pp_mfc3_ops);
311 		if (!p)
312 			goto out_port;
313 
314 		if (p->irq != PARPORT_IRQ_NONE) {
315 			if (use_cnt++ == 0)
316 				if (request_irq(IRQ_AMIGA_PORTS, mfc3_interrupt, IRQF_SHARED, p->name, &pp_mfc3_ops))
317 					goto out_irq;
318 		}
319 		p->dev = &z->dev;
320 
321 		this_port[pias++] = p;
322 		pr_info("%s: Multiface III port using irq\n", p->name);
323 		/* XXX: set operating mode */
324 
325 		p->private_data = (void *)piabase;
326 		parport_announce_port (p);
327 
328 		if (pias >= MAX_MFC)
329 			break;
330 		continue;
331 
332 	out_irq:
333 		parport_put_port(p);
334 	out_port:
335 		release_mem_region(piabase, sizeof(struct pia));
336 	}
337 
338 	return pias ? 0 : -ENODEV;
339 }
340 
341 static void __exit parport_mfc3_exit(void)
342 {
343 	int i;
344 
345 	for (i = 0; i < MAX_MFC; i++) {
346 		if (!this_port[i])
347 			continue;
348 		parport_remove_port(this_port[i]);
349 		if (this_port[i]->irq != PARPORT_IRQ_NONE) {
350 			if (--use_cnt == 0)
351 				free_irq(IRQ_AMIGA_PORTS, &pp_mfc3_ops);
352 		}
353 		release_mem_region(ZTWO_PADDR(this_port[i]->private_data), sizeof(struct pia));
354 		parport_put_port(this_port[i]);
355 	}
356 }
357 
358 
359 MODULE_AUTHOR("Joerg Dorchain <joerg@dorchain.net>");
360 MODULE_DESCRIPTION("Parport Driver for Multiface 3 expansion cards Parallel Port");
361 MODULE_LICENSE("GPL");
362 
363 module_init(parport_mfc3_init)
364 module_exit(parport_mfc3_exit)
365