1/*	$NetBSD: mfp.c,v 1.32 2024/01/06 05:31:19 isaki Exp $	*/
2
3/*-
4 * Copyright (c) 1998 NetBSD Foundation, Inc.
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 NETBSD FOUNDATION, INC. AND CONTRIBUTORS
17 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/*
30 * MC68901 MFP (multi function periferal) driver for NetBSD/x68k
31 */
32
33/*
34 * MFP is used as keyboard controller, which may be used before
35 * ordinary initialization.
36 */
37
38#include <sys/cdefs.h>
39__KERNEL_RCSID(0, "$NetBSD: mfp.c,v 1.32 2024/01/06 05:31:19 isaki Exp $");
40
41#include <sys/param.h>
42#include <sys/systm.h>
43#include <sys/device.h>
44
45#include <machine/bus.h>
46#include <machine/cpu.h>
47#include <machine/autoconf.h>
48
49#include <arch/x68k/dev/intiovar.h>
50#include <arch/x68k/dev/mfp.h>
51
52static int  mfp_match(device_t, cfdata_t, void *);
53static void mfp_attach(device_t, device_t, void *);
54static int  mfp_search(device_t, cfdata_t, const int *, void *);
55static void mfp_init(void);
56static void mfp_calibrate_delay(void);
57
58CFATTACH_DECL_NEW(mfp, sizeof(struct mfp_softc),
59    mfp_match, mfp_attach, NULL, NULL);
60
61static int mfp_attached;
62
63static int
64mfp_match(device_t parent, cfdata_t cf, void *aux)
65{
66	struct intio_attach_args *ia = aux;
67
68	/* mfp0 */
69	if (strcmp(ia->ia_name, "mfp") != 0)
70		return 0;
71	if (mfp_attached)
72		return (0);
73
74	if (ia->ia_addr == INTIOCF_ADDR_DEFAULT)
75		ia->ia_addr = MFP_ADDR;
76	if (ia->ia_intr == INTIOCF_INTR_DEFAULT)
77		ia->ia_addr = MFP_INTR;
78
79	/* fixed address */
80	if (ia->ia_addr != MFP_ADDR)
81		return (0);
82	if (ia->ia_intr != MFP_INTR)
83		return (0);
84
85	return (1);
86}
87
88
89static void
90mfp_attach(device_t parent, device_t self, void *aux)
91{
92	struct mfp_softc *sc = device_private(self);
93	struct intio_attach_args *ia = aux;
94	int r __diagused;
95
96	aprint_normal("\n");
97	mfp_attached = 1;
98
99	/* mfp_init() is already called via early config_console() */
100	sc->sc_bst = ia->ia_bst;
101	sc->sc_intr = ia->ia_intr;
102	ia->ia_size = 0x30;
103	r = intio_map_allocate_region(parent, ia, INTIO_MAP_ALLOCATE);
104#ifdef DIAGNOSTIC
105	if (r)
106		panic("IO map for MFP corruption??");
107#endif
108	bus_space_map(ia->ia_bst, ia->ia_addr, 0x2000, 0, &sc->sc_bht);
109	config_search(self, NULL,
110	    CFARGS(.search = mfp_search));
111}
112
113static int
114mfp_search(device_t parent, cfdata_t cf, const int *loc, void *aux)
115{
116	if (config_probe(parent, cf, __UNCONST(cf->cf_name)))
117		config_attach(parent, cf, __UNCONST(cf->cf_name), NULL,
118		    CFARGS_NONE);
119	return 0;
120}
121
122void
123mfp_config_console(void)
124{
125	mfp_init();
126	mfp_calibrate_delay();
127}
128
129static void
130mfp_init(void)
131{
132	mfp_set_vr(MFP_INTR);
133
134	/* stop all interrupts */
135	mfp_set_iera(0);
136	mfp_set_ierb(0);
137
138	/* make MSCTRL 'High', XXX where should I do it? */
139	mfp_send_usart(0x41);
140
141	/* Timer A settings */
142	mfp_set_tacr(MFP_TIMERA_RESET | MFP_TIMERA_STOP);
143
144	/* Timer B settings: used for USART clock */
145	mfp_set_tbcr(MFP_TIMERB_RESET | MFP_TIMERB_STOP);
146
147	/* Timer C/D settings */
148	mfp_set_tcdcr(0);
149}
150
151extern int delay_divisor;
152
153static void
154mfp_calibrate_delay(void)
155{
156	/*
157	 * Stolen from mvme68k.
158	 */
159	/*
160	 * X68k provides 4MHz clock (= 0.25usec) for MFP timer C.
161	 * 10000usec = 0.25usec * 200 * 200
162	 * Our slowest clock is 20MHz (?).  Its delay_divisor value
163	 * should be about 102.  Start from 140 here.
164	 */
165	for (delay_divisor = 140; delay_divisor > 0; delay_divisor--) {
166		mfp_set_tcdr(255-0);
167		mfp_set_tcdcr(0x70); /* 1/200 delay mode */
168		_delay(10000);
169		mfp_set_tcdcr(0); /* stop timer */
170		if ((255 - mfp_get_tcdr()) > 200)
171			break;	/* got it! */
172		/* retry! */
173	}
174}
175
176/*
177 * MFP utility functions
178 */
179
180/*
181 * wait for built-in display hsync.
182 * should be called before writing to frame buffer.
183 * might be called before realconfig.
184 */
185void
186mfp_wait_for_hsync(void)
187{
188	/* wait for CRT HSYNC */
189	while (mfp_get_gpip() & MFP_GPIP_HSYNC)
190		__asm("nop");
191	while (!(mfp_get_gpip() & MFP_GPIP_HSYNC))
192		__asm("nop");
193}
194
195/*
196 * send COMMAND to the MFP USART.
197 * USART is attached to the keyboard.
198 * might be called before realconfig.
199 */
200int
201mfp_send_usart(int command)
202{
203	while (!(mfp_get_tsr() & MFP_TSR_BE));
204	mfp_set_udr(command);
205
206	return 0;
207}
208
209int
210mfp_receive_usart(void)
211{
212	while (!(mfp_get_rsr() & MFP_RSR_BF))
213		__asm("nop");
214	return mfp_get_udr();
215}
216