4 * driver for the GE IP-OCTAL boards
6 * Copyright (C) 2009-2012 CERN (www.cern.ch)
7 * Author: Nicolas Serafini, EIC2 SA
8 * Author: Samuel Iglesias Gonsalvez <siglesias@igalia.com>
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the Free
12 * Software Foundation; version 2 of the License.
15 #include <linux/device.h>
16 #include <linux/module.h>
17 #include <linux/interrupt.h>
18 #include <linux/sched.h>
19 #include <linux/tty.h>
20 #include <linux/serial.h>
21 #include <linux/tty_flip.h>
22 #include <linux/slab.h>
24 #include <linux/ipack.h>
28 #define IP_OCTAL_ID_SPACE_VECTOR 0x41
29 #define IP_OCTAL_NB_BLOCKS 4
31 static const struct tty_operations ipoctal_fops;
33 struct ipoctal_channel {
34 struct ipoctal_stats stats;
35 unsigned int nb_bytes;
36 wait_queue_head_t queue;
38 unsigned int pointer_read;
39 unsigned int pointer_write;
40 struct tty_port tty_port;
41 union scc2698_channel __iomem *regs;
42 union scc2698_block __iomem *block_regs;
43 unsigned int board_id;
46 unsigned int rx_enable;
50 struct ipack_device *dev;
51 unsigned int board_id;
52 struct ipoctal_channel channel[NR_CHANNELS];
53 struct tty_driver *tty_drv;
54 u8 __iomem *mem8_space;
55 u8 __iomem *int_space;
58 static int ipoctal_port_activate(struct tty_port *port, struct tty_struct *tty)
60 struct ipoctal_channel *channel;
62 channel = dev_get_drvdata(tty->dev);
65 * Enable RX. TX will be enabled when
66 * there is something to send
68 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
69 channel->rx_enable = 1;
73 static int ipoctal_open(struct tty_struct *tty, struct file *file)
75 struct ipoctal_channel *channel;
77 channel = dev_get_drvdata(tty->dev);
78 tty->driver_data = channel;
80 return tty_port_open(&channel->tty_port, tty, file);
83 static void ipoctal_reset_stats(struct ipoctal_stats *stats)
88 stats->framing_err = 0;
89 stats->overrun_err = 0;
90 stats->parity_err = 0;
93 static void ipoctal_free_channel(struct ipoctal_channel *channel)
95 ipoctal_reset_stats(&channel->stats);
96 channel->pointer_read = 0;
97 channel->pointer_write = 0;
98 channel->nb_bytes = 0;
101 static void ipoctal_close(struct tty_struct *tty, struct file *filp)
103 struct ipoctal_channel *channel = tty->driver_data;
105 tty_port_close(&channel->tty_port, tty, filp);
106 ipoctal_free_channel(channel);
109 static int ipoctal_get_icount(struct tty_struct *tty,
110 struct serial_icounter_struct *icount)
112 struct ipoctal_channel *channel = tty->driver_data;
118 icount->rx = channel->stats.rx;
119 icount->tx = channel->stats.tx;
120 icount->frame = channel->stats.framing_err;
121 icount->parity = channel->stats.parity_err;
122 icount->brk = channel->stats.rcv_break;
126 static void ipoctal_irq_rx(struct ipoctal_channel *channel,
127 struct tty_struct *tty, u8 sr)
134 value = ioread8(&channel->regs->r.rhr);
136 /* Error: count statistics */
138 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
140 if (sr & SR_OVERRUN_ERROR) {
141 channel->stats.overrun_err++;
142 /* Overrun doesn't affect the current character*/
143 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
145 if (sr & SR_PARITY_ERROR) {
146 channel->stats.parity_err++;
149 if (sr & SR_FRAMING_ERROR) {
150 channel->stats.framing_err++;
153 if (sr & SR_RECEIVED_BREAK) {
154 iowrite8(CR_CMD_RESET_BREAK_CHANGE, &channel->regs->w.cr);
155 channel->stats.rcv_break++;
159 tty_insert_flip_char(tty, value, flag);
161 /* Check if there are more characters in RX FIFO
162 * If there are more, the isr register for this channel
163 * has enabled the RxRDY|FFULL bit.
165 isr = ioread8(&channel->block_regs->r.isr);
166 sr = ioread8(&channel->regs->r.sr);
167 } while (isr & channel->isr_rx_rdy_mask);
169 tty_flip_buffer_push(tty);
172 static void ipoctal_irq_tx(struct ipoctal_channel *channel)
175 unsigned int *pointer_write = &channel->pointer_write;
177 if (channel->nb_bytes == 0)
180 value = channel->tty_port.xmit_buf[*pointer_write];
181 iowrite8(value, &channel->regs->w.thr);
184 *pointer_write = *pointer_write % PAGE_SIZE;
188 static void ipoctal_irq_channel(struct ipoctal_channel *channel)
191 struct tty_struct *tty;
193 tty = tty_port_tty_get(&channel->tty_port);
197 spin_lock(&channel->lock);
198 /* The HW is organized in pair of channels. See which register we need
200 isr = ioread8(&channel->block_regs->r.isr);
201 sr = ioread8(&channel->regs->r.sr);
203 if ((sr & SR_TX_EMPTY) && (channel->nb_bytes == 0)) {
204 iowrite8(CR_DISABLE_TX, &channel->regs->w.cr);
205 /* In case of RS-485, change from TX to RX when finishing TX.
207 if (channel->board_id == IPACK1_DEVICE_ID_SBS_OCTAL_485) {
208 iowrite8(CR_CMD_NEGATE_RTSN, &channel->regs->w.cr);
209 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
210 channel->rx_enable = 1;
215 if ((isr & channel->isr_rx_rdy_mask) && (sr & SR_RX_READY))
216 ipoctal_irq_rx(channel, tty, sr);
218 /* TX of each character */
219 if ((isr & channel->isr_tx_rdy_mask) && (sr & SR_TX_READY))
220 ipoctal_irq_tx(channel);
223 spin_unlock(&channel->lock);
226 static irqreturn_t ipoctal_irq_handler(void *arg)
229 struct ipoctal *ipoctal = (struct ipoctal *) arg;
231 /* Clear the IPack device interrupt */
232 readw(ipoctal->int_space + ACK_INT_REQ0);
233 readw(ipoctal->int_space + ACK_INT_REQ1);
235 /* Check all channels */
236 for (i = 0; i < NR_CHANNELS; i++)
237 ipoctal_irq_channel(&ipoctal->channel[i]);
242 static const struct tty_port_operations ipoctal_tty_port_ops = {
244 .activate = ipoctal_port_activate,
247 static int ipoctal_inst_slot(struct ipoctal *ipoctal, unsigned int bus_nr,
252 struct tty_driver *tty;
254 struct ipoctal_channel *channel;
255 struct ipack_region *region;
257 union scc2698_channel __iomem *chan_regs;
258 union scc2698_block __iomem *block_regs;
260 ipoctal->board_id = ipoctal->dev->id_device;
262 region = &ipoctal->dev->region[IPACK_IO_SPACE];
263 addr = devm_ioremap_nocache(&ipoctal->dev->dev,
264 region->start, region->size);
266 dev_err(&ipoctal->dev->dev,
267 "Unable to map slot [%d:%d] IO space!\n",
269 return -EADDRNOTAVAIL;
271 /* Save the virtual address to access the registers easily */
273 (union scc2698_channel __iomem *) addr;
275 (union scc2698_block __iomem *) addr;
277 region = &ipoctal->dev->region[IPACK_INT_SPACE];
279 devm_ioremap_nocache(&ipoctal->dev->dev,
280 region->start, region->size);
281 if (!ipoctal->int_space) {
282 dev_err(&ipoctal->dev->dev,
283 "Unable to map slot [%d:%d] INT space!\n",
285 return -EADDRNOTAVAIL;
288 region = &ipoctal->dev->region[IPACK_MEM8_SPACE];
289 ipoctal->mem8_space =
290 devm_ioremap_nocache(&ipoctal->dev->dev,
291 region->start, 0x8000);
292 if (!ipoctal->mem8_space) {
293 dev_err(&ipoctal->dev->dev,
294 "Unable to map slot [%d:%d] MEM8 space!\n",
296 return -EADDRNOTAVAIL;
300 /* Disable RX and TX before touching anything */
301 for (i = 0; i < NR_CHANNELS ; i++) {
302 struct ipoctal_channel *channel = &ipoctal->channel[i];
303 channel->regs = chan_regs + i;
304 channel->block_regs = block_regs + (i >> 1);
305 channel->board_id = ipoctal->board_id;
307 channel->isr_tx_rdy_mask = ISR_TxRDY_B;
308 channel->isr_rx_rdy_mask = ISR_RxRDY_FFULL_B;
310 channel->isr_tx_rdy_mask = ISR_TxRDY_A;
311 channel->isr_rx_rdy_mask = ISR_RxRDY_FFULL_A;
314 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
315 channel->rx_enable = 0;
316 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
317 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
318 iowrite8(MR1_CHRL_8_BITS | MR1_ERROR_CHAR | MR1_RxINT_RxRDY,
319 &channel->regs->w.mr); /* mr1 */
320 iowrite8(0, &channel->regs->w.mr); /* mr2 */
321 iowrite8(TX_CLK_9600 | RX_CLK_9600, &channel->regs->w.csr);
324 for (i = 0; i < IP_OCTAL_NB_BLOCKS; i++) {
325 iowrite8(ACR_BRG_SET2, &block_regs[i].w.acr);
326 iowrite8(OPCR_MPP_OUTPUT | OPCR_MPOa_RTSN | OPCR_MPOb_RTSN,
327 &block_regs[i].w.opcr);
328 iowrite8(IMR_TxRDY_A | IMR_RxRDY_FFULL_A | IMR_DELTA_BREAK_A |
329 IMR_TxRDY_B | IMR_RxRDY_FFULL_B | IMR_DELTA_BREAK_B,
330 &block_regs[i].w.imr);
334 * IP-OCTAL has different addresses to copy its IRQ vector.
335 * Depending of the carrier these addresses are accesible or not.
336 * More info in the datasheet.
338 ipoctal->dev->bus->ops->request_irq(ipoctal->dev,
339 ipoctal_irq_handler, ipoctal);
341 iowrite8(1, ipoctal->mem8_space + 1);
343 /* Register the TTY device */
345 /* Each IP-OCTAL channel is a TTY port */
346 tty = alloc_tty_driver(NR_CHANNELS);
351 /* Fill struct tty_driver with ipoctal data */
352 tty->owner = THIS_MODULE;
353 tty->driver_name = KBUILD_MODNAME;
354 sprintf(name, KBUILD_MODNAME ".%d.%d.", bus_nr, slot);
358 tty->minor_start = 0;
359 tty->type = TTY_DRIVER_TYPE_SERIAL;
360 tty->subtype = SERIAL_TYPE_NORMAL;
361 tty->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
362 tty->init_termios = tty_std_termios;
363 tty->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
364 tty->init_termios.c_ispeed = 9600;
365 tty->init_termios.c_ospeed = 9600;
367 tty_set_operations(tty, &ipoctal_fops);
368 res = tty_register_driver(tty);
370 dev_err(&ipoctal->dev->dev, "Can't register tty driver.\n");
375 /* Save struct tty_driver for use it when uninstalling the device */
376 ipoctal->tty_drv = tty;
378 for (i = 0; i < NR_CHANNELS; i++) {
379 struct device *tty_dev;
381 channel = &ipoctal->channel[i];
382 tty_port_init(&channel->tty_port);
383 tty_port_alloc_xmit_buf(&channel->tty_port);
384 channel->tty_port.ops = &ipoctal_tty_port_ops;
386 ipoctal_reset_stats(&channel->stats);
387 channel->nb_bytes = 0;
388 spin_lock_init(&channel->lock);
389 channel->pointer_read = 0;
390 channel->pointer_write = 0;
391 tty_dev = tty_port_register_device(&channel->tty_port, tty, i, NULL);
392 if (IS_ERR(tty_dev)) {
393 dev_err(&ipoctal->dev->dev, "Failed to register tty device.\n");
394 tty_port_destroy(&channel->tty_port);
397 dev_set_drvdata(tty_dev, channel);
403 static inline int ipoctal_copy_write_buffer(struct ipoctal_channel *channel,
404 const unsigned char *buf,
409 unsigned int *pointer_read = &channel->pointer_read;
411 /* Copy the bytes from the user buffer to the internal one */
412 for (i = 0; i < count; i++) {
413 if (i <= (PAGE_SIZE - channel->nb_bytes)) {
414 spin_lock_irqsave(&channel->lock, flags);
415 channel->tty_port.xmit_buf[*pointer_read] = buf[i];
416 *pointer_read = (*pointer_read + 1) % PAGE_SIZE;
418 spin_unlock_irqrestore(&channel->lock, flags);
426 static int ipoctal_write_tty(struct tty_struct *tty,
427 const unsigned char *buf, int count)
429 struct ipoctal_channel *channel = tty->driver_data;
430 unsigned int char_copied;
432 char_copied = ipoctal_copy_write_buffer(channel, buf, count);
434 /* As the IP-OCTAL 485 only supports half duplex, do it manually */
435 if (channel->board_id == IPACK1_DEVICE_ID_SBS_OCTAL_485) {
436 iowrite8(CR_DISABLE_RX, &channel->regs->w.cr);
437 channel->rx_enable = 0;
438 iowrite8(CR_CMD_ASSERT_RTSN, &channel->regs->w.cr);
442 * Send a packet and then disable TX to avoid failure after several send
445 iowrite8(CR_ENABLE_TX, &channel->regs->w.cr);
449 static int ipoctal_write_room(struct tty_struct *tty)
451 struct ipoctal_channel *channel = tty->driver_data;
453 return PAGE_SIZE - channel->nb_bytes;
456 static int ipoctal_chars_in_buffer(struct tty_struct *tty)
458 struct ipoctal_channel *channel = tty->driver_data;
460 return channel->nb_bytes;
463 static void ipoctal_set_termios(struct tty_struct *tty,
464 struct ktermios *old_termios)
467 unsigned char mr1 = 0;
468 unsigned char mr2 = 0;
469 unsigned char csr = 0;
470 struct ipoctal_channel *channel = tty->driver_data;
473 cflag = tty->termios.c_cflag;
475 /* Disable and reset everything before change the setup */
476 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
477 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
478 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
479 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
480 iowrite8(CR_CMD_RESET_MR, &channel->regs->w.cr);
482 /* Set Bits per chars */
483 switch (cflag & CSIZE) {
485 mr1 |= MR1_CHRL_6_BITS;
488 mr1 |= MR1_CHRL_7_BITS;
492 mr1 |= MR1_CHRL_8_BITS;
493 /* By default, select CS8 */
494 tty->termios.c_cflag = (cflag & ~CSIZE) | CS8;
501 mr1 |= MR1_PARITY_ON | MR1_PARITY_ODD;
503 mr1 |= MR1_PARITY_ON | MR1_PARITY_EVEN;
505 mr1 |= MR1_PARITY_OFF;
507 /* Mark or space parity is not supported */
508 tty->termios.c_cflag &= ~CMSPAR;
512 mr2 |= MR2_STOP_BITS_LENGTH_2;
514 mr2 |= MR2_STOP_BITS_LENGTH_1;
516 /* Set the flow control */
517 switch (channel->board_id) {
518 case IPACK1_DEVICE_ID_SBS_OCTAL_232:
519 if (cflag & CRTSCTS) {
520 mr1 |= MR1_RxRTS_CONTROL_ON;
521 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_ON;
523 mr1 |= MR1_RxRTS_CONTROL_OFF;
524 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_OFF;
527 case IPACK1_DEVICE_ID_SBS_OCTAL_422:
528 mr1 |= MR1_RxRTS_CONTROL_OFF;
529 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_OFF;
531 case IPACK1_DEVICE_ID_SBS_OCTAL_485:
532 mr1 |= MR1_RxRTS_CONTROL_OFF;
533 mr2 |= MR2_TxRTS_CONTROL_ON | MR2_CTS_ENABLE_TX_OFF;
540 baud = tty_get_baud_rate(tty);
541 tty_termios_encode_baud_rate(&tty->termios, baud, baud);
546 csr |= TX_CLK_75 | RX_CLK_75;
549 csr |= TX_CLK_110 | RX_CLK_110;
552 csr |= TX_CLK_150 | RX_CLK_150;
555 csr |= TX_CLK_300 | RX_CLK_300;
558 csr |= TX_CLK_600 | RX_CLK_600;
561 csr |= TX_CLK_1200 | RX_CLK_1200;
564 csr |= TX_CLK_1800 | RX_CLK_1800;
567 csr |= TX_CLK_2000 | RX_CLK_2000;
570 csr |= TX_CLK_2400 | RX_CLK_2400;
573 csr |= TX_CLK_4800 | RX_CLK_4800;
576 csr |= TX_CLK_9600 | RX_CLK_9600;
579 csr |= TX_CLK_19200 | RX_CLK_19200;
583 csr |= TX_CLK_38400 | RX_CLK_38400;
584 /* In case of default, we establish 38400 bps */
585 tty_termios_encode_baud_rate(&tty->termios, 38400, 38400);
589 mr1 |= MR1_ERROR_CHAR;
590 mr1 |= MR1_RxINT_RxRDY;
592 /* Write the control registers */
593 iowrite8(mr1, &channel->regs->w.mr);
594 iowrite8(mr2, &channel->regs->w.mr);
595 iowrite8(csr, &channel->regs->w.csr);
597 /* Enable again the RX, if it was before */
598 if (channel->rx_enable)
599 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
602 static void ipoctal_hangup(struct tty_struct *tty)
605 struct ipoctal_channel *channel = tty->driver_data;
610 spin_lock_irqsave(&channel->lock, flags);
611 channel->nb_bytes = 0;
612 channel->pointer_read = 0;
613 channel->pointer_write = 0;
614 spin_unlock_irqrestore(&channel->lock, flags);
616 tty_port_hangup(&channel->tty_port);
618 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
619 channel->rx_enable = 0;
620 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
621 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
622 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
623 iowrite8(CR_CMD_RESET_MR, &channel->regs->w.cr);
625 clear_bit(ASYNCB_INITIALIZED, &channel->tty_port.flags);
626 wake_up_interruptible(&channel->tty_port.open_wait);
629 static void ipoctal_shutdown(struct tty_struct *tty)
631 struct ipoctal_channel *channel = tty->driver_data;
636 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
637 channel->rx_enable = 0;
638 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
639 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
640 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
641 iowrite8(CR_CMD_RESET_MR, &channel->regs->w.cr);
642 clear_bit(ASYNCB_INITIALIZED, &channel->tty_port.flags);
645 static const struct tty_operations ipoctal_fops = {
647 .open = ipoctal_open,
648 .close = ipoctal_close,
649 .write = ipoctal_write_tty,
650 .set_termios = ipoctal_set_termios,
651 .write_room = ipoctal_write_room,
652 .chars_in_buffer = ipoctal_chars_in_buffer,
653 .get_icount = ipoctal_get_icount,
654 .hangup = ipoctal_hangup,
655 .shutdown = ipoctal_shutdown,
658 static int ipoctal_probe(struct ipack_device *dev)
661 struct ipoctal *ipoctal;
663 ipoctal = kzalloc(sizeof(struct ipoctal), GFP_KERNEL);
668 res = ipoctal_inst_slot(ipoctal, dev->bus->bus_nr, dev->slot);
672 dev_set_drvdata(&dev->dev, ipoctal);
680 static void __ipoctal_remove(struct ipoctal *ipoctal)
684 ipoctal->dev->bus->ops->free_irq(ipoctal->dev);
686 for (i = 0; i < NR_CHANNELS; i++) {
687 struct ipoctal_channel *channel = &ipoctal->channel[i];
688 tty_unregister_device(ipoctal->tty_drv, i);
689 tty_port_free_xmit_buf(&channel->tty_port);
690 tty_port_destroy(&channel->tty_port);
693 tty_unregister_driver(ipoctal->tty_drv);
694 put_tty_driver(ipoctal->tty_drv);
698 static void ipoctal_remove(struct ipack_device *idev)
700 __ipoctal_remove(dev_get_drvdata(&idev->dev));
703 static DEFINE_IPACK_DEVICE_TABLE(ipoctal_ids) = {
704 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
705 IPACK1_DEVICE_ID_SBS_OCTAL_232) },
706 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
707 IPACK1_DEVICE_ID_SBS_OCTAL_422) },
708 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
709 IPACK1_DEVICE_ID_SBS_OCTAL_485) },
713 MODULE_DEVICE_TABLE(ipack, ipoctal_ids);
715 static const struct ipack_driver_ops ipoctal_drv_ops = {
716 .probe = ipoctal_probe,
717 .remove = ipoctal_remove,
720 static struct ipack_driver driver = {
721 .ops = &ipoctal_drv_ops,
722 .id_table = ipoctal_ids,
725 static int __init ipoctal_init(void)
727 return ipack_driver_register(&driver, THIS_MODULE, KBUILD_MODNAME);
730 static void __exit ipoctal_exit(void)
732 ipack_driver_unregister(&driver);
735 MODULE_DESCRIPTION("IP-Octal 232, 422 and 485 device driver");
736 MODULE_LICENSE("GPL");
738 module_init(ipoctal_init);
739 module_exit(ipoctal_exit);