xref: /netbsd-src/sys/arch/hpcmips/dev/ucb1200.c (revision 53d1339bf7f9c7367b35a9e1ebe693f9b047a47b)
1 /*	$NetBSD: ucb1200.c,v 1.20 2021/04/24 23:36:38 thorpej Exp $ */
2 
3 /*-
4  * Copyright (c) 2000 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by UCHIYAMA Yasushi.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * Device driver for PHILIPS UCB1200 Advanced modem/audio analog front-end
34  */
35 
36 #include <sys/cdefs.h>
37 __KERNEL_RCSID(0, "$NetBSD: ucb1200.c,v 1.20 2021/04/24 23:36:38 thorpej Exp $");
38 
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/device.h>
42 
43 #include <machine/bus.h>
44 #include <machine/intr.h>
45 
46 #include <hpcmips/tx/tx39var.h>
47 #include <hpcmips/tx/tx39sibvar.h>
48 #include <hpcmips/tx/tx39sibreg.h>
49 
50 #include <hpcmips/dev/ucb1200var.h>
51 #include <hpcmips/dev/ucb1200reg.h>
52 
53 #ifdef	UCB1200_DEBUG
54 #define DPRINTF_ENABLE
55 #define DPRINTF_DEBUG	ucb1200_debug
56 #endif
57 #include <machine/debug.h>
58 
59 struct ucbchild_state {
60 	int (*cs_busy)(void *);
61 	void *cs_arg;
62 };
63 
64 struct ucb1200_softc {
65 	device_t	sc_parent; /* parent (TX39 SIB module) */
66 	tx_chipset_tag_t sc_tc;
67 
68 	int		sc_snd_rate; /* passed down from SIB module */
69 	int		sc_tel_rate;
70 
71 	/* inquire child module state */
72 	struct ucbchild_state sc_child[UCB1200_MODULE_MAX];
73 };
74 
75 int	ucb1200_match(device_t, cfdata_t, void *);
76 void	ucb1200_attach(device_t, device_t, void *);
77 int	ucb1200_print(void *, const char *);
78 int	ucb1200_search(device_t, cfdata_t, const int *, void *);
79 int	ucb1200_check_id(u_int16_t, int);
80 
81 #ifdef UCB1200_DEBUG
82 void	ucb1200_dump(struct ucb1200_softc *);
83 #endif
84 
85 CFATTACH_DECL_NEW(ucb, sizeof(struct ucb1200_softc),
86     ucb1200_match, ucb1200_attach, NULL, NULL);
87 
88 const struct ucb_id {
89 	u_int16_t	id;
90 	const char	*product;
91 } ucb_id[] = {
92 	{ UCB1100_ID,	"PHILIPS UCB1100" },
93 	{ UCB1200_ID,	"PHILIPS UCB1200" },
94 	{ UCB1300_ID,	"PHILIPS UCB1300" },
95 	{ TC35413F_ID,	"TOSHIBA TC35413F" },
96 	{ 0, 0 }
97 };
98 
99 int
100 ucb1200_match(device_t parent, cfdata_t cf, void *aux)
101 {
102 	struct txsib_attach_args *sa = aux;
103 	u_int16_t reg;
104 
105 	if (sa->sa_slot != 0) /* UCB1200 must be subframe 0 */
106 		return (0);
107 	reg = txsibsf0_reg_read(sa->sa_tc, UCB1200_ID_REG);
108 
109 	return (ucb1200_check_id(reg, 0));
110 }
111 
112 void
113 ucb1200_attach(device_t parent, device_t self, void *aux)
114 {
115 	struct txsib_attach_args *sa = aux;
116 	struct ucb1200_softc *sc = device_private(self);
117 	u_int16_t reg;
118 
119 	printf(": ");
120 	sc->sc_tc = sa->sa_tc;
121 	sc->sc_parent = parent;
122 	sc->sc_snd_rate = sa->sa_snd_rate;
123 	sc->sc_tel_rate = sa->sa_tel_rate;
124 
125 	tx39sib_enable1(sc->sc_parent);
126 	tx39sib_enable2(sc->sc_parent);
127 
128 #ifdef UCB1200_DEBUG
129 	if (ucb1200_debug)
130 		ucb1200_dump(sc);
131 #endif
132 	reg = txsibsf0_reg_read(sa->sa_tc, UCB1200_ID_REG);
133 	(void)ucb1200_check_id(reg, 1);
134 	printf("\n");
135 
136 	config_search(self, NULL,
137 	    CFARG_SEARCH, ucb1200_search,
138 	    CFARG_EOL);
139 }
140 
141 int
142 ucb1200_search(device_t parent, cfdata_t cf, const int *ldesc, void *aux)
143 {
144 	struct ucb1200_softc *sc = device_private(parent);
145 	struct ucb1200_attach_args ucba;
146 
147 	ucba.ucba_tc = sc->sc_tc;
148 	ucba.ucba_snd_rate = sc->sc_snd_rate;
149 	ucba.ucba_tel_rate = sc->sc_tel_rate;
150 	ucba.ucba_sib	   = sc->sc_parent;
151 	ucba.ucba_ucb	   = parent;
152 
153 	if (config_probe(parent, cf, &ucba))
154 		config_attach(parent, cf, &ucba, ucb1200_print, CFARG_EOL);
155 
156 	return (0);
157 }
158 
159 int
160 ucb1200_print(void *aux, const char *pnp)
161 {
162 
163 	return (pnp ? QUIET : UNCONF);
164 }
165 
166 int
167 ucb1200_check_id(u_int16_t idreg, int print)
168 {
169 	int i;
170 
171 	for (i = 0; ucb_id[i].product; i++) {
172 		if (ucb_id[i].id == idreg) {
173 			if (print) {
174 				printf("%s", ucb_id[i].product);
175 			}
176 
177 			return (1);
178 		}
179 	}
180 
181 	return (0);
182 }
183 
184 void
185 ucb1200_state_install(device_t dev, int (*sfun)(void *), void *sarg,
186     int sid)
187 {
188 	struct ucb1200_softc *sc = device_private(dev);
189 
190 	sc->sc_child[sid].cs_busy = sfun;
191 	sc->sc_child[sid].cs_arg = sarg;
192 }
193 
194 int
195 ucb1200_state_idle(device_t dev)
196 {
197 	struct ucb1200_softc *sc = device_private(dev);
198 	struct ucbchild_state *cs;
199 	int i;
200 
201 	cs = sc->sc_child;
202 	for (i = 0; i < UCB1200_MODULE_MAX; i++, cs++)
203 		if (cs->cs_busy)
204 			if ((*cs->cs_busy)(cs->cs_arg))
205 				return (0);
206 
207 	return (1); /* idle state */
208 }
209 
210 #ifdef UCB1200_DEBUG
211 void
212 ucb1200_dump(struct ucb1200_softc *sc)
213 {
214 	static const char *const regname[] = {
215                 "IO_DATA        ",
216                 "IO_DIR         ",
217                 "POSINTEN       ",
218                 "NEGINTEN       ",
219                 "INTSTAT        ",
220                 "TELECOMCTRLA   ",
221                 "TELECOMCTRLB   ",
222                 "AUDIOCTRLA     ",
223                 "AUDIOCTRLB     ",
224                 "TOUCHSCREENCTRL",
225                 "ADCCTRL        ",
226                 "ADCDATA        ",
227                 "ID             ",
228                 "MODE           ",
229                 "RESERVED       ",
230                 "NULL           "
231 	};
232 	tx_chipset_tag_t tc;
233 	u_int16_t reg;
234 	int i;
235 
236 	tc = sc->sc_tc;
237 
238 	printf("\n\t[UCB1200 register]\n");
239 	for (i = 0; i < 16; i++) {
240 		reg = txsibsf0_reg_read(tc, i);
241 		printf("%s(%02d) 0x%04x ", regname[i], i, reg);
242 		dbg_bit_print(reg);
243 	}
244 }
245 #endif /* UCB1200_DEBUG */
246