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>
7 * $FreeBSD: src/sys/i386/isa/spkr.c,v 1.45 2000/01/29 16:00:32 peter Exp $
8 * $DragonFly: src/sys/dev/sound/isa/i386/spkr/Attic/spkr.c,v 1.12 2005/01/04 05:27:47 cpressey Exp $
11 #include <sys/param.h>
12 #include <sys/systm.h>
13 #include <sys/kernel.h>
17 #include <sys/ctype.h>
18 #include <sys/systimer.h>
19 #include <bus/isa/i386/isa.h>
20 #include <i386/isa/timerreg.h>
21 #include <machine/clock.h>
22 #include <machine/speaker.h>
24 static d_open_t spkropen;
25 static d_close_t spkrclose;
26 static d_write_t spkrwrite;
27 static d_ioctl_t spkrioctl;
30 static struct cdevsw spkr_cdevsw = {
38 /* close */ spkrclose,
40 /* write */ spkrwrite,
41 /* ioctl */ spkrioctl,
44 /* strategy */ nostrategy,
49 /**************** MACHINE DEPENDENT PART STARTS HERE *************************
51 * This section defines a function tone() which causes a tone of given
52 * frequency and duration from the ISA console speaker.
53 * Another function endtone() is defined to force sound off, and there is
54 * also a rest() entry point to do pauses.
56 * Audible sound is generated using the Programmable Interval Timer (PIT) and
57 * Programmable Peripheral Interface (PPI) attached to the ISA speaker. The
58 * PPI controls whether sound is passed through at all; the PIT's channel 2 is
59 * used to generate clicks (a square wave) of whatever frequency is desired.
64 * XXX should be in a header and used in clock.c.
66 #define PPI_SPKR 0x03 /* turn these PPI bits on to pass sound */
68 static char endtone, endrest;
70 static void tone (unsigned int thz, unsigned int ticks);
71 static void rest (int ticks);
72 static void playinit (void);
73 static void playtone (int pitch, int value, int sustain);
74 static int abs (int n);
75 static void playstring (char *cp, size_t slen);
77 /* emit tone of frequency thz for given number of ticks */
80 unsigned int thz, ticks;
87 divisor = cputimer_freq / thz;
90 (void) printf("tone: thz=%d ticks=%d\n", thz, ticks);
93 /* set timer to generate clicks at given frequency in Hertz */
95 if (acquire_timer2(TIMER_SEL2 | TIMER_SQWAVE | TIMER_16BIT)) {
96 /* enter list of waiting procs ??? */
100 outb(TIMER_CNTR2, (divisor & 0xff)); /* send lo byte */
101 outb(TIMER_CNTR2, (divisor >> 8)); /* send hi byte */
104 /* turn the speaker on */
105 outb(IO_PPI, inb(IO_PPI) | PPI_SPKR);
108 * Set timeout to endtone function, then give up the timeslice.
109 * This is so other processes can execute while the tone is being
113 tsleep((caddr_t)&endtone, PCATCH, "spkrtn", ticks);
114 outb(IO_PPI, inb(IO_PPI) & ~PPI_SPKR);
118 /* rest for given number of ticks */
124 * Set timeout to endrest function, then give up the timeslice.
125 * This is so other processes can execute while the rest is being
129 (void) printf("rest: %d\n", ticks);
132 tsleep((caddr_t)&endrest, PCATCH, "spkrrs", ticks);
135 /**************** PLAY STRING INTERPRETER BEGINS HERE **********************
137 * Play string interpretation is modelled on IBM BASIC 2.0's PLAY statement;
138 * M[LNS] are missing; the ~ synonym and the _ slur mark and the octave-
139 * tracking facility are added.
140 * Requires tone(), rest(), and endtone(). String play is not interruptible
141 * except possibly at physical block boundaries.
148 #define dtoi(c) ((c) - '0')
150 static int octave; /* currently selected octave */
151 static int whole; /* whole-note time at current tempo, in ticks */
152 static int value; /* whole divisor for note time, quarter note = 1 */
153 static int fill; /* controls spacing of notes */
154 static bool octtrack; /* octave-tracking on? */
155 static bool octprefix; /* override current octave-tracking state? */
158 * Magic number avoidance...
160 #define SECS_PER_MIN 60 /* seconds per minute */
161 #define WHOLE_NOTE 4 /* quarter notes per whole note */
162 #define MIN_VALUE 64 /* the most we can divide a note by */
163 #define DFLT_VALUE 4 /* default value (quarter-note) */
164 #define FILLTIME 8 /* for articulation, break note in parts */
165 #define STACCATO 6 /* 6/8 = 3/4 of note is filled */
166 #define NORMAL 7 /* 7/8ths of note interval is filled */
167 #define LEGATO 8 /* all of note interval is filled */
168 #define DFLT_OCTAVE 4 /* default octave */
169 #define MIN_TEMPO 32 /* minimum tempo */
170 #define DFLT_TEMPO 120 /* default tempo */
171 #define MAX_TEMPO 255 /* max tempo */
172 #define NUM_MULT 3 /* numerator of dot multiplier */
173 #define DENOM_MULT 2 /* denominator of dot multiplier */
175 /* letter to half-tone: A B C D E F G */
176 static int notetab[8] = {9, 11, 0, 2, 4, 5, 7};
179 * This is the American Standard A440 Equal-Tempered scale with frequencies
180 * rounded to nearest integer. Thank Goddess for the good ol' CRC Handbook...
181 * our octave 0 is standard octave 2.
183 #define OCTAVE_NOTES 12 /* semitones per octave */
184 static int pitchtab[] =
186 /* C C# D D# E F F# G G# A A# B*/
187 /* 0 */ 65, 69, 73, 78, 82, 87, 93, 98, 103, 110, 117, 123,
188 /* 1 */ 131, 139, 147, 156, 165, 175, 185, 196, 208, 220, 233, 247,
189 /* 2 */ 262, 277, 294, 311, 330, 349, 370, 392, 415, 440, 466, 494,
190 /* 3 */ 523, 554, 587, 622, 659, 698, 740, 784, 831, 880, 932, 988,
191 /* 4 */ 1047, 1109, 1175, 1245, 1319, 1397, 1480, 1568, 1661, 1760, 1865, 1975,
192 /* 5 */ 2093, 2217, 2349, 2489, 2637, 2794, 2960, 3136, 3322, 3520, 3729, 3951,
193 /* 6 */ 4186, 4435, 4698, 4978, 5274, 5588, 5920, 6272, 6644, 7040, 7459, 7902,
199 octave = DFLT_OCTAVE;
200 whole = (hz * SECS_PER_MIN * WHOLE_NOTE) / DFLT_TEMPO;
204 octprefix = TRUE; /* act as though there was an initial O(n) */
207 /* play tone of proper duration for current rhythm signature */
209 playtone(pitch, value, sustain)
210 int pitch, value, sustain;
212 int sound, silence, snum = 1, sdenom = 1;
214 /* this weirdness avoids floating-point arithmetic */
215 for (; sustain; sustain--)
217 /* See the BUGS section in the man page for discussion */
219 sdenom *= DENOM_MULT;
222 if (value == 0 || sdenom == 0)
226 rest(whole * snum / (value * sdenom));
229 sound = (whole * snum) / (value * sdenom)
230 - (whole * (FILLTIME - fill)) / (value * FILLTIME);
231 silence = whole * (FILLTIME-fill) * snum / (FILLTIME * value * sdenom);
234 (void) printf("playtone: pitch %d for %d ticks, rest for %d ticks\n",
235 pitch, sound, silence);
238 tone(pitchtab[pitch], sound);
254 /* interpret and play an item from a notation string */
260 int pitch, oldfill, lastpitch = OCTAVE_NOTES * DFLT_OCTAVE;
262 #define GETNUM(cp, v) for(v=0; isdigit(cp[1]) && slen > 0; ) \
263 {v = v * 10 + (*++cp - '0'); slen--;}
266 int sustain, timeval, tempo;
267 char c = toupper(*cp);
270 (void) printf("playstring: %c (%x)\n", c, c);
275 case 'A': case 'B': case 'C': case 'D': case 'E': case 'F': case 'G':
278 pitch = notetab[c - 'A'] + octave * OCTAVE_NOTES;
280 /* this may be followed by an accidental sign */
281 if (cp[1] == '#' || cp[1] == '+')
287 else if (cp[1] == '-')
295 * If octave-tracking mode is on, and there has been no octave-
296 * setting prefix, find the version of the current letter note
297 * closest to the last regardless of octave.
299 if (octtrack && !octprefix)
301 if (abs(pitch-lastpitch) > abs(pitch+OCTAVE_NOTES-lastpitch))
304 pitch += OCTAVE_NOTES;
307 if (abs(pitch-lastpitch) > abs((pitch-OCTAVE_NOTES)-lastpitch))
310 pitch -= OCTAVE_NOTES;
316 /* ...which may in turn be followed by an override time value */
318 if (timeval <= 0 || timeval > MIN_VALUE)
321 /* ...and/or sustain dots */
322 for (sustain = 0; cp[1] == '.'; cp++)
328 /* ...and/or a slur mark */
337 /* time to emit the actual tone */
338 playtone(pitch, timeval, sustain);
344 if (cp[1] == 'N' || cp[1] == 'n')
346 octprefix = octtrack = FALSE;
350 else if (cp[1] == 'L' || cp[1] == 'l')
359 if (octave >= sizeof(pitchtab) / sizeof(pitchtab[0]) / OCTAVE_NOTES)
360 octave = DFLT_OCTAVE;
366 if (octave < sizeof(pitchtab) / sizeof(pitchtab[0]) / OCTAVE_NOTES - 1)
379 for (sustain = 0; cp[1] == '.'; cp++)
391 playtone(pitch - 1, value, sustain);
397 if (value <= 0 || value > MIN_VALUE)
403 /* this may be followed by an override time value */
405 if (timeval <= 0 || timeval > MIN_VALUE)
407 for (sustain = 0; cp[1] == '.'; cp++)
412 playtone(-1, timeval, sustain);
417 if (tempo < MIN_TEMPO || tempo > MAX_TEMPO)
419 whole = (hz * SECS_PER_MIN * WHOLE_NOTE) / tempo;
423 if (cp[1] == 'N' || cp[1] == 'n')
429 else if (cp[1] == 'L' || cp[1] == 'l')
435 else if (cp[1] == 'S' || cp[1] == 's')
446 /******************* UNIX DRIVER HOOKS BEGIN HERE **************************
448 * This section implements driver hooks to run playstring() and the tone(),
449 * endtone(), and rest() functions defined above.
452 static int spkr_active = FALSE; /* exclusion flag */
453 static struct buf *spkr_inbuf; /* incoming buf */
456 spkropen(dev_t dev, int flags, int fmt, struct thread *td)
459 (void) printf("spkropen: entering with dev = %s\n", devtoname(dev));
464 else if (spkr_active)
469 (void) printf("spkropen: about to perform play initialization\n");
472 spkr_inbuf = geteblk(DEV_BSIZE);
479 spkrwrite(dev, uio, ioflag)
485 printf("spkrwrite: entering with dev = %s, count = %d\n",
486 devtoname(dev), uio->uio_resid);
491 else if (uio->uio_resid > (DEV_BSIZE - 1)) /* prevent system crashes */
500 cp = spkr_inbuf->b_data;
501 error = uiomove(cp, n, uio);
511 spkrclose(dev_t dev, int flags, int fmt, struct thread *td)
514 (void) printf("spkrclose: entering with dev = %s\n", devtoname(dev));
521 wakeup((caddr_t)&endtone);
522 wakeup((caddr_t)&endrest);
530 spkrioctl(dev_t dev, unsigned long cmd, caddr_t cmdarg, int flags, struct thread*td)
533 (void) printf("spkrioctl: entering with dev = %s, cmd = %lx\n",
534 devtoname(dev), cmd);
539 else if (cmd == SPKRTONE)
541 tone_t *tp = (tone_t *)cmdarg;
543 if (tp->frequency == 0)
546 tone(tp->frequency, tp->duration);
549 else if (cmd == SPKRTUNE)
551 tone_t *tp = (tone_t *)(*(caddr_t *)cmdarg);
556 error = copyin(tp, &ttp, sizeof(tone_t));
559 if (ttp.duration == 0)
561 if (ttp.frequency == 0)
564 tone(ttp.frequency, ttp.duration);
572 spkr_drvinit(void *unused)
574 cdevsw_add(&spkr_cdevsw, 0, 0);
575 make_dev(&spkr_cdevsw, 0, UID_ROOT, GID_WHEEL, 0600, "speaker");
578 SYSINIT(spkrdev,SI_SUB_DRIVERS,SI_ORDER_MIDDLE+CDEV_MAJOR,spkr_drvinit,NULL)
581 /* spkr.c ends here */