blob: f641c232beca99137cff5739ccb4b008ea881574 [file] [log] [blame]
Feng Tang22510992010-06-16 14:46:09 +01001/*
Feng Tangee9b4502010-09-13 15:39:48 +08002 * mrst_max3110.c - spi uart protocol driver for Maxim 3110
Feng Tang22510992010-06-16 14:46:09 +01003 *
Feng Tangee9b4502010-09-13 15:39:48 +08004 * Copyright (c) 2008-2010, Intel Corporation.
Feng Tang22510992010-06-16 14:46:09 +01005 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms and conditions of the GNU General Public License,
8 * version 2, as published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
14 *
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20/*
21 * Note:
22 * 1. From Max3110 spec, the Rx FIFO has 8 words, while the Tx FIFO only has
23 * 1 word. If SPI master controller doesn't support sclk frequency change,
24 * then the char need be sent out one by one with some delay
25 *
Vitaliy Ivanovfb914eb2011-06-23 20:01:55 +030026 * 2. Currently only RX available interrupt is used, no need for waiting TXE
Feng Tang22510992010-06-16 14:46:09 +010027 * interrupt for a low speed UART device
28 */
29
Alexander Shishkin51808f02011-08-26 11:25:35 +010030#ifdef CONFIG_MAGIC_SYSRQ
31#define SUPPORT_SYSRQ
32#endif
33
Feng Tang22510992010-06-16 14:46:09 +010034#include <linux/module.h>
35#include <linux/ioport.h>
Andrew Mortonc0443912010-09-30 15:15:29 -070036#include <linux/irq.h>
Feng Tang22510992010-06-16 14:46:09 +010037#include <linux/init.h>
38#include <linux/console.h>
Feng Tang22510992010-06-16 14:46:09 +010039#include <linux/tty.h>
40#include <linux/tty_flip.h>
41#include <linux/serial_core.h>
42#include <linux/serial_reg.h>
43
44#include <linux/kthread.h>
Feng Tang22510992010-06-16 14:46:09 +010045#include <linux/spi/spi.h>
Feng Tang22510992010-06-16 14:46:09 +010046
47#include "mrst_max3110.h"
48
49#define PR_FMT "mrst_max3110: "
50
Arjan van de Vend6e679b2010-06-17 11:02:15 +010051#define UART_TX_NEEDED 1
52#define CON_TX_NEEDED 2
53#define BIT_IRQ_PENDING 3
54
Feng Tang22510992010-06-16 14:46:09 +010055struct uart_max3110 {
56 struct uart_port port;
57 struct spi_device *spi;
Dan Carpenterd8653d32011-01-25 14:15:11 +000058 char name[SPI_NAME_SIZE];
Feng Tang22510992010-06-16 14:46:09 +010059
60 wait_queue_head_t wq;
61 struct task_struct *main_thread;
62 struct task_struct *read_thread;
Justin P. Mattock6eab04a2011-04-08 19:49:08 -070063 struct mutex thread_mutex;
Feng Tang22510992010-06-16 14:46:09 +010064
65 u32 baud;
66 u16 cur_conf;
67 u8 clock;
68 u8 parity, word_7bits;
Feng Tangee9b4502010-09-13 15:39:48 +080069 u16 irq;
Feng Tang22510992010-06-16 14:46:09 +010070
Arjan van de Vend6e679b2010-06-17 11:02:15 +010071 unsigned long uart_flags;
Feng Tang22510992010-06-16 14:46:09 +010072
73 /* console related */
74 struct circ_buf con_xmit;
Feng Tang22510992010-06-16 14:46:09 +010075};
76
77/* global data structure, may need be removed */
Feng Tangee9b4502010-09-13 15:39:48 +080078static struct uart_max3110 *pmax;
79
Alexander Shishkin51808f02011-08-26 11:25:35 +010080static int receive_chars(struct uart_max3110 *max,
81 unsigned short *str, int len);
82static int max3110_read_multi(struct uart_max3110 *max);
Feng Tangee9b4502010-09-13 15:39:48 +080083static void max3110_con_receive(struct uart_max3110 *max);
Feng Tang22510992010-06-16 14:46:09 +010084
Feng Tangee9b4502010-09-13 15:39:48 +080085static int max3110_write_then_read(struct uart_max3110 *max,
86 const void *txbuf, void *rxbuf, unsigned len, int always_fast)
Feng Tang22510992010-06-16 14:46:09 +010087{
88 struct spi_device *spi = max->spi;
89 struct spi_message message;
90 struct spi_transfer x;
91 int ret;
92
Feng Tang22510992010-06-16 14:46:09 +010093 spi_message_init(&message);
94 memset(&x, 0, sizeof x);
95 x.len = len;
96 x.tx_buf = txbuf;
97 x.rx_buf = rxbuf;
98 spi_message_add_tail(&x, &message);
99
100 if (always_fast)
Feng Tangee9b4502010-09-13 15:39:48 +0800101 x.speed_hz = spi->max_speed_hz;
Feng Tang22510992010-06-16 14:46:09 +0100102 else if (max->baud)
103 x.speed_hz = max->baud;
104
105 /* Do the i/o */
106 ret = spi_sync(spi, &message);
107 return ret;
108}
109
Feng Tangee9b4502010-09-13 15:39:48 +0800110/* Write a 16b word to the device */
111static int max3110_out(struct uart_max3110 *max, const u16 out)
Feng Tang22510992010-06-16 14:46:09 +0100112{
Feng Tangee9b4502010-09-13 15:39:48 +0800113 void *buf;
114 u16 *obuf, *ibuf;
Feng Tang22510992010-06-16 14:46:09 +0100115 int ret;
116
Feng Tangee9b4502010-09-13 15:39:48 +0800117 buf = kzalloc(8, GFP_KERNEL | GFP_DMA);
118 if (!buf)
119 return -ENOMEM;
120
121 obuf = buf;
122 ibuf = buf + 4;
123 *obuf = out;
124 ret = max3110_write_then_read(max, obuf, ibuf, 2, 1);
125 if (ret) {
126 pr_warning(PR_FMT "%s(): get err msg %d when sending 0x%x\n",
127 __func__, ret, out);
128 goto exit;
129 }
Feng Tang22510992010-06-16 14:46:09 +0100130
Alexander Shishkin51808f02011-08-26 11:25:35 +0100131 receive_chars(max, ibuf, 1);
Feng Tang22510992010-06-16 14:46:09 +0100132
Feng Tangee9b4502010-09-13 15:39:48 +0800133exit:
134 kfree(buf);
Feng Tang22510992010-06-16 14:46:09 +0100135 return ret;
136}
137
Feng Tang22510992010-06-16 14:46:09 +0100138/*
139 * This is usually used to read data from SPIC RX FIFO, which doesn't
Feng Tangee9b4502010-09-13 15:39:48 +0800140 * need any delay like flushing character out.
141 *
142 * Return how many valide bytes are read back
Feng Tang22510992010-06-16 14:46:09 +0100143 */
Alexander Shishkin51808f02011-08-26 11:25:35 +0100144static int max3110_read_multi(struct uart_max3110 *max)
Feng Tang22510992010-06-16 14:46:09 +0100145{
Feng Tangee9b4502010-09-13 15:39:48 +0800146 void *buf;
147 u16 *obuf, *ibuf;
Alexander Shishkin51808f02011-08-26 11:25:35 +0100148 int ret, blen;
Feng Tang22510992010-06-16 14:46:09 +0100149
Feng Tangee9b4502010-09-13 15:39:48 +0800150 blen = M3110_RX_FIFO_DEPTH * sizeof(u16);
151 buf = kzalloc(blen * 2, GFP_KERNEL | GFP_DMA);
152 if (!buf) {
153 pr_warning(PR_FMT "%s(): fail to alloc dma buffer\n", __func__);
Feng Tang22510992010-06-16 14:46:09 +0100154 return 0;
155 }
156
Feng Tangee9b4502010-09-13 15:39:48 +0800157 /* tx/rx always have the same length */
158 obuf = buf;
159 ibuf = buf + blen;
Feng Tang22510992010-06-16 14:46:09 +0100160
Feng Tangee9b4502010-09-13 15:39:48 +0800161 if (max3110_write_then_read(max, obuf, ibuf, blen, 1)) {
162 kfree(buf);
Feng Tang22510992010-06-16 14:46:09 +0100163 return 0;
Feng Tangee9b4502010-09-13 15:39:48 +0800164 }
Feng Tang22510992010-06-16 14:46:09 +0100165
Alexander Shishkin51808f02011-08-26 11:25:35 +0100166 ret = receive_chars(max, ibuf, M3110_RX_FIFO_DEPTH);
Feng Tang22510992010-06-16 14:46:09 +0100167
Feng Tangee9b4502010-09-13 15:39:48 +0800168 kfree(buf);
Alexander Shishkin51808f02011-08-26 11:25:35 +0100169 return ret;
Feng Tang22510992010-06-16 14:46:09 +0100170}
171
172static void serial_m3110_con_putchar(struct uart_port *port, int ch)
173{
174 struct uart_max3110 *max =
175 container_of(port, struct uart_max3110, port);
176 struct circ_buf *xmit = &max->con_xmit;
177
178 if (uart_circ_chars_free(xmit)) {
179 xmit->buf[xmit->head] = (char)ch;
180 xmit->head = (xmit->head + 1) & (PAGE_SIZE - 1);
181 }
Feng Tang22510992010-06-16 14:46:09 +0100182}
183
184/*
185 * Print a string to the serial port trying not to disturb
186 * any possible real use of the port...
187 *
188 * The console_lock must be held when we get here.
189 */
190static void serial_m3110_con_write(struct console *co,
191 const char *s, unsigned int count)
192{
193 if (!pmax)
194 return;
195
196 uart_console_write(&pmax->port, s, count, serial_m3110_con_putchar);
Feng Tangee9b4502010-09-13 15:39:48 +0800197
198 if (!test_and_set_bit(CON_TX_NEEDED, &pmax->uart_flags))
Dirk Brandewie7b18bd52011-08-26 11:24:49 +0100199 wake_up(&pmax->wq);
Feng Tang22510992010-06-16 14:46:09 +0100200}
201
202static int __init
203serial_m3110_con_setup(struct console *co, char *options)
204{
205 struct uart_max3110 *max = pmax;
206 int baud = 115200;
207 int bits = 8;
208 int parity = 'n';
209 int flow = 'n';
210
211 pr_info(PR_FMT "setting up console\n");
212
Feng Tangee9b4502010-09-13 15:39:48 +0800213 if (co->index == -1)
214 co->index = 0;
215
Feng Tang22510992010-06-16 14:46:09 +0100216 if (!max) {
217 pr_err(PR_FMT "pmax is NULL, return");
218 return -ENODEV;
219 }
220
221 if (options)
222 uart_parse_options(options, &baud, &parity, &bits, &flow);
223
224 return uart_set_options(&max->port, co, baud, parity, bits, flow);
225}
226
227static struct tty_driver *serial_m3110_con_device(struct console *co,
228 int *index)
229{
230 struct uart_driver *p = co->data;
231 *index = co->index;
232 return p->tty_driver;
233}
234
235static struct uart_driver serial_m3110_reg;
236static struct console serial_m3110_console = {
237 .name = "ttyS",
238 .write = serial_m3110_con_write,
239 .device = serial_m3110_con_device,
240 .setup = serial_m3110_con_setup,
241 .flags = CON_PRINTBUFFER,
242 .index = -1,
243 .data = &serial_m3110_reg,
244};
245
Feng Tang22510992010-06-16 14:46:09 +0100246static unsigned int serial_m3110_tx_empty(struct uart_port *port)
247{
248 return 1;
249}
250
251static void serial_m3110_stop_tx(struct uart_port *port)
252{
253 return;
254}
255
256/* stop_rx will be called in spin_lock env */
257static void serial_m3110_stop_rx(struct uart_port *port)
258{
259 return;
260}
261
262#define WORDS_PER_XFER 128
Feng Tangee9b4502010-09-13 15:39:48 +0800263static void send_circ_buf(struct uart_max3110 *max,
Feng Tang22510992010-06-16 14:46:09 +0100264 struct circ_buf *xmit)
265{
Feng Tangee9b4502010-09-13 15:39:48 +0800266 void *buf;
267 u16 *obuf, *ibuf;
Alexander Shishkin51808f02011-08-26 11:25:35 +0100268 int i, len, blen, dma_size, left, ret = 0;
Feng Tangee9b4502010-09-13 15:39:48 +0800269
270
271 dma_size = WORDS_PER_XFER * sizeof(u16) * 2;
272 buf = kzalloc(dma_size, GFP_KERNEL | GFP_DMA);
273 if (!buf)
274 return;
275 obuf = buf;
276 ibuf = buf + dma_size/2;
Feng Tang22510992010-06-16 14:46:09 +0100277
278 while (!uart_circ_empty(xmit)) {
279 left = uart_circ_chars_pending(xmit);
280 while (left) {
Feng Tangee9b4502010-09-13 15:39:48 +0800281 len = min(left, WORDS_PER_XFER);
282 blen = len * sizeof(u16);
283 memset(ibuf, 0, blen);
Feng Tang22510992010-06-16 14:46:09 +0100284
Feng Tang22510992010-06-16 14:46:09 +0100285 for (i = 0; i < len; i++) {
286 obuf[i] = (u8)xmit->buf[xmit->tail] | WD_TAG;
287 xmit->tail = (xmit->tail + 1) &
288 (UART_XMIT_SIZE - 1);
289 }
Feng Tangee9b4502010-09-13 15:39:48 +0800290
291 /* Fail to send msg to console is not very critical */
Dirk Brandewie7b18bd52011-08-26 11:24:49 +0100292
Feng Tangee9b4502010-09-13 15:39:48 +0800293 ret = max3110_write_then_read(max, obuf, ibuf, blen, 0);
294 if (ret)
295 pr_warning(PR_FMT "%s(): get err msg %d\n",
296 __func__, ret);
Feng Tang22510992010-06-16 14:46:09 +0100297
Alexander Shishkin51808f02011-08-26 11:25:35 +0100298 receive_chars(max, ibuf, len);
Feng Tang22510992010-06-16 14:46:09 +0100299
300 max->port.icount.tx += len;
301 left -= len;
302 }
303 }
Feng Tangee9b4502010-09-13 15:39:48 +0800304
305 kfree(buf);
Feng Tang22510992010-06-16 14:46:09 +0100306}
307
308static void transmit_char(struct uart_max3110 *max)
309{
310 struct uart_port *port = &max->port;
311 struct circ_buf *xmit = &port->state->xmit;
312
313 if (uart_circ_empty(xmit) || uart_tx_stopped(port))
314 return;
315
316 send_circ_buf(max, xmit);
317
318 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
319 uart_write_wakeup(port);
320
321 if (uart_circ_empty(xmit))
322 serial_m3110_stop_tx(port);
323}
324
Feng Tangee9b4502010-09-13 15:39:48 +0800325/*
326 * This will be called by uart_write() and tty_write, can't
327 * go to sleep
328 */
Feng Tang22510992010-06-16 14:46:09 +0100329static void serial_m3110_start_tx(struct uart_port *port)
330{
331 struct uart_max3110 *max =
332 container_of(port, struct uart_max3110, port);
333
Arjan van de Vend6e679b2010-06-17 11:02:15 +0100334 if (!test_and_set_bit(UART_TX_NEEDED, &max->uart_flags))
Dirk Brandewie7b18bd52011-08-26 11:24:49 +0100335 wake_up(&max->wq);
Feng Tang22510992010-06-16 14:46:09 +0100336}
337
Alexander Shishkin51808f02011-08-26 11:25:35 +0100338static int
339receive_chars(struct uart_max3110 *max, unsigned short *str, int len)
Feng Tang22510992010-06-16 14:46:09 +0100340{
341 struct uart_port *port = &max->port;
Jiri Slaby227434f2013-01-03 15:53:01 +0100342 struct tty_port *tport;
Alexander Shishkin51808f02011-08-26 11:25:35 +0100343 char buf[M3110_RX_FIFO_DEPTH];
344 int r, w, usable;
Feng Tang22510992010-06-16 14:46:09 +0100345
346 /* If uart is not opened, just return */
347 if (!port->state)
Alexander Shishkin51808f02011-08-26 11:25:35 +0100348 return 0;
Feng Tang22510992010-06-16 14:46:09 +0100349
Jiri Slaby227434f2013-01-03 15:53:01 +0100350 tport = &port->state->port;
Feng Tang22510992010-06-16 14:46:09 +0100351
Alexander Shishkin51808f02011-08-26 11:25:35 +0100352 for (r = 0, w = 0; r < len; r++) {
353 if (str[r] & MAX3110_BREAK &&
354 uart_handle_break(port))
355 continue;
356
357 if (str[r] & MAX3110_READ_DATA_AVAILABLE) {
358 if (uart_handle_sysrq_char(port, str[r] & 0xff))
359 continue;
360
361 buf[w++] = str[r] & 0xff;
362 }
363 }
364
Jiri Slaby2e124b42013-01-03 15:53:06 +0100365 if (!w)
Alexander Shishkin51808f02011-08-26 11:25:35 +0100366 return 0;
367
368 for (r = 0; w; r += usable, w -= usable) {
Jiri Slaby227434f2013-01-03 15:53:01 +0100369 usable = tty_buffer_request_room(tport, w);
Feng Tang22510992010-06-16 14:46:09 +0100370 if (usable) {
Jiri Slaby05c7cd32013-01-03 15:53:04 +0100371 tty_insert_flip_string(tport, buf + r, usable);
Feng Tang22510992010-06-16 14:46:09 +0100372 port->icount.rx += usable;
Feng Tang22510992010-06-16 14:46:09 +0100373 }
Feng Tang22510992010-06-16 14:46:09 +0100374 }
Jiri Slaby2e124b42013-01-03 15:53:06 +0100375 tty_flip_buffer_push(tport);
Alexander Shishkin51808f02011-08-26 11:25:35 +0100376
377 return r;
Feng Tang22510992010-06-16 14:46:09 +0100378}
379
Feng Tangee9b4502010-09-13 15:39:48 +0800380/*
381 * This routine will be used in read_thread or RX IRQ handling,
382 * it will first do one round buffer read(8 words), if there is some
383 * valid RX data, will try to read 5 more rounds till all data
384 * is read out.
385 *
386 * Use stack space as data buffer to save some system load, and chose
387 * 504 Btyes as a threadhold to do a bulk push to upper tty layer when
388 * receiving bulk data, a much bigger buffer may cause stack overflow
389 */
390static void max3110_con_receive(struct uart_max3110 *max)
Feng Tang22510992010-06-16 14:46:09 +0100391{
Alexander Shishkin51808f02011-08-26 11:25:35 +0100392 int loop = 1, num;
Feng Tang22510992010-06-16 14:46:09 +0100393
Feng Tang22510992010-06-16 14:46:09 +0100394 do {
Alexander Shishkin51808f02011-08-26 11:25:35 +0100395 num = max3110_read_multi(max);
Feng Tang22510992010-06-16 14:46:09 +0100396
397 if (num) {
Feng Tangee9b4502010-09-13 15:39:48 +0800398 loop = 5;
Feng Tang22510992010-06-16 14:46:09 +0100399 }
400 } while (--loop);
Feng Tang22510992010-06-16 14:46:09 +0100401}
402
403static int max3110_main_thread(void *_max)
404{
405 struct uart_max3110 *max = _max;
406 wait_queue_head_t *wq = &max->wq;
407 int ret = 0;
408 struct circ_buf *xmit = &max->con_xmit;
409
Feng Tang22510992010-06-16 14:46:09 +0100410 pr_info(PR_FMT "start main thread\n");
411
412 do {
Dirk Brandewie7b18bd52011-08-26 11:24:49 +0100413 wait_event_interruptible(*wq,
414 max->uart_flags || kthread_should_stop());
Arjan van de Ven68c16b42010-06-17 11:02:06 +0100415
416 mutex_lock(&max->thread_mutex);
Feng Tang22510992010-06-16 14:46:09 +0100417
Arjan van de Vend6e679b2010-06-17 11:02:15 +0100418 if (test_and_clear_bit(BIT_IRQ_PENDING, &max->uart_flags))
Feng Tangee9b4502010-09-13 15:39:48 +0800419 max3110_con_receive(max);
Feng Tang22510992010-06-16 14:46:09 +0100420
421 /* first handle console output */
Arjan van de Vend6e679b2010-06-17 11:02:15 +0100422 if (test_and_clear_bit(CON_TX_NEEDED, &max->uart_flags))
Feng Tang22510992010-06-16 14:46:09 +0100423 send_circ_buf(max, xmit);
Feng Tang22510992010-06-16 14:46:09 +0100424
425 /* handle uart output */
Arjan van de Vend6e679b2010-06-17 11:02:15 +0100426 if (test_and_clear_bit(UART_TX_NEEDED, &max->uart_flags))
Feng Tang22510992010-06-16 14:46:09 +0100427 transmit_char(max);
Arjan van de Vend6e679b2010-06-17 11:02:15 +0100428
Arjan van de Ven68c16b42010-06-17 11:02:06 +0100429 mutex_unlock(&max->thread_mutex);
Arjan van de Vend6e679b2010-06-17 11:02:15 +0100430
Feng Tang22510992010-06-16 14:46:09 +0100431 } while (!kthread_should_stop());
432
433 return ret;
434}
435
Feng Tang22510992010-06-16 14:46:09 +0100436static irqreturn_t serial_m3110_irq(int irq, void *dev_id)
437{
438 struct uart_max3110 *max = dev_id;
439
440 /* max3110's irq is a falling edge, not level triggered,
441 * so no need to disable the irq */
Dirk Brandewie7b18bd52011-08-26 11:24:49 +0100442
Arjan van de Vend6e679b2010-06-17 11:02:15 +0100443 if (!test_and_set_bit(BIT_IRQ_PENDING, &max->uart_flags))
Dirk Brandewie7b18bd52011-08-26 11:24:49 +0100444 wake_up(&max->wq);
Arjan van de Vend6e679b2010-06-17 11:02:15 +0100445
Feng Tang22510992010-06-16 14:46:09 +0100446 return IRQ_HANDLED;
447}
Alan Cox91efa752010-09-13 15:39:56 +0800448
Feng Tang22510992010-06-16 14:46:09 +0100449/* if don't use RX IRQ, then need a thread to polling read */
450static int max3110_read_thread(void *_max)
451{
452 struct uart_max3110 *max = _max;
453
454 pr_info(PR_FMT "start read thread\n");
455 do {
Feng Tangee9b4502010-09-13 15:39:48 +0800456 /*
457 * If can't acquire the mutex, it means the main thread
458 * is running which will also perform the rx job
459 */
460 if (mutex_trylock(&max->thread_mutex)) {
461 max3110_con_receive(max);
462 mutex_unlock(&max->thread_mutex);
463 }
Feng Tang22510992010-06-16 14:46:09 +0100464
465 set_current_state(TASK_INTERRUPTIBLE);
466 schedule_timeout(HZ / 20);
467 } while (!kthread_should_stop());
468
469 return 0;
470}
Feng Tang22510992010-06-16 14:46:09 +0100471
472static int serial_m3110_startup(struct uart_port *port)
473{
474 struct uart_max3110 *max =
475 container_of(port, struct uart_max3110, port);
476 u16 config = 0;
477 int ret = 0;
478
Feng Tangee9b4502010-09-13 15:39:48 +0800479 if (port->line != 0) {
Feng Tang22510992010-06-16 14:46:09 +0100480 pr_err(PR_FMT "uart port startup failed\n");
Feng Tangee9b4502010-09-13 15:39:48 +0800481 return -1;
482 }
Feng Tang22510992010-06-16 14:46:09 +0100483
Feng Tangee9b4502010-09-13 15:39:48 +0800484 /* Disable all IRQ and config it to 115200, 8n1 */
Feng Tang22510992010-06-16 14:46:09 +0100485 config = WC_TAG | WC_FIFO_ENABLE
486 | WC_1_STOPBITS
487 | WC_8BIT_WORD
488 | WC_BAUD_DR2;
Feng Tang22510992010-06-16 14:46:09 +0100489
490 /* as we use thread to handle tx/rx, need set low latency */
Jiri Slabyd6c53c02013-01-03 15:53:05 +0100491 port->state->port.low_latency = 1;
Feng Tang22510992010-06-16 14:46:09 +0100492
Alan Cox91efa752010-09-13 15:39:56 +0800493 if (max->irq) {
Feng Tangee9b4502010-09-13 15:39:48 +0800494 max->read_thread = NULL;
Alan Cox91efa752010-09-13 15:39:56 +0800495 ret = request_irq(max->irq, serial_m3110_irq,
496 IRQ_TYPE_EDGE_FALLING, "max3110", max);
497 if (ret) {
498 max->irq = 0;
499 pr_err(PR_FMT "unable to allocate IRQ, polling\n");
500 } else {
501 /* Enable RX IRQ only */
502 config |= WC_RXA_IRQ_ENABLE;
503 }
Feng Tangee9b4502010-09-13 15:39:48 +0800504 }
Alan Cox91efa752010-09-13 15:39:56 +0800505
506 if (max->irq == 0) {
507 /* If IRQ is disabled, start a read thread for input data */
508 max->read_thread =
509 kthread_run(max3110_read_thread, max, "max3110_read");
510 if (IS_ERR(max->read_thread)) {
511 ret = PTR_ERR(max->read_thread);
512 max->read_thread = NULL;
513 pr_err(PR_FMT "Can't create read thread!\n");
514 return ret;
515 }
516 }
Feng Tang22510992010-06-16 14:46:09 +0100517
Feng Tangee9b4502010-09-13 15:39:48 +0800518 ret = max3110_out(max, config);
519 if (ret) {
Alan Cox91efa752010-09-13 15:39:56 +0800520 if (max->irq)
521 free_irq(max->irq, max);
522 if (max->read_thread)
523 kthread_stop(max->read_thread);
Feng Tangee9b4502010-09-13 15:39:48 +0800524 max->read_thread = NULL;
Feng Tangee9b4502010-09-13 15:39:48 +0800525 return ret;
526 }
527
Feng Tang22510992010-06-16 14:46:09 +0100528 max->cur_conf = config;
529 return 0;
530}
531
532static void serial_m3110_shutdown(struct uart_port *port)
533{
534 struct uart_max3110 *max =
535 container_of(port, struct uart_max3110, port);
536 u16 config;
537
538 if (max->read_thread) {
539 kthread_stop(max->read_thread);
540 max->read_thread = NULL;
541 }
542
Alan Cox91efa752010-09-13 15:39:56 +0800543 if (max->irq)
544 free_irq(max->irq, max);
Feng Tang22510992010-06-16 14:46:09 +0100545
546 /* Disable interrupts from this port */
547 config = WC_TAG | WC_SW_SHDI;
548 max3110_out(max, config);
549}
550
551static void serial_m3110_release_port(struct uart_port *port)
552{
553}
554
555static int serial_m3110_request_port(struct uart_port *port)
556{
557 return 0;
558}
559
560static void serial_m3110_config_port(struct uart_port *port, int flags)
561{
Feng Tangee9b4502010-09-13 15:39:48 +0800562 port->type = PORT_MAX3100;
Feng Tang22510992010-06-16 14:46:09 +0100563}
564
565static int
566serial_m3110_verify_port(struct uart_port *port, struct serial_struct *ser)
567{
568 /* we don't want the core code to modify any port params */
569 return -EINVAL;
570}
571
572
573static const char *serial_m3110_type(struct uart_port *port)
574{
575 struct uart_max3110 *max =
576 container_of(port, struct uart_max3110, port);
577 return max->name;
578}
579
580static void
581serial_m3110_set_termios(struct uart_port *port, struct ktermios *termios,
582 struct ktermios *old)
583{
584 struct uart_max3110 *max =
585 container_of(port, struct uart_max3110, port);
586 unsigned char cval;
587 unsigned int baud, parity = 0;
588 int clk_div = -1;
589 u16 new_conf = max->cur_conf;
590
591 switch (termios->c_cflag & CSIZE) {
592 case CS7:
593 cval = UART_LCR_WLEN7;
594 new_conf |= WC_7BIT_WORD;
595 break;
596 default:
Feng Tangee9b4502010-09-13 15:39:48 +0800597 /* We only support CS7 & CS8 */
598 termios->c_cflag &= ~CSIZE;
599 termios->c_cflag |= CS8;
Feng Tang22510992010-06-16 14:46:09 +0100600 case CS8:
601 cval = UART_LCR_WLEN8;
602 new_conf |= WC_8BIT_WORD;
603 break;
604 }
605
606 baud = uart_get_baud_rate(port, termios, old, 0, 230400);
607
Feng Tangee9b4502010-09-13 15:39:48 +0800608 /* First calc the div for 1.8MHZ clock case */
Feng Tang22510992010-06-16 14:46:09 +0100609 switch (baud) {
610 case 300:
611 clk_div = WC_BAUD_DR384;
612 break;
613 case 600:
614 clk_div = WC_BAUD_DR192;
615 break;
616 case 1200:
617 clk_div = WC_BAUD_DR96;
618 break;
619 case 2400:
620 clk_div = WC_BAUD_DR48;
621 break;
622 case 4800:
623 clk_div = WC_BAUD_DR24;
624 break;
625 case 9600:
626 clk_div = WC_BAUD_DR12;
627 break;
628 case 19200:
629 clk_div = WC_BAUD_DR6;
630 break;
631 case 38400:
632 clk_div = WC_BAUD_DR3;
633 break;
634 case 57600:
635 clk_div = WC_BAUD_DR2;
636 break;
637 case 115200:
638 clk_div = WC_BAUD_DR1;
639 break;
640 case 230400:
641 if (max->clock & MAX3110_HIGH_CLK)
642 break;
643 default:
Feng Tangee9b4502010-09-13 15:39:48 +0800644 /* Pick the previous baud rate */
Feng Tang22510992010-06-16 14:46:09 +0100645 baud = max->baud;
646 clk_div = max->cur_conf & WC_BAUD_DIV_MASK;
647 tty_termios_encode_baud_rate(termios, baud, baud);
648 }
649
650 if (max->clock & MAX3110_HIGH_CLK) {
651 clk_div += 1;
Feng Tangee9b4502010-09-13 15:39:48 +0800652 /* High clk version max3110 doesn't support B300 */
653 if (baud == 300) {
Feng Tang22510992010-06-16 14:46:09 +0100654 baud = 600;
Feng Tangee9b4502010-09-13 15:39:48 +0800655 clk_div = WC_BAUD_DR384;
656 }
Feng Tang22510992010-06-16 14:46:09 +0100657 if (baud == 230400)
658 clk_div = WC_BAUD_DR1;
659 tty_termios_encode_baud_rate(termios, baud, baud);
660 }
661
662 new_conf = (new_conf & ~WC_BAUD_DIV_MASK) | clk_div;
Feng Tangee9b4502010-09-13 15:39:48 +0800663
664 if (unlikely(termios->c_cflag & CMSPAR))
665 termios->c_cflag &= ~CMSPAR;
666
Feng Tang22510992010-06-16 14:46:09 +0100667 if (termios->c_cflag & CSTOPB)
668 new_conf |= WC_2_STOPBITS;
669 else
670 new_conf &= ~WC_2_STOPBITS;
671
672 if (termios->c_cflag & PARENB) {
673 new_conf |= WC_PARITY_ENABLE;
674 parity |= UART_LCR_PARITY;
675 } else
676 new_conf &= ~WC_PARITY_ENABLE;
677
678 if (!(termios->c_cflag & PARODD))
679 parity |= UART_LCR_EPAR;
680 max->parity = parity;
681
682 uart_update_timeout(port, termios->c_cflag, baud);
683
684 new_conf |= WC_TAG;
685 if (new_conf != max->cur_conf) {
Feng Tangee9b4502010-09-13 15:39:48 +0800686 if (!max3110_out(max, new_conf)) {
687 max->cur_conf = new_conf;
688 max->baud = baud;
689 }
Feng Tang22510992010-06-16 14:46:09 +0100690 }
691}
692
Feng Tangee9b4502010-09-13 15:39:48 +0800693/* Don't handle hw handshaking */
Feng Tang22510992010-06-16 14:46:09 +0100694static unsigned int serial_m3110_get_mctrl(struct uart_port *port)
695{
696 return TIOCM_DSR | TIOCM_CAR | TIOCM_DSR;
697}
698
699static void serial_m3110_set_mctrl(struct uart_port *port, unsigned int mctrl)
700{
701}
702
703static void serial_m3110_break_ctl(struct uart_port *port, int break_state)
704{
705}
706
707static void serial_m3110_pm(struct uart_port *port, unsigned int state,
708 unsigned int oldstate)
709{
710}
711
712static void serial_m3110_enable_ms(struct uart_port *port)
713{
714}
715
716struct uart_ops serial_m3110_ops = {
717 .tx_empty = serial_m3110_tx_empty,
718 .set_mctrl = serial_m3110_set_mctrl,
719 .get_mctrl = serial_m3110_get_mctrl,
720 .stop_tx = serial_m3110_stop_tx,
721 .start_tx = serial_m3110_start_tx,
722 .stop_rx = serial_m3110_stop_rx,
723 .enable_ms = serial_m3110_enable_ms,
724 .break_ctl = serial_m3110_break_ctl,
725 .startup = serial_m3110_startup,
726 .shutdown = serial_m3110_shutdown,
Feng Tangee9b4502010-09-13 15:39:48 +0800727 .set_termios = serial_m3110_set_termios,
Feng Tang22510992010-06-16 14:46:09 +0100728 .pm = serial_m3110_pm,
729 .type = serial_m3110_type,
730 .release_port = serial_m3110_release_port,
731 .request_port = serial_m3110_request_port,
732 .config_port = serial_m3110_config_port,
733 .verify_port = serial_m3110_verify_port,
734};
735
736static struct uart_driver serial_m3110_reg = {
737 .owner = THIS_MODULE,
738 .driver_name = "MRST serial",
739 .dev_name = "ttyS",
740 .major = TTY_MAJOR,
741 .minor = 64,
742 .nr = 1,
Feng Tangee9b4502010-09-13 15:39:48 +0800743 .cons = &serial_m3110_console,
Feng Tang22510992010-06-16 14:46:09 +0100744};
745
Feng Tangee9b4502010-09-13 15:39:48 +0800746#ifdef CONFIG_PM
Feng Tang22510992010-06-16 14:46:09 +0100747static int serial_m3110_suspend(struct spi_device *spi, pm_message_t state)
748{
Feng Tangee9b4502010-09-13 15:39:48 +0800749 struct uart_max3110 *max = spi_get_drvdata(spi);
750
751 disable_irq(max->irq);
752 uart_suspend_port(&serial_m3110_reg, &max->port);
753 max3110_out(max, max->cur_conf | WC_SW_SHDI);
Feng Tang22510992010-06-16 14:46:09 +0100754 return 0;
755}
756
757static int serial_m3110_resume(struct spi_device *spi)
758{
Feng Tangee9b4502010-09-13 15:39:48 +0800759 struct uart_max3110 *max = spi_get_drvdata(spi);
760
761 max3110_out(max, max->cur_conf);
762 uart_resume_port(&serial_m3110_reg, &max->port);
763 enable_irq(max->irq);
Feng Tang22510992010-06-16 14:46:09 +0100764 return 0;
765}
Feng Tangee9b4502010-09-13 15:39:48 +0800766#else
767#define serial_m3110_suspend NULL
768#define serial_m3110_resume NULL
769#endif
Feng Tang22510992010-06-16 14:46:09 +0100770
Bill Pemberton9671f092012-11-19 13:21:50 -0500771static int serial_m3110_probe(struct spi_device *spi)
Feng Tang22510992010-06-16 14:46:09 +0100772{
773 struct uart_max3110 *max;
Feng Tangee9b4502010-09-13 15:39:48 +0800774 void *buffer;
jianwei.yang99dd3f62010-06-16 14:46:49 +0100775 u16 res;
Feng Tangee9b4502010-09-13 15:39:48 +0800776 int ret = 0;
777
Feng Tang22510992010-06-16 14:46:09 +0100778 max = kzalloc(sizeof(*max), GFP_KERNEL);
779 if (!max)
780 return -ENOMEM;
781
Feng Tangee9b4502010-09-13 15:39:48 +0800782 /* Set spi info */
Feng Tang22510992010-06-16 14:46:09 +0100783 spi->bits_per_word = 16;
784 max->clock = MAX3110_HIGH_CLK;
Feng Tang22510992010-06-16 14:46:09 +0100785
786 spi_setup(spi);
787
Feng Tangee9b4502010-09-13 15:39:48 +0800788 max->port.type = PORT_MAX3100;
789 max->port.fifosize = 2; /* Only have 16b buffer */
Feng Tang22510992010-06-16 14:46:09 +0100790 max->port.ops = &serial_m3110_ops;
791 max->port.line = 0;
792 max->port.dev = &spi->dev;
793 max->port.uartclk = 115200;
794
795 max->spi = spi;
Feng Tangee9b4502010-09-13 15:39:48 +0800796 strcpy(max->name, spi->modalias);
Feng Tang22510992010-06-16 14:46:09 +0100797 max->irq = (u16)spi->irq;
798
Arjan van de Ven68c16b42010-06-17 11:02:06 +0100799 mutex_init(&max->thread_mutex);
Feng Tang22510992010-06-16 14:46:09 +0100800
801 max->word_7bits = 0;
802 max->parity = 0;
803 max->baud = 0;
804
805 max->cur_conf = 0;
Arjan van de Vend6e679b2010-06-17 11:02:15 +0100806 max->uart_flags = 0;
807
jianwei.yang99dd3f62010-06-16 14:46:49 +0100808 /* Check if reading configuration register returns something sane */
Feng Tang22510992010-06-16 14:46:09 +0100809
jianwei.yang99dd3f62010-06-16 14:46:49 +0100810 res = RC_TAG;
811 ret = max3110_write_then_read(max, (u8 *)&res, (u8 *)&res, 2, 0);
812 if (ret < 0 || res == 0 || res == 0xffff) {
William Douglas0bb04bf2011-06-23 13:38:36 +0100813 dev_dbg(&spi->dev, "MAX3111 deemed not present (conf reg %04x)",
jianwei.yang99dd3f62010-06-16 14:46:49 +0100814 res);
815 ret = -ENODEV;
816 goto err_get_page;
817 }
Feng Tangee9b4502010-09-13 15:39:48 +0800818
819 buffer = (void *)__get_free_page(GFP_KERNEL);
Feng Tang22510992010-06-16 14:46:09 +0100820 if (!buffer) {
821 ret = -ENOMEM;
822 goto err_get_page;
823 }
Feng Tangee9b4502010-09-13 15:39:48 +0800824 max->con_xmit.buf = buffer;
825 max->con_xmit.head = 0;
826 max->con_xmit.tail = 0;
Feng Tang22510992010-06-16 14:46:09 +0100827
Mika Westerberg33b1e692011-06-23 13:39:00 +0100828 init_waitqueue_head(&max->wq);
829
Feng Tang22510992010-06-16 14:46:09 +0100830 max->main_thread = kthread_run(max3110_main_thread,
831 max, "max3110_main");
832 if (IS_ERR(max->main_thread)) {
833 ret = PTR_ERR(max->main_thread);
834 goto err_kthread;
835 }
836
Feng Tangee9b4502010-09-13 15:39:48 +0800837 spi_set_drvdata(spi, max);
Feng Tang22510992010-06-16 14:46:09 +0100838 pmax = max;
Feng Tangee9b4502010-09-13 15:39:48 +0800839
840 /* Give membase a psudo value to pass serial_core's check */
Feng Tang22510992010-06-16 14:46:09 +0100841 max->port.membase = (void *)0xff110000;
842 uart_add_one_port(&serial_m3110_reg, &max->port);
843
844 return 0;
845
846err_kthread:
847 free_page((unsigned long)buffer);
848err_get_page:
Feng Tang22510992010-06-16 14:46:09 +0100849 kfree(max);
850 return ret;
851}
852
Bill Pembertonae8d8a12012-11-19 13:26:18 -0500853static int serial_m3110_remove(struct spi_device *dev)
Feng Tang22510992010-06-16 14:46:09 +0100854{
Feng Tangee9b4502010-09-13 15:39:48 +0800855 struct uart_max3110 *max = spi_get_drvdata(dev);
Feng Tang22510992010-06-16 14:46:09 +0100856
Feng Tangee9b4502010-09-13 15:39:48 +0800857 if (!max)
Feng Tang22510992010-06-16 14:46:09 +0100858 return 0;
859
Feng Tang22510992010-06-16 14:46:09 +0100860 uart_remove_one_port(&serial_m3110_reg, &max->port);
861
862 free_page((unsigned long)max->con_xmit.buf);
863
864 if (max->main_thread)
865 kthread_stop(max->main_thread);
866
867 kfree(max);
868 return 0;
869}
870
871static struct spi_driver uart_max3110_driver = {
872 .driver = {
873 .name = "spi_max3111",
Feng Tang22510992010-06-16 14:46:09 +0100874 .owner = THIS_MODULE,
875 },
876 .probe = serial_m3110_probe,
Bill Pemberton2d47b712012-11-19 13:21:34 -0500877 .remove = serial_m3110_remove,
Feng Tang22510992010-06-16 14:46:09 +0100878 .suspend = serial_m3110_suspend,
879 .resume = serial_m3110_resume,
880};
881
Feng Tangee9b4502010-09-13 15:39:48 +0800882static int __init serial_m3110_init(void)
Feng Tang22510992010-06-16 14:46:09 +0100883{
884 int ret = 0;
885
886 ret = uart_register_driver(&serial_m3110_reg);
887 if (ret)
888 return ret;
889
890 ret = spi_register_driver(&uart_max3110_driver);
891 if (ret)
892 uart_unregister_driver(&serial_m3110_reg);
893
894 return ret;
895}
896
Feng Tangee9b4502010-09-13 15:39:48 +0800897static void __exit serial_m3110_exit(void)
Feng Tang22510992010-06-16 14:46:09 +0100898{
899 spi_unregister_driver(&uart_max3110_driver);
900 uart_unregister_driver(&serial_m3110_reg);
901}
902
903module_init(serial_m3110_init);
904module_exit(serial_m3110_exit);
905
Feng Tangee9b4502010-09-13 15:39:48 +0800906MODULE_LICENSE("GPL v2");
Axel Lin8c4074c2011-08-01 21:20:10 +0800907MODULE_ALIAS("spi:max3110-uart");