Skip to contentSkip to conversation

tty: New RISC-V SBI console driver

PATCH In review Palmer Dabbelt 4 participants 5 messages Dec 8, 2017

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 tty: New RISC-V SBI console driver

From: Palmer Dabbelt <[email protected]>

The RISC-V ISA defines a simple console that is availiable via SBI calls on all systems. This patch adds a driver for this console interface that can act as both a target for early printk and as the system console. The core arch code already enables the early printk support when CONFIG_HVC_RISCV_SBI is defined.

There is one checkpatch.pl warning here: to check the MAINTAINERS file. They're all matched by the "K: riscv" line.

---
 arch/riscv/include/asm/hvc_riscv_sbi.h | 12 ++++++
 drivers/tty/hvc/Kconfig                | 11 +++++
 drivers/tty/hvc/Makefile               |  1 +
 drivers/tty/hvc/hvc_riscv_sbi.c        | 75 ++++++++++++++++++++++++++++++++++
 4 files changed, 99 insertions(+)
 create mode 100644 arch/riscv/include/asm/hvc_riscv_sbi.h
 create mode 100644 drivers/tty/hvc/hvc_riscv_sbi.c
arch/riscv/include/asm/hvc_riscv_sbi.h new file +12 -0
new file mode 100644
index 000000000000..41723ed7bd97
@@ -0,0 +1,12 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+
+#ifndef _ASM_RISCV_HVC_RISCV_SBI_H
+#define _ASM_RISCV_HVC_RISCV_SBI_H
+
+/*
+ * We always support CONFIG_EARLY_PRINTK via the SBI console driver because it
+ * works well enough that there's no penalty to doing so.
+ */
+extern struct console riscv_sbi_early_console_dev __initdata;
+
+#endif
drivers/tty/hvc/Kconfig +11 -0
index fec457edad14..5e267bb002af 100644
@@ -97,6 +97,17 @@ config HVC_BFIN_JTAG
 	 the HVC driver.  If you don't have JTAG, then you probably don't
 	 want this option.
 
+config HVC_RISCV_SBI
+	bool "RISC-V SBI console support"
+	depends on RISCV
+	select HVC_DRIVER
+	default y
+	help
+	  This enables support for console output via RISC-V SBI calls, which
+	  is normally used only during boot to output printk.
+
+	  If you don't know what do to here, say Y.
+
 config HVCS
 	tristate "IBM Hypervisor Virtual Console Server support"
 	depends on PPC_PSERIES && HVC_CONSOLE
drivers/tty/hvc/Makefile +1 -0
index 0b02ec7f1dfd..83079ae000ae 100644
@@ -11,4 +11,5 @@ obj-$(CONFIG_HVC_XEN)		+= hvc_xen.o
 obj-$(CONFIG_HVC_IUCV)		+= hvc_iucv.o
 obj-$(CONFIG_HVC_UDBG)		+= hvc_udbg.o
 obj-$(CONFIG_HVC_BFIN_JTAG)	+= hvc_bfin_jtag.o
+obj-$(CONFIG_HVC_RISCV_SBI)	+= hvc_riscv_sbi.o
 obj-$(CONFIG_HVCS)		+= hvcs.o
drivers/tty/hvc/hvc_riscv_sbi.c new file +75 -0

75 lines not on this page · raw message

Signature · 1 line
2.13.6
maintainer
#1 lore raw
Quoted 27 lines · Palmer Dabbelt

From: Palmer Dabbelt <[email protected]>

The RISC-V ISA defines a simple console that is availiable via SBI calls on all systems. This patch adds a driver for this console interface that can act as both a target for early printk and as the system console. The core arch code already enables the early printk support when CONFIG_HVC_RISCV_SBI is defined.

There is one checkpatch.pl warning here: to check the MAINTAINERS file. They're all matched by the "K: riscv" line.

---
 arch/riscv/include/asm/hvc_riscv_sbi.h | 12 ++++++
 drivers/tty/hvc/Kconfig                | 11 +++++
 drivers/tty/hvc/Makefile               |  1 +
 drivers/tty/hvc/hvc_riscv_sbi.c        | 75 ++++++++++++++++++++++++++++++++++
 4 files changed, 99 insertions(+)
 create mode 100644 arch/riscv/include/asm/hvc_riscv_sbi.h
 create mode 100644 drivers/tty/hvc/hvc_riscv_sbi.c
arch/riscv/include/asm/hvc_riscv_sbi.h new file +0 -0
new file mode 100644
index 000000000000..41723ed7bd97

