mirror of
https://mirrors.bfsu.edu.cn/git/linux.git
synced 2024-12-14 22:44:27 +08:00
08ba93064e
Baikal-T1 SoC provides a DW DMA controller to perform low-speed peripherals Mem-to-Dev and Dev-to-Mem transaction. This is also applicable to the DW APB SSI devices embedded into the SoC. Currently the DMA-based transfers are supported by the DW APB SPI driver only as a middle layer code for Intel MID/Elkhart PCI devices. Seeing the same code can be used for normal platform DMAC device we introduced a set of patches to fix it within this series. First of all we need to add the Tx and Rx DMA channels support into the DW APB SSI binding. Then there are several fixes and cleanups provided as a initial preparation for the Generic DMA support integration: add Tx/Rx finish wait methods, clear DMAC register when done or stopped, Fix native CS being unset, enable interrupts in accordance with DMA xfer mode, discard static DW DMA slave structures, discard unused void priv pointer and dma_width member of the dw_spi structure, provide the DMA Tx/Rx burst length parametrisation and make sure it's optionally set in accordance with the DMA max-burst capability. In order to have the DW APB SSI MMIO driver working with DMA we need to initialize the paddr field with the physical base address of the DW APB SSI registers space. Then we unpin the Intel MID specific code from the generic DMA one and placed it into the spi-dw-pci.c driver, which is a better place for it anyway. After that the naming cleanups are performed since the code is going to be used for a generic DMAC device. Finally the Generic DMA initialization can be added to the generic version of the DW APB SSI IP. Last but not least we traditionally convert the legacy plain text-based dt-binding file with yaml-based one and as a cherry on a cake replace the manually written DebugFS registers read method with a ready-to-use for the same purpose regset32 DebugFS interface usage. This patchset is rebased and tested on the spi/for-next (5.7-rc5): base-commit: fe9fce6b2cf3 ("Merge remote-tracking branch 'spi/for-5.8' into spi-next") Link: https://lore.kernel.org/linux-spi/20200508132943.9826-1-Sergey.Semin@baikalelectronics.ru/ Changelog v2: - Rebase on top of the spi repository for-next branch. - Move bindings conversion patch to the tail of the series. - Move fixes to the head of the series. - Apply as many changes as possible to be applied the Generic DMA functionality support is added and the spi-dw-mid is moved to the spi-dw-dma driver. - Discard patch "spi: dw: Fix dma_slave_config used partly uninitialized" since the problem has already been fixed. - Add new patch "spi: dw: Discard unused void priv pointer". - Add new patch "spi: dw: Discard dma_width member of the dw_spi structure". n_bytes member of the DW SPI data can be used instead. - Build the DMA functionality into the DW APB SSI core if required instead of creating a separate kernel module. - Use conditional statement instead of the ternary operator in the ref clock getter. Link: https://lore.kernel.org/linux-spi/20200515104758.6934-1-Sergey.Semin@baikalelectronics.ru/ Changelog v3: - Use spi_delay_exec() method to wait for the DMA operation completion. - Explicitly initialize the dw_dma_slave members on stack. - Discard the dws->fifo_len utilization in the Tx FIFO DMA threshold setting from the patch where we just add the default burst length constants. - Use min() method to calculate the optimal burst values. - Add new patch which moves the spi-dw.c source file to spi-dw-core.c in order to preserve the DW APB SSI core driver name. - Add commas in the debugfs_reg32 structure initializer and after the last entry of the dw_spi_dbgfs_regs array. Link: https://lore.kernel.org/linux-spi/20200521012206.14472-1-Sergey.Semin@baikalelectronics.ru Changelog v4: - Get back ndelay() method to wait for an SPI transfer completion. spi_delay_exec() isn't suitable for the atomic context. Link: https://lore.kernel.org/linux-spi/20200522000806.7381-1-Sergey.Semin@baikalelectronics.ru Changelog v5: - Refactor the Tx/Rx DMA-based SPI transfers wait methods. - Add a new patch "spi: dw: Set xfer effective_speed_hz". - Add a new patch "spi: dw: Return any value retrieved from the dma_transfer callback" as a preparation patch before implementing the local DMA, Tx SPI and Rx SPI transfers wait methods. - Add a new patch "spi: dw: Locally wait for the DMA transactions completion", which provides a local DMA transaction complete method - Create a dedicated patch which adds the Rx-done wait method: "spi: dw: Add SPI Rx-done wait method to DMA-based transfer". - Add more detailed description of the problems the Tx/Rx-wait methods-related patches fix. - Wait for the SPI Tx and Rx transfers being finished in the mid_spi_dma_transfer() method executed in the task context. - Use spi_delay_exec() to wait for the SPI Tx/Rx completion, since now the driver calls the wait methods in the kernel thread context. - Use SPI_DELAY_UNIT_SCK spi_delay unit for Tx-wait delay, since SPI xfer's are now have the effective_speed_hz initialized. - Rx-wait for a delay correlated with the APB/SSI synchronous clock rate instead of using the SPI bus clock rate. Link: https://lore.kernel.org/linux-spi/20200529035915.20790-1-Sergey.Semin@baikalelectronics.ru Changelog v6: - Provide a more detailed description of the patch: 2901db35bea1 ("spi: dw: Locally wait for the DMA transfers completion") - Calculate the Rx delay with better accuracy by moving 4-multiplication to the head of the formulae: ns = 4U * NSEC_PER_SEC / dws->max_freq * nents. Co-developed-by: Georgy Vlasov <Georgy.Vlasov@baikalelectronics.ru> Signed-off-by: Georgy Vlasov <Georgy.Vlasov@baikalelectronics.ru> Co-developed-by: Ramil Zaripov <Ramil.Zaripov@baikalelectronics.ru> Signed-off-by: Ramil Zaripov <Ramil.Zaripov@baikalelectronics.ru> Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru> Cc: Alexey Malahov <Alexey.Malahov@baikalelectronics.ru> Cc: Maxim Kaurkin <Maxim.Kaurkin@baikalelectronics.ru> Cc: Pavel Parkhomenko <Pavel.Parkhomenko@baikalelectronics.ru> Cc: Ekaterina Skachko <Ekaterina.Skachko@baikalelectronics.ru> Cc: Vadim Vlasov <V.Vlasov@baikalelectronics.ru> Cc: Alexey Kolotnikov <Alexey.Kolotnikov@baikalelectronics.ru> Cc: Thomas Bogendoerfer <tsbogend@alpha.franken.de> Cc: Arnd Bergmann <arnd@arndb.de> Cc: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Cc: Feng Tang <feng.tang@intel.com> Cc: Rob Herring <robh+dt@kernel.org> Cc: linux-mips@vger.kernel.org Cc: linux-spi@vger.kernel.org Cc: devicetree@vger.kernel.org Cc: linux-kernel@vger.kernel.org Serge Semin (16): spi: dw: Set xfer effective_speed_hz spi: dw: Return any value retrieved from the dma_transfer callback spi: dw: Locally wait for the DMA transfers completion spi: dw: Add SPI Tx-done wait method to DMA-based transfer spi: dw: Add SPI Rx-done wait method to DMA-based transfer spi: dw: Parameterize the DMA Rx/Tx burst length spi: dw: Use DMA max burst to set the request thresholds spi: dw: Fix Rx-only DMA transfers spi: dw: Add core suffix to the DW APB SSI core source file spi: dw: Move Non-DMA code to the DW PCIe-SPI driver spi: dw: Remove DW DMA code dependency from DW_DMAC_PCI spi: dw: Add DW SPI DMA/PCI/MMIO dependency on the DW SPI core spi: dw: Cleanup generic DW DMA code namings spi: dw: Add DMA support to the DW SPI MMIO driver spi: dw: Use regset32 DebugFS method to create regdump file dt-bindings: spi: Convert DW SPI binding to DT schema .../bindings/spi/snps,dw-apb-ssi.txt | 44 -- .../bindings/spi/snps,dw-apb-ssi.yaml | 127 +++++ .../devicetree/bindings/spi/spi-dw.txt | 24 - drivers/spi/Kconfig | 15 +- drivers/spi/Makefile | 5 +- drivers/spi/{spi-dw.c => spi-dw-core.c} | 95 ++-- drivers/spi/spi-dw-dma.c | 482 ++++++++++++++++++ drivers/spi/spi-dw-mid.c | 382 -------------- drivers/spi/spi-dw-mmio.c | 4 + drivers/spi/spi-dw-pci.c | 50 +- drivers/spi/spi-dw.h | 20 +- 11 files changed, 719 insertions(+), 529 deletions(-) delete mode 100644 Documentation/devicetree/bindings/spi/snps,dw-apb-ssi.txt create mode 100644 Documentation/devicetree/bindings/spi/snps,dw-apb-ssi.yaml delete mode 100644 Documentation/devicetree/bindings/spi/spi-dw.txt rename drivers/spi/{spi-dw.c => spi-dw-core.c} (82%) create mode 100644 drivers/spi/spi-dw-dma.c delete mode 100644 drivers/spi/spi-dw-mid.c -- 2.26.2
326 lines
8.4 KiB
C
326 lines
8.4 KiB
C
// SPDX-License-Identifier: GPL-2.0-only
|
|
/*
|
|
* Memory-mapped interface driver for DW SPI Core
|
|
*
|
|
* Copyright (c) 2010, Octasic semiconductor.
|
|
*/
|
|
|
|
#include <linux/clk.h>
|
|
#include <linux/err.h>
|
|
#include <linux/platform_device.h>
|
|
#include <linux/pm_runtime.h>
|
|
#include <linux/slab.h>
|
|
#include <linux/spi/spi.h>
|
|
#include <linux/scatterlist.h>
|
|
#include <linux/mfd/syscon.h>
|
|
#include <linux/module.h>
|
|
#include <linux/of.h>
|
|
#include <linux/of_platform.h>
|
|
#include <linux/acpi.h>
|
|
#include <linux/property.h>
|
|
#include <linux/regmap.h>
|
|
#include <linux/reset.h>
|
|
|
|
#include "spi-dw.h"
|
|
|
|
#define DRIVER_NAME "dw_spi_mmio"
|
|
|
|
struct dw_spi_mmio {
|
|
struct dw_spi dws;
|
|
struct clk *clk;
|
|
struct clk *pclk;
|
|
void *priv;
|
|
struct reset_control *rstc;
|
|
};
|
|
|
|
#define MSCC_CPU_SYSTEM_CTRL_GENERAL_CTRL 0x24
|
|
#define OCELOT_IF_SI_OWNER_OFFSET 4
|
|
#define JAGUAR2_IF_SI_OWNER_OFFSET 6
|
|
#define MSCC_IF_SI_OWNER_MASK GENMASK(1, 0)
|
|
#define MSCC_IF_SI_OWNER_SISL 0
|
|
#define MSCC_IF_SI_OWNER_SIBM 1
|
|
#define MSCC_IF_SI_OWNER_SIMC 2
|
|
|
|
#define MSCC_SPI_MST_SW_MODE 0x14
|
|
#define MSCC_SPI_MST_SW_MODE_SW_PIN_CTRL_MODE BIT(13)
|
|
#define MSCC_SPI_MST_SW_MODE_SW_SPI_CS(x) (x << 5)
|
|
|
|
/*
|
|
* For Keem Bay, CTRLR0[31] is used to select controller mode.
|
|
* 0: SSI is slave
|
|
* 1: SSI is master
|
|
*/
|
|
#define KEEMBAY_CTRLR0_SSIC_IS_MST BIT(31)
|
|
|
|
struct dw_spi_mscc {
|
|
struct regmap *syscon;
|
|
void __iomem *spi_mst;
|
|
};
|
|
|
|
/*
|
|
* The Designware SPI controller (referred to as master in the documentation)
|
|
* automatically deasserts chip select when the tx fifo is empty. The chip
|
|
* selects then needs to be either driven as GPIOs or, for the first 4 using the
|
|
* the SPI boot controller registers. the final chip select is an OR gate
|
|
* between the Designware SPI controller and the SPI boot controller.
|
|
*/
|
|
static void dw_spi_mscc_set_cs(struct spi_device *spi, bool enable)
|
|
{
|
|
struct dw_spi *dws = spi_master_get_devdata(spi->master);
|
|
struct dw_spi_mmio *dwsmmio = container_of(dws, struct dw_spi_mmio, dws);
|
|
struct dw_spi_mscc *dwsmscc = dwsmmio->priv;
|
|
u32 cs = spi->chip_select;
|
|
|
|
if (cs < 4) {
|
|
u32 sw_mode = MSCC_SPI_MST_SW_MODE_SW_PIN_CTRL_MODE;
|
|
|
|
if (!enable)
|
|
sw_mode |= MSCC_SPI_MST_SW_MODE_SW_SPI_CS(BIT(cs));
|
|
|
|
writel(sw_mode, dwsmscc->spi_mst + MSCC_SPI_MST_SW_MODE);
|
|
}
|
|
|
|
dw_spi_set_cs(spi, enable);
|
|
}
|
|
|
|
static int dw_spi_mscc_init(struct platform_device *pdev,
|
|
struct dw_spi_mmio *dwsmmio,
|
|
const char *cpu_syscon, u32 if_si_owner_offset)
|
|
{
|
|
struct dw_spi_mscc *dwsmscc;
|
|
|
|
dwsmscc = devm_kzalloc(&pdev->dev, sizeof(*dwsmscc), GFP_KERNEL);
|
|
if (!dwsmscc)
|
|
return -ENOMEM;
|
|
|
|
dwsmscc->spi_mst = devm_platform_ioremap_resource(pdev, 1);
|
|
if (IS_ERR(dwsmscc->spi_mst)) {
|
|
dev_err(&pdev->dev, "SPI_MST region map failed\n");
|
|
return PTR_ERR(dwsmscc->spi_mst);
|
|
}
|
|
|
|
dwsmscc->syscon = syscon_regmap_lookup_by_compatible(cpu_syscon);
|
|
if (IS_ERR(dwsmscc->syscon))
|
|
return PTR_ERR(dwsmscc->syscon);
|
|
|
|
/* Deassert all CS */
|
|
writel(0, dwsmscc->spi_mst + MSCC_SPI_MST_SW_MODE);
|
|
|
|
/* Select the owner of the SI interface */
|
|
regmap_update_bits(dwsmscc->syscon, MSCC_CPU_SYSTEM_CTRL_GENERAL_CTRL,
|
|
MSCC_IF_SI_OWNER_MASK << if_si_owner_offset,
|
|
MSCC_IF_SI_OWNER_SIMC << if_si_owner_offset);
|
|
|
|
dwsmmio->dws.set_cs = dw_spi_mscc_set_cs;
|
|
dwsmmio->priv = dwsmscc;
|
|
|
|
/* Register hook to configure CTRLR0 */
|
|
dwsmmio->dws.update_cr0 = dw_spi_update_cr0;
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int dw_spi_mscc_ocelot_init(struct platform_device *pdev,
|
|
struct dw_spi_mmio *dwsmmio)
|
|
{
|
|
return dw_spi_mscc_init(pdev, dwsmmio, "mscc,ocelot-cpu-syscon",
|
|
OCELOT_IF_SI_OWNER_OFFSET);
|
|
}
|
|
|
|
static int dw_spi_mscc_jaguar2_init(struct platform_device *pdev,
|
|
struct dw_spi_mmio *dwsmmio)
|
|
{
|
|
return dw_spi_mscc_init(pdev, dwsmmio, "mscc,jaguar2-cpu-syscon",
|
|
JAGUAR2_IF_SI_OWNER_OFFSET);
|
|
}
|
|
|
|
static int dw_spi_alpine_init(struct platform_device *pdev,
|
|
struct dw_spi_mmio *dwsmmio)
|
|
{
|
|
dwsmmio->dws.cs_override = 1;
|
|
|
|
/* Register hook to configure CTRLR0 */
|
|
dwsmmio->dws.update_cr0 = dw_spi_update_cr0;
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int dw_spi_dw_apb_init(struct platform_device *pdev,
|
|
struct dw_spi_mmio *dwsmmio)
|
|
{
|
|
/* Register hook to configure CTRLR0 */
|
|
dwsmmio->dws.update_cr0 = dw_spi_update_cr0;
|
|
|
|
dw_spi_dma_setup_generic(&dwsmmio->dws);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int dw_spi_dwc_ssi_init(struct platform_device *pdev,
|
|
struct dw_spi_mmio *dwsmmio)
|
|
{
|
|
/* Register hook to configure CTRLR0 */
|
|
dwsmmio->dws.update_cr0 = dw_spi_update_cr0_v1_01a;
|
|
|
|
dw_spi_dma_setup_generic(&dwsmmio->dws);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static u32 dw_spi_update_cr0_keembay(struct spi_controller *master,
|
|
struct spi_device *spi,
|
|
struct spi_transfer *transfer)
|
|
{
|
|
u32 cr0 = dw_spi_update_cr0_v1_01a(master, spi, transfer);
|
|
|
|
return cr0 | KEEMBAY_CTRLR0_SSIC_IS_MST;
|
|
}
|
|
|
|
static int dw_spi_keembay_init(struct platform_device *pdev,
|
|
struct dw_spi_mmio *dwsmmio)
|
|
{
|
|
/* Register hook to configure CTRLR0 */
|
|
dwsmmio->dws.update_cr0 = dw_spi_update_cr0_keembay;
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int dw_spi_mmio_probe(struct platform_device *pdev)
|
|
{
|
|
int (*init_func)(struct platform_device *pdev,
|
|
struct dw_spi_mmio *dwsmmio);
|
|
struct dw_spi_mmio *dwsmmio;
|
|
struct resource *mem;
|
|
struct dw_spi *dws;
|
|
int ret;
|
|
int num_cs;
|
|
|
|
dwsmmio = devm_kzalloc(&pdev->dev, sizeof(struct dw_spi_mmio),
|
|
GFP_KERNEL);
|
|
if (!dwsmmio)
|
|
return -ENOMEM;
|
|
|
|
dws = &dwsmmio->dws;
|
|
|
|
/* Get basic io resource and map it */
|
|
dws->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &mem);
|
|
if (IS_ERR(dws->regs))
|
|
return PTR_ERR(dws->regs);
|
|
|
|
dws->paddr = mem->start;
|
|
|
|
dws->irq = platform_get_irq(pdev, 0);
|
|
if (dws->irq < 0)
|
|
return dws->irq; /* -ENXIO */
|
|
|
|
dwsmmio->clk = devm_clk_get(&pdev->dev, NULL);
|
|
if (IS_ERR(dwsmmio->clk))
|
|
return PTR_ERR(dwsmmio->clk);
|
|
ret = clk_prepare_enable(dwsmmio->clk);
|
|
if (ret)
|
|
return ret;
|
|
|
|
/* Optional clock needed to access the registers */
|
|
dwsmmio->pclk = devm_clk_get_optional(&pdev->dev, "pclk");
|
|
if (IS_ERR(dwsmmio->pclk)) {
|
|
ret = PTR_ERR(dwsmmio->pclk);
|
|
goto out_clk;
|
|
}
|
|
ret = clk_prepare_enable(dwsmmio->pclk);
|
|
if (ret)
|
|
goto out_clk;
|
|
|
|
/* find an optional reset controller */
|
|
dwsmmio->rstc = devm_reset_control_get_optional_exclusive(&pdev->dev, "spi");
|
|
if (IS_ERR(dwsmmio->rstc)) {
|
|
ret = PTR_ERR(dwsmmio->rstc);
|
|
goto out_clk;
|
|
}
|
|
reset_control_deassert(dwsmmio->rstc);
|
|
|
|
dws->bus_num = pdev->id;
|
|
|
|
dws->max_freq = clk_get_rate(dwsmmio->clk);
|
|
|
|
device_property_read_u32(&pdev->dev, "reg-io-width", &dws->reg_io_width);
|
|
|
|
num_cs = 4;
|
|
|
|
device_property_read_u32(&pdev->dev, "num-cs", &num_cs);
|
|
|
|
dws->num_cs = num_cs;
|
|
|
|
init_func = device_get_match_data(&pdev->dev);
|
|
if (init_func) {
|
|
ret = init_func(pdev, dwsmmio);
|
|
if (ret)
|
|
goto out;
|
|
}
|
|
|
|
pm_runtime_enable(&pdev->dev);
|
|
|
|
ret = dw_spi_add_host(&pdev->dev, dws);
|
|
if (ret)
|
|
goto out;
|
|
|
|
platform_set_drvdata(pdev, dwsmmio);
|
|
return 0;
|
|
|
|
out:
|
|
pm_runtime_disable(&pdev->dev);
|
|
clk_disable_unprepare(dwsmmio->pclk);
|
|
out_clk:
|
|
clk_disable_unprepare(dwsmmio->clk);
|
|
reset_control_assert(dwsmmio->rstc);
|
|
|
|
return ret;
|
|
}
|
|
|
|
static int dw_spi_mmio_remove(struct platform_device *pdev)
|
|
{
|
|
struct dw_spi_mmio *dwsmmio = platform_get_drvdata(pdev);
|
|
|
|
dw_spi_remove_host(&dwsmmio->dws);
|
|
pm_runtime_disable(&pdev->dev);
|
|
clk_disable_unprepare(dwsmmio->pclk);
|
|
clk_disable_unprepare(dwsmmio->clk);
|
|
reset_control_assert(dwsmmio->rstc);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static const struct of_device_id dw_spi_mmio_of_match[] = {
|
|
{ .compatible = "snps,dw-apb-ssi", .data = dw_spi_dw_apb_init},
|
|
{ .compatible = "mscc,ocelot-spi", .data = dw_spi_mscc_ocelot_init},
|
|
{ .compatible = "mscc,jaguar2-spi", .data = dw_spi_mscc_jaguar2_init},
|
|
{ .compatible = "amazon,alpine-dw-apb-ssi", .data = dw_spi_alpine_init},
|
|
{ .compatible = "renesas,rzn1-spi", .data = dw_spi_dw_apb_init},
|
|
{ .compatible = "snps,dwc-ssi-1.01a", .data = dw_spi_dwc_ssi_init},
|
|
{ .compatible = "intel,keembay-ssi", .data = dw_spi_keembay_init},
|
|
{ /* end of table */}
|
|
};
|
|
MODULE_DEVICE_TABLE(of, dw_spi_mmio_of_match);
|
|
|
|
#ifdef CONFIG_ACPI
|
|
static const struct acpi_device_id dw_spi_mmio_acpi_match[] = {
|
|
{"HISI0173", (kernel_ulong_t)dw_spi_dw_apb_init},
|
|
{},
|
|
};
|
|
MODULE_DEVICE_TABLE(acpi, dw_spi_mmio_acpi_match);
|
|
#endif
|
|
|
|
static struct platform_driver dw_spi_mmio_driver = {
|
|
.probe = dw_spi_mmio_probe,
|
|
.remove = dw_spi_mmio_remove,
|
|
.driver = {
|
|
.name = DRIVER_NAME,
|
|
.of_match_table = dw_spi_mmio_of_match,
|
|
.acpi_match_table = ACPI_PTR(dw_spi_mmio_acpi_match),
|
|
},
|
|
};
|
|
module_platform_driver(dw_spi_mmio_driver);
|
|
|
|
MODULE_AUTHOR("Jean-Hugues Deschenes <jean-hugues.deschenes@octasic.com>");
|
|
MODULE_DESCRIPTION("Memory-mapped I/O interface driver for DW SPI Core");
|
|
MODULE_LICENSE("GPL v2");
|