Skip to contentSkip to conversation

LiteX SoC controller and LiteUART serial driver

PATCH Superseded Mateusz Holenko 3 participants 12 messages Aug 12, 2020 – Sep 15, 2020

Subsystems (3)

v10 of 12 Superseded Latest is v12 →

lore
Share & tools
lore

Mateusz Holenko

author maintainer
#0 lore raw

v10 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 v10:
- added casting to avoid sparse warnings in the SoC Controller's driver

Changes in v9:
- fixed the reg node notation in the DT example
- added exporting of the litex_set_reg/litex_get_reg symbols

Changes in v8:
- fixed help messages in LiteUART's KConfig
- removed dependency between LiteUART and LiteX SoC drivers
- removed litex_check_accessors() helper function
- added crashing (BUG) on the failed LiteX CSR access test

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            | 194 +++++++++
 drivers/tty/serial/Kconfig                    |  32 ++
 drivers/tty/serial/Makefile                   |   1 +
 drivers/tty/serial/liteuart.c                 | 402 ++++++++++++++++++
 include/linux/litex.h                         |  24 ++
 13 files changed, 761 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 v10 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 v10.

No changes in v9.

No changes in v8.

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 d3891386d671..9aae6c56d7a3 100644
@@ -571,6 +571,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 v10 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 v10.

Changes in v9:
- fixed the reg node notation in the DT example

No changes in v8.

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 = <0xf0000000 0xC>;
+        status = "okay";
+    };
+
+...
MAINTAINERS +6 -0
index 7b58ca29cc80..39be98db7418 100644
@@ -9835,6 +9835,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 v10 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:
Changes in v10:
- added casting to avoid sparse warnings in the SoC Controller's driver

Changes in v9:
- added exporting of the litex_set_reg/litex_get_reg symbols

Changes in v8:
- removed litex_check_accessors() helper function
- added crashing (BUG) on the failed LiteX CSR access test

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 | 194 +++++++++++++++++++++++++++++
 include/linux/litex.h              |  24 ++++
 7 files changed, 240 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 39be98db7418..4d70a1b22a87 100644
@@ -9840,6 +9840,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 +194 -0

194 lines not on this page · raw message

include/linux/litex.h new file +24 -0
new file mode 100644
index 000000000000..72061018c172
@@ -0,0 +1,24 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * Common LiteX header providing
+ * helper functions for accessing CSRs.
+ *
+ * Implementation of the functions is provided by
+ * the LiteX SoC Controller driver.
+ *
+ * Copyright (C) 2019-2020 Antmicro <www.antmicro.com>
+ */
+
+#ifndef _LINUX_LITEX_H
+#define _LINUX_LITEX_H
+
+#include <linux/io.h>
+#include <linux/types.h>
+#include <linux/compiler_types.h>
+
+void litex_set_reg(void __iomem *reg, unsigned long reg_sz, unsigned long val);
+
+unsigned long litex_get_reg(void __iomem *reg, unsigned long reg_sz);
+
+
+#endif /* _LINUX_LITEX_H */
Signature · 1 line
2.25.1
#4 lore raw

Re: [PATCH v10 3/5] drivers/soc/litex: add LiteX SoC Controller driver

Quoted 9 lines · Mateusz Holenko

From: Pawel Czarnecki <[email protected]>

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

---

...

