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, u8 sr)
128 struct tty_port *port = &channel->tty_port;
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(port, 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(port, 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(port);
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)
192 spin_lock(&channel->lock);
193 /* The HW is organized in pair of channels. See which register we need
195 isr = ioread8(&channel->block_regs->r.isr);
196 sr = ioread8(&channel->regs->r.sr);
198 if ((sr & SR_TX_EMPTY) && (channel->nb_bytes == 0)) {
199 iowrite8(CR_DISABLE_TX, &channel->regs->w.cr);
200 /* In case of RS-485, change from TX to RX when finishing TX.
202 if (channel->board_id == IPACK1_DEVICE_ID_SBS_OCTAL_485) {
203 iowrite8(CR_CMD_NEGATE_RTSN, &channel->regs->w.cr);
204 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
205 channel->rx_enable = 1;
210 if ((isr & channel->isr_rx_rdy_mask) && (sr & SR_RX_READY))
211 ipoctal_irq_rx(channel, sr);
213 /* TX of each character */
214 if ((isr & channel->isr_tx_rdy_mask) && (sr & SR_TX_READY))
215 ipoctal_irq_tx(channel);
217 spin_unlock(&channel->lock);
220 static irqreturn_t ipoctal_irq_handler(void *arg)
223 struct ipoctal *ipoctal = (struct ipoctal *) arg;
225 /* Clear the IPack device interrupt */
226 readw(ipoctal->int_space + ACK_INT_REQ0);
227 readw(ipoctal->int_space + ACK_INT_REQ1);
229 /* Check all channels */
230 for (i = 0; i < NR_CHANNELS; i++)
231 ipoctal_irq_channel(&ipoctal->channel[i]);
236 static const struct tty_port_operations ipoctal_tty_port_ops = {
238 .activate = ipoctal_port_activate,
241 static int ipoctal_inst_slot(struct ipoctal *ipoctal, unsigned int bus_nr,
246 struct tty_driver *tty;
248 struct ipoctal_channel *channel;
249 struct ipack_region *region;
251 union scc2698_channel __iomem *chan_regs;
252 union scc2698_block __iomem *block_regs;
254 ipoctal->board_id = ipoctal->dev->id_device;
256 region = &ipoctal->dev->region[IPACK_IO_SPACE];
257 addr = devm_ioremap_nocache(&ipoctal->dev->dev,
258 region->start, region->size);
260 dev_err(&ipoctal->dev->dev,
261 "Unable to map slot [%d:%d] IO space!\n",
263 return -EADDRNOTAVAIL;
265 /* Save the virtual address to access the registers easily */
267 (union scc2698_channel __iomem *) addr;
269 (union scc2698_block __iomem *) addr;
271 region = &ipoctal->dev->region[IPACK_INT_SPACE];
273 devm_ioremap_nocache(&ipoctal->dev->dev,
274 region->start, region->size);
275 if (!ipoctal->int_space) {
276 dev_err(&ipoctal->dev->dev,
277 "Unable to map slot [%d:%d] INT space!\n",
279 return -EADDRNOTAVAIL;
282 region = &ipoctal->dev->region[IPACK_MEM8_SPACE];
283 ipoctal->mem8_space =
284 devm_ioremap_nocache(&ipoctal->dev->dev,
285 region->start, 0x8000);
286 if (!ipoctal->mem8_space) {
287 dev_err(&ipoctal->dev->dev,
288 "Unable to map slot [%d:%d] MEM8 space!\n",
290 return -EADDRNOTAVAIL;
294 /* Disable RX and TX before touching anything */
295 for (i = 0; i < NR_CHANNELS ; i++) {
296 struct ipoctal_channel *channel = &ipoctal->channel[i];
297 channel->regs = chan_regs + i;
298 channel->block_regs = block_regs + (i >> 1);
299 channel->board_id = ipoctal->board_id;
301 channel->isr_tx_rdy_mask = ISR_TxRDY_B;
302 channel->isr_rx_rdy_mask = ISR_RxRDY_FFULL_B;
304 channel->isr_tx_rdy_mask = ISR_TxRDY_A;
305 channel->isr_rx_rdy_mask = ISR_RxRDY_FFULL_A;
308 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
309 channel->rx_enable = 0;
310 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
311 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
312 iowrite8(MR1_CHRL_8_BITS | MR1_ERROR_CHAR | MR1_RxINT_RxRDY,
313 &channel->regs->w.mr); /* mr1 */
314 iowrite8(0, &channel->regs->w.mr); /* mr2 */
315 iowrite8(TX_CLK_9600 | RX_CLK_9600, &channel->regs->w.csr);
318 for (i = 0; i < IP_OCTAL_NB_BLOCKS; i++) {
319 iowrite8(ACR_BRG_SET2, &block_regs[i].w.acr);
320 iowrite8(OPCR_MPP_OUTPUT | OPCR_MPOa_RTSN | OPCR_MPOb_RTSN,
321 &block_regs[i].w.opcr);
322 iowrite8(IMR_TxRDY_A | IMR_RxRDY_FFULL_A | IMR_DELTA_BREAK_A |
323 IMR_TxRDY_B | IMR_RxRDY_FFULL_B | IMR_DELTA_BREAK_B,
324 &block_regs[i].w.imr);
328 * IP-OCTAL has different addresses to copy its IRQ vector.
329 * Depending of the carrier these addresses are accesible or not.
330 * More info in the datasheet.
332 ipoctal->dev->bus->ops->request_irq(ipoctal->dev,
333 ipoctal_irq_handler, ipoctal);
335 iowrite8(1, ipoctal->mem8_space + 1);
337 /* Register the TTY device */
339 /* Each IP-OCTAL channel is a TTY port */
340 tty = alloc_tty_driver(NR_CHANNELS);
345 /* Fill struct tty_driver with ipoctal data */
346 tty->owner = THIS_MODULE;
347 tty->driver_name = KBUILD_MODNAME;
348 sprintf(name, KBUILD_MODNAME ".%d.%d.", bus_nr, slot);
352 tty->minor_start = 0;
353 tty->type = TTY_DRIVER_TYPE_SERIAL;
354 tty->subtype = SERIAL_TYPE_NORMAL;
355 tty->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
356 tty->init_termios = tty_std_termios;
357 tty->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
358 tty->init_termios.c_ispeed = 9600;
359 tty->init_termios.c_ospeed = 9600;
361 tty_set_operations(tty, &ipoctal_fops);
362 res = tty_register_driver(tty);
364 dev_err(&ipoctal->dev->dev, "Can't register tty driver.\n");
369 /* Save struct tty_driver for use it when uninstalling the device */
370 ipoctal->tty_drv = tty;
372 for (i = 0; i < NR_CHANNELS; i++) {
373 struct device *tty_dev;
375 channel = &ipoctal->channel[i];
376 tty_port_init(&channel->tty_port);
377 tty_port_alloc_xmit_buf(&channel->tty_port);
378 channel->tty_port.ops = &ipoctal_tty_port_ops;
380 ipoctal_reset_stats(&channel->stats);
381 channel->nb_bytes = 0;
382 spin_lock_init(&channel->lock);
383 channel->pointer_read = 0;
384 channel->pointer_write = 0;
385 tty_dev = tty_port_register_device(&channel->tty_port, tty, i, NULL);
386 if (IS_ERR(tty_dev)) {
387 dev_err(&ipoctal->dev->dev, "Failed to register tty device.\n");
388 tty_port_destroy(&channel->tty_port);
391 dev_set_drvdata(tty_dev, channel);
397 static inline int ipoctal_copy_write_buffer(struct ipoctal_channel *channel,
398 const unsigned char *buf,
403 unsigned int *pointer_read = &channel->pointer_read;
405 /* Copy the bytes from the user buffer to the internal one */
406 for (i = 0; i < count; i++) {
407 if (i <= (PAGE_SIZE - channel->nb_bytes)) {
408 spin_lock_irqsave(&channel->lock, flags);
409 channel->tty_port.xmit_buf[*pointer_read] = buf[i];
410 *pointer_read = (*pointer_read + 1) % PAGE_SIZE;
412 spin_unlock_irqrestore(&channel->lock, flags);
420 static int ipoctal_write_tty(struct tty_struct *tty,
421 const unsigned char *buf, int count)
423 struct ipoctal_channel *channel = tty->driver_data;
424 unsigned int char_copied;
426 char_copied = ipoctal_copy_write_buffer(channel, buf, count);
428 /* As the IP-OCTAL 485 only supports half duplex, do it manually */
429 if (channel->board_id == IPACK1_DEVICE_ID_SBS_OCTAL_485) {
430 iowrite8(CR_DISABLE_RX, &channel->regs->w.cr);
431 channel->rx_enable = 0;
432 iowrite8(CR_CMD_ASSERT_RTSN, &channel->regs->w.cr);
436 * Send a packet and then disable TX to avoid failure after several send
439 iowrite8(CR_ENABLE_TX, &channel->regs->w.cr);
443 static int ipoctal_write_room(struct tty_struct *tty)
445 struct ipoctal_channel *channel = tty->driver_data;
447 return PAGE_SIZE - channel->nb_bytes;
450 static int ipoctal_chars_in_buffer(struct tty_struct *tty)
452 struct ipoctal_channel *channel = tty->driver_data;
454 return channel->nb_bytes;
457 static void ipoctal_set_termios(struct tty_struct *tty,
458 struct ktermios *old_termios)
461 unsigned char mr1 = 0;
462 unsigned char mr2 = 0;
463 unsigned char csr = 0;
464 struct ipoctal_channel *channel = tty->driver_data;
467 cflag = tty->termios.c_cflag;
469 /* Disable and reset everything before change the setup */
470 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
471 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
472 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
473 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
474 iowrite8(CR_CMD_RESET_MR, &channel->regs->w.cr);
476 /* Set Bits per chars */
477 switch (cflag & CSIZE) {
479 mr1 |= MR1_CHRL_6_BITS;
482 mr1 |= MR1_CHRL_7_BITS;
486 mr1 |= MR1_CHRL_8_BITS;
487 /* By default, select CS8 */
488 tty->termios.c_cflag = (cflag & ~CSIZE) | CS8;
495 mr1 |= MR1_PARITY_ON | MR1_PARITY_ODD;
497 mr1 |= MR1_PARITY_ON | MR1_PARITY_EVEN;
499 mr1 |= MR1_PARITY_OFF;
501 /* Mark or space parity is not supported */
502 tty->termios.c_cflag &= ~CMSPAR;
506 mr2 |= MR2_STOP_BITS_LENGTH_2;
508 mr2 |= MR2_STOP_BITS_LENGTH_1;
510 /* Set the flow control */
511 switch (channel->board_id) {
512 case IPACK1_DEVICE_ID_SBS_OCTAL_232:
513 if (cflag & CRTSCTS) {
514 mr1 |= MR1_RxRTS_CONTROL_ON;
515 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_ON;
517 mr1 |= MR1_RxRTS_CONTROL_OFF;
518 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_OFF;
521 case IPACK1_DEVICE_ID_SBS_OCTAL_422:
522 mr1 |= MR1_RxRTS_CONTROL_OFF;
523 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_OFF;
525 case IPACK1_DEVICE_ID_SBS_OCTAL_485:
526 mr1 |= MR1_RxRTS_CONTROL_OFF;
527 mr2 |= MR2_TxRTS_CONTROL_ON | MR2_CTS_ENABLE_TX_OFF;
534 baud = tty_get_baud_rate(tty);
535 tty_termios_encode_baud_rate(&tty->termios, baud, baud);
540 csr |= TX_CLK_75 | RX_CLK_75;
543 csr |= TX_CLK_110 | RX_CLK_110;
546 csr |= TX_CLK_150 | RX_CLK_150;
549 csr |= TX_CLK_300 | RX_CLK_300;
552 csr |= TX_CLK_600 | RX_CLK_600;
555 csr |= TX_CLK_1200 | RX_CLK_1200;
558 csr |= TX_CLK_1800 | RX_CLK_1800;
561 csr |= TX_CLK_2000 | RX_CLK_2000;
564 csr |= TX_CLK_2400 | RX_CLK_2400;
567 csr |= TX_CLK_4800 | RX_CLK_4800;
570 csr |= TX_CLK_9600 | RX_CLK_9600;
573 csr |= TX_CLK_19200 | RX_CLK_19200;
577 csr |= TX_CLK_38400 | RX_CLK_38400;
578 /* In case of default, we establish 38400 bps */
579 tty_termios_encode_baud_rate(&tty->termios, 38400, 38400);
583 mr1 |= MR1_ERROR_CHAR;
584 mr1 |= MR1_RxINT_RxRDY;
586 /* Write the control registers */
587 iowrite8(mr1, &channel->regs->w.mr);
588 iowrite8(mr2, &channel->regs->w.mr);
589 iowrite8(csr, &channel->regs->w.csr);
591 /* Enable again the RX, if it was before */
592 if (channel->rx_enable)
593 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
596 static void ipoctal_hangup(struct tty_struct *tty)
599 struct ipoctal_channel *channel = tty->driver_data;
604 spin_lock_irqsave(&channel->lock, flags);
605 channel->nb_bytes = 0;
606 channel->pointer_read = 0;
607 channel->pointer_write = 0;
608 spin_unlock_irqrestore(&channel->lock, flags);
610 tty_port_hangup(&channel->tty_port);
612 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
613 channel->rx_enable = 0;
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 void ipoctal_shutdown(struct tty_struct *tty)
625 struct ipoctal_channel *channel = tty->driver_data;
630 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
631 channel->rx_enable = 0;
632 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
633 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
634 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
635 iowrite8(CR_CMD_RESET_MR, &channel->regs->w.cr);
636 clear_bit(ASYNCB_INITIALIZED, &channel->tty_port.flags);
639 static const struct tty_operations ipoctal_fops = {
641 .open = ipoctal_open,
642 .close = ipoctal_close,
643 .write = ipoctal_write_tty,
644 .set_termios = ipoctal_set_termios,
645 .write_room = ipoctal_write_room,
646 .chars_in_buffer = ipoctal_chars_in_buffer,
647 .get_icount = ipoctal_get_icount,
648 .hangup = ipoctal_hangup,
649 .shutdown = ipoctal_shutdown,
652 static int ipoctal_probe(struct ipack_device *dev)
655 struct ipoctal *ipoctal;
657 ipoctal = kzalloc(sizeof(struct ipoctal), GFP_KERNEL);
662 res = ipoctal_inst_slot(ipoctal, dev->bus->bus_nr, dev->slot);
666 dev_set_drvdata(&dev->dev, ipoctal);
674 static void __ipoctal_remove(struct ipoctal *ipoctal)
678 ipoctal->dev->bus->ops->free_irq(ipoctal->dev);
680 for (i = 0; i < NR_CHANNELS; i++) {
681 struct ipoctal_channel *channel = &ipoctal->channel[i];
682 tty_unregister_device(ipoctal->tty_drv, i);
683 tty_port_free_xmit_buf(&channel->tty_port);
684 tty_port_destroy(&channel->tty_port);
687 tty_unregister_driver(ipoctal->tty_drv);
688 put_tty_driver(ipoctal->tty_drv);
692 static void ipoctal_remove(struct ipack_device *idev)
694 __ipoctal_remove(dev_get_drvdata(&idev->dev));
697 static DEFINE_IPACK_DEVICE_TABLE(ipoctal_ids) = {
698 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
699 IPACK1_DEVICE_ID_SBS_OCTAL_232) },
700 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
701 IPACK1_DEVICE_ID_SBS_OCTAL_422) },
702 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
703 IPACK1_DEVICE_ID_SBS_OCTAL_485) },
707 MODULE_DEVICE_TABLE(ipack, ipoctal_ids);
709 static const struct ipack_driver_ops ipoctal_drv_ops = {
710 .probe = ipoctal_probe,
711 .remove = ipoctal_remove,
714 static struct ipack_driver driver = {
715 .ops = &ipoctal_drv_ops,
716 .id_table = ipoctal_ids,
719 static int __init ipoctal_init(void)
721 return ipack_driver_register(&driver, THIS_MODULE, KBUILD_MODNAME);
724 static void __exit ipoctal_exit(void)
726 ipack_driver_unregister(&driver);
729 MODULE_DESCRIPTION("IP-Octal 232, 422 and 485 device driver");
730 MODULE_LICENSE("GPL");
732 module_init(ipoctal_init);
733 module_exit(ipoctal_exit);