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 */
67 #define TRACE_TEXT(str) printk(str);
68 #define TRACE_RET printk(")")
70 #define TRACE_TEXT(str) ((void) 0)
71 #define TRACE_RET ((void) 0)
74 static void dtlk_timer_tick(unsigned long data);
76 static int dtlk_major;
77 static int dtlk_port_lpc;
78 static int dtlk_port_tts;
80 static int dtlk_has_indexing;
81 static unsigned int dtlk_portlist[] =
82 {0x25e, 0x29e, 0x2de, 0x31e, 0x35e, 0x39e, 0};
83 static wait_queue_head_t dtlk_process_list;
84 static DEFINE_TIMER(dtlk_timer, dtlk_timer_tick, 0, 0);
86 /* prototypes for file_operations struct */
87 static ssize_t dtlk_read(struct file *, char __user *,
88 size_t nbytes, loff_t * ppos);
89 static ssize_t dtlk_write(struct file *, const char __user *,
90 size_t nbytes, loff_t * ppos);
91 static unsigned int dtlk_poll(struct file *, poll_table *);
92 static int dtlk_open(struct inode *, struct file *);
93 static int dtlk_release(struct inode *, struct file *);
94 static int dtlk_ioctl(struct inode *inode, struct file *file,
95 unsigned int cmd, unsigned long arg);
97 static const struct file_operations dtlk_fops =
105 .release = dtlk_release,
108 /* local prototypes */
109 static int dtlk_dev_probe(void);
110 static struct dtlk_settings *dtlk_interrogate(void);
111 static int dtlk_readable(void);
112 static char dtlk_read_lpc(void);
113 static char dtlk_read_tts(void);
114 static int dtlk_writeable(void);
115 static char dtlk_write_bytes(const char *buf, int n);
116 static char dtlk_write_tts(char);
118 static void dtlk_handle_error(char, char, unsigned int);
121 static ssize_t dtlk_read(struct file *file, char __user *buf,
122 size_t count, loff_t * ppos)
124 unsigned int minor = iminor(file->f_path.dentry->d_inode);
128 TRACE_TEXT("(dtlk_read");
129 /* printk("DoubleTalk PC - dtlk_read()\n"); */
131 if (minor != DTLK_MINOR || !dtlk_has_indexing)
134 for (retries = 0; retries < loops_per_jiffy; retries++) {
135 while (i < count && dtlk_readable()) {
136 ch = dtlk_read_lpc();
137 /* printk("dtlk_read() reads 0x%02x\n", ch); */
138 if (put_user(ch, buf++))
144 if (file->f_flags & O_NONBLOCK)
146 msleep_interruptible(100);
148 if (retries == loops_per_jiffy)
149 printk(KERN_ERR "dtlk_read times out\n");
154 static ssize_t dtlk_write(struct file *file, const char __user *buf,
155 size_t count, loff_t * ppos)
157 int i = 0, retries = 0, ch;
159 TRACE_TEXT("(dtlk_write");
164 for (i = 0; i < count; i++) {
165 if (get_user(ch, buf + i))
167 if (' ' <= ch && ch <= '~')
170 printk("\\%03o", ch);
176 if (iminor(file->f_path.dentry->d_inode) != DTLK_MINOR)
180 while (i < count && !get_user(ch, buf) &&
181 (ch == DTLK_CLEAR || dtlk_writeable())) {
186 /* We yield our time until scheduled
187 again. This reduces the transfer
188 rate to 500 bytes/sec, but that's
189 still enough to keep up with the
190 speech synthesizer. */
191 msleep_interruptible(1);
193 /* the RDY bit goes zero 2-3 usec
194 after writing, and goes 1 again
195 180-190 usec later. Here, we wait
196 up to 250 usec for the RDY bit to
199 retries < loops_per_jiffy / (4000/HZ);
201 if (inb_p(dtlk_port_tts) &
209 if (file->f_flags & O_NONBLOCK)
212 msleep_interruptible(1);
214 if (++retries > 10 * HZ) { /* wait no more than 10 sec
216 printk("dtlk: write timeout. "
217 "inb_p(dtlk_port_tts) = 0x%02x\n",
218 inb_p(dtlk_port_tts));
227 static unsigned int dtlk_poll(struct file *file, poll_table * wait)
230 unsigned long expires;
232 TRACE_TEXT(" dtlk_poll");
236 printk("<%ld>", jiffies-j);
239 poll_wait(file, &dtlk_process_list, wait);
241 if (dtlk_has_indexing && dtlk_readable()) {
242 del_timer(&dtlk_timer);
243 mask = POLLIN | POLLRDNORM;
245 if (dtlk_writeable()) {
246 del_timer(&dtlk_timer);
247 mask |= POLLOUT | POLLWRNORM;
249 /* there are no exception conditions */
251 /* There won't be any interrupts, so we set a timer instead. */
252 expires = jiffies + 3*HZ / 100;
253 mod_timer(&dtlk_timer, expires);
258 static void dtlk_timer_tick(unsigned long data)
260 TRACE_TEXT(" dtlk_timer_tick");
261 wake_up_interruptible(&dtlk_process_list);
264 static int dtlk_ioctl(struct inode *inode,
269 char __user *argp = (char __user *)arg;
270 struct dtlk_settings *sp;
272 TRACE_TEXT(" dtlk_ioctl");
276 case DTLK_INTERROGATE:
277 sp = dtlk_interrogate();
278 if (copy_to_user(argp, sp, sizeof(struct dtlk_settings)))
283 portval = inb_p(dtlk_port_tts);
284 return put_user(portval, argp);
291 static int dtlk_open(struct inode *inode, struct file *file)
293 TRACE_TEXT("(dtlk_open");
295 nonseekable_open(inode, file);
296 switch (iminor(inode)) {
300 return nonseekable_open(inode, file);
307 static int dtlk_release(struct inode *inode, struct file *file)
309 TRACE_TEXT("(dtlk_release");
311 switch (iminor(inode)) {
320 del_timer_sync(&dtlk_timer);
325 static int __init dtlk_init(void)
330 dtlk_major = register_chrdev(0, "dtlk", &dtlk_fops);
331 if (dtlk_major == 0) {
332 printk(KERN_ERR "DoubleTalk PC - cannot register device\n");
335 if (dtlk_dev_probe() == 0)
336 printk(", MAJOR %d\n", dtlk_major);
338 init_waitqueue_head(&dtlk_process_list);
343 static void __exit dtlk_cleanup (void)
345 dtlk_write_bytes("goodbye", 8);
346 msleep_interruptible(500); /* nap 0.50 sec but
351 dtlk_write_tts(DTLK_CLEAR);
352 unregister_chrdev(dtlk_major, "dtlk");
353 release_region(dtlk_port_lpc, DTLK_IO_EXTENT);
356 module_init(dtlk_init);
357 module_exit(dtlk_cleanup);
359 /* ------------------------------------------------------------------------ */
361 static int dtlk_readable(void)
364 printk(" dtlk_readable=%u@%u", inb_p(dtlk_port_lpc) != 0x7f, jiffies);
366 return inb_p(dtlk_port_lpc) != 0x7f;
369 static int dtlk_writeable(void)
371 /* TRACE_TEXT(" dtlk_writeable"); */
373 printk(" dtlk_writeable=%u", (inb_p(dtlk_port_tts) & TTS_WRITABLE)!=0);
375 return inb_p(dtlk_port_tts) & TTS_WRITABLE;
378 static int __init dtlk_dev_probe(void)
380 unsigned int testval = 0;
382 struct dtlk_settings *sp;
384 if (dtlk_port_lpc | dtlk_port_tts)
387 for (i = 0; dtlk_portlist[i]; i++) {
389 printk("DoubleTalk PC - Port %03x = %04x\n",
390 dtlk_portlist[i], (testval = inw_p(dtlk_portlist[i])));
393 if (!request_region(dtlk_portlist[i], DTLK_IO_EXTENT,
396 testval = inw_p(dtlk_portlist[i]);
397 if ((testval &= 0xfbff) == 0x107f) {
398 dtlk_port_lpc = dtlk_portlist[i];
399 dtlk_port_tts = dtlk_port_lpc + 1;
401 sp = dtlk_interrogate();
402 printk("DoubleTalk PC at %03x-%03x, "
403 "ROM version %s, serial number %u",
404 dtlk_portlist[i], dtlk_portlist[i] +
406 sp->rom_version, sp->serial_number);
408 /* put LPC port into known state, so
409 dtlk_readable() gives valid result */
410 outb_p(0xff, dtlk_port_lpc);
412 /* INIT string and index marker */
413 dtlk_write_bytes("\036\1@\0\0012I\r", 8);
414 /* posting an index takes 18 msec. Here, we
415 wait up to 100 msec to see whether it
417 msleep_interruptible(100);
418 dtlk_has_indexing = dtlk_readable();
420 printk(", indexing %d\n", dtlk_has_indexing);
424 /* This macro records ten samples read from the LPC port, for later display */
426 for (i = 0; i < 10; i++) \
428 buffer[b++] = inb_p(dtlk_port_lpc); \
429 __delay(loops_per_jiffy/(1000000/HZ)); \
435 outb_p(0xff, dtlk_port_lpc);
438 dtlk_write_bytes("\0012I\r", 4);
440 __delay(50 * loops_per_jiffy / (1000/HZ));
441 outb_p(0xff, dtlk_port_lpc);
446 for (j = 0; j < b; j++)
447 printk(" %02x", buffer[j]);
454 /* This macro records ten samples read from the TTS port, for later display */
456 for (i = 0; i < 10; i++) \
458 buffer[b++] = inb_p(dtlk_port_tts); \
459 __delay(loops_per_jiffy/(1000000/HZ)); /* 1 us */ \
464 mdelay(10); /* 10 ms */
466 outb_p(0x03, dtlk_port_tts);
472 for (j = 0; j < b; j++)
473 printk(" %02x", buffer[j]);
476 #endif /* OUTSCOPE */
478 dtlk_write_bytes("Double Talk found", 18);
482 release_region(dtlk_portlist[i], DTLK_IO_EXTENT);
485 printk(KERN_INFO "DoubleTalk PC - not found\n");
490 static void dtlk_handle_error(char op, char rc, unsigned int minor)
492 printk(KERN_INFO"\nDoubleTalk PC - MINOR: %d, OPCODE: %d, ERROR: %d\n",
498 /* interrogate the DoubleTalk PC and return its settings */
499 static struct dtlk_settings *dtlk_interrogate(void)
502 static char buf[sizeof(struct dtlk_settings) + 1];
504 static struct dtlk_settings status;
505 TRACE_TEXT("(dtlk_interrogate");
506 dtlk_write_bytes("\030\001?", 3);
507 for (total = 0, i = 0; i < 50; i++) {
508 buf[total] = dtlk_read_tts();
509 if (total > 2 && buf[total] == 0x7f)
511 if (total < sizeof(struct dtlk_settings))
515 if (i==50) printk("interrogate() read overrun\n");
516 for (i=0; i<sizeof(buf); i++)
517 printk(" %02x", buf[i]);
521 status.serial_number = t[0] + t[1] * 256; /* serial number is
527 status.rom_version[i] = *t;
528 if (i < sizeof(status.rom_version) - 1)
532 status.rom_version[i] = 0;
536 status.punc_level = *t++;
537 status.formant_freq = *t++;
540 status.volume = *t++;
542 status.expression = *t++;
543 status.ext_dict_loaded = *t++;
544 status.ext_dict_status = *t++;
545 status.free_ram = *t++;
546 status.articulation = *t++;
547 status.reverb = *t++;
549 status.has_indexing = dtlk_has_indexing;
554 static char dtlk_read_tts(void)
556 int portval, retries = 0;
558 TRACE_TEXT("(dtlk_read_tts");
560 /* verify DT is ready, read char, wait for ACK */
562 portval = inb_p(dtlk_port_tts);
563 } while ((portval & TTS_READABLE) == 0 &&
564 retries++ < DTLK_MAX_RETRIES);
565 if (retries == DTLK_MAX_RETRIES)
566 printk(KERN_ERR "dtlk_read_tts() timeout\n");
568 ch = inb_p(dtlk_port_tts); /* input from TTS port */
570 outb_p(ch, dtlk_port_tts);
574 portval = inb_p(dtlk_port_tts);
575 } while ((portval & TTS_READABLE) != 0 &&
576 retries++ < DTLK_MAX_RETRIES);
577 if (retries == DTLK_MAX_RETRIES)
578 printk(KERN_ERR "dtlk_read_tts() timeout\n");
584 static char dtlk_read_lpc(void)
588 TRACE_TEXT("(dtlk_read_lpc");
590 /* no need to test -- this is only called when the port is readable */
592 ch = inb_p(dtlk_port_lpc); /* input from LPC port */
594 outb_p(0xff, dtlk_port_lpc);
596 /* acknowledging a read takes 3-4
597 usec. Here, we wait up to 20 usec
598 for the acknowledgement */
599 retries = (loops_per_jiffy * 20) / (1000000/HZ);
600 while (inb_p(dtlk_port_lpc) != 0x7f && --retries > 0);
602 printk(KERN_ERR "dtlk_read_lpc() timeout\n");
608 /* write n bytes to tts port */
609 static char dtlk_write_bytes(const char *buf, int n)
612 /* printk("dtlk_write_bytes(\"%-*s\", %d)\n", n, buf, n); */
613 TRACE_TEXT("(dtlk_write_bytes");
615 val = dtlk_write_tts(*buf++);
620 static char dtlk_write_tts(char ch)
624 printk(" dtlk_write_tts(");
625 if (' ' <= ch && ch <= '~')
628 printk("0x%02x", ch);
630 if (ch != DTLK_CLEAR) /* no flow control for CLEAR command */
631 while ((inb_p(dtlk_port_tts) & TTS_WRITABLE) == 0 &&
632 retries++ < DTLK_MAX_RETRIES) /* DT ready? */
634 if (retries == DTLK_MAX_RETRIES)
635 printk(KERN_ERR "dtlk_write_tts() timeout\n");
637 outb_p(ch, dtlk_port_tts); /* output to TTS port */
638 /* the RDY bit goes zero 2-3 usec after writing, and goes
639 1 again 180-190 usec later. Here, we wait up to 10
640 usec for the RDY bit to go zero. */
641 for (retries = 0; retries < loops_per_jiffy / (100000/HZ); retries++)
642 if ((inb_p(dtlk_port_tts) & TTS_WRITABLE) == 0)
651 MODULE_LICENSE("GPL");