Quoted 17 lines
drivers/soc/litex/litex_soc_ctrl.c new file +17 -0
+static int litex_check_csr_access(void __iomem *reg_addr)
+{
+	unsigned long reg;
+
+	reg = litex_get_reg(reg_addr + SCRATCH_REG_OFF, SCRATCH_REG_SIZE);
+
+	if (reg != SCRATCH_REG_VALUE) {
+		panic("Scratch register read error! Expected: 0x%x but got: 0x%lx",
+			SCRATCH_REG_VALUE, reg);
+		return -EINVAL;
+	}
+
+	litex_set_reg(reg_addr + SCRATCH_REG_OFF,
+		SCRATCH_REG_SIZE, SCRATCH_TEST_VALUE);
+	reg = litex_get_reg(reg_addr + SCRATCH_REG_OFF, SCRATCH_REG_SIZE);
+
+	if (reg != SCRATCH_TEST_VALUE) {

drivers/soc/litex/litex_soc_ctrl.c line 135

Quoted 10 lines
drivers/soc/litex/litex_soc_ctrl.c new file +10 -0
+		panic("Scratch register write error! Expected: 0x%x but got: 0x%lx",
+			SCRATCH_TEST_VALUE, reg);
+		return -EINVAL;
+	}
+
+	/* restore original value of the SCRATCH register */
+	litex_set_reg(reg_addr + SCRATCH_REG_OFF,
+		SCRATCH_REG_SIZE, SCRATCH_REG_VALUE);
+
+	/* Set flag for other drivers */

What does this comment mean?

Quoted 31 lines
drivers/soc/litex/litex_soc_ctrl.c new file +31 -0
+	pr_info("LiteX SoC Controller driver initialized");
+
+	return 0;
+}
+
+struct litex_soc_ctrl_device {
+	void __iomem *base;
+};
+
+static const struct of_device_id litex_soc_ctrl_of_match[] = {
+	{.compatible = "litex,soc-controller"},
+	{},
+};
+
+MODULE_DEVICE_TABLE(of, litex_soc_ctrl_of_match);
+
+static int litex_soc_ctrl_probe(struct platform_device *pdev)
+{
+	int result;
+	struct device *dev;
+	struct device_node *node;
+	struct litex_soc_ctrl_device *soc_ctrl_dev;
+
+	dev = &pdev->dev;
+	node = dev->of_node;
+	if (!node)
+		return -ENODEV;
+
+	soc_ctrl_dev = devm_kzalloc(dev, sizeof(*soc_ctrl_dev), GFP_KERNEL);
+	if (!soc_ctrl_dev)
+		return -ENOMEM;

drivers/soc/litex/litex_soc_ctrl.c line 176

Quoted 10 lines
drivers/soc/litex/litex_soc_ctrl.c new file +10 -0
+
+	soc_ctrl_dev->base = devm_platform_ioremap_resource(pdev, 0);
+	if (IS_ERR(soc_ctrl_dev->base))
+		return PTR_ERR(soc_ctrl_dev->base);
+
+	result = litex_check_csr_access(soc_ctrl_dev->base);
+	if (result) {
+		// LiteX CSRs access is broken which means that
+		// none of LiteX drivers will most probably
+		// operate correctly

The comment format here with // is not usually used in the kernel, but its not forbidded. Could you use the /* */ multiline style?

drivers/soc/litex/litex_soc_ctrl.c line 177

Quoted 1 line
drivers/soc/litex/litex_soc_ctrl.c new file +1 -0
+		BUG();

Instead of stopping the system with BUG, could we just do:

	return litex_check_csr_access(soc_ctrl_dev->base);

We already have failure for NODEV/NOMEM so might as well not call BUG() here too.

drivers/soc/litex/litex_soc_ctrl.c line 140

Quoted 5 lines
drivers/soc/litex/litex_soc_ctrl.c new file +5 -0
+	}
+
+	return 0;
+}
+

Other than that it looks ok to me.

-Stafford

author maintainer
#5 lore raw

Re: [PATCH v10 3/5] drivers/soc/litex: add LiteX SoC Controller driver

Quoted 32 lines · Stafford Horne
Quoted 9 lines · Mateusz Holenko

From: Pawel Czarnecki <[email protected]>

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

---

...

