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);
63 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
67 static int ipoctal_open(struct tty_struct *tty, struct file *file)
69 struct ipoctal_channel *channel;
71 channel = dev_get_drvdata(tty->dev);
72 tty->driver_data = channel;
74 return tty_port_open(&channel->tty_port, tty, file);
77 static void ipoctal_reset_stats(struct ipoctal_stats *stats)
82 stats->framing_err = 0;
83 stats->overrun_err = 0;
84 stats->parity_err = 0;
87 static void ipoctal_free_channel(struct ipoctal_channel *channel)
89 ipoctal_reset_stats(&channel->stats);
90 channel->pointer_read = 0;
91 channel->pointer_write = 0;
92 channel->nb_bytes = 0;
95 static void ipoctal_close(struct tty_struct *tty, struct file *filp)
97 struct ipoctal_channel *channel = tty->driver_data;
99 tty_port_close(&channel->tty_port, tty, filp);
100 ipoctal_free_channel(channel);
103 static int ipoctal_get_icount(struct tty_struct *tty,
104 struct serial_icounter_struct *icount)
106 struct ipoctal_channel *channel = tty->driver_data;
112 icount->rx = channel->stats.rx;
113 icount->tx = channel->stats.tx;
114 icount->frame = channel->stats.framing_err;
115 icount->parity = channel->stats.parity_err;
116 icount->brk = channel->stats.rcv_break;
120 static void ipoctal_irq_rx(struct ipoctal_channel *channel,
121 struct tty_struct *tty, u8 sr)
128 value = ioread8(&channel->regs->r.rhr);
130 /* Error: count statistics */
132 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
134 if (sr & SR_OVERRUN_ERROR) {
135 channel->stats.overrun_err++;
136 /* Overrun doesn't affect the current character*/
137 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
139 if (sr & SR_PARITY_ERROR) {
140 channel->stats.parity_err++;
143 if (sr & SR_FRAMING_ERROR) {
144 channel->stats.framing_err++;
147 if (sr & SR_RECEIVED_BREAK) {
148 iowrite8(CR_CMD_RESET_BREAK_CHANGE, &channel->regs->w.cr);
149 channel->stats.rcv_break++;
153 tty_insert_flip_char(tty, value, flag);
155 /* Check if there are more characters in RX FIFO
156 * If there are more, the isr register for this channel
157 * has enabled the RxRDY|FFULL bit.
159 isr = ioread8(&channel->block_regs->r.isr);
160 sr = ioread8(&channel->regs->r.sr);
161 } while (isr & channel->isr_rx_rdy_mask);
163 tty_flip_buffer_push(tty);
166 static void ipoctal_irq_tx(struct ipoctal_channel *channel)
169 unsigned int *pointer_write = &channel->pointer_write;
171 if (channel->nb_bytes == 0)
174 value = channel->tty_port.xmit_buf[*pointer_write];
175 iowrite8(value, &channel->regs->w.thr);
178 *pointer_write = *pointer_write % PAGE_SIZE;
182 static void ipoctal_irq_channel(struct ipoctal_channel *channel)
185 struct tty_struct *tty;
187 tty = tty_port_tty_get(&channel->tty_port);
190 /* The HW is organized in pair of channels. See which register we need
192 isr = ioread8(&channel->block_regs->r.isr);
193 sr = ioread8(&channel->regs->r.sr);
195 if ((sr & SR_TX_EMPTY) && (channel->nb_bytes == 0)) {
196 iowrite8(CR_DISABLE_TX, &channel->regs->w.cr);
197 /* In case of RS-485, change from TX to RX when finishing TX.
199 if (channel->board_id == IPACK1_DEVICE_ID_SBS_OCTAL_485) {
200 iowrite8(CR_CMD_NEGATE_RTSN, &channel->regs->w.cr);
201 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
206 if ((isr & channel->isr_rx_rdy_mask) && (sr & SR_RX_READY))
207 ipoctal_irq_rx(channel, tty, sr);
209 /* TX of each character */
210 if ((isr & channel->isr_tx_rdy_mask) && (sr & SR_TX_READY))
211 ipoctal_irq_tx(channel);
213 tty_flip_buffer_push(tty);
217 static irqreturn_t ipoctal_irq_handler(void *arg)
220 struct ipoctal *ipoctal = (struct ipoctal *) arg;
222 /* Check all channels */
223 for (i = 0; i < NR_CHANNELS; i++)
224 ipoctal_irq_channel(&ipoctal->channel[i]);
226 /* Clear the IPack device interrupt */
227 readw(ipoctal->int_space + ACK_INT_REQ0);
228 readw(ipoctal->int_space + ACK_INT_REQ1);
233 static const struct tty_port_operations ipoctal_tty_port_ops = {
235 .activate = ipoctal_port_activate,
238 static int ipoctal_inst_slot(struct ipoctal *ipoctal, unsigned int bus_nr,
243 struct tty_driver *tty;
245 struct ipoctal_channel *channel;
246 struct ipack_region *region;
248 union scc2698_channel __iomem *chan_regs;
249 union scc2698_block __iomem *block_regs;
251 ipoctal->board_id = ipoctal->dev->id_device;
253 region = &ipoctal->dev->region[IPACK_IO_SPACE];
254 addr = devm_ioremap_nocache(&ipoctal->dev->dev,
255 region->start, region->size);
257 dev_err(&ipoctal->dev->dev,
258 "Unable to map slot [%d:%d] IO space!\n",
260 return -EADDRNOTAVAIL;
262 /* Save the virtual address to access the registers easily */
264 (union scc2698_channel __iomem *) addr;
266 (union scc2698_block __iomem *) addr;
268 region = &ipoctal->dev->region[IPACK_INT_SPACE];
270 devm_ioremap_nocache(&ipoctal->dev->dev,
271 region->start, region->size);
272 if (!ipoctal->int_space) {
273 dev_err(&ipoctal->dev->dev,
274 "Unable to map slot [%d:%d] INT space!\n",
276 return -EADDRNOTAVAIL;
279 region = &ipoctal->dev->region[IPACK_MEM8_SPACE];
280 ipoctal->mem8_space =
281 devm_ioremap_nocache(&ipoctal->dev->dev,
282 region->start, 0x8000);
284 dev_err(&ipoctal->dev->dev,
285 "Unable to map slot [%d:%d] MEM8 space!\n",
287 return -EADDRNOTAVAIL;
291 /* Disable RX and TX before touching anything */
292 for (i = 0; i < NR_CHANNELS ; i++) {
293 struct ipoctal_channel *channel = &ipoctal->channel[i];
294 channel->regs = chan_regs + i;
295 channel->block_regs = block_regs + (i >> 1);
296 channel->board_id = ipoctal->board_id;
298 channel->isr_tx_rdy_mask = ISR_TxRDY_B;
299 channel->isr_rx_rdy_mask = ISR_RxRDY_FFULL_B;
301 channel->isr_tx_rdy_mask = ISR_TxRDY_A;
302 channel->isr_rx_rdy_mask = ISR_RxRDY_FFULL_A;
305 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
306 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
307 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
308 iowrite8(MR1_CHRL_8_BITS | MR1_ERROR_CHAR | MR1_RxINT_RxRDY,
309 &channel->regs->w.mr); /* mr1 */
310 iowrite8(0, &channel->regs->w.mr); /* mr2 */
311 iowrite8(TX_CLK_9600 | RX_CLK_9600, &channel->regs->w.csr);
314 for (i = 0; i < IP_OCTAL_NB_BLOCKS; i++) {
315 iowrite8(ACR_BRG_SET2, &block_regs[i].w.acr);
316 iowrite8(OPCR_MPP_OUTPUT | OPCR_MPOa_RTSN | OPCR_MPOb_RTSN,
317 &block_regs[i].w.opcr);
318 iowrite8(IMR_TxRDY_A | IMR_RxRDY_FFULL_A | IMR_DELTA_BREAK_A |
319 IMR_TxRDY_B | IMR_RxRDY_FFULL_B | IMR_DELTA_BREAK_B,
320 &block_regs[i].w.imr);
324 * IP-OCTAL has different addresses to copy its IRQ vector.
325 * Depending of the carrier these addresses are accesible or not.
326 * More info in the datasheet.
328 ipoctal->dev->bus->ops->request_irq(ipoctal->dev,
329 ipoctal_irq_handler, ipoctal);
331 iowrite8(1, ipoctal->mem8_space + 1);
333 /* Register the TTY device */
335 /* Each IP-OCTAL channel is a TTY port */
336 tty = alloc_tty_driver(NR_CHANNELS);
341 /* Fill struct tty_driver with ipoctal data */
342 tty->owner = THIS_MODULE;
343 tty->driver_name = KBUILD_MODNAME;
344 sprintf(name, KBUILD_MODNAME ".%d.%d.", bus_nr, slot);
348 tty->minor_start = 0;
349 tty->type = TTY_DRIVER_TYPE_SERIAL;
350 tty->subtype = SERIAL_TYPE_NORMAL;
351 tty->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
352 tty->init_termios = tty_std_termios;
353 tty->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
354 tty->init_termios.c_ispeed = 9600;
355 tty->init_termios.c_ospeed = 9600;
357 tty_set_operations(tty, &ipoctal_fops);
358 res = tty_register_driver(tty);
360 dev_err(&ipoctal->dev->dev, "Can't register tty driver.\n");
365 /* Save struct tty_driver for use it when uninstalling the device */
366 ipoctal->tty_drv = tty;
368 for (i = 0; i < NR_CHANNELS; i++) {
369 struct device *tty_dev;
371 channel = &ipoctal->channel[i];
372 tty_port_init(&channel->tty_port);
373 tty_port_alloc_xmit_buf(&channel->tty_port);
374 channel->tty_port.ops = &ipoctal_tty_port_ops;
376 ipoctal_reset_stats(&channel->stats);
377 channel->nb_bytes = 0;
378 spin_lock_init(&channel->lock);
379 channel->pointer_read = 0;
380 channel->pointer_write = 0;
381 tty_dev = tty_port_register_device(&channel->tty_port, tty, i, NULL);
382 if (IS_ERR(tty_dev)) {
383 dev_err(&ipoctal->dev->dev, "Failed to register tty device.\n");
384 tty_port_destroy(&channel->tty_port);
387 dev_set_drvdata(tty_dev, channel);
390 * Enable again the RX. TX will be enabled when
391 * there is something to send
393 iowrite8(CR_ENABLE_RX, &channel->regs->w.cr);
399 static inline int ipoctal_copy_write_buffer(struct ipoctal_channel *channel,
400 const unsigned char *buf,
405 unsigned int *pointer_read = &channel->pointer_read;
407 /* Copy the bytes from the user buffer to the internal one */
408 for (i = 0; i < count; i++) {
409 if (i <= (PAGE_SIZE - channel->nb_bytes)) {
410 spin_lock_irqsave(&channel->lock, flags);
411 channel->tty_port.xmit_buf[*pointer_read] = buf[i];
412 *pointer_read = (*pointer_read + 1) % PAGE_SIZE;
414 spin_unlock_irqrestore(&channel->lock, flags);
422 static int ipoctal_write_tty(struct tty_struct *tty,
423 const unsigned char *buf, int count)
425 struct ipoctal_channel *channel = tty->driver_data;
426 unsigned int char_copied;
428 char_copied = ipoctal_copy_write_buffer(channel, buf, count);
430 /* As the IP-OCTAL 485 only supports half duplex, do it manually */
431 if (channel->board_id == IPACK1_DEVICE_ID_SBS_OCTAL_485) {
432 iowrite8(CR_DISABLE_RX, &channel->regs->w.cr);
433 iowrite8(CR_CMD_ASSERT_RTSN, &channel->regs->w.cr);
437 * Send a packet and then disable TX to avoid failure after several send
440 iowrite8(CR_ENABLE_TX, &channel->regs->w.cr);
444 static int ipoctal_write_room(struct tty_struct *tty)
446 struct ipoctal_channel *channel = tty->driver_data;
448 return PAGE_SIZE - channel->nb_bytes;
451 static int ipoctal_chars_in_buffer(struct tty_struct *tty)
453 struct ipoctal_channel *channel = tty->driver_data;
455 return channel->nb_bytes;
458 static void ipoctal_set_termios(struct tty_struct *tty,
459 struct ktermios *old_termios)
462 unsigned char mr1 = 0;
463 unsigned char mr2 = 0;
464 unsigned char csr = 0;
465 struct ipoctal_channel *channel = tty->driver_data;
468 cflag = tty->termios.c_cflag;
470 /* Disable and reset everything before change the setup */
471 iowrite8(CR_DISABLE_RX | CR_DISABLE_TX, &channel->regs->w.cr);
472 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
473 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
474 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
475 iowrite8(CR_CMD_RESET_MR, &channel->regs->w.cr);
477 /* Set Bits per chars */
478 switch (cflag & CSIZE) {
480 mr1 |= MR1_CHRL_6_BITS;
483 mr1 |= MR1_CHRL_7_BITS;
487 mr1 |= MR1_CHRL_8_BITS;
488 /* By default, select CS8 */
489 tty->termios.c_cflag = (cflag & ~CSIZE) | CS8;
496 mr1 |= MR1_PARITY_ON | MR1_PARITY_ODD;
498 mr1 |= MR1_PARITY_ON | MR1_PARITY_EVEN;
500 mr1 |= MR1_PARITY_OFF;
502 /* Mark or space parity is not supported */
503 tty->termios.c_cflag &= ~CMSPAR;
507 mr2 |= MR2_STOP_BITS_LENGTH_2;
509 mr2 |= MR2_STOP_BITS_LENGTH_1;
511 /* Set the flow control */
512 switch (channel->board_id) {
513 case IPACK1_DEVICE_ID_SBS_OCTAL_232:
514 if (cflag & CRTSCTS) {
515 mr1 |= MR1_RxRTS_CONTROL_ON;
516 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_ON;
518 mr1 |= MR1_RxRTS_CONTROL_OFF;
519 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_OFF;
522 case IPACK1_DEVICE_ID_SBS_OCTAL_422:
523 mr1 |= MR1_RxRTS_CONTROL_OFF;
524 mr2 |= MR2_TxRTS_CONTROL_OFF | MR2_CTS_ENABLE_TX_OFF;
526 case IPACK1_DEVICE_ID_SBS_OCTAL_485:
527 mr1 |= MR1_RxRTS_CONTROL_OFF;
528 mr2 |= MR2_TxRTS_CONTROL_ON | MR2_CTS_ENABLE_TX_OFF;
535 baud = tty_get_baud_rate(tty);
536 tty_termios_encode_baud_rate(&tty->termios, baud, baud);
541 csr |= TX_CLK_75 | RX_CLK_75;
544 csr |= TX_CLK_110 | RX_CLK_110;
547 csr |= TX_CLK_150 | RX_CLK_150;
550 csr |= TX_CLK_300 | RX_CLK_300;
553 csr |= TX_CLK_600 | RX_CLK_600;
556 csr |= TX_CLK_1200 | RX_CLK_1200;
559 csr |= TX_CLK_1800 | RX_CLK_1800;
562 csr |= TX_CLK_2000 | RX_CLK_2000;
565 csr |= TX_CLK_2400 | RX_CLK_2400;
568 csr |= TX_CLK_4800 | RX_CLK_4800;
571 csr |= TX_CLK_9600 | RX_CLK_9600;
574 csr |= TX_CLK_19200 | RX_CLK_19200;
578 csr |= TX_CLK_38400 | RX_CLK_38400;
579 /* In case of default, we establish 38400 bps */
580 tty_termios_encode_baud_rate(&tty->termios, 38400, 38400);
584 mr1 |= MR1_ERROR_CHAR;
585 mr1 |= MR1_RxINT_RxRDY;
587 /* Write the control registers */
588 iowrite8(mr1, &channel->regs->w.mr);
589 iowrite8(mr2, &channel->regs->w.mr);
590 iowrite8(csr, &channel->regs->w.csr);
592 /* Enable again the RX */
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 iowrite8(CR_CMD_RESET_RX, &channel->regs->w.cr);
614 iowrite8(CR_CMD_RESET_TX, &channel->regs->w.cr);
615 iowrite8(CR_CMD_RESET_ERR_STATUS, &channel->regs->w.cr);
616 iowrite8(CR_CMD_RESET_MR, &channel->regs->w.cr);
618 clear_bit(ASYNCB_INITIALIZED, &channel->tty_port.flags);
619 wake_up_interruptible(&channel->tty_port.open_wait);
622 static const struct tty_operations ipoctal_fops = {
624 .open = ipoctal_open,
625 .close = ipoctal_close,
626 .write = ipoctal_write_tty,
627 .set_termios = ipoctal_set_termios,
628 .write_room = ipoctal_write_room,
629 .chars_in_buffer = ipoctal_chars_in_buffer,
630 .get_icount = ipoctal_get_icount,
631 .hangup = ipoctal_hangup,
634 static int ipoctal_probe(struct ipack_device *dev)
637 struct ipoctal *ipoctal;
639 ipoctal = kzalloc(sizeof(struct ipoctal), GFP_KERNEL);
644 res = ipoctal_inst_slot(ipoctal, dev->bus->bus_nr, dev->slot);
648 dev_set_drvdata(&dev->dev, ipoctal);
656 static void __ipoctal_remove(struct ipoctal *ipoctal)
660 ipoctal->dev->bus->ops->free_irq(ipoctal->dev);
662 for (i = 0; i < NR_CHANNELS; i++) {
663 struct ipoctal_channel *channel = &ipoctal->channel[i];
664 tty_unregister_device(ipoctal->tty_drv, i);
665 tty_port_free_xmit_buf(&channel->tty_port);
666 tty_port_destroy(&channel->tty_port);
669 tty_unregister_driver(ipoctal->tty_drv);
670 put_tty_driver(ipoctal->tty_drv);
674 static void ipoctal_remove(struct ipack_device *idev)
676 __ipoctal_remove(dev_get_drvdata(&idev->dev));
679 static DEFINE_IPACK_DEVICE_TABLE(ipoctal_ids) = {
680 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
681 IPACK1_DEVICE_ID_SBS_OCTAL_232) },
682 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
683 IPACK1_DEVICE_ID_SBS_OCTAL_422) },
684 { IPACK_DEVICE(IPACK_ID_VERSION_1, IPACK1_VENDOR_ID_SBS,
685 IPACK1_DEVICE_ID_SBS_OCTAL_485) },
689 MODULE_DEVICE_TABLE(ipack, ipoctal_ids);
691 static const struct ipack_driver_ops ipoctal_drv_ops = {
692 .probe = ipoctal_probe,
693 .remove = ipoctal_remove,
696 static struct ipack_driver driver = {
697 .ops = &ipoctal_drv_ops,
698 .id_table = ipoctal_ids,
701 static int __init ipoctal_init(void)
703 return ipack_driver_register(&driver, THIS_MODULE, KBUILD_MODNAME);
706 static void __exit ipoctal_exit(void)
708 ipack_driver_unregister(&driver);
711 MODULE_DESCRIPTION("IP-Octal 232, 422 and 485 device driver");
712 MODULE_LICENSE("GPL");
714 module_init(ipoctal_init);
715 module_exit(ipoctal_exit);