2 * spkr.c -- device driver for console speaker
4 * v1.4 by Eric S. Raymond (esr@snark.thyrsus.com) Aug 1993
5 * modified for FreeBSD by Andrew A. Chernov <ache@astral.msk.su>
6 * modified for PC98 by Kakefuda
10 __FBSDID("$FreeBSD$");
12 #include <sys/param.h>
13 #include <sys/systm.h>
15 #include <sys/kernel.h>
16 #include <sys/module.h>
19 #include <sys/ctype.h>
20 #include <sys/malloc.h>
21 #include <isa/isavar.h>
23 #include <pc98/pc98/pc98.h>
25 #include <i386/isa/isa.h>
27 #include <i386/isa/timerreg.h>
28 #include <machine/clock.h>
29 #include <machine/speaker.h>
31 static d_open_t spkropen;
32 static d_close_t spkrclose;
33 static d_write_t spkrwrite;
34 static d_ioctl_t spkrioctl;
36 static struct cdevsw spkr_cdevsw = {
37 .d_version = D_VERSION,
38 .d_flags = D_NEEDGIANT,
46 static MALLOC_DEFINE(M_SPKR, "spkr", "Speaker buffer");
48 /**************** MACHINE DEPENDENT PART STARTS HERE *************************
50 * This section defines a function tone() which causes a tone of given
51 * frequency and duration from the ISA console speaker.
52 * Another function endtone() is defined to force sound off, and there is
53 * also a rest() entry point to do pauses.
55 * Audible sound is generated using the Programmable Interval Timer (PIT) and
56 * Programmable Peripheral Interface (PPI) attached to the ISA speaker. The
57 * PPI controls whether sound is passed through at all; the PIT's channel 2 is
58 * used to generate clicks (a square wave) of whatever frequency is desired.
62 * XXX PPI control values should be in a header and used in clock.c.
65 #define SPKR_DESC "PC98 speaker"
66 #define PPI_SPKR 0x08 /* turn these PPI bits on to pass sound */
67 #define PIT_COUNT 0x3fdb /* PIT count address */
69 #define SPEAKER_ON outb(IO_PPI, inb(IO_PPI) & ~PPI_SPKR)
70 #define SPEAKER_OFF outb(IO_PPI, inb(IO_PPI) | PPI_SPKR)
71 #define TIMER_ACQUIRE acquire_timer1(TIMER_SEL1 | TIMER_SQWAVE | TIMER_16BIT)
72 #define TIMER_RELEASE release_timer1()
73 #define SPEAKER_WRITE(val) { \
74 outb(PIT_COUNT, (val & 0xff)); \
75 outb(PIT_COUNT, (val >> 8)); \
78 #define SPKR_DESC "PC speaker"
79 #define PPI_SPKR 0x03 /* turn these PPI bits on to pass sound */
81 #define SPEAKER_ON outb(IO_PPI, inb(IO_PPI) | PPI_SPKR)
82 #define SPEAKER_OFF outb(IO_PPI, inb(IO_PPI) & ~PPI_SPKR)
83 #define TIMER_ACQUIRE acquire_timer2(TIMER_SEL2 | TIMER_SQWAVE | TIMER_16BIT)
84 #define TIMER_RELEASE release_timer2()
85 #define SPEAKER_WRITE(val) { \
86 outb(TIMER_CNTR2, (val & 0xff)); \
87 outb(TIMER_CNTR2, (val >> 8)); \
92 static char endtone, endrest;
94 static void tone(unsigned int thz, unsigned int ticks);
95 static void rest(int ticks);
96 static void playinit(void);
97 static void playtone(int pitch, int value, int sustain);
98 static void playstring(char *cp, size_t slen);
100 /* emit tone of frequency thz for given number of ticks */
103 unsigned int thz, ticks;
105 unsigned int divisor;
111 divisor = timer_freq / thz;
114 (void) printf("tone: thz=%d ticks=%d\n", thz, ticks);
117 /* set timer to generate clicks at given frequency in Hertz */
121 /* enter list of waiting procs ??? */
127 SPEAKER_WRITE(divisor);
130 /* turn the speaker on */
134 * Set timeout to endtone function, then give up the timeslice.
135 * This is so other processes can execute while the tone is being
139 tsleep(&endtone, SPKRPRI | PCATCH, "spkrtn", ticks);
146 /* rest for given number of ticks */
152 * Set timeout to endrest function, then give up the timeslice.
153 * This is so other processes can execute while the rest is being
157 (void) printf("rest: %d\n", ticks);
160 tsleep(&endrest, SPKRPRI | PCATCH, "spkrrs", ticks);
163 /**************** PLAY STRING INTERPRETER BEGINS HERE **********************
165 * Play string interpretation is modelled on IBM BASIC 2.0's PLAY statement;
166 * M[LNS] are missing; the ~ synonym and the _ slur mark and the octave-
167 * tracking facility are added.
168 * Requires tone(), rest(), and endtone(). String play is not interruptible
169 * except possibly at physical block boundaries.
176 #define dtoi(c) ((c) - '0')
178 static int octave; /* currently selected octave */
179 static int whole; /* whole-note time at current tempo, in ticks */
180 static int value; /* whole divisor for note time, quarter note = 1 */
181 static int fill; /* controls spacing of notes */
182 static bool octtrack; /* octave-tracking on? */
183 static bool octprefix; /* override current octave-tracking state? */
186 * Magic number avoidance...
188 #define SECS_PER_MIN 60 /* seconds per minute */
189 #define WHOLE_NOTE 4 /* quarter notes per whole note */
190 #define MIN_VALUE 64 /* the most we can divide a note by */
191 #define DFLT_VALUE 4 /* default value (quarter-note) */
192 #define FILLTIME 8 /* for articulation, break note in parts */
193 #define STACCATO 6 /* 6/8 = 3/4 of note is filled */
194 #define NORMAL 7 /* 7/8ths of note interval is filled */
195 #define LEGATO 8 /* all of note interval is filled */
196 #define DFLT_OCTAVE 4 /* default octave */
197 #define MIN_TEMPO 32 /* minimum tempo */
198 #define DFLT_TEMPO 120 /* default tempo */
199 #define MAX_TEMPO 255 /* max tempo */
200 #define NUM_MULT 3 /* numerator of dot multiplier */
201 #define DENOM_MULT 2 /* denominator of dot multiplier */
203 /* letter to half-tone: A B C D E F G */
204 static int notetab[8] = {9, 11, 0, 2, 4, 5, 7};
207 * This is the American Standard A440 Equal-Tempered scale with frequencies
208 * rounded to nearest integer. Thank Goddess for the good ol' CRC Handbook...
209 * our octave 0 is standard octave 2.
211 #define OCTAVE_NOTES 12 /* semitones per octave */
212 static int pitchtab[] =
214 /* C C# D D# E F F# G G# A A# B*/
215 /* 0 */ 65, 69, 73, 78, 82, 87, 93, 98, 103, 110, 117, 123,
216 /* 1 */ 131, 139, 147, 156, 165, 175, 185, 196, 208, 220, 233, 247,
217 /* 2 */ 262, 277, 294, 311, 330, 349, 370, 392, 415, 440, 466, 494,
218 /* 3 */ 523, 554, 587, 622, 659, 698, 740, 784, 831, 880, 932, 988,
219 /* 4 */ 1047, 1109, 1175, 1245, 1319, 1397, 1480, 1568, 1661, 1760, 1865, 1975,
220 /* 5 */ 2093, 2217, 2349, 2489, 2637, 2794, 2960, 3136, 3322, 3520, 3729, 3951,
221 /* 6 */ 4186, 4435, 4698, 4978, 5274, 5588, 5920, 6272, 6644, 7040, 7459, 7902,
227 octave = DFLT_OCTAVE;
228 whole = (hz * SECS_PER_MIN * WHOLE_NOTE) / DFLT_TEMPO;
232 octprefix = TRUE; /* act as though there was an initial O(n) */
235 /* play tone of proper duration for current rhythm signature */
237 playtone(pitch, value, sustain)
238 int pitch, value, sustain;
240 register int sound, silence, snum = 1, sdenom = 1;
242 /* this weirdness avoids floating-point arithmetic */
243 for (; sustain; sustain--)
245 /* See the BUGS section in the man page for discussion */
247 sdenom *= DENOM_MULT;
250 if (value == 0 || sdenom == 0)
254 rest(whole * snum / (value * sdenom));
257 sound = (whole * snum) / (value * sdenom)
258 - (whole * (FILLTIME - fill)) / (value * FILLTIME);
259 silence = whole * (FILLTIME-fill) * snum / (FILLTIME * value * sdenom);
262 (void) printf("playtone: pitch %d for %d ticks, rest for %d ticks\n",
263 pitch, sound, silence);
266 tone(pitchtab[pitch], sound);
272 /* interpret and play an item from a notation string */
278 int pitch, oldfill, lastpitch = OCTAVE_NOTES * DFLT_OCTAVE;
280 #define GETNUM(cp, v) for(v=0; isdigit(cp[1]) && slen > 0; ) \
281 {v = v * 10 + (*++cp - '0'); slen--;}
284 int sustain, timeval, tempo;
285 register char c = toupper(*cp);
288 (void) printf("playstring: %c (%x)\n", c, c);
293 case 'A': case 'B': case 'C': case 'D': case 'E': case 'F': case 'G':
296 pitch = notetab[c - 'A'] + octave * OCTAVE_NOTES;
298 /* this may be followed by an accidental sign */
299 if (cp[1] == '#' || cp[1] == '+')
305 else if (cp[1] == '-')
313 * If octave-tracking mode is on, and there has been no octave-
314 * setting prefix, find the version of the current letter note
315 * closest to the last regardless of octave.
317 if (octtrack && !octprefix)
319 if (abs(pitch-lastpitch) > abs(pitch+OCTAVE_NOTES-lastpitch))
322 pitch += OCTAVE_NOTES;
325 if (abs(pitch-lastpitch) > abs((pitch-OCTAVE_NOTES)-lastpitch))
328 pitch -= OCTAVE_NOTES;
334 /* ...which may in turn be followed by an override time value */
336 if (timeval <= 0 || timeval > MIN_VALUE)
339 /* ...and/or sustain dots */
340 for (sustain = 0; cp[1] == '.'; cp++)
346 /* ...and/or a slur mark */
355 /* time to emit the actual tone */
356 playtone(pitch, timeval, sustain);
362 if (cp[1] == 'N' || cp[1] == 'n')
364 octprefix = octtrack = FALSE;
368 else if (cp[1] == 'L' || cp[1] == 'l')
377 if (octave >= sizeof(pitchtab) / sizeof(pitchtab[0]) / OCTAVE_NOTES)
378 octave = DFLT_OCTAVE;
384 if (octave < sizeof(pitchtab) / sizeof(pitchtab[0]) / OCTAVE_NOTES - 1)
397 for (sustain = 0; cp[1] == '.'; cp++)
409 playtone(pitch - 1, value, sustain);
415 if (value <= 0 || value > MIN_VALUE)
421 /* this may be followed by an override time value */
423 if (timeval <= 0 || timeval > MIN_VALUE)
425 for (sustain = 0; cp[1] == '.'; cp++)
430 playtone(-1, timeval, sustain);
435 if (tempo < MIN_TEMPO || tempo > MAX_TEMPO)
437 whole = (hz * SECS_PER_MIN * WHOLE_NOTE) / tempo;
441 if (cp[1] == 'N' || cp[1] == 'n')
447 else if (cp[1] == 'L' || cp[1] == 'l')
453 else if (cp[1] == 'S' || cp[1] == 's')
464 /******************* UNIX DRIVER HOOKS BEGIN HERE **************************
466 * This section implements driver hooks to run playstring() and the tone(),
467 * endtone(), and rest() functions defined above.
470 static int spkr_active = FALSE; /* exclusion flag */
471 static char *spkr_inbuf; /* incoming buf */
474 spkropen(dev, flags, fmt, td)
481 (void) printf("spkropen: entering with dev = %s\n", devtoname(dev));
486 else if (spkr_active)
491 (void) printf("spkropen: about to perform play initialization\n");
494 spkr_inbuf = malloc(DEV_BSIZE, M_SPKR, M_WAITOK);
501 spkrwrite(dev, uio, ioflag)
507 printf("spkrwrite: entering with dev = %s, count = %d\n",
508 devtoname(dev), uio->uio_resid);
513 else if (uio->uio_resid > (DEV_BSIZE - 1)) /* prevent system crashes */
523 error = uiomove(cp, n, uio);
533 spkrclose(dev, flags, fmt, td)
540 (void) printf("spkrclose: entering with dev = %s\n", devtoname(dev));
549 free(spkr_inbuf, M_SPKR);
556 spkrioctl(dev, cmd, cmdarg, flags, td)
564 (void) printf("spkrioctl: entering with dev = %s, cmd = %lx\n",
565 devtoname(dev), cmd);
570 else if (cmd == SPKRTONE)
572 tone_t *tp = (tone_t *)cmdarg;
574 if (tp->frequency == 0)
577 tone(tp->frequency, tp->duration);
580 else if (cmd == SPKRTUNE)
582 tone_t *tp = (tone_t *)(*(caddr_t *)cmdarg);
587 error = copyin(tp, &ttp, sizeof(tone_t));
590 if (ttp.duration == 0)
592 if (ttp.frequency == 0)
595 tone(ttp.frequency, ttp.duration);
603 * Install placeholder to claim the resources owned by the
606 static struct isa_pnp_id speaker_ids[] = {
608 { 0x0008d041 /* PNP0800 */, SPKR_DESC },
613 static struct cdev *speaker_dev;
616 speaker_probe(device_t dev)
620 error = ISA_PNP_PROBE(device_get_parent(dev), dev, speaker_ids);
630 /* Not configured by hints. */
631 if (strncmp(device_get_name(dev), "speaker", 9))
634 device_set_desc(dev, SPKR_DESC);
640 speaker_attach(device_t dev)
644 device_printf(dev, "Already attached!\n");
648 speaker_dev = make_dev(&spkr_cdevsw, 0, UID_ROOT, GID_WHEEL, 0600,
654 speaker_detach(device_t dev)
656 destroy_dev(speaker_dev);
660 static device_method_t speaker_methods[] = {
661 /* Device interface */
662 DEVMETHOD(device_probe, speaker_probe),
663 DEVMETHOD(device_attach, speaker_attach),
664 DEVMETHOD(device_detach, speaker_detach),
665 DEVMETHOD(device_shutdown, bus_generic_shutdown),
666 DEVMETHOD(device_suspend, bus_generic_suspend),
667 DEVMETHOD(device_resume, bus_generic_resume),
671 static driver_t speaker_driver = {
677 static devclass_t speaker_devclass;
679 DRIVER_MODULE(speaker, isa, speaker_driver, speaker_devclass, 0, 0);
681 DRIVER_MODULE(speaker, acpi, speaker_driver, speaker_devclass, 0, 0);
684 /* spkr.c ends here */