Quoted 20 lines
drivers/soc/litex/litex_soc_ctrl.c new file +20 -0
+static int litex_check_csr_access(void __iomem *reg_addr)
+{
+     unsigned long reg;
+
+     reg = litex_get_reg(reg_addr + SCRATCH_REG_OFF, SCRATCH_REG_SIZE);
+
+     if (reg != SCRATCH_REG_VALUE) {
+             panic("Scratch register read error! Expected: 0x%x but got: 0x%lx",
+                     SCRATCH_REG_VALUE, reg);
+             return -EINVAL;
+     }
+
+     litex_set_reg(reg_addr + SCRATCH_REG_OFF,
+             SCRATCH_REG_SIZE, SCRATCH_TEST_VALUE);
+     reg = litex_get_reg(reg_addr + SCRATCH_REG_OFF, SCRATCH_REG_SIZE);
+
+     if (reg != SCRATCH_TEST_VALUE) {
+             panic("Scratch register write error! Expected: 0x%x but got: 0x%lx",
+                     SCRATCH_TEST_VALUE, reg);
+             return -EINVAL;
Quoted 8 lines

drivers/soc/litex/litex_soc_ctrl.c line 135

Quoted 7 lines
drivers/soc/litex/litex_soc_ctrl.c new file +7 -0
+     }
+
+     /* restore original value of the SCRATCH register */
+     litex_set_reg(reg_addr + SCRATCH_REG_OFF,
+             SCRATCH_REG_SIZE, SCRATCH_REG_VALUE);
+
+     /* Set flag for other drivers */

What does this comment mean?

This is a leftover from the previous version of the patch and shouldn't be there - sorry for that.
I'll remove it.

Quoted 35 lines
Quoted 35 lines
drivers/soc/litex/litex_soc_ctrl.c new file +35 -0
+     pr_info("LiteX SoC Controller driver initialized");
+
+     return 0;
+}
+
+struct litex_soc_ctrl_device {
+     void __iomem *base;
+};
+
+static const struct of_device_id litex_soc_ctrl_of_match[] = {
+     {.compatible = "litex,soc-controller"},
+     {},
+};
+
+MODULE_DEVICE_TABLE(of, litex_soc_ctrl_of_match);
+
+static int litex_soc_ctrl_probe(struct platform_device *pdev)
+{
+     int result;
+     struct device *dev;
+     struct device_node *node;
+     struct litex_soc_ctrl_device *soc_ctrl_dev;
+
+     dev = &pdev->dev;
+     node = dev->of_node;
+     if (!node)
+             return -ENODEV;
+
+     soc_ctrl_dev = devm_kzalloc(dev, sizeof(*soc_ctrl_dev), GFP_KERNEL);
+     if (!soc_ctrl_dev)
+             return -ENOMEM;
+
+     soc_ctrl_dev->base = devm_platform_ioremap_resource(pdev, 0);
+     if (IS_ERR(soc_ctrl_dev->base))
+             return PTR_ERR(soc_ctrl_dev->base);
Quoted 8 lines

drivers/soc/litex/litex_soc_ctrl.c line 176

Quoted 6 lines
drivers/soc/litex/litex_soc_ctrl.c new file +6 -0
+
+     result = litex_check_csr_access(soc_ctrl_dev->base);
+     if (result) {
+             // LiteX CSRs access is broken which means that
+             // none of LiteX drivers will most probably
+             // operate correctly

The comment format here with // is not usually used in the kernel, but its not forbidded. Could you use the /* */ multiline style?

Sure, I'll change the commenting style here.

Quoted 8 lines
Quoted 2 lines

+ BUG();

Instead of stopping the system with BUG, could we just do:

        return litex_check_csr_access(soc_ctrl_dev->base);

We already have failure for NODEV/NOMEM so might as well not call BUG() here too.

It's true that litex_check_csr_accessors() already generates error codes that could be
returned directly.
The point of using BUG() macro here, however, is to stop booting the system so that it's visible
(and impossible to miss for the user) that an unresolvable HW issue was encountered.

CSR-accessors - the litex_{g,s}et_reg() functions - are intended to be used by other LiteX drivers
and it's very unlikely that those drivers would work properly after the fail of litex_check_csr_accessors().
Since in such case the UART driver will be affected too (no boot logs and error messages visible to the user),
I thought it'll be easier to spot and debug the problem if the system stopped in the BUG loop.
Perhaps there are other, more linux-friendly, ways of achieving a similar goal - I'm open for suggestions.

Quoted 9 lines

drivers/soc/litex/litex_soc_ctrl.c line 140

Quoted 5 lines
drivers/soc/litex/litex_soc_ctrl.c new file +5 -0
+     }
+
+     return 0;
+}
+

Other than that it looks ok to me.

-Stafford

Thanks for the review!

Best,
Mateusz

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

#6 lore raw

Re: [PATCH v10 3/5] drivers/soc/litex: add LiteX SoC Controller driver

Quoted 8 lines · Mateusz Holenko
Quoted 7 lines · Stafford Horne
Quoted 5 lines · Mateusz Holenko

From: Pawel Czarnecki <[email protected]>

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

Quoted 7 lines
Quoted 7 lines

drivers/soc/litex/litex_soc_ctrl.c line 162

Quoted 7 lines

---

drivers/soc/litex/litex_soc_ctrl.c new file +3 -0
+     node = dev->of_node;
+     if (!node)
+             return -ENODEV;

We return here without BUG() if the setup fails.

Quoted 4 lines
Quoted 4 lines