arch/riscv/include/asm/hvc_riscv_sbi.h line 10

Quoted 10 lines
arch/riscv/include/asm/hvc_riscv_sbi.h new file +10 -0
@@ -0,0 +1,12 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+
+#ifndef _ASM_RISCV_HVC_RISCV_SBI_H
+#define _ASM_RISCV_HVC_RISCV_SBI_H
+
+/*
+ * We always support CONFIG_EARLY_PRINTK via the SBI console driver because it
+ * works well enough that there's no penalty to doing so.
+ */
+extern struct console riscv_sbi_early_console_dev __initdata;

Are you sure that __initdata should go into a .h file with an extern?

And why do you need this .h file? Nothing in this patch uses it.

arch/riscv/include/asm/hvc_riscv_sbi.h

Quoted 5 lines
arch/riscv/include/asm/hvc_riscv_sbi.h new file +5 -0
+config HVC_RISCV_SBI
+	bool "RISC-V SBI console support"
+	depends on RISCV
+	select HVC_DRIVER
+	default y

Unless you can not boot your machine without this, you do not need 'y'.

thanks,

greg k-h

#2 lore raw
Quoted 41 lines · On Thu, 07 Dec 2017 23:37:18 PST (-0800), [email protected] wrote:
Quoted 27 lines · Palmer Dabbelt

From: Palmer Dabbelt <[email protected]>

The RISC-V ISA defines a simple console that is availiable via SBI calls on all systems. This patch adds a driver for this console interface that can act as both a target for early printk and as the system console. The core arch code already enables the early printk support when CONFIG_HVC_RISCV_SBI is defined.

There is one checkpatch.pl warning here: to check the MAINTAINERS file. They're all matched by the "K: riscv" line.

---
 arch/riscv/include/asm/hvc_riscv_sbi.h | 12 ++++++
 drivers/tty/hvc/Kconfig                | 11 +++++
 drivers/tty/hvc/Makefile               |  1 +
 drivers/tty/hvc/hvc_riscv_sbi.c        | 75 ++++++++++++++++++++++++++++++++++
 4 files changed, 99 insertions(+)
 create mode 100644 arch/riscv/include/asm/hvc_riscv_sbi.h
 create mode 100644 drivers/tty/hvc/hvc_riscv_sbi.c
arch/riscv/include/asm/hvc_riscv_sbi.h new file +0 -0
new file mode 100644
index 000000000000..41723ed7bd97

arch/riscv/include/asm/hvc_riscv_sbi.h line 10

Quoted 10 lines
arch/riscv/include/asm/hvc_riscv_sbi.h new file +10 -0
@@ -0,0 +1,12 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+
+#ifndef _ASM_RISCV_HVC_RISCV_SBI_H
+#define _ASM_RISCV_HVC_RISCV_SBI_H
+
+/*
+ * We always support CONFIG_EARLY_PRINTK via the SBI console driver because it
+ * works well enough that there's no penalty to doing so.
+ */
+extern struct console riscv_sbi_early_console_dev __initdata;

Are you sure that __initdata should go into a .h file with an extern?

Quoted 1 line

And why do you need this .h file? Nothing in this patch uses it.

I'm not sure we need it, but it's the best way I could come up with to get this into setup_arch for the early printk stuff. We use it in arch/riscv/kernel/setup.c, via

   #ifdef CONFIG_HVC_RISCV_SBI
   #include <asm/hvc_riscv_sbi.h>
   #endif

