Skip to contentSkip to conversation

LiteX SoC controller and LiteUART serial driver

PATCH Superseded Mateusz Holenko 2 participants 8 messages Jun 4, 2020 – Jun 8, 2020

Subsystems (3)

v7 of 12 Superseded Latest is v12 →

lore
Share & tools
lore

Mateusz Holenko

author maintainer
#0 lore raw

v7 cover LiteX SoC controller and LiteUART serial driver

This patchset introduces support for LiteX SoC Controller and LiteUART - serial device from LiteX SoC builder
(https://github.com/enjoy-digital/litex).

In the following patchset I will add
a new mor1kx-based (OpenRISC) platform that
uses this device.

Later I plan to extend this platform by
adding support for more devices from LiteX suite.

Changes in v7:
- added missing include directive in UART's driver

Changes in v6:
- changed accessors in SoC Controller's driver
- reworked UART driver

Changes in v5:
- added Reviewed-by tag
- removed custom accessors from SoC Controller's driver
- fixed error checking in SoC Controller's driver

Changes in v4:
- fixed copyright headers
- fixed SoC Controller's yaml
- simplified SoC Controller's driver

Changes in v3:
- added Acked-by and Reviewed-by tags
- introduced LiteX SoC Controller driver
- removed endianness detection (handled now by LiteX SoC Controller driver)
- modified litex.h header
- DTS aliases for LiteUART made optional
- renamed SERIAL_LITEUART_NR_PORTS to SERIAL_LITEUART_MAX_PORTS
- changed PORT_LITEUART from 122 to 123

Changes in v2:
- binding description rewritten to a yaml schema file
- added litex.h header with common register access functions

Filip Kokosinski (3):
dt-bindings: vendor: add vendor prefix for LiteX
dt-bindings: serial: document LiteUART bindings drivers/tty/serial: add LiteUART driver

Pawel Czarnecki (2):
dt-bindings: soc: document LiteX SoC Controller bindings drivers/soc/litex: add LiteX SoC Controller driver

 .../bindings/serial/litex,liteuart.yaml       |  38 ++
 .../soc/litex/litex,soc-controller.yaml       |  39 ++
 .../devicetree/bindings/vendor-prefixes.yaml  |   2 +
 MAINTAINERS                                   |   9 +
 drivers/soc/Kconfig                           |   1 +
 drivers/soc/Makefile                          |   1 +
 drivers/soc/litex/Kconfig                     |  15 +
 drivers/soc/litex/Makefile                    |   3 +
 drivers/soc/litex/litex_soc_ctrl.c            | 197 +++++++++
 drivers/tty/serial/Kconfig                    |  31 ++
 drivers/tty/serial/Makefile                   |   1 +
 drivers/tty/serial/liteuart.c                 | 405 ++++++++++++++++++
 include/linux/litex.h                         |  45 ++
 13 files changed, 787 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/serial/litex,liteuart.yaml
 create mode 100644 Documentation/devicetree/bindings/soc/litex/litex,soc-controller.yaml
 create mode 100644 drivers/soc/litex/Kconfig
 create mode 100644 drivers/soc/litex/Makefile
 create mode 100644 drivers/soc/litex/litex_soc_ctrl.c
 create mode 100644 drivers/tty/serial/liteuart.c
 create mode 100644 include/linux/litex.h
Signature · 1 line
2.25.1
author maintainer
#1 lore raw

PATCH v7 1/5 dt-bindings: vendor: add vendor prefix for LiteX

From: Filip Kokosinski <[email protected]>

Add vendor prefix for LiteX SoC builder.

---

Notes:
No changes in v7.

No changes in v6.

No changes in v5.

No changes in v4.

Changes in v3:
- added Acked-by tag

No changes in v2.

 Documentation/devicetree/bindings/vendor-prefixes.yaml | 2 ++
 1 file changed, 2 insertions(+)
Documentation/devicetree/bindings/vendor-prefixes.yaml +2 -0
index 997934c58f9a..d2eaddc473ac 100644
@@ -575,6 +575,8 @@ patternProperties:
     description: Linux-specific binding
   "^linx,.*":
     description: Linx Technologies
+  "^litex,.*":
+    description: LiteX SoC builder
   "^lltc,.*":
     description: Linear Technology Corporation
   "^logicpd,.*":
Signature · 1 line
2.25.1
author maintainer
#2 lore raw

PATCH v7 2/5 dt-bindings: soc: document LiteX SoC Controller bindings

In reply to Mateusz Holenko

From: Pawel Czarnecki <[email protected]>

Add documentation for LiteX SoC Controller bindings.

---

Notes:
No changes in v7.

Changes in v6:
- fixed license header

Changes in v5:
- added reviewed-by tag

Changes in v4:
- changes compatible to "litex,soc-controller"
- fixed yaml's header
- removed unnecessary sections from yaml
- fixed indentation in yaml

This commit has been introduced in v3 of the patchset.

 .../soc/litex/litex,soc-controller.yaml       | 39 +++++++++++++++++++
 MAINTAINERS                                   |  6 +++
 2 files changed, 45 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/soc/litex/litex,soc-controller.yaml
Documentation/devicetree/bindings/soc/litex/litex,soc-controller.yaml new file +39 -0
new file mode 100644
index 000000000000..53121c1fbe4d
@@ -0,0 +1,39 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+# Copyright 2020 Antmicro <www.antmicro.com>
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/soc/litex/litex,soc-controller.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: LiteX SoC Controller driver
+
+description: |
+  This is the SoC Controller driver for the LiteX SoC Builder.
+  It's purpose is to verify LiteX CSR (Control&Status Register) access
+  operations and provide function for other drivers to read/write CSRs
+  and to check if those accessors are ready to use.
+
+maintainers:
+  - Karol Gugala <[email protected]>
+  - Mateusz Holenko <[email protected]>
+
+properties:
+  compatible:
+    const: litex,soc-controller
+
+  reg:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+examples:
+  - |
+    soc_ctrl0: soc-controller@f0000000 {
+        compatible = "litex,soc-controller";
+        reg = <0x0 0xf0000000 0x0 0xC>;
+        status = "okay";
+    };
+
+...
MAINTAINERS +6 -0
index ddc1dc7e535e..e3f8804c08d7 100644
@@ -9918,6 +9918,12 @@ L:	[email protected]
 S:	Maintained
 F:	lib/list-test.c
 
+LITEX PLATFORM
+M:	Karol Gugala <[email protected]>
+M:	Mateusz Holenko <[email protected]>
+S:	Maintained
+F:	Documentation/devicetree/bindings/*/litex,*.yaml
+
 LIVE PATCHING
 M:	Josh Poimboeuf <[email protected]>
 M:	Jiri Kosina <[email protected]>
Signature · 1 line
2.25.1
author maintainer
#3 lore raw

PATCH v7 3/5 drivers/soc/litex: add LiteX SoC Controller driver

In reply to Mateusz Holenko

From: Pawel Czarnecki <[email protected]>

This commit adds driver for the FPGA-based LiteX SoC Controller from LiteX SoC builder.

---

Notes:
No changes in v7.

Changes in v6:
- added dependency on OF || COMPILE_TEST
- used le32_to_cpu(readl(addr)) instead of __raw_readl and writel(cpu_to_le32(value), addr) instead of __raw_writel to take advantage of memory barriers provided by readl/writel

Changes in v5:
- removed helper accessors and used __raw_readl/__raw_writel instead
- fixed checking for errors in litex_soc_ctrl_probe

Changes in v4:
- fixed indent in Kconfig's help section
- fixed copyright header
- changed compatible to "litex,soc-controller"
- simplified litex_soc_ctrl_probe
- removed unnecessary litex_soc_ctrl_remove

This commit has been introduced in v3 of the patchset.

It includes a simplified version of common 'litex.h' header introduced in v2 of the patchset.

 MAINTAINERS                        |   2 +
 drivers/soc/Kconfig                |   1 +
 drivers/soc/Makefile               |   1 +
 drivers/soc/litex/Kconfig          |  15 +++
 drivers/soc/litex/Makefile         |   3 +
 drivers/soc/litex/litex_soc_ctrl.c | 197 +++++++++++++++++++++++++++++
 include/linux/litex.h              |  45 +++++++
 7 files changed, 264 insertions(+)
 create mode 100644 drivers/soc/litex/Kconfig
 create mode 100644 drivers/soc/litex/Makefile
 create mode 100644 drivers/soc/litex/litex_soc_ctrl.c
 create mode 100644 include/linux/litex.h
MAINTAINERS +2 -0
index e3f8804c08d7..b6d926a6ed04 100644
@@ -9923,6 +9923,8 @@ M:	Karol Gugala <[email protected]>
 M:	Mateusz Holenko <[email protected]>
 S:	Maintained
 F:	Documentation/devicetree/bindings/*/litex,*.yaml
+F:	drivers/soc/litex/litex_soc_ctrl.c
+F:	include/linux/litex.h
 
 LIVE PATCHING
 M:	Josh Poimboeuf <[email protected]>
drivers/soc/Kconfig +1 -0
index 425ab6f7e375..d097d070f579 100644
@@ -9,6 +9,7 @@ source "drivers/soc/bcm/Kconfig"
 source "drivers/soc/fsl/Kconfig"
 source "drivers/soc/imx/Kconfig"
 source "drivers/soc/ixp4xx/Kconfig"
+source "drivers/soc/litex/Kconfig"
 source "drivers/soc/mediatek/Kconfig"
 source "drivers/soc/qcom/Kconfig"
 source "drivers/soc/renesas/Kconfig"
drivers/soc/Makefile +1 -0
index 36452bed86ef..0b16108823ef 100644
@@ -14,6 +14,7 @@ obj-$(CONFIG_ARCH_GEMINI)	+= gemini/
 obj-y				+= imx/
 obj-$(CONFIG_ARCH_IXP4XX)	+= ixp4xx/
 obj-$(CONFIG_SOC_XWAY)		+= lantiq/
+obj-$(CONFIG_LITEX_SOC_CONTROLLER) += litex/
 obj-y				+= mediatek/
 obj-y				+= amlogic/
 obj-y				+= qcom/
drivers/soc/litex/Kconfig new file +15 -0
new file mode 100644
index 000000000000..c974ec3846bc
@@ -0,0 +1,15 @@
+# SPDX-License_Identifier: GPL-2.0
+
+menu "Enable LiteX SoC Builder specific drivers"
+
+config LITEX_SOC_CONTROLLER
+	tristate "Enable LiteX SoC Controller driver"
+	depends on OF || COMPILE_TEST
+	help
+	  This option enables the SoC Controller Driver which verifies
+	  LiteX CSR access and provides common litex_get_reg/litex_set_reg
+	  accessors.
+	  All drivers that use functions from litex.h must depend on
+	  LITEX_SOC_CONTROLLER.
+
+endmenu
drivers/soc/litex/Makefile new file +3 -0
new file mode 100644
index 000000000000..98ff7325b1c0
@@ -0,0 +1,3 @@
+# SPDX-License_Identifier: GPL-2.0
+
+obj-$(CONFIG_LITEX_SOC_CONTROLLER)	+= litex_soc_ctrl.o
drivers/soc/litex/litex_soc_ctrl.c new file +197 -0

197 lines not on this page · raw message

include/linux/litex.h new file +45 -0

45 lines not on this page · raw message

Signature · 1 line
2.25.1
author maintainer
#4 lore raw

PATCH v7 4/5 dt-bindings: serial: document LiteUART bindings

In reply to Mateusz Holenko

From: Filip Kokosinski <[email protected]>

Add documentation for LiteUART devicetree bindings.

---

Notes:
No changes in v7.

Changes in v6:
- fixed license header

No changes in v5.

No changes in v4.

Changes in v3:
- added Reviewed-by tag
- patch number changed from 3 to 4
- removed changes in MAINTAINERS file (moved to patch #2)

Changes in v2:
- binding description rewritten to a yaml schema file
- added interrupt line
- fixed unit address
- patch number changed from 2 to 3

 .../bindings/serial/litex,liteuart.yaml       | 38 +++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/serial/litex,liteuart.yaml
Documentation/devicetree/bindings/serial/litex,liteuart.yaml new file +38 -0
new file mode 100644
index 000000000000..87bf846b170a
@@ -0,0 +1,38 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/serial/litex,liteuart.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: LiteUART serial controller
+
+maintainers:
+  - Karol Gugala <[email protected]>
+  - Mateusz Holenko <[email protected]>
+
+description: |
+  LiteUART serial controller is a part of LiteX FPGA SoC builder. It supports
+  multiple CPU architectures, currently including e.g. OpenRISC and RISC-V.
+
+properties:
+  compatible:
+    const: litex,liteuart
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+examples:
+  - |
+    uart0: serial@e0001800 {
+      compatible = "litex,liteuart";
+      reg = <0xe0001800 0x100>;
+      interrupts = <2>;
+    };
Signature · 1 line
2.25.1
author maintainer
#5 lore raw

PATCH v7 5/5 drivers/tty/serial: add LiteUART driver

In reply to Mateusz Holenko

From: Filip Kokosinski <[email protected]>

This commit adds driver for the FPGA-based LiteUART serial controller from LiteX SoC builder.

The current implementation supports LiteUART configured for 32 bit data width and 8 bit CSR bus width.

It does not support IRQ.

---

Notes:
Changed in v7:
- added missing include directive

Changes in v6:
- LiteUART ports now stored in xArray
- removed PORT_LITEUART
- fixed formatting
- removed some unnecessary defines

No changes in v5.

Changes in v4:
- fixed copyright header
- removed a wrong dependency on UARTLITE from Kconfig
- added a dependency on LITEX_SOC_CONTROLLER to LITEUART in Kconfig

Changes in v3:
- aliases made optional
- used litex_get_reg/litex_set_reg functions instead of macros
- SERIAL_LITEUART_NR_PORTS renamed to SERIAL_LITEUART_MAX_PORTS
- PORT_LITEUART changed from 122 to 123
- added dependency on LITEX_SOC_CONTROLLER
- patch number changed from 4 to 5

No changes in v2.

 MAINTAINERS                   |   1 +
 drivers/tty/serial/Kconfig    |  31 +++
 drivers/tty/serial/Makefile   |   1 +
 drivers/tty/serial/liteuart.c | 405 ++++++++++++++++++++++++++++++++++
 4 files changed, 438 insertions(+)
 create mode 100644 drivers/tty/serial/liteuart.c
MAINTAINERS +1 -0
index b6d926a6ed04..d06d099aa56f 100644
@@ -9924,6 +9924,7 @@ M:	Mateusz Holenko <[email protected]>
 S:	Maintained
 F:	Documentation/devicetree/bindings/*/litex,*.yaml
 F:	drivers/soc/litex/litex_soc_ctrl.c
+F:	drivers/tty/serial/liteuart.c
 F:	include/linux/litex.h
 
 LIVE PATCHING
drivers/tty/serial/Kconfig +31 -0
index adf9e80e7dc9..17aaf0afb27a 100644
@@ -1562,6 +1562,37 @@ config SERIAL_MILBEAUT_USIO_CONSOLE
 	  receives all kernel messages and warnings and which allows logins in
 	  single user mode).
 
+config SERIAL_LITEUART
+	tristate "LiteUART serial port support"
+	depends on HAS_IOMEM
+	depends on OF || COMPILE_TEST
+	depends on LITEX_SOC_CONTROLLER
+	select SERIAL_CORE
+	help
+	  This driver is for the FPGA-based LiteUART serial controller from LiteX
+	  SoC builder.
+
+	  Say 'Y' here if you wish to use the LiteUART serial controller.
+	  Otherwise, say 'N'.
+
+config SERIAL_LITEUART_MAX_PORTS
+	int "Maximum number of LiteUART ports"
+	depends on SERIAL_LITEUART
+	default "1"
+	help
+	  Set this to the maximum number of serial ports you want the driver
+	  to support.
+
+config SERIAL_LITEUART_CONSOLE
+	bool "LiteUART serial port console support"
+	depends on SERIAL_LITEUART=y
+	select SERIAL_CORE_CONSOLE
+	help
+	  Say 'Y' here if you wish to use the FPGA-based LiteUART serial controller
+	  from LiteX SoC builder as the system console (the system console is the
+	  device which receives all kernel messages and warnings and which allows
+	  logins in single user mode). Otherwise, say 'N'.
+
 endmenu
 
 config SERIAL_MCTRL_GPIO
drivers/tty/serial/Makefile +1 -0
index d056ee6cca33..9f8ba419ff3b 100644
@@ -89,6 +89,7 @@ obj-$(CONFIG_SERIAL_OWL)	+= owl-uart.o
 obj-$(CONFIG_SERIAL_RDA)	+= rda-uart.o
 obj-$(CONFIG_SERIAL_MILBEAUT_USIO) += milbeaut_usio.o
 obj-$(CONFIG_SERIAL_SIFIVE)	+= sifive.o
+obj-$(CONFIG_SERIAL_LITEUART) += liteuart.o
 
 # GPIOLIB helpers for modem control lines
 obj-$(CONFIG_SERIAL_MCTRL_GPIO)	+= serial_mctrl_gpio.o
drivers/tty/serial/liteuart.c new file +405 -0

405 lines not on this page · raw message

Signature · 1 line
2.20.1
#6 lore raw

Re: [PATCH v7 5/5] drivers/tty/serial: add LiteUART driver

Hi--

drivers/tty/serial/Kconfig config SERIAL_MILBEAUT_USIO_CONSOLE · line 1576

Quoted 12 lines · Mateusz Holenko
drivers/tty/serial/Kconfig +12 -0
+config SERIAL_LITEUART
+	tristate "LiteUART serial port support"
+	depends on HAS_IOMEM
+	depends on OF || COMPILE_TEST
+	depends on LITEX_SOC_CONTROLLER
+	select SERIAL_CORE
+	help
+	  This driver is for the FPGA-based LiteUART serial controller from LiteX
+	  SoC builder.
+
+	  Say 'Y' here if you wish to use the LiteUART serial controller.
+	  Otherwise, say 'N'.

That last paragraph seems to say that Y and N are the only choices here. It can also be set to M ...

Signature · 1 line
~Randy
author maintainer
#7 lore raw

Re: [PATCH v7 5/5] drivers/tty/serial: add LiteUART driver

Hi Randy,

Quoted 4 lines · Randy Dunlap

Hi--

On 6/4/20 3:14 AM, Mateusz Holenko wrote:

Quoted 15 lines

drivers/tty/serial/Kconfig config SERIAL_MILBEAUT_USIO_CONSOLE · line 1576

Quoted 12 lines
drivers/tty/serial/Kconfig +12 -0
+config SERIAL_LITEUART
+     tristate "LiteUART serial port support"
+     depends on HAS_IOMEM
+     depends on OF || COMPILE_TEST
+     depends on LITEX_SOC_CONTROLLER
+     select SERIAL_CORE
+     help
+       This driver is for the FPGA-based LiteUART serial controller from LiteX
+       SoC builder.
+
+       Say 'Y' here if you wish to use the LiteUART serial controller.
+       Otherwise, say 'N'.

That last paragraph seems to say that Y and N are the only choices here. It can also be set to M ...

You are correct, we'll update the help message to make it clear.

Quoted 3 lines

--
~Randy

Thanks for your comment!

Best,
Mateusz

--
Mateusz Holenko
Antmicro Ltd | www.antmicro.com
Roosevelta 22, 60-829 Poznan, Poland