2 * dtlk.c - DoubleTalk PC driver for Linux
4 * Original author: Chris Pallotta <chris@allmedia.com>
5 * Current maintainer: Jim Van Zandt <jrv@vanzandt.mv.com>
7 * 2000-03-18 Jim Van Zandt: Fix polling.
8 * Eliminate dtlk_timer_active flag and separate dtlk_stop_timer
9 * function. Don't restart timer in dtlk_timer_tick. Restart timer
10 * in dtlk_poll after every poll. dtlk_poll returns mask (duh).
11 * Eliminate unused function dtlk_write_byte. Misc. code cleanups.
14 /* This driver is for the DoubleTalk PC, a speech synthesizer
15 manufactured by RC Systems (http://www.rcsys.com/). It was written
16 based on documentation in their User's Manual file and Developer's
19 The DoubleTalk PC contains four voice synthesizers: text-to-speech
20 (TTS), linear predictive coding (LPC), PCM/ADPCM, and CVSD. It
21 also has a tone generator. Output data for LPC are written to the
22 LPC port, and output data for the other modes are written to the
25 Two kinds of data can be read from the DoubleTalk: status
26 information (in response to the "\001?" interrogation command) is
27 read from the TTS port, and index markers (which mark the progress
28 of the speech) are read from the LPC port. Not all models of the
29 DoubleTalk PC implement index markers. Both the TTS and LPC ports
30 can also display status flags.
32 The DoubleTalk PC generates no interrupts.
34 These characteristics are mapped into the Unix stream I/O model as
37 "write" sends bytes to the TTS port. It is the responsibility of
38 the user program to switch modes among TTS, PCM/ADPCM, and CVSD.
39 This driver was written for use with the text-to-speech
40 synthesizer. If LPC output is needed some day, other minor device
41 numbers can be used to select among output modes.
43 "read" gets index markers from the LPC port. If the device does
44 not implement index markers, the read will fail with error EINVAL.
46 Status information is available using the DTLK_INTERROGATE ioctl.
50 #include <linux/module.h>
53 #include <linux/types.h>
56 #include <linux/errno.h> /* for -EBUSY */
57 #include <linux/ioport.h> /* for request_region */
58 #include <linux/delay.h> /* for loops_per_jiffy */
59 #include <asm/io.h> /* for inb_p, outb_p, inb, outb, etc. */
60 #include <asm/uaccess.h> /* for get_user, etc. */
61 #include <linux/wait.h> /* for wait_queue */
62 #include <linux/init.h> /* for __init, module_{init,exit} */
63 #include <linux/poll.h> /* for POLLIN, etc. */
64 #include <linux/dtlk.h> /* local header file for DoubleTalk values */
65 #include <linux/devfs_fs_kernel.h>
66 #include <linux/smp_lock.h>
69 #define TRACE_TEXT(str) printk(str);
70 #define TRACE_RET printk(")")
72 #define TRACE_TEXT(str) ((void) 0)
73 #define TRACE_RET ((void) 0)
77 static int dtlk_major;
78 static int dtlk_port_lpc;
79 static int dtlk_port_tts;
81 static int dtlk_has_indexing;
82 static unsigned int dtlk_portlist[] =
83 {0x25e, 0x29e, 0x2de, 0x31e, 0x35e, 0x39e, 0};
84 static wait_queue_head_t dtlk_process_list;
85 static struct timer_list dtlk_timer;
87 /* prototypes for file_operations struct */
88 static ssize_t dtlk_read(struct file *, char __user *,
89 size_t nbytes, loff_t * ppos);
90 static ssize_t dtlk_write(struct file *, const char __user *,
91 size_t nbytes, loff_t * ppos);
92 static unsigned int dtlk_poll(struct file *, poll_table *);
93 static int dtlk_open(struct inode *, struct file *);
94 static int dtlk_release(struct inode *, struct file *);
95 static int dtlk_ioctl(struct inode *inode, struct file *file,
96 unsigned int cmd, unsigned long arg);
98 static struct file_operations dtlk_fops =
100 .owner = THIS_MODULE,
106 .release = dtlk_release,
109 /* local prototypes */
110 static int dtlk_dev_probe(void);
111 static struct dtlk_settings *dtlk_interrogate(void);
112 static int dtlk_readable(void);
113 static char dtlk_read_lpc(void);
114 static char dtlk_read_tts(void);
115 static int dtlk_writeable(void);
116 static char dtlk_write_bytes(const char *buf, int n);
117 static char dtlk_write_tts(char);
119 static void dtlk_handle_error(char, char, unsigned int);
121 static void dtlk_timer_tick(unsigned long data);
123 static ssize_t dtlk_read(struct file *file, char __user *buf,
124 size_t count, loff_t * ppos)
126 unsigned int minor = iminor(file->f_dentry->d_inode);
130 TRACE_TEXT("(dtlk_read");
131 /* printk("DoubleTalk PC - dtlk_read()\n"); */
133 if (minor != DTLK_MINOR || !dtlk_has_indexing)
136 for (retries = 0; retries < loops_per_jiffy; retries++) {
137 while (i < count && dtlk_readable()) {
138 ch = dtlk_read_lpc();
139 /* printk("dtlk_read() reads 0x%02x\n", ch); */
140 if (put_user(ch, buf++))
146 if (file->f_flags & O_NONBLOCK)
148 msleep_interruptible(100);
150 if (retries == loops_per_jiffy)
151 printk(KERN_ERR "dtlk_read times out\n");
156 static ssize_t dtlk_write(struct file *file, const char __user *buf,
157 size_t count, loff_t * ppos)
159 int i = 0, retries = 0, ch;
161 TRACE_TEXT("(dtlk_write");
166 for (i = 0; i < count; i++) {
167 if (get_user(ch, buf + i))
169 if (' ' <= ch && ch <= '~')
172 printk("\\%03o", ch);
178 if (iminor(file->f_dentry->d_inode) != DTLK_MINOR)
182 while (i < count && !get_user(ch, buf) &&
183 (ch == DTLK_CLEAR || dtlk_writeable())) {
188 /* We yield our time until scheduled
189 again. This reduces the transfer
190 rate to 500 bytes/sec, but that's
191 still enough to keep up with the
192 speech synthesizer. */
193 msleep_interruptible(1);
195 /* the RDY bit goes zero 2-3 usec
196 after writing, and goes 1 again
197 180-190 usec later. Here, we wait
198 up to 250 usec for the RDY bit to
201 retries < loops_per_jiffy / (4000/HZ);
203 if (inb_p(dtlk_port_tts) &
211 if (file->f_flags & O_NONBLOCK)
214 msleep_interruptible(1);
216 if (++retries > 10 * HZ) { /* wait no more than 10 sec
218 printk("dtlk: write timeout. "
219 "inb_p(dtlk_port_tts) = 0x%02x\n",
220 inb_p(dtlk_port_tts));
229 static unsigned int dtlk_poll(struct file *file, poll_table * wait)
232 unsigned long expires;
234 TRACE_TEXT(" dtlk_poll");
238 printk("<%ld>", jiffies-j);
241 poll_wait(file, &dtlk_process_list, wait);
243 if (dtlk_has_indexing && dtlk_readable()) {
244 del_timer(&dtlk_timer);
245 mask = POLLIN | POLLRDNORM;
247 if (dtlk_writeable()) {
248 del_timer(&dtlk_timer);
249 mask |= POLLOUT | POLLWRNORM;
251 /* there are no exception conditions */
253 /* There won't be any interrupts, so we set a timer instead. */
254 expires = jiffies + 3*HZ / 100;
255 mod_timer(&dtlk_timer, expires);
260 static void dtlk_timer_tick(unsigned long data)
262 TRACE_TEXT(" dtlk_timer_tick");
263 wake_up_interruptible(&dtlk_process_list);
266 static int dtlk_ioctl(struct inode *inode,
271 char __user *argp = (char __user *)arg;
272 struct dtlk_settings *sp;
274 TRACE_TEXT(" dtlk_ioctl");
278 case DTLK_INTERROGATE:
279 sp = dtlk_interrogate();
280 if (copy_to_user(argp, sp, sizeof(struct dtlk_settings)))
285 portval = inb_p(dtlk_port_tts);
286 return put_user(portval, argp);
293 static int dtlk_open(struct inode *inode, struct file *file)
295 TRACE_TEXT("(dtlk_open");
297 nonseekable_open(inode, file);
298 switch (iminor(inode)) {
302 return nonseekable_open(inode, file);
309 static int dtlk_release(struct inode *inode, struct file *file)
311 TRACE_TEXT("(dtlk_release");
313 switch (iminor(inode)) {
322 del_timer(&dtlk_timer);
327 static int __init dtlk_init(void)
332 dtlk_major = register_chrdev(0, "dtlk", &dtlk_fops);
333 if (dtlk_major == 0) {
334 printk(KERN_ERR "DoubleTalk PC - cannot register device\n");
337 if (dtlk_dev_probe() == 0)
338 printk(", MAJOR %d\n", dtlk_major);
340 init_timer(&dtlk_timer);
341 dtlk_timer.function = dtlk_timer_tick;
342 init_waitqueue_head(&dtlk_process_list);
347 static void __exit dtlk_cleanup (void)
349 dtlk_write_bytes("goodbye", 8);
350 msleep_interruptible(500); /* nap 0.50 sec but
355 dtlk_write_tts(DTLK_CLEAR);
356 unregister_chrdev(dtlk_major, "dtlk");
357 release_region(dtlk_port_lpc, DTLK_IO_EXTENT);
360 module_init(dtlk_init);
361 module_exit(dtlk_cleanup);
363 /* ------------------------------------------------------------------------ */
365 static int dtlk_readable(void)
368 printk(" dtlk_readable=%u@%u", inb_p(dtlk_port_lpc) != 0x7f, jiffies);
370 return inb_p(dtlk_port_lpc) != 0x7f;
373 static int dtlk_writeable(void)
375 /* TRACE_TEXT(" dtlk_writeable"); */
377 printk(" dtlk_writeable=%u", (inb_p(dtlk_port_tts) & TTS_WRITABLE)!=0);
379 return inb_p(dtlk_port_tts) & TTS_WRITABLE;
382 static int __init dtlk_dev_probe(void)
384 unsigned int testval = 0;
386 struct dtlk_settings *sp;
388 if (dtlk_port_lpc | dtlk_port_tts)
391 for (i = 0; dtlk_portlist[i]; i++) {
393 printk("DoubleTalk PC - Port %03x = %04x\n",
394 dtlk_portlist[i], (testval = inw_p(dtlk_portlist[i])));
397 if (!request_region(dtlk_portlist[i], DTLK_IO_EXTENT,
400 testval = inw_p(dtlk_portlist[i]);
401 if ((testval &= 0xfbff) == 0x107f) {
402 dtlk_port_lpc = dtlk_portlist[i];
403 dtlk_port_tts = dtlk_port_lpc + 1;
405 sp = dtlk_interrogate();
406 printk("DoubleTalk PC at %03x-%03x, "
407 "ROM version %s, serial number %u",
408 dtlk_portlist[i], dtlk_portlist[i] +
410 sp->rom_version, sp->serial_number);
412 /* put LPC port into known state, so
413 dtlk_readable() gives valid result */
414 outb_p(0xff, dtlk_port_lpc);
416 /* INIT string and index marker */
417 dtlk_write_bytes("\036\1@\0\0012I\r", 8);
418 /* posting an index takes 18 msec. Here, we
419 wait up to 100 msec to see whether it
421 msleep_interruptible(100);
422 dtlk_has_indexing = dtlk_readable();
424 printk(", indexing %d\n", dtlk_has_indexing);
428 /* This macro records ten samples read from the LPC port, for later display */
430 for (i = 0; i < 10; i++) \
432 buffer[b++] = inb_p(dtlk_port_lpc); \
433 __delay(loops_per_jiffy/(1000000/HZ)); \
439 outb_p(0xff, dtlk_port_lpc);
442 dtlk_write_bytes("\0012I\r", 4);
444 __delay(50 * loops_per_jiffy / (1000/HZ));
445 outb_p(0xff, dtlk_port_lpc);
450 for (j = 0; j < b; j++)
451 printk(" %02x", buffer[j]);
458 /* This macro records ten samples read from the TTS port, for later display */
460 for (i = 0; i < 10; i++) \
462 buffer[b++] = inb_p(dtlk_port_tts); \
463 __delay(loops_per_jiffy/(1000000/HZ)); /* 1 us */ \
468 mdelay(10); /* 10 ms */
470 outb_p(0x03, dtlk_port_tts);
476 for (j = 0; j < b; j++)
477 printk(" %02x", buffer[j]);
480 #endif /* OUTSCOPE */
482 dtlk_write_bytes("Double Talk found", 18);
486 release_region(dtlk_portlist[i], DTLK_IO_EXTENT);
489 printk(KERN_INFO "DoubleTalk PC - not found\n");
494 static void dtlk_handle_error(char op, char rc, unsigned int minor)
496 printk(KERN_INFO"\nDoubleTalk PC - MINOR: %d, OPCODE: %d, ERROR: %d\n",
502 /* interrogate the DoubleTalk PC and return its settings */
503 static struct dtlk_settings *dtlk_interrogate(void)
506 static char buf[sizeof(struct dtlk_settings) + 1];
508 static struct dtlk_settings status;
509 TRACE_TEXT("(dtlk_interrogate");
510 dtlk_write_bytes("\030\001?", 3);
511 for (total = 0, i = 0; i < 50; i++) {
512 buf[total] = dtlk_read_tts();
513 if (total > 2 && buf[total] == 0x7f)
515 if (total < sizeof(struct dtlk_settings))
519 if (i==50) printk("interrogate() read overrun\n");
520 for (i=0; i<sizeof(buf); i++)
521 printk(" %02x", buf[i]);
525 status.serial_number = t[0] + t[1] * 256; /* serial number is
531 status.rom_version[i] = *t;
532 if (i < sizeof(status.rom_version) - 1)
536 status.rom_version[i] = 0;
540 status.punc_level = *t++;
541 status.formant_freq = *t++;
544 status.volume = *t++;
546 status.expression = *t++;
547 status.ext_dict_loaded = *t++;
548 status.ext_dict_status = *t++;
549 status.free_ram = *t++;
550 status.articulation = *t++;
551 status.reverb = *t++;
553 status.has_indexing = dtlk_has_indexing;
558 static char dtlk_read_tts(void)
560 int portval, retries = 0;
562 TRACE_TEXT("(dtlk_read_tts");
564 /* verify DT is ready, read char, wait for ACK */
566 portval = inb_p(dtlk_port_tts);
567 } while ((portval & TTS_READABLE) == 0 &&
568 retries++ < DTLK_MAX_RETRIES);
569 if (retries == DTLK_MAX_RETRIES)
570 printk(KERN_ERR "dtlk_read_tts() timeout\n");
572 ch = inb_p(dtlk_port_tts); /* input from TTS port */
574 outb_p(ch, dtlk_port_tts);
578 portval = inb_p(dtlk_port_tts);
579 } while ((portval & TTS_READABLE) != 0 &&
580 retries++ < DTLK_MAX_RETRIES);
581 if (retries == DTLK_MAX_RETRIES)
582 printk(KERN_ERR "dtlk_read_tts() timeout\n");
588 static char dtlk_read_lpc(void)
592 TRACE_TEXT("(dtlk_read_lpc");
594 /* no need to test -- this is only called when the port is readable */
596 ch = inb_p(dtlk_port_lpc); /* input from LPC port */
598 outb_p(0xff, dtlk_port_lpc);
600 /* acknowledging a read takes 3-4
601 usec. Here, we wait up to 20 usec
602 for the acknowledgement */
603 retries = (loops_per_jiffy * 20) / (1000000/HZ);
604 while (inb_p(dtlk_port_lpc) != 0x7f && --retries > 0);
606 printk(KERN_ERR "dtlk_read_lpc() timeout\n");
612 /* write n bytes to tts port */
613 static char dtlk_write_bytes(const char *buf, int n)
616 /* printk("dtlk_write_bytes(\"%-*s\", %d)\n", n, buf, n); */
617 TRACE_TEXT("(dtlk_write_bytes");
619 val = dtlk_write_tts(*buf++);
624 static char dtlk_write_tts(char ch)
628 printk(" dtlk_write_tts(");
629 if (' ' <= ch && ch <= '~')
632 printk("0x%02x", ch);
634 if (ch != DTLK_CLEAR) /* no flow control for CLEAR command */
635 while ((inb_p(dtlk_port_tts) & TTS_WRITABLE) == 0 &&
636 retries++ < DTLK_MAX_RETRIES) /* DT ready? */
638 if (retries == DTLK_MAX_RETRIES)
639 printk(KERN_ERR "dtlk_write_tts() timeout\n");
641 outb_p(ch, dtlk_port_tts); /* output to TTS port */
642 /* the RDY bit goes zero 2-3 usec after writing, and goes
643 1 again 180-190 usec later. Here, we wait up to 10
644 usec for the RDY bit to go zero. */
645 for (retries = 0; retries < loops_per_jiffy / (100000/HZ); retries++)
646 if ((inb_p(dtlk_port_tts) & TTS_WRITABLE) == 0)
655 MODULE_LICENSE("GPL");