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