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 (waitqueue_active(&channel->queue))) {
201 if (channel->board_id != IPACK1_DEVICE_ID_SBS_OCTAL_485) {
202 *channel->board_write = 1;
203 wake_up_interruptible(&channel->queue);
208 static void ipoctal_irq_channel(struct ipoctal_channel *channel)
211 struct tty_struct *tty;
213 /* If there is no client, skip the check */
214 if (!atomic_read(&channel->open))
217 tty = tty_port_tty_get(&channel->tty_port);
220 /* The HW is organized in pair of channels. See which register we need
222 isr = ioread8(&channel->block_regs->r.isr);
223 sr = ioread8(&channel->regs->r.sr);
225 /* In case of RS-485, change from TX to RX when finishing TX.
227 if ((channel->board_id == IPACK1_DEVICE_ID_SBS_OCTAL_485) &&
228 (sr & SR_TX_EMPTY) && (channel->nb_bytes == 0)) {
229 iowrite8(CR_DISABLE_TX, &channel->regs->w.cr);
230 iowrite8(CR_CMD_NEGATE_RTSN, &channel->regs->w.cr);
231 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
232 *channel->board_write = 1;
233 wake_up_interruptible(&channel->queue);
237 if ((isr & channel->isr_rx_rdy_mask) && (sr & SR_RX_READY))
238 ipoctal_irq_rx(channel, tty, sr);
240 /* TX of each character */
241 if ((isr & channel->isr_tx_rdy_mask) && (sr & SR_TX_READY))
242 ipoctal_irq_tx(channel);
244 tty_flip_buffer_push(tty);
248 static irqreturn_t ipoctal_irq_handler(void *arg)
251 struct ipoctal *ipoctal = (struct ipoctal *) arg;
253 /* Check all channels */
254 for (i = 0; i < NR_CHANNELS; i++)
255 ipoctal_irq_channel(&ipoctal->channel[i]);
257 /* Clear the IPack device interrupt */
258 readw(ipoctal->int_space + ACK_INT_REQ0);
259 readw(ipoctal->int_space + ACK_INT_REQ1);
264 static const struct tty_port_operations ipoctal_tty_port_ops = {
266 .activate = ipoctal_port_activate,
269 static int ipoctal_inst_slot(struct ipoctal *ipoctal, unsigned int bus_nr,
274 struct tty_driver *tty;
276 struct ipoctal_channel *channel;
277 struct ipack_region *region;
279 union scc2698_channel __iomem *chan_regs;
280 union scc2698_block __iomem *block_regs;
282 ipoctal->board_id = ipoctal->dev->id_device;
284 region = &ipoctal->dev->region[IPACK_IO_SPACE];
285 addr = devm_ioremap_nocache(&ipoctal->dev->dev,
286 region->start, region->size);
288 dev_err(&ipoctal->dev->dev,
289 "Unable to map slot [%d:%d] IO space!\n",
291 return -EADDRNOTAVAIL;
293 /* Save the virtual address to access the registers easily */
295 (union scc2698_channel __iomem *) addr;
297 (union scc2698_block __iomem *) addr;
299 region = &ipoctal->dev->region[IPACK_INT_SPACE];
301 devm_ioremap_nocache(&ipoctal->dev->dev,
302 region->start, region->size);
303 if (!ipoctal->int_space) {
304 dev_err(&ipoctal->dev->dev,
305 "Unable to map slot [%d:%d] INT space!\n",
307 return -EADDRNOTAVAIL;
310 region = &ipoctal->dev->region[IPACK_MEM8_SPACE];
311 ipoctal->mem8_space =
312 devm_ioremap_nocache(&ipoctal->dev->dev,
313 region->start, 0x8000);
315 dev_err(&ipoctal->dev->dev,
316 "Unable to map slot [%d:%d] MEM8 space!\n",
318 return -EADDRNOTAVAIL;
322 /* Disable RX and TX before touching anything */
323 for (i = 0; i < NR_CHANNELS ; i++) {
324 struct ipoctal_channel *channel = &ipoctal->channel[i];
325 channel->regs = chan_regs + i;
326 channel->block_regs = block_regs + (i >> 1);
327 channel->board_write = &ipoctal->write;
328 channel->board_id = ipoctal->board_id;
330 channel->isr_tx_rdy_mask = ISR_TxRDY_B;
331 channel->isr_rx_rdy_mask = ISR_RxRDY_FFULL_B;
333 channel->isr_tx_rdy_mask = ISR_TxRDY_A;
334 channel->isr_rx_rdy_mask = ISR_RxRDY_FFULL_A;
337 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
338 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
339 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
340 iowrite8(MR1_CHRL_8_BITS | MR1_ERROR_CHAR | MR1_RxINT_RxRDY,
341 &channel->regs->w.mr); /* mr1 */
342 iowrite8(0, &channel->regs->w.mr); /* mr2 */
343 iowrite8(TX_CLK_9600 | RX_CLK_9600, &channel->regs->w.csr);
346 for (i = 0; i < IP_OCTAL_NB_BLOCKS; i++) {
347 iowrite8(ACR_BRG_SET2, &block_regs[i].w.acr);
348 iowrite8(OPCR_MPP_OUTPUT | OPCR_MPOa_RTSN | OPCR_MPOb_RTSN,
349 &block_regs[i].w.opcr);
350 iowrite8(IMR_TxRDY_A | IMR_RxRDY_FFULL_A | IMR_DELTA_BREAK_A |
351 IMR_TxRDY_B | IMR_RxRDY_FFULL_B | IMR_DELTA_BREAK_B,
352 &block_regs[i].w.imr);
356 * IP-OCTAL has different addresses to copy its IRQ vector.
357 * Depending of the carrier these addresses are accesible or not.
358 * More info in the datasheet.
360 ipoctal->dev->bus->ops->request_irq(ipoctal->dev,
361 ipoctal_irq_handler, ipoctal);
363 iowrite8(1, ipoctal->mem8_space + 1);
365 /* Register the TTY device */
367 /* Each IP-OCTAL channel is a TTY port */
368 tty = alloc_tty_driver(NR_CHANNELS);
373 /* Fill struct tty_driver with ipoctal data */
374 tty->owner = THIS_MODULE;
375 tty->driver_name = KBUILD_MODNAME;
376 sprintf(name, KBUILD_MODNAME ".%d.%d.", bus_nr, slot);
380 tty->minor_start = 0;
381 tty->type = TTY_DRIVER_TYPE_SERIAL;
382 tty->subtype = SERIAL_TYPE_NORMAL;
383 tty->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
384 tty->init_termios = tty_std_termios;
385 tty->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
386 tty->init_termios.c_ispeed = 9600;
387 tty->init_termios.c_ospeed = 9600;
389 tty_set_operations(tty, &ipoctal_fops);
390 res = tty_register_driver(tty);
392 dev_err(&ipoctal->dev->dev, "Can't register tty driver.\n");
397 /* Save struct tty_driver for use it when uninstalling the device */
398 ipoctal->tty_drv = tty;
400 for (i = 0; i < NR_CHANNELS; i++) {
401 struct device *tty_dev;
403 channel = &ipoctal->channel[i];
404 tty_port_init(&channel->tty_port);
405 tty_port_alloc_xmit_buf(&channel->tty_port);
406 channel->tty_port.ops = &ipoctal_tty_port_ops;
408 ipoctal_reset_stats(&channel->stats);
409 channel->nb_bytes = 0;
410 init_waitqueue_head(&channel->queue);
412 spin_lock_init(&channel->lock);
413 channel->pointer_read = 0;
414 channel->pointer_write = 0;
415 tty_dev = tty_port_register_device(&channel->tty_port, tty, i, NULL);
416 if (IS_ERR(tty_dev)) {
417 dev_err(&ipoctal->dev->dev, "Failed to register tty device.\n");
418 tty_port_destroy(&channel->tty_port);
421 dev_set_drvdata(tty_dev, channel);
424 * Enable again the RX. TX will be enabled when
425 * there is something to send
427 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
433 static inline int ipoctal_copy_write_buffer(struct ipoctal_channel *channel,
434 const unsigned char *buf,
439 unsigned int *pointer_read = &channel->pointer_read;
441 /* Copy the bytes from the user buffer to the internal one */
442 for (i = 0; i < count; i++) {
443 if (i <= (PAGE_SIZE - channel->nb_bytes)) {
444 spin_lock_irqsave(&channel->lock, flags);
445 channel->tty_port.xmit_buf[*pointer_read] = buf[i];
446 *pointer_read = (*pointer_read + 1) % PAGE_SIZE;
448 spin_unlock_irqrestore(&channel->lock, flags);
456 static int ipoctal_write_tty(struct tty_struct *tty,
457 const unsigned char *buf, int count)
459 struct ipoctal_channel *channel = tty->driver_data;
460 unsigned int char_copied;
462 char_copied = ipoctal_copy_write_buffer(channel, buf, count);
464 /* As the IP-OCTAL 485 only supports half duplex, do it manually */
465 if (channel->board_id == IPACK1_DEVICE_ID_SBS_OCTAL_485) {
466 iowrite8(CR_DISABLE_RX, &channel->regs->w.cr);
467 iowrite8(CR_CMD_ASSERT_RTSN, &channel->regs->w.cr);
471 * Send a packet and then disable TX to avoid failure after several send
474 iowrite8(CR_ENABLE_TX, &channel->regs->w.cr);
475 wait_event_interruptible(channel->queue, *channel->board_write);
476 iowrite8(CR_DISABLE_TX, &channel->regs->w.cr);
478 *channel->board_write = 0;
482 static int ipoctal_write_room(struct tty_struct *tty)
484 struct ipoctal_channel *channel = tty->driver_data;
486 return PAGE_SIZE - channel->nb_bytes;
489 static int ipoctal_chars_in_buffer(struct tty_struct *tty)
491 struct ipoctal_channel *channel = tty->driver_data;
493 return channel->nb_bytes;
496 static void ipoctal_set_termios(struct tty_struct *tty,
497 struct ktermios *old_termios)
500 unsigned char mr1 = 0;
501 unsigned char mr2 = 0;
502 unsigned char csr = 0;
503 struct ipoctal_channel *channel = tty->driver_data;
506 cflag = tty->termios.c_cflag;
508 /* Disable and reset everything before change the setup */
509 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
510 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
511 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
512 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
513 iowrite8(CR_CMD_RESET_MR, &channel->regs->w.cr);
515 /* Set Bits per chars */
516 switch (cflag & CSIZE) {
518 mr1 |= MR1_CHRL_6_BITS;
521 mr1 |= MR1_CHRL_7_BITS;
525 mr1 |= MR1_CHRL_8_BITS;
526 /* By default, select CS8 */
527 tty->termios.c_cflag = (cflag & ~CSIZE) | CS8;
534 mr1 |= MR1_PARITY_ON | MR1_PARITY_ODD;
536 mr1 |= MR1_PARITY_ON | MR1_PARITY_EVEN;
538 mr1 |= MR1_PARITY_OFF;
540 /* Mark or space parity is not supported */
541 tty->termios.c_cflag &= ~CMSPAR;
545 mr2 |= MR2_STOP_BITS_LENGTH_2;
547 mr2 |= MR2_STOP_BITS_LENGTH_1;
549 /* Set the flow control */
550 switch (channel->board_id) {
551 case IPACK1_DEVICE_ID_SBS_OCTAL_232:
552 if (cflag & CRTSCTS) {
553 mr1 |= MR1_RxRTS_CONTROL_ON;
554 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_ON;
556 mr1 |= MR1_RxRTS_CONTROL_OFF;
557 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_OFF;
560 case IPACK1_DEVICE_ID_SBS_OCTAL_422:
561 mr1 |= MR1_RxRTS_CONTROL_OFF;
562 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_OFF;
564 case IPACK1_DEVICE_ID_SBS_OCTAL_485:
565 mr1 |= MR1_RxRTS_CONTROL_OFF;
566 mr2 |= MR2_TxRTS_CONTROL_ON | MR2_CTS_ENABLE_TX_OFF;
573 baud = tty_get_baud_rate(tty);
574 tty_termios_encode_baud_rate(&tty->termios, baud, baud);
579 csr |= TX_CLK_75 | RX_CLK_75;
582 csr |= TX_CLK_110 | RX_CLK_110;
585 csr |= TX_CLK_150 | RX_CLK_150;
588 csr |= TX_CLK_300 | RX_CLK_300;
591 csr |= TX_CLK_600 | RX_CLK_600;
594 csr |= TX_CLK_1200 | RX_CLK_1200;
597 csr |= TX_CLK_1800 | RX_CLK_1800;
600 csr |= TX_CLK_2000 | RX_CLK_2000;
603 csr |= TX_CLK_2400 | RX_CLK_2400;
606 csr |= TX_CLK_4800 | RX_CLK_4800;
609 csr |= TX_CLK_9600 | RX_CLK_9600;
612 csr |= TX_CLK_19200 | RX_CLK_19200;
616 csr |= TX_CLK_38400 | RX_CLK_38400;
617 /* In case of default, we establish 38400 bps */
618 tty_termios_encode_baud_rate(&tty->termios, 38400, 38400);
622 mr1 |= MR1_ERROR_CHAR;
623 mr1 |= MR1_RxINT_RxRDY;
625 /* Write the control registers */
626 iowrite8(mr1, &channel->regs->w.mr);
627 iowrite8(mr2, &channel->regs->w.mr);
628 iowrite8(csr, &channel->regs->w.csr);
630 /* Enable again the RX */
631 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
634 static void ipoctal_hangup(struct tty_struct *tty)
637 struct ipoctal_channel *channel = tty->driver_data;
642 spin_lock_irqsave(&channel->lock, flags);
643 channel->nb_bytes = 0;
644 channel->pointer_read = 0;
645 channel->pointer_write = 0;
646 spin_unlock_irqrestore(&channel->lock, flags);
648 tty_port_hangup(&channel->tty_port);
650 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
651 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
652 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
653 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
654 iowrite8(CR_CMD_RESET_MR, &channel->regs->w.cr);
656 clear_bit(ASYNCB_INITIALIZED, &channel->tty_port.flags);
657 wake_up_interruptible(&channel->tty_port.open_wait);
660 static const struct tty_operations ipoctal_fops = {
662 .open = ipoctal_open,
663 .close = ipoctal_close,
664 .write = ipoctal_write_tty,
665 .set_termios = ipoctal_set_termios,
666 .write_room = ipoctal_write_room,
667 .chars_in_buffer = ipoctal_chars_in_buffer,
668 .get_icount = ipoctal_get_icount,
669 .hangup = ipoctal_hangup,
672 static int ipoctal_probe(struct ipack_device *dev)
675 struct ipoctal *ipoctal;
677 ipoctal = kzalloc(sizeof(struct ipoctal), GFP_KERNEL);
682 res = ipoctal_inst_slot(ipoctal, dev->bus->bus_nr, dev->slot);
686 dev_set_drvdata(&dev->dev, ipoctal);
694 static void __ipoctal_remove(struct ipoctal *ipoctal)
698 ipoctal->dev->bus->ops->free_irq(ipoctal->dev);
700 for (i = 0; i < NR_CHANNELS; i++) {
701 struct ipoctal_channel *channel = &ipoctal->channel[i];
702 tty_unregister_device(ipoctal->tty_drv, i);
703 tty_port_free_xmit_buf(&channel->tty_port);
704 tty_port_destroy(&channel->tty_port);
707 tty_unregister_driver(ipoctal->tty_drv);
708 put_tty_driver(ipoctal->tty_drv);
712 static void ipoctal_remove(struct ipack_device *idev)
714 __ipoctal_remove(dev_get_drvdata(&idev->dev));
717 static DEFINE_IPACK_DEVICE_TABLE(ipoctal_ids) = {
718 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
719 IPACK1_DEVICE_ID_SBS_OCTAL_232) },
720 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
721 IPACK1_DEVICE_ID_SBS_OCTAL_422) },
722 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
723 IPACK1_DEVICE_ID_SBS_OCTAL_485) },
727 MODULE_DEVICE_TABLE(ipack, ipoctal_ids);
729 static const struct ipack_driver_ops ipoctal_drv_ops = {
730 .probe = ipoctal_probe,
731 .remove = ipoctal_remove,
734 static struct ipack_driver driver = {
735 .ops = &ipoctal_drv_ops,
736 .id_table = ipoctal_ids,
739 static int __init ipoctal_init(void)
741 return ipack_driver_register(&driver, THIS_MODULE, KBUILD_MODNAME);
744 static void __exit ipoctal_exit(void)
746 ipack_driver_unregister(&driver);
749 MODULE_DESCRIPTION("IP-Octal 232, 422 and 485 device driver");
750 MODULE_LICENSE("GPL");
752 module_init(ipoctal_init);
753 module_exit(ipoctal_exit);