aboutsummaryrefslogtreecommitdiff
path: root/drivers
diff options
context:
space:
mode:
authorAntonio Nino Diaz <antonio.ninodiaz@arm.com>2019-04-23 10:53:45 +0100
committerAntonio Nino Diaz <antonio.ninodiaz@arm.com>2019-04-23 10:53:45 +0100
commit3da9cb1fcad88d5c7ca60141c067ad5559cdb399 (patch)
tree03dea16e67cb32994050580fd74a0fb5cb9c9994 /drivers
parent5394feaf2190cb0a80ff0b633d2702a9add337a2 (diff)
downloadtf-a-tests-3da9cb1fcad88d5c7ca60141c067ad5559cdb399.tar.gz
drivers: console: pl011: Move comments to header
Rather than having the description of each function in the implementation, move it to the header so that it isn't needed to copy it in each file that implements a console driver. Change-Id: I1b437ae3d3ccff10979466727353bc1fa1d5b188 Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com>
Diffstat (limited to 'drivers')
-rw-r--r--drivers/arm/pl011/aarch32/pl011_console.S35
-rw-r--r--drivers/arm/pl011/aarch64/pl011_console.S35
-rw-r--r--drivers/console/aarch64/dummy_console.S33
3 files changed, 17 insertions, 86 deletions
diff --git a/drivers/arm/pl011/aarch32/pl011_console.S b/drivers/arm/pl011/aarch32/pl011_console.S
index 4c7bfe7f..c65c4f68 100644
--- a/drivers/arm/pl011/aarch32/pl011_console.S
+++ b/drivers/arm/pl011/aarch32/pl011_console.S
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2018, Arm Limited. All rights reserved.
+ * Copyright (c) 2018-2019, Arm Limited. All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
@@ -33,13 +33,7 @@ console_base: .word 0x0
/* -----------------------------------------------
* int console_init(uintptr_t base_addr,
* unsigned int uart_clk, unsigned int baud_rate)
- * Function to initialize the console without a
- * C Runtime to print debug information. It saves
- * the console base to the data section.
- * In: r0 - Console base address
- * r1 - Uart clock in Hz
- * r2 - Baud rate
- * Out: r0 - Return 1 on success, 0 on error.
+ *
* Clobber list : r1 - r3
* -----------------------------------------------
*/
@@ -105,11 +99,7 @@ endfunc console_core_init
/* ---------------------------------------------
* int console_putc(int c)
- * Function to output a character over the
- * console. It returns the character printed on
- * success or an error code.
- * In : r0 - Character to be printed
- * Out : r0 - Input character or error code.
+ *
* Clobber list : r1, r2
* ---------------------------------------------
*/
@@ -161,12 +151,7 @@ endfunc console_core_putc
/* ---------------------------------------------
* int console_getc(void)
- * Function to get a character from the console.
- * It returns the character grabbed on success
- * or an error code on error. This function is
- * blocking, it waits until there is an
- * available character to return.
- * Out : r0 - Return character or error code.
+ *
* Clobber list : r0 - r3
* ---------------------------------------------
*/
@@ -186,11 +171,7 @@ endfunc console_getc
/* ---------------------------------------------
* int console_try_getc(void)
- * Function to get a character from the console.
- * It returns the character grabbed on success
- * or an error code on error. This function is
- * non-blocking, it returns immediately.
- * Out : r0 - Return character or error code.
+ *
* Clobber list : r0, r1
* ---------------------------------------------
*/
@@ -235,11 +216,7 @@ endfunc console_core_getc
/* ---------------------------------------------
* int console_flush(void)
- * Function to force a write of all buffered
- * data that hasn't been output. It returns 0
- * upon successful completion, otherwise it
- * returns an error code.
- * Out: r0 - Error code or 0.
+ *
* Clobber list : r0, r1
* ---------------------------------------------
*/
diff --git a/drivers/arm/pl011/aarch64/pl011_console.S b/drivers/arm/pl011/aarch64/pl011_console.S
index 4e7ad2d5..8b1e0624 100644
--- a/drivers/arm/pl011/aarch64/pl011_console.S
+++ b/drivers/arm/pl011/aarch64/pl011_console.S
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2018, Arm Limited. All rights reserved.
+ * Copyright (c) 2018-2019, Arm Limited. All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
@@ -33,13 +33,7 @@ console_base: .quad 0x0
/* -----------------------------------------------
* int console_init(uintptr_t base_addr,
* unsigned int uart_clk, unsigned int baud_rate)
- * Function to initialize the console without a
- * C Runtime to print debug information. It saves
- * the console base to the data section.
- * In: x0 - Console base address
- * w1 - Uart clock in Hz
- * w2 - Baud rate
- * Out: w0 - Return 1 on success, 0 on error.
+ *
* Clobber list : x1 - x3
* -----------------------------------------------
*/
@@ -101,11 +95,7 @@ endfunc console_core_init
/* ---------------------------------------------
* int console_putc(int c)
- * Function to output a character over the
- * console. It returns the character printed on
- * success or an error code.
- * In : x0 - Character to be printed
- * Out : w0 - Input character or error code.
+ *
* Clobber list : x1, x2
* ---------------------------------------------
*/
@@ -154,12 +144,7 @@ endfunc console_core_putc
/* ---------------------------------------------
* int console_getc(void)
- * Function to get a character from the console.
- * It returns the character grabbed on success
- * or an error code on error. This function is
- * blocking, it waits until there is an
- * available character to return.
- * Out : w0 - Return character or error code.
+ *
* Clobber list : x0 - x3
* ---------------------------------------------
*/
@@ -179,11 +164,7 @@ endfunc console_getc
/* ---------------------------------------------
* int console_try_getc(void)
- * Function to get a character from the console.
- * It returns the character grabbed on success
- * or an error code on error. This function is
- * non-blocking, it returns immediately.
- * Out : w0 - Return character or error code.
+ *
* Clobber list : x0, x1
* ---------------------------------------------
*/
@@ -226,11 +207,7 @@ endfunc console_core_getc
/* ---------------------------------------------
* int console_flush(void)
- * Function to force a write of all buffered
- * data that hasn't been output. It returns 0
- * upon successful completion, otherwise it
- * returns an error code.
- * Out: w0 - Error code or 0.
+ *
* Clobber list : x0, x1
* ---------------------------------------------
*/
diff --git a/drivers/console/aarch64/dummy_console.S b/drivers/console/aarch64/dummy_console.S
index 50ac1963..961ef96e 100644
--- a/drivers/console/aarch64/dummy_console.S
+++ b/drivers/console/aarch64/dummy_console.S
@@ -16,13 +16,7 @@
/* -----------------------------------------------
* int console_init(uintptr_t base_addr,
* unsigned int uart_clk, unsigned int baud_rate)
- * Function to initialize the console without a
- * C Runtime to print debug information. It saves
- * the console base to the data section.
- * In: x0 - Console base address
- * w1 - Uart clock in Hz
- * w2 - Baud rate
- * Out: w0 - Return 1 on success, 0 on error.
+ *
* Clobber list : x1 - x3
* -----------------------------------------------
*/
@@ -33,11 +27,7 @@ endfunc console_init
/* ---------------------------------------------
* int console_putc(int c)
- * Function to output a character over the
- * console. It returns the character printed on
- * success or an error code.
- * In : x0 - Character to be printed
- * Out : w0 - Input character or error code.
+ *
* Clobber list : x1, x2
* ---------------------------------------------
*/
@@ -48,12 +38,7 @@ endfunc console_putc
/* ---------------------------------------------
* int console_getc(void)
- * Function to get a character from the console.
- * It returns the character grabbed on success
- * or an error code on error. This function is
- * blocking, it waits until there is an
- * available character to return.
- * Out : w0 - Return character or error code.
+ *
* Clobber list : x0 - x3
* ---------------------------------------------
*/
@@ -64,11 +49,7 @@ endfunc console_getc
/* ---------------------------------------------
* int console_try_getc(void)
- * Function to get a character from the console.
- * It returns the character grabbed on success
- * or an error code on error. This function is
- * non-blocking, it returns immediately.
- * Out : w0 - Return character or error code.
+ *
* Clobber list : x0, x1
* ---------------------------------------------
*/
@@ -79,11 +60,7 @@ endfunc console_try_getc
/* ---------------------------------------------
* int console_flush(void)
- * Function to force a write of all buffered
- * data that hasn't been output. It returns 0
- * upon successful completion, otherwise it
- * returns an error code.
- * Out: w0 - Error code or 0.
+ *
* Clobber list : x0, x1
* ---------------------------------------------
*/