1 // SPDX-License-Identifier: GPL-2.0+
4 * Copyright (C) 2008 Christian Pellegrin <chripell@evolware.org>
6 * Notes: the MAX3100 doesn't provide an interrupt on CTS so we have
7 * to use polling for flow control. TX empty IRQ is unusable, since
8 * writing conf clears FIFO buffer and we cannot have this interrupt
9 * always asking us for attention.
11 * Example platform data:
13 static struct plat_max3100 max3100_plat_data = {
19 static struct spi_board_info spi_board_info[] = {
21 .modalias = "max3100",
22 .platform_data = &max3100_plat_data,
24 .max_speed_hz = 5*1000*1000,
29 * The initial minor number is 209 in the low-density serial port:
30 * mknod /dev/ttyMAX0 c 204 209
33 #define MAX3100_MAJOR 204
34 #define MAX3100_MINOR 209
35 /* 4 MAX3100s should be enough for everyone */
38 #include <linux/delay.h>
39 #include <linux/slab.h>
40 #include <linux/device.h>
41 #include <linux/module.h>
42 #include <linux/serial_core.h>
43 #include <linux/serial.h>
44 #include <linux/spi/spi.h>
45 #include <linux/freezer.h>
46 #include <linux/tty.h>
47 #include <linux/tty_flip.h>
49 #include <linux/serial_max3100.h>
51 #define MAX3100_C (1<<14)
52 #define MAX3100_D (0<<14)
53 #define MAX3100_W (1<<15)
54 #define MAX3100_RX (0<<15)
56 #define MAX3100_WC (MAX3100_W | MAX3100_C)
57 #define MAX3100_RC (MAX3100_RX | MAX3100_C)
58 #define MAX3100_WD (MAX3100_W | MAX3100_D)
59 #define MAX3100_RD (MAX3100_RX | MAX3100_D)
60 #define MAX3100_CMD (3 << 14)
62 #define MAX3100_T (1<<14)
63 #define MAX3100_R (1<<15)
65 #define MAX3100_FEN (1<<13)
66 #define MAX3100_SHDN (1<<12)
67 #define MAX3100_TM (1<<11)
68 #define MAX3100_RM (1<<10)
69 #define MAX3100_PM (1<<9)
70 #define MAX3100_RAM (1<<8)
71 #define MAX3100_IR (1<<7)
72 #define MAX3100_ST (1<<6)
73 #define MAX3100_PE (1<<5)
74 #define MAX3100_L (1<<4)
75 #define MAX3100_BAUD (0xf)
77 #define MAX3100_TE (1<<10)
78 #define MAX3100_RAFE (1<<10)
79 #define MAX3100_RTS (1<<9)
80 #define MAX3100_CTS (1<<9)
81 #define MAX3100_PT (1<<8)
82 #define MAX3100_DATA (0xff)
84 #define MAX3100_RT (MAX3100_R | MAX3100_T)
85 #define MAX3100_RTC (MAX3100_RT | MAX3100_CTS | MAX3100_RAFE)
87 /* the following simulate a status reg for ignore_status_mask */
88 #define MAX3100_STATUS_PE 1
89 #define MAX3100_STATUS_FE 2
90 #define MAX3100_STATUS_OE 4
93 struct uart_port port;
94 struct spi_device *spi;
96 int cts; /* last CTS received for flow ctrl */
97 int tx_empty; /* last TX empty bit */
99 spinlock_t conf_lock; /* shared data */
100 int conf_commit; /* need to make changes */
101 int conf; /* configuration for the MAX31000
102 * (bits 0-7, bits 8-11 are irqs) */
103 int rts_commit; /* need to change rts */
104 int rts; /* rts status */
105 int baud; /* current baud rate */
107 int parity; /* keeps track if we should send parity */
108 #define MAX3100_PARITY_ON 1
109 #define MAX3100_PARITY_ODD 2
110 #define MAX3100_7BIT 4
111 int rx_enabled; /* if we should rx chars */
113 int irq; /* irq assigned to the max3100 */
115 int minor; /* minor number */
116 int crystal; /* 1 if 3.6864Mhz crystal 0 for 1.8432 */
117 int loopback; /* 1 if we are in loopback mode */
119 /* for handling irqs: need workqueue since we do spi_sync */
120 struct workqueue_struct *workqueue;
121 struct work_struct work;
122 /* set to 1 to make the workhandler exit as soon as possible */
124 /* need to know we are suspending to avoid deadlock on workqueue */
127 /* hook for suspending MAX3100 via dedicated pin */
128 void (*max3100_hw_suspend) (int suspend);
130 /* poll time (in ms) for ctrl lines */
133 struct timer_list timer;
136 static struct max3100_port *max3100s[MAX_MAX3100]; /* the chips */
137 static DEFINE_MUTEX(max3100s_lock); /* race on probe */
139 static int max3100_do_parity(struct max3100_port *s, u16 c)
143 if (s->parity & MAX3100_PARITY_ODD)
148 if (s->parity & MAX3100_7BIT)
153 parity = parity ^ (hweight8(c) & 1);
157 static int max3100_check_parity(struct max3100_port *s, u16 c)
159 return max3100_do_parity(s, c) == ((c >> 8) & 1);
162 static void max3100_calc_parity(struct max3100_port *s, u16 *c)
164 if (s->parity & MAX3100_7BIT)
169 if (s->parity & MAX3100_PARITY_ON)
170 *c |= max3100_do_parity(s, *c) << 8;
173 static void max3100_work(struct work_struct *w);
175 static void max3100_dowork(struct max3100_port *s)
177 if (!s->force_end_work && !freezing(current) && !s->suspending)
178 queue_work(s->workqueue, &s->work);
181 static void max3100_timeout(struct timer_list *t)
183 struct max3100_port *s = from_timer(s, t, timer);
187 mod_timer(&s->timer, jiffies + s->poll_time);
191 static int max3100_sr(struct max3100_port *s, u16 tx, u16 *rx)
193 struct spi_message message;
196 struct spi_transfer tran = {
202 etx = cpu_to_be16(tx);
203 spi_message_init(&message);
204 spi_message_add_tail(&tran, &message);
205 status = spi_sync(s->spi, &message);
207 dev_warn(&s->spi->dev, "error while calling spi_sync\n");
210 *rx = be16_to_cpu(erx);
211 s->tx_empty = (*rx & MAX3100_T) > 0;
212 dev_dbg(&s->spi->dev, "%04x - %04x\n", tx, *rx);
216 static int max3100_handlerx_unlocked(struct max3100_port *s, u16 rx)
218 unsigned int status = 0;
222 if (rx & MAX3100_R && s->rx_enabled) {
223 dev_dbg(&s->spi->dev, "%s\n", __func__);
224 ch = rx & (s->parity & MAX3100_7BIT ? 0x7f : 0xff);
225 if (rx & MAX3100_RAFE) {
226 s->port.icount.frame++;
228 status |= MAX3100_STATUS_FE;
230 if (s->parity & MAX3100_PARITY_ON) {
231 if (max3100_check_parity(s, rx)) {
235 s->port.icount.parity++;
237 status |= MAX3100_STATUS_PE;
244 uart_insert_char(&s->port, status, MAX3100_STATUS_OE, ch, flg);
248 cts = (rx & MAX3100_CTS) > 0;
251 uart_handle_cts_change(&s->port, cts);
257 static int max3100_handlerx(struct max3100_port *s, u16 rx)
262 uart_port_lock_irqsave(&s->port, &flags);
263 ret = max3100_handlerx_unlocked(s, rx);
264 uart_port_unlock_irqrestore(&s->port, flags);
268 static void max3100_work(struct work_struct *w)
270 struct max3100_port *s = container_of(w, struct max3100_port, work);
271 struct tty_port *tport = &s->port.state->port;
275 int conf, cconf, crts;
277 dev_dbg(&s->spi->dev, "%s\n", __func__);
281 spin_lock(&s->conf_lock);
283 cconf = s->conf_commit;
285 crts = s->rts_commit;
287 spin_unlock(&s->conf_lock);
289 max3100_sr(s, MAX3100_WC | conf, &rx);
291 max3100_sr(s, MAX3100_WD | MAX3100_TE |
292 (s->rts ? MAX3100_RTS : 0), &rx);
293 rxchars += max3100_handlerx(s, rx);
296 max3100_sr(s, MAX3100_RD, &rx);
297 rxchars += max3100_handlerx(s, rx);
299 if (rx & MAX3100_T) {
301 if (s->port.x_char) {
305 } else if (!uart_tx_stopped(&s->port) &&
306 uart_fifo_get(&s->port, &ch)) {
310 max3100_calc_parity(s, &tx);
311 tx |= MAX3100_WD | (s->rts ? MAX3100_RTS : 0);
312 max3100_sr(s, tx, &rx);
313 rxchars += max3100_handlerx(s, rx);
318 tty_flip_buffer_push(&s->port.state->port);
321 if (kfifo_len(&tport->xmit_fifo) < WAKEUP_CHARS)
322 uart_write_wakeup(&s->port);
324 } while (!s->force_end_work &&
325 !freezing(current) &&
327 (!kfifo_is_empty(&tport->xmit_fifo) &&
328 !uart_tx_stopped(&s->port))));
331 tty_flip_buffer_push(&s->port.state->port);
334 static irqreturn_t max3100_irq(int irqno, void *dev_id)
336 struct max3100_port *s = dev_id;
338 dev_dbg(&s->spi->dev, "%s\n", __func__);
344 static void max3100_enable_ms(struct uart_port *port)
346 struct max3100_port *s = container_of(port,
350 if (s->poll_time > 0)
351 mod_timer(&s->timer, jiffies);
352 dev_dbg(&s->spi->dev, "%s\n", __func__);
355 static void max3100_start_tx(struct uart_port *port)
357 struct max3100_port *s = container_of(port,
361 dev_dbg(&s->spi->dev, "%s\n", __func__);
366 static void max3100_stop_rx(struct uart_port *port)
368 struct max3100_port *s = container_of(port,
372 dev_dbg(&s->spi->dev, "%s\n", __func__);
375 spin_lock(&s->conf_lock);
376 s->conf &= ~MAX3100_RM;
378 spin_unlock(&s->conf_lock);
382 static unsigned int max3100_tx_empty(struct uart_port *port)
384 struct max3100_port *s = container_of(port,
388 dev_dbg(&s->spi->dev, "%s\n", __func__);
390 /* may not be truly up-to-date */
395 static unsigned int max3100_get_mctrl(struct uart_port *port)
397 struct max3100_port *s = container_of(port,
401 dev_dbg(&s->spi->dev, "%s\n", __func__);
403 /* may not be truly up-to-date */
405 /* always assert DCD and DSR since these lines are not wired */
406 return (s->cts ? TIOCM_CTS : 0) | TIOCM_DSR | TIOCM_CAR;
409 static void max3100_set_mctrl(struct uart_port *port, unsigned int mctrl)
411 struct max3100_port *s = container_of(port,
416 dev_dbg(&s->spi->dev, "%s\n", __func__);
418 rts = (mctrl & TIOCM_RTS) > 0;
420 spin_lock(&s->conf_lock);
426 spin_unlock(&s->conf_lock);
430 max3100_set_termios(struct uart_port *port, struct ktermios *termios,
431 const struct ktermios *old)
433 struct max3100_port *s = container_of(port,
438 u32 param_new, param_mask, parity = 0;
440 dev_dbg(&s->spi->dev, "%s\n", __func__);
442 cflag = termios->c_cflag;
445 baud = tty_termios_baud_rate(termios);
446 param_new = s->conf & MAX3100_BAUD;
455 param_new = 14 + s->crystal;
458 param_new = 13 + s->crystal;
461 param_new = 12 + s->crystal;
464 param_new = 11 + s->crystal;
467 param_new = 10 + s->crystal;
470 param_new = 9 + s->crystal;
473 param_new = 8 + s->crystal;
476 param_new = 1 + s->crystal;
479 param_new = 0 + s->crystal;
490 tty_termios_encode_baud_rate(termios, baud, baud);
492 param_mask |= MAX3100_BAUD;
494 if ((cflag & CSIZE) == CS8) {
495 param_new &= ~MAX3100_L;
496 parity &= ~MAX3100_7BIT;
498 param_new |= MAX3100_L;
499 parity |= MAX3100_7BIT;
500 cflag = (cflag & ~CSIZE) | CS7;
502 param_mask |= MAX3100_L;
505 param_new |= MAX3100_ST;
507 param_new &= ~MAX3100_ST;
508 param_mask |= MAX3100_ST;
510 if (cflag & PARENB) {
511 param_new |= MAX3100_PE;
512 parity |= MAX3100_PARITY_ON;
514 param_new &= ~MAX3100_PE;
515 parity &= ~MAX3100_PARITY_ON;
517 param_mask |= MAX3100_PE;
520 parity |= MAX3100_PARITY_ODD;
522 parity &= ~MAX3100_PARITY_ODD;
524 /* mask termios capabilities we don't support */
526 termios->c_cflag = cflag;
528 s->port.ignore_status_mask = 0;
529 if (termios->c_iflag & IGNPAR)
530 s->port.ignore_status_mask |=
531 MAX3100_STATUS_PE | MAX3100_STATUS_FE |
534 if (s->poll_time > 0)
535 del_timer_sync(&s->timer);
537 uart_update_timeout(port, termios->c_cflag, baud);
539 spin_lock(&s->conf_lock);
540 s->conf = (s->conf & ~param_mask) | (param_new & param_mask);
543 spin_unlock(&s->conf_lock);
546 if (UART_ENABLE_MS(&s->port, termios->c_cflag))
547 max3100_enable_ms(&s->port);
550 static void max3100_shutdown(struct uart_port *port)
552 struct max3100_port *s = container_of(port,
556 dev_dbg(&s->spi->dev, "%s\n", __func__);
561 s->force_end_work = 1;
563 if (s->poll_time > 0)
564 del_timer_sync(&s->timer);
567 destroy_workqueue(s->workqueue);
573 /* set shutdown mode to save power */
574 if (s->max3100_hw_suspend)
575 s->max3100_hw_suspend(1);
579 tx = MAX3100_WC | MAX3100_SHDN;
580 max3100_sr(s, tx, &rx);
584 static int max3100_startup(struct uart_port *port)
586 struct max3100_port *s = container_of(port,
591 dev_dbg(&s->spi->dev, "%s\n", __func__);
593 s->conf = MAX3100_RM;
594 s->baud = s->crystal ? 230400 : 115200;
600 s->force_end_work = 0;
604 sprintf(b, "max3100-%d", s->minor);
605 s->workqueue = create_freezable_workqueue(b);
607 dev_warn(&s->spi->dev, "cannot create workqueue\n");
610 INIT_WORK(&s->work, max3100_work);
612 if (request_irq(s->irq, max3100_irq,
613 IRQF_TRIGGER_FALLING, "max3100", s) < 0) {
614 dev_warn(&s->spi->dev, "cannot allocate irq %d\n", s->irq);
616 destroy_workqueue(s->workqueue);
624 max3100_sr(s, tx, &rx);
627 if (s->max3100_hw_suspend)
628 s->max3100_hw_suspend(0);
631 /* wait for clock to settle */
634 max3100_enable_ms(&s->port);
639 static const char *max3100_type(struct uart_port *port)
641 struct max3100_port *s = container_of(port,
645 dev_dbg(&s->spi->dev, "%s\n", __func__);
647 return s->port.type == PORT_MAX3100 ? "MAX3100" : NULL;
650 static void max3100_release_port(struct uart_port *port)
652 struct max3100_port *s = container_of(port,
656 dev_dbg(&s->spi->dev, "%s\n", __func__);
659 static void max3100_config_port(struct uart_port *port, int flags)
661 struct max3100_port *s = container_of(port,
665 dev_dbg(&s->spi->dev, "%s\n", __func__);
667 if (flags & UART_CONFIG_TYPE)
668 s->port.type = PORT_MAX3100;
671 static int max3100_verify_port(struct uart_port *port,
672 struct serial_struct *ser)
674 struct max3100_port *s = container_of(port,
679 dev_dbg(&s->spi->dev, "%s\n", __func__);
681 if (ser->type == PORT_UNKNOWN || ser->type == PORT_MAX3100)
686 static void max3100_stop_tx(struct uart_port *port)
688 struct max3100_port *s = container_of(port,
692 dev_dbg(&s->spi->dev, "%s\n", __func__);
695 static int max3100_request_port(struct uart_port *port)
697 struct max3100_port *s = container_of(port,
701 dev_dbg(&s->spi->dev, "%s\n", __func__);
705 static void max3100_break_ctl(struct uart_port *port, int break_state)
707 struct max3100_port *s = container_of(port,
711 dev_dbg(&s->spi->dev, "%s\n", __func__);
714 static const struct uart_ops max3100_ops = {
715 .tx_empty = max3100_tx_empty,
716 .set_mctrl = max3100_set_mctrl,
717 .get_mctrl = max3100_get_mctrl,
718 .stop_tx = max3100_stop_tx,
719 .start_tx = max3100_start_tx,
720 .stop_rx = max3100_stop_rx,
721 .enable_ms = max3100_enable_ms,
722 .break_ctl = max3100_break_ctl,
723 .startup = max3100_startup,
724 .shutdown = max3100_shutdown,
725 .set_termios = max3100_set_termios,
726 .type = max3100_type,
727 .release_port = max3100_release_port,
728 .request_port = max3100_request_port,
729 .config_port = max3100_config_port,
730 .verify_port = max3100_verify_port,
733 static struct uart_driver max3100_uart_driver = {
734 .owner = THIS_MODULE,
735 .driver_name = "ttyMAX",
736 .dev_name = "ttyMAX",
737 .major = MAX3100_MAJOR,
738 .minor = MAX3100_MINOR,
741 static int uart_driver_registered;
743 static int max3100_probe(struct spi_device *spi)
746 struct plat_max3100 *pdata;
749 mutex_lock(&max3100s_lock);
751 if (!uart_driver_registered) {
752 retval = uart_register_driver(&max3100_uart_driver);
754 printk(KERN_ERR "Couldn't register max3100 uart driver\n");
755 mutex_unlock(&max3100s_lock);
759 uart_driver_registered = 1;
762 for (i = 0; i < MAX_MAX3100; i++)
765 if (i == MAX_MAX3100) {
766 dev_warn(&spi->dev, "too many MAX3100 chips\n");
767 mutex_unlock(&max3100s_lock);
771 max3100s[i] = kzalloc(sizeof(struct max3100_port), GFP_KERNEL);
774 "kmalloc for max3100 structure %d failed!\n", i);
775 mutex_unlock(&max3100s_lock);
778 max3100s[i]->spi = spi;
779 max3100s[i]->irq = spi->irq;
780 spin_lock_init(&max3100s[i]->conf_lock);
781 spi_set_drvdata(spi, max3100s[i]);
782 pdata = dev_get_platdata(&spi->dev);
783 max3100s[i]->crystal = pdata->crystal;
784 max3100s[i]->loopback = pdata->loopback;
785 max3100s[i]->poll_time = msecs_to_jiffies(pdata->poll_time);
786 if (pdata->poll_time > 0 && max3100s[i]->poll_time == 0)
787 max3100s[i]->poll_time = 1;
788 max3100s[i]->max3100_hw_suspend = pdata->max3100_hw_suspend;
789 max3100s[i]->minor = i;
790 timer_setup(&max3100s[i]->timer, max3100_timeout, 0);
792 dev_dbg(&spi->dev, "%s: adding port %d\n", __func__, i);
793 max3100s[i]->port.irq = max3100s[i]->irq;
794 max3100s[i]->port.uartclk = max3100s[i]->crystal ? 3686400 : 1843200;
795 max3100s[i]->port.fifosize = 16;
796 max3100s[i]->port.ops = &max3100_ops;
797 max3100s[i]->port.flags = UPF_SKIP_TEST | UPF_BOOT_AUTOCONF;
798 max3100s[i]->port.line = i;
799 max3100s[i]->port.type = PORT_MAX3100;
800 max3100s[i]->port.dev = &spi->dev;
801 retval = uart_add_one_port(&max3100_uart_driver, &max3100s[i]->port);
804 "uart_add_one_port failed for line %d with error %d\n",
807 /* set shutdown mode to save power. Will be woken-up on open */
808 if (max3100s[i]->max3100_hw_suspend)
809 max3100s[i]->max3100_hw_suspend(1);
811 tx = MAX3100_WC | MAX3100_SHDN;
812 max3100_sr(max3100s[i], tx, &rx);
814 mutex_unlock(&max3100s_lock);
818 static void max3100_remove(struct spi_device *spi)
820 struct max3100_port *s = spi_get_drvdata(spi);
823 mutex_lock(&max3100s_lock);
825 /* find out the index for the chip we are removing */
826 for (i = 0; i < MAX_MAX3100; i++)
827 if (max3100s[i] == s) {
828 dev_dbg(&spi->dev, "%s: removing port %d\n", __func__, i);
829 uart_remove_one_port(&max3100_uart_driver, &max3100s[i]->port);
835 WARN_ON(i == MAX_MAX3100);
837 /* check if this is the last chip we have */
838 for (i = 0; i < MAX_MAX3100; i++)
840 mutex_unlock(&max3100s_lock);
843 pr_debug("removing max3100 driver\n");
844 uart_unregister_driver(&max3100_uart_driver);
845 uart_driver_registered = 0;
847 mutex_unlock(&max3100s_lock);
850 #ifdef CONFIG_PM_SLEEP
852 static int max3100_suspend(struct device *dev)
854 struct max3100_port *s = dev_get_drvdata(dev);
856 dev_dbg(&s->spi->dev, "%s\n", __func__);
861 uart_suspend_port(&max3100_uart_driver, &s->port);
863 if (s->max3100_hw_suspend)
864 s->max3100_hw_suspend(1);
866 /* no HW suspend, so do SW one */
869 tx = MAX3100_WC | MAX3100_SHDN;
870 max3100_sr(s, tx, &rx);
875 static int max3100_resume(struct device *dev)
877 struct max3100_port *s = dev_get_drvdata(dev);
879 dev_dbg(&s->spi->dev, "%s\n", __func__);
881 if (s->max3100_hw_suspend)
882 s->max3100_hw_suspend(0);
883 uart_resume_port(&max3100_uart_driver, &s->port);
895 static SIMPLE_DEV_PM_OPS(max3100_pm_ops, max3100_suspend, max3100_resume);
896 #define MAX3100_PM_OPS (&max3100_pm_ops)
899 #define MAX3100_PM_OPS NULL
902 static struct spi_driver max3100_driver = {
905 .pm = MAX3100_PM_OPS,
907 .probe = max3100_probe,
908 .remove = max3100_remove,
911 module_spi_driver(max3100_driver);
913 MODULE_DESCRIPTION("MAX3100 driver");
914 MODULE_AUTHOR("Christian Pellegrin <chripell@evolware.org>");
915 MODULE_LICENSE("GPL");
916 MODULE_ALIAS("spi:max3100");