auvia.c revision 1.75 1 1.75 mrg /* $NetBSD: auvia.c,v 1.75 2011/11/24 03:35:58 mrg Exp $ */
2 1.1 tsarna
3 1.1 tsarna /*-
4 1.74 jmcneill * Copyright (c) 2000, 2008 The NetBSD Foundation, Inc.
5 1.1 tsarna * All rights reserved.
6 1.1 tsarna *
7 1.1 tsarna * This code is derived from software contributed to The NetBSD Foundation
8 1.74 jmcneill * by Tyler C. Sarna.
9 1.1 tsarna *
10 1.1 tsarna * Redistribution and use in source and binary forms, with or without
11 1.1 tsarna * modification, are permitted provided that the following conditions
12 1.1 tsarna * are met:
13 1.1 tsarna * 1. Redistributions of source code must retain the above copyright
14 1.1 tsarna * notice, this list of conditions and the following disclaimer.
15 1.1 tsarna * 2. Redistributions in binary form must reproduce the above copyright
16 1.1 tsarna * notice, this list of conditions and the following disclaimer in the
17 1.1 tsarna * documentation and/or other materials provided with the distribution.
18 1.1 tsarna *
19 1.1 tsarna * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.1 tsarna * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.1 tsarna * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.1 tsarna * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.1 tsarna * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.1 tsarna * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.1 tsarna * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.1 tsarna * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.1 tsarna * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.1 tsarna * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.1 tsarna * POSSIBILITY OF SUCH DAMAGE.
30 1.1 tsarna */
31 1.1 tsarna
32 1.1 tsarna /*
33 1.22 kent * VIA Technologies VT82C686A / VT8233 / VT8235 Southbridge Audio Driver
34 1.1 tsarna *
35 1.1 tsarna * Documentation links:
36 1.1 tsarna *
37 1.1 tsarna * ftp://ftp.alsa-project.org/pub/manuals/via/686a.pdf
38 1.1 tsarna * ftp://ftp.alsa-project.org/pub/manuals/general/ac97r21.pdf
39 1.1 tsarna * ftp://ftp.alsa-project.org/pub/manuals/ad/AD1881_0.pdf (example AC'97 codec)
40 1.1 tsarna */
41 1.14 lukem
42 1.14 lukem #include <sys/cdefs.h>
43 1.75 mrg __KERNEL_RCSID(0, "$NetBSD: auvia.c,v 1.75 2011/11/24 03:35:58 mrg Exp $");
44 1.1 tsarna
45 1.1 tsarna #include <sys/param.h>
46 1.1 tsarna #include <sys/systm.h>
47 1.74 jmcneill #include <sys/kmem.h>
48 1.1 tsarna #include <sys/device.h>
49 1.1 tsarna #include <sys/audioio.h>
50 1.1 tsarna
51 1.1 tsarna #include <dev/pci/pcidevs.h>
52 1.1 tsarna #include <dev/pci/pcivar.h>
53 1.1 tsarna
54 1.1 tsarna #include <dev/audio_if.h>
55 1.1 tsarna #include <dev/mulaw.h>
56 1.1 tsarna #include <dev/auconv.h>
57 1.1 tsarna
58 1.10 augustss #include <dev/ic/ac97reg.h>
59 1.3 thorpej #include <dev/ic/ac97var.h>
60 1.1 tsarna
61 1.1 tsarna #include <dev/pci/auviavar.h>
62 1.1 tsarna
63 1.74 jmcneill #define AUVIA_MINBLKSZ 512
64 1.74 jmcneill
65 1.1 tsarna struct auvia_dma {
66 1.1 tsarna struct auvia_dma *next;
67 1.60 christos void *addr;
68 1.1 tsarna size_t size;
69 1.1 tsarna bus_dmamap_t map;
70 1.1 tsarna bus_dma_segment_t seg;
71 1.1 tsarna };
72 1.1 tsarna
73 1.1 tsarna struct auvia_dma_op {
74 1.51 kent uint32_t ptr;
75 1.51 kent uint32_t flags;
76 1.1 tsarna #define AUVIA_DMAOP_EOL 0x80000000
77 1.1 tsarna #define AUVIA_DMAOP_FLAG 0x40000000
78 1.1 tsarna #define AUVIA_DMAOP_STOP 0x20000000
79 1.1 tsarna #define AUVIA_DMAOP_COUNT(x) ((x)&0x00FFFFFF)
80 1.1 tsarna };
81 1.1 tsarna
82 1.68 cegger static int auvia_match(device_t, cfdata_t, void *);
83 1.63 dyoung static void auvia_attach(device_t, device_t, void *);
84 1.63 dyoung static int auvia_detach(device_t, int);
85 1.63 dyoung static void auvia_childdet(device_t, device_t);
86 1.54 kent static int auvia_open(void *, int);
87 1.54 kent static void auvia_close(void *);
88 1.52 thorpej static int auvia_query_encoding(void *, struct audio_encoding *);
89 1.52 thorpej static void auvia_set_params_sub(struct auvia_softc *,
90 1.52 thorpej struct auvia_softc_chan *,
91 1.52 thorpej const audio_params_t *);
92 1.52 thorpej static int auvia_set_params(void *, int, int, audio_params_t *,
93 1.52 thorpej audio_params_t *, stream_filter_list_t *,
94 1.52 thorpej stream_filter_list_t *);
95 1.52 thorpej static int auvia_round_blocksize(void *, int, int, const audio_params_t *);
96 1.52 thorpej static int auvia_halt_output(void *);
97 1.52 thorpej static int auvia_halt_input(void *);
98 1.52 thorpej static int auvia_getdev(void *, struct audio_device *);
99 1.52 thorpej static int auvia_set_port(void *, mixer_ctrl_t *);
100 1.52 thorpej static int auvia_get_port(void *, mixer_ctrl_t *);
101 1.52 thorpej static int auvia_query_devinfo(void *, mixer_devinfo_t *);
102 1.74 jmcneill static void * auvia_malloc(void *, int, size_t);
103 1.74 jmcneill static void auvia_free(void *, void *, size_t);
104 1.52 thorpej static size_t auvia_round_buffersize(void *, int, size_t);
105 1.52 thorpej static paddr_t auvia_mappage(void *, void *, off_t, int);
106 1.52 thorpej static int auvia_get_props(void *);
107 1.52 thorpej static int auvia_build_dma_ops(struct auvia_softc *,
108 1.52 thorpej struct auvia_softc_chan *,
109 1.52 thorpej struct auvia_dma *, void *, void *, int);
110 1.52 thorpej static int auvia_trigger_output(void *, void *, void *, int,
111 1.52 thorpej void (*)(void *), void *,
112 1.52 thorpej const audio_params_t *);
113 1.52 thorpej static int auvia_trigger_input(void *, void *, void *, int,
114 1.52 thorpej void (*)(void *), void *,
115 1.52 thorpej const audio_params_t *);
116 1.74 jmcneill static void auvia_get_locks(void *, kmutex_t **, kmutex_t **);
117 1.72 dyoung static bool auvia_resume(device_t, const pmf_qual_t *);
118 1.74 jmcneill
119 1.52 thorpej static int auvia_intr(void *);
120 1.74 jmcneill static void * auvia_malloc_dmamem(void *, int, size_t);
121 1.74 jmcneill static int auvia_malloc_channel(struct auvia_softc *, struct auvia_softc_chan *,
122 1.74 jmcneill size_t);
123 1.54 kent static int auvia_attach_codec(void *, struct ac97_codec_if *);
124 1.54 kent static int auvia_write_codec(void *, uint8_t, uint16_t);
125 1.54 kent static int auvia_read_codec(void *, uint8_t, uint16_t *);
126 1.54 kent static int auvia_reset_codec(void *);
127 1.54 kent static int auvia_waitready_codec(struct auvia_softc *);
128 1.54 kent static int auvia_waitvalid_codec(struct auvia_softc *);
129 1.59 thorpej static void auvia_spdif_event(void *, bool);
130 1.54 kent
131 1.69 cegger CFATTACH_DECL2_NEW(auvia, sizeof (struct auvia_softc),
132 1.63 dyoung auvia_match, auvia_attach, auvia_detach, NULL, NULL, auvia_childdet);
133 1.1 tsarna
134 1.34 martin /* VIA VT823xx revision number */
135 1.53 rpaulo #define VIA_REV_8233PRE 0x10
136 1.34 martin #define VIA_REV_8233C 0x20
137 1.34 martin #define VIA_REV_8233 0x30
138 1.34 martin #define VIA_REV_8233A 0x40
139 1.34 martin #define VIA_REV_8235 0x50
140 1.45 kent #define VIA_REV_8237 0x60
141 1.34 martin
142 1.1 tsarna #define AUVIA_PCICONF_JUNK 0x40
143 1.1 tsarna #define AUVIA_PCICONF_ENABLES 0x00FF0000 /* reg 42 mask */
144 1.1 tsarna #define AUVIA_PCICONF_ACLINKENAB 0x00008000 /* ac link enab */
145 1.1 tsarna #define AUVIA_PCICONF_ACNOTRST 0x00004000 /* ~(ac reset) */
146 1.1 tsarna #define AUVIA_PCICONF_ACSYNC 0x00002000 /* ac sync */
147 1.1 tsarna #define AUVIA_PCICONF_ACVSR 0x00000800 /* var. samp. rate */
148 1.1 tsarna #define AUVIA_PCICONF_ACSGD 0x00000400 /* SGD enab */
149 1.1 tsarna #define AUVIA_PCICONF_ACFM 0x00000200 /* FM enab */
150 1.1 tsarna #define AUVIA_PCICONF_ACSB 0x00000100 /* SB enab */
151 1.32 jmmv #define AUVIA_PCICONF_PRIVALID 0x00000001 /* primary codec rdy */
152 1.1 tsarna
153 1.24 kent #define AUVIA_PLAY_BASE 0x00
154 1.24 kent #define AUVIA_RECORD_BASE 0x10
155 1.22 kent
156 1.27 kent /* *_RP_* are offsets from AUVIA_PLAY_BASE or AUVIA_RECORD_BASE */
157 1.24 kent #define AUVIA_RP_STAT 0x00
158 1.1 tsarna #define AUVIA_RPSTAT_INTR 0x03
159 1.24 kent #define AUVIA_RP_CONTROL 0x01
160 1.1 tsarna #define AUVIA_RPCTRL_START 0x80
161 1.1 tsarna #define AUVIA_RPCTRL_TERMINATE 0x40
162 1.22 kent #define AUVIA_RPCTRL_AUTOSTART 0x20
163 1.22 kent /* The following are 8233 specific */
164 1.22 kent #define AUVIA_RPCTRL_STOP 0x04
165 1.22 kent #define AUVIA_RPCTRL_EOL 0x02
166 1.22 kent #define AUVIA_RPCTRL_FLAG 0x01
167 1.27 kent #define AUVIA_RP_MODE 0x02 /* 82c686 specific */
168 1.1 tsarna #define AUVIA_RPMODE_INTR_FLAG 0x01
169 1.1 tsarna #define AUVIA_RPMODE_INTR_EOL 0x02
170 1.1 tsarna #define AUVIA_RPMODE_STEREO 0x10
171 1.1 tsarna #define AUVIA_RPMODE_16BIT 0x20
172 1.1 tsarna #define AUVIA_RPMODE_AUTOSTART 0x80
173 1.24 kent #define AUVIA_RP_DMAOPS_BASE 0x04
174 1.22 kent
175 1.24 kent #define VIA8233_RP_DXS_LVOL 0x02
176 1.24 kent #define VIA8233_RP_DXS_RVOL 0x03
177 1.24 kent #define VIA8233_RP_RATEFMT 0x08
178 1.22 kent #define VIA8233_RATEFMT_48K 0xfffff
179 1.22 kent #define VIA8233_RATEFMT_STEREO 0x00100000
180 1.22 kent #define VIA8233_RATEFMT_16BIT 0x00200000
181 1.22 kent
182 1.24 kent #define VIA_RP_DMAOPS_COUNT 0x0c
183 1.1 tsarna
184 1.27 kent #define VIA8233_MP_BASE 0x40
185 1.27 kent /* STAT, CONTROL, DMAOPS_BASE, DMAOPS_COUNT are valid */
186 1.27 kent #define VIA8233_OFF_MP_FORMAT 0x02
187 1.27 kent #define VIA8233_MP_FORMAT_8BIT 0x00
188 1.27 kent #define VIA8233_MP_FORMAT_16BIT 0x80
189 1.27 kent #define VIA8233_MP_FORMAT_CHANNLE_MASK 0x70 /* 1, 2, 4, 6 */
190 1.27 kent #define VIA8233_OFF_MP_SCRATCH 0x03
191 1.27 kent #define VIA8233_OFF_MP_STOP 0x08
192 1.27 kent
193 1.66 jmcneill #define VIA8233_WR_BASE 0x60
194 1.66 jmcneill
195 1.1 tsarna #define AUVIA_CODEC_CTL 0x80
196 1.1 tsarna #define AUVIA_CODEC_READ 0x00800000
197 1.1 tsarna #define AUVIA_CODEC_BUSY 0x01000000
198 1.1 tsarna #define AUVIA_CODEC_PRIVALID 0x02000000
199 1.1 tsarna #define AUVIA_CODEC_INDEX(x) ((x)<<16)
200 1.1 tsarna
201 1.27 kent #define CH_WRITE1(sc, ch, off, v) \
202 1.27 kent bus_space_write_1((sc)->sc_iot, (sc)->sc_ioh, (ch)->sc_base + (off), v)
203 1.27 kent #define CH_WRITE4(sc, ch, off, v) \
204 1.27 kent bus_space_write_4((sc)->sc_iot, (sc)->sc_ioh, (ch)->sc_base + (off), v)
205 1.27 kent #define CH_READ1(sc, ch, off) \
206 1.27 kent bus_space_read_1((sc)->sc_iot, (sc)->sc_ioh, (ch)->sc_base + (off))
207 1.27 kent #define CH_READ4(sc, ch, off) \
208 1.27 kent bus_space_read_4((sc)->sc_iot, (sc)->sc_ioh, (ch)->sc_base + (off))
209 1.27 kent
210 1.1 tsarna #define TIMEOUT 50
211 1.1 tsarna
212 1.52 thorpej static const struct audio_hw_if auvia_hw_if = {
213 1.54 kent auvia_open,
214 1.54 kent auvia_close,
215 1.1 tsarna NULL, /* drain */
216 1.1 tsarna auvia_query_encoding,
217 1.1 tsarna auvia_set_params,
218 1.1 tsarna auvia_round_blocksize,
219 1.1 tsarna NULL, /* commit_settings */
220 1.1 tsarna NULL, /* init_output */
221 1.1 tsarna NULL, /* init_input */
222 1.1 tsarna NULL, /* start_output */
223 1.1 tsarna NULL, /* start_input */
224 1.1 tsarna auvia_halt_output,
225 1.1 tsarna auvia_halt_input,
226 1.1 tsarna NULL, /* speaker_ctl */
227 1.1 tsarna auvia_getdev,
228 1.1 tsarna NULL, /* setfd */
229 1.1 tsarna auvia_set_port,
230 1.1 tsarna auvia_get_port,
231 1.1 tsarna auvia_query_devinfo,
232 1.1 tsarna auvia_malloc,
233 1.1 tsarna auvia_free,
234 1.1 tsarna auvia_round_buffersize,
235 1.1 tsarna auvia_mappage,
236 1.1 tsarna auvia_get_props,
237 1.1 tsarna auvia_trigger_output,
238 1.1 tsarna auvia_trigger_input,
239 1.13 augustss NULL, /* dev_ioctl */
240 1.74 jmcneill auvia_get_locks,
241 1.1 tsarna };
242 1.1 tsarna
243 1.48 kent #define AUVIA_FORMATS_4CH_16 2
244 1.48 kent #define AUVIA_FORMATS_6CH_16 3
245 1.48 kent #define AUVIA_FORMATS_4CH_8 6
246 1.48 kent #define AUVIA_FORMATS_6CH_8 7
247 1.48 kent static const struct audio_format auvia_formats[AUVIA_NFORMATS] = {
248 1.48 kent {NULL, AUMODE_PLAY | AUMODE_RECORD, AUDIO_ENCODING_SLINEAR_LE, 16, 16,
249 1.48 kent 1, AUFMT_MONAURAL, 0, {8000, 48000}},
250 1.48 kent {NULL, AUMODE_PLAY | AUMODE_RECORD, AUDIO_ENCODING_SLINEAR_LE, 16, 16,
251 1.48 kent 2, AUFMT_STEREO, 0, {8000, 48000}},
252 1.48 kent {NULL, AUMODE_PLAY, AUDIO_ENCODING_SLINEAR_LE, 16, 16,
253 1.48 kent 4, AUFMT_SURROUND4, 0, {8000, 48000}},
254 1.48 kent {NULL, AUMODE_PLAY, AUDIO_ENCODING_SLINEAR_LE, 16, 16,
255 1.48 kent 6, AUFMT_DOLBY_5_1, 0, {8000, 48000}},
256 1.48 kent {NULL, AUMODE_PLAY | AUMODE_RECORD, AUDIO_ENCODING_ULINEAR_LE, 8, 8,
257 1.48 kent 1, AUFMT_MONAURAL, 0, {8000, 48000}},
258 1.48 kent {NULL, AUMODE_PLAY | AUMODE_RECORD, AUDIO_ENCODING_ULINEAR_LE, 8, 8,
259 1.48 kent 2, AUFMT_STEREO, 0, {8000, 48000}},
260 1.48 kent {NULL, AUMODE_PLAY, AUDIO_ENCODING_ULINEAR_LE, 8, 8,
261 1.48 kent 4, AUFMT_SURROUND4, 0, {8000, 48000}},
262 1.48 kent {NULL, AUMODE_PLAY, AUDIO_ENCODING_SLINEAR_LE, 8, 8,
263 1.48 kent 6, AUFMT_DOLBY_5_1, 0, {8000, 48000}},
264 1.48 kent };
265 1.48 kent
266 1.54 kent #define AUVIA_SPDIF_NFORMATS 1
267 1.54 kent static const struct audio_format auvia_spdif_formats[AUVIA_SPDIF_NFORMATS] = {
268 1.54 kent {NULL, AUMODE_PLAY | AUMODE_RECORD, AUDIO_ENCODING_SLINEAR_LE, 16, 16,
269 1.54 kent 2, AUFMT_STEREO, 1, {48000}},
270 1.54 kent };
271 1.1 tsarna
272 1.1 tsarna
273 1.52 thorpej static int
274 1.68 cegger auvia_match(device_t parent, cfdata_t match, void *aux)
275 1.1 tsarna {
276 1.51 kent struct pci_attach_args *pa;
277 1.1 tsarna
278 1.51 kent pa = (struct pci_attach_args *) aux;
279 1.1 tsarna if (PCI_VENDOR(pa->pa_id) != PCI_VENDOR_VIATECH)
280 1.1 tsarna return 0;
281 1.15 jmcneill switch (PCI_PRODUCT(pa->pa_id)) {
282 1.15 jmcneill case PCI_PRODUCT_VIATECH_VT82C686A_AC97:
283 1.22 kent case PCI_PRODUCT_VIATECH_VT8233_AC97:
284 1.15 jmcneill break;
285 1.15 jmcneill default:
286 1.1 tsarna return 0;
287 1.15 jmcneill }
288 1.1 tsarna
289 1.1 tsarna return 1;
290 1.1 tsarna }
291 1.1 tsarna
292 1.52 thorpej static void
293 1.63 dyoung auvia_childdet(device_t self, device_t child)
294 1.63 dyoung {
295 1.63 dyoung /* we hold no child references, so do nothing */
296 1.63 dyoung }
297 1.63 dyoung
298 1.63 dyoung static int
299 1.63 dyoung auvia_detach(device_t self, int flags)
300 1.63 dyoung {
301 1.63 dyoung int rc;
302 1.63 dyoung struct auvia_softc *sc = device_private(self);
303 1.63 dyoung
304 1.63 dyoung if ((rc = config_detach_children(self, flags)) != 0)
305 1.63 dyoung return rc;
306 1.63 dyoung pmf_device_deregister(self);
307 1.63 dyoung
308 1.74 jmcneill mutex_enter(&sc->sc_lock);
309 1.63 dyoung auconv_delete_encodings(sc->sc_encodings);
310 1.63 dyoung auconv_delete_encodings(sc->sc_spdif_encodings);
311 1.63 dyoung if (sc->codec_if != NULL)
312 1.63 dyoung sc->codec_if->vtbl->detach(sc->codec_if);
313 1.74 jmcneill mutex_exit(&sc->sc_lock);
314 1.63 dyoung
315 1.63 dyoung /* XXX restore compatibility? */
316 1.63 dyoung if (sc->sc_ih != NULL)
317 1.63 dyoung pci_intr_disestablish(sc->sc_pc, sc->sc_ih);
318 1.63 dyoung
319 1.63 dyoung bus_space_unmap(sc->sc_iot, sc->sc_ioh, sc->sc_iosize);
320 1.74 jmcneill if (sc->sc_play.sc_dma_ops != NULL) {
321 1.74 jmcneill auvia_free(sc, sc->sc_play.sc_dma_ops,
322 1.74 jmcneill sc->sc_play.sc_dma_op_count *
323 1.74 jmcneill sizeof(struct auvia_dma_op));
324 1.74 jmcneill }
325 1.74 jmcneill if (sc->sc_record.sc_dma_ops != NULL) {
326 1.74 jmcneill auvia_free(sc, sc->sc_record.sc_dma_ops,
327 1.74 jmcneill sc->sc_play.sc_dma_op_count *
328 1.74 jmcneill sizeof(struct auvia_dma_op));
329 1.74 jmcneill }
330 1.74 jmcneill mutex_destroy(&sc->sc_lock);
331 1.74 jmcneill mutex_destroy(&sc->sc_intr_lock);
332 1.63 dyoung
333 1.63 dyoung return 0;
334 1.63 dyoung }
335 1.63 dyoung
336 1.63 dyoung static void
337 1.63 dyoung auvia_attach(device_t parent, device_t self, void *aux)
338 1.1 tsarna {
339 1.51 kent struct pci_attach_args *pa;
340 1.51 kent struct auvia_softc *sc;
341 1.51 kent const char *intrstr;
342 1.51 kent pci_chipset_tag_t pc;
343 1.51 kent pcitag_t pt;
344 1.22 kent pci_intr_handle_t ih;
345 1.1 tsarna pcireg_t pr;
346 1.27 kent int r;
347 1.51 kent const char *revnum; /* VT823xx revision number */
348 1.51 kent
349 1.51 kent pa = aux;
350 1.63 dyoung sc = device_private(self);
351 1.69 cegger sc->sc_dev = self;
352 1.51 kent intrstr = NULL;
353 1.51 kent pc = pa->pa_pc;
354 1.51 kent pt = pa->pa_tag;
355 1.51 kent revnum = NULL;
356 1.22 kent
357 1.29 thorpej aprint_naive(": Audio controller\n");
358 1.29 thorpej
359 1.27 kent sc->sc_play.sc_base = AUVIA_PLAY_BASE;
360 1.27 kent sc->sc_record.sc_base = AUVIA_RECORD_BASE;
361 1.27 kent if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_VIATECH_VT8233_AC97) {
362 1.22 kent sc->sc_flags |= AUVIA_FLAGS_VT8233;
363 1.27 kent sc->sc_play.sc_base = VIA8233_MP_BASE;
364 1.66 jmcneill sc->sc_record.sc_base = VIA8233_WR_BASE;
365 1.27 kent }
366 1.22 kent
367 1.22 kent if (pci_mapreg_map(pa, 0x10, PCI_MAPREG_TYPE_IO, 0, &sc->sc_iot,
368 1.63 dyoung &sc->sc_ioh, NULL, &sc->sc_iosize)) {
369 1.29 thorpej aprint_error(": can't map i/o space\n");
370 1.22 kent return;
371 1.22 kent }
372 1.22 kent
373 1.22 kent sc->sc_dmat = pa->pa_dmat;
374 1.22 kent sc->sc_pc = pc;
375 1.22 kent sc->sc_pt = pt;
376 1.1 tsarna
377 1.1 tsarna r = PCI_REVISION(pa->pa_class);
378 1.22 kent if (sc->sc_flags & AUVIA_FLAGS_VT8233) {
379 1.39 itojun snprintf(sc->sc_revision, sizeof(sc->sc_revision), "0x%02X", r);
380 1.34 martin switch(r) {
381 1.53 rpaulo case VIA_REV_8233PRE:
382 1.53 rpaulo /* same as 8233, but should not be in the market */
383 1.53 rpaulo revnum = "3-Pre";
384 1.53 rpaulo break;
385 1.34 martin case VIA_REV_8233C:
386 1.34 martin /* 2 rec, 4 pb, 1 multi-pb */
387 1.34 martin revnum = "3C";
388 1.34 martin break;
389 1.34 martin case VIA_REV_8233:
390 1.34 martin /* 2 rec, 4 pb, 1 multi-pb, spdif */
391 1.34 martin revnum = "3";
392 1.34 martin break;
393 1.34 martin case VIA_REV_8233A:
394 1.34 martin /* 1 rec, 1 multi-pb, spdif */
395 1.34 martin revnum = "3A";
396 1.34 martin break;
397 1.34 martin default:
398 1.36 xtraeme break;
399 1.22 kent }
400 1.49 xtraeme if (r >= VIA_REV_8237)
401 1.45 kent revnum = "7";
402 1.45 kent else if (r >= VIA_REV_8235) /* 2 rec, 4 pb, 1 multi-pb, spdif */
403 1.35 xtraeme revnum = "5";
404 1.38 jmmv aprint_normal(": VIA Technologies VT823%s AC'97 Audio "
405 1.38 jmmv "(rev %s)\n", revnum, sc->sc_revision);
406 1.1 tsarna } else {
407 1.22 kent sc->sc_revision[1] = '\0';
408 1.22 kent if (r == 0x20) {
409 1.22 kent sc->sc_revision[0] = 'H';
410 1.22 kent } else if ((r >= 0x10) && (r <= 0x14)) {
411 1.22 kent sc->sc_revision[0] = 'A' + (r - 0x10);
412 1.22 kent } else {
413 1.39 itojun snprintf(sc->sc_revision, sizeof(sc->sc_revision),
414 1.39 itojun "0x%02X", r);
415 1.22 kent }
416 1.22 kent
417 1.38 jmmv aprint_normal(": VIA Technologies VT82C686A AC'97 Audio "
418 1.38 jmmv "(rev %s)\n", sc->sc_revision);
419 1.1 tsarna }
420 1.1 tsarna
421 1.9 sommerfe if (pci_intr_map(pa, &ih)) {
422 1.29 thorpej aprint_error(": couldn't map interrupt\n");
423 1.63 dyoung bus_space_unmap(sc->sc_iot, sc->sc_ioh, sc->sc_iosize);
424 1.1 tsarna return;
425 1.1 tsarna }
426 1.1 tsarna intrstr = pci_intr_string(pc, ih);
427 1.1 tsarna
428 1.74 jmcneill mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_NONE);
429 1.75 mrg mutex_init(&sc->sc_intr_lock, MUTEX_DEFAULT, IPL_AUDIO);
430 1.74 jmcneill
431 1.75 mrg sc->sc_ih = pci_intr_establish(pc, ih, IPL_AUDIO, auvia_intr, sc);
432 1.1 tsarna if (sc->sc_ih == NULL) {
433 1.69 cegger aprint_error_dev(sc->sc_dev, "couldn't establish interrupt");
434 1.1 tsarna if (intrstr != NULL)
435 1.70 njoly aprint_error(" at %s", intrstr);
436 1.70 njoly aprint_error("\n");
437 1.63 dyoung bus_space_unmap(sc->sc_iot, sc->sc_ioh, sc->sc_iosize);
438 1.74 jmcneill mutex_destroy(&sc->sc_lock);
439 1.74 jmcneill mutex_destroy(&sc->sc_intr_lock);
440 1.1 tsarna return;
441 1.1 tsarna }
442 1.1 tsarna
443 1.69 cegger aprint_normal_dev(sc->sc_dev, "interrupting at %s\n", intrstr);
444 1.1 tsarna
445 1.1 tsarna /* disable SBPro compat & others */
446 1.1 tsarna pr = pci_conf_read(pc, pt, AUVIA_PCICONF_JUNK);
447 1.1 tsarna
448 1.1 tsarna pr &= ~AUVIA_PCICONF_ENABLES; /* clear compat function enables */
449 1.1 tsarna /* XXX what to do about MIDI, FM, joystick? */
450 1.1 tsarna
451 1.1 tsarna pr |= (AUVIA_PCICONF_ACLINKENAB | AUVIA_PCICONF_ACNOTRST
452 1.1 tsarna | AUVIA_PCICONF_ACVSR | AUVIA_PCICONF_ACSGD);
453 1.1 tsarna
454 1.1 tsarna pr &= ~(AUVIA_PCICONF_ACFM | AUVIA_PCICONF_ACSB);
455 1.1 tsarna
456 1.1 tsarna pci_conf_write(pc, pt, AUVIA_PCICONF_JUNK, pr);
457 1.1 tsarna
458 1.1 tsarna sc->host_if.arg = sc;
459 1.1 tsarna sc->host_if.attach = auvia_attach_codec;
460 1.1 tsarna sc->host_if.read = auvia_read_codec;
461 1.1 tsarna sc->host_if.write = auvia_write_codec;
462 1.1 tsarna sc->host_if.reset = auvia_reset_codec;
463 1.54 kent sc->host_if.spdif_event = auvia_spdif_event;
464 1.1 tsarna
465 1.74 jmcneill if ((r = ac97_attach(&sc->host_if, self, &sc->sc_lock)) != 0) {
466 1.69 cegger aprint_error_dev(sc->sc_dev, "can't attach codec (error 0x%X)\n", r);
467 1.22 kent pci_intr_disestablish(pc, sc->sc_ih);
468 1.63 dyoung bus_space_unmap(sc->sc_iot, sc->sc_ioh, sc->sc_iosize);
469 1.74 jmcneill mutex_destroy(&sc->sc_lock);
470 1.74 jmcneill mutex_destroy(&sc->sc_intr_lock);
471 1.1 tsarna return;
472 1.1 tsarna }
473 1.1 tsarna
474 1.48 kent /* setup audio_format */
475 1.48 kent memcpy(sc->sc_formats, auvia_formats, sizeof(auvia_formats));
476 1.74 jmcneill mutex_enter(&sc->sc_lock);
477 1.48 kent if (sc->sc_play.sc_base != VIA8233_MP_BASE || !AC97_IS_4CH(sc->codec_if)) {
478 1.48 kent AUFMT_INVALIDATE(&sc->sc_formats[AUVIA_FORMATS_4CH_8]);
479 1.48 kent AUFMT_INVALIDATE(&sc->sc_formats[AUVIA_FORMATS_4CH_16]);
480 1.48 kent }
481 1.48 kent if (sc->sc_play.sc_base != VIA8233_MP_BASE || !AC97_IS_6CH(sc->codec_if)) {
482 1.48 kent AUFMT_INVALIDATE(&sc->sc_formats[AUVIA_FORMATS_6CH_8]);
483 1.48 kent AUFMT_INVALIDATE(&sc->sc_formats[AUVIA_FORMATS_6CH_16]);
484 1.48 kent }
485 1.48 kent if (AC97_IS_FIXED_RATE(sc->codec_if)) {
486 1.48 kent for (r = 0; r < AUVIA_NFORMATS; r++) {
487 1.48 kent sc->sc_formats[r].frequency_type = 1;
488 1.48 kent sc->sc_formats[r].frequency[0] = 48000;
489 1.48 kent }
490 1.48 kent }
491 1.74 jmcneill mutex_exit(&sc->sc_lock);
492 1.48 kent
493 1.48 kent if (0 != auconv_create_encodings(sc->sc_formats, AUVIA_NFORMATS,
494 1.48 kent &sc->sc_encodings)) {
495 1.74 jmcneill mutex_enter(&sc->sc_lock);
496 1.48 kent sc->codec_if->vtbl->detach(sc->codec_if);
497 1.74 jmcneill mutex_exit(&sc->sc_lock);
498 1.48 kent pci_intr_disestablish(pc, sc->sc_ih);
499 1.63 dyoung bus_space_unmap(sc->sc_iot, sc->sc_ioh, sc->sc_iosize);
500 1.74 jmcneill mutex_destroy(&sc->sc_lock);
501 1.74 jmcneill mutex_destroy(&sc->sc_intr_lock);
502 1.69 cegger aprint_error_dev(sc->sc_dev, "can't create encodings\n");
503 1.48 kent return;
504 1.48 kent }
505 1.54 kent if (0 != auconv_create_encodings(auvia_spdif_formats,
506 1.54 kent AUVIA_SPDIF_NFORMATS, &sc->sc_spdif_encodings)) {
507 1.74 jmcneill mutex_enter(&sc->sc_lock);
508 1.54 kent sc->codec_if->vtbl->detach(sc->codec_if);
509 1.74 jmcneill mutex_exit(&sc->sc_lock);
510 1.54 kent pci_intr_disestablish(pc, sc->sc_ih);
511 1.63 dyoung bus_space_unmap(sc->sc_iot, sc->sc_ioh, sc->sc_iosize);
512 1.74 jmcneill mutex_destroy(&sc->sc_lock);
513 1.74 jmcneill mutex_destroy(&sc->sc_intr_lock);
514 1.69 cegger aprint_error_dev(sc->sc_dev, "can't create spdif encodings\n");
515 1.54 kent return;
516 1.54 kent }
517 1.48 kent
518 1.61 jmcneill if (!pmf_device_register(self, NULL, auvia_resume))
519 1.61 jmcneill aprint_error_dev(self, "couldn't establish power handler\n");
520 1.43 kent
521 1.69 cegger audio_attach_mi(&auvia_hw_if, sc, sc->sc_dev);
522 1.74 jmcneill mutex_enter(&sc->sc_lock);
523 1.54 kent sc->codec_if->vtbl->unlock(sc->codec_if);
524 1.74 jmcneill mutex_exit(&sc->sc_lock);
525 1.48 kent return;
526 1.1 tsarna }
527 1.1 tsarna
528 1.52 thorpej static int
529 1.1 tsarna auvia_attach_codec(void *addr, struct ac97_codec_if *cif)
530 1.1 tsarna {
531 1.51 kent struct auvia_softc *sc;
532 1.1 tsarna
533 1.51 kent sc = addr;
534 1.1 tsarna sc->codec_if = cif;
535 1.1 tsarna return 0;
536 1.1 tsarna }
537 1.1 tsarna
538 1.52 thorpej static int
539 1.1 tsarna auvia_reset_codec(void *addr)
540 1.1 tsarna {
541 1.51 kent struct auvia_softc *sc;
542 1.51 kent pcireg_t r;
543 1.32 jmmv int i;
544 1.1 tsarna
545 1.1 tsarna /* perform a codec cold reset */
546 1.51 kent sc = addr;
547 1.1 tsarna r = pci_conf_read(sc->sc_pc, sc->sc_pt, AUVIA_PCICONF_JUNK);
548 1.1 tsarna
549 1.1 tsarna r &= ~AUVIA_PCICONF_ACNOTRST; /* enable RESET (active low) */
550 1.1 tsarna pci_conf_write(sc->sc_pc, sc->sc_pt, AUVIA_PCICONF_JUNK, r);
551 1.1 tsarna delay(2);
552 1.1 tsarna
553 1.22 kent r |= AUVIA_PCICONF_ACNOTRST; /* disable RESET (inactive high) */
554 1.1 tsarna pci_conf_write(sc->sc_pc, sc->sc_pt, AUVIA_PCICONF_JUNK, r);
555 1.1 tsarna delay(200);
556 1.1 tsarna
557 1.32 jmmv for (i = 500000; i != 0 && !(pci_conf_read(sc->sc_pc, sc->sc_pt,
558 1.32 jmmv AUVIA_PCICONF_JUNK) & AUVIA_PCICONF_PRIVALID); i--)
559 1.32 jmmv DELAY(1);
560 1.42 kent if (i == 0) {
561 1.69 cegger printf("%s: codec reset timed out\n", device_xname(sc->sc_dev));
562 1.42 kent return ETIMEDOUT;
563 1.42 kent }
564 1.42 kent return 0;
565 1.1 tsarna }
566 1.1 tsarna
567 1.52 thorpej static int
568 1.1 tsarna auvia_waitready_codec(struct auvia_softc *sc)
569 1.1 tsarna {
570 1.1 tsarna int i;
571 1.1 tsarna
572 1.1 tsarna /* poll until codec not busy */
573 1.1 tsarna for (i = 0; (i < TIMEOUT) && (bus_space_read_4(sc->sc_iot, sc->sc_ioh,
574 1.1 tsarna AUVIA_CODEC_CTL) & AUVIA_CODEC_BUSY); i++)
575 1.1 tsarna delay(1);
576 1.1 tsarna if (i >= TIMEOUT) {
577 1.69 cegger printf("%s: codec busy\n", device_xname(sc->sc_dev));
578 1.1 tsarna return 1;
579 1.1 tsarna }
580 1.1 tsarna
581 1.1 tsarna return 0;
582 1.1 tsarna }
583 1.1 tsarna
584 1.52 thorpej static int
585 1.1 tsarna auvia_waitvalid_codec(struct auvia_softc *sc)
586 1.1 tsarna {
587 1.1 tsarna int i;
588 1.1 tsarna
589 1.1 tsarna /* poll until codec valid */
590 1.1 tsarna for (i = 0; (i < TIMEOUT) && !(bus_space_read_4(sc->sc_iot, sc->sc_ioh,
591 1.1 tsarna AUVIA_CODEC_CTL) & AUVIA_CODEC_PRIVALID); i++)
592 1.1 tsarna delay(1);
593 1.1 tsarna if (i >= TIMEOUT) {
594 1.69 cegger printf("%s: codec invalid\n", device_xname(sc->sc_dev));
595 1.1 tsarna return 1;
596 1.1 tsarna }
597 1.1 tsarna
598 1.1 tsarna return 0;
599 1.1 tsarna }
600 1.1 tsarna
601 1.52 thorpej static int
602 1.1 tsarna auvia_write_codec(void *addr, u_int8_t reg, u_int16_t val)
603 1.1 tsarna {
604 1.51 kent struct auvia_softc *sc;
605 1.1 tsarna
606 1.51 kent sc = addr;
607 1.1 tsarna if (auvia_waitready_codec(sc))
608 1.1 tsarna return 1;
609 1.1 tsarna
610 1.1 tsarna bus_space_write_4(sc->sc_iot, sc->sc_ioh, AUVIA_CODEC_CTL,
611 1.1 tsarna AUVIA_CODEC_PRIVALID | AUVIA_CODEC_INDEX(reg) | val);
612 1.1 tsarna
613 1.1 tsarna return 0;
614 1.1 tsarna }
615 1.1 tsarna
616 1.52 thorpej static int
617 1.1 tsarna auvia_read_codec(void *addr, u_int8_t reg, u_int16_t *val)
618 1.1 tsarna {
619 1.51 kent struct auvia_softc *sc;
620 1.1 tsarna
621 1.51 kent sc = addr;
622 1.1 tsarna if (auvia_waitready_codec(sc))
623 1.1 tsarna return 1;
624 1.1 tsarna
625 1.1 tsarna bus_space_write_4(sc->sc_iot, sc->sc_ioh, AUVIA_CODEC_CTL,
626 1.1 tsarna AUVIA_CODEC_PRIVALID | AUVIA_CODEC_READ | AUVIA_CODEC_INDEX(reg));
627 1.1 tsarna
628 1.1 tsarna if (auvia_waitready_codec(sc))
629 1.1 tsarna return 1;
630 1.1 tsarna
631 1.1 tsarna if (auvia_waitvalid_codec(sc))
632 1.1 tsarna return 1;
633 1.1 tsarna
634 1.1 tsarna *val = bus_space_read_2(sc->sc_iot, sc->sc_ioh, AUVIA_CODEC_CTL);
635 1.1 tsarna
636 1.1 tsarna return 0;
637 1.1 tsarna }
638 1.1 tsarna
639 1.54 kent static void
640 1.59 thorpej auvia_spdif_event(void *addr, bool flag)
641 1.54 kent {
642 1.54 kent struct auvia_softc *sc;
643 1.54 kent
644 1.54 kent sc = addr;
645 1.54 kent sc->sc_spdif = flag;
646 1.54 kent }
647 1.54 kent
648 1.54 kent static int
649 1.58 christos auvia_open(void *addr, int flags)
650 1.54 kent {
651 1.54 kent struct auvia_softc *sc;
652 1.54 kent
653 1.54 kent sc = (struct auvia_softc *)addr;
654 1.74 jmcneill mutex_spin_exit(&sc->sc_intr_lock);
655 1.54 kent sc->codec_if->vtbl->lock(sc->codec_if);
656 1.74 jmcneill mutex_spin_enter(&sc->sc_intr_lock);
657 1.54 kent return 0;
658 1.54 kent }
659 1.54 kent
660 1.54 kent static void
661 1.54 kent auvia_close(void *addr)
662 1.54 kent {
663 1.54 kent struct auvia_softc *sc;
664 1.54 kent
665 1.54 kent sc = (struct auvia_softc *)addr;
666 1.74 jmcneill mutex_spin_exit(&sc->sc_intr_lock);
667 1.54 kent sc->codec_if->vtbl->unlock(sc->codec_if);
668 1.74 jmcneill mutex_spin_enter(&sc->sc_intr_lock);
669 1.54 kent }
670 1.54 kent
671 1.52 thorpej static int
672 1.1 tsarna auvia_query_encoding(void *addr, struct audio_encoding *fp)
673 1.1 tsarna {
674 1.48 kent struct auvia_softc *sc;
675 1.48 kent
676 1.48 kent sc = (struct auvia_softc *)addr;
677 1.54 kent return auconv_query_encoding(
678 1.54 kent sc->sc_spdif ? sc->sc_spdif_encodings : sc->sc_encodings, fp);
679 1.1 tsarna }
680 1.1 tsarna
681 1.52 thorpej static void
682 1.27 kent auvia_set_params_sub(struct auvia_softc *sc, struct auvia_softc_chan *ch,
683 1.50 kent const audio_params_t *p)
684 1.27 kent {
685 1.51 kent uint32_t v;
686 1.51 kent uint16_t regval;
687 1.27 kent
688 1.27 kent if (!(sc->sc_flags & AUVIA_FLAGS_VT8233)) {
689 1.50 kent regval = (p->channels == 2 ? AUVIA_RPMODE_STEREO : 0)
690 1.50 kent | (p->precision == 16 ?
691 1.27 kent AUVIA_RPMODE_16BIT : 0)
692 1.27 kent | AUVIA_RPMODE_INTR_FLAG | AUVIA_RPMODE_INTR_EOL
693 1.27 kent | AUVIA_RPMODE_AUTOSTART;
694 1.27 kent ch->sc_reg = regval;
695 1.27 kent } else if (ch->sc_base != VIA8233_MP_BASE) {
696 1.27 kent v = CH_READ4(sc, ch, VIA8233_RP_RATEFMT);
697 1.27 kent v &= ~(VIA8233_RATEFMT_48K | VIA8233_RATEFMT_STEREO
698 1.27 kent | VIA8233_RATEFMT_16BIT);
699 1.27 kent
700 1.50 kent v |= VIA8233_RATEFMT_48K * (p->sample_rate / 20)
701 1.27 kent / (48000 / 20);
702 1.50 kent if (p->channels == 2)
703 1.27 kent v |= VIA8233_RATEFMT_STEREO;
704 1.50 kent if (p->precision == 16)
705 1.27 kent v |= VIA8233_RATEFMT_16BIT;
706 1.27 kent
707 1.27 kent CH_WRITE4(sc, ch, VIA8233_RP_RATEFMT, v);
708 1.27 kent } else {
709 1.27 kent static const u_int32_t slottab[7] =
710 1.27 kent { 0, 0xff000011, 0xff000021, 0,
711 1.27 kent 0xff004321, 0, 0xff436521};
712 1.27 kent
713 1.50 kent regval = (p->precision == 16
714 1.27 kent ? VIA8233_MP_FORMAT_16BIT : VIA8233_MP_FORMAT_8BIT)
715 1.50 kent | (p->channels << 4);
716 1.27 kent CH_WRITE1(sc, ch, VIA8233_OFF_MP_FORMAT, regval);
717 1.50 kent CH_WRITE4(sc, ch, VIA8233_OFF_MP_STOP, slottab[p->channels]);
718 1.27 kent }
719 1.27 kent }
720 1.1 tsarna
721 1.52 thorpej static int
722 1.58 christos auvia_set_params(void *addr, int setmode, int usemode,
723 1.57 christos audio_params_t *play, audio_params_t *rec, stream_filter_list_t *pfil,
724 1.57 christos stream_filter_list_t *rfil)
725 1.1 tsarna {
726 1.51 kent struct auvia_softc *sc;
727 1.27 kent struct auvia_softc_chan *ch;
728 1.1 tsarna struct audio_params *p;
729 1.27 kent struct ac97_codec_if* codec;
730 1.50 kent stream_filter_list_t *fil;
731 1.27 kent int reg, mode;
732 1.48 kent int index;
733 1.1 tsarna
734 1.51 kent sc = addr;
735 1.27 kent codec = sc->codec_if;
736 1.1 tsarna /* for mode in (RECORD, PLAY) */
737 1.22 kent for (mode = AUMODE_RECORD; mode != -1;
738 1.1 tsarna mode = mode == AUMODE_RECORD ? AUMODE_PLAY : -1) {
739 1.1 tsarna if ((setmode & mode) == 0)
740 1.1 tsarna continue;
741 1.1 tsarna
742 1.22 kent if (mode == AUMODE_PLAY ) {
743 1.22 kent p = play;
744 1.27 kent ch = &sc->sc_play;
745 1.28 kent reg = AC97_REG_PCM_FRONT_DAC_RATE;
746 1.50 kent fil = pfil;
747 1.22 kent } else {
748 1.22 kent p = rec;
749 1.27 kent ch = &sc->sc_record;
750 1.28 kent reg = AC97_REG_PCM_LR_ADC_RATE;
751 1.50 kent fil = rfil;
752 1.22 kent }
753 1.22 kent
754 1.1 tsarna if (p->sample_rate < 4000 || p->sample_rate > 48000 ||
755 1.27 kent (p->precision != 8 && p->precision != 16))
756 1.1 tsarna return (EINVAL);
757 1.54 kent if (sc->sc_spdif)
758 1.54 kent index = auconv_set_converter(auvia_spdif_formats,
759 1.54 kent AUVIA_SPDIF_NFORMATS, mode, p, TRUE, fil);
760 1.54 kent else
761 1.54 kent index = auconv_set_converter(sc->sc_formats,
762 1.54 kent AUVIA_NFORMATS, mode, p, TRUE, fil);
763 1.48 kent if (index < 0)
764 1.48 kent return EINVAL;
765 1.50 kent if (fil->req_size > 0)
766 1.50 kent p = &fil->filters[0].param;
767 1.48 kent if (!AC97_IS_FIXED_RATE(codec)) {
768 1.50 kent if (codec->vtbl->set_rate(codec, reg, &p->sample_rate))
769 1.48 kent return EINVAL;
770 1.27 kent reg = AC97_REG_PCM_SURR_DAC_RATE;
771 1.50 kent if (p->channels >= 4
772 1.27 kent && codec->vtbl->set_rate(codec, reg,
773 1.50 kent &p->sample_rate))
774 1.48 kent return EINVAL;
775 1.27 kent reg = AC97_REG_PCM_LFE_DAC_RATE;
776 1.50 kent if (p->channels == 6
777 1.27 kent && codec->vtbl->set_rate(codec, reg,
778 1.50 kent &p->sample_rate))
779 1.48 kent return EINVAL;
780 1.1 tsarna }
781 1.27 kent auvia_set_params_sub(sc, ch, p);
782 1.1 tsarna }
783 1.1 tsarna
784 1.1 tsarna return 0;
785 1.1 tsarna }
786 1.1 tsarna
787 1.52 thorpej static int
788 1.50 kent auvia_round_blocksize(void *addr, int blk,
789 1.58 christos int mode, const audio_params_t *param)
790 1.1 tsarna {
791 1.51 kent struct auvia_softc *sc;
792 1.37 jmcneill
793 1.51 kent sc = addr;
794 1.74 jmcneill
795 1.37 jmcneill /* XXX VT823x might have the limitation of dma_ops size */
796 1.37 jmcneill if (sc->sc_flags & AUVIA_FLAGS_VT8233 && blk < 288)
797 1.37 jmcneill blk = 288;
798 1.37 jmcneill
799 1.74 jmcneill /* Avoid too many dma_ops. */
800 1.74 jmcneill return min((blk & -32), AUVIA_MINBLKSZ);
801 1.1 tsarna }
802 1.1 tsarna
803 1.52 thorpej static int
804 1.1 tsarna auvia_halt_output(void *addr)
805 1.1 tsarna {
806 1.51 kent struct auvia_softc *sc;
807 1.51 kent struct auvia_softc_chan *ch;
808 1.1 tsarna
809 1.51 kent sc = addr;
810 1.51 kent ch = &(sc->sc_play);
811 1.27 kent CH_WRITE1(sc, ch, AUVIA_RP_CONTROL, AUVIA_RPCTRL_TERMINATE);
812 1.41 mycroft ch->sc_intr = NULL;
813 1.1 tsarna return 0;
814 1.1 tsarna }
815 1.1 tsarna
816 1.52 thorpej static int
817 1.1 tsarna auvia_halt_input(void *addr)
818 1.1 tsarna {
819 1.51 kent struct auvia_softc *sc;
820 1.51 kent struct auvia_softc_chan *ch;
821 1.1 tsarna
822 1.51 kent sc = addr;
823 1.51 kent ch = &(sc->sc_record);
824 1.27 kent CH_WRITE1(sc, ch, AUVIA_RP_CONTROL, AUVIA_RPCTRL_TERMINATE);
825 1.41 mycroft ch->sc_intr = NULL;
826 1.1 tsarna return 0;
827 1.1 tsarna }
828 1.1 tsarna
829 1.52 thorpej static int
830 1.1 tsarna auvia_getdev(void *addr, struct audio_device *retp)
831 1.1 tsarna {
832 1.51 kent struct auvia_softc *sc;
833 1.1 tsarna
834 1.1 tsarna if (retp) {
835 1.51 kent sc = addr;
836 1.22 kent if (sc->sc_flags & AUVIA_FLAGS_VT8233) {
837 1.45 kent strncpy(retp->name, "VIA VT823x",
838 1.22 kent sizeof(retp->name));
839 1.22 kent } else {
840 1.22 kent strncpy(retp->name, "VIA VT82C686A",
841 1.22 kent sizeof(retp->name));
842 1.22 kent }
843 1.1 tsarna strncpy(retp->version, sc->sc_revision, sizeof(retp->version));
844 1.1 tsarna strncpy(retp->config, "auvia", sizeof(retp->config));
845 1.1 tsarna }
846 1.1 tsarna
847 1.1 tsarna return 0;
848 1.1 tsarna }
849 1.1 tsarna
850 1.52 thorpej static int
851 1.1 tsarna auvia_set_port(void *addr, mixer_ctrl_t *cp)
852 1.1 tsarna {
853 1.51 kent struct auvia_softc *sc;
854 1.1 tsarna
855 1.51 kent sc = addr;
856 1.51 kent return sc->codec_if->vtbl->mixer_set_port(sc->codec_if, cp);
857 1.1 tsarna }
858 1.1 tsarna
859 1.52 thorpej static int
860 1.1 tsarna auvia_get_port(void *addr, mixer_ctrl_t *cp)
861 1.1 tsarna {
862 1.51 kent struct auvia_softc *sc;
863 1.1 tsarna
864 1.51 kent sc = addr;
865 1.51 kent return sc->codec_if->vtbl->mixer_get_port(sc->codec_if, cp);
866 1.1 tsarna }
867 1.1 tsarna
868 1.52 thorpej static int
869 1.1 tsarna auvia_query_devinfo(void *addr, mixer_devinfo_t *dip)
870 1.1 tsarna {
871 1.51 kent struct auvia_softc *sc;
872 1.1 tsarna
873 1.51 kent sc = addr;
874 1.51 kent return sc->codec_if->vtbl->query_devinfo(sc->codec_if, dip);
875 1.1 tsarna }
876 1.1 tsarna
877 1.74 jmcneill static int
878 1.74 jmcneill auvia_malloc_channel(struct auvia_softc *sc, struct auvia_softc_chan *ch,
879 1.74 jmcneill size_t size)
880 1.74 jmcneill {
881 1.74 jmcneill struct auvia_dma *dp;
882 1.74 jmcneill int segs;
883 1.74 jmcneill
884 1.74 jmcneill /* if old list is large enough, nothing to do */
885 1.74 jmcneill segs = (size + AUVIA_MINBLKSZ - 1) / AUVIA_MINBLKSZ;
886 1.74 jmcneill if (segs <= ch->sc_dma_op_count) {
887 1.74 jmcneill return 0;
888 1.74 jmcneill }
889 1.74 jmcneill
890 1.74 jmcneill if (ch->sc_dma_ops) {
891 1.74 jmcneill auvia_free(sc, ch->sc_dma_ops,
892 1.74 jmcneill ch->sc_dma_op_count * sizeof(*dp));
893 1.74 jmcneill }
894 1.74 jmcneill
895 1.74 jmcneill ch->sc_dma_ops = auvia_malloc_dmamem(sc, 0,
896 1.74 jmcneill sizeof(struct auvia_dma_op) * segs);
897 1.74 jmcneill
898 1.74 jmcneill if (ch->sc_dma_ops == NULL) {
899 1.74 jmcneill aprint_error_dev(sc->sc_dev, "couldn't build dmaops\n");
900 1.74 jmcneill return ENOMEM;
901 1.74 jmcneill }
902 1.74 jmcneill
903 1.74 jmcneill for (dp = sc->sc_dmas;
904 1.74 jmcneill dp && dp->addr != (void *)(ch->sc_dma_ops);
905 1.74 jmcneill dp = dp->next)
906 1.74 jmcneill continue;
907 1.74 jmcneill
908 1.74 jmcneill if (!dp)
909 1.74 jmcneill panic("%s: build_dma_ops: where'd my memory go??? "
910 1.74 jmcneill "address (%p)\n", device_xname(sc->sc_dev),
911 1.74 jmcneill ch->sc_dma_ops);
912 1.74 jmcneill
913 1.74 jmcneill ch->sc_dma_op_count = segs;
914 1.74 jmcneill ch->sc_dma_ops_dma = dp;
915 1.74 jmcneill
916 1.74 jmcneill return 0;
917 1.74 jmcneill }
918 1.74 jmcneill
919 1.52 thorpej static void *
920 1.74 jmcneill auvia_malloc_dmamem(void *addr, int direction, size_t size)
921 1.1 tsarna {
922 1.51 kent struct auvia_softc *sc;
923 1.1 tsarna struct auvia_dma *p;
924 1.1 tsarna int error;
925 1.1 tsarna int rseg;
926 1.1 tsarna
927 1.74 jmcneill p = kmem_alloc(sizeof(*p), KM_SLEEP);
928 1.74 jmcneill if (p == NULL)
929 1.74 jmcneill return NULL;
930 1.51 kent sc = addr;
931 1.2 tsarna p->size = size;
932 1.6 thorpej if ((error = bus_dmamem_alloc(sc->sc_dmat, size, PAGE_SIZE, 0, &p->seg,
933 1.74 jmcneill 1, &rseg, BUS_DMA_WAITOK)) != 0) {
934 1.69 cegger aprint_error_dev(sc->sc_dev, "unable to allocate DMA, error = %d\n", error);
935 1.1 tsarna goto fail_alloc;
936 1.1 tsarna }
937 1.1 tsarna
938 1.1 tsarna if ((error = bus_dmamem_map(sc->sc_dmat, &p->seg, rseg, size, &p->addr,
939 1.74 jmcneill BUS_DMA_WAITOK | BUS_DMA_COHERENT)) != 0) {
940 1.69 cegger aprint_error_dev(sc->sc_dev, "unable to map DMA, error = %d\n",
941 1.64 cegger error);
942 1.1 tsarna goto fail_map;
943 1.1 tsarna }
944 1.1 tsarna
945 1.22 kent if ((error = bus_dmamap_create(sc->sc_dmat, size, 1, size, 0,
946 1.74 jmcneill BUS_DMA_WAITOK, &p->map)) != 0) {
947 1.69 cegger aprint_error_dev(sc->sc_dev, "unable to create DMA map, error = %d\n",
948 1.64 cegger error);
949 1.1 tsarna goto fail_create;
950 1.1 tsarna }
951 1.1 tsarna
952 1.1 tsarna if ((error = bus_dmamap_load(sc->sc_dmat, p->map, p->addr, size, NULL,
953 1.74 jmcneill BUS_DMA_WAITOK)) != 0) {
954 1.69 cegger aprint_error_dev(sc->sc_dev, "unable to load DMA map, error = %d\n",
955 1.64 cegger error);
956 1.1 tsarna goto fail_load;
957 1.1 tsarna }
958 1.1 tsarna
959 1.1 tsarna p->next = sc->sc_dmas;
960 1.1 tsarna sc->sc_dmas = p;
961 1.1 tsarna
962 1.1 tsarna return p->addr;
963 1.1 tsarna
964 1.1 tsarna fail_load:
965 1.1 tsarna bus_dmamap_destroy(sc->sc_dmat, p->map);
966 1.1 tsarna fail_create:
967 1.1 tsarna bus_dmamem_unmap(sc->sc_dmat, p->addr, size);
968 1.1 tsarna fail_map:
969 1.1 tsarna bus_dmamem_free(sc->sc_dmat, &p->seg, 1);
970 1.1 tsarna fail_alloc:
971 1.74 jmcneill kmem_free(p, sizeof(*p));
972 1.51 kent return NULL;
973 1.1 tsarna }
974 1.1 tsarna
975 1.74 jmcneill static void *
976 1.74 jmcneill auvia_malloc(void *addr, int direction, size_t size)
977 1.74 jmcneill {
978 1.74 jmcneill struct auvia_softc *sc;
979 1.74 jmcneill void *p;
980 1.74 jmcneill
981 1.74 jmcneill sc = addr;
982 1.74 jmcneill
983 1.74 jmcneill p = auvia_malloc_dmamem(addr, direction, size);
984 1.74 jmcneill if (p == NULL) {
985 1.74 jmcneill return NULL;
986 1.74 jmcneill }
987 1.74 jmcneill if (auvia_malloc_channel(sc, &sc->sc_play, size) != 0) {
988 1.74 jmcneill auvia_free(addr, p, size);
989 1.74 jmcneill return NULL;
990 1.74 jmcneill }
991 1.74 jmcneill if (auvia_malloc_channel(sc, &sc->sc_record, size) != 0) {
992 1.74 jmcneill auvia_free(addr, p, size);
993 1.74 jmcneill return NULL;
994 1.74 jmcneill }
995 1.74 jmcneill return p;
996 1.74 jmcneill }
997 1.74 jmcneill
998 1.52 thorpej static void
999 1.74 jmcneill auvia_free(void *addr, void *ptr, size_t size)
1000 1.1 tsarna {
1001 1.51 kent struct auvia_softc *sc;
1002 1.2 tsarna struct auvia_dma **pp, *p;
1003 1.1 tsarna
1004 1.51 kent sc = addr;
1005 1.2 tsarna for (pp = &(sc->sc_dmas); (p = *pp) != NULL; pp = &p->next)
1006 1.2 tsarna if (p->addr == ptr) {
1007 1.2 tsarna bus_dmamap_unload(sc->sc_dmat, p->map);
1008 1.2 tsarna bus_dmamap_destroy(sc->sc_dmat, p->map);
1009 1.2 tsarna bus_dmamem_unmap(sc->sc_dmat, p->addr, p->size);
1010 1.2 tsarna bus_dmamem_free(sc->sc_dmat, &p->seg, 1);
1011 1.22 kent
1012 1.2 tsarna *pp = p->next;
1013 1.74 jmcneill kmem_free(p, sizeof(*p));
1014 1.2 tsarna return;
1015 1.2 tsarna }
1016 1.1 tsarna
1017 1.2 tsarna panic("auvia_free: trying to free unallocated memory");
1018 1.1 tsarna }
1019 1.1 tsarna
1020 1.52 thorpej static size_t
1021 1.58 christos auvia_round_buffersize(void *addr, int direction, size_t size)
1022 1.1 tsarna {
1023 1.51 kent
1024 1.1 tsarna return size;
1025 1.1 tsarna }
1026 1.1 tsarna
1027 1.52 thorpej static paddr_t
1028 1.4 simonb auvia_mappage(void *addr, void *mem, off_t off, int prot)
1029 1.1 tsarna {
1030 1.51 kent struct auvia_softc *sc;
1031 1.1 tsarna struct auvia_dma *p;
1032 1.1 tsarna
1033 1.1 tsarna if (off < 0)
1034 1.1 tsarna return -1;
1035 1.51 kent sc = addr;
1036 1.1 tsarna for (p = sc->sc_dmas; p && p->addr != mem; p = p->next)
1037 1.51 kent continue;
1038 1.1 tsarna
1039 1.1 tsarna if (!p)
1040 1.1 tsarna return -1;
1041 1.1 tsarna
1042 1.22 kent return bus_dmamem_mmap(sc->sc_dmat, &p->seg, 1, off, prot,
1043 1.51 kent BUS_DMA_WAITOK);
1044 1.1 tsarna }
1045 1.1 tsarna
1046 1.52 thorpej static int
1047 1.1 tsarna auvia_get_props(void *addr)
1048 1.1 tsarna {
1049 1.51 kent struct auvia_softc *sc;
1050 1.26 kent int props;
1051 1.26 kent
1052 1.26 kent props = AUDIO_PROP_INDEPENDENT | AUDIO_PROP_FULLDUPLEX;
1053 1.51 kent sc = addr;
1054 1.26 kent /*
1055 1.26 kent * Even if the codec is fixed-rate, set_param() succeeds for any sample
1056 1.26 kent * rate because of aurateconv. Applications can't know what rate the
1057 1.26 kent * device can process in the case of mmap().
1058 1.26 kent */
1059 1.46 kent if (!AC97_IS_FIXED_RATE(sc->codec_if))
1060 1.26 kent props |= AUDIO_PROP_MMAP;
1061 1.26 kent return props;
1062 1.1 tsarna }
1063 1.1 tsarna
1064 1.74 jmcneill static void
1065 1.74 jmcneill auvia_get_locks(void *addr, kmutex_t **intr, kmutex_t **thread)
1066 1.74 jmcneill {
1067 1.74 jmcneill struct auvia_softc *sc;
1068 1.74 jmcneill
1069 1.74 jmcneill sc = addr;
1070 1.74 jmcneill *intr = &sc->sc_intr_lock;
1071 1.74 jmcneill *thread = &sc->sc_lock;
1072 1.74 jmcneill }
1073 1.74 jmcneill
1074 1.52 thorpej static int
1075 1.1 tsarna auvia_build_dma_ops(struct auvia_softc *sc, struct auvia_softc_chan *ch,
1076 1.1 tsarna struct auvia_dma *p, void *start, void *end, int blksize)
1077 1.1 tsarna {
1078 1.1 tsarna struct auvia_dma_op *op;
1079 1.1 tsarna struct auvia_dma *dp;
1080 1.33 simonb bus_addr_t s;
1081 1.1 tsarna size_t l;
1082 1.1 tsarna
1083 1.74 jmcneill dp = ch->sc_dma_ops_dma;
1084 1.74 jmcneill op = ch->sc_dma_ops;
1085 1.1 tsarna s = p->map->dm_segs[0].ds_addr;
1086 1.1 tsarna l = ((char *)end - (char *)start);
1087 1.1 tsarna
1088 1.1 tsarna while (l) {
1089 1.62 tsutsui op->ptr = htole32(s);
1090 1.1 tsarna l = l - blksize;
1091 1.1 tsarna if (!l) {
1092 1.1 tsarna /* if last block */
1093 1.62 tsutsui op->flags = htole32(AUVIA_DMAOP_EOL | blksize);
1094 1.1 tsarna } else {
1095 1.62 tsutsui op->flags = htole32(AUVIA_DMAOP_FLAG | blksize);
1096 1.1 tsarna }
1097 1.1 tsarna s += blksize;
1098 1.1 tsarna op++;
1099 1.1 tsarna }
1100 1.1 tsarna
1101 1.1 tsarna return 0;
1102 1.1 tsarna }
1103 1.1 tsarna
1104 1.1 tsarna
1105 1.52 thorpej static int
1106 1.57 christos auvia_trigger_output(void *addr, void *start, void *end, int blksize,
1107 1.58 christos void (*intr)(void *), void *arg, const audio_params_t *param)
1108 1.1 tsarna {
1109 1.51 kent struct auvia_softc *sc;
1110 1.51 kent struct auvia_softc_chan *ch;
1111 1.1 tsarna struct auvia_dma *p;
1112 1.1 tsarna
1113 1.51 kent sc = addr;
1114 1.51 kent ch = &(sc->sc_play);
1115 1.1 tsarna for (p = sc->sc_dmas; p && p->addr != start; p = p->next)
1116 1.51 kent continue;
1117 1.1 tsarna
1118 1.1 tsarna if (!p)
1119 1.1 tsarna panic("auvia_trigger_output: request with bad start "
1120 1.18 provos "address (%p)", start);
1121 1.1 tsarna
1122 1.1 tsarna if (auvia_build_dma_ops(sc, ch, p, start, end, blksize)) {
1123 1.1 tsarna return 1;
1124 1.1 tsarna }
1125 1.1 tsarna
1126 1.1 tsarna ch->sc_intr = intr;
1127 1.1 tsarna ch->sc_arg = arg;
1128 1.1 tsarna
1129 1.27 kent CH_WRITE4(sc, ch, AUVIA_RP_DMAOPS_BASE,
1130 1.1 tsarna ch->sc_dma_ops_dma->map->dm_segs[0].ds_addr);
1131 1.1 tsarna
1132 1.22 kent if (sc->sc_flags & AUVIA_FLAGS_VT8233) {
1133 1.27 kent if (ch->sc_base != VIA8233_MP_BASE) {
1134 1.27 kent CH_WRITE1(sc, ch, VIA8233_RP_DXS_LVOL, 0);
1135 1.27 kent CH_WRITE1(sc, ch, VIA8233_RP_DXS_RVOL, 0);
1136 1.27 kent }
1137 1.27 kent CH_WRITE1(sc, ch, AUVIA_RP_CONTROL,
1138 1.22 kent AUVIA_RPCTRL_START | AUVIA_RPCTRL_AUTOSTART |
1139 1.22 kent AUVIA_RPCTRL_STOP | AUVIA_RPCTRL_EOL | AUVIA_RPCTRL_FLAG);
1140 1.24 kent } else {
1141 1.27 kent CH_WRITE1(sc, ch, AUVIA_RP_MODE, ch->sc_reg);
1142 1.27 kent CH_WRITE1(sc, ch, AUVIA_RP_CONTROL, AUVIA_RPCTRL_START);
1143 1.24 kent }
1144 1.1 tsarna
1145 1.1 tsarna return 0;
1146 1.1 tsarna }
1147 1.1 tsarna
1148 1.52 thorpej static int
1149 1.57 christos auvia_trigger_input(void *addr, void *start, void *end, int blksize,
1150 1.58 christos void (*intr)(void *), void *arg, const audio_params_t *param)
1151 1.1 tsarna {
1152 1.51 kent struct auvia_softc *sc;
1153 1.51 kent struct auvia_softc_chan *ch;
1154 1.1 tsarna struct auvia_dma *p;
1155 1.1 tsarna
1156 1.51 kent sc = addr;
1157 1.51 kent ch = &(sc->sc_record);
1158 1.1 tsarna for (p = sc->sc_dmas; p && p->addr != start; p = p->next)
1159 1.51 kent continue;
1160 1.1 tsarna
1161 1.1 tsarna if (!p)
1162 1.1 tsarna panic("auvia_trigger_input: request with bad start "
1163 1.18 provos "address (%p)", start);
1164 1.1 tsarna
1165 1.1 tsarna if (auvia_build_dma_ops(sc, ch, p, start, end, blksize)) {
1166 1.1 tsarna return 1;
1167 1.1 tsarna }
1168 1.1 tsarna
1169 1.1 tsarna ch->sc_intr = intr;
1170 1.1 tsarna ch->sc_arg = arg;
1171 1.1 tsarna
1172 1.27 kent CH_WRITE4(sc, ch, AUVIA_RP_DMAOPS_BASE,
1173 1.27 kent ch->sc_dma_ops_dma->map->dm_segs[0].ds_addr);
1174 1.1 tsarna
1175 1.24 kent if (sc->sc_flags & AUVIA_FLAGS_VT8233) {
1176 1.27 kent CH_WRITE1(sc, ch, VIA8233_RP_DXS_LVOL, 0);
1177 1.27 kent CH_WRITE1(sc, ch, VIA8233_RP_DXS_RVOL, 0);
1178 1.27 kent CH_WRITE1(sc, ch, AUVIA_RP_CONTROL,
1179 1.22 kent AUVIA_RPCTRL_START | AUVIA_RPCTRL_AUTOSTART |
1180 1.22 kent AUVIA_RPCTRL_STOP | AUVIA_RPCTRL_EOL | AUVIA_RPCTRL_FLAG);
1181 1.24 kent } else {
1182 1.27 kent CH_WRITE1(sc, ch, AUVIA_RP_MODE, ch->sc_reg);
1183 1.27 kent CH_WRITE1(sc, ch, AUVIA_RP_CONTROL, AUVIA_RPCTRL_START);
1184 1.24 kent }
1185 1.1 tsarna
1186 1.1 tsarna return 0;
1187 1.1 tsarna }
1188 1.1 tsarna
1189 1.52 thorpej static int
1190 1.1 tsarna auvia_intr(void *arg)
1191 1.1 tsarna {
1192 1.51 kent struct auvia_softc *sc;
1193 1.27 kent struct auvia_softc_chan *ch;
1194 1.1 tsarna u_int8_t r;
1195 1.17 fvdl int rval;
1196 1.17 fvdl
1197 1.51 kent sc = arg;
1198 1.17 fvdl rval = 0;
1199 1.74 jmcneill ch = &sc->sc_record;
1200 1.1 tsarna
1201 1.74 jmcneill mutex_spin_enter(&sc->sc_intr_lock);
1202 1.27 kent r = CH_READ1(sc, ch, AUVIA_RP_STAT);
1203 1.1 tsarna if (r & AUVIA_RPSTAT_INTR) {
1204 1.2 tsarna if (sc->sc_record.sc_intr)
1205 1.2 tsarna sc->sc_record.sc_intr(sc->sc_record.sc_arg);
1206 1.1 tsarna
1207 1.1 tsarna /* clear interrupts */
1208 1.27 kent CH_WRITE1(sc, ch, AUVIA_RP_STAT, AUVIA_RPSTAT_INTR);
1209 1.17 fvdl rval = 1;
1210 1.1 tsarna }
1211 1.22 kent
1212 1.27 kent ch = &sc->sc_play;
1213 1.27 kent r = CH_READ1(sc, ch, AUVIA_RP_STAT);
1214 1.1 tsarna if (r & AUVIA_RPSTAT_INTR) {
1215 1.2 tsarna if (sc->sc_play.sc_intr)
1216 1.2 tsarna sc->sc_play.sc_intr(sc->sc_play.sc_arg);
1217 1.1 tsarna
1218 1.1 tsarna /* clear interrupts */
1219 1.27 kent CH_WRITE1(sc, ch, AUVIA_RP_STAT, AUVIA_RPSTAT_INTR);
1220 1.17 fvdl rval = 1;
1221 1.1 tsarna }
1222 1.74 jmcneill mutex_spin_exit(&sc->sc_intr_lock);
1223 1.1 tsarna
1224 1.17 fvdl return rval;
1225 1.1 tsarna }
1226 1.43 kent
1227 1.61 jmcneill static bool
1228 1.72 dyoung auvia_resume(device_t dv, const pmf_qual_t *qual)
1229 1.43 kent {
1230 1.61 jmcneill struct auvia_softc *sc = device_private(dv);
1231 1.43 kent
1232 1.74 jmcneill mutex_enter(&sc->sc_lock);
1233 1.74 jmcneill mutex_spin_enter(&sc->sc_intr_lock);
1234 1.61 jmcneill auvia_reset_codec(sc);
1235 1.61 jmcneill DELAY(1000);
1236 1.74 jmcneill mutex_spin_exit(&sc->sc_intr_lock);
1237 1.61 jmcneill (sc->codec_if->vtbl->restore_ports)(sc->codec_if);
1238 1.74 jmcneill mutex_exit(&sc->sc_lock);
1239 1.43 kent
1240 1.61 jmcneill return true;
1241 1.43 kent }
1242