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>
23 #include <linux/atomic.h>
25 #include <linux/ipack.h>
29 #define IP_OCTAL_ID_SPACE_VECTOR 0x41
30 #define IP_OCTAL_NB_BLOCKS 4
32 static const struct tty_operations ipoctal_fops;
34 struct ipoctal_channel {
35 struct ipoctal_stats stats;
36 unsigned int nb_bytes;
37 wait_queue_head_t queue;
39 unsigned int pointer_read;
40 unsigned int pointer_write;
42 struct tty_port tty_port;
43 union scc2698_channel __iomem *regs;
44 union scc2698_block __iomem *block_regs;
45 unsigned int board_id;
46 unsigned char *board_write;
52 struct ipack_device *dev;
53 unsigned int board_id;
54 struct ipoctal_channel channel[NR_CHANNELS];
56 struct tty_driver *tty_drv;
57 u8 __iomem *mem8_space;
58 u8 __iomem *int_space;
61 static int ipoctal_port_activate(struct tty_port *port, struct tty_struct *tty)
63 struct ipoctal_channel *channel;
65 channel = dev_get_drvdata(tty->dev);
67 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
71 static int ipoctal_open(struct tty_struct *tty, struct file *file)
74 struct ipoctal_channel *channel;
76 channel = dev_get_drvdata(tty->dev);
78 if (atomic_read(&channel->open))
81 tty->driver_data = channel;
83 res = tty_port_open(&channel->tty_port, tty, file);
87 atomic_inc(&channel->open);
91 static void ipoctal_reset_stats(struct ipoctal_stats *stats)
96 stats->framing_err = 0;
97 stats->overrun_err = 0;
98 stats->parity_err = 0;
101 static void ipoctal_free_channel(struct ipoctal_channel *channel)
103 ipoctal_reset_stats(&channel->stats);
104 channel->pointer_read = 0;
105 channel->pointer_write = 0;
106 channel->nb_bytes = 0;
109 static void ipoctal_close(struct tty_struct *tty, struct file *filp)
111 struct ipoctal_channel *channel = tty->driver_data;
113 tty_port_close(&channel->tty_port, tty, filp);
115 if (atomic_dec_and_test(&channel->open))
116 ipoctal_free_channel(channel);
119 static int ipoctal_get_icount(struct tty_struct *tty,
120 struct serial_icounter_struct *icount)
122 struct ipoctal_channel *channel = tty->driver_data;
128 icount->rx = channel->stats.rx;
129 icount->tx = channel->stats.tx;
130 icount->frame = channel->stats.framing_err;
131 icount->parity = channel->stats.parity_err;
132 icount->brk = channel->stats.rcv_break;
136 static void ipoctal_irq_rx(struct ipoctal_channel *channel,
137 struct tty_struct *tty, u8 sr)
140 unsigned char flag = TTY_NORMAL;
144 value = ioread8(&channel->regs->r.rhr);
145 /* Error: count statistics */
147 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
149 if (sr & SR_OVERRUN_ERROR) {
150 channel->stats.overrun_err++;
151 /* Overrun doesn't affect the current character*/
152 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
154 if (sr & SR_PARITY_ERROR) {
155 channel->stats.parity_err++;
158 if (sr & SR_FRAMING_ERROR) {
159 channel->stats.framing_err++;
162 if (sr & SR_RECEIVED_BREAK) {
163 iowrite8(CR_CMD_RESET_BREAK_CHANGE, &channel->regs->w.cr);
164 channel->stats.rcv_break++;
168 tty_insert_flip_char(tty, value, flag);
170 /* Check if there are more characters in RX FIFO
171 * If there are more, the isr register for this channel
172 * has enabled the RxRDY|FFULL bit.
174 isr = ioread8(&channel->block_regs->r.isr);
175 sr = ioread8(&channel->regs->r.sr);
176 } while (isr & channel->isr_rx_rdy_mask);
178 tty_flip_buffer_push(tty);
181 static void ipoctal_irq_tx(struct ipoctal_channel *channel)
184 unsigned int *pointer_write = &channel->pointer_write;
186 if (channel->nb_bytes <= 0) {
187 channel->nb_bytes = 0;
191 value = channel->tty_port.xmit_buf[*pointer_write];
192 iowrite8(value, &channel->regs->w.thr);
195 *pointer_write = *pointer_write % PAGE_SIZE;
198 if (channel->nb_bytes == 0 &&
199 channel->board_id != IPACK1_DEVICE_ID_SBS_OCTAL_485) {
200 *channel->board_write = 1;
201 wake_up_interruptible(&channel->queue);
205 static void ipoctal_irq_channel(struct ipoctal_channel *channel)
208 struct tty_struct *tty;
210 /* If there is no client, skip the check */
211 if (!atomic_read(&channel->open))
214 tty = tty_port_tty_get(&channel->tty_port);
217 /* The HW is organized in pair of channels. See which register we need
219 isr = ioread8(&channel->block_regs->r.isr);
220 sr = ioread8(&channel->regs->r.sr);
222 /* In case of RS-485, change from TX to RX when finishing TX.
224 if ((channel->board_id == IPACK1_DEVICE_ID_SBS_OCTAL_485) &&
225 (sr & SR_TX_EMPTY) && (channel->nb_bytes == 0)) {
226 iowrite8(CR_DISABLE_TX, &channel->regs->w.cr);
227 iowrite8(CR_CMD_NEGATE_RTSN, &channel->regs->w.cr);
228 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
229 *channel->board_write = 1;
230 wake_up_interruptible(&channel->queue);
234 if ((isr & channel->isr_rx_rdy_mask) && (sr & SR_RX_READY))
235 ipoctal_irq_rx(channel, tty, sr);
237 /* TX of each character */
238 if ((isr & channel->isr_tx_rdy_mask) && (sr & SR_TX_READY))
239 ipoctal_irq_tx(channel);
241 tty_flip_buffer_push(tty);
245 static irqreturn_t ipoctal_irq_handler(void *arg)
248 struct ipoctal *ipoctal = (struct ipoctal *) arg;
250 /* Check all channels */
251 for (i = 0; i < NR_CHANNELS; i++)
252 ipoctal_irq_channel(&ipoctal->channel[i]);
254 /* Clear the IPack device interrupt */
255 readw(ipoctal->int_space + ACK_INT_REQ0);
256 readw(ipoctal->int_space + ACK_INT_REQ1);
261 static const struct tty_port_operations ipoctal_tty_port_ops = {
263 .activate = ipoctal_port_activate,
266 static int ipoctal_inst_slot(struct ipoctal *ipoctal, unsigned int bus_nr,
271 struct tty_driver *tty;
273 struct ipoctal_channel *channel;
274 struct ipack_region *region;
276 union scc2698_channel __iomem *chan_regs;
277 union scc2698_block __iomem *block_regs;
279 ipoctal->board_id = ipoctal->dev->id_device;
281 region = &ipoctal->dev->region[IPACK_IO_SPACE];
282 addr = devm_ioremap_nocache(&ipoctal->dev->dev,
283 region->start, region->size);
285 dev_err(&ipoctal->dev->dev,
286 "Unable to map slot [%d:%d] IO space!\n",
288 return -EADDRNOTAVAIL;
290 /* Save the virtual address to access the registers easily */
292 (union scc2698_channel __iomem *) addr;
294 (union scc2698_block __iomem *) addr;
296 region = &ipoctal->dev->region[IPACK_INT_SPACE];
298 devm_ioremap_nocache(&ipoctal->dev->dev,
299 region->start, region->size);
300 if (!ipoctal->int_space) {
301 dev_err(&ipoctal->dev->dev,
302 "Unable to map slot [%d:%d] INT space!\n",
304 return -EADDRNOTAVAIL;
307 region = &ipoctal->dev->region[IPACK_MEM8_SPACE];
308 ipoctal->mem8_space =
309 devm_ioremap_nocache(&ipoctal->dev->dev,
310 region->start, 0x8000);
312 dev_err(&ipoctal->dev->dev,
313 "Unable to map slot [%d:%d] MEM8 space!\n",
315 return -EADDRNOTAVAIL;
319 /* Disable RX and TX before touching anything */
320 for (i = 0; i < NR_CHANNELS ; i++) {
321 struct ipoctal_channel *channel = &ipoctal->channel[i];
322 channel->regs = chan_regs + i;
323 channel->block_regs = block_regs + (i >> 1);
324 channel->board_write = &ipoctal->write;
325 channel->board_id = ipoctal->board_id;
327 channel->isr_tx_rdy_mask = ISR_TxRDY_B;
328 channel->isr_rx_rdy_mask = ISR_RxRDY_FFULL_B;
330 channel->isr_tx_rdy_mask = ISR_TxRDY_A;
331 channel->isr_rx_rdy_mask = ISR_RxRDY_FFULL_A;
334 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
335 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
336 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
337 iowrite8(MR1_CHRL_8_BITS | MR1_ERROR_CHAR | MR1_RxINT_RxRDY,
338 &channel->regs->w.mr); /* mr1 */
339 iowrite8(0, &channel->regs->w.mr); /* mr2 */
340 iowrite8(TX_CLK_9600 | RX_CLK_9600, &channel->regs->w.csr);
343 for (i = 0; i < IP_OCTAL_NB_BLOCKS; i++) {
344 iowrite8(ACR_BRG_SET2, &block_regs[i].w.acr);
345 iowrite8(OPCR_MPP_OUTPUT | OPCR_MPOa_RTSN | OPCR_MPOb_RTSN,
346 &block_regs[i].w.opcr);
347 iowrite8(IMR_TxRDY_A | IMR_RxRDY_FFULL_A | IMR_DELTA_BREAK_A |
348 IMR_TxRDY_B | IMR_RxRDY_FFULL_B | IMR_DELTA_BREAK_B,
349 &block_regs[i].w.imr);
353 * IP-OCTAL has different addresses to copy its IRQ vector.
354 * Depending of the carrier these addresses are accesible or not.
355 * More info in the datasheet.
357 ipoctal->dev->bus->ops->request_irq(ipoctal->dev,
358 ipoctal_irq_handler, ipoctal);
360 iowrite8(1, ipoctal->mem8_space + 1);
362 /* Register the TTY device */
364 /* Each IP-OCTAL channel is a TTY port */
365 tty = alloc_tty_driver(NR_CHANNELS);
370 /* Fill struct tty_driver with ipoctal data */
371 tty->owner = THIS_MODULE;
372 tty->driver_name = KBUILD_MODNAME;
373 sprintf(name, KBUILD_MODNAME ".%d.%d.", bus_nr, slot);
377 tty->minor_start = 0;
378 tty->type = TTY_DRIVER_TYPE_SERIAL;
379 tty->subtype = SERIAL_TYPE_NORMAL;
380 tty->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
381 tty->init_termios = tty_std_termios;
382 tty->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
383 tty->init_termios.c_ispeed = 9600;
384 tty->init_termios.c_ospeed = 9600;
386 tty_set_operations(tty, &ipoctal_fops);
387 res = tty_register_driver(tty);
389 dev_err(&ipoctal->dev->dev, "Can't register tty driver.\n");
394 /* Save struct tty_driver for use it when uninstalling the device */
395 ipoctal->tty_drv = tty;
397 for (i = 0; i < NR_CHANNELS; i++) {
398 struct device *tty_dev;
400 channel = &ipoctal->channel[i];
401 tty_port_init(&channel->tty_port);
402 tty_port_alloc_xmit_buf(&channel->tty_port);
403 channel->tty_port.ops = &ipoctal_tty_port_ops;
405 ipoctal_reset_stats(&channel->stats);
406 channel->nb_bytes = 0;
407 init_waitqueue_head(&channel->queue);
409 spin_lock_init(&channel->lock);
410 channel->pointer_read = 0;
411 channel->pointer_write = 0;
412 tty_dev = tty_port_register_device(&channel->tty_port, tty, i, NULL);
413 if (IS_ERR(tty_dev)) {
414 dev_err(&ipoctal->dev->dev, "Failed to register tty device.\n");
415 tty_port_destroy(&channel->tty_port);
418 dev_set_drvdata(tty_dev, channel);
421 * Enable again the RX. TX will be enabled when
422 * there is something to send
424 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
430 static inline int ipoctal_copy_write_buffer(struct ipoctal_channel *channel,
431 const unsigned char *buf,
436 unsigned int *pointer_read = &channel->pointer_read;
438 /* Copy the bytes from the user buffer to the internal one */
439 for (i = 0; i < count; i++) {
440 if (i <= (PAGE_SIZE - channel->nb_bytes)) {
441 spin_lock_irqsave(&channel->lock, flags);
442 channel->tty_port.xmit_buf[*pointer_read] = buf[i];
443 *pointer_read = (*pointer_read + 1) % PAGE_SIZE;
445 spin_unlock_irqrestore(&channel->lock, flags);
453 static int ipoctal_write_tty(struct tty_struct *tty,
454 const unsigned char *buf, int count)
456 struct ipoctal_channel *channel = tty->driver_data;
457 unsigned int char_copied;
459 char_copied = ipoctal_copy_write_buffer(channel, buf, count);
461 /* As the IP-OCTAL 485 only supports half duplex, do it manually */
462 if (channel->board_id == IPACK1_DEVICE_ID_SBS_OCTAL_485) {
463 iowrite8(CR_DISABLE_RX, &channel->regs->w.cr);
464 iowrite8(CR_CMD_ASSERT_RTSN, &channel->regs->w.cr);
468 * Send a packet and then disable TX to avoid failure after several send
471 iowrite8(CR_ENABLE_TX, &channel->regs->w.cr);
472 wait_event_interruptible(channel->queue, *channel->board_write);
473 iowrite8(CR_DISABLE_TX, &channel->regs->w.cr);
475 *channel->board_write = 0;
479 static int ipoctal_write_room(struct tty_struct *tty)
481 struct ipoctal_channel *channel = tty->driver_data;
483 return PAGE_SIZE - channel->nb_bytes;
486 static int ipoctal_chars_in_buffer(struct tty_struct *tty)
488 struct ipoctal_channel *channel = tty->driver_data;
490 return channel->nb_bytes;
493 static void ipoctal_set_termios(struct tty_struct *tty,
494 struct ktermios *old_termios)
497 unsigned char mr1 = 0;
498 unsigned char mr2 = 0;
499 unsigned char csr = 0;
500 struct ipoctal_channel *channel = tty->driver_data;
503 cflag = tty->termios.c_cflag;
505 /* Disable and reset everything before change the setup */
506 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
507 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
508 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
509 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
510 iowrite8(CR_CMD_RESET_MR, &channel->regs->w.cr);
512 /* Set Bits per chars */
513 switch (cflag & CSIZE) {
515 mr1 |= MR1_CHRL_6_BITS;
518 mr1 |= MR1_CHRL_7_BITS;
522 mr1 |= MR1_CHRL_8_BITS;
523 /* By default, select CS8 */
524 tty->termios.c_cflag = (cflag & ~CSIZE) | CS8;
531 mr1 |= MR1_PARITY_ON | MR1_PARITY_ODD;
533 mr1 |= MR1_PARITY_ON | MR1_PARITY_EVEN;
535 mr1 |= MR1_PARITY_OFF;
537 /* Mark or space parity is not supported */
538 tty->termios.c_cflag &= ~CMSPAR;
542 mr2 |= MR2_STOP_BITS_LENGTH_2;
544 mr2 |= MR2_STOP_BITS_LENGTH_1;
546 /* Set the flow control */
547 switch (channel->board_id) {
548 case IPACK1_DEVICE_ID_SBS_OCTAL_232:
549 if (cflag & CRTSCTS) {
550 mr1 |= MR1_RxRTS_CONTROL_ON;
551 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_ON;
553 mr1 |= MR1_RxRTS_CONTROL_OFF;
554 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_OFF;
557 case IPACK1_DEVICE_ID_SBS_OCTAL_422:
558 mr1 |= MR1_RxRTS_CONTROL_OFF;
559 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_OFF;
561 case IPACK1_DEVICE_ID_SBS_OCTAL_485:
562 mr1 |= MR1_RxRTS_CONTROL_OFF;
563 mr2 |= MR2_TxRTS_CONTROL_ON | MR2_CTS_ENABLE_TX_OFF;
570 baud = tty_get_baud_rate(tty);
571 tty_termios_encode_baud_rate(&tty->termios, baud, baud);
576 csr |= TX_CLK_75 | RX_CLK_75;
579 csr |= TX_CLK_110 | RX_CLK_110;
582 csr |= TX_CLK_150 | RX_CLK_150;
585 csr |= TX_CLK_300 | RX_CLK_300;
588 csr |= TX_CLK_600 | RX_CLK_600;
591 csr |= TX_CLK_1200 | RX_CLK_1200;
594 csr |= TX_CLK_1800 | RX_CLK_1800;
597 csr |= TX_CLK_2000 | RX_CLK_2000;
600 csr |= TX_CLK_2400 | RX_CLK_2400;
603 csr |= TX_CLK_4800 | RX_CLK_4800;
606 csr |= TX_CLK_9600 | RX_CLK_9600;
609 csr |= TX_CLK_19200 | RX_CLK_19200;
613 csr |= TX_CLK_38400 | RX_CLK_38400;
614 /* In case of default, we establish 38400 bps */
615 tty_termios_encode_baud_rate(&tty->termios, 38400, 38400);
619 mr1 |= MR1_ERROR_CHAR;
620 mr1 |= MR1_RxINT_RxRDY;
622 /* Write the control registers */
623 iowrite8(mr1, &channel->regs->w.mr);
624 iowrite8(mr2, &channel->regs->w.mr);
625 iowrite8(csr, &channel->regs->w.csr);
627 /* Enable again the RX */
628 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
631 static void ipoctal_hangup(struct tty_struct *tty)
634 struct ipoctal_channel *channel = tty->driver_data;
639 spin_lock_irqsave(&channel->lock, flags);
640 channel->nb_bytes = 0;
641 channel->pointer_read = 0;
642 channel->pointer_write = 0;
643 spin_unlock_irqrestore(&channel->lock, flags);
645 tty_port_hangup(&channel->tty_port);
647 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
648 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
649 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
650 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
651 iowrite8(CR_CMD_RESET_MR, &channel->regs->w.cr);
653 clear_bit(ASYNCB_INITIALIZED, &channel->tty_port.flags);
654 wake_up_interruptible(&channel->tty_port.open_wait);
657 static const struct tty_operations ipoctal_fops = {
659 .open = ipoctal_open,
660 .close = ipoctal_close,
661 .write = ipoctal_write_tty,
662 .set_termios = ipoctal_set_termios,
663 .write_room = ipoctal_write_room,
664 .chars_in_buffer = ipoctal_chars_in_buffer,
665 .get_icount = ipoctal_get_icount,
666 .hangup = ipoctal_hangup,
669 static int ipoctal_probe(struct ipack_device *dev)
672 struct ipoctal *ipoctal;
674 ipoctal = kzalloc(sizeof(struct ipoctal), GFP_KERNEL);
679 res = ipoctal_inst_slot(ipoctal, dev->bus->bus_nr, dev->slot);
683 dev_set_drvdata(&dev->dev, ipoctal);
691 static void __ipoctal_remove(struct ipoctal *ipoctal)
695 ipoctal->dev->bus->ops->free_irq(ipoctal->dev);
697 for (i = 0; i < NR_CHANNELS; i++) {
698 struct ipoctal_channel *channel = &ipoctal->channel[i];
699 tty_unregister_device(ipoctal->tty_drv, i);
700 tty_port_free_xmit_buf(&channel->tty_port);
701 tty_port_destroy(&channel->tty_port);
704 tty_unregister_driver(ipoctal->tty_drv);
705 put_tty_driver(ipoctal->tty_drv);
709 static void ipoctal_remove(struct ipack_device *idev)
711 __ipoctal_remove(dev_get_drvdata(&idev->dev));
714 static DEFINE_IPACK_DEVICE_TABLE(ipoctal_ids) = {
715 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
716 IPACK1_DEVICE_ID_SBS_OCTAL_232) },
717 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
718 IPACK1_DEVICE_ID_SBS_OCTAL_422) },
719 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
720 IPACK1_DEVICE_ID_SBS_OCTAL_485) },
724 MODULE_DEVICE_TABLE(ipack, ipoctal_ids);
726 static const struct ipack_driver_ops ipoctal_drv_ops = {
727 .probe = ipoctal_probe,
728 .remove = ipoctal_remove,
731 static struct ipack_driver driver = {
732 .ops = &ipoctal_drv_ops,
733 .id_table = ipoctal_ids,
736 static int __init ipoctal_init(void)
738 return ipack_driver_register(&driver, THIS_MODULE, KBUILD_MODNAME);
741 static void __exit ipoctal_exit(void)
743 ipack_driver_unregister(&driver);
746 MODULE_DESCRIPTION("IP-Octal 232, 422 and 485 device driver");
747 MODULE_LICENSE("GPL");
749 module_init(ipoctal_init);
750 module_exit(ipoctal_exit);