Skip to contentSkip to conversation

LiteX SoC controller and LiteUART serial driver

PATCH Superseded Mateusz Holenko 3 participants 11 messages May 27, 2020 – Jun 4, 2020

Subsystems (4)

v6 of 12 Superseded Latest is v12 →

lore
Share & tools
lore

Mateusz Holenko

author maintainer
#0 lore raw

v6 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 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                 | 399 ++++++++++++++++++
 include/linux/litex.h                         |  45 ++
 13 files changed, 781 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 v6 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 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 v6 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 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..b118ddbf04a4
@@ -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 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 v6 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 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 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 +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 v6 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:
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 v6 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:
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 | 404 ++++++++++++++++++++++++++++++++++
 4 files changed, 437 insertions(+)
 create mode 100644 drivers/tty/serial/liteuart.c
MAINTAINERS +1 -0
index 51d2d6a61fb0..d855fe807833 100644
@@ -9846,6 +9846,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 +404 -0

404 lines not on this page · raw message

Signature · 1 line
2.20.1
#6 lore raw

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

Thank you for the patch! Yet something to improve:

Hi Mateusz,

Thank you for the patch! Yet something to improve:

[auto build test ERROR on robh/for-next]
[also build test ERROR on tty/tty-testing usb/usb-testing staging/staging-testing driver-core/driver-core-testing linus/master v5.7-rc7 next-20200526] [if your patch is applied to the wrong git tree, please drop us a note to help
improve the system. BTW, we also suggest to use '--base' option to specify the
base tree in git format-patch, please see https://stackoverflow.com/a/37406982]

url:    https://github.com/0day-ci/linux/commits/Mateusz-Holenko/LiteX-SoC-controller-and-LiteUART-serial-driver/20200528-003240
base:   https://git.kernel.org/pub/scm/linux/kernel/git/robh/linux.git for-next
config: arm64-allyesconfig (attached as .config)
compiler: aarch64-linux-gcc (GCC) 9.3.0

reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross ARCH=arm64

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

All error/warnings (new ones prefixed by >>, old ones prefixed by <<):

drivers/tty/serial/liteuart.c: In function 'liteuart_probe':

>> drivers/tty/serial/liteuart.c:266:9: error: implicit declaration of function 'kzalloc'; did you mean 'vzalloc'? [-Werror=implicit-function-declaration]
266 |  uart = kzalloc(sizeof(struct liteuart_port), GFP_KERNEL);
|         ^~~~~~~
|         vzalloc
>> drivers/tty/serial/liteuart.c:266:7: warning: assignment to 'struct liteuart_port *' from 'int' makes pointer from integer without a cast [-Wint-conversion]

266 | uart = kzalloc(sizeof(struct liteuart_port), GFP_KERNEL);
| ^
cc1: some warnings being treated as errors

vim +266 drivers/tty/serial/liteuart.c

243
244 static int liteuart_probe(struct platform_device *pdev)
245 {
246 struct device_node *np = pdev->dev.of_node;
247 struct liteuart_port *uart;
248 struct uart_port *port;
249 struct xa_limit limit;
250 int dev_id, ret;
251
252 /* no device tree */
253 if (!np)
254 return -ENODEV;
255
256 if (!litex_check_accessors())
257 return -EPROBE_DEFER;
258
259 /* look for aliases; auto-enumerate for free index if not found */
260 dev_id = of_alias_get_id(np, "serial");
261 if (dev_id < 0)
262 limit = XA_LIMIT(0, CONFIG_SERIAL_LITEUART_MAX_PORTS);
263 else
264 limit = XA_LIMIT(dev_id, dev_id);
265

 > 266		uart = kzalloc(sizeof(struct liteuart_port), GFP_KERNEL);

267 if (!uart)
268 return -ENOMEM;
269
270 ret = xa_alloc(&liteuart_array, &dev_id, uart, limit, GFP_KERNEL);
271 if (ret)
272 return ret;
273
274 port = &uart->port;
275
276 /* get membase */
277 port->membase = devm_platform_get_and_ioremap_resource(pdev, 0, NULL);
278 if (!port->membase)
279 return -ENXIO;
280
281 /* values not from device tree */
282 port->dev = &pdev->dev;
283 port->iotype = UPIO_MEM;
284 port->flags = UPF_BOOT_AUTOCONF;
285 port->ops = &liteuart_ops;
286 port->regshift = 2;
287 port->fifosize = 16;
288 port->iobase = 1;
289 port->type = PORT_UNKNOWN;
290 port->line = dev_id;
291 spin_lock_init(&port->lock);
292
293 return uart_add_one_port(&liteuart_driver, &uart->port);
294 }
295

---
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 v6 5/5] drivers/tty/serial: add LiteUART driver

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

