1 /* sunhv.c: Serial driver for SUN4V hypervisor console.
3 * Copyright (C) 2006, 2007 David S. Miller (davem@davemloft.net)
6 #include <linux/kernel.h>
7 #include <linux/errno.h>
9 #include <linux/tty_flip.h>
10 #include <linux/major.h>
11 #include <linux/circ_buf.h>
12 #include <linux/serial.h>
13 #include <linux/sysrq.h>
14 #include <linux/console.h>
15 #include <linux/spinlock.h>
16 #include <linux/slab.h>
17 #include <linux/delay.h>
18 #include <linux/init.h>
19 #include <linux/of_device.h>
21 #include <asm/hypervisor.h>
22 #include <asm/spitfire.h>
25 #include <asm/setup.h>
27 #if defined(CONFIG_MAGIC_SYSRQ)
31 #include <linux/serial_core.h>
32 #include <linux/sunserialcore.h>
34 #define CON_BREAK ((long)-1)
35 #define CON_HUP ((long)-2)
37 #define IGNORE_BREAK 0x1
38 #define IGNORE_ALL 0x2
40 static char *con_write_page
;
41 static char *con_read_page
;
43 static int hung_up
= 0;
45 static void transmit_chars_putchar(struct uart_port
*port
, struct circ_buf
*xmit
)
47 while (!uart_circ_empty(xmit
)) {
48 long status
= sun4v_con_putchar(xmit
->buf
[xmit
->tail
]);
53 xmit
->tail
= (xmit
->tail
+ 1) & (UART_XMIT_SIZE
- 1);
58 static void transmit_chars_write(struct uart_port
*port
, struct circ_buf
*xmit
)
60 while (!uart_circ_empty(xmit
)) {
61 unsigned long ra
= __pa(xmit
->buf
+ xmit
->tail
);
62 unsigned long len
, status
, sent
;
64 len
= CIRC_CNT_TO_END(xmit
->head
, xmit
->tail
,
66 status
= sun4v_con_write(ra
, len
, &sent
);
69 xmit
->tail
= (xmit
->tail
+ sent
) & (UART_XMIT_SIZE
- 1);
70 port
->icount
.tx
+= sent
;
74 static int receive_chars_getchar(struct uart_port
*port
)
76 int saw_console_brk
= 0;
81 long c
= sun4v_con_getchar(&status
);
83 if (status
== HV_EWOULDBLOCK
)
87 if (uart_handle_break(port
))
95 uart_handle_dcd_change(port
, 0);
98 uart_handle_dcd_change(port
, 1);
101 if (port
->state
== NULL
) {
102 uart_handle_sysrq_char(port
, c
);
108 if (uart_handle_sysrq_char(port
, c
))
111 tty_insert_flip_char(&port
->state
->port
, c
, TTY_NORMAL
);
114 return saw_console_brk
;
117 static int receive_chars_read(struct uart_port
*port
)
119 int saw_console_brk
= 0;
122 while (limit
-- > 0) {
123 unsigned long ra
= __pa(con_read_page
);
124 unsigned long bytes_read
, i
;
125 long stat
= sun4v_con_read(ra
, PAGE_SIZE
, &bytes_read
);
127 if (stat
!= HV_EOK
) {
130 if (stat
== CON_BREAK
) {
131 if (uart_handle_break(port
))
136 } else if (stat
== CON_HUP
) {
138 uart_handle_dcd_change(port
, 0);
141 /* HV_EWOULDBLOCK, etc. */
148 uart_handle_dcd_change(port
, 1);
151 if (port
->sysrq
!= 0 && *con_read_page
) {
152 for (i
= 0; i
< bytes_read
; i
++)
153 uart_handle_sysrq_char(port
, con_read_page
[i
]);
156 if (port
->state
== NULL
)
159 port
->icount
.rx
+= bytes_read
;
161 tty_insert_flip_string(&port
->state
->port
, con_read_page
,
165 return saw_console_brk
;
169 void (*transmit_chars
)(struct uart_port
*port
, struct circ_buf
*xmit
);
170 int (*receive_chars
)(struct uart_port
*port
);
173 static const struct sunhv_ops bychar_ops
= {
174 .transmit_chars
= transmit_chars_putchar
,
175 .receive_chars
= receive_chars_getchar
,
178 static const struct sunhv_ops bywrite_ops
= {
179 .transmit_chars
= transmit_chars_write
,
180 .receive_chars
= receive_chars_read
,
183 static const struct sunhv_ops
*sunhv_ops
= &bychar_ops
;
185 static struct tty_port
*receive_chars(struct uart_port
*port
)
187 struct tty_port
*tport
= NULL
;
189 if (port
->state
!= NULL
) /* Unopened serial console */
190 tport
= &port
->state
->port
;
192 if (sunhv_ops
->receive_chars(port
))
198 static void transmit_chars(struct uart_port
*port
)
200 struct circ_buf
*xmit
;
205 xmit
= &port
->state
->xmit
;
206 if (uart_circ_empty(xmit
) || uart_tx_stopped(port
))
209 sunhv_ops
->transmit_chars(port
, xmit
);
211 if (uart_circ_chars_pending(xmit
) < WAKEUP_CHARS
)
212 uart_write_wakeup(port
);
215 static irqreturn_t
sunhv_interrupt(int irq
, void *dev_id
)
217 struct uart_port
*port
= dev_id
;
218 struct tty_port
*tport
;
221 spin_lock_irqsave(&port
->lock
, flags
);
222 tport
= receive_chars(port
);
223 transmit_chars(port
);
224 spin_unlock_irqrestore(&port
->lock
, flags
);
227 tty_flip_buffer_push(tport
);
232 /* port->lock is not held. */
233 static unsigned int sunhv_tx_empty(struct uart_port
*port
)
235 /* Transmitter is always empty for us. If the circ buffer
236 * is non-empty or there is an x_char pending, our caller
237 * will do the right thing and ignore what we return here.
242 /* port->lock held by caller. */
243 static void sunhv_set_mctrl(struct uart_port
*port
, unsigned int mctrl
)
248 /* port->lock is held by caller and interrupts are disabled. */
249 static unsigned int sunhv_get_mctrl(struct uart_port
*port
)
251 return TIOCM_DSR
| TIOCM_CAR
| TIOCM_CTS
;
254 /* port->lock held by caller. */
255 static void sunhv_stop_tx(struct uart_port
*port
)
260 /* port->lock held by caller. */
261 static void sunhv_start_tx(struct uart_port
*port
)
263 transmit_chars(port
);
266 /* port->lock is not held. */
267 static void sunhv_send_xchar(struct uart_port
*port
, char ch
)
272 if (ch
== __DISABLED_CHAR
)
275 spin_lock_irqsave(&port
->lock
, flags
);
277 while (limit
-- > 0) {
278 long status
= sun4v_con_putchar(ch
);
279 if (status
== HV_EOK
)
284 spin_unlock_irqrestore(&port
->lock
, flags
);
287 /* port->lock held by caller. */
288 static void sunhv_stop_rx(struct uart_port
*port
)
292 /* port->lock is not held. */
293 static void sunhv_break_ctl(struct uart_port
*port
, int break_state
)
299 spin_lock_irqsave(&port
->lock
, flags
);
301 while (limit
-- > 0) {
302 long status
= sun4v_con_putchar(CON_BREAK
);
303 if (status
== HV_EOK
)
308 spin_unlock_irqrestore(&port
->lock
, flags
);
312 /* port->lock is not held. */
313 static int sunhv_startup(struct uart_port
*port
)
318 /* port->lock is not held. */
319 static void sunhv_shutdown(struct uart_port
*port
)
323 /* port->lock is not held. */
324 static void sunhv_set_termios(struct uart_port
*port
, struct ktermios
*termios
,
325 struct ktermios
*old
)
327 unsigned int baud
= uart_get_baud_rate(port
, termios
, old
, 0, 4000000);
328 unsigned int quot
= uart_get_divisor(port
, baud
);
329 unsigned int iflag
, cflag
;
332 spin_lock_irqsave(&port
->lock
, flags
);
334 iflag
= termios
->c_iflag
;
335 cflag
= termios
->c_cflag
;
337 port
->ignore_status_mask
= 0;
339 port
->ignore_status_mask
|= IGNORE_BREAK
;
340 if ((cflag
& CREAD
) == 0)
341 port
->ignore_status_mask
|= IGNORE_ALL
;
344 uart_update_timeout(port
, cflag
,
345 (port
->uartclk
/ (16 * quot
)));
347 spin_unlock_irqrestore(&port
->lock
, flags
);
350 static const char *sunhv_type(struct uart_port
*port
)
352 return "SUN4V HCONS";
355 static void sunhv_release_port(struct uart_port
*port
)
359 static int sunhv_request_port(struct uart_port
*port
)
364 static void sunhv_config_port(struct uart_port
*port
, int flags
)
368 static int sunhv_verify_port(struct uart_port
*port
, struct serial_struct
*ser
)
373 static struct uart_ops sunhv_pops
= {
374 .tx_empty
= sunhv_tx_empty
,
375 .set_mctrl
= sunhv_set_mctrl
,
376 .get_mctrl
= sunhv_get_mctrl
,
377 .stop_tx
= sunhv_stop_tx
,
378 .start_tx
= sunhv_start_tx
,
379 .send_xchar
= sunhv_send_xchar
,
380 .stop_rx
= sunhv_stop_rx
,
381 .break_ctl
= sunhv_break_ctl
,
382 .startup
= sunhv_startup
,
383 .shutdown
= sunhv_shutdown
,
384 .set_termios
= sunhv_set_termios
,
386 .release_port
= sunhv_release_port
,
387 .request_port
= sunhv_request_port
,
388 .config_port
= sunhv_config_port
,
389 .verify_port
= sunhv_verify_port
,
392 static struct uart_driver sunhv_reg
= {
393 .owner
= THIS_MODULE
,
394 .driver_name
= "sunhv",
399 static struct uart_port
*sunhv_port
;
401 /* Copy 's' into the con_write_page, decoding "\n" into
402 * "\r\n" along the way. We have to return two lengths
403 * because the caller needs to know how much to advance
404 * 's' and also how many bytes to output via con_write_page.
406 static int fill_con_write_page(const char *s
, unsigned int n
,
407 unsigned long *page_bytes
)
409 const char *orig_s
= s
;
410 char *p
= con_write_page
;
411 int left
= PAGE_SIZE
;
424 *page_bytes
= p
- con_write_page
;
428 static void sunhv_console_write_paged(struct console
*con
, const char *s
, unsigned n
)
430 struct uart_port
*port
= sunhv_port
;
434 if (port
->sysrq
|| oops_in_progress
)
435 locked
= spin_trylock_irqsave(&port
->lock
, flags
);
437 spin_lock_irqsave(&port
->lock
, flags
);
440 unsigned long ra
= __pa(con_write_page
);
441 unsigned long page_bytes
;
442 unsigned int cpy
= fill_con_write_page(s
, n
,
447 while (page_bytes
> 0) {
448 unsigned long written
;
454 stat
= sun4v_con_write(ra
, page_bytes
,
462 page_bytes
-= written
;
468 spin_unlock_irqrestore(&port
->lock
, flags
);
471 static inline void sunhv_console_putchar(struct uart_port
*port
, char c
)
475 while (limit
-- > 0) {
476 long status
= sun4v_con_putchar(c
);
477 if (status
== HV_EOK
)
483 static void sunhv_console_write_bychar(struct console
*con
, const char *s
, unsigned n
)
485 struct uart_port
*port
= sunhv_port
;
489 if (port
->sysrq
|| oops_in_progress
)
490 locked
= spin_trylock_irqsave(&port
->lock
, flags
);
492 spin_lock_irqsave(&port
->lock
, flags
);
494 for (i
= 0; i
< n
; i
++) {
496 sunhv_console_putchar(port
, '\r');
497 sunhv_console_putchar(port
, *s
++);
501 spin_unlock_irqrestore(&port
->lock
, flags
);
504 static struct console sunhv_console
= {
506 .write
= sunhv_console_write_bychar
,
507 .device
= uart_console_device
,
508 .flags
= CON_PRINTBUFFER
,
513 static int hv_probe(struct platform_device
*op
)
515 struct uart_port
*port
;
519 if (op
->archdata
.irqs
[0] == 0xffffffff)
522 port
= kzalloc(sizeof(struct uart_port
), GFP_KERNEL
);
527 if (sun4v_hvapi_register(HV_GRP_CORE
, 1, &minor
) == 0 &&
530 con_write_page
= kzalloc(PAGE_SIZE
, GFP_KERNEL
);
534 con_read_page
= kzalloc(PAGE_SIZE
, GFP_KERNEL
);
536 goto out_free_con_write_page
;
538 sunhv_console
.write
= sunhv_console_write_paged
;
539 sunhv_ops
= &bywrite_ops
;
545 port
->ops
= &sunhv_pops
;
546 port
->type
= PORT_SUNHV
;
547 port
->uartclk
= ( 29491200 / 16 ); /* arbitrary */
549 port
->membase
= (unsigned char __iomem
*) __pa(port
);
551 port
->irq
= op
->archdata
.irqs
[0];
553 port
->dev
= &op
->dev
;
555 err
= sunserial_register_minors(&sunhv_reg
, 1);
557 goto out_free_con_read_page
;
559 sunserial_console_match(&sunhv_console
, op
->dev
.of_node
,
560 &sunhv_reg
, port
->line
, false);
562 err
= uart_add_one_port(&sunhv_reg
, port
);
564 goto out_unregister_driver
;
566 err
= request_irq(port
->irq
, sunhv_interrupt
, 0, "hvcons", port
);
568 goto out_remove_port
;
570 platform_set_drvdata(op
, port
);
575 uart_remove_one_port(&sunhv_reg
, port
);
577 out_unregister_driver
:
578 sunserial_unregister_minors(&sunhv_reg
, 1);
580 out_free_con_read_page
:
581 kfree(con_read_page
);
583 out_free_con_write_page
:
584 kfree(con_write_page
);
592 static int hv_remove(struct platform_device
*dev
)
594 struct uart_port
*port
= platform_get_drvdata(dev
);
596 free_irq(port
->irq
, port
);
598 uart_remove_one_port(&sunhv_reg
, port
);
600 sunserial_unregister_minors(&sunhv_reg
, 1);
601 kfree(con_read_page
);
602 kfree(con_write_page
);
609 static const struct of_device_id hv_match
[] = {
616 .compatible
= "SUNW,sun4v-console",
621 static struct platform_driver hv_driver
= {
624 .of_match_table
= hv_match
,
630 static int __init
sunhv_init(void)
632 if (tlb_type
!= hypervisor
)
635 return platform_driver_register(&hv_driver
);
637 device_initcall(sunhv_init
);
639 #if 0 /* ...def MODULE ; never supported as such */
640 MODULE_AUTHOR("David S. Miller");
641 MODULE_DESCRIPTION("SUN4V Hypervisor console driver");
642 MODULE_VERSION("2.0");
643 MODULE_LICENSE("GPL");