Skip to contentSkip to conversation

mmc: Add LiteSDCard mmc driver

PATCH In review Gabriel Somlo 2 participants 7 messages Jan 13, 2022 – Jan 24, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

v14 cover mmc: Add LiteSDCard mmc driver

Add support for the LiteX SD-Card device, LiteSDCard.

LiteSDCard is a simple SD-Card interface available as part of the LiteX environment, used with various RISC-V and other FPGA based SoCs.

New in v14:
Documentation/devicetree/bindings/mmc/litex,mmc.yaml:
- add missing vmmc-supply = ... property to example section

Quoted 171 lines

New in v13:
Documentation/devicetree/bindings/mmc/litex,mmc.yaml:
- add vmmc-supply requirement
drivers/mmc/host/Kconfig:
- add dependency on REGULATOR, REGULATOR_FIXED_VOLTAGE
drivers/mmc/host/litex_mmc.c:
- use mmc_regulator_get_supply(), with fallback to hardcoded 3.3V

Quoted 163 lines

New in v12:
drivers/mmc/host/Kconfig:
- add dependency on HAVE_CLK for litex_mmc driver
- (re)add "If unsure, say N" to the litex_mmc driver help message
drivers/mmc/host/litex_mmc.c:
- prints message using dev_info() before returning success from probe()

Quoted 156 lines

New in v11:
- picked up r/b from Andy
drivers/mmc/host/litex_mmc.c:
- defensive coding of litex_mmc_interrupt() return logic
- remove dev member of struct litex_mmc_host, only used during probe

Quoted 150 lines

