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;
49 struct ipack_device *dev;
50 unsigned int board_id;
51 struct ipoctal_channel channel[NR_CHANNELS];
52 struct tty_driver *tty_drv;
53 u8 __iomem *mem8_space;
54 u8 __iomem *int_space;
57 static int ipoctal_port_activate(struct tty_port *port, struct tty_struct *tty)
59 struct ipoctal_channel *channel;
61 channel = dev_get_drvdata(tty->dev);
64 * Enable RX. TX will be enabled when
65 * there is something to send
67 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
71 static int ipoctal_open(struct tty_struct *tty, struct file *file)
73 struct ipoctal_channel *channel;
75 channel = dev_get_drvdata(tty->dev);
76 tty->driver_data = channel;
78 return tty_port_open(&channel->tty_port, tty, file);
81 static void ipoctal_reset_stats(struct ipoctal_stats *stats)
86 stats->framing_err = 0;
87 stats->overrun_err = 0;
88 stats->parity_err = 0;
91 static void ipoctal_free_channel(struct ipoctal_channel *channel)
93 ipoctal_reset_stats(&channel->stats);
94 channel->pointer_read = 0;
95 channel->pointer_write = 0;
96 channel->nb_bytes = 0;
99 static void ipoctal_close(struct tty_struct *tty, struct file *filp)
101 struct ipoctal_channel *channel = tty->driver_data;
103 tty_port_close(&channel->tty_port, tty, filp);
104 ipoctal_free_channel(channel);
107 static int ipoctal_get_icount(struct tty_struct *tty,
108 struct serial_icounter_struct *icount)
110 struct ipoctal_channel *channel = tty->driver_data;
116 icount->rx = channel->stats.rx;
117 icount->tx = channel->stats.tx;
118 icount->frame = channel->stats.framing_err;
119 icount->parity = channel->stats.parity_err;
120 icount->brk = channel->stats.rcv_break;
124 static void ipoctal_irq_rx(struct ipoctal_channel *channel,
125 struct tty_struct *tty, u8 sr)
132 value = ioread8(&channel->regs->r.rhr);
134 /* Error: count statistics */
136 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
138 if (sr & SR_OVERRUN_ERROR) {
139 channel->stats.overrun_err++;
140 /* Overrun doesn't affect the current character*/
141 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
143 if (sr & SR_PARITY_ERROR) {
144 channel->stats.parity_err++;
147 if (sr & SR_FRAMING_ERROR) {
148 channel->stats.framing_err++;
151 if (sr & SR_RECEIVED_BREAK) {
152 iowrite8(CR_CMD_RESET_BREAK_CHANGE, &channel->regs->w.cr);
153 channel->stats.rcv_break++;
157 tty_insert_flip_char(tty, value, flag);
159 /* Check if there are more characters in RX FIFO
160 * If there are more, the isr register for this channel
161 * has enabled the RxRDY|FFULL bit.
163 isr = ioread8(&channel->block_regs->r.isr);
164 sr = ioread8(&channel->regs->r.sr);
165 } while (isr & channel->isr_rx_rdy_mask);
167 tty_flip_buffer_push(tty);
170 static void ipoctal_irq_tx(struct ipoctal_channel *channel)
173 unsigned int *pointer_write = &channel->pointer_write;
175 if (channel->nb_bytes == 0)
178 value = channel->tty_port.xmit_buf[*pointer_write];
179 iowrite8(value, &channel->regs->w.thr);
182 *pointer_write = *pointer_write % PAGE_SIZE;
186 static void ipoctal_irq_channel(struct ipoctal_channel *channel)
189 struct tty_struct *tty;
191 tty = tty_port_tty_get(&channel->tty_port);
195 spin_lock(&channel->lock);
196 /* The HW is organized in pair of channels. See which register we need
198 isr = ioread8(&channel->block_regs->r.isr);
199 sr = ioread8(&channel->regs->r.sr);
201 if ((sr & SR_TX_EMPTY) && (channel->nb_bytes == 0)) {
202 iowrite8(CR_DISABLE_TX, &channel->regs->w.cr);
203 /* In case of RS-485, change from TX to RX when finishing TX.
205 if (channel->board_id == IPACK1_DEVICE_ID_SBS_OCTAL_485) {
206 iowrite8(CR_CMD_NEGATE_RTSN, &channel->regs->w.cr);
207 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
212 if ((isr & channel->isr_rx_rdy_mask) && (sr & SR_RX_READY))
213 ipoctal_irq_rx(channel, tty, sr);
215 /* TX of each character */
216 if ((isr & channel->isr_tx_rdy_mask) && (sr & SR_TX_READY))
217 ipoctal_irq_tx(channel);
219 tty_flip_buffer_push(tty);
221 spin_unlock(&channel->lock);
224 static irqreturn_t ipoctal_irq_handler(void *arg)
227 struct ipoctal *ipoctal = (struct ipoctal *) arg;
229 /* Clear the IPack device interrupt */
230 readw(ipoctal->int_space + ACK_INT_REQ0);
231 readw(ipoctal->int_space + ACK_INT_REQ1);
233 /* Check all channels */
234 for (i = 0; i < NR_CHANNELS; i++)
235 ipoctal_irq_channel(&ipoctal->channel[i]);
240 static const struct tty_port_operations ipoctal_tty_port_ops = {
242 .activate = ipoctal_port_activate,
245 static int ipoctal_inst_slot(struct ipoctal *ipoctal, unsigned int bus_nr,
250 struct tty_driver *tty;
252 struct ipoctal_channel *channel;
253 struct ipack_region *region;
255 union scc2698_channel __iomem *chan_regs;
256 union scc2698_block __iomem *block_regs;
258 ipoctal->board_id = ipoctal->dev->id_device;
260 region = &ipoctal->dev->region[IPACK_IO_SPACE];
261 addr = devm_ioremap_nocache(&ipoctal->dev->dev,
262 region->start, region->size);
264 dev_err(&ipoctal->dev->dev,
265 "Unable to map slot [%d:%d] IO space!\n",
267 return -EADDRNOTAVAIL;
269 /* Save the virtual address to access the registers easily */
271 (union scc2698_channel __iomem *) addr;
273 (union scc2698_block __iomem *) addr;
275 region = &ipoctal->dev->region[IPACK_INT_SPACE];
277 devm_ioremap_nocache(&ipoctal->dev->dev,
278 region->start, region->size);
279 if (!ipoctal->int_space) {
280 dev_err(&ipoctal->dev->dev,
281 "Unable to map slot [%d:%d] INT space!\n",
283 return -EADDRNOTAVAIL;
286 region = &ipoctal->dev->region[IPACK_MEM8_SPACE];
287 ipoctal->mem8_space =
288 devm_ioremap_nocache(&ipoctal->dev->dev,
289 region->start, 0x8000);
291 dev_err(&ipoctal->dev->dev,
292 "Unable to map slot [%d:%d] MEM8 space!\n",
294 return -EADDRNOTAVAIL;
298 /* Disable RX and TX before touching anything */
299 for (i = 0; i < NR_CHANNELS ; i++) {
300 struct ipoctal_channel *channel = &ipoctal->channel[i];
301 channel->regs = chan_regs + i;
302 channel->block_regs = block_regs + (i >> 1);
303 channel->board_id = ipoctal->board_id;
305 channel->isr_tx_rdy_mask = ISR_TxRDY_B;
306 channel->isr_rx_rdy_mask = ISR_RxRDY_FFULL_B;
308 channel->isr_tx_rdy_mask = ISR_TxRDY_A;
309 channel->isr_rx_rdy_mask = ISR_RxRDY_FFULL_A;
312 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
313 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
314 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
315 iowrite8(MR1_CHRL_8_BITS | MR1_ERROR_CHAR | MR1_RxINT_RxRDY,
316 &channel->regs->w.mr); /* mr1 */
317 iowrite8(0, &channel->regs->w.mr); /* mr2 */
318 iowrite8(TX_CLK_9600 | RX_CLK_9600, &channel->regs->w.csr);
321 for (i = 0; i < IP_OCTAL_NB_BLOCKS; i++) {
322 iowrite8(ACR_BRG_SET2, &block_regs[i].w.acr);
323 iowrite8(OPCR_MPP_OUTPUT | OPCR_MPOa_RTSN | OPCR_MPOb_RTSN,
324 &block_regs[i].w.opcr);
325 iowrite8(IMR_TxRDY_A | IMR_RxRDY_FFULL_A | IMR_DELTA_BREAK_A |
326 IMR_TxRDY_B | IMR_RxRDY_FFULL_B | IMR_DELTA_BREAK_B,
327 &block_regs[i].w.imr);
331 * IP-OCTAL has different addresses to copy its IRQ vector.
332 * Depending of the carrier these addresses are accesible or not.
333 * More info in the datasheet.
335 ipoctal->dev->bus->ops->request_irq(ipoctal->dev,
336 ipoctal_irq_handler, ipoctal);
338 iowrite8(1, ipoctal->mem8_space + 1);
340 /* Register the TTY device */
342 /* Each IP-OCTAL channel is a TTY port */
343 tty = alloc_tty_driver(NR_CHANNELS);
348 /* Fill struct tty_driver with ipoctal data */
349 tty->owner = THIS_MODULE;
350 tty->driver_name = KBUILD_MODNAME;
351 sprintf(name, KBUILD_MODNAME ".%d.%d.", bus_nr, slot);
355 tty->minor_start = 0;
356 tty->type = TTY_DRIVER_TYPE_SERIAL;
357 tty->subtype = SERIAL_TYPE_NORMAL;
358 tty->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
359 tty->init_termios = tty_std_termios;
360 tty->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
361 tty->init_termios.c_ispeed = 9600;
362 tty->init_termios.c_ospeed = 9600;
364 tty_set_operations(tty, &ipoctal_fops);
365 res = tty_register_driver(tty);
367 dev_err(&ipoctal->dev->dev, "Can't register tty driver.\n");
372 /* Save struct tty_driver for use it when uninstalling the device */
373 ipoctal->tty_drv = tty;
375 for (i = 0; i < NR_CHANNELS; i++) {
376 struct device *tty_dev;
378 channel = &ipoctal->channel[i];
379 tty_port_init(&channel->tty_port);
380 tty_port_alloc_xmit_buf(&channel->tty_port);
381 channel->tty_port.ops = &ipoctal_tty_port_ops;
383 ipoctal_reset_stats(&channel->stats);
384 channel->nb_bytes = 0;
385 spin_lock_init(&channel->lock);
386 channel->pointer_read = 0;
387 channel->pointer_write = 0;
388 tty_dev = tty_port_register_device(&channel->tty_port, tty, i, NULL);
389 if (IS_ERR(tty_dev)) {
390 dev_err(&ipoctal->dev->dev, "Failed to register tty device.\n");
391 tty_port_destroy(&channel->tty_port);
394 dev_set_drvdata(tty_dev, channel);
400 static inline int ipoctal_copy_write_buffer(struct ipoctal_channel *channel,
401 const unsigned char *buf,
406 unsigned int *pointer_read = &channel->pointer_read;
408 /* Copy the bytes from the user buffer to the internal one */
409 for (i = 0; i < count; i++) {
410 if (i <= (PAGE_SIZE - channel->nb_bytes)) {
411 spin_lock_irqsave(&channel->lock, flags);
412 channel->tty_port.xmit_buf[*pointer_read] = buf[i];
413 *pointer_read = (*pointer_read + 1) % PAGE_SIZE;
415 spin_unlock_irqrestore(&channel->lock, flags);
423 static int ipoctal_write_tty(struct tty_struct *tty,
424 const unsigned char *buf, int count)
426 struct ipoctal_channel *channel = tty->driver_data;
427 unsigned int char_copied;
429 char_copied = ipoctal_copy_write_buffer(channel, buf, count);
431 /* As the IP-OCTAL 485 only supports half duplex, do it manually */
432 if (channel->board_id == IPACK1_DEVICE_ID_SBS_OCTAL_485) {
433 iowrite8(CR_DISABLE_RX, &channel->regs->w.cr);
434 iowrite8(CR_CMD_ASSERT_RTSN, &channel->regs->w.cr);
438 * Send a packet and then disable TX to avoid failure after several send
441 iowrite8(CR_ENABLE_TX, &channel->regs->w.cr);
445 static int ipoctal_write_room(struct tty_struct *tty)
447 struct ipoctal_channel *channel = tty->driver_data;
449 return PAGE_SIZE - channel->nb_bytes;
452 static int ipoctal_chars_in_buffer(struct tty_struct *tty)
454 struct ipoctal_channel *channel = tty->driver_data;
456 return channel->nb_bytes;
459 static void ipoctal_set_termios(struct tty_struct *tty,
460 struct ktermios *old_termios)
463 unsigned char mr1 = 0;
464 unsigned char mr2 = 0;
465 unsigned char csr = 0;
466 struct ipoctal_channel *channel = tty->driver_data;
469 cflag = tty->termios.c_cflag;
471 /* Disable and reset everything before change the setup */
472 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
473 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
474 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
475 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
476 iowrite8(CR_CMD_RESET_MR, &channel->regs->w.cr);
478 /* Set Bits per chars */
479 switch (cflag & CSIZE) {
481 mr1 |= MR1_CHRL_6_BITS;
484 mr1 |= MR1_CHRL_7_BITS;
488 mr1 |= MR1_CHRL_8_BITS;
489 /* By default, select CS8 */
490 tty->termios.c_cflag = (cflag & ~CSIZE) | CS8;
497 mr1 |= MR1_PARITY_ON | MR1_PARITY_ODD;
499 mr1 |= MR1_PARITY_ON | MR1_PARITY_EVEN;
501 mr1 |= MR1_PARITY_OFF;
503 /* Mark or space parity is not supported */
504 tty->termios.c_cflag &= ~CMSPAR;
508 mr2 |= MR2_STOP_BITS_LENGTH_2;
510 mr2 |= MR2_STOP_BITS_LENGTH_1;
512 /* Set the flow control */
513 switch (channel->board_id) {
514 case IPACK1_DEVICE_ID_SBS_OCTAL_232:
515 if (cflag & CRTSCTS) {
516 mr1 |= MR1_RxRTS_CONTROL_ON;
517 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_ON;
519 mr1 |= MR1_RxRTS_CONTROL_OFF;
520 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_OFF;
523 case IPACK1_DEVICE_ID_SBS_OCTAL_422:
524 mr1 |= MR1_RxRTS_CONTROL_OFF;
525 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_OFF;
527 case IPACK1_DEVICE_ID_SBS_OCTAL_485:
528 mr1 |= MR1_RxRTS_CONTROL_OFF;
529 mr2 |= MR2_TxRTS_CONTROL_ON | MR2_CTS_ENABLE_TX_OFF;
536 baud = tty_get_baud_rate(tty);
537 tty_termios_encode_baud_rate(&tty->termios, baud, baud);
542 csr |= TX_CLK_75 | RX_CLK_75;
545 csr |= TX_CLK_110 | RX_CLK_110;
548 csr |= TX_CLK_150 | RX_CLK_150;
551 csr |= TX_CLK_300 | RX_CLK_300;
554 csr |= TX_CLK_600 | RX_CLK_600;
557 csr |= TX_CLK_1200 | RX_CLK_1200;
560 csr |= TX_CLK_1800 | RX_CLK_1800;
563 csr |= TX_CLK_2000 | RX_CLK_2000;
566 csr |= TX_CLK_2400 | RX_CLK_2400;
569 csr |= TX_CLK_4800 | RX_CLK_4800;
572 csr |= TX_CLK_9600 | RX_CLK_9600;
575 csr |= TX_CLK_19200 | RX_CLK_19200;
579 csr |= TX_CLK_38400 | RX_CLK_38400;
580 /* In case of default, we establish 38400 bps */
581 tty_termios_encode_baud_rate(&tty->termios, 38400, 38400);
585 mr1 |= MR1_ERROR_CHAR;
586 mr1 |= MR1_RxINT_RxRDY;
588 /* Write the control registers */
589 iowrite8(mr1, &channel->regs->w.mr);
590 iowrite8(mr2, &channel->regs->w.mr);
591 iowrite8(csr, &channel->regs->w.csr);
593 /* Enable again the RX */
594 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
597 static void ipoctal_hangup(struct tty_struct *tty)
600 struct ipoctal_channel *channel = tty->driver_data;
605 spin_lock_irqsave(&channel->lock, flags);
606 channel->nb_bytes = 0;
607 channel->pointer_read = 0;
608 channel->pointer_write = 0;
609 spin_unlock_irqrestore(&channel->lock, flags);
611 tty_port_hangup(&channel->tty_port);
613 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
614 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
615 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
616 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
617 iowrite8(CR_CMD_RESET_MR, &channel->regs->w.cr);
619 clear_bit(ASYNCB_INITIALIZED, &channel->tty_port.flags);
620 wake_up_interruptible(&channel->tty_port.open_wait);
623 static const struct tty_operations ipoctal_fops = {
625 .open = ipoctal_open,
626 .close = ipoctal_close,
627 .write = ipoctal_write_tty,
628 .set_termios = ipoctal_set_termios,
629 .write_room = ipoctal_write_room,
630 .chars_in_buffer = ipoctal_chars_in_buffer,
631 .get_icount = ipoctal_get_icount,
632 .hangup = ipoctal_hangup,
635 static int ipoctal_probe(struct ipack_device *dev)
638 struct ipoctal *ipoctal;
640 ipoctal = kzalloc(sizeof(struct ipoctal), GFP_KERNEL);
645 res = ipoctal_inst_slot(ipoctal, dev->bus->bus_nr, dev->slot);
649 dev_set_drvdata(&dev->dev, ipoctal);
657 static void __ipoctal_remove(struct ipoctal *ipoctal)
661 ipoctal->dev->bus->ops->free_irq(ipoctal->dev);
663 for (i = 0; i < NR_CHANNELS; i++) {
664 struct ipoctal_channel *channel = &ipoctal->channel[i];
665 tty_unregister_device(ipoctal->tty_drv, i);
666 tty_port_free_xmit_buf(&channel->tty_port);
667 tty_port_destroy(&channel->tty_port);
670 tty_unregister_driver(ipoctal->tty_drv);
671 put_tty_driver(ipoctal->tty_drv);
675 static void ipoctal_remove(struct ipack_device *idev)
677 __ipoctal_remove(dev_get_drvdata(&idev->dev));
680 static DEFINE_IPACK_DEVICE_TABLE(ipoctal_ids) = {
681 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
682 IPACK1_DEVICE_ID_SBS_OCTAL_232) },
683 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
684 IPACK1_DEVICE_ID_SBS_OCTAL_422) },
685 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
686 IPACK1_DEVICE_ID_SBS_OCTAL_485) },
690 MODULE_DEVICE_TABLE(ipack, ipoctal_ids);
692 static const struct ipack_driver_ops ipoctal_drv_ops = {
693 .probe = ipoctal_probe,
694 .remove = ipoctal_remove,
697 static struct ipack_driver driver = {
698 .ops = &ipoctal_drv_ops,
699 .id_table = ipoctal_ids,
702 static int __init ipoctal_init(void)
704 return ipack_driver_register(&driver, THIS_MODULE, KBUILD_MODNAME);
707 static void __exit ipoctal_exit(void)
709 ipack_driver_unregister(&driver);
712 MODULE_DESCRIPTION("IP-Octal 232, 422 and 485 device driver");
713 MODULE_LICENSE("GPL");
715 module_init(ipoctal_init);
716 module_exit(ipoctal_exit);