xref: /rk3399_ARM-atf/plat/nvidia/tegra/drivers/spe/shared_console.S (revision e2469d823bfc633a32782a8c018d3b55eb2b23a1)
1*e2469d82SVarun Wadekar/*
2*e2469d82SVarun Wadekar * Copyright (c) 2017-2019, ARM Limited and Contributors. All rights reserved.
3*e2469d82SVarun Wadekar * Copyright (c) 2020, NVIDIA Corporation. All rights reserved.
4*e2469d82SVarun Wadekar *
5*e2469d82SVarun Wadekar * SPDX-License-Identifier: BSD-3-Clause
6*e2469d82SVarun Wadekar */
7*e2469d82SVarun Wadekar#include <asm_macros.S>
8*e2469d82SVarun Wadekar#include <console_macros.S>
9*e2469d82SVarun Wadekar
10*e2469d82SVarun Wadekar#define CONSOLE_NUM_BYTES_SHIFT		24
11*e2469d82SVarun Wadekar#define CONSOLE_FLUSH_DATA_TO_PORT	(1 << 26)
12*e2469d82SVarun Wadekar#define CONSOLE_RING_DOORBELL		(1 << 31)
13*e2469d82SVarun Wadekar#define CONSOLE_IS_BUSY			(1 << 31)
14*e2469d82SVarun Wadekar#define CONSOLE_TIMEOUT			0xC000		/* approx. 50 ms */
15*e2469d82SVarun Wadekar#define CONSOLE_WRITE			(CONSOLE_RING_DOORBELL | CONSOLE_FLUSH_DATA_TO_PORT)
16*e2469d82SVarun Wadekar
17*e2469d82SVarun Wadekar	/*
18*e2469d82SVarun Wadekar	 * This file contains a driver implementation to make use of the
19*e2469d82SVarun Wadekar	 * real console implementation provided by the SPE firmware running
20*e2469d82SVarun Wadekar	 * SoCs after Tegra186.
21*e2469d82SVarun Wadekar	 *
22*e2469d82SVarun Wadekar	 * This console is shared by multiple components and the SPE firmware
23*e2469d82SVarun Wadekar	 * finally displays everything on the UART port.
24*e2469d82SVarun Wadekar	 */
25*e2469d82SVarun Wadekar
26*e2469d82SVarun Wadekar	.globl	console_spe_core_init
27*e2469d82SVarun Wadekar	.globl	console_spe_core_putc
28*e2469d82SVarun Wadekar	.globl	console_spe_core_getc
29*e2469d82SVarun Wadekar	.globl	console_spe_core_flush
30*e2469d82SVarun Wadekar	.globl	console_spe_putc
31*e2469d82SVarun Wadekar	.globl	console_spe_getc
32*e2469d82SVarun Wadekar	.globl	console_spe_flush
33*e2469d82SVarun Wadekar	.globl	console_spe_register
34*e2469d82SVarun Wadekar
35*e2469d82SVarun Wadekar.macro	check_if_console_is_ready base, tmp1, tmp2, label
36*e2469d82SVarun Wadekar	/* wait until spe is ready or timeout expires */
37*e2469d82SVarun Wadekar	mrs	\tmp2, cntps_tval_el1
38*e2469d82SVarun Wadekar1:	ldr	\tmp1, [\base]
39*e2469d82SVarun Wadekar	and	\tmp1, \tmp1, #CONSOLE_IS_BUSY
40*e2469d82SVarun Wadekar	cbz	\tmp1, 2f
41*e2469d82SVarun Wadekar	mrs	\tmp1, cntps_tval_el1
42*e2469d82SVarun Wadekar	sub	\tmp1, \tmp2, \tmp1
43*e2469d82SVarun Wadekar	cmp	\tmp1, #CONSOLE_TIMEOUT
44*e2469d82SVarun Wadekar	b.lt	1b
45*e2469d82SVarun Wadekar	b	\label
46*e2469d82SVarun Wadekar2:
47*e2469d82SVarun Wadekar.endm
48*e2469d82SVarun Wadekar
49*e2469d82SVarun Wadekar	/* -------------------------------------------------
50*e2469d82SVarun Wadekar	 * int console_spe_register(uintptr_t baseaddr,
51*e2469d82SVarun Wadekar	 *     uint32_t clock, uint32_t baud,
52*e2469d82SVarun Wadekar	 *     console_t *console);
53*e2469d82SVarun Wadekar	 * Function to initialize and register a new spe
54*e2469d82SVarun Wadekar	 * console. Storage passed in for the console struct
55*e2469d82SVarun Wadekar	 * *must* be persistent (i.e. not from the stack).
56*e2469d82SVarun Wadekar	 * In: x0 - UART register base address
57*e2469d82SVarun Wadekar	 *     w1 - UART clock in Hz
58*e2469d82SVarun Wadekar	 *     w2 - Baud rate
59*e2469d82SVarun Wadekar	 *     x3 - pointer to empty console_t struct
60*e2469d82SVarun Wadekar	 * Out: return 1 on success, 0 on error
61*e2469d82SVarun Wadekar	 * Clobber list : x0, x1, x2, x6, x7, x14
62*e2469d82SVarun Wadekar	 * -------------------------------------------------
63*e2469d82SVarun Wadekar	 */
64*e2469d82SVarun Wadekarfunc console_spe_register
65*e2469d82SVarun Wadekar	/* Check the input base address */
66*e2469d82SVarun Wadekar	cbz	x0, register_fail
67*e2469d82SVarun Wadekar
68*e2469d82SVarun Wadekar	/* Dont use clock or baud rate, so ok to overwrite them */
69*e2469d82SVarun Wadekar	check_if_console_is_ready x0, x1, x2, register_fail
70*e2469d82SVarun Wadekar
71*e2469d82SVarun Wadekar	cbz	x3, register_fail
72*e2469d82SVarun Wadekar	str	x0, [x3, #CONSOLE_T_BASE]
73*e2469d82SVarun Wadekar	mov	x0, x3
74*e2469d82SVarun Wadekar	finish_console_register spe putc=1, getc=1, flush=1
75*e2469d82SVarun Wadekar
76*e2469d82SVarun Wadekarregister_fail:
77*e2469d82SVarun Wadekar	mov	w0, wzr
78*e2469d82SVarun Wadekar	ret
79*e2469d82SVarun Wadekarendfunc console_spe_register
80*e2469d82SVarun Wadekar
81*e2469d82SVarun Wadekar	/* --------------------------------------------------------
82*e2469d82SVarun Wadekar	 * int console_spe_core_putc(int c, uintptr_t base_addr)
83*e2469d82SVarun Wadekar	 * Function to output a character over the console. It
84*e2469d82SVarun Wadekar	 * returns the character printed on success or -1 on error.
85*e2469d82SVarun Wadekar	 * In : w0 - character to be printed
86*e2469d82SVarun Wadekar	 *      x1 - console base address
87*e2469d82SVarun Wadekar	 * Out : return -1 on error else return character.
88*e2469d82SVarun Wadekar	 * Clobber list : x2, x3
89*e2469d82SVarun Wadekar	 * --------------------------------------------------------
90*e2469d82SVarun Wadekar	 */
91*e2469d82SVarun Wadekarfunc console_spe_core_putc
92*e2469d82SVarun Wadekar	/* Check the input parameter */
93*e2469d82SVarun Wadekar	cbz	x1, putc_error
94*e2469d82SVarun Wadekar
95*e2469d82SVarun Wadekar	/* Prepend '\r' to '\n' */
96*e2469d82SVarun Wadekar	cmp	w0, #0xA
97*e2469d82SVarun Wadekar	b.ne	not_eol
98*e2469d82SVarun Wadekar
99*e2469d82SVarun Wadekar	check_if_console_is_ready x1, x2, x3, putc_error
100*e2469d82SVarun Wadekar
101*e2469d82SVarun Wadekar	/* spe is ready */
102*e2469d82SVarun Wadekar	mov	w2, #0xD		/* '\r' */
103*e2469d82SVarun Wadekar	and	w2, w2, #0xFF
104*e2469d82SVarun Wadekar	mov	w3, #(CONSOLE_WRITE | (1 << CONSOLE_NUM_BYTES_SHIFT))
105*e2469d82SVarun Wadekar	orr	w2, w2, w3
106*e2469d82SVarun Wadekar	str	w2, [x1]
107*e2469d82SVarun Wadekar
108*e2469d82SVarun Wadekarnot_eol:
109*e2469d82SVarun Wadekar	check_if_console_is_ready x1, x2, x3, putc_error
110*e2469d82SVarun Wadekar
111*e2469d82SVarun Wadekar	/* spe is ready */
112*e2469d82SVarun Wadekar	mov	w2, w0
113*e2469d82SVarun Wadekar	and	w2, w2, #0xFF
114*e2469d82SVarun Wadekar	mov	w3, #(CONSOLE_WRITE | (1 << CONSOLE_NUM_BYTES_SHIFT))
115*e2469d82SVarun Wadekar	orr	w2, w2, w3
116*e2469d82SVarun Wadekar	str	w2, [x1]
117*e2469d82SVarun Wadekar
118*e2469d82SVarun Wadekar	ret
119*e2469d82SVarun Wadekarputc_error:
120*e2469d82SVarun Wadekar	mov	w0, #-1
121*e2469d82SVarun Wadekar	ret
122*e2469d82SVarun Wadekarendfunc console_spe_core_putc
123*e2469d82SVarun Wadekar
124*e2469d82SVarun Wadekar	/* --------------------------------------------------------
125*e2469d82SVarun Wadekar	 * int console_spe_putc(int c, console_t *console)
126*e2469d82SVarun Wadekar	 * Function to output a character over the console. It
127*e2469d82SVarun Wadekar	 * returns the character printed on success or -1 on error.
128*e2469d82SVarun Wadekar	 * In : w0 - character to be printed
129*e2469d82SVarun Wadekar	 *      x1 - pointer to console_t structure
130*e2469d82SVarun Wadekar	 * Out : return -1 on error else return character.
131*e2469d82SVarun Wadekar	 * Clobber list : x2
132*e2469d82SVarun Wadekar	 * --------------------------------------------------------
133*e2469d82SVarun Wadekar	 */
134*e2469d82SVarun Wadekarfunc console_spe_putc
135*e2469d82SVarun Wadekar	ldr	x1, [x1, #CONSOLE_T_BASE]
136*e2469d82SVarun Wadekar	b	console_spe_core_putc
137*e2469d82SVarun Wadekarendfunc console_spe_putc
138*e2469d82SVarun Wadekar
139*e2469d82SVarun Wadekar	/* ---------------------------------------------
140*e2469d82SVarun Wadekar	 * int console_spe_getc(console_t *console)
141*e2469d82SVarun Wadekar	 * Function to get a character from the console.
142*e2469d82SVarun Wadekar	 * It returns the character grabbed on success
143*e2469d82SVarun Wadekar	 * or -1 if no character is available.
144*e2469d82SVarun Wadekar	 * In : x0 - pointer to console_t structure
145*e2469d82SVarun Wadekar	 * Out: w0 - character if available, else -1
146*e2469d82SVarun Wadekar	 * Clobber list : x0, x1
147*e2469d82SVarun Wadekar	 * ---------------------------------------------
148*e2469d82SVarun Wadekar	 */
149*e2469d82SVarun Wadekarfunc console_spe_getc
150*e2469d82SVarun Wadekar	mov	w0, #-1
151*e2469d82SVarun Wadekar	ret
152*e2469d82SVarun Wadekarendfunc console_spe_getc
153*e2469d82SVarun Wadekar
154*e2469d82SVarun Wadekar	/* -------------------------------------------------
155*e2469d82SVarun Wadekar	 * int console_spe_core_flush(uintptr_t base_addr)
156*e2469d82SVarun Wadekar	 * Function to force a write of all buffered
157*e2469d82SVarun Wadekar	 * data that hasn't been output.
158*e2469d82SVarun Wadekar	 * In : x0 - console base address
159*e2469d82SVarun Wadekar	 * Out : return -1 on error else return 0.
160*e2469d82SVarun Wadekar	 * Clobber list : x0, x1
161*e2469d82SVarun Wadekar	 * -------------------------------------------------
162*e2469d82SVarun Wadekar	 */
163*e2469d82SVarun Wadekarfunc console_spe_core_flush
164*e2469d82SVarun Wadekar	cbz	x0, flush_error
165*e2469d82SVarun Wadekar
166*e2469d82SVarun Wadekar	/* flush console */
167*e2469d82SVarun Wadekar	mov	w1, #CONSOLE_WRITE
168*e2469d82SVarun Wadekar	str	w1, [x0]
169*e2469d82SVarun Wadekar	mov	w0, #0
170*e2469d82SVarun Wadekar	ret
171*e2469d82SVarun Wadekarflush_error:
172*e2469d82SVarun Wadekar	mov	w0, #-1
173*e2469d82SVarun Wadekar	ret
174*e2469d82SVarun Wadekarendfunc console_spe_core_flush
175*e2469d82SVarun Wadekar
176*e2469d82SVarun Wadekar	/* ---------------------------------------------
177*e2469d82SVarun Wadekar	 * int console_spe_flush(console_t *console)
178*e2469d82SVarun Wadekar	 * Function to force a write of all buffered
179*e2469d82SVarun Wadekar	 * data that hasn't been output.
180*e2469d82SVarun Wadekar	 * In : x0 - pointer to console_t structure
181*e2469d82SVarun Wadekar	 * Out : return -1 on error else return 0.
182*e2469d82SVarun Wadekar	 * Clobber list : x0, x1
183*e2469d82SVarun Wadekar	 * ---------------------------------------------
184*e2469d82SVarun Wadekar	 */
185*e2469d82SVarun Wadekarfunc console_spe_flush
186*e2469d82SVarun Wadekar	ldr	x0, [x0, #CONSOLE_T_BASE]
187*e2469d82SVarun Wadekar	b	console_spe_core_flush
188*e2469d82SVarun Wadekarendfunc console_spe_flush
189