and

   void __init setup_arch(char **cmdline_p)
   {
   #if defined(CONFIG_HVC_RISCV_SBI)
           if (likely(early_console == NULL)) {
                   early_console = &riscv_sbi_early_console_dev;
                   register_console(early_console);
           }
   #endif

I don't know how I missed this the first time, but I can actually just move all that to setup.c, as it's calling directly into the SBI anyway. I think the cleanest way to support this would be to:

* Submit a 4.15 cleanup to remove those two blocks above that call into this driver from our arch code. They can't be compiled in anyway, so it should be safe.
* Submit a v2 of this patch without any of the early printk stuff. I'd assumed this patch would target the 4.16 merge window already, so as long as the first patch is in I think it should be safe.
* Submit a patch that adds support for early printk. This will depend on the first patch, but won't depend on this driver at all as it can just call directly into the SBI.

Sorry this is a mess, I'm still a bit new at this.

Quoted 8 lines

arch/riscv/include/asm/hvc_riscv_sbi.h

Quoted 6 lines
arch/riscv/include/asm/hvc_riscv_sbi.h new file +5 -0
+config HVC_RISCV_SBI
+	bool "RISC-V SBI console support"
+	depends on RISCV
+	select HVC_DRIVER
+	default y

Unless you can not boot your machine without this, you do not need 'y'.

OK.

Quoted 4 lines

thanks,

greg k-h

#3 lore raw
In reply to Palmer Dabbelt
Quoted 23 lines · Palmer Dabbelt

From: Palmer Dabbelt <[email protected]>

The RISC-V ISA defines a simple console that is availiable via SBI calls on all systems. This patch adds a driver for this console interface that can act as both a target for early printk and as the system console. The core arch code already enables the early printk support when CONFIG_HVC_RISCV_SBI is defined.

There is one checkpatch.pl warning here: to check the MAINTAINERS file. They're all matched by the "K: riscv" line.

arch/riscv/include/asm/hvc_riscv_sbi.h new file +4 -0
new file mode 100644
index 000000000000..41723ed7bd97
@@ -0,0 +1,12 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+
+#ifndef _ASM_RISCV_HVC_RISCV_SBI_H
+#define _ASM_RISCV_HVC_RISCV_SBI_H

[...]

drivers/tty/hvc/hvc_riscv_sbi.c line 3

Quoted 9 lines
drivers/tty/hvc/hvc_riscv_sbi.c new file +3 -0
new file mode 100644
index 000000000000..83ef0dcc24e0
@@ -0,0 +1,75 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+
+#include <linux/console.h>

[...]

Hello Palmer,

just a non-technical nitpick: the SPDX-License-Identifier states the license, but not the copyright holder(s). Could you please add an appropriate copyright line to each new file, i.e. something in the form of "copyright <year> <author>"?

Although one can try to determine authorship from the git history, IMHO authorship should be noted explicitly in each file, as that information then sticks to the file whatever happens to it. Files might be reused outside the kernel (e.g. in u-boot, which reuses quite a bit of Linux driver code), and in those cases the connection between the file and its original git history gets lost. The same is true for example for the kernel releases in form of release tarballs which of course don't contain any git metadata. I therefore think it is good practice to always include the copyright/authorship information in each file.

Regards,
Karsten

Signature · 3 lines
Gem. Par. 28 Abs. 4 Bundesdatenschutzgesetz widerspreche ich der Nutzung
sowie der Weitergabe meiner personenbezogenen Daten für Zwecke der
Werbung sowie der Markt- oder Meinungsforschung.
#4 lore raw

Karsten.

Quoted 43 lines · Karsten Merker
Quoted 23 lines · Palmer Dabbelt

From: Palmer Dabbelt <[email protected]>

The RISC-V ISA defines a simple console that is availiable via SBI calls on all systems. This patch adds a driver for this console interface that can act as both a target for early printk and as the system console. The core arch code already enables the early printk support when CONFIG_HVC_RISCV_SBI is defined.

There is one checkpatch.pl warning here: to check the MAINTAINERS file. They're all matched by the "K: riscv" line.

arch/riscv/include/asm/hvc_riscv_sbi.h new file +4 -0
new file mode 100644
index 000000000000..41723ed7bd97
@@ -0,0 +1,12 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+
+#ifndef _ASM_RISCV_HVC_RISCV_SBI_H
+#define _ASM_RISCV_HVC_RISCV_SBI_H

[...]

drivers/tty/hvc/hvc_riscv_sbi.c line 3

Quoted 9 lines
drivers/tty/hvc/hvc_riscv_sbi.c new file +3 -0
new file mode 100644
index 000000000000..83ef0dcc24e0
@@ -0,0 +1,75 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+
+#include <linux/console.h>

[...]

Hello Palmer,

just a non-technical nitpick: the SPDX-License-Identifier states the license, but not the copyright holder(s). Could you please add an appropriate copyright line to each new file, i.e. something in the form of "copyright <year> <author>"?

Quoted 11 lines

Although one can try to determine authorship from the git history, IMHO authorship should be noted explicitly in each file, as that information then sticks to the file whatever happens to it. Files might be reused outside the kernel (e.g. in u-boot, which reuses quite a bit of Linux driver code), and in those cases the connection between the file and its original git history gets lost. The same is true for example for the kernel releases in form of release tarballs which of course don't contain any git metadata. I therefore think it is good practice to always include the copyright/authorship information in each file.

FWIW, I fully agree with you and you nailed it: the combo of SPDX ids
+ a clear copyrights makes both license and author easy to discover in and out of tree: explicit (and concise, and easy to grep) is a win!

Signature · 2 lines
Cordially
Philippe Ombredanne