drivers/soc/litex/litex_soc_ctrl.c line 166

Quoted 4 lines
drivers/soc/litex/litex_soc_ctrl.c new file +4 -0
+
+     soc_ctrl_dev = devm_kzalloc(dev, sizeof(*soc_ctrl_dev), GFP_KERNEL);
+     if (!soc_ctrl_dev)
+             return -ENOMEM;

We return here without BUG() if we are out of memory.

Quoted 4 lines
Quoted 4 lines

drivers/soc/litex/litex_soc_ctrl.c line 170

Quoted 4 lines
drivers/soc/litex/litex_soc_ctrl.c new file +4 -0
+
+     soc_ctrl_dev->base = devm_platform_ioremap_resource(pdev, 0);
+     if (IS_ERR(soc_ctrl_dev->base))
+             return PTR_ERR(soc_ctrl_dev->base);

Etc.

Quoted 28 lines
Quoted 8 lines

drivers/soc/litex/litex_soc_ctrl.c line 176

Quoted 6 lines
drivers/soc/litex/litex_soc_ctrl.c new file +6 -0
+
+     result = litex_check_csr_access(soc_ctrl_dev->base);
+     if (result) {
+             // LiteX CSRs access is broken which means that
+             // none of LiteX drivers will most probably
+             // operate correctly

The comment format here with // is not usually used in the kernel, but its not forbidded. Could you use the /* */ multiline style?

Sure, I'll change the commenting style here.

Quoted 8 lines
Quoted 2 lines

+ BUG();

Instead of stopping the system with BUG, could we just do:

        return litex_check_csr_access(soc_ctrl_dev->base);

We already have failure for NODEV/NOMEM so might as well not call BUG() here too.

It's true that litex_check_csr_accessors() already generates error codes that could be
returned directly.
The point of using BUG() macro here, however, is to stop booting the system so that it's visible
(and impossible to miss for the user) that an unresolvable HW issue was encountered.

Quoted 10 lines

CSR-accessors - the litex_{g,s}et_reg() functions - are intended to be used by other LiteX drivers
and it's very unlikely that those drivers would work properly after the fail of litex_check_csr_accessors().
Since in such case the UART driver will be affected too (no boot logs and error messages visible to the user),
I thought it'll be easier to spot and debug the problem if the system stopped in the BUG loop.
Perhaps there are other, more linux-friendly, ways of achieving a similar goal - I'm open for suggestions.

I see your point, but I thought if failed with an exit status above, we could do the same here. But I guess failing here means that something is really wrong as validation failed.

Some points:
- If we return here, the system will still boot but there will be no UART
- If we bail with BUG(), here the system stops, and there is no UART
- Both cases the user can connect with a debugger and read "dmesg", to see what is wrong, but BUG() does not print an error message on all architectures.

We could also use:

- WARN(1, "Failed to validate CSR registers, the system is probably broken.");

If you want to keep BUG() it may be fine.

I am not an expert on handling these type of bailout's so other input is appreciated.

-Stafford

author maintainer
#7 lore raw

Re: [PATCH v10 3/5] drivers/soc/litex: add LiteX SoC Controller driver

Quoted 25 lines · Stafford Horne
Quoted 8 lines · Mateusz Holenko
Quoted 7 lines · Stafford Horne
Quoted 5 lines · Mateusz Holenko

From: Pawel Czarnecki <[email protected]>

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

Quoted 7 lines
Quoted 7 lines

drivers/soc/litex/litex_soc_ctrl.c line 162

Quoted 7 lines

---

drivers/soc/litex/litex_soc_ctrl.c new file +3 -0
+     node = dev->of_node;
+     if (!node)
+             return -ENODEV;

We return here without BUG() if the setup fails.

Quoted 4 lines
Quoted 4 lines

drivers/soc/litex/litex_soc_ctrl.c line 166

Quoted 4 lines
drivers/soc/litex/litex_soc_ctrl.c new file +4 -0
+
+     soc_ctrl_dev = devm_kzalloc(dev, sizeof(*soc_ctrl_dev), GFP_KERNEL);
+     if (!soc_ctrl_dev)
+             return -ENOMEM;
Quoted 8 lines

We return here without BUG() if we are out of memory.

Quoted 4 lines
Quoted 4 lines

drivers/soc/litex/litex_soc_ctrl.c line 170

Quoted 4 lines
drivers/soc/litex/litex_soc_ctrl.c new file +4 -0
+
+     soc_ctrl_dev->base = devm_platform_ioremap_resource(pdev, 0);
+     if (IS_ERR(soc_ctrl_dev->base))
+             return PTR_ERR(soc_ctrl_dev->base);

Etc.

You are totally right - this is not consistent.
We should probably either trigger BUG() in each case or don't bother at all.

Quoted 50 lines
Quoted 29 lines
Quoted 9 lines

drivers/soc/litex/litex_soc_ctrl.c line 176

Quoted 7 lines
drivers/soc/litex/litex_soc_ctrl.c new file +6 -0
+
+     result = litex_check_csr_access(soc_ctrl_dev->base);
+     if (result) {
+             // LiteX CSRs access is broken which means that
+             // none of LiteX drivers will most probably
+             // operate correctly

The comment format here with // is not usually used in the kernel, but its not forbidded. Could you use the /* */ multiline style?

Sure, I'll change the commenting style here.

Quoted 8 lines
Quoted 2 lines

+ BUG();

Instead of stopping the system with BUG, could we just do:

        return litex_check_csr_access(soc_ctrl_dev->base);

We already have failure for NODEV/NOMEM so might as well not call BUG() here too.

It's true that litex_check_csr_accessors() already generates error codes that could be
returned directly.
The point of using BUG() macro here, however, is to stop booting the system so that it's visible
(and impossible to miss for the user) that an unresolvable HW issue was encountered.

Quoted 10 lines

CSR-accessors - the litex_{g,s}et_reg() functions - are intended to be used by other LiteX drivers
and it's very unlikely that those drivers would work properly after the fail of litex_check_csr_accessors().
Since in such case the UART driver will be affected too (no boot logs and error messages visible to the user),
I thought it'll be easier to spot and debug the problem if the system stopped in the BUG loop.
Perhaps there are other, more linux-friendly, ways of achieving a similar goal - I'm open for suggestions.

I see your point, but I thought if failed with an exit status above, we could do the same here. But I guess failing here means that something is really wrong as validation failed.

Some points:
- If we return here, the system will still boot but there will be no UART
- If we bail with BUG(), here the system stops, and there is no UART
- Both cases the user can connect with a debugger and read "dmesg", to see what is wrong, but BUG() does not print an error message on all architectures.

Quoted 8 lines

We could also use:

- WARN(1, "Failed to validate CSR registers, the system is probably broken.");

If you want to keep BUG() it may be fine.

I am not an expert on handling these type of bailout's so other input is appreciated.

I don't have a strong opinion about using BUG() here - I just thought it would be easier for the user.
If this is, however, not how linux typically works, I'm ok with reworking this part.

Quoted 1 line

-Stafford

Best,
Mateusz

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

author maintainer
#8 lore raw

PATCH v10 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 v10.

No changes in v9.

No changes in v8.

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..69acb222bb57
@@ -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
#9 lore raw

PATCH v10 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:
No changes in v10.

No changes in v9.

Changes in v8:
- fixed help messages in LiteUART's KConfig
- removed dependency between LiteUART and LiteX SoC drivers

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    |  32 +++
 drivers/tty/serial/Makefile   |   1 +
 drivers/tty/serial/liteuart.c | 402 ++++++++++++++++++++++++++++++++++
 4 files changed, 436 insertions(+)
 create mode 100644 drivers/tty/serial/liteuart.c
MAINTAINERS +1 -0
index 4d70a1b22a87..1387cefc63ce 100644
@@ -9841,6 +9841,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 +32 -0
index adf9e80e7dc9..17aaf0afb27a 100644
@@ -1562,6 +1562,38 @@ 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' or 'M' 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' or 'M' 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 +402 -0

402 lines not on this page · raw message

Signature · 1 line
2.25.1
maintainer Reviewed-by on v10 5/5
#10 lore raw

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

Quoted 5 lines · Mateusz Holenko

From: Filip Kokosinski <[email protected]>

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

Quoted 7 lines

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

It does not support IRQ.

#11 lore raw
In reply to Mateusz Holenko
Quoted 10 lines · Mateusz Holenko

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.

Hello, as discussed offline I am planning to merge these via the OpenRISC tree during 5.10. If anyone has an issues let me know.

The patches all have their reviews and look fine to me other than a few nit's on the soc controller patch.

-Stafford