New in v10:
drivers/mmc/host/litex_mmc.c:
- group linux/mmc/* includes by themselves
- clean-up of return style (multiple locations throughout source)
- create mmc_free_host() wrapper for use with devm_add_action_or_reset()
- use GFP_KERNEL with dmam_alloc_coherent()

Quoted 142 lines

New in v9:
drivers/mmc/host/Kconfig:
- fix OF dependency
drivers/mmc/host/litex_mmc.c:
- remove linux/of.h include, no longer needed since dropping of_match_ptr()
- add linux/mod_devicetable.h include
- use devm_action_or_reset() to devm-ify mmc_alloc_host(), and obviate the need to call mmc_free_host() explicitly during either probe() error path or during remove()

Quoted 131 lines

New in v8:
commit blurbs:
- cosmetic editing of descriptions
- removed Cc: lines
drivers/mmc/host/litex_mmc.c:
- fix file header comment (for real, this time)
- add explicit bits.h include
- remove of_match_ptr() wrapper from around .of_match_table argument
- fix devm ordering issues: use devm_request_irq(), which precludes the need to call free_irq() on probe() error path or from remove()

Quoted 120 lines

New in v7:

drivers/mmc/host/Kconfig:
- added module name in LiteSDCard Kconfig entry

drivers/mmc/host/litex_mmc.c:
- fixed comment formatting, ordering, and capitalization throughout the entire file
- sorted header #include statements
- removed redundant parantheses in readx_poll_timeout() condition
- explicit handling of readx_poll_timeout() timeout scenarios
- dev_err() used in litex_mmc_sdcard_wait_done()
- use memcpy_fromio() to grab command response
- no need to apply 0xffff mask to a 32-bit value right-shifted by 16 (host->resp[3])
- use clamp() instead of min(max(...)...)
- reworked platform_get_irq_optional() error handling logic
- no need to explicitly zero host->irq, kzalloc() does that already
- added missing free_irq() in litex_mmc_probe() error path
- reordered calls inside litex_mmc_remove() (calling mmc_free_host() before free_irq()

Quoted 98 lines

New in v6:

drivers/mmc/host/litex_mmc.c:
- fix handling of deferred probe vs. platform_get_irq_optional()
- don't #ifdef dma_set_mask_and_coherent(), since it automatically does the right thing on both 32- and 64-bit DMA capable arches
- remove MMC_CAP2_FULL_PWR_CYCLE, add MMC_CAP2_NO_MMC to list of hardcoded capabilities during litex_mmc_probe()
- hardcode mmc->ocr_avail to the full 2.7-3.6V range allowed by the SDCard spec (the LiteSDCard device doesn't accept software configuration)

Quoted 86 lines

New in v5:

MAINTAINERS:

- picked up a/b Mateusz

Doc/dt/bindings/mmc/litex,mmc.yaml:

- picked up r/b Rob, Joel

drivers/mmc/host/litex_mmc.c:

- shorten #define constant names (cosmetic, make them less unwieldy)
- picked up r/b Joel

Quoted 71 lines

New in v4:

Doc/dt/bindings/mmc/litex,mmc.yaml:

- fixed dt_binding_check errors uncovered by Rob's script

drivers/mmc/host/litex_mmc.c:

- struct litex_mmc_host fields re-ordered so that pahole reports no holes in either 32- or 64-bit builds
- litex_mmc_set_bus_width() now encapsulates check for host->is_bus_width_set
- litex_mmc_request() - factor out dma data setup into separate helper function: litex_mmc_do_dma()

Quoted 56 lines

New in v3:

MAINTAINERS:

- picked up acked-by Joel
- added listing for liteeth driver
- added Joel as additional co-maintainer (thanks!)

Doc/dt/bindings/mmc/litex,mmc.yaml:

- picked up r/b Geert Uytterhoeven <[email protected]> in DT bindings document (please let me know if that was premature, and happy to take further review if needed :)
- add dedicated DT property for source clock frequency

drivers/mmc/host/litex_mmc.c:

- fixed function signature (no line split), and naming (litex_mmc_*)
- more informative MODULE_AUTHOR() entries
- also added matching "Copyright" entries in file header
- fixed description in Kconfig
- fixed DT documentation
- removed magic constants
- removed litex_map_status(), have sdcard_wait_done() return *real* error codes directly instead.
- streamlined litex_mmc_reponse_len()
- call litex_mmc_set_bus_width() only once, and ensure it returns correct error code(s)
- use readx_poll_timeout() -- more concise -- instead of read_poll_timeout()
- use dev_err() in litex_mmc_send_cmd() (instead of pr_err())
- litex_mmc_setclk() will update host->clock before returning
- separate irq initialization into its own function, litex_mmc_irq_init()
- document rationale for f_min, f_max
- use dmam_alloc_coherent(), which simplifies cleanup significantly
- large if (data) { ... } block in litex_mmc_request() left as-is, there are too many variables shared with the rest of the parent function body to easily separate (e.g., len, transfer, direct). If this is indeed a blocker, I can take another shot at refactoring it in a future revision!
- bump dma_set_mask_and_coherent() to 64-bits on suitable architectures
- clock source picked up from dedicated DT clock reference property
- remove gpio card-detect logic (needs testing and a dt binding example before being eligible for upstream inclusion)

Quoted 9 lines

New in v2:
- reword info message in litex_set_clk()
- streamline code in litex_map_status()
- fix typos in Kconfig (thanks Randy Dunlap <[email protected]>)
- improvements suggested by Stafford Horne <[email protected]>
- allow COMPILE_TEST in Kconfig
- use read_poll_timeout() when waiting for cmd/data/DMA xfer completion
- include interrupt.h (thanks kernel test robot <[email protected]>)

Gabriel Somlo (3):
MAINTAINERS: co-maintain LiteX platform
dt-bindings: mmc: Add bindings for LiteSDCard
mmc: Add driver for LiteX's LiteSDCard interface

 .../devicetree/bindings/mmc/litex,mmc.yaml    |  78 +++
 MAINTAINERS                                   |   9 +-
 drivers/mmc/host/Kconfig                      |  13 +
 drivers/mmc/host/Makefile                     |   1 +
 drivers/mmc/host/litex_mmc.c                  | 661 ++++++++++++++++++
 5 files changed, 760 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/mmc/litex,mmc.yaml
 create mode 100644 drivers/mmc/host/litex_mmc.c
Signature · 1 line
2.31.1
#1 lore raw

PATCH v14 1/3 MAINTAINERS: co-maintain LiteX platform

Add the litex_mmc (LiteSDCard) and LiteETH drivers to the list of files maintained under LiteX.

Add Gabriel Somlo and Joel Stanley as maintainers; Joel authored the LiteETH driver, and Gabriel is currently curating the LiteX out-of-tree device drivers as they are tested and prepared for upstream submission, having also co-authored a number of them.

---
 MAINTAINERS | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)
MAINTAINERS +7 -2
index e4cecccbd439..d0aa02e9963d 100644
@@ -11094,12 +11094,17 @@ F:	lib/list-test.c
 LITEX PLATFORM
 M:	Karol Gugala <[email protected]>
 M:	Mateusz Holenko <[email protected]>
+M:	Gabriel Somlo <[email protected]>
+M:	Joel Stanley <[email protected]>
 S:	Maintained
 F:	Documentation/devicetree/bindings/*/litex,*.yaml
 F:	arch/openrisc/boot/dts/or1klitex.dts
-F:	drivers/soc/litex/litex_soc_ctrl.c
-F:	drivers/tty/serial/liteuart.c
 F:	include/linux/litex.h
