xref: /netbsd-src/sys/arch/mips/alchemy/dev/aupsc.c (revision 82d56013d7b633d116a93943de88e08335357a7c)
1 /* $NetBSD: aupsc.c,v 1.8 2021/04/24 23:36:42 thorpej Exp $ */
2 
3 /*-
4  * Copyright (c) 2006 Shigeyuki Fukushima.
5  * All rights reserved.
6  *
7  * Written by Shigeyuki Fukushima.
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
15  *    copyright notice, this list of conditions and the following
16  *    disclaimer in the documentation and/or other materials provided
17  *    with the distribution.
18  * 3. The name of the author may not be used to endorse or promote
19  *    products derived from this software without specific prior
20  *    written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
23  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
26  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
28  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
30  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #include <sys/cdefs.h>
36 __KERNEL_RCSID(0, "$NetBSD: aupsc.c,v 1.8 2021/04/24 23:36:42 thorpej Exp $");
37 
38 #include "locators.h"
39 
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/device.h>
43 #include <sys/errno.h>
44 
45 #include <sys/bus.h>
46 #include <machine/cpu.h>
47 
48 #include <mips/alchemy/include/aubusvar.h>
49 #include <mips/alchemy/include/aureg.h>
50 #include <mips/alchemy/dev/aupscreg.h>
51 #include <mips/alchemy/dev/aupscvar.h>
52 #include <mips/alchemy/dev/ausmbus_pscreg.h>
53 
54 struct aupsc_softc {
55 	device_t		sc_dev;
56 	bus_space_tag_t		sc_bust;
57 	bus_space_handle_t	sc_bush;
58 	int			sc_pscsel;
59 };
60 
61 const struct aupsc_proto {
62 	const char *name;
63 	int protocol;
64 } aupsc_protos [] = {
65 	{ "ausmbus", AUPSC_SEL_SMBUS },
66 	{ "auspi", AUPSC_SEL_SPI },
67 #if 0
68 	{ "auaudio" },
69 	{ "aui2s" },
70 #endif
71 	{ NULL, AUPSC_SEL_DISABLE }
72 };
73 
74 static int	aupsc_match(device_t, struct cfdata *, void *);
75 static void	aupsc_attach(device_t, device_t, void *);
76 static int	aupsc_submatch(device_t, struct cfdata *, const int *, void *);
77 static int	aupsc_print(void *, const char *);
78 
79 static void	aupsc_enable(void *, int);
80 static void	aupsc_disable(void *);
81 static void	aupsc_suspend(void *);
82 
83 
84 CFATTACH_DECL_NEW(aupsc, sizeof(struct aupsc_softc),
85 	aupsc_match, aupsc_attach, NULL, NULL);
86 
87 static int
88 aupsc_match(device_t parent, struct cfdata *cf, void *aux)
89 {
90 	struct aubus_attach_args *aa = (struct aubus_attach_args *)aux;
91 
92 	if (strcmp(aa->aa_name, cf->cf_name) != 0)
93 		return 0;
94 
95 	return 1;
96 }
97 
98 static void
99 aupsc_attach(device_t parent, device_t self, void *aux)
100 {
101 	int i;
102 	uint32_t rv;
103 	struct aupsc_softc *sc = device_private(self);
104 	struct aubus_attach_args *aa = (struct aubus_attach_args *)aux;
105 	struct aupsc_attach_args pa;
106 	struct aupsc_controller ctrl;
107 
108 	sc->sc_dev = self;
109 	sc->sc_bust = aa->aa_st;
110 	if (bus_space_map(sc->sc_bust, aa->aa_addr,
111 			AUPSC_SIZE, 0, &sc->sc_bush) != 0) {
112 		aprint_error(": unable to map device registers\n");
113 		return;
114 	}
115 
116 	/* Initialize PSC_SEL register */
117 	sc->sc_pscsel = AUPSC_SEL_DISABLE;
118 	rv = bus_space_read_4(sc->sc_bust, sc->sc_bush, AUPSC_SEL);
119 	bus_space_write_4(sc->sc_bust, sc->sc_bush,
120 		AUPSC_SEL, (rv & AUPSC_SEL_PS(AUPSC_SEL_DISABLE)));
121 	bus_space_write_4(sc->sc_bust, sc->sc_bush,
122 		AUPSC_CTRL, AUPSC_CTRL_ENA(AUPSC_CTRL_DISABLE));
123 
124 	aprint_normal(": Alchemy PSC\n");
125 	aprint_naive("\n");
126 
127 	ctrl.psc_bust = sc->sc_bust;
128 	ctrl.psc_bush = sc->sc_bush;
129 	ctrl.psc_sel = &(sc->sc_pscsel);
130 	ctrl.psc_enable = aupsc_enable;
131 	ctrl.psc_disable = aupsc_disable;
132 	ctrl.psc_suspend = aupsc_suspend;
133 	pa.aupsc_ctrl = ctrl;
134 	pa.aupsc_addr = aa->aa_addr;
135 	pa.aupsc_irq = aa->aa_irq[0];
136 
137 	for (i = 0 ; aupsc_protos[i].name != NULL ; i++) {
138 		struct aupsc_protocol_device p;
139 		uint32_t s;
140 
141 		pa.aupsc_name = aupsc_protos[i].name;
142 
143 		p.sc_dev = sc->sc_dev;
144 		p.sc_ctrl = ctrl;
145 
146 		aupsc_enable(&p, aupsc_protos[i].protocol);
147 		s = bus_space_read_4(sc->sc_bust, sc->sc_bush, AUPSC_STAT);
148 		aupsc_disable(&p);
149 
150 		if (s & AUPSC_STAT_SR) {
151 			config_found(self, &pa, aupsc_print,
152 			    CFARG_SUBMATCH, aupsc_submatch,
153 			    CFARG_EOL);
154 		}
155         }
156 }
157 
158 static int
159 aupsc_submatch(device_t parent, struct cfdata *cf, const int *ldesc, void *aux)
160 {
161 
162 	return config_match(parent, cf, aux);
163 }
164 
165 static int
166 aupsc_print(void *aux, const char *pnp)
167 {
168 	/*
169 	 * By default we don't want to print anything, because
170 	 * otherwise we see complaints about protocols that aren't
171 	 * configured on every port.  (E.g. each PSC can support 4
172 	 * protocols, but on a typical design, only one protocol can
173 	 * be configured per board.)
174 	 *
175 	 * Basically, this whole thing should be replaced with an
176 	 * indirect configuration mechanism.  Direct configuration
177 	 * doesn't make sense when we absolutely require kernel
178 	 * configuration to operate.
179 	 *
180 	 * Alternatively, a board-specific configuration mechanism
181 	 * could determine this, and provide direct configuration as
182 	 * we do for PCMCIA.
183 	 */
184 
185 	return QUIET;
186 }
187 
188 static void
189 aupsc_enable(void *arg, int proto)
190 {
191 	struct aupsc_protocol_device *sc = arg;
192 	int i;
193 
194 	/* XXX: (TODO) setting clock AUPSC_SEL_CLK */
195 	switch (proto) {
196 	case AUPSC_SEL_SPI:
197 	case AUPSC_SEL_I2S:
198 	case AUPSC_SEL_AC97:
199 	case AUPSC_SEL_SMBUS:
200 		break;
201 	case AUPSC_SEL_DISABLE:
202 		aupsc_disable(arg);
203 		break;
204 	default:
205 		printf("%s: aupsc_enable: unsupported protocol.\n",
206 			device_xname(sc->sc_dev));
207 		return;
208 	}
209 
210 	if (*(sc->sc_ctrl.psc_sel) != AUPSC_SEL_DISABLE) {
211 		printf("%s: aupsc_enable: please disable first.\n",
212 			device_xname(sc->sc_dev));
213 		return;
214 	}
215 
216 	bus_space_write_4(sc->sc_ctrl.psc_bust, sc->sc_ctrl.psc_bush,
217 			AUPSC_SEL, AUPSC_SEL_PS(proto));
218 	bus_space_write_4(sc->sc_ctrl.psc_bust, sc->sc_ctrl.psc_bush,
219 			AUPSC_CTRL, AUPSC_CTRL_ENA(AUPSC_CTRL_ENABLE));
220 
221 	/* wait up to a whole second, but test every 10us */
222 	for (i = 1000000; i; i -= 10) {
223 		if (bus_space_read_4(sc->sc_ctrl.psc_bust,
224 			sc->sc_ctrl.psc_bush, AUPSC_STAT) & AUPSC_STAT_SR)
225 			return;
226 		delay(10);
227 	}
228 }
229 
230 static void
231 aupsc_disable(void *arg)
232 {
233 	struct aupsc_protocol_device *sc = arg;
234 
235 	bus_space_write_4(sc->sc_ctrl.psc_bust, sc->sc_ctrl.psc_bush,
236 			AUPSC_SEL, AUPSC_SEL_PS(AUPSC_SEL_DISABLE));
237 	bus_space_write_4(sc->sc_ctrl.psc_bust, sc->sc_ctrl.psc_bush,
238 			AUPSC_CTRL, AUPSC_CTRL_ENA(AUPSC_CTRL_DISABLE));
239 	delay(1);
240 }
241 
242 static void
243 aupsc_suspend(void *arg)
244 {
245 	struct aupsc_protocol_device *sc = arg;
246 
247 	bus_space_write_4(sc->sc_ctrl.psc_bust, sc->sc_ctrl.psc_bush,
248 			AUPSC_CTRL, AUPSC_CTRL_ENA(AUPSC_CTRL_SUSPEND));
249 	delay(1);
250 }
251