FreeBSD/Linux Kernel Cross Reference
sys/dev/sound/isa/gusc.c
1 /*-
2 * Copyright (c) 1999 Seigo Tanimura
3 * Copyright (c) 1999 Ville-Pertti Keinonen
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 */
27
28 #include <sys/param.h>
29 #include <sys/systm.h>
30 #include <sys/kernel.h>
31 #include <sys/bus.h>
32 #include <sys/malloc.h>
33 #include <sys/module.h>
34 #include <machine/resource.h>
35 #include <machine/bus.h>
36 #include <sys/rman.h>
37
38 #ifdef HAVE_KERNEL_OPTION_HEADERS
39 #include "opt_snd.h"
40 #endif
41
42 #include <dev/sound/pcm/sound.h>
43 #include <dev/sound/chip.h>
44 #include "bus_if.h"
45
46 #include <isa/isavar.h>
47 #include <isa/isa_common.h>
48
49 SND_DECLARE_FILE("$FreeBSD: releng/11.0/sys/dev/sound/isa/gusc.c 298307 2016-04-19 23:37:24Z pfg $");
50
51 #define LOGICALID_NOPNP 0
52 #define LOGICALID_PCM 0x0000561e
53 #define LOGICALID_OPL 0x0300561e
54 #define LOGICALID_MIDI 0x0400561e
55
56 /* PnP IDs */
57 static struct isa_pnp_id gusc_ids[] = {
58 {LOGICALID_PCM, "GRV0000 Gravis UltraSound PnP PCM"}, /* GRV0000 */
59 {LOGICALID_OPL, "GRV0003 Gravis UltraSound PnP OPL"}, /* GRV0003 */
60 {LOGICALID_MIDI, "GRV0004 Gravis UltraSound PnP MIDI"}, /* GRV0004 */
61 };
62
63 /* Interrupt handler. */
64 struct gusc_ihandler {
65 void (*intr)(void *);
66 void *arg;
67 };
68
69 /* Here is the parameter structure per a device. */
70 struct gusc_softc {
71 device_t dev; /* device */
72 int io_rid[3]; /* io port rids */
73 struct resource *io[3]; /* io port resources */
74 int io_alloced[3]; /* io port alloc flag */
75 int irq_rid; /* irq rids */
76 struct resource *irq; /* irq resources */
77 int irq_alloced; /* irq alloc flag */
78 int drq_rid[2]; /* drq rids */
79 struct resource *drq[2]; /* drq resources */
80 int drq_alloced[2]; /* drq alloc flag */
81
82 /* Interrupts are shared (XXX non-PnP only?) */
83 struct gusc_ihandler midi_intr;
84 struct gusc_ihandler pcm_intr;
85 };
86
87 typedef struct gusc_softc *sc_p;
88
89 static int gusc_probe(device_t dev);
90 static int gusc_attach(device_t dev);
91 static int gusisa_probe(device_t dev);
92 static void gusc_intr(void *);
93 static struct resource *gusc_alloc_resource(device_t bus, device_t child, int type, int *rid,
94 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags);
95 static int gusc_release_resource(device_t bus, device_t child, int type, int rid,
96 struct resource *r);
97
98 static device_t find_masterdev(sc_p scp);
99 static int alloc_resource(sc_p scp);
100 static int release_resource(sc_p scp);
101
102 static devclass_t gusc_devclass;
103
104 static int
105 gusc_probe(device_t dev)
106 {
107 device_t child;
108 u_int32_t logical_id;
109 char *s;
110 struct sndcard_func *func;
111 int ret;
112
113 logical_id = isa_get_logicalid(dev);
114 s = NULL;
115
116 /* Check isapnp ids */
117 if (logical_id != 0 && (ret = ISA_PNP_PROBE(device_get_parent(dev), dev, gusc_ids)) != 0)
118 return (ret);
119 else {
120 if (logical_id == 0)
121 return gusisa_probe(dev);
122 }
123
124 switch (logical_id) {
125 case LOGICALID_PCM:
126 s = "Gravis UltraSound Plug & Play PCM";
127 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
128 if (func == NULL)
129 return (ENOMEM);
130 func->func = SCF_PCM;
131 child = device_add_child(dev, "pcm", -1);
132 device_set_ivars(child, func);
133 break;
134 case LOGICALID_OPL:
135 s = "Gravis UltraSound Plug & Play OPL";
136 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
137 if (func == NULL)
138 return (ENOMEM);
139 func->func = SCF_SYNTH;
140 child = device_add_child(dev, "midi", -1);
141 device_set_ivars(child, func);
142 break;
143 case LOGICALID_MIDI:
144 s = "Gravis UltraSound Plug & Play MIDI";
145 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
146 if (func == NULL)
147 return (ENOMEM);
148 func->func = SCF_MIDI;
149 child = device_add_child(dev, "midi", -1);
150 device_set_ivars(child, func);
151 break;
152 }
153
154 if (s != NULL) {
155 device_set_desc(dev, s);
156 return (0);
157 }
158
159 return (ENXIO);
160 }
161
162 static void
163 port_wr(struct resource *r, int i, unsigned char v)
164 {
165 bus_space_write_1(rman_get_bustag(r), rman_get_bushandle(r), i, v);
166 }
167
168 static int
169 port_rd(struct resource *r, int i)
170 {
171 return bus_space_read_1(rman_get_bustag(r), rman_get_bushandle(r), i);
172 }
173
174 /*
175 * Probe for an old (non-PnP) GUS card on the ISA bus.
176 */
177
178 static int
179 gusisa_probe(device_t dev)
180 {
181 device_t child;
182 struct resource *res, *res2;
183 int base, rid, rid2, s, flags;
184 unsigned char val;
185
186 base = isa_get_port(dev);
187 flags = device_get_flags(dev);
188 rid = 1;
189 res = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, base + 0x100,
190 base + 0x107, 8, RF_ACTIVE);
191
192 if (res == NULL)
193 return ENXIO;
194
195 res2 = NULL;
196
197 /*
198 * Check for the presence of some GUS card. Reset the card,
199 * then see if we can access the memory on it.
200 */
201
202 port_wr(res, 3, 0x4c);
203 port_wr(res, 5, 0);
204 DELAY(30 * 1000);
205
206 port_wr(res, 3, 0x4c);
207 port_wr(res, 5, 1);
208 DELAY(30 * 1000);
209
210 s = splhigh();
211
212 /* Write to DRAM. */
213
214 port_wr(res, 3, 0x43); /* Register select */
215 port_wr(res, 4, 0); /* Low addr */
216 port_wr(res, 5, 0); /* Med addr */
217
218 port_wr(res, 3, 0x44); /* Register select */
219 port_wr(res, 4, 0); /* High addr */
220 port_wr(res, 7, 0x55); /* DRAM */
221
222 /* Read from DRAM. */
223
224 port_wr(res, 3, 0x43); /* Register select */
225 port_wr(res, 4, 0); /* Low addr */
226 port_wr(res, 5, 0); /* Med addr */
227
228 port_wr(res, 3, 0x44); /* Register select */
229 port_wr(res, 4, 0); /* High addr */
230 val = port_rd(res, 7); /* DRAM */
231
232 splx(s);
233
234 if (val != 0x55)
235 goto fail;
236
237 rid2 = 0;
238 res2 = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid2, base, base, 1,
239 RF_ACTIVE);
240
241 if (res2 == NULL)
242 goto fail;
243
244 s = splhigh();
245 port_wr(res2, 0x0f, 0x20);
246 val = port_rd(res2, 0x0f);
247 splx(s);
248
249 if (val == 0xff || (val & 0x06) == 0)
250 val = 0;
251 else {
252 val = port_rd(res2, 0x506); /* XXX Out of range. */
253 if (val == 0xff)
254 val = 0;
255 }
256
257 bus_release_resource(dev, SYS_RES_IOPORT, rid2, res2);
258 bus_release_resource(dev, SYS_RES_IOPORT, rid, res);
259
260 if (val >= 10) {
261 struct sndcard_func *func;
262
263 /* Looks like a GUS MAX. Set the rest of the resources. */
264
265 bus_set_resource(dev, SYS_RES_IOPORT, 2, base + 0x10c, 8);
266
267 if (flags & DV_F_DUAL_DMA)
268 bus_set_resource(dev, SYS_RES_DRQ, 1,
269 flags & DV_F_DRQ_MASK, 1);
270
271 /* We can support the CS4231 and MIDI devices. */
272
273 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
274 if (func == NULL)
275 return ENOMEM;
276 func->func = SCF_MIDI;
277 child = device_add_child(dev, "midi", -1);
278 device_set_ivars(child, func);
279
280 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
281 if (func == NULL)
282 printf("xxx: gus pcm not attached, out of memory\n");
283 else {
284 func->func = SCF_PCM;
285 child = device_add_child(dev, "pcm", -1);
286 device_set_ivars(child, func);
287 }
288 device_set_desc(dev, "Gravis UltraSound MAX");
289 return 0;
290 } else {
291
292 /*
293 * TODO: Support even older GUS cards. MIDI should work on
294 * all models.
295 */
296 return ENXIO;
297 }
298
299 fail:
300 bus_release_resource(dev, SYS_RES_IOPORT, rid, res);
301 return ENXIO;
302 }
303
304 static int
305 gusc_attach(device_t dev)
306 {
307 sc_p scp;
308 void *ih;
309
310 scp = device_get_softc(dev);
311
312 bzero(scp, sizeof(*scp));
313
314 scp->dev = dev;
315 if (alloc_resource(scp)) {
316 release_resource(scp);
317 return (ENXIO);
318 }
319
320 if (scp->irq != NULL)
321 snd_setup_intr(dev, scp->irq, 0, gusc_intr, scp, &ih);
322 bus_generic_attach(dev);
323
324 return (0);
325 }
326
327 /*
328 * Handle interrupts on GUS devices until there aren't any left.
329 */
330 static void
331 gusc_intr(void *arg)
332 {
333 sc_p scp = (sc_p)arg;
334 int did_something;
335
336 do {
337 did_something = 0;
338 if (scp->pcm_intr.intr != NULL &&
339 (port_rd(scp->io[2], 2) & 1)) {
340 (*scp->pcm_intr.intr)(scp->pcm_intr.arg);
341 did_something = 1;
342 }
343 if (scp->midi_intr.intr != NULL &&
344 (port_rd(scp->io[1], 0) & 0x80)) {
345 (*scp->midi_intr.intr)(scp->midi_intr.arg);
346 did_something = 1;
347 }
348 } while (did_something != 0);
349 }
350
351 static struct resource *
352 gusc_alloc_resource(device_t bus, device_t child, int type, int *rid,
353 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
354 {
355 sc_p scp;
356 int *alloced, rid_max, alloced_max;
357 struct resource **res;
358
359 scp = device_get_softc(bus);
360 switch (type) {
361 case SYS_RES_IOPORT:
362 alloced = scp->io_alloced;
363 res = scp->io;
364 rid_max = 2;
365 alloced_max = 2; /* pcm + midi (more to include synth) */
366 break;
367 case SYS_RES_IRQ:
368 alloced = &scp->irq_alloced;
369 res = &scp->irq;
370 rid_max = 0;
371 alloced_max = 2; /* pcm and midi share the single irq. */
372 break;
373 case SYS_RES_DRQ:
374 alloced = scp->drq_alloced;
375 res = scp->drq;
376 rid_max = 1;
377 alloced_max = 1;
378 break;
379 default:
380 return (NULL);
381 }
382
383 if (*rid > rid_max || alloced[*rid] == alloced_max)
384 return (NULL);
385
386 alloced[*rid]++;
387 return (res[*rid]);
388 }
389
390 static int
391 gusc_release_resource(device_t bus, device_t child, int type, int rid,
392 struct resource *r)
393 {
394 sc_p scp;
395 int *alloced, rid_max;
396
397 scp = device_get_softc(bus);
398 switch (type) {
399 case SYS_RES_IOPORT:
400 alloced = scp->io_alloced;
401 rid_max = 2;
402 break;
403 case SYS_RES_IRQ:
404 alloced = &scp->irq_alloced;
405 rid_max = 0;
406 break;
407 case SYS_RES_DRQ:
408 alloced = scp->drq_alloced;
409 rid_max = 1;
410 break;
411 default:
412 return (1);
413 }
414
415 if (rid > rid_max || alloced[rid] == 0)
416 return (1);
417
418 alloced[rid]--;
419 return (0);
420 }
421
422 static int
423 gusc_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
424 driver_filter_t *filter,
425 driver_intr_t *intr, void *arg, void **cookiep)
426 {
427 sc_p scp = (sc_p)device_get_softc(dev);
428 devclass_t devclass;
429
430 if (filter != NULL) {
431 printf("gusc.c: we cannot use a filter here\n");
432 return (EINVAL);
433 }
434 devclass = device_get_devclass(child);
435 if (strcmp(devclass_get_name(devclass), "midi") == 0) {
436 scp->midi_intr.intr = intr;
437 scp->midi_intr.arg = arg;
438 return 0;
439 } else if (strcmp(devclass_get_name(devclass), "pcm") == 0) {
440 scp->pcm_intr.intr = intr;
441 scp->pcm_intr.arg = arg;
442 return 0;
443 }
444 return bus_generic_setup_intr(dev, child, irq, flags,
445 filter,
446 intr, arg, cookiep);
447 }
448
449 static device_t
450 find_masterdev(sc_p scp)
451 {
452 int i, units;
453 devclass_t devclass;
454 device_t dev;
455
456 devclass = device_get_devclass(scp->dev);
457 units = devclass_get_maxunit(devclass);
458 dev = NULL;
459 for (i = 0 ; i < units ; i++) {
460 dev = devclass_get_device(devclass, i);
461 if (isa_get_vendorid(dev) == isa_get_vendorid(scp->dev)
462 && isa_get_logicalid(dev) == LOGICALID_PCM
463 && isa_get_serial(dev) == isa_get_serial(scp->dev))
464 break;
465 }
466 if (i == units)
467 return (NULL);
468
469 return (dev);
470 }
471
472 static int io_range[3] = {0x10, 0x8 , 0x4 };
473 static int io_offset[3] = {0x0 , 0x100, 0x10c};
474 static int
475 alloc_resource(sc_p scp)
476 {
477 int i, base, lid, flags;
478 device_t dev;
479
480 flags = 0;
481 if (isa_get_vendorid(scp->dev))
482 lid = isa_get_logicalid(scp->dev);
483 else {
484 lid = LOGICALID_NOPNP;
485 flags = device_get_flags(scp->dev);
486 }
487 switch(lid) {
488 case LOGICALID_PCM:
489 case LOGICALID_NOPNP: /* XXX Non-PnP */
490 if (lid == LOGICALID_NOPNP)
491 base = isa_get_port(scp->dev);
492 else
493 base = 0;
494 for (i = 0 ; i < nitems(scp->io); i++) {
495 if (scp->io[i] == NULL) {
496 scp->io_rid[i] = i;
497 if (base == 0)
498 scp->io[i] =
499 bus_alloc_resource_anywhere(scp->dev,
500 SYS_RES_IOPORT,
501 &scp->io_rid[i],
502 io_range[i],
503 RF_ACTIVE);
504 else
505 scp->io[i] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[i],
506 base + io_offset[i],
507 base + io_offset[i] + io_range[i] - 1
508 , io_range[i], RF_ACTIVE);
509 if (scp->io[i] == NULL)
510 return (1);
511 scp->io_alloced[i] = 0;
512 }
513 }
514 if (scp->irq == NULL) {
515 scp->irq_rid = 0;
516 scp->irq =
517 bus_alloc_resource_any(scp->dev, SYS_RES_IRQ,
518 &scp->irq_rid,
519 RF_ACTIVE|RF_SHAREABLE);
520 if (scp->irq == NULL)
521 return (1);
522 scp->irq_alloced = 0;
523 }
524 for (i = 0 ; i < nitems(scp->drq); i++) {
525 if (scp->drq[i] == NULL) {
526 scp->drq_rid[i] = i;
527 if (base == 0 || i == 0)
528 scp->drq[i] =
529 bus_alloc_resource_any(
530 scp->dev, SYS_RES_DRQ,
531 &scp->drq_rid[i],
532 RF_ACTIVE);
533 else if ((flags & DV_F_DUAL_DMA) != 0)
534 /* XXX The secondary drq is specified in the flag. */
535 scp->drq[i] = bus_alloc_resource(scp->dev, SYS_RES_DRQ, &scp->drq_rid[i],
536 flags & DV_F_DRQ_MASK,
537 flags & DV_F_DRQ_MASK, 1, RF_ACTIVE);
538 if (scp->drq[i] == NULL)
539 return (1);
540 scp->drq_alloced[i] = 0;
541 }
542 }
543 break;
544 case LOGICALID_OPL:
545 if (scp->io[0] == NULL) {
546 scp->io_rid[0] = 0;
547 scp->io[0] = bus_alloc_resource_anywhere(scp->dev,
548 SYS_RES_IOPORT,
549 &scp->io_rid[0],
550 io_range[0],
551 RF_ACTIVE);
552 if (scp->io[0] == NULL)
553 return (1);
554 scp->io_alloced[0] = 0;
555 }
556 break;
557 case LOGICALID_MIDI:
558 if (scp->io[0] == NULL) {
559 scp->io_rid[0] = 0;
560 scp->io[0] = bus_alloc_resource_anywhere(scp->dev,
561 SYS_RES_IOPORT,
562 &scp->io_rid[0],
563 io_range[0],
564 RF_ACTIVE);
565 if (scp->io[0] == NULL)
566 return (1);
567 scp->io_alloced[0] = 0;
568 }
569 if (scp->irq == NULL) {
570 /* The irq is shared with pcm audio. */
571 dev = find_masterdev(scp);
572 if (dev == NULL)
573 return (1);
574 scp->irq_rid = 0;
575 scp->irq = BUS_ALLOC_RESOURCE(dev, NULL, SYS_RES_IRQ, &scp->irq_rid,
576 0, ~0, 1, RF_ACTIVE | RF_SHAREABLE);
577 if (scp->irq == NULL)
578 return (1);
579 scp->irq_alloced = 0;
580 }
581 break;
582 }
583 return (0);
584 }
585
586 static int
587 release_resource(sc_p scp)
588 {
589 int i, lid;
590 device_t dev;
591
592 if (isa_get_vendorid(scp->dev))
593 lid = isa_get_logicalid(scp->dev);
594 else
595 lid = LOGICALID_NOPNP;
596
597 switch(lid) {
598 case LOGICALID_PCM:
599 case LOGICALID_NOPNP: /* XXX Non-PnP */
600 for (i = 0 ; i < nitems(scp->io); i++) {
601 if (scp->io[i] != NULL) {
602 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[i], scp->io[i]);
603 scp->io[i] = NULL;
604 }
605 }
606 if (scp->irq != NULL) {
607 bus_release_resource(scp->dev, SYS_RES_IRQ, scp->irq_rid, scp->irq);
608 scp->irq = NULL;
609 }
610 for (i = 0 ; i < nitems(scp->drq); i++) {
611 if (scp->drq[i] != NULL) {
612 bus_release_resource(scp->dev, SYS_RES_DRQ, scp->drq_rid[i], scp->drq[i]);
613 scp->drq[i] = NULL;
614 }
615 }
616 break;
617 case LOGICALID_OPL:
618 if (scp->io[0] != NULL) {
619 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[0], scp->io[0]);
620 scp->io[0] = NULL;
621 }
622 break;
623 case LOGICALID_MIDI:
624 if (scp->io[0] != NULL) {
625 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[0], scp->io[0]);
626 scp->io[0] = NULL;
627 }
628 if (scp->irq != NULL) {
629 /* The irq is shared with pcm audio. */
630 dev = find_masterdev(scp);
631 if (dev == NULL)
632 return (1);
633 BUS_RELEASE_RESOURCE(dev, NULL, SYS_RES_IOPORT, scp->irq_rid, scp->irq);
634 scp->irq = NULL;
635 }
636 break;
637 }
638 return (0);
639 }
640
641 static device_method_t gusc_methods[] = {
642 /* Device interface */
643 DEVMETHOD(device_probe, gusc_probe),
644 DEVMETHOD(device_attach, gusc_attach),
645 DEVMETHOD(device_detach, bus_generic_detach),
646 DEVMETHOD(device_shutdown, bus_generic_shutdown),
647 DEVMETHOD(device_suspend, bus_generic_suspend),
648 DEVMETHOD(device_resume, bus_generic_resume),
649
650 /* Bus interface */
651 DEVMETHOD(bus_alloc_resource, gusc_alloc_resource),
652 DEVMETHOD(bus_release_resource, gusc_release_resource),
653 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
654 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
655 DEVMETHOD(bus_setup_intr, gusc_setup_intr),
656 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
657
658 DEVMETHOD_END
659 };
660
661 static driver_t gusc_driver = {
662 "gusc",
663 gusc_methods,
664 sizeof(struct gusc_softc),
665 };
666
667 /*
668 * gusc can be attached to an isa bus.
669 */
670 DRIVER_MODULE(snd_gusc, isa, gusc_driver, gusc_devclass, 0, 0);
671 DRIVER_MODULE(snd_gusc, acpi, gusc_driver, gusc_devclass, 0, 0);
672 MODULE_DEPEND(snd_gusc, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
673 MODULE_VERSION(snd_gusc, 1);
674
675
Cache object: e7f909fc515d8ef2717fa26668da1cc7
|