Hi Mateusz,

Thank you for the patch! Yet something to improve:

[auto build test ERROR on robh/for-next]
[also build test ERROR on tty/tty-testing usb/usb-testing staging/staging-testing driver-core/driver-core-testing linus/master v5.7-rc7 next-20200526] [if your patch is applied to the wrong git tree, please drop us a note to help
improve the system. BTW, we also suggest to use '--base' option to specify the
base tree in git format-patch, please see https://stackoverflow.com/a/37406982]

url:    https://github.com/0day-ci/linux/commits/Mateusz-Holenko/LiteX-SoC-controller-and-LiteUART-serial-driver/20200528-003240
base:   https://git.kernel.org/pub/scm/linux/kernel/git/robh/linux.git for-next
config: x86_64-allyesconfig (attached as .config)
compiler: clang version 11.0.0 (https://github.com/llvm/llvm-project 3393cc4cebf9969db94dc424b7a2b6195589c33b)

reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# install x86_64 cross compiling tool for clang build
# apt-get install binutils-x86-64-linux-gnu
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross ARCH=x86_64

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

All error/warnings (new ones prefixed by >>, old ones prefixed by <<):

>> drivers/tty/serial/liteuart.c:266:9: error: implicit declaration of function 'kzalloc' [-Werror,-Wimplicit-function-declaration]

uart = kzalloc(sizeof(struct liteuart_port), GFP_KERNEL); ^
drivers/tty/serial/liteuart.c:266:9: note: did you mean 'vzalloc'? include/linux/vmalloc.h:106:14: note: 'vzalloc' declared here extern void *vzalloc(unsigned long size);
^

>> drivers/tty/serial/liteuart.c:266:7: warning: incompatible integer to pointer conversion assigning to 'struct liteuart_port *' from 'int' [-Wint-conversion]

uart = kzalloc(sizeof(struct liteuart_port), GFP_KERNEL); ^ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1 warning and 1 error generated.

vim +/kzalloc +266 drivers/tty/serial/liteuart.c

243
244 static int liteuart_probe(struct platform_device *pdev)
245 {
246 struct device_node *np = pdev->dev.of_node;
247 struct liteuart_port *uart;
248 struct uart_port *port;
249 struct xa_limit limit;
250 int dev_id, ret;
251
252 /* no device tree */
253 if (!np)
254 return -ENODEV;
255
256 if (!litex_check_accessors())
257 return -EPROBE_DEFER;
258
259 /* look for aliases; auto-enumerate for free index if not found */
260 dev_id = of_alias_get_id(np, "serial");
261 if (dev_id < 0)
262 limit = XA_LIMIT(0, CONFIG_SERIAL_LITEUART_MAX_PORTS);
263 else
264 limit = XA_LIMIT(dev_id, dev_id);
265

 > 266		uart = kzalloc(sizeof(struct liteuart_port), GFP_KERNEL);

267 if (!uart)
268 return -ENOMEM;
269
270 ret = xa_alloc(&liteuart_array, &dev_id, uart, limit, GFP_KERNEL);
271 if (ret)
272 return ret;
273
274 port = &uart->port;
275
276 /* get membase */
277 port->membase = devm_platform_get_and_ioremap_resource(pdev, 0, NULL);
278 if (!port->membase)
279 return -ENXIO;
280
281 /* values not from device tree */
282 port->dev = &pdev->dev;
283 port->iotype = UPIO_MEM;
284 port->flags = UPF_BOOT_AUTOCONF;
285 port->ops = &liteuart_ops;
286 port->regshift = 2;
287 port->fifosize = 16;
288 port->iobase = 1;
289 port->type = PORT_UNKNOWN;
290 port->line = dev_id;
291 spin_lock_init(&port->lock);
292
293 return uart_add_one_port(&liteuart_driver, &uart->port);
294 }
295

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

author maintainer
#8 lore raw

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

In reply to Mateusz Holenko
Quoted 126 lines · 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:
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 | 404 ++++++++++++++++++++++++++++++++++
 4 files changed, 437 insertions(+)
 create mode 100644 drivers/tty/serial/liteuart.c
MAINTAINERS +1 -0
index 51d2d6a61fb0..d855fe807833 100644
@@ -9846,6 +9846,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 +8 -0
new file mode 100644
index 000000000000..22b7612c13ca
@@ -0,0 +1,404 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * LiteUART serial controller (LiteX) Driver
+ *
+ * Copyright (C) 2019-2020 Antmicro <www.antmicro.com>
+ */
+
+#include <linux/console.h>

drivers/tty/serial/liteuart.c line 18

Quoted 10 lines
drivers/tty/serial/liteuart.c new file +10 -0
+#include <linux/module.h>
+#include <linux/of.h>
+#include <linux/of_address.h>
+#include <linux/of_platform.h>
+#include <linux/serial.h>
+#include <linux/serial_core.h>
+#include <linux/timer.h>
+#include <linux/tty_flip.h>
+#include <linux/litex.h>
+#include <linux/xarray.h>

kbuild test robot reported problems with this patch, namely: implicit declaration of function 'kzalloc'
This is caused by the missing include directive. When I was testing it I must have missed the warning, but the compilation succeeded and the resulting binary worked fine on HW (LiteX/mor1kx platform). The fix is a simple one-liner, adding a new include:

+#include <linux/slab.h>

Since this is a very small fix and does not modify the actual code of the driver I want to wait for more feedback on all patches in the series before resubmitting, in order to limit traffic on the list. Or should I generate the next version and resend the whole patchset with this single fix, as otherwise it won't be reviewed at all?

Quoted 387 lines
drivers/tty/serial/liteuart.c new file +386 -1
+
+/*
+ * CSRs definitions (base address offsets + width)
+ *
+ * The definitions below are true for LiteX SoC configured for 8-bit CSR Bus,
+ * 32-bit aligned.
+ *
+ * Supporting other configurations might require new definitions or a more
+ * generic way of indexing the LiteX CSRs.
+ *
+ * For more details on how CSRs are defined and handled in LiteX, see comments
+ * in the LiteX SoC Driver: drivers/soc/litex/litex_soc_ctrl.c
+ */
+#define OFF_RXTX       0x00
+#define OFF_TXFULL     0x04
+#define OFF_RXEMPTY    0x08
+#define OFF_EV_STATUS  0x0c
+#define OFF_EV_PENDING 0x10
+#define OFF_EV_ENABLE  0x14
+
+/* events */
+#define EV_TX          0x1
+#define EV_RX          0x2
+
+struct liteuart_port {
+       struct uart_port port;
+       struct timer_list timer;
+};
+
+#define to_liteuart_port(port) container_of(port, struct liteuart_port, port)
+
+static DEFINE_XARRAY_FLAGS(liteuart_array, XA_FLAGS_ALLOC);
+
+#ifdef CONFIG_SERIAL_LITEUART_CONSOLE
+static struct console liteuart_console;
+#endif
+
+static struct uart_driver liteuart_driver = {
+       .owner = THIS_MODULE,
+       .driver_name = "liteuart",
+       .dev_name = "ttyLXU",
+       .major = 0,
+       .minor = 0,
+       .nr = CONFIG_SERIAL_LITEUART_MAX_PORTS,
+#ifdef CONFIG_SERIAL_LITEUART_CONSOLE
+       .cons = &liteuart_console,
+#endif
+};
+
+static void liteuart_timer(struct timer_list *t)
+{
+       struct liteuart_port *uart = from_timer(uart, t, timer);
+       struct uart_port *port = &uart->port;
+       unsigned char __iomem *membase = port->membase;
+       unsigned int flg = TTY_NORMAL;
+       int ch;
+       unsigned long status;
+
+       while ((status = !litex_get_reg(membase + OFF_RXEMPTY, 1)) == 1) {
+               ch = litex_get_reg(membase + OFF_RXTX, 1);
+               port->icount.rx++;
+
+               /* necessary for RXEMPTY to refresh its value */
+               litex_set_reg(membase + OFF_EV_PENDING, 1, EV_TX | EV_RX);
+
+               /* no overflow bits in status */
+               if (!(uart_handle_sysrq_char(port, ch)))
+                       uart_insert_char(port, status, 0, ch, flg);
+
+               tty_flip_buffer_push(&port->state->port);
+       }
+
+       mod_timer(&uart->timer, jiffies + uart_poll_timeout(port));
+}
+
+static void liteuart_putchar(struct uart_port *port, int ch)
+{
+       while (litex_get_reg(port->membase + OFF_TXFULL, 1))
+               cpu_relax();
+
+       litex_set_reg(port->membase + OFF_RXTX, 1, ch);
+}
+
+static unsigned int liteuart_tx_empty(struct uart_port *port)
+{
+       /* not really tx empty, just checking if tx is not full */
+       if (!litex_get_reg(port->membase + OFF_TXFULL, 1))
+               return TIOCSER_TEMT;
+
+       return 0;
+}
+
+static void liteuart_set_mctrl(struct uart_port *port, unsigned int mctrl)
+{
+       /* modem control register is not present in LiteUART */
+}
+
+static unsigned int liteuart_get_mctrl(struct uart_port *port)
+{
+       return TIOCM_CTS | TIOCM_DSR | TIOCM_CAR;
+}
+
+static void liteuart_stop_tx(struct uart_port *port)
+{
+}
+
+static void liteuart_start_tx(struct uart_port *port)
+{
+       struct circ_buf *xmit = &port->state->xmit;
+       unsigned char ch;
+
+       if (unlikely(port->x_char)) {
+               litex_set_reg(port->membase + OFF_RXTX, 1, port->x_char);
+               port->icount.tx++;
+               port->x_char = 0;
+       } else if (!uart_circ_empty(xmit)) {
+               while (xmit->head != xmit->tail) {
+                       ch = xmit->buf[xmit->tail];
+                       xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
+                       port->icount.tx++;
+                       liteuart_putchar(port, ch);
+               }
+       }
+
+       if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
+               uart_write_wakeup(port);
+}
+
+static void liteuart_stop_rx(struct uart_port *port)
+{
+       struct liteuart_port *uart = to_liteuart_port(port);
+
+       /* just delete timer */
+       del_timer(&uart->timer);
+}
+
+static void liteuart_break_ctl(struct uart_port *port, int break_state)
+{
+       /* LiteUART doesn't support sending break signal */
+}
+
+static int liteuart_startup(struct uart_port *port)
+{
+       struct liteuart_port *uart = to_liteuart_port(port);
+
+       /* disable events */
+       litex_set_reg(port->membase + OFF_EV_ENABLE, 1, 0);
+
+       /* prepare timer for polling */
+       timer_setup(&uart->timer, liteuart_timer, 0);
+       mod_timer(&uart->timer, jiffies + uart_poll_timeout(port));
+
+       return 0;
+}
+
+static void liteuart_shutdown(struct uart_port *port)
+{
+}
+
+static void liteuart_set_termios(struct uart_port *port, struct ktermios *new,
+                                struct ktermios *old)
+{
+       unsigned int baud;
+       unsigned long flags;
+
+       spin_lock_irqsave(&port->lock, flags);
+
+       /* update baudrate */
+       baud = uart_get_baud_rate(port, new, old, 0, 460800);
+       uart_update_timeout(port, new->c_cflag, baud);
+
+       spin_unlock_irqrestore(&port->lock, flags);
+}
+
+static const char *liteuart_type(struct uart_port *port)
+{
+       return "liteuart";
+}
+
+static void liteuart_release_port(struct uart_port *port)
+{
+}
+
+static int liteuart_request_port(struct uart_port *port)
+{
+       return 0;
+}
+
+static void liteuart_config_port(struct uart_port *port, int flags)
+{
+       /*
+        * Driver core for serial ports forces a non-zero value for port type.
+        * Write an arbitrary value here to accommodate the serial core driver,
+        * as ID part of UAPI is redundant.
+        */
+       port->type = 1;
+}
+
+static int liteuart_verify_port(struct uart_port *port,
+                               struct serial_struct *ser)
+{
+       if (port->type != PORT_UNKNOWN && ser->type != 1)
+               return -EINVAL;
+
+       return 0;
+}
+
+static const struct uart_ops liteuart_ops = {
+       .tx_empty       = liteuart_tx_empty,
+       .set_mctrl      = liteuart_set_mctrl,
+       .get_mctrl      = liteuart_get_mctrl,
+       .stop_tx        = liteuart_stop_tx,
+       .start_tx       = liteuart_start_tx,
+       .stop_rx        = liteuart_stop_rx,
+       .break_ctl      = liteuart_break_ctl,
+       .startup        = liteuart_startup,
+       .shutdown       = liteuart_shutdown,
+       .set_termios    = liteuart_set_termios,
+       .type           = liteuart_type,
+       .release_port   = liteuart_release_port,
+       .request_port   = liteuart_request_port,
+       .config_port    = liteuart_config_port,
+       .verify_port    = liteuart_verify_port,
+};
+
+static int liteuart_probe(struct platform_device *pdev)
+{
+       struct device_node *np = pdev->dev.of_node;
+       struct liteuart_port *uart;
+       struct uart_port *port;
+       struct xa_limit limit;
+       int dev_id, ret;
+
+       /* no device tree */
+       if (!np)
+               return -ENODEV;
+
+       if (!litex_check_accessors())
+               return -EPROBE_DEFER;
+
+       /* look for aliases; auto-enumerate for free index if not found */
+       dev_id = of_alias_get_id(np, "serial");
+       if (dev_id < 0)
+               limit = XA_LIMIT(0, CONFIG_SERIAL_LITEUART_MAX_PORTS);
+       else
+               limit = XA_LIMIT(dev_id, dev_id);
+
+       uart = kzalloc(sizeof(struct liteuart_port), GFP_KERNEL);
+       if (!uart)
+               return -ENOMEM;
+
+       ret = xa_alloc(&liteuart_array, &dev_id, uart, limit, GFP_KERNEL);
+       if (ret)
+               return ret;
+
+       port = &uart->port;
+
+       /* get membase */
+       port->membase = devm_platform_get_and_ioremap_resource(pdev, 0, NULL);
+       if (!port->membase)
+               return -ENXIO;
+
+       /* values not from device tree */
+       port->dev = &pdev->dev;
+       port->iotype = UPIO_MEM;
+       port->flags = UPF_BOOT_AUTOCONF;
+       port->ops = &liteuart_ops;
+       port->regshift = 2;
+       port->fifosize = 16;
+       port->iobase = 1;
+       port->type = PORT_UNKNOWN;
+       port->line = dev_id;
+       spin_lock_init(&port->lock);
+
+       return uart_add_one_port(&liteuart_driver, &uart->port);
+}
+
+static int liteuart_remove(struct platform_device *pdev)
+{
+       return 0;
+}
+
+static const struct of_device_id liteuart_of_match[] = {
+       { .compatible = "litex,liteuart" },
+       {}
+};
+MODULE_DEVICE_TABLE(of, liteuart_of_match);
+
+static struct platform_driver liteuart_platform_driver = {
+       .probe = liteuart_probe,
+       .remove = liteuart_remove,
+       .driver = {
+               .name = "liteuart",
+               .of_match_table = liteuart_of_match,
+       },
+};
+
+#ifdef CONFIG_SERIAL_LITEUART_CONSOLE
+
+static void liteuart_console_write(struct console *co, const char *s,
+       unsigned int count)
+{
+       struct liteuart_port *uart;
+       struct uart_port *port;
+       unsigned long flags;
+
+       uart = (struct liteuart_port *)xa_load(&liteuart_array, co->index);
+       port = &uart->port;
+
+       spin_lock_irqsave(&port->lock, flags);
+       uart_console_write(port, s, count, liteuart_putchar);
+       spin_unlock_irqrestore(&port->lock, flags);
+}
+
+static int liteuart_console_setup(struct console *co, char *options)
+{
+       struct liteuart_port *uart;
+       struct uart_port *port;
+       int baud = 115200;
+       int bits = 8;
+       int parity = 'n';
+       int flow = 'n';
+
+       uart = (struct liteuart_port *)xa_load(&liteuart_array, co->index);
+       if (!uart)
+               return -ENODEV;
+
+       port = &uart->port;
+       if (!port->membase)
+               return -ENODEV;
+
+       if (options)
+               uart_parse_options(options, &baud, &parity, &bits, &flow);
+
+       return uart_set_options(port, co, baud, parity, bits, flow);
+}
+
+static struct console liteuart_console = {
+       .name = "liteuart",
+       .write = liteuart_console_write,
+       .device = uart_console_device,
+       .setup = liteuart_console_setup,
+       .flags = CON_PRINTBUFFER,
+       .index = -1,
+       .data = &liteuart_driver,
+};
+
+static int __init liteuart_console_init(void)
+{
+       register_console(&liteuart_console);
+
+       return 0;
+}
+console_initcall(liteuart_console_init);
+#endif /* CONFIG_SERIAL_LITEUART_CONSOLE */
+
+static int __init liteuart_init(void)
+{
+       int res;
+
+       res = uart_register_driver(&liteuart_driver);
+       if (res)
+               return res;
+
+       res = platform_driver_register(&liteuart_platform_driver);
+       if (res) {
+               uart_unregister_driver(&liteuart_driver);
+               return res;
+       }
+
+       return 0;
+}
+
+static void __exit liteuart_exit(void)
+{
+       platform_driver_unregister(&liteuart_platform_driver);
+       uart_unregister_driver(&liteuart_driver);
+}
+
+module_init(liteuart_init);
+module_exit(liteuart_exit);
+
+MODULE_AUTHOR("Antmicro <www.antmicro.com>");
+MODULE_DESCRIPTION("LiteUART serial driver");
+MODULE_LICENSE("GPL v2");
+MODULE_ALIAS("platform: liteuart");
--
Quoted 2 lines

2.20.1

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

#9 lore raw

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

Quoted 145 lines · Mateusz Holenko
Quoted 126 lines · 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:
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 | 404 ++++++++++++++++++++++++++++++++++
 4 files changed, 437 insertions(+)
 create mode 100644 drivers/tty/serial/liteuart.c
MAINTAINERS +1 -0
index 51d2d6a61fb0..d855fe807833 100644
@@ -9846,6 +9846,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 +8 -0
new file mode 100644
index 000000000000..22b7612c13ca
@@ -0,0 +1,404 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * LiteUART serial controller (LiteX) Driver
+ *
+ * Copyright (C) 2019-2020 Antmicro <www.antmicro.com>
+ */
+
+#include <linux/console.h>

drivers/tty/serial/liteuart.c line 18

Quoted 10 lines
drivers/tty/serial/liteuart.c new file +10 -0
+#include <linux/module.h>
+#include <linux/of.h>
+#include <linux/of_address.h>
+#include <linux/of_platform.h>
+#include <linux/serial.h>
+#include <linux/serial_core.h>
+#include <linux/timer.h>
+#include <linux/tty_flip.h>
+#include <linux/litex.h>
+#include <linux/xarray.h>

kbuild test robot reported problems with this patch, namely: implicit declaration of function 'kzalloc'
This is caused by the missing include directive. When I was testing it I must have missed the warning, but the compilation succeeded and the resulting binary worked fine on HW (LiteX/mor1kx platform). The fix is a simple one-liner, adding a new include:

Quoted 7 lines

+#include <linux/slab.h>

Since this is a very small fix and does not modify the actual code of the driver I want to wait for more feedback on all patches in the series before resubmitting, in order to limit traffic on the list. Or should I generate the next version and resend the whole patchset with this single fix, as otherwise it won't be reviewed at all?

Please fix up and resend. We can't do anything until after 5.8-rc1 is out anyway...

thanks,

greg k-h

author maintainer
#10 lore raw

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

Quoted 155 lines · Greg Kroah-Hartman
Quoted 145 lines · Mateusz Holenko
Quoted 126 lines · 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:
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 | 404 ++++++++++++++++++++++++++++++++++
 4 files changed, 437 insertions(+)
 create mode 100644 drivers/tty/serial/liteuart.c
MAINTAINERS +1 -0
index 51d2d6a61fb0..d855fe807833 100644
@@ -9846,6 +9846,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 +8 -0
new file mode 100644
index 000000000000..22b7612c13ca
@@ -0,0 +1,404 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * LiteUART serial controller (LiteX) Driver
+ *
+ * Copyright (C) 2019-2020 Antmicro <www.antmicro.com>
+ */
+
+#include <linux/console.h>

drivers/tty/serial/liteuart.c line 18

Quoted 10 lines
drivers/tty/serial/liteuart.c new file +10 -0
+#include <linux/module.h>
+#include <linux/of.h>
+#include <linux/of_address.h>
+#include <linux/of_platform.h>
+#include <linux/serial.h>
+#include <linux/serial_core.h>
+#include <linux/timer.h>
+#include <linux/tty_flip.h>
+#include <linux/litex.h>
+#include <linux/xarray.h>

kbuild test robot reported problems with this patch, namely: implicit declaration of function 'kzalloc'
This is caused by the missing include directive. When I was testing it I must have missed the warning, but the compilation succeeded and the resulting binary worked fine on HW (LiteX/mor1kx platform). The fix is a simple one-liner, adding a new include:

Quoted 7 lines

+#include <linux/slab.h>

Since this is a very small fix and does not modify the actual code of the driver I want to wait for more feedback on all patches in the series before resubmitting, in order to limit traffic on the list. Or should I generate the next version and resend the whole patchset with this single fix, as otherwise it won't be reviewed at all?

Quoted 6 lines

Please fix up and resend. We can't do anything until after 5.8-rc1 is out anyway...

thanks,

greg k-h

Sure, thanks for the prompt response!

Best,
Mateusz Hołenko

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