Skip to contentSkip to conversation

LiteX SoC controller and LiteUART serial driver

PATCH Superseded Mateusz Holenko 3 participants 12 messages Jul 22, 2020 – Aug 3, 2020

Subsystems (3)

v9 of 12 Superseded Latest is v12 →

lore
Share & tools
lore

Mateusz Holenko

author maintainer
#0 lore raw

v9 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 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 v9 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 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 v9 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:
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 v9 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 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 v9 3/5] drivers/soc/litex: add LiteX SoC Controller driver

Thank you for the patch! Perhaps something to improve:

Hi Mateusz,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on robh/for-next]
[also build test WARNING on tty/tty-testing usb/usb-testing staging/staging-testing driver-core/driver-core-testing linus/master v5.8-rc6 next-20200724] [If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url:    https://github.com/0day-ci/linux/commits/Mateusz-Holenko/LiteX-SoC-controller-and-LiteUART-serial-driver/20200722-183024
base:   https://git.kernel.org/pub/scm/linux/kernel/git/robh/linux.git for-next
config: openrisc-randconfig-s032-20200725 (attached as .config)
compiler: or1k-linux-gcc (GCC) 9.3.0

reproduce:
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# apt-get install sparse
# sparse version: v0.6.2-93-g4c6cbe55-dirty
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross C=1 CF='-fdiagnostic-prefix -D__CHECK_ENDIAN__' ARCH=openrisc

If you fix the issue, kindly add following tag as appropriate

sparse warnings: (new ones prefixed by >>)

>> drivers/soc/litex/litex_soc_ctrl.c:61:24: sparse: sparse: incorrect type in argument 1 (different base types) @@     expected unsigned int [usertype] value @@     got restricted __le32 [usertype] @@
>> drivers/soc/litex/litex_soc_ctrl.c:61:24: sparse:     expected unsigned int [usertype] value
>> drivers/soc/litex/litex_soc_ctrl.c:61:24: sparse:     got restricted __le32 [usertype]
>> drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32
>> drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32
>> drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32
>> drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32
>> drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32
>> drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32

drivers/soc/litex/litex_soc_ctrl.c: note: in included file (through arch/openrisc/include/asm/io.h, include/linux/io.h, include/linux/litex.h):
include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32
include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32
include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32
include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32
include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32
include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32
include/asm-generic/io.h:225:22: sparse: sparse: incorrect type in argument 1 (different base types) @@ expected unsigned int [usertype] value @@ got restricted __le32 [usertype] @@
include/asm-generic/io.h:225:22: sparse: expected unsigned int [usertype] value
include/asm-generic/io.h:225:22: sparse: got restricted __le32 [usertype]
include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32
include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32
include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32
include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32
include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32
include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32

vim +61 drivers/soc/litex/litex_soc_ctrl.c

    32	
    33	/*
    34	 * LiteX SoC Generator, depending on the configuration,
    35	 * can split a single logical CSR (Control & Status Register)
    36	 * into a series of consecutive physical registers.
    37	 *
    38	 * For example, in the configuration with 8-bit CSR Bus,
    39	 * 32-bit aligned (the default one for 32-bit CPUs) a 32-bit
    40	 * logical CSR will be generated as four 32-bit physical registers,
    41	 * each one containing one byte of meaningful data.
    42	 *
    43	 * For details see: https://github.com/enjoy-digital/litex/wiki/CSR-Bus
    44	 *
    45	 * The purpose of `litex_set_reg`/`litex_get_reg` is to implement
    46	 * the logic of writing to/reading from the LiteX CSR in a single
    47	 * place that can be then reused by all LiteX drivers.
    48	 */
    49	void litex_set_reg(void __iomem *reg, unsigned long reg_size,
    50			    unsigned long val)
    51	{
    52		unsigned long shifted_data, shift, i;
    53		unsigned long flags;
    54	
    55		spin_lock_irqsave(&csr_lock, flags);
    56	
    57		for (i = 0; i < reg_size; ++i) {
    58			shift = ((reg_size - i - 1) * LITEX_SUBREG_SIZE_BIT);
    59			shifted_data = val >> shift;
    60	
  > 61			writel(cpu_to_le32(shifted_data), reg + (LITEX_REG_SIZE * i));
    62		}
    63	
    64		spin_unlock_irqrestore(&csr_lock, flags);
    65	}
    66	EXPORT_SYMBOL_GPL(litex_set_reg);
    67	
    68	unsigned long litex_get_reg(void __iomem *reg, unsigned long reg_size)
    69	{
    70		unsigned long shifted_data, shift, i;
    71		unsigned long result = 0;
    72		unsigned long flags;
    73	
    74		spin_lock_irqsave(&csr_lock, flags);
    75	
    76		for (i = 0; i < reg_size; ++i) {
  > 77			shifted_data = le32_to_cpu(readl(reg + (LITEX_REG_SIZE * i)));
    78	
    79			shift = ((reg_size - i - 1) * LITEX_SUBREG_SIZE_BIT);
    80			result |= (shifted_data << shift);
    81		}
    82	
    83		spin_unlock_irqrestore(&csr_lock, flags);
    84	
    85		return result;
    86	}
    87	EXPORT_SYMBOL_GPL(litex_get_reg);
    88	

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/[email protected]

#5 lore raw

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

Quoted 14 lines · kernel test robot

Hi Mateusz,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on robh/for-next]
[also build test WARNING on tty/tty-testing usb/usb-testing staging/staging-testing driver-core/driver-core-testing linus/master v5.8-rc6 next-20200724] [If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url:    https://github.com/0day-ci/linux/commits/Mateusz-Holenko/LiteX-SoC-controller-and-LiteUART-serial-driver/20200722-183024
base:   https://git.kernel.org/pub/scm/linux/kernel/git/robh/linux.git for-next
config: openrisc-randconfig-s032-20200725 (attached as .config)
compiler: or1k-linux-gcc (GCC) 9.3.0
Quoted 7 lines

reproduce:
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# apt-get install sparse
# sparse version: v0.6.2-93-g4c6cbe55-dirty
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross C=1 CF='-fdiagnostic-prefix -D__CHECK_ENDIAN__' ARCH=openrisc

Note, this is OpenRISC

Quoted 15 lines

If you fix the issue, kindly add following tag as appropriate

sparse warnings: (new ones prefixed by >>)

Quoted 9 lines
Quoted 9 lines

drivers/soc/litex/litex_soc_ctrl.c:61:24: sparse: sparse: incorrect type in argument 1 (different base types) @@ expected unsigned int [usertype] value @@ got restricted __le32 [usertype] @@
drivers/soc/litex/litex_soc_ctrl.c:61:24: sparse: expected unsigned int [usertype] value
drivers/soc/litex/litex_soc_ctrl.c:61:24: sparse: got restricted __le32 [usertype]
drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32

Quoted 1 line

drivers/soc/litex/litex_soc_ctrl.c: note: in included file (through arch/openrisc/include/asm/io.h, include/linux/io.h, include/linux/litex.h):

I think this is something I need to fix up in the openrisc io.h header.

It seems the sparse annotations are messed up. Working on it...

-Stafford

Quoted 79 lines

include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32
include/asm-generic/io.h:225:22: sparse: sparse: incorrect type in argument 1 (different base types) @@ expected unsigned int [usertype] value @@ got restricted __le32 [usertype] @@
include/asm-generic/io.h:225:22: sparse: expected unsigned int [usertype] value
include/asm-generic/io.h:225:22: sparse: got restricted __le32 [usertype]
include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32

vim +61 drivers/soc/litex/litex_soc_ctrl.c

    32	
    33	/*
    34	 * LiteX SoC Generator, depending on the configuration,
    35	 * can split a single logical CSR (Control & Status Register)
    36	 * into a series of consecutive physical registers.
    37	 *
    38	 * For example, in the configuration with 8-bit CSR Bus,
    39	 * 32-bit aligned (the default one for 32-bit CPUs) a 32-bit
    40	 * logical CSR will be generated as four 32-bit physical registers,
    41	 * each one containing one byte of meaningful data.
    42	 *
    43	 * For details see: https://github.com/enjoy-digital/litex/wiki/CSR-Bus
    44	 *
    45	 * The purpose of `litex_set_reg`/`litex_get_reg` is to implement
    46	 * the logic of writing to/reading from the LiteX CSR in a single
    47	 * place that can be then reused by all LiteX drivers.
    48	 */
    49	void litex_set_reg(void __iomem *reg, unsigned long reg_size,
    50			    unsigned long val)
    51	{
    52		unsigned long shifted_data, shift, i;
    53		unsigned long flags;
    54	
    55		spin_lock_irqsave(&csr_lock, flags);
    56	
    57		for (i = 0; i < reg_size; ++i) {
    58			shift = ((reg_size - i - 1) * LITEX_SUBREG_SIZE_BIT);
    59			shifted_data = val >> shift;
    60	
Quoted 1 line

61 writel(cpu_to_le32(shifted_data), reg + (LITEX_REG_SIZE * i));

    62		}
    63	
    64		spin_unlock_irqrestore(&csr_lock, flags);
    65	}
    66	EXPORT_SYMBOL_GPL(litex_set_reg);
    67	
    68	unsigned long litex_get_reg(void __iomem *reg, unsigned long reg_size)
    69	{
    70		unsigned long shifted_data, shift, i;
    71		unsigned long result = 0;
    72		unsigned long flags;
    73	
    74		spin_lock_irqsave(&csr_lock, flags);
    75	
    76		for (i = 0; i < reg_size; ++i) {
Quoted 1 line

77 shifted_data = le32_to_cpu(readl(reg + (LITEX_REG_SIZE * i)));

    78	
    79			shift = ((reg_size - i - 1) * LITEX_SUBREG_SIZE_BIT);
    80			result |= (shifted_data << shift);
    81		}
    82	
    83		spin_unlock_irqrestore(&csr_lock, flags);
    84	
    85		return result;
    86	}
    87	EXPORT_SYMBOL_GPL(litex_get_reg);
    88	

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org

#6 lore raw

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

Hi Mateusz,

There may be a problem here, see below.

Quoted 40 lines · Stafford Horne
Quoted 14 lines · kernel test robot

Hi Mateusz,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on robh/for-next]
[also build test WARNING on tty/tty-testing usb/usb-testing staging/staging-testing driver-core/driver-core-testing linus/master v5.8-rc6 next-20200724] [If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url:    https://github.com/0day-ci/linux/commits/Mateusz-Holenko/LiteX-SoC-controller-and-LiteUART-serial-driver/20200722-183024
base:   https://git.kernel.org/pub/scm/linux/kernel/git/robh/linux.git for-next
config: openrisc-randconfig-s032-20200725 (attached as .config)
compiler: or1k-linux-gcc (GCC) 9.3.0
Quoted 7 lines

reproduce:
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# apt-get install sparse
# sparse version: v0.6.2-93-g4c6cbe55-dirty
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross C=1 CF='-fdiagnostic-prefix -D__CHECK_ENDIAN__' ARCH=openrisc

Note, this is OpenRISC

Quoted 15 lines

If you fix the issue, kindly add following tag as appropriate

sparse warnings: (new ones prefixed by >>)

Quoted 9 lines
Quoted 9 lines

drivers/soc/litex/litex_soc_ctrl.c:61:24: sparse: sparse: incorrect type in argument 1 (different base types) @@ expected unsigned int [usertype] value @@ got restricted __le32 [usertype] @@
drivers/soc/litex/litex_soc_ctrl.c:61:24: sparse: expected unsigned int [usertype] value
drivers/soc/litex/litex_soc_ctrl.c:61:24: sparse: got restricted __le32 [usertype]
drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32

Quoted 3 lines
Quoted 1 line

drivers/soc/litex/litex_soc_ctrl.c: note: in included file (through arch/openrisc/include/asm/io.h, include/linux/io.h, include/linux/litex.h):

I think this is something I need to fix up in the openrisc io.h header.

There are issues with the openrisc io.h header, but after closer inspection the new warnings above do not seem to be related to this. See more notes below.

Quoted 52 lines

It seems the sparse annotations are messed up. Working on it...

-Stafford

Quoted 48 lines

include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32
include/asm-generic/io.h:225:22: sparse: sparse: incorrect type in argument 1 (different base types) @@ expected unsigned int [usertype] value @@ got restricted __le32 [usertype] @@
include/asm-generic/io.h:225:22: sparse: expected unsigned int [usertype] value
include/asm-generic/io.h:225:22: sparse: got restricted __le32 [usertype]
include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32 include/asm-generic/io.h:179:15: sparse: sparse: cast to restricted __le32

vim +61 drivers/soc/litex/litex_soc_ctrl.c

    32	
    33	/*
    34	 * LiteX SoC Generator, depending on the configuration,
    35	 * can split a single logical CSR (Control & Status Register)
    36	 * into a series of consecutive physical registers.
    37	 *
    38	 * For example, in the configuration with 8-bit CSR Bus,
    39	 * 32-bit aligned (the default one for 32-bit CPUs) a 32-bit
    40	 * logical CSR will be generated as four 32-bit physical registers,
    41	 * each one containing one byte of meaningful data.
    42	 *
    43	 * For details see: https://github.com/enjoy-digital/litex/wiki/CSR-Bus
    44	 *
    45	 * The purpose of `litex_set_reg`/`litex_get_reg` is to implement
    46	 * the logic of writing to/reading from the LiteX CSR in a single
    47	 * place that can be then reused by all LiteX drivers.
    48	 */
    49	void litex_set_reg(void __iomem *reg, unsigned long reg_size,
    50			    unsigned long val)
    51	{
    52		unsigned long shifted_data, shift, i;
    53		unsigned long flags;
    54	
    55		spin_lock_irqsave(&csr_lock, flags);
    56	
    57		for (i = 0; i < reg_size; ++i) {
    58			shift = ((reg_size - i - 1) * LITEX_SUBREG_SIZE_BIT);
    59			shifted_data = val >> shift;
    60	
Quoted 1 line

61 writel(cpu_to_le32(shifted_data), reg + (LITEX_REG_SIZE * i));

writel is defined to expect cpu endian u32 and it will internally convert it to le32. There shouldbe no need for cpu_to_le32. This is from asm-generic/io.h used by openrisc:

   #ifndef writel
   #define writel writel
   static inline void writel(u32 value, volatile void __iomem *addr)
   {
   	__io_bw();
   	__raw_writel(__cpu_to_le32(value), addr);
   	__io_aw();
   }
   #endif

The call to cpu_to_le32() is what is causing the sparse warnings above.

Quoted 8 lines
Quoted 8 lines
    62		}
    63	
    64		spin_unlock_irqrestore(&csr_lock, flags);
    65	}
    66	EXPORT_SYMBOL_GPL(litex_set_reg);
    67	
    68	unsigned long litex_get_reg(void __iomem *reg, unsigned long reg_size)
    69	{
Quoted 8 lines
Quoted 8 lines
    70		unsigned long shifted_data, shift, i;
    71		unsigned long result = 0;
    72		unsigned long flags;
    73	
    74		spin_lock_irqsave(&csr_lock, flags);
    75	
    76		for (i = 0; i < reg_size; ++i) {
Quoted 1 line

77 shifted_data = le32_to_cpu(readl(reg + (LITEX_REG_SIZE * i)));

Same issue here, readl is already returning cpu endian u32. No need to convert it to cpu.

    #ifndef readl
    #define readl readl
    static inline u32 readl(const volatile void __iomem *addr)
    {
    	u32 val;

    	__io_br();
    	val = __le32_to_cpu((__le32 __force) __raw_readl(addr));
    	__io_ar(val);
    	return val;
    }
    #endif

Note, of LE machines like riscv the le32_to_cpu and le32_to_cpu will be no-ops so this will not cause issues. But likely this is broken on OpenRISC. I have not run these drivers for a while.

-Stafford

Quoted 17 lines
Quoted 15 lines
    78	
    79			shift = ((reg_size - i - 1) * LITEX_SUBREG_SIZE_BIT);
    80			result |= (shifted_data << shift);
    81		}
    82	
    83		spin_unlock_irqrestore(&csr_lock, flags);
    84	
    85		return result;
    86	}
    87	EXPORT_SYMBOL_GPL(litex_get_reg);
    88	

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org

#7 lore raw

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

In reply to Mateusz Holenko
Thank you for the patch! Perhaps something to improve:

Hi Mateusz,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on robh/for-next]
[also build test WARNING on tty/tty-testing usb/usb-testing staging/staging-testing driver-core/driver-core-testing linus/master v5.8-rc6 next-20200724] [If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url:    https://github.com/0day-ci/linux/commits/Mateusz-Holenko/LiteX-SoC-controller-and-LiteUART-serial-driver/20200722-183024
base:   https://git.kernel.org/pub/scm/linux/kernel/git/robh/linux.git for-next
config: arc-randconfig-s032-20200726 (attached as .config)
compiler: arc-elf-gcc (GCC) 9.3.0

reproduce:
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# apt-get install sparse
# sparse version: v0.6.2-93-g4c6cbe55-dirty
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross C=1 CF='-fdiagnostic-prefix -D__CHECK_ENDIAN__' ARCH=arc

If you fix the issue, kindly add following tag as appropriate

sparse warnings: (new ones prefixed by >>)

>> drivers/soc/litex/litex_soc_ctrl.c:61:17: sparse: sparse: cast from restricted __le32
>> drivers/soc/litex/litex_soc_ctrl.c:61:17: sparse: sparse: incorrect type in argument 1 (different base types) @@     expected unsigned int [usertype] val @@     got restricted __le32 [usertype] @@
>> drivers/soc/litex/litex_soc_ctrl.c:61:17: sparse:     expected unsigned int [usertype] val
   drivers/soc/litex/litex_soc_ctrl.c:61:17: sparse:     got restricted __le32 [usertype]
>> drivers/soc/litex/litex_soc_ctrl.c:61:17: sparse: sparse: cast from restricted __le32
>> drivers/soc/litex/litex_soc_ctrl.c:61:17: sparse: sparse: cast from restricted __le32
>> drivers/soc/litex/litex_soc_ctrl.c:61:17: sparse: sparse: cast from restricted __le32
>> drivers/soc/litex/litex_soc_ctrl.c:61:17: sparse: sparse: cast from restricted __le32

drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32

vim +61 drivers/soc/litex/litex_soc_ctrl.c

    32	
    33	/*
    34	 * LiteX SoC Generator, depending on the configuration,
    35	 * can split a single logical CSR (Control & Status Register)
    36	 * into a series of consecutive physical registers.
    37	 *
    38	 * For example, in the configuration with 8-bit CSR Bus,
    39	 * 32-bit aligned (the default one for 32-bit CPUs) a 32-bit
    40	 * logical CSR will be generated as four 32-bit physical registers,
    41	 * each one containing one byte of meaningful data.
    42	 *
    43	 * For details see: https://github.com/enjoy-digital/litex/wiki/CSR-Bus
    44	 *
    45	 * The purpose of `litex_set_reg`/`litex_get_reg` is to implement
    46	 * the logic of writing to/reading from the LiteX CSR in a single
    47	 * place that can be then reused by all LiteX drivers.
    48	 */
    49	void litex_set_reg(void __iomem *reg, unsigned long reg_size,
    50			    unsigned long val)
    51	{
    52		unsigned long shifted_data, shift, i;
    53		unsigned long flags;
    54	
    55		spin_lock_irqsave(&csr_lock, flags);
    56	
    57		for (i = 0; i < reg_size; ++i) {
    58			shift = ((reg_size - i - 1) * LITEX_SUBREG_SIZE_BIT);
    59			shifted_data = val >> shift;
    60	
  > 61			writel(cpu_to_le32(shifted_data), reg + (LITEX_REG_SIZE * i));
    62		}
    63	
    64		spin_unlock_irqrestore(&csr_lock, flags);
    65	}
    66	EXPORT_SYMBOL_GPL(litex_set_reg);
    67	

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org

#8 lore raw

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

In reply to Mateusz Holenko
Thank you for the patch! Perhaps something to improve:

Hi Mateusz,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on robh/for-next]
[also build test WARNING on tty/tty-testing usb/usb-testing staging/staging-testing driver-core/driver-core-testing linus/master v5.8-rc7 next-20200727] [If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url:    https://github.com/0day-ci/linux/commits/Mateusz-Holenko/LiteX-SoC-controller-and-LiteUART-serial-driver/20200722-183024
base:   https://git.kernel.org/pub/scm/linux/kernel/git/robh/linux.git for-next
config: sparc64-randconfig-s031-20200728 (attached as .config)
compiler: sparc64-linux-gcc (GCC) 9.3.0

reproduce:
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# apt-get install sparse
# sparse version: v0.6.2-94-geb6779f6-dirty
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross C=1 CF='-fdiagnostic-prefix -D__CHECK_ENDIAN__' ARCH=sparc64

If you fix the issue, kindly add following tag as appropriate

sparse warnings: (new ones prefixed by >>)

>> drivers/soc/litex/litex_soc_ctrl.c:61:24: sparse: sparse: incorrect type in argument 1 (different base types) @@     expected unsigned int [usertype] l @@     got restricted __le32 [usertype] @@
>> drivers/soc/litex/litex_soc_ctrl.c:61:24: sparse:     expected unsigned int [usertype] l

drivers/soc/litex/litex_soc_ctrl.c:61:24: sparse: got restricted __le32 [usertype]
drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32 drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32

vim +61 drivers/soc/litex/litex_soc_ctrl.c

    32	
    33	/*
    34	 * LiteX SoC Generator, depending on the configuration,
    35	 * can split a single logical CSR (Control & Status Register)
    36	 * into a series of consecutive physical registers.
    37	 *
    38	 * For example, in the configuration with 8-bit CSR Bus,
    39	 * 32-bit aligned (the default one for 32-bit CPUs) a 32-bit
    40	 * logical CSR will be generated as four 32-bit physical registers,
    41	 * each one containing one byte of meaningful data.
    42	 *
    43	 * For details see: https://github.com/enjoy-digital/litex/wiki/CSR-Bus
    44	 *
    45	 * The purpose of `litex_set_reg`/`litex_get_reg` is to implement
    46	 * the logic of writing to/reading from the LiteX CSR in a single
    47	 * place that can be then reused by all LiteX drivers.
    48	 */
    49	void litex_set_reg(void __iomem *reg, unsigned long reg_size,
    50			    unsigned long val)
    51	{
    52		unsigned long shifted_data, shift, i;
    53		unsigned long flags;
    54	
    55		spin_lock_irqsave(&csr_lock, flags);
    56	
    57		for (i = 0; i < reg_size; ++i) {
    58			shift = ((reg_size - i - 1) * LITEX_SUBREG_SIZE_BIT);
    59			shifted_data = val >> shift;
    60	
  > 61			writel(cpu_to_le32(shifted_data), reg + (LITEX_REG_SIZE * i));
    62		}
    63	
    64		spin_unlock_irqrestore(&csr_lock, flags);
    65	}
    66	EXPORT_SYMBOL_GPL(litex_set_reg);
    67	

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org

#9 lore raw

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

In reply to Mateusz Holenko
Thank you for the patch! Perhaps something to improve:

Hi Mateusz,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on robh/for-next]
[also build test WARNING on tty/tty-testing usb/usb-testing staging/staging-testing driver-core/driver-core-testing linus/master v5.8 next-20200731] [If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url:    https://github.com/0day-ci/linux/commits/Mateusz-Holenko/LiteX-SoC-controller-and-LiteUART-serial-driver/20200722-183024
base:   https://git.kernel.org/pub/scm/linux/kernel/git/robh/linux.git for-next
config: i386-randconfig-s032-20200803 (attached as .config)
compiler: gcc-9 (Debian 9.3.0-14) 9.3.0
reproduce:
        # apt-get install sparse
        # sparse version: v0.6.2-117-g8c7aee71-dirty
        # save the attached .config to linux build tree
        make W=1 C=1 CF='-fdiagnostic-prefix -D__CHECK_ENDIAN__' ARCH=i386 

If you fix the issue, kindly add following tag as appropriate

sparse warnings: (new ones prefixed by >>)

>> drivers/soc/litex/litex_soc_ctrl.c:61:24: sparse: sparse: incorrect type in argument 1 (different base types) @@     expected unsigned int val @@     got restricted __le32 [usertype] @@
>> drivers/soc/litex/litex_soc_ctrl.c:61:24: sparse:     expected unsigned int val

drivers/soc/litex/litex_soc_ctrl.c:61:24: sparse: got restricted __le32 [usertype]
drivers/soc/litex/litex_soc_ctrl.c:77:32: sparse: sparse: cast to restricted __le32

vim +61 drivers/soc/litex/litex_soc_ctrl.c

    32	
    33	/*
    34	 * LiteX SoC Generator, depending on the configuration,
    35	 * can split a single logical CSR (Control & Status Register)
    36	 * into a series of consecutive physical registers.
    37	 *
    38	 * For example, in the configuration with 8-bit CSR Bus,
    39	 * 32-bit aligned (the default one for 32-bit CPUs) a 32-bit
    40	 * logical CSR will be generated as four 32-bit physical registers,
    41	 * each one containing one byte of meaningful data.
    42	 *
    43	 * For details see: https://github.com/enjoy-digital/litex/wiki/CSR-Bus
    44	 *
    45	 * The purpose of `litex_set_reg`/`litex_get_reg` is to implement
    46	 * the logic of writing to/reading from the LiteX CSR in a single
    47	 * place that can be then reused by all LiteX drivers.
    48	 */
    49	void litex_set_reg(void __iomem *reg, unsigned long reg_size,
    50			    unsigned long val)
    51	{
    52		unsigned long shifted_data, shift, i;
    53		unsigned long flags;
    54	
    55		spin_lock_irqsave(&csr_lock, flags);
    56	
    57		for (i = 0; i < reg_size; ++i) {
    58			shift = ((reg_size - i - 1) * LITEX_SUBREG_SIZE_BIT);
    59			shifted_data = val >> shift;
    60	
  > 61			writel(cpu_to_le32(shifted_data), reg + (LITEX_REG_SIZE * i));
    62		}
    63	
    64		spin_unlock_irqrestore(&csr_lock, flags);
    65	}
    66	EXPORT_SYMBOL_GPL(litex_set_reg);
    67	

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org

author maintainer
#10 lore raw

PATCH v9 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 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
#11 lore raw

PATCH v9 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 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