2 * File: linux/drivers/serial/bfin_sport_uart.c
4 * Based on: drivers/serial/bfin_5xx.c by Aubrey Li.
5 * Author: Roy Huang <roy.huang@analog.com>
7 * Created: Nov 22, 2006
8 * Copyright: (c) 2006-2007 Analog Devices Inc.
9 * Description: this driver enable SPORTs on Blackfin emulate UART.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, see the file COPYING, or write
23 * to the Free Software Foundation, Inc.,
24 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
28 * This driver and the hardware supported are in term of EE-191 of ADI.
29 * http://www.analog.com/UploadedFiles/Application_Notes/399447663EE191.pdf
30 * This application note describe how to implement a UART on a Sharc DSP,
31 * but this driver is implemented on Blackfin Processor.
34 /* After reset, there is a prelude of low level pulse when transmit data first
35 * time. No addtional pulse in following transmit.
36 * According to document:
37 * The SPORTs are ready to start transmitting or receiving data no later than
38 * three serial clock cycles after they are enabled in the SPORTx_TCR1 or
39 * SPORTx_RCR1 register. No serial clock cycles are lost from this point on.
40 * The first internal frame sync will occur one frame sync delay after the
41 * SPORTs are ready. External frame syncs can occur as soon as the SPORT is
45 /* Thanks to Axel Alatalo <axel@rubico.se> for fixing sport rx bug. Sometimes
46 * sport receives data incorrectly. The following is Axel's words.
47 * As EE-191, sport rx samples 3 times of the UART baudrate and takes the
48 * middle smaple of every 3 samples as the data bit. For a 8-N-1 UART setting,
49 * 30 samples will be required for a byte. If transmitter sends a 1/3 bit short
50 * byte due to buadrate drift, then the 30th sample of a byte, this sample is
51 * also the third sample of the stop bit, will happens on the immediately
52 * following start bit which will be thrown away and missed. Thus since parts
53 * of the startbit will be missed and the receiver will begin to drift, the
54 * effect accumulates over time until synchronization is lost.
55 * If only require 2 samples of the stopbit (by sampling in total 29 samples),
56 * then a to short byte as in the case above will be tolerated. Then the 1/3
57 * early startbit will trigger a framesync since the last read is complete
58 * after only 2/3 stopbit and framesync is active during the last 1/3 looking
59 * for a possible early startbit. */
63 #include <linux/module.h>
64 #include <linux/ioport.h>
65 #include <linux/init.h>
66 #include <linux/console.h>
67 #include <linux/sysrq.h>
68 #include <linux/platform_device.h>
69 #include <linux/tty.h>
70 #include <linux/tty_flip.h>
71 #include <linux/serial_core.h>
73 #include <asm/delay.h>
74 #include <asm/portmux.h>
76 #include "bfin_sport_uart.h"
78 unsigned short bfin_uart_pin_req_sport0
[] =
79 {P_SPORT0_TFS
, P_SPORT0_DTPRI
, P_SPORT0_TSCLK
, P_SPORT0_RFS
, \
80 P_SPORT0_DRPRI
, P_SPORT0_RSCLK
, P_SPORT0_DRSEC
, P_SPORT0_DTSEC
, 0};
82 unsigned short bfin_uart_pin_req_sport1
[] =
83 {P_SPORT1_TFS
, P_SPORT1_DTPRI
, P_SPORT1_TSCLK
, P_SPORT1_RFS
, \
84 P_SPORT1_DRPRI
, P_SPORT1_RSCLK
, P_SPORT1_DRSEC
, P_SPORT1_DTSEC
, 0};
86 #define DRV_NAME "bfin-sport-uart"
88 struct sport_uart_port
{
89 struct uart_port port
;
97 static void sport_uart_tx_chars(struct sport_uart_port
*up
);
98 static void sport_stop_tx(struct uart_port
*port
);
100 static inline void tx_one_byte(struct sport_uart_port
*up
, unsigned int value
)
102 pr_debug("%s value:%x\n", __func__
, value
);
103 /* Place a Start and Stop bit */
104 __asm__
__volatile__ (
105 "R2 = b#01111111100;"
106 "R3 = b#10000000001;"
112 : "ASTAT", "R2", "R3"
114 pr_debug("%s value:%x\n", __func__
, value
);
116 SPORT_PUT_TX(up
, value
);
119 static inline unsigned int rx_one_byte(struct sport_uart_port
*up
)
121 unsigned int value
, extract
;
122 u32 tmp_mask1
, tmp_mask2
, tmp_shift
, tmp
;
124 value
= SPORT_GET_RX32(up
);
125 pr_debug("%s value:%x\n", __func__
, value
);
127 /* Extract 8 bits data */
128 __asm__
__volatile__ (
130 "%[mask1] = 0x1801(Z);"
131 "%[mask2] = 0x0300(Z);"
133 "LSETUP(.Lloop_s, .Lloop_e) LC0 = %[lc];"
135 "%[tmp] = extract(%[val], %[mask1].L)(Z);"
136 "%[tmp] <<= %[shift];"
137 "%[extr] = %[extr] | %[tmp];"
138 "%[mask1] = %[mask1] - %[mask2];"
141 : [val
]"=d"(value
), [extr
]"=d"(extract
), [shift
]"=d"(tmp_shift
), [tmp
]"=d"(tmp
),
142 [mask1
]"=d"(tmp_mask1
), [mask2
]"=d"(tmp_mask2
)
143 : "d"(value
), [lc
]"a"(8)
144 : "ASTAT", "LB0", "LC0", "LT0"
147 pr_debug(" extract:%x\n", extract
);
151 static int sport_uart_setup(struct sport_uart_port
*up
, int sclk
, int baud_rate
)
153 int tclkdiv
, tfsdiv
, rclkdiv
;
155 /* Set TCR1 and TCR2 */
156 SPORT_PUT_TCR1(up
, (LATFS
| ITFS
| TFSR
| TLSBIT
| ITCLK
));
157 SPORT_PUT_TCR2(up
, 10);
158 pr_debug("%s TCR1:%x, TCR2:%x\n", __func__
, SPORT_GET_TCR1(up
), SPORT_GET_TCR2(up
));
160 /* Set RCR1 and RCR2 */
161 SPORT_PUT_RCR1(up
, (RCKFE
| LARFS
| LRFS
| RFSR
| IRCLK
));
162 SPORT_PUT_RCR2(up
, 28);
163 pr_debug("%s RCR1:%x, RCR2:%x\n", __func__
, SPORT_GET_RCR1(up
), SPORT_GET_RCR2(up
));
165 tclkdiv
= sclk
/(2 * baud_rate
) - 1;
167 rclkdiv
= sclk
/(2 * baud_rate
* 3) - 1;
168 SPORT_PUT_TCLKDIV(up
, tclkdiv
);
169 SPORT_PUT_TFSDIV(up
, tfsdiv
);
170 SPORT_PUT_RCLKDIV(up
, rclkdiv
);
172 pr_debug("%s sclk:%d, baud_rate:%d, tclkdiv:%d, tfsdiv:%d, rclkdiv:%d\n",
173 __func__
, sclk
, baud_rate
, tclkdiv
, tfsdiv
, rclkdiv
);
178 static irqreturn_t
sport_uart_rx_irq(int irq
, void *dev_id
)
180 struct sport_uart_port
*up
= dev_id
;
181 struct tty_struct
*tty
= up
->port
.info
->port
.tty
;
185 ch
= rx_one_byte(up
);
186 up
->port
.icount
.rx
++;
188 if (uart_handle_sysrq_char(&up
->port
, ch
))
191 tty_insert_flip_char(tty
, ch
, TTY_NORMAL
);
192 } while (SPORT_GET_STAT(up
) & RXNE
);
193 tty_flip_buffer_push(tty
);
198 static irqreturn_t
sport_uart_tx_irq(int irq
, void *dev_id
)
200 sport_uart_tx_chars(dev_id
);
205 static irqreturn_t
sport_uart_err_irq(int irq
, void *dev_id
)
207 struct sport_uart_port
*up
= dev_id
;
208 struct tty_struct
*tty
= up
->port
.info
->port
.tty
;
209 unsigned int stat
= SPORT_GET_STAT(up
);
211 /* Overflow in RX FIFO */
213 up
->port
.icount
.overrun
++;
214 tty_insert_flip_char(tty
, 0, TTY_OVERRUN
);
215 SPORT_PUT_STAT(up
, ROVF
); /* Clear ROVF bit */
217 /* These should not happen */
218 if (stat
& (TOVF
| TUVF
| RUVF
)) {
219 printk(KERN_ERR
"SPORT Error:%s %s %s\n",
220 (stat
& TOVF
)?"TX overflow":"",
221 (stat
& TUVF
)?"TX underflow":"",
222 (stat
& RUVF
)?"RX underflow":"");
223 SPORT_PUT_TCR1(up
, SPORT_GET_TCR1(up
) & ~TSPEN
);
224 SPORT_PUT_RCR1(up
, SPORT_GET_RCR1(up
) & ~RSPEN
);
231 /* Reqeust IRQ, Setup clock */
232 static int sport_startup(struct uart_port
*port
)
234 struct sport_uart_port
*up
= (struct sport_uart_port
*)port
;
238 pr_debug("%s enter\n", __func__
);
239 snprintf(buffer
, 20, "%s rx", up
->name
);
240 retval
= request_irq(up
->rx_irq
, sport_uart_rx_irq
, IRQF_SAMPLE_RANDOM
, buffer
, up
);
242 printk(KERN_ERR
"Unable to request interrupt %s\n", buffer
);
246 snprintf(buffer
, 20, "%s tx", up
->name
);
247 retval
= request_irq(up
->tx_irq
, sport_uart_tx_irq
, IRQF_SAMPLE_RANDOM
, buffer
, up
);
249 printk(KERN_ERR
"Unable to request interrupt %s\n", buffer
);
253 snprintf(buffer
, 20, "%s err", up
->name
);
254 retval
= request_irq(up
->err_irq
, sport_uart_err_irq
, IRQF_SAMPLE_RANDOM
, buffer
, up
);
256 printk(KERN_ERR
"Unable to request interrupt %s\n", buffer
);
261 if (peripheral_request_list(bfin_uart_pin_req_sport1
, DRV_NAME
))
264 if (peripheral_request_list(bfin_uart_pin_req_sport0
, DRV_NAME
))
268 sport_uart_setup(up
, get_sclk(), port
->uartclk
);
270 /* Enable receive interrupt */
271 SPORT_PUT_RCR1(up
, (SPORT_GET_RCR1(up
) | RSPEN
));
278 printk(KERN_ERR DRV_NAME
279 ": Requesting Peripherals failed\n");
281 free_irq(up
->err_irq
, up
);
283 free_irq(up
->tx_irq
, up
);
285 free_irq(up
->rx_irq
, up
);
291 static void sport_uart_tx_chars(struct sport_uart_port
*up
)
293 struct circ_buf
*xmit
= &up
->port
.info
->xmit
;
295 if (SPORT_GET_STAT(up
) & TXF
)
298 if (up
->port
.x_char
) {
299 tx_one_byte(up
, up
->port
.x_char
);
300 up
->port
.icount
.tx
++;
305 if (uart_circ_empty(xmit
) || uart_tx_stopped(&up
->port
)) {
306 sport_stop_tx(&up
->port
);
310 while(!(SPORT_GET_STAT(up
) & TXF
) && !uart_circ_empty(xmit
)) {
311 tx_one_byte(up
, xmit
->buf
[xmit
->tail
]);
312 xmit
->tail
= (xmit
->tail
+ 1) & (UART_XMIT_SIZE
-1);
313 up
->port
.icount
.tx
++;
316 if (uart_circ_chars_pending(xmit
) < WAKEUP_CHARS
)
317 uart_write_wakeup(&up
->port
);
320 static unsigned int sport_tx_empty(struct uart_port
*port
)
322 struct sport_uart_port
*up
= (struct sport_uart_port
*)port
;
325 stat
= SPORT_GET_STAT(up
);
326 pr_debug("%s stat:%04x\n", __func__
, stat
);
333 static unsigned int sport_get_mctrl(struct uart_port
*port
)
335 pr_debug("%s enter\n", __func__
);
336 return (TIOCM_CTS
| TIOCM_CD
| TIOCM_DSR
);
339 static void sport_set_mctrl(struct uart_port
*port
, unsigned int mctrl
)
341 pr_debug("%s enter\n", __func__
);
344 static void sport_stop_tx(struct uart_port
*port
)
346 struct sport_uart_port
*up
= (struct sport_uart_port
*)port
;
349 pr_debug("%s enter\n", __func__
);
351 stat
= SPORT_GET_STAT(up
);
352 while(!(stat
& TXHRE
)) {
354 stat
= SPORT_GET_STAT(up
);
356 /* Although the hold register is empty, last byte is still in shift
357 * register and not sent out yet. If baud rate is lower than default,
358 * delay should be longer. For example, if the baud rate is 9600,
359 * the delay must be at least 2ms by experience */
362 SPORT_PUT_TCR1(up
, (SPORT_GET_TCR1(up
) & ~TSPEN
));
368 static void sport_start_tx(struct uart_port
*port
)
370 struct sport_uart_port
*up
= (struct sport_uart_port
*)port
;
372 pr_debug("%s enter\n", __func__
);
373 /* Write data into SPORT FIFO before enable SPROT to transmit */
374 sport_uart_tx_chars(up
);
376 /* Enable transmit, then an interrupt will generated */
377 SPORT_PUT_TCR1(up
, (SPORT_GET_TCR1(up
) | TSPEN
));
379 pr_debug("%s exit\n", __func__
);
382 static void sport_stop_rx(struct uart_port
*port
)
384 struct sport_uart_port
*up
= (struct sport_uart_port
*)port
;
386 pr_debug("%s enter\n", __func__
);
387 /* Disable sport to stop rx */
388 SPORT_PUT_RCR1(up
, (SPORT_GET_RCR1(up
) & ~RSPEN
));
392 static void sport_enable_ms(struct uart_port
*port
)
394 pr_debug("%s enter\n", __func__
);
397 static void sport_break_ctl(struct uart_port
*port
, int break_state
)
399 pr_debug("%s enter\n", __func__
);
402 static void sport_shutdown(struct uart_port
*port
)
404 struct sport_uart_port
*up
= (struct sport_uart_port
*)port
;
406 pr_debug("%s enter\n", __func__
);
409 SPORT_PUT_TCR1(up
, (SPORT_GET_TCR1(up
) & ~TSPEN
));
410 SPORT_PUT_RCR1(up
, (SPORT_GET_RCR1(up
) & ~RSPEN
));
414 peripheral_free_list(bfin_uart_pin_req_sport1
);
416 peripheral_free_list(bfin_uart_pin_req_sport0
);
419 free_irq(up
->rx_irq
, up
);
420 free_irq(up
->tx_irq
, up
);
421 free_irq(up
->err_irq
, up
);
424 static void sport_set_termios(struct uart_port
*port
,
425 struct ktermios
*termios
, struct ktermios
*old
)
427 pr_debug("%s enter, c_cflag:%08x\n", __func__
, termios
->c_cflag
);
428 uart_update_timeout(port
, CS8
,port
->uartclk
);
431 static const char *sport_type(struct uart_port
*port
)
433 struct sport_uart_port
*up
= (struct sport_uart_port
*)port
;
435 pr_debug("%s enter\n", __func__
);
439 static void sport_release_port(struct uart_port
*port
)
441 pr_debug("%s enter\n", __func__
);
444 static int sport_request_port(struct uart_port
*port
)
446 pr_debug("%s enter\n", __func__
);
450 static void sport_config_port(struct uart_port
*port
, int flags
)
452 struct sport_uart_port
*up
= (struct sport_uart_port
*)port
;
454 pr_debug("%s enter\n", __func__
);
455 up
->port
.type
= PORT_BFIN_SPORT
;
458 static int sport_verify_port(struct uart_port
*port
, struct serial_struct
*ser
)
460 pr_debug("%s enter\n", __func__
);
464 struct uart_ops sport_uart_ops
= {
465 .tx_empty
= sport_tx_empty
,
466 .set_mctrl
= sport_set_mctrl
,
467 .get_mctrl
= sport_get_mctrl
,
468 .stop_tx
= sport_stop_tx
,
469 .start_tx
= sport_start_tx
,
470 .stop_rx
= sport_stop_rx
,
471 .enable_ms
= sport_enable_ms
,
472 .break_ctl
= sport_break_ctl
,
473 .startup
= sport_startup
,
474 .shutdown
= sport_shutdown
,
475 .set_termios
= sport_set_termios
,
477 .release_port
= sport_release_port
,
478 .request_port
= sport_request_port
,
479 .config_port
= sport_config_port
,
480 .verify_port
= sport_verify_port
,
483 static struct sport_uart_port sport_uart_ports
[] = {
486 .tx_irq
= IRQ_SPORT0_TX
,
487 .rx_irq
= IRQ_SPORT0_RX
,
488 .err_irq
= IRQ_SPORT0_ERROR
,
490 .type
= PORT_BFIN_SPORT
,
492 .membase
= (void __iomem
*)SPORT0_TCR1
,
493 .mapbase
= SPORT0_TCR1
,
494 .irq
= IRQ_SPORT0_RX
,
495 .uartclk
= CONFIG_SPORT_BAUD_RATE
,
497 .ops
= &sport_uart_ops
,
502 .tx_irq
= IRQ_SPORT1_TX
,
503 .rx_irq
= IRQ_SPORT1_RX
,
504 .err_irq
= IRQ_SPORT1_ERROR
,
506 .type
= PORT_BFIN_SPORT
,
508 .membase
= (void __iomem
*)SPORT1_TCR1
,
509 .mapbase
= SPORT1_TCR1
,
510 .irq
= IRQ_SPORT1_RX
,
511 .uartclk
= CONFIG_SPORT_BAUD_RATE
,
513 .ops
= &sport_uart_ops
,
519 static struct uart_driver sport_uart_reg
= {
520 .owner
= THIS_MODULE
,
521 .driver_name
= "SPORT-UART",
525 .nr
= ARRAY_SIZE(sport_uart_ports
),
529 static int sport_uart_suspend(struct platform_device
*dev
, pm_message_t state
)
531 struct sport_uart_port
*sport
= platform_get_drvdata(dev
);
533 pr_debug("%s enter\n", __func__
);
535 uart_suspend_port(&sport_uart_reg
, &sport
->port
);
540 static int sport_uart_resume(struct platform_device
*dev
)
542 struct sport_uart_port
*sport
= platform_get_drvdata(dev
);
544 pr_debug("%s enter\n", __func__
);
546 uart_resume_port(&sport_uart_reg
, &sport
->port
);
551 static int sport_uart_probe(struct platform_device
*dev
)
553 pr_debug("%s enter\n", __func__
);
554 sport_uart_ports
[dev
->id
].port
.dev
= &dev
->dev
;
555 uart_add_one_port(&sport_uart_reg
, &sport_uart_ports
[dev
->id
].port
);
556 platform_set_drvdata(dev
, &sport_uart_ports
[dev
->id
]);
561 static int sport_uart_remove(struct platform_device
*dev
)
563 struct sport_uart_port
*sport
= platform_get_drvdata(dev
);
565 pr_debug("%s enter\n", __func__
);
566 platform_set_drvdata(dev
, NULL
);
569 uart_remove_one_port(&sport_uart_reg
, &sport
->port
);
574 static struct platform_driver sport_uart_driver
= {
575 .probe
= sport_uart_probe
,
576 .remove
= sport_uart_remove
,
577 .suspend
= sport_uart_suspend
,
578 .resume
= sport_uart_resume
,
584 static int __init
sport_uart_init(void)
588 pr_debug("%s enter\n", __func__
);
589 ret
= uart_register_driver(&sport_uart_reg
);
591 printk(KERN_ERR
"Failed to register %s:%d\n",
592 sport_uart_reg
.driver_name
, ret
);
596 ret
= platform_driver_register(&sport_uart_driver
);
598 printk(KERN_ERR
"Failed to register sport uart driver:%d\n", ret
);
599 uart_unregister_driver(&sport_uart_reg
);
603 pr_debug("%s exit\n", __func__
);
607 static void __exit
sport_uart_exit(void)
609 pr_debug("%s enter\n", __func__
);
610 platform_driver_unregister(&sport_uart_driver
);
611 uart_unregister_driver(&sport_uart_reg
);
614 module_init(sport_uart_init
);
615 module_exit(sport_uart_exit
);
617 MODULE_LICENSE("GPL");