Separate out common console functionality
authorDan Handley <dan.handley@arm.com>
Wed, 1 Apr 2015 15:51:20 +0000 (16:51 +0100)
committerDan Handley <dan.handley@arm.com>
Tue, 28 Apr 2015 17:57:35 +0000 (18:57 +0100)
Separate out the common console functionality in
`drivers/arm/pl011/pl011_console.S` into a new source file
`drivers/console/console.S`. The former includes the latter to
provide backwards compatibility for platform make files.

Also add a skeleton console implementation for platforms that do not
want to use PL011.

Change-Id: I1ff963b2b54a872fbcf1eb0700797b9e9afa2538

drivers/arm/pl011/pl011_console.S
drivers/console/console.S [new file with mode: 0644]
drivers/console/skeleton_console.S [new file with mode: 0644]

index 0c781a2a5b3acf87a9ec40316b2506615963eeb7..4ed0cebc7b1379b7ab1b5cfdff5f77a990751a62 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved.
+ * Copyright (c) 2013-2015, ARM Limited and Contributors. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
 #include <asm_macros.S>
 #include <pl011.h>
 
-       .globl  console_init
-       .globl  console_putc
+/*
+ * Pull in generic functions to provide backwards compatibility for
+ * platform makefiles
+ */
+#include "../../console/console.S"
+
+
        .globl  console_core_init
        .globl  console_core_putc
-       .globl  console_getc
+       .globl  console_core_getc
 
-       /*
-        *  The console base is in the data section and not in .bss
-        *  even though it is zero-init. In particular, this allows
-        *  the console functions to start using this variable before
-        *  the runtime memory is initialized for images which do not
-        *  need to copy the .data section from ROM to RAM.
-        */
-.section .data.console_base ; .align 3
-       console_base: .quad 0x0
-
-       /* -----------------------------------------------
-        * int console_init(unsigned long 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: return 1 on success.
-        * Clobber list : x1 - x3
-        * -----------------------------------------------
-        */
-func console_init
-       adrp    x3, console_base
-       str     x0, [x3, :lo12:console_base]
-       b       console_core_init
-endfunc console_init
 
        /* -----------------------------------------------
         * int console_core_init(unsigned long base_addr,
@@ -76,16 +53,16 @@ endfunc console_init
         * In: x0 - console base address
         *     w1 - Uart clock in Hz
         *     w2 - Baud rate
-        * Out: return 1 on success
+        * Out: return 1 on success else 0 on error
         * Clobber list : x1, x2
         * -----------------------------------------------
         */
 func console_core_init
        /* Check the input base address */
-       cbz     x0, init_fail
+       cbz     x0, core_init_fail
        /* Check baud rate and uart clock for sanity */
-       cbz     w1, init_fail
-       cbz     w2, init_fail
+       cbz     w1, core_init_fail
+       cbz     w2, core_init_fail
        /* Program the baudrate */
        /* Divisor =  (Uart clock * 4) / baudrate */
        lsl     w1, w1, #2