+F:	drivers/tty/serial/liteuart.c
+F:	drivers/soc/litex/*
+F:	drivers/net/ethernet/litex/*
+F:	drivers/mmc/host/litex_mmc.c
+N:	litex
 
 LIVE PATCHING
 M:	Josh Poimboeuf <[email protected]>
Signature · 1 line
2.31.1
#2 lore raw

PATCH v14 2/3 dt-bindings: mmc: Add bindings for LiteSDCard

In reply to Gabriel Somlo

LiteSDCard is a small footprint, configurable SDCard core for FPGA based SoCs.

---

New in v14:
- add missing vmmc-supply = ... property to example section

Quoted 2 lines

New in v13:
- add vmmc-supply requirement

 .../devicetree/bindings/mmc/litex,mmc.yaml    | 78 +++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mmc/litex,mmc.yaml
Documentation/devicetree/bindings/mmc/litex,mmc.yaml new file +78 -0
new file mode 100644
index 000000000000..ef9e0da44bf8
@@ -0,0 +1,78 @@
+# SPDX-License-Identifier: GPL-2.0-or-later OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mmc/litex,mmc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: LiteX LiteSDCard device
+
+maintainers:
+  - Gabriel Somlo <[email protected]>
+
+description: |
+  LiteSDCard is a small footprint, configurable SDCard core for FPGA based
+  system on chips.
+
+  The hardware source is Open Source and can be found on at
+  https://github.com/enjoy-digital/litesdcard/.
+
+allOf:
+  - $ref: mmc-controller.yaml#
+
+properties:
+  compatible:
+    const: litex,mmc
+
+  reg:
+    items:
+      - description: PHY registers
+      - description: CORE registers
+      - description: DMA Reader buffer
+      - description: DMA Writer buffer
+      - description: IRQ registers
+    minItems: 4
+
+  reg-names:
+    items:
+      - const: phy
+      - const: core
+      - const: reader
+      - const: writer
+      - const: irq
+    minItems: 4
+
+  clocks:
+    maxItems: 1
+    description:
+      Handle to reference clock.
+
+  vmmc-supply:
+    description:
+      Handle to fixed-voltage supply for the card power.
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - reg-names
+  - clocks
+  - vmmc-supply
+
+additionalProperties: false
+
+examples:
+  - |
+    mmc: mmc@12005000 {
+        compatible = "litex,mmc";
+        reg = <0x12005000 0x100>,
+              <0x12003800 0x100>,
+              <0x12003000 0x100>,
+              <0x12004800 0x100>,
+              <0x12004000 0x100>;
+        reg-names = "phy", "core", "reader", "writer", "irq";
+        clocks = <&reference_clk>;
+        vmmc-supply = <&vreg_mmc>;
+        interrupts = <4>;
+    };
Signature · 1 line
2.31.1
#3 lore raw

PATCH v14 3/3 mmc: Add driver for LiteX's LiteSDCard interface

In reply to Gabriel Somlo

LiteX (https://github.com/enjoy-digital/litex) is a SoC framework that targets FPGAs. LiteSDCard is a small footprint, configurable SDCard core commonly used in LiteX designs.

The driver was first written in May 2020 and has been maintained cooperatively by the LiteX community. Thanks to all contributors!

---

New in v14:
n/a

Quoted 118 lines

New in v13:
drivers/mmc/host/Kconfig:
- add dependency on REGULATOR, REGULATOR_FIXED_VOLTAGE
drivers/mmc/host/litex_mmc.c:
- use mmc_regulator_get_supply(), with fallback to hardcoded 3.3V

Quoted 112 lines

New in v12:
drivers/mmc/host/Kconfig:
- add dependency on HAVE_CLK for litex_mmc driver
- (re) add "If unsure, say N" to the litex_mmc driver help message
drivers/mmc/host/litex_mmc.c:
- prints message using dev_info() before returning success from probe()

Quoted 105 lines

New in v11:
- picked up r/b from Andy
drivers/mmc/host/litex_mmc.c:
- defensive coding of litex_mmc_interrupt() return logic
- remove dev member of struct litex_mmc_host, only used during probe

Quoted 99 lines

New in v10:
drivers/mmc/host/litex_mmc.c:
- group linux/mmc/* includes by themselves
- clean-up of return style (multiple locations throughout source)
- create mmc_free_host() wrapper for use with devm_add_action_or_reset()
- use GFP_KERNEL with dmam_alloc_coherent()

Quoted 91 lines

New in v9:
drivers/mmc/host/Kconfig:
- fix OF dependency
drivers/mmc/host/litex_mmc.c:
- remove linux/of.h include, no longer needed since dropping of_match_ptr()
- add linux/mod_devicetable.h include
- use devm_action_or_reset() to devm-ify mmc_alloc_host(), and obviate the need to call mmc_free_host() explicitly during either probe() error path or during remove()

Quoted 80 lines

New in v8:
- remove Cc: lines from commit blurb
drivers/mmc/host/litex_mmc.c:
- fix file header comment (for real, this time)
- add explicit bits.h include
- remove of_match_ptr() wrapper from around .of_match_table argument
- fix devm ordering issues: use devm_request_irq(), which precludes the need to call free_irq() on probe() error path or from remove()

Quoted 71 lines

New in v7:
drivers/mmc/host/Kconfig:
- added module name in LiteSDCard Kconfig entry
drivers/mmc/host/litex_mmc.c:
- fixed comment formatting, ordering, and capitalization throughout the entire file
- sorted header #include statements
- removed redundant parantheses in readx_poll_timeout() condition
- explicit handling of readx_poll_timeout() timeout scenarios
- dev_err() used in litex_mmc_sdcard_wait_done()
- use memcpy_fromio() to grab command response
- no need to apply 0xffff mask to a 32-bit value right-shifted by 16 (host->resp[3])
- use clamp() instead of min(max(...)...)
- reworked platform_get_irq_optional() error handling logic
- no need to explicitly zero host->irq, kzalloc() does that already
- added missing free_irq() in litex_mmc_probe() error path
- reordered calls inside litex_mmc_remove() (calling mmc_free_host() before free_irq()

Quoted 51 lines

New in v6:
- fix handling of deferred probe vs. platform_get_irq_optional()
- don't #ifdef dma_set_mask_and_coherent(), since it automatically does the right thing on both 32- and 64-bit DMA capable arches
- remove MMC_CAP2_FULL_PWR_CYCLE, add MMC_CAP2_NO_MMC to list of hardcoded capabilities during litex_mmc_probe()
- hardcode mmc->ocr_avail to the full 2.7-3.6V range allowed by the SDCard spec (the LiteSDCard device doesn't accept software configuration)

Quoted 41 lines

New in v5:
- shorter #define constant names (cosmetic, make them less unwieldy)
- picked up reviewed-by Joel

Quoted 37 lines

New in v4:
- struct litex_mmc_host fields re-ordered so that pahole reports no holes on either 32- or 64-bit builds
- litex_mmc_set_bus_width() now encapsulates check for host->is_bus_width_set
- litex_mmc_request() - factor out dma data setup into separate helper function: litex_mmc_do_dma()

Quoted 29 lines

New in v3:
- fixed function signature (no line split), and naming (litex_mmc_*)
- more informative MODULE_AUTHOR() entries
- also added matching "Copyright" entries in file header
- fixed description and dependencies in Kconfig
- removed magic constants
- removed litex_map_status(), have sdcard_wait_done() return *real* error codes directly instead.
- streamlined litex_mmc_reponse_len()
- call litex_mmc_set_bus_width() only once, and ensure it returns correct error code(s)
- use readx_poll_timeout() -- more concise -- instead of read_poll_timeout()
- use dev_err() in litex_mmc_send_cmd() (instead of pr_err())
- litex_mmc_setclk() will update host->clock before returning
- separate irq initialization into its own function, litex_mmc_irq_init()
- document rationale for f_min, f_max
- use dmam_alloc_coherent(), which simplifies cleanup significantly
- bump dma_set_mask_and_coherent() to 64-bits on suitable architectures
- clock source picked up from dedicated DT clock reference property
- remove gpio card-detect logic (needs testing and a dt binding example before being eligible for upstream inclusion)
- large if (data) { ... } block in litex_mmc_request() left as-is, there are too many variables shared with the rest of the parent function body to easily separate (e.g., len, transfer, direct). If this is indeed a blocker, I can take another shot at refactoring it in a future revision!

 drivers/mmc/host/Kconfig     |  13 +
 drivers/mmc/host/Makefile    |   1 +
 drivers/mmc/host/litex_mmc.c | 661 +++++++++++++++++++++++++++++++++++
 3 files changed, 675 insertions(+)
 create mode 100644 drivers/mmc/host/litex_mmc.c
drivers/mmc/host/Kconfig +13 -0
index 52b0b27a6839..af6c3c329076 100644
@@ -1094,3 +1094,16 @@ config MMC_OWL
 
 config MMC_SDHCI_EXTERNAL_DMA
 	bool
+
+config MMC_LITEX
+	tristate "LiteX MMC Host Controller support"
+	depends on ((PPC_MICROWATT || LITEX) && OF && HAVE_CLK) || COMPILE_TEST
+	select REGULATOR
+	select REGULATOR_FIXED_VOLTAGE
+	help
+	  This selects support for the MMC Host Controller found in LiteX SoCs.
+
+	  To compile this driver as a module, choose M here: the
+	  module will be called litex_mmc.
+
+	  If unsure, say N.
drivers/mmc/host/Makefile +1 -0
index ea36d379bd3c..4e4ceb32c4b4 100644
@@ -101,6 +101,7 @@ obj-$(CONFIG_MMC_CQHCI)			+= cqhci.o
 cqhci-y					+= cqhci-core.o
 cqhci-$(CONFIG_MMC_CRYPTO)		+= cqhci-crypto.o
 obj-$(CONFIG_MMC_HSQ)			+= mmc_hsq.o
+obj-$(CONFIG_MMC_LITEX)			+= litex_mmc.o
 
 ifeq ($(CONFIG_CB710_DEBUG),y)
 	CFLAGS-cb710-mmc	+= -DDEBUG
drivers/mmc/host/litex_mmc.c new file +661 -0

661 lines not on this page · raw message

Signature · 1 line
2.31.1
#4 lore raw
In reply to Gabriel Somlo
Quoted 16 lines · Gabriel Somlo

Add support for the LiteX SD-Card device, LiteSDCard.

LiteSDCard is a simple SD-Card interface available as part of the LiteX environment, used with various RISC-V and other FPGA based SoCs.

New in v14:
Documentation/devicetree/bindings/mmc/litex,mmc.yaml:
- add missing vmmc-supply = ... property to example section

Quoted 7 lines

New in v13:
Documentation/devicetree/bindings/mmc/litex,mmc.yaml:
- add vmmc-supply requirement
drivers/mmc/host/Kconfig:
- add dependency on REGULATOR, REGULATOR_FIXED_VOLTAGE
drivers/mmc/host/litex_mmc.c:
- use mmc_regulator_get_supply(), with fallback to hardcoded 3.3V

Ping?

Quoted 181 lines
Quoted 154 lines
Quoted 154 lines

New in v12:
drivers/mmc/host/Kconfig:
- add dependency on HAVE_CLK for litex_mmc driver
- (re)add "If unsure, say N" to the litex_mmc driver help message
drivers/mmc/host/litex_mmc.c:
- prints message using dev_info() before returning success from probe()

Quoted 147 lines

New in v11:
- picked up r/b from Andy
drivers/mmc/host/litex_mmc.c:
- defensive coding of litex_mmc_interrupt() return logic
- remove dev member of struct litex_mmc_host, only used during probe

Quoted 141 lines

New in v10:
drivers/mmc/host/litex_mmc.c:
- group linux/mmc/* includes by themselves
- clean-up of return style (multiple locations throughout source)
- create mmc_free_host() wrapper for use with devm_add_action_or_reset()
- use GFP_KERNEL with dmam_alloc_coherent()

Quoted 133 lines

New in v9:
drivers/mmc/host/Kconfig:
- fix OF dependency
drivers/mmc/host/litex_mmc.c:
- remove linux/of.h include, no longer needed since dropping of_match_ptr()
- add linux/mod_devicetable.h include
- use devm_action_or_reset() to devm-ify mmc_alloc_host(), and obviate the need to call mmc_free_host() explicitly during either probe() error path or during remove()

Quoted 122 lines

New in v8:
commit blurbs:
- cosmetic editing of descriptions
- removed Cc: lines
drivers/mmc/host/litex_mmc.c:
- fix file header comment (for real, this time)
- add explicit bits.h include
- remove of_match_ptr() wrapper from around .of_match_table argument
- fix devm ordering issues: use devm_request_irq(), which precludes the need to call free_irq() on probe() error path or from remove()

Quoted 111 lines

New in v7:

drivers/mmc/host/Kconfig:
- added module name in LiteSDCard Kconfig entry

drivers/mmc/host/litex_mmc.c:
- fixed comment formatting, ordering, and capitalization throughout the entire file
- sorted header #include statements
- removed redundant parantheses in readx_poll_timeout() condition
- explicit handling of readx_poll_timeout() timeout scenarios
- dev_err() used in litex_mmc_sdcard_wait_done()
- use memcpy_fromio() to grab command response
- no need to apply 0xffff mask to a 32-bit value right-shifted by 16 (host->resp[3])
- use clamp() instead of min(max(...)...)
- reworked platform_get_irq_optional() error handling logic
- no need to explicitly zero host->irq, kzalloc() does that already
- added missing free_irq() in litex_mmc_probe() error path
- reordered calls inside litex_mmc_remove() (calling mmc_free_host() before free_irq()

Quoted 89 lines

New in v6:

drivers/mmc/host/litex_mmc.c:
- fix handling of deferred probe vs. platform_get_irq_optional()
- don't #ifdef dma_set_mask_and_coherent(), since it automatically does the right thing on both 32- and 64-bit DMA capable arches
- remove MMC_CAP2_FULL_PWR_CYCLE, add MMC_CAP2_NO_MMC to list of hardcoded capabilities during litex_mmc_probe()
- hardcode mmc->ocr_avail to the full 2.7-3.6V range allowed by the SDCard spec (the LiteSDCard device doesn't accept software configuration)

Quoted 77 lines

New in v5:

MAINTAINERS:

- picked up a/b Mateusz

Doc/dt/bindings/mmc/litex,mmc.yaml:

- picked up r/b Rob, Joel

drivers/mmc/host/litex_mmc.c:

- shorten #define constant names (cosmetic, make them less unwieldy)
- picked up r/b Joel

Quoted 62 lines

New in v4:

Doc/dt/bindings/mmc/litex,mmc.yaml:

- fixed dt_binding_check errors uncovered by Rob's script

drivers/mmc/host/litex_mmc.c:

- struct litex_mmc_host fields re-ordered so that pahole reports no holes in either 32- or 64-bit builds
- litex_mmc_set_bus_width() now encapsulates check for host->is_bus_width_set
- litex_mmc_request() - factor out dma data setup into separate helper function: litex_mmc_do_dma()

Quoted 47 lines

New in v3:

MAINTAINERS:

- picked up acked-by Joel
- added listing for liteeth driver
- added Joel as additional co-maintainer (thanks!)

Doc/dt/bindings/mmc/litex,mmc.yaml:

- picked up r/b Geert Uytterhoeven <[email protected]> in DT bindings document (please let me know if that was premature, and happy to take further review if needed :)
- add dedicated DT property for source clock frequency

drivers/mmc/host/litex_mmc.c:

- fixed function signature (no line split), and naming (litex_mmc_*)
- more informative MODULE_AUTHOR() entries
- also added matching "Copyright" entries in file header
- fixed description in Kconfig
- fixed DT documentation
- removed magic constants
- removed litex_map_status(), have sdcard_wait_done() return *real* error codes directly instead.
- streamlined litex_mmc_reponse_len()
- call litex_mmc_set_bus_width() only once, and ensure it returns correct error code(s)
- use readx_poll_timeout() -- more concise -- instead of read_poll_timeout()
- use dev_err() in litex_mmc_send_cmd() (instead of pr_err())
- litex_mmc_setclk() will update host->clock before returning
- separate irq initialization into its own function, litex_mmc_irq_init()
- document rationale for f_min, f_max
- use dmam_alloc_coherent(), which simplifies cleanup significantly
- large if (data) { ... } block in litex_mmc_request() left as-is, there are too many variables shared with the rest of the parent function body to easily separate (e.g., len, transfer, direct). If this is indeed a blocker, I can take another shot at refactoring it in a future revision!
- bump dma_set_mask_and_coherent() to 64-bits on suitable architectures
- clock source picked up from dedicated DT clock reference property
- remove gpio card-detect logic (needs testing and a dt binding example before being eligible for upstream inclusion)

Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines

New in v2:
- reword info message in litex_set_clk()
- streamline code in litex_map_status()
- fix typos in Kconfig (thanks Randy Dunlap <[email protected]>)
- improvements suggested by Stafford Horne <[email protected]>
- allow COMPILE_TEST in Kconfig
- use read_poll_timeout() when waiting for cmd/data/DMA
xfer completion
- include interrupt.h (thanks kernel test robot <[email protected]>)

Gabriel Somlo (3):
MAINTAINERS: co-maintain LiteX platform
dt-bindings: mmc: Add bindings for LiteSDCard
mmc: Add driver for LiteX's LiteSDCard interface

 .../devicetree/bindings/mmc/litex,mmc.yaml    |  78 +++
 MAINTAINERS                                   |   9 +-
 drivers/mmc/host/Kconfig                      |  13 +
 drivers/mmc/host/Makefile                     |   1 +
 drivers/mmc/host/litex_mmc.c                  | 661 ++++++++++++++++++
 5 files changed, 760 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/mmc/litex,mmc.yaml
 create mode 100644 drivers/mmc/host/litex_mmc.c
Signature · 1 line
2.31.1
#5 lore raw
Quoted 20 lines · Gabriel L. Somlo
Quoted 16 lines · Gabriel Somlo

Add support for the LiteX SD-Card device, LiteSDCard.

LiteSDCard is a simple SD-Card interface available as part of the LiteX environment, used with various RISC-V and other FPGA based SoCs.

New in v14:
Documentation/devicetree/bindings/mmc/litex,mmc.yaml:
- add missing vmmc-supply = ... property to example section

Quoted 7 lines

New in v13:
Documentation/devicetree/bindings/mmc/litex,mmc.yaml:
- add vmmc-supply requirement
drivers/mmc/host/Kconfig:
- add dependency on REGULATOR, REGULATOR_FIXED_VOLTAGE
drivers/mmc/host/litex_mmc.c:
- use mmc_regulator_get_supply(), with fallback to hardcoded 3.3V

Quoted 1 line

Ping?

Please don't ping during the merge window, unless it's a fix.

Although, as I have already started to prepare for applying a slew of patches, I can let you know that this series is going to be applied on Monday, when rc1 is out.

Kind regards
Uffe

Quoted 183 lines
Quoted 183 lines
Quoted 156 lines
Quoted 156 lines

New in v12:
drivers/mmc/host/Kconfig:
- add dependency on HAVE_CLK for litex_mmc driver
- (re)add "If unsure, say N" to the litex_mmc driver help message
drivers/mmc/host/litex_mmc.c:
- prints message using dev_info() before returning success from probe()

Quoted 147 lines

New in v11:
- picked up r/b from Andy
drivers/mmc/host/litex_mmc.c:
- defensive coding of litex_mmc_interrupt() return logic
- remove dev member of struct litex_mmc_host, only used during probe

Quoted 141 lines

New in v10:
drivers/mmc/host/litex_mmc.c:
- group linux/mmc/* includes by themselves
- clean-up of return style (multiple locations throughout source)
- create mmc_free_host() wrapper for use with devm_add_action_or_reset()
- use GFP_KERNEL with dmam_alloc_coherent()

Quoted 133 lines

New in v9:
drivers/mmc/host/Kconfig:
- fix OF dependency
drivers/mmc/host/litex_mmc.c:
- remove linux/of.h include, no longer needed since dropping of_match_ptr()
- add linux/mod_devicetable.h include
- use devm_action_or_reset() to devm-ify mmc_alloc_host(), and obviate the need to call mmc_free_host() explicitly during either probe() error path or during remove()

Quoted 122 lines

New in v8:
commit blurbs:
- cosmetic editing of descriptions
- removed Cc: lines
drivers/mmc/host/litex_mmc.c:
- fix file header comment (for real, this time)
- add explicit bits.h include
- remove of_match_ptr() wrapper from around .of_match_table argument
- fix devm ordering issues: use devm_request_irq(), which precludes the need to call free_irq() on probe() error path or from remove()

Quoted 111 lines

New in v7:

drivers/mmc/host/Kconfig:
- added module name in LiteSDCard Kconfig entry

drivers/mmc/host/litex_mmc.c:
- fixed comment formatting, ordering, and capitalization throughout the entire file
- sorted header #include statements
- removed redundant parantheses in readx_poll_timeout() condition
- explicit handling of readx_poll_timeout() timeout scenarios
- dev_err() used in litex_mmc_sdcard_wait_done()
- use memcpy_fromio() to grab command response
- no need to apply 0xffff mask to a 32-bit value right-shifted by 16 (host->resp[3])
- use clamp() instead of min(max(...)...)
- reworked platform_get_irq_optional() error handling logic
- no need to explicitly zero host->irq, kzalloc() does that already
- added missing free_irq() in litex_mmc_probe() error path
- reordered calls inside litex_mmc_remove() (calling mmc_free_host() before free_irq()

Quoted 89 lines

New in v6:

drivers/mmc/host/litex_mmc.c:
- fix handling of deferred probe vs. platform_get_irq_optional()
- don't #ifdef dma_set_mask_and_coherent(), since it automatically does the right thing on both 32- and 64-bit DMA capable arches
- remove MMC_CAP2_FULL_PWR_CYCLE, add MMC_CAP2_NO_MMC to list of hardcoded capabilities during litex_mmc_probe()
- hardcode mmc->ocr_avail to the full 2.7-3.6V range allowed by the SDCard spec (the LiteSDCard device doesn't accept software configuration)

Quoted 77 lines

New in v5:

MAINTAINERS:

- picked up a/b Mateusz

Doc/dt/bindings/mmc/litex,mmc.yaml:

- picked up r/b Rob, Joel

drivers/mmc/host/litex_mmc.c:

- shorten #define constant names (cosmetic, make them less unwieldy)
- picked up r/b Joel

Quoted 62 lines

New in v4:

Doc/dt/bindings/mmc/litex,mmc.yaml:

- fixed dt_binding_check errors uncovered by Rob's script

drivers/mmc/host/litex_mmc.c:

- struct litex_mmc_host fields re-ordered so that pahole reports no holes in either 32- or 64-bit builds
- litex_mmc_set_bus_width() now encapsulates check for host->is_bus_width_set
- litex_mmc_request() - factor out dma data setup into separate helper function: litex_mmc_do_dma()

Quoted 47 lines

New in v3:

MAINTAINERS:

- picked up acked-by Joel
- added listing for liteeth driver
- added Joel as additional co-maintainer (thanks!)

Doc/dt/bindings/mmc/litex,mmc.yaml:

- picked up r/b Geert Uytterhoeven <[email protected]> in DT
bindings document (please let me know if that was premature, and
happy to take further review if needed :)
- add dedicated DT property for source clock frequency

drivers/mmc/host/litex_mmc.c:

- fixed function signature (no line split), and naming (litex_mmc_*)
- more informative MODULE_AUTHOR() entries
- also added matching "Copyright" entries in file header
- fixed description in Kconfig
- fixed DT documentation
- removed magic constants
- removed litex_map_status(), have sdcard_wait_done() return *real*
error codes directly instead.
- streamlined litex_mmc_reponse_len()
- call litex_mmc_set_bus_width() only once, and ensure it returns
correct error code(s)
- use readx_poll_timeout() -- more concise -- instead of
read_poll_timeout()
- use dev_err() in litex_mmc_send_cmd() (instead of pr_err())
- litex_mmc_setclk() will update host->clock before returning
- separate irq initialization into its own function,
litex_mmc_irq_init()
- document rationale for f_min, f_max
- use dmam_alloc_coherent(), which simplifies cleanup significantly
- large `if (data) { ... }` block in litex_mmc_request() left as-is,
there are too many variables shared with the rest of the parent
function body to easily separate (e.g., `len`, `transfer`, `direct`).
If this is indeed a blocker, I can take another shot at refactoring
it in a future revision!
- bump dma_set_mask_and_coherent() to 64-bits on suitable
architectures
- clock source picked up from dedicated DT clock reference property
- remove gpio card-detect logic (needs testing and a dt binding
example before being eligible for upstream inclusion)

Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines

New in v2:
- reword info message in litex_set_clk()
- streamline code in litex_map_status()
- fix typos in Kconfig (thanks Randy Dunlap <[email protected]>)
- improvements suggested by Stafford Horne <[email protected]>
- allow COMPILE_TEST in Kconfig
- use read_poll_timeout() when waiting for cmd/data/DMA
xfer completion
- include interrupt.h (thanks kernel test robot <[email protected]>)

Gabriel Somlo (3):
MAINTAINERS: co-maintain LiteX platform
dt-bindings: mmc: Add bindings for LiteSDCard
mmc: Add driver for LiteX's LiteSDCard interface

 .../devicetree/bindings/mmc/litex,mmc.yaml    |  78 +++
 MAINTAINERS                                   |   9 +-
 drivers/mmc/host/Kconfig                      |  13 +
 drivers/mmc/host/Makefile                     |   1 +
 drivers/mmc/host/litex_mmc.c                  | 661 ++++++++++++++++++
 5 files changed, 760 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/mmc/litex,mmc.yaml
 create mode 100644 drivers/mmc/host/litex_mmc.c

--
2.31.1

#6 lore raw
In reply to Gabriel Somlo
Quoted 9 lines · Gabriel Somlo

Add support for the LiteX SD-Card device, LiteSDCard.

LiteSDCard is a simple SD-Card interface available as part of the LiteX environment, used with various RISC-V and other FPGA based SoCs.

New in v14:
Documentation/devicetree/bindings/mmc/litex,mmc.yaml:
- add missing vmmc-supply = ... property to example section

This v14 series applied for next, thanks!

[...]

Quoted 5 lines

Gabriel Somlo (3):
MAINTAINERS: co-maintain LiteX platform
dt-bindings: mmc: Add bindings for LiteSDCard
mmc: Add driver for LiteX's LiteSDCard interface

Quoted 9 lines
 .../devicetree/bindings/mmc/litex,mmc.yaml    |  78 +++
 MAINTAINERS                                   |   9 +-
 drivers/mmc/host/Kconfig                      |  13 +
 drivers/mmc/host/Makefile                     |   1 +
 drivers/mmc/host/litex_mmc.c                  | 661 ++++++++++++++++++
 5 files changed, 760 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/mmc/litex,mmc.yaml
 create mode 100644 drivers/mmc/host/litex_mmc.c

Kind regards
Uffe