LiteX SoC controller and LiteUART serial driver
Subsystems (3)
Mateusz Holenko
maintainerv3 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 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 | 46 ++ .../devicetree/bindings/vendor-prefixes.yaml | 2 + MAINTAINERS | 9 + drivers/soc/Kconfig | 1 + drivers/soc/Makefile | 1 + drivers/soc/litex/Kconfig | 14 + drivers/soc/litex/Makefile | 3 + drivers/soc/litex/litex_soc_ctrl.c | 233 ++++++++++ drivers/tty/serial/Kconfig | 32 +- drivers/tty/serial/Makefile | 1 + drivers/tty/serial/liteuart.c | 411 ++++++++++++++++++ include/linux/litex.h | 45 ++ include/uapi/linux/serial_core.h | 3 + 14 files changed, 838 insertions(+), 1 deletion(-) 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.0
Mateusz Holenko
maintainerPATCH v3 1/5 dt-bindings: vendor: add vendor prefix for LiteX
From: Filip Kokosinski <[email protected]>
Add vendor prefix for LiteX SoC builder.
---
Notes:
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
@@ -549,6 +549,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.0
Mateusz Holenko
maintainerPATCH v3 2/5 dt-bindings: soc: document LiteX SoC Controller bindings
In reply to Mateusz HolenkoFrom: Pawel Czarnecki <[email protected]>
Add documentation for LiteX SoC Controller bindings.
---
Notes:
This commit has been introduced in v3 of the patchset.
.../soc/litex/litex,soc_controller.yaml | 46 +++++++++++++++++++ MAINTAINERS | 6 +++ 2 files changed, 52 insertions(+) create mode 100644 Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml new file +46 -0
@@ -0,0 +1,46 @@ +PDX-License-Identifier: GPL-2.0 +%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: + description: Base address and length of the register space + + status: + description: | + disables or enables node + + const: "okay" + +required: + - compatible + - reg + - status + +examples: + - | + + soc_ctrl0: soc_controller@f0000000 { + compatible = "litex,soc_controller"; + reg = <0x0 0xf0000000 0x0 0xC>; + status = "okay"; + }; + +...
MAINTAINERS +6 -0
@@ -9725,6 +9725,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.0
Re: [PATCH v3 2/5] dt-bindings: soc: document LiteX SoC Controller bindings
Hi Mateusz,
Quoted 33 lines · Mateusz Holenko
From: Pawel Czarnecki <[email protected]>
Add documentation for LiteX SoC Controller bindings.
Signed-off-by Pawel Czarnecki <[email protected]>Signed-off-by Mateusz Holenko <[email protected]>---
Notes:
This commit has been introduced in v3 of the patchset..../soc/litex/litex,soc_controller.yaml | 46 +++++++++++++++++++ MAINTAINERS | 6 +++ 2 files changed, 52 insertions(+) create mode 100644 Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yamlDocumentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml new file +11
-0@@ -0,0 +1,46 @@ +PDX-License-Identifier: GPL-2.0 +%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
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml line 21
Quoted 10 lines
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml new file +10
-0+ 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
Usually compatible will use dash as separators, not underscores.
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml line 24
Quoted 2 lines
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml new file +2
-0+ reg: + description: Base address and length of the register space
This is usually removed since it's what's expected from the property anyway. However, what you should really test for in the number of address/size couples being set, and you can do that using maxItems: 1
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml line 30
Quoted 5 lines
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml new file +5
-0+ status: + description: | + disables or enables node + + const: "okay"
This is added automatically by the tooling, so you can leave it out.
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml line 35
Quoted 4 lines
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml new file +4
-0+required: + - compatible + - reg + - status
And in general, status is not required. Leaving status out is equivalent to status = "okay"
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml line 44
Quoted 8 lines
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml new file +8
-0+examples: + - | + + soc_ctrl0: soc_controller@f0000000 { + compatible = "litex,soc_controller"; + reg = <0x0 0xf0000000 0x0 0xC>; + status = "okay"; + };
The indentation looks weird here?
Maxime
Mateusz Holenko
maintainerRe: [PATCH v3 2/5] dt-bindings: soc: document LiteX SoC Controller bindings
Hi Maxime,
Quoted 84 lines · Maxime Ripard
Hi Mateusz,
Quoted 33 lines · Mateusz Holenko
From: Pawel Czarnecki <[email protected]>
Add documentation for LiteX SoC Controller bindings.
Signed-off-by Pawel Czarnecki <[email protected]>Signed-off-by Mateusz Holenko <[email protected]>---
Notes:
This commit has been introduced in v3 of the patchset..../soc/litex/litex,soc_controller.yaml | 46 +++++++++++++++++++ MAINTAINERS | 6 +++ 2 files changed, 52 insertions(+) create mode 100644 Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yamlDocumentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml new file +11
-0@@ -0,0 +1,46 @@ +PDX-License-Identifier: GPL-2.0 +%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) accessDocumentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml line 21
Quoted 10 lines
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml new file +10
-0+ 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_controllerUsually compatible will use dash as separators, not underscores.
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml line 24
Quoted 2 lines
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml new file +2
-0+ reg: + description: Base address and length of the register spaceThis is usually removed since it's what's expected from the property anyway. However, what you should really test for in the number of address/size couples being set, and you can do that using maxItems: 1
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml line 30
Quoted 5 lines
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml new file +5
-0+ status: + description: | + disables or enables node + + const: "okay"This is added automatically by the tooling, so you can leave it out.
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml line 35
Quoted 4 lines
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml new file +4
-0+required: + - compatible + - reg + - statusAnd in general, status is not required. Leaving status out is equivalent to status = "okay"
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml line 44
Quoted 8 lines
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml new file +8
-0+examples: + - | + + soc_ctrl0: soc_controller@f0000000 { + compatible = "litex,soc_controller"; + reg = <0x0 0xf0000000 0x0 0xC>; + status = "okay"; + };The indentation looks weird here?
Quoted 1 line
Maxime
Thanks for all the comments!
I'll fix this file and resubmit the whole patchset after addressing other remarks.
--
Mateusz Holenko
Antmicro Ltd | www.antmicro.com
Roosevelta 22, 60-829 Poznan, Poland
Rob Herring
maintainerRe: [PATCH v3 2/5] dt-bindings: soc: document LiteX SoC Controller bindings
In reply to Mateusz HolenkoQuoted 8 lines · Mateusz Holenko
From: Pawel Czarnecki <[email protected]>
Add documentation for LiteX SoC Controller bindings.
Signed-off-by Pawel Czarnecki <[email protected]>Signed-off-by Mateusz Holenko <[email protected]>---
Quoted 8 lines
Notes:
This commit has been introduced in v3 of the patchset..../soc/litex/litex,soc_controller.yaml | 46 +++++++++++++++++++ MAINTAINERS | 6 +++ 2 files changed, 52 insertions(+) create mode 100644 Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml
My bot found errors running 'make dt_binding_check' on your patch:
warning: no schema found in file: Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml: ignoring, error parsing file Documentation/devicetree/bindings/display/simple-framebuffer.example.dts:21.16-37.11: Warning (chosen_node_is_root): /example-0/chosen: chosen node must be at root node Traceback (most recent call last):
File "/usr/local/bin/dt-doc-validate", line 35, in check_doc
testtree = dtschema.load(filename, line_number=line_number, duplicate_keys=False)
File "/usr/local/lib/python3.6/dist-packages/dtschema/lib.py", line 513, in load
return yaml.load(f.read())
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/main.py", line 343, in load
return constructor.get_single_data()
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/constructor.py", line 111, in get_single_data
node = self.composer.get_single_node()
File "_ruamel_yaml.pyx", line 718, in _ruamel_yaml.CParser.get_single_node
ruamel.yaml.composer.ComposerError: expected a single document in the stream
in "<unicode string>", line 1, column 1
but found another document
in "<unicode string>", line 2, column 1
During handling of the above exception, another exception occurred:
Traceback (most recent call last):
File "/usr/local/bin/dt-doc-validate", line 74, in <module>
ret = check_doc(args.yamldt)
File "/usr/local/bin/dt-doc-validate", line 40, in check_doc
print(filename + ":", exc.path[-1], exc.message)
AttributeError: 'ComposerError' object has no attribute 'path'Documentation/devicetree/bindings/Makefile:12: recipe for target 'Documentation/devicetree/bindings/soc/litex/litex,soc_controller.example.dts' failed make[1]: *** [Documentation/devicetree/bindings/soc/litex/litex,soc_controller.example.dts] Error 1
Makefile:1263: recipe for target 'dt_binding_check' failed
make: *** [dt_binding_check] Error 2
See https://patchwork.ozlabs.org/patch/1243930
Please check and re-submit.
Mateusz Holenko
maintainerRe: [PATCH v3 2/5] dt-bindings: soc: document LiteX SoC Controller bindings
Quoted 46 lines · Rob Herring
Quoted 8 lines · Mateusz Holenko
From: Pawel Czarnecki <[email protected]>
Add documentation for LiteX SoC Controller bindings.
Signed-off-by Pawel Czarnecki <[email protected]>Signed-off-by Mateusz Holenko <[email protected]>---
Quoted 8 lines
Notes:
This commit has been introduced in v3 of the patchset..../soc/litex/litex,soc_controller.yaml | 46 +++++++++++++++++++ MAINTAINERS | 6 +++ 2 files changed, 52 insertions(+) create mode 100644 Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yamlMy bot found errors running 'make
dt_binding_check' on your patch:warning: no schema found in file:
Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml: ignoring, error parsing file Documentation/devicetree/bindings/display/simple-framebuffer.example.dts:21.16-37.11: Warning (chosen_node_is_root): /example-0/chosen: chosen node must be at root node Traceback (most recent call last):
File "/usr/local/bin/dt-doc-validate", line 35, incheck_doc
testtree =dtschema.load(filename, line_number=line_number, duplicate_keys=False)
File "/usr/local/lib/python3.6/dist-packages/dtschema/lib.py", line 513, in load
return yaml.load(f.read())
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/main.py", line 343, in load
returnconstructor.get_single_data()
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/constructor.py", line 111, inget_single_data
node =self.composer.get_single_node()
File "_ruamel_yaml.pyx", line 718, in _ruamel_yaml.CParser.get_single_node
ruamel.yaml.composer.ComposerError: expected a single document in the stream
in "<unicode string>", line 1, column 1
but found another document
in "<unicode string>", line 2, column 1During handling of the above exception, another exception occurred:
Traceback (most recent call last):
File "/usr/local/bin/dt-doc-validate", line 74, in <module>
ret =check_doc(args.yamldt)
File "/usr/local/bin/dt-doc-validate", line 40, incheck_docprint(filename + ":", exc.path[-1], exc.message)
Quoted 8 lines
AttributeError: 'ComposerError' object has no attribute 'path'
Documentation/devicetree/bindings/Makefile:12: recipe for target 'Documentation/devicetree/bindings/soc/litex/litex,soc_controller.example.dts' failed make[1]: *** [Documentation/devicetree/bindings/soc/litex/litex,soc_controller.example.dts] Error 1
Makefile:1263: recipe for target 'dt_binding_check' failed
make: *** [dt_binding_check] Error 2See https://patchwork.ozlabs.org/patch/1243930
Please check and re-submit.
Thanks for spotting this.
It looks like the first line of the document is broken - it should be a comment with a license descriptor, but the initial characters are missing.
I'll fix this and resubmit the whole patchset after addressing all other remarks.
Signature · 3 lines
Mateusz Holenko Antmicro Ltd | www.antmicro.com Roosevelta 22, 60-829 Poznan, Poland
Mateusz Holenko
maintainerPATCH v3 3/5 drivers/soc/litex: add LiteX SoC Controller driver
In reply to Mateusz HolenkoFrom: Pawel Czarnecki <[email protected]>
This commit adds driver for the FPGA-based LiteX SoC Controller from LiteX SoC builder.
---
Notes:
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 | 14 ++ drivers/soc/litex/Makefile | 3 + drivers/soc/litex/litex_soc_ctrl.c | 233 +++++++++++++++++++++++++++++ include/linux/litex.h | 45 ++++++ 7 files changed, 299 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
@@ -9730,6 +9730,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
@@ -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
@@ -14,6 +14,7 @@ obj-$(CONFIG_ARCH_GEMINI) += gemini/ obj-$(CONFIG_ARCH_MXC) += 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 +14 -0
@@ -0,0 +1,14 @@ +# SPDX-License_Identifier: GPL-2.0 + +menu "Enable LiteX SoC Builder specific drivers" + +config LITEX_SOC_CONTROLLER + tristate "Enable LiteX SoC Controller driver" + 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
@@ -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 +233 -0
233 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.0
Re: [PATCH v3 3/5] drivers/soc/litex: add LiteX SoC Controller driver
Quoted 141 lines · Mateusz Holenko
From: Pawel Czarnecki <[email protected]>
This commit adds driver for the FPGA-based LiteX SoC Controller from LiteX SoC builder.
Co-developed-by Mateusz Holenko <[email protected]>Signed-off-by Mateusz Holenko <[email protected]>Signed-off-by Pawel Czarnecki <[email protected]>---
Notes:
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 | 14 ++ drivers/soc/litex/Makefile | 3 + drivers/soc/litex/litex_soc_ctrl.c | 233 +++++++++++++++++++++++++++++ include/linux/litex.h | 45 ++++++ 7 files changed, 299 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.hMAINTAINERS +2
-0@@ -9730,6 +9730,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@@ -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@@ -14,6 +14,7 @@ obj-$(CONFIG_ARCH_GEMINI) += gemini/ obj-$(CONFIG_ARCH_MXC) += 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 +14
-0@@ -0,0 +1,14 @@ +# SPDX-License_Identifier: GPL-2.0 + +menu "Enable LiteX SoC Builder specific drivers" + +config LITEX_SOC_CONTROLLER + tristate "Enable LiteX SoC Controller driver" + 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 + +endmenudrivers/soc/litex/Makefile new file +3
-0@@ -0,0 +1,3 @@ +# SPDX-License_Identifier: GPL-2.0 + +obj-$(CONFIG_LITEX_SOC_CONTROLLER) += litex_soc_ctrl.odrivers/soc/litex/litex_soc_ctrl.c new file +40
-0@@ -0,0 +1,233 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* LiteX SoC Controller Driver +* +* Copyright (C) 2020 Antmicro +* +*/ + +#include <linux/litex.h> +#include <linux/device.h> +#include <linux/errno.h> +#include <linux/of.h> +#include <linux/of_platform.h> +#include <linux/platform_device.h> +#include <linux/printk.h> +#include <linux/module.h> +#include <linux/errno.h> +#include <linux/io.h> + +/* +* The parameters below are true for LiteX SoC +* configured for 8-bit CSR Bus, 32-bit aligned. +* +* Supporting other configurations will require +* extending the logic in this header. +*/ +#define LITEX_REG_SIZE 0x4 +#define LITEX_SUBREG_SIZE 0x1 +#define LITEX_SUBREG_SIZE_BIT (LITEX_SUBREG_SIZE * 8) + +static DEFINE_SPINLOCK (csr_lock); + +static inline unsigned long read_pointer_with_barrier ( +const volatile void __iomem *addr) +{ +unsigned long val; + +__io_br (); + val = *(const volatile unsigned long __force *)addr; +__io_ar ();
drivers/soc/litex/litex_soc_ctrl.c line 50
Quoted 10 lines
drivers/soc/litex/litex_soc_ctrl.c new file +10
-0+return val; +} + +static inline void write_pointer_with_barrier ( +volatile void __iomem *addr,unsigned long val) +{ +__io_br (); + *(volatile unsigned long __force *)addr = val; +__io_ar (); +}
What's wrong with readl/writel ?
Quoted 44 lines
drivers/soc/litex/litex_soc_ctrl.c new file +44
-0+/* +* LiteX SoC Generator, depending on the configuration, +* can split a single logical CSR (Control & Status Register) +* into a series of consecutive physical registers. +* +* For example, in the configuration with 8-bit CSR Bus, +* 32-bit aligned (the default one for 32-bit CPUs) a 32-bit +* logical CSR will be generated as four 32-bit physical registers, +* each one containing one byte of meaningful data. +* +* For details see: https://github.com/enjoy-digital/litex/issues/314 +* +* The purpose of `litex_set_reg`/`litex_get_reg` is to implement +* the logic of writing to/reading from the LiteX CSR in a single +* place that can be then reused by all LiteX drivers. +*/ +void litex_set_reg ( +void __iomem *reg,unsigned long reg_size,unsigned long val) +{ +unsigned long shifted_data, shift, i; +unsigned long flags; + +spin_lock_irqsave (&csr_lock, flags); + +for (i =0 ; i < reg_size; ++i) { + shift = ((reg_size - i -1 ) *LITEX_SUBREG_SIZE_BIT ); + shifted_data = val >> shift; +write_pointer_with_barrier ( + reg + (LITEX_REG_SIZE * i), shifted_data); + } + +spin_unlock_irqrestore (&csr_lock, flags); +} + +unsigned long litex_get_reg ( +void __iomem *reg,unsigned long reg_size) +{ +unsigned long shifted_data, shift, i; +unsigned long result =0 ; +unsigned long flags; + +spin_lock_irqsave (&csr_lock, flags); + +for (i =0 ; i < reg_size; ++i) {
drivers/soc/litex/litex_soc_ctrl.c line 105
Quoted 10 lines
drivers/soc/litex/litex_soc_ctrl.c new file +10
-0+ shifted_data =read_pointer_with_barrier ( + reg + (LITEX_REG_SIZE * i)); + shift = ((reg_size - i -1 ) *LITEX_SUBREG_SIZE_BIT ); + result |= (shifted_data << shift); + } + +spin_unlock_irqrestore (&csr_lock, flags); + +return result; +}
I'm not sure what's supposed to be in that register, but usually it will either be abstracted away through a framework since letting each and every driver poke into the same register is not really ideal, or if you really have to do it, using a syscon.
Quoted 22 lines
drivers/soc/litex/litex_soc_ctrl.c new file +22
-0+static int accessors_ok; + +/* +* Check if accessors are safe to be used by other drivers +* returns true if yes - false if not +*/ +int litex_check_accessors (void ) +{ +return accessors_ok; +} + +#define SCRATCH_REG_OFF 0x04 +#define SCRATCH_REG_SIZE 4 +#define SCRATCH_REG_VALUE 0x12345678 +#define SCRATCH_TEST_VALUE 0xdeadbeef + +/* +* Check LiteX CSR read/write access +* +* This function reads and writes a scratch register in order +* to verify if CSR access works. +*
drivers/soc/litex/litex_soc_ctrl.c line 138
Quoted 10 lines
drivers/soc/litex/litex_soc_ctrl.c new file +10
-0+* In case any problems are detected, the driver should panic +* and not set `accessors_ok` flag. As a result no other +* LiteX driver should access CSR bus. +* +* Access to the LiteX CSR is, by design, done in CPU native +* endianness. The driver should not dynamically configure +* access functions when the endianness mismatch is detected. +* Such situation indicates problems in the soft SoC design +* and should be solved at the LiteX generator level, +* not in the software.
I guess that's why you don't use readl/writel. Then __raw_readl/__raw_writel?
Quoted 51 lines
drivers/soc/litex/litex_soc_ctrl.c new file +51
-0+*/ +static int litex_check_csr_access (void __iomem *reg_addr) +{ +unsigned long reg; + + reg =litex_get_reg (reg_addr +SCRATCH_REG_OFF ,SCRATCH_REG_SIZE ); + +if (reg !=SCRATCH_REG_VALUE ) { +panic ("Scratch register read error! Expected: 0x%x but got: 0x%lx" , +SCRATCH_REG_VALUE , reg); +return -EINVAL ; + } + +litex_set_reg (reg_addr +SCRATCH_REG_OFF , +SCRATCH_REG_SIZE ,SCRATCH_TEST_VALUE ); + reg =litex_get_reg (reg_addr +SCRATCH_REG_OFF ,SCRATCH_REG_SIZE ); + +if (reg !=SCRATCH_TEST_VALUE ) { +panic ("Scratch register write error! Expected: 0x%x but got: 0x%lx" , +SCRATCH_TEST_VALUE , reg); +return -EINVAL ; + } + +/* restore original value of the SCRATCH register */ +litex_set_reg (reg_addr +SCRATCH_REG_OFF , +SCRATCH_REG_SIZE ,SCRATCH_REG_VALUE ); + +/* Set flag for other drivers */ + accessors_ok =1 ; +pr_info ("LiteX SoC Controller driver initialized" ); + +return 0 ; +} + +struct litex_soc_ctrl_device { +void __iomem *base; +}; + +static const struct of_device_id litex_soc_ctrl_of_match[] = { + {.compatible ="litex,soc_controller" }, + {}, +}; + +MODULE_DEVICE_TABLE (of, litex_soc_ctrl_of_match); + +static int litex_soc_ctrl_probe (struct platform_device *pdev) +{ +struct device *dev; +struct device_node *node; +const struct of_device_id *id; +struct litex_soc_ctrl_device *soc_ctrl_dev;
drivers/soc/litex/litex_soc_ctrl.c line 199
Quoted 10 lines
drivers/soc/litex/litex_soc_ctrl.c new file +10
-0+struct resource *res; + + dev = &pdev->dev; + node = dev->of_node; +if (!node) +return -ENODEV ; + + id =of_match_node (litex_soc_ctrl_of_match, node); +if (!id) +return -ENODEV ;
That's pretty much guaranteed.
drivers/soc/litex/litex_soc_ctrl.c line 211
Quoted 11 lines
drivers/soc/litex/litex_soc_ctrl.c new file +11
-0+ soc_ctrl_dev =devm_kzalloc (dev,sizeof (*soc_ctrl_dev),GFP_KERNEL ); +if (IS_ERR_OR_NULL (soc_ctrl_dev)) +return -ENOMEM ; + + res =platform_get_resource (pdev,IORESOURCE_MEM ,0 ); +if (IS_ERR_OR_NULL (res)) +return -EBUSY ; + + soc_ctrl_dev->base =devm_of_iomap (dev, node,0 , &res->end); +if (IS_ERR_OR_NULL (soc_ctrl_dev->base)) +return -EIO ;
devm_platform_ioremap_resource ?
drivers/soc/litex/litex_soc_ctrl.c line 219
Quoted 7 lines
drivers/soc/litex/litex_soc_ctrl.c new file +7
-0+return litex_check_csr_access (soc_ctrl_dev->base); +} + +static int litex_soc_ctrl_remove (struct platform_device *pdev) +{ +return 0 ; +}
You can leave the remove hook out entirely if you don't have anything in it.
Maxime
Mateusz Holenko
maintainerRe: [PATCH v3 3/5] drivers/soc/litex: add LiteX SoC Controller driver
Hi Maxime,
Quoted 147 lines · Maxime Ripard
Quoted 145 lines · Mateusz Holenko
From: Pawel Czarnecki <[email protected]>
This commit adds driver for the FPGA-based LiteX SoC Controller from LiteX SoC builder.
Co-developed-by Mateusz Holenko <[email protected]>Signed-off-by Mateusz Holenko <[email protected]>Signed-off-by Pawel Czarnecki <[email protected]>---
Notes:
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 | 14 ++ drivers/soc/litex/Makefile | 3 + drivers/soc/litex/litex_soc_ctrl.c | 233 +++++++++++++++++++++++++++++ include/linux/litex.h | 45 ++++++ 7 files changed, 299 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.hMAINTAINERS +2
-0@@ -9730,6 +9730,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@@ -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@@ -14,6 +14,7 @@ obj-$(CONFIG_ARCH_GEMINI) += gemini/ obj-$(CONFIG_ARCH_MXC) += 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 +14
-0@@ -0,0 +1,14 @@ +# SPDX-License_Identifier: GPL-2.0 + +menu "Enable LiteX SoC Builder specific drivers" + +config LITEX_SOC_CONTROLLER + tristate "Enable LiteX SoC Controller driver" + 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 + +endmenudrivers/soc/litex/Makefile new file +3
-0@@ -0,0 +1,3 @@ +# SPDX-License_Identifier: GPL-2.0 + +obj-$(CONFIG_LITEX_SOC_CONTROLLER) += litex_soc_ctrl.odrivers/soc/litex/litex_soc_ctrl.c new file +44
-0@@ -0,0 +1,233 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* LiteX SoC Controller Driver +* +* Copyright (C) 2020 Antmicro +* +*/ + +#include <linux/litex.h> +#include <linux/device.h> +#include <linux/errno.h> +#include <linux/of.h> +#include <linux/of_platform.h> +#include <linux/platform_device.h> +#include <linux/printk.h> +#include <linux/module.h> +#include <linux/errno.h> +#include <linux/io.h> + +/* +* The parameters below are true for LiteX SoC +* configured for 8-bit CSR Bus, 32-bit aligned. +* +* Supporting other configurations will require +* extending the logic in this header. +*/ +#define LITEX_REG_SIZE 0x4 +#define LITEX_SUBREG_SIZE 0x1 +#define LITEX_SUBREG_SIZE_BIT (LITEX_SUBREG_SIZE * 8) + +static DEFINE_SPINLOCK (csr_lock); + +static inline unsigned long read_pointer_with_barrier ( +const volatile void __iomem *addr) +{ +unsigned long val; + +__io_br (); + val = *(const volatile unsigned long __force *)addr; +__io_ar (); +return val; +} + +static inline void write_pointer_with_barrier(
Quoted 9 lines
drivers/soc/litex/litex_soc_ctrl.c line 50
Quoted 6 lines
drivers/soc/litex/litex_soc_ctrl.c new file +6
-0+ volatile void __iomem *addr, unsigned long val) +{ +__io_br (); + *(volatile unsigned long __force *)addr = val; +__io_ar (); +}What's wrong with readl/writel ?
readl/writel use a fixed endianness. What I want to do here is to access bytes in the CPU native ordering - there is a comment below explaining how CSRs are handled in LiteX.
Quoted 51 lines
Quoted 51 lines
drivers/soc/litex/litex_soc_ctrl.c new file +51
-0+/* +* LiteX SoC Generator, depending on the configuration, +* can split a single logical CSR (Control & Status Register) +* into a series of consecutive physical registers. +* +* For example, in the configuration with 8-bit CSR Bus, +* 32-bit aligned (the default one for 32-bit CPUs) a 32-bit +* logical CSR will be generated as four 32-bit physical registers, +* each one containing one byte of meaningful data. +* +* For details see: https://github.com/enjoy-digital/litex/issues/314 +* +* The purpose of `litex_set_reg`/`litex_get_reg` is to implement +* the logic of writing to/reading from the LiteX CSR in a single +* place that can be then reused by all LiteX drivers. +*/ +void litex_set_reg ( +void __iomem *reg,unsigned long reg_size,unsigned long val) +{ +unsigned long shifted_data, shift, i; +unsigned long flags; + +spin_lock_irqsave (&csr_lock, flags); + +for (i =0 ; i < reg_size; ++i) { + shift = ((reg_size - i -1 ) *LITEX_SUBREG_SIZE_BIT ); + shifted_data = val >> shift; +write_pointer_with_barrier ( + reg + (LITEX_REG_SIZE * i), shifted_data); + } + +spin_unlock_irqrestore (&csr_lock, flags); +} + +unsigned long litex_get_reg ( +void __iomem *reg,unsigned long reg_size) +{ +unsigned long shifted_data, shift, i; +unsigned long result =0 ; +unsigned long flags; + +spin_lock_irqsave (&csr_lock, flags); + +for (i =0 ; i < reg_size; ++i) { + shifted_data =read_pointer_with_barrier ( + reg + (LITEX_REG_SIZE * i)); + shift = ((reg_size - i -1 ) *LITEX_SUBREG_SIZE_BIT ); + result |= (shifted_data << shift); + } + +spin_unlock_irqrestore (&csr_lock, flags);
Quoted 8 lines
drivers/soc/litex/litex_soc_ctrl.c line 105
Quoted 3 lines
drivers/soc/litex/litex_soc_ctrl.c new file +3
-0+ +return result; +}I'm not sure what's supposed to be in that register, but usually it will either be abstracted away through a framework since letting each and every driver poke into the same register is not really ideal, or if you really have to do it, using a syscon.
Those litex_set_reg/ltex_get_reg are generic functions allowing to access any CSR generated by LiteX (addressed with reg argument). Each peripheral has its own set of CSRs and each driver should access only CSRs from a single peripheral.
The reason for having a common accessor is to have the logic of doing a single CSR write (implemented internally as many writes) and a single CSR read (implemented internally as many reads) just in one place to avoid code duplication.
Quoted 27 lines
Quoted 27 lines
drivers/soc/litex/litex_soc_ctrl.c new file +27
-0+static int accessors_ok; + +/* +* Check if accessors are safe to be used by other drivers +* returns true if yes - false if not +*/ +int litex_check_accessors (void ) +{ +return accessors_ok; +} + +#define SCRATCH_REG_OFF 0x04 +#define SCRATCH_REG_SIZE 4 +#define SCRATCH_REG_VALUE 0x12345678 +#define SCRATCH_TEST_VALUE 0xdeadbeef + +/* +* Check LiteX CSR read/write access +* +* This function reads and writes a scratch register in order +* to verify if CSR access works. +* +* In case any problems are detected, the driver should panic +* and not set `accessors_ok` flag. As a result no other +* LiteX driver should access CSR bus. +* +* Access to the LiteX CSR is, by design, done in CPU native
Quoted 8 lines
drivers/soc/litex/litex_soc_ctrl.c line 138
Quoted 5 lines
drivers/soc/litex/litex_soc_ctrl.c new file +5
-0+* endianness. The driver should not dynamically configure +* access functions when the endianness mismatch is detected. +* Such situation indicates problems in the soft SoC design +* and should be solved at the LiteX generator level, +* not in the software. I guess that's why you don't use readl/writel. Then __raw_readl/__raw_writel?
Do __raw_readl/__raw_writel provide memory barriers? I want to make sure that CSR's subregisters are read in a specific order.
Quoted 55 lines
Quoted 55 lines
drivers/soc/litex/litex_soc_ctrl.c new file +55
-0+*/ +static int litex_check_csr_access (void __iomem *reg_addr) +{ +unsigned long reg; + + reg =litex_get_reg (reg_addr +SCRATCH_REG_OFF ,SCRATCH_REG_SIZE ); + +if (reg !=SCRATCH_REG_VALUE ) { +panic ("Scratch register read error! Expected: 0x%x but got: 0x%lx" , +SCRATCH_REG_VALUE , reg); +return -EINVAL ; + } + +litex_set_reg (reg_addr +SCRATCH_REG_OFF , +SCRATCH_REG_SIZE ,SCRATCH_TEST_VALUE ); + reg =litex_get_reg (reg_addr +SCRATCH_REG_OFF ,SCRATCH_REG_SIZE ); + +if (reg !=SCRATCH_TEST_VALUE ) { +panic ("Scratch register write error! Expected: 0x%x but got: 0x%lx" , +SCRATCH_TEST_VALUE , reg); +return -EINVAL ; + } + +/* restore original value of the SCRATCH register */ +litex_set_reg (reg_addr +SCRATCH_REG_OFF , +SCRATCH_REG_SIZE ,SCRATCH_REG_VALUE ); + +/* Set flag for other drivers */ + accessors_ok =1 ; +pr_info ("LiteX SoC Controller driver initialized" ); + +return 0 ; +} + +struct litex_soc_ctrl_device { +void __iomem *base; +}; + +static const struct of_device_id litex_soc_ctrl_of_match[] = { + {.compatible ="litex,soc_controller" }, + {}, +}; + +MODULE_DEVICE_TABLE (of, litex_soc_ctrl_of_match); + +static int litex_soc_ctrl_probe (struct platform_device *pdev) +{ +struct device *dev; +struct device_node *node; +const struct of_device_id *id; +struct litex_soc_ctrl_device *soc_ctrl_dev; +struct resource *res; + + dev = &pdev->dev; + node = dev->of_node;
Quoted 8 lines
drivers/soc/litex/litex_soc_ctrl.c line 199
Quoted 6 lines
drivers/soc/litex/litex_soc_ctrl.c new file +6
-0+if (!node) +return -ENODEV ; + + id =of_match_node (litex_soc_ctrl_of_match, node); +if (!id) +return -ENODEV ;That's pretty much guaranteed.
You are right, I'll remove this fragment.
Quoted 5 lines
Quoted 5 lines
drivers/soc/litex/litex_soc_ctrl.c new file +5
-0+ soc_ctrl_dev =devm_kzalloc (dev,sizeof (*soc_ctrl_dev),GFP_KERNEL ); +if (IS_ERR_OR_NULL (soc_ctrl_dev)) +return -ENOMEM ; + + res =platform_get_resource (pdev,IORESOURCE_MEM ,0 );
Quoted 8 lines
drivers/soc/litex/litex_soc_ctrl.c line 211
Quoted 6 lines
drivers/soc/litex/litex_soc_ctrl.c new file +6
-0+if (IS_ERR_OR_NULL (res)) +return -EBUSY ; + + soc_ctrl_dev->base =devm_of_iomap (dev, node,0 , &res->end); +if (IS_ERR_OR_NULL (soc_ctrl_dev->base)) +return -EIO ;
devm_platform_ioremap_resource?
I'll simplify this fragment by using devm_platform_ioremap_resource as suggested.
Quoted 10 lines
drivers/soc/litex/litex_soc_ctrl.c line 219
Quoted 7 lines
drivers/soc/litex/litex_soc_ctrl.c new file +7
-0+return litex_check_csr_access (soc_ctrl_dev->base); +} + +static int litex_soc_ctrl_remove (struct platform_device *pdev) +{ +return 0 ; +}You can leave the remove hook out entirely if you don't have anything in it.
Right.
Quoted 1 line
Maxime
Thanks for the comments!
I'll refactor the code to address your suggestions.
--
Mateusz Holenko
Antmicro Ltd | www.antmicro.com
Roosevelta 22, 60-829 Poznan, Poland
Re: [PATCH v3 3/5] drivers/soc/litex: add LiteX SoC Controller driver
In reply to Mateusz HolenkoQuoted 8 lines · Mateusz Holenko
drivers/soc/litex/Kconfig new file +2
-0@@ -0,0 +1,14 @@ +# SPDX-License_Identifier: GPL-2.0 +
drivers/soc/litex/Kconfig line 12
Quoted 10 lines
drivers/soc/litex/Kconfig new file +10
-0+menu "Enable LiteX SoC Builder specific drivers" + +config LITEX_SOC_CONTROLLER + tristate "Enable LiteX SoC Controller driver" + 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
Hi,
Please indent the help text with 2 additional spaces, as explained in the coding-style.rst file:
10) Kconfig configuration files
-------------------------------
For all of the Kconfig* configuration files throughout the source tree, the indentation is somewhat different. Lines under a ``config`` definition are indented with one tab, while help text is indented an additional two spaces. Example::
config AUDIT
bool "Auditing support"
depends on NET
help
Enable auditing infrastructure that can be used with another kernel subsystem, such as SELinux (which requires this for logging of avc messages output). Does not do system-call auditing without CONFIG_AUDITSYSCALL.
drivers/soc/litex/Kconfig line 14
Quoted 2 lines
drivers/soc/litex/Kconfig new file +2
-0+ +endmenu
and then end the last line of the help text with a period ('.').
thanks.
Signature · 1 line
~Randy
Mateusz Holenko
maintainerRe: [PATCH v3 3/5] drivers/soc/litex: add LiteX SoC Controller driver
Quoted 47 lines · Randy Dunlap
Quoted 8 lines · Mateusz Holenko
drivers/soc/litex/Kconfig new file +2
-0@@ -0,0 +1,14 @@ +# SPDX-License_Identifier: GPL-2.0 +drivers/soc/litex/Kconfig line 12
Quoted 10 lines
drivers/soc/litex/Kconfig new file +10
-0+menu "Enable LiteX SoC Builder specific drivers" + +config LITEX_SOC_CONTROLLER + tristate "Enable LiteX SoC Controller driver" + 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_CONTROLLERHi,
Please indent the help text with 2 additional spaces, as explained in thecoding-style.rstfile:10)
Kconfigconfiguration files
-------------------------------For all of the Kconfig* configuration files throughout the source tree, the indentation is somewhat different. Lines under a ``config`` definition are indented with one tab, while help text is indented an additional two spaces. Example::
config AUDIT
bool "Auditing support"
depends on NET
help
Enable auditing infrastructure that can be used with another kernel subsystem, such as SELinux (which requires this for logging of avc messages output). Does not do system-call auditing withoutCONFIG_AUDITSYSCALL.drivers/soc/litex/Kconfig line 14
Quoted 2 lines
drivers/soc/litex/Kconfig new file +2
-0+ +endmenuand then end the last line of the help text with a period ('.').
Quoted 5 lines
thanks.
--
~Randy
Thanks for the comments!
I'll fix the documentation and resubmit the patch after addressing all other remarks.
Signature · 3 lines
Mateusz Holenko Antmicro Ltd | www.antmicro.com Roosevelta 22, 60-829 Poznan, Poland
Mateusz Holenko
maintainerPATCH v3 4/5 dt-bindings: serial: document LiteUART bindings
In reply to Mateusz HolenkoFrom: Filip Kokosinski <[email protected]>
Add documentation for LiteUART devicetree bindings.
---
Notes:
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
@@ -0,0 +1,38 @@ +# SPDX-License-Identifier: GPL-2.0 + +%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.0
Mateusz Holenko
maintainerPATCH v3 5/5 drivers/tty/serial: add LiteUART driver
In reply to Mateusz HolenkoFrom: 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 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 | 411 +++++++++++++++++++++++++++++++ include/uapi/linux/serial_core.h | 3 + 5 files changed, 447 insertions(+), 1 deletion(-) create mode 100644 drivers/tty/serial/liteuart.c
MAINTAINERS +1 -0
@@ -9732,6 +9732,7 @@ S: Maintained F: Documentation/devicetree/bindings/*/litex,*.yaml F: drivers/soc/litex/litex_soc_ctrl.c F: include/linux/litex.h +F: drivers/tty/serial/liteuart.c LIVE PATCHING M: Josh Poimboeuf <[email protected]>
drivers/tty/serial/Kconfig +31 -1
@@ -529,7 +529,7 @@ config SERIAL_IMX_CONSOLE config SERIAL_UARTLITE tristate "Xilinx uartlite serial port support" - depends on HAS_IOMEM + depends on HAS_IOMEM && LITEX_SOC_CONTROLLER select SERIAL_CORE help Say Y here if you want to use the Xilinx uartlite serial controller.
@@ -1572,6 +1572,36 @@ 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 + 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
@@ -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 +411 -0
411 lines not on this page · raw message
include/uapi/linux/serial_core.h +3 -0
@@ -293,4 +293,7 @@/* Freescale LINFlexD UART */ #define PORT_LINFLEXUART 122 +/* LiteUART */ +#define PORT_LITEUART 123 +#endif /* _UAPILINUX_SERIAL_CORE_H */
Signature · 1 line
2.25.0
Mateusz Holenko
maintainerRe: [PATCH v3 5/5] drivers/tty/serial: add LiteUART driver
Quoted 51 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.
Signed-off-by Filip Kokosinski <[email protected]>Signed-off-by Mateusz Holenko <[email protected]>---
Notes:
Changes in v3:
- aliases made optional
- used litex_get_reg/litex_set_reg functions instead of macros
-SERIAL_LITEUART_NR_PORTSrenamed toSERIAL_LITEUART_MAX_PORTS
-PORT_LITEUARTchanged from 122 to 123
- added dependency onLITEX_SOC_CONTROLLER
- patch number changed from 4 to 5No changes in v2.
MAINTAINERS | 1 + drivers/tty/serial/Kconfig | 32 ++- drivers/tty/serial/Makefile | 1 + drivers/tty/serial/liteuart.c | 411 +++++++++++++++++++++++++++++++ include/uapi/linux/serial_core.h | 3 + 5 files changed, 447 insertions(+), 1 deletion(-) create mode 100644 drivers/tty/serial/liteuart.cMAINTAINERS +1
-0@@ -9732,6 +9732,7 @@ S: Maintained F: Documentation/devicetree/bindings/*/litex,*.yaml F: drivers/soc/litex/litex_soc_ctrl.c F: include/linux/litex.h +F: drivers/tty/serial/liteuart.c LIVE PATCHING M: Josh Poimboeuf <[email protected]>drivers/tty/serial/Kconfig +0
-0
drivers/tty/serial/Kconfig config SERIAL_IMX_CONSOLE · line 532
Quoted 5 lines
drivers/tty/serial/Kconfig +1
-1@@ -529,7 +529,7 @@ config SERIAL_IMX_CONSOLE config SERIAL_UARTLITE tristate "Xilinx uartlite serial port support" - depends on HAS_IOMEM + depends on HAS_IOMEM && LITEX_SOC_CONTROLLER
Just noticed this - it's wrong. We don't want to change Xilinx UARTLITE config. It's SERIAL_LITEUART that should be dependent on LITEX_SOC_CONTROLLER.
drivers/tty/serial/Kconfig config SERIAL_MILBEAUT_USIO_CONSOLE · line 1578
Quoted 11 lines
drivers/tty/serial/Kconfig +4
-0select SERIAL_CORE help Say Y here if you want to use the Xilinx uartlite serial controller.@@ -1572,6 +1572,36 @@ 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
This should also depend on LITEX_SOC_CONTROLLER.
Quoted 473 lines
drivers/tty/serial/Kconfig +26
-0+ 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_GPIOdrivers/tty/serial/Makefile +1
-0@@ -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.odrivers/tty/serial/liteuart.c new file +411
-0@@ -0,0 +1,411 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* LiteUART serial controller (LiteX) Driver +* +* Copyright (C) 2019 - 2020 Antmicro <www.antmicro.com> +*/ + +#include <linux/console.h> +#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> + +/* module-related defines */ +#define DRIVER_NAME "liteuart" +#define DRIVER_MAJOR 0 +#define DRIVER_MINOR 0 +#define DEV_NAME "ttyLXU" + +/* +* 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 SIZE_RXTX 1 +#define OFF_TXFULL 0x04 +#define SIZE_TXFULL 1 +#define OFF_RXEMPTY 0x08 +#define SIZE_RXEMPTY 1 +#define OFF_EV_STATUS 0x0c +#define SIZE_EV_STATUS 1 +#define OFF_EV_PENDING 0x10 +#define SIZE_EV_PENDING 1 +#define OFF_EV_ENABLE 0x14 +#define SIZE_EV_ENABLE 1 + +/* 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 struct liteuart_port liteuart_ports[CONFIG_SERIAL_LITEUART_MAX_PORTS ]; +static DECLARE_BITMAP(liteuart_ports_in_use, CONFIG_SERIAL_LITEUART_MAX_PORTS); + +#ifdef CONFIG_SERIAL_LITEUART_CONSOLE +static struct console liteuart_console; +#endif + +static struct uart_driver liteuart_driver = { + .owner =THIS_MODULE , + .driver_name =DRIVER_NAME , + .dev_name =DEV_NAME , + .major =DRIVER_MAJOR , + .minor =DRIVER_MINOR , + .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 , +SIZE_RXEMPTY )) ==1 ) { + ch =litex_get_reg (membase +OFF_RXTX ,SIZE_RXTX ); + port->icount.rx++; + +/* necessary for RXEMPTY to refresh its value */ +litex_set_reg (membase +OFF_EV_PENDING , +SIZE_EV_PENDING ,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 ,SIZE_TXFULL )) +cpu_relax (); + +litex_set_reg (port->membase +OFF_RXTX ,SIZE_RXTX , 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 ,SIZE_TXFULL )) +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 , +SIZE_RXTX , 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 ,SIZE_EV_ENABLE ,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 (port->type ==PORT_LITEUART ) ?DRIVER_NAME :NULL ; +} + +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) +{ +if (flags &UART_CONFIG_TYPE ) + port->type =PORT_LITEUART ; +} + +static int liteuart_verify_port (struct uart_port *port, +struct serial_struct *ser) +{ +if (port->type !=PORT_UNKNOWN && ser->type !=PORT_LITEUART ) +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; +int dev_id; + +if (!litex_check_accessors ()) +return -EPROBE_DEFER ; + +/* no device tree */ +if (!np) +return -ENODEV ; + +/* look for aliases; auto-enumerate for free index if not found */ + dev_id =of_alias_get_id (np,"serial" ); +if (dev_id <0 ) + dev_id =find_first_zero_bit (liteuart_ports_in_use, +CONFIG_SERIAL_LITEUART_MAX_PORTS ); + +if (dev_id >=CONFIG_SERIAL_LITEUART_MAX_PORTS ) +return -ENODEV ; + +if (test_and_set_bit (dev_id, liteuart_ports_in_use)) +return -EBUSY ; + + uart = &liteuart_ports[dev_id]; + port = &uart->port; + +/* get {map,mem}base */ + port->mapbase =platform_get_resource (pdev,IORESOURCE_MEM ,0 )->start; + port->membase =of_iomap (np,0 ); +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; + +return uart_add_one_port (&liteuart_driver, + &liteuart_ports[dev_id].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 =DRIVER_NAME , + .of_match_table =of_match_ptr (liteuart_of_match), + }, +}; + +#ifdef CONFIG_SERIAL_LITEUART_CONSOLE + +static void liteuart_console_write (struct console *co,const char *s, +unsigned int count) +{ +struct uart_port *port = &liteuart_ports[co->index].port; +unsigned long flags; + +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 uart_port *port; +int baud =115200 ; +int bits =8 ; +int parity ='n' ; +int flow ='n' ; + + port = &liteuart_ports[co->index].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 =DRIVER_NAME , + .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:" DRIVER_NAME );include/uapi/linux/serial_core.h +3
-1@@ -293,4 +293,7 @@/* Freescale LINFlexD UART */ #define PORT_LINFLEXUART 122 +/* LiteUART */ +#define PORT_LITEUART 123 +#endif /* _UAPILINUX_SERIAL_CORE_H */ --2.25.0
Signature · 3 lines
Mateusz Holenko Antmicro Ltd | www.antmicro.com Roosevelta 22, 60-829 Poznan, Poland