@@ -106,28 +83,14 @@ func console_core_init
        mov     w1, #(PL011_UARTCR_RXE | PL011_UARTCR_TXE | PL011_UARTCR_UARTEN)
        str     w1, [x0, #UARTCR]
        mov     w0, #1
-init_fail:
+       ret
+core_init_fail:
+       mov     w0, wzr
        ret
 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 -1 on error.
-        * In : x0 - character to be printed
-        * Out : return -1 on error else return character.
-        * Clobber list : x1, x2
-        * ---------------------------------------------
-        */
-func console_putc
-       adrp    x2, console_base
-       ldr     x1, [x2, :lo12:console_base]
-       b       console_core_putc
-endfunc console_putc
-
        /* --------------------------------------------------------
-        * int console_core_putc(int c, unsigned int base_addr)
+        * int console_core_putc(int c, unsigned long base_addr)
         * Function to output a character over the console. It
         * returns the character printed on success or -1 on error.
         * In : w0 - character to be printed
@@ -160,24 +123,24 @@ putc_error:
 endfunc console_core_putc
 
        /* ---------------------------------------------
-        * int console_getc(void)
+        * int console_core_getc(unsigned long base_addr)
         * Function to get a character from the console.
         * It returns the character grabbed on success
         * or -1 on error.
+        * In : x0 - console base address
         * Clobber list : x0, x1
         * ---------------------------------------------
         */
-func console_getc
-       adrp    x0, console_base
-       ldr     x1, [x0, :lo12:console_base]
-       cbz     x1, getc_error
+func console_core_getc
+       cbz     x0, getc_error
 1:
        /* Check if the receive FIFO is empty */
-       ldr     w0, [x1, #UARTFR]
-       tbnz    w0, #PL011_UARTFR_RXFE_BIT, 1b
-       ldr     w0, [x1, #UARTDR]
+       ldr     w1, [x0, #UARTFR]
+       tbnz    w1, #PL011_UARTFR_RXFE_BIT, 1b
+       ldr     w1, [x0, #UARTDR]
+       mov     w0, w1
        ret
 getc_error:
        mov     w0, #-1
        ret
-endfunc console_getc
+endfunc console_core_getc
diff --git a/drivers/console/console.S b/drivers/console/console.S
new file mode 100644 (file)
index 0000000..85c8f65
--- /dev/null
@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2015, ARM Limited and Contributors. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * Neither the name of ARM nor the names of its contributors may be used
+ * to endorse or promote products derived from this software without specific
+ * prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+#include <asm_macros.S>
+
+       .globl  console_init
+       .globl  console_putc
+       .globl  console_getc
+
+       /*
+        *  The console base is in the data section and not in .bss
+        *  even though it is zero-init. In particular, this allows
+        *  the console functions to start using this variable before
+        *  the runtime memory is initialized for images which do not
+        *  need to copy the .data section from ROM to RAM.
+        */
+.section .data.console_base ; .align 3
+       console_base: .quad 0x0
+
+       /* -----------------------------------------------
+        * int console_init(unsigned long 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: return 1 on success else 0 on error
+        * Clobber list : x1 - x3
+        * -----------------------------------------------
+        */
+func console_init
+       /* Check the input base address */
+       cbz     x0, init_fail
+       adrp    x3, console_base
+       str     x0, [x3, :lo12:console_base]
+       b       console_core_init
+init_fail:
+       ret
+endfunc console_init
+
+       /* ---------------------------------------------
+        * int console_putc(int c)
+        * Function to output a character over the
+        * console. It returns the character printed on
+        * success or -1 on error.
+        * In : x0 - character to be printed
+        * Out : return -1 on error else return character.
+        * Clobber list : x1, x2
+        * ---------------------------------------------
+        */
+func console_putc
+       adrp    x2, console_base
+       ldr     x1, [x2, :lo12:console_base]
+       b       console_core_putc
+endfunc console_putc
+
+       /* ---------------------------------------------
+        * int console_getc(void)
+        * Function to get a character from the console.
+        * It returns the character grabbed on success
+        * or -1 on error.
+        * Clobber list : x0, x1
+        * ---------------------------------------------
+        */
+func console_getc
+       adrp    x1, console_base
+       ldr     x0, [x1, :lo12:console_base]
+       b       console_core_getc
+endfunc console_getc
diff --git a/drivers/console/skeleton_console.S b/drivers/console/skeleton_console.S
new file mode 100644 (file)
index 0000000..af78376
--- /dev/null
@@ -0,0 +1,106 @@
+/*
+ * Copyright (c) 2015, ARM Limited and Contributors. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * Neither the name of ARM nor the names of its contributors may be used
+ * to endorse or promote products derived from this software without specific
+ * prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+#include <asm_macros.S>
+
+       /*
+        * This file contains a skeleton console implementation that can
+        * be used as basis for a real console implementation by platforms
+        * that do not contain PL011 hardware.
+        */
+
+       .globl  console_core_init
+       .globl  console_core_putc
+       .globl  console_core_getc
+
+       /* -----------------------------------------------
+        * int console_core_init(unsigned long base_addr,
+        * unsigned int uart_clk, unsigned int baud_rate)
+        * Function to initialize the console without a
+        * C Runtime to print debug information. This
+        * function will be accessed by console_init and
+        * crash reporting.
+        * In: x0 - console base address
+        *     w1 - Uart clock in Hz
+        *     w2 - Baud rate
+        * Out: return 1 on success else 0 on error
+        * Clobber list : x1, x2
+        * -----------------------------------------------
+        */
+func console_core_init
+       /* Check the input base address */
+       cbz     x0, core_init_fail
+       /* Check baud rate and uart clock for sanity */
+       cbz     w1, core_init_fail
+       cbz     w2, core_init_fail
+       /* Insert implementation here */
+       mov     w0, #1
+       ret
+core_init_fail:
+       mov     w0, wzr
+       ret
+endfunc console_core_init
+
+       /* --------------------------------------------------------
+        * int console_core_putc(int c, unsigned long base_addr)
+        * Function to output a character over the console. It
+        * returns the character printed on success or -1 on error.
+        * In : w0 - character to be printed
+        *      x1 - console base address
+        * Out : return -1 on error else return character.
+        * Clobber list : x2
+        * --------------------------------------------------------
+        */
+func console_core_putc
+       /* Check the input parameter */
+       cbz     x1, putc_error
+       /* Insert implementation here */
+       ret
+putc_error:
+       mov     w0, #-1
+       ret
+endfunc console_core_putc
+
+       /* ---------------------------------------------
+        * int console_core_getc(unsigned long base_addr)
+        * Function to get a character from the console.
+        * It returns the character grabbed on success
+        * or -1 on error.
+        * In : x0 - console base address
+        * Clobber list : x0, x1
+        * ---------------------------------------------
+        */
+func console_core_getc
+       cbz     x0, getc_error
+       /* Insert implementation here */
+       ret
+getc_error:
+       mov     w0, #-1
+       ret
+endfunc console_core_getc