[PATCH] spi: meson-spicc: add DMA support
Xianwei Zhao
xianwei.zhao at amlogic.com
Tue Apr 8 18:49:34 PDT 2025
Hi Neil,
Thanks for your reply.
On 2025/4/8 15:41, Neil Armstrong wrote:
> [ EXTERNAL EMAIL ]
>
> Hi,
>
> On 08/04/2025 09:04, Xianwei Zhao via B4 Relay wrote:
>> From: Xianwei Zhao <xianwei.zhao at amlogic.com>
>>
>> Add DMA support for spicc driver.
>>
>> DMA works if the transfer meets the following conditions:
>> 1. 64 bits per word;
>> 2. The transfer length must be multiples of the dma_burst_len,
>> and the dma_burst_len should be one of 8,7...2,
>> otherwise, it will be split into several SPI bursts.
>>
>> Signed-off-by: Sunny Luo <sunny.luo at amlogic.com>
>> Signed-off-by: Xianwei Zhao <xianwei.zhao at amlogic.com>
>> ---
>> drivers/spi/spi-meson-spicc.c | 243
>> ++++++++++++++++++++++++++++++++++++++++--
>> 1 file changed, 232 insertions(+), 11 deletions(-)
>>
>> diff --git a/drivers/spi/spi-meson-spicc.c
>> b/drivers/spi/spi-meson-spicc.c
>> index df74ad5060f8..81e263bceba9 100644
>> --- a/drivers/spi/spi-meson-spicc.c
>> +++ b/drivers/spi/spi-meson-spicc.c
>> @@ -21,6 +21,7 @@
>> #include <linux/interrupt.h>
>> #include <linux/reset.h>
>> #include <linux/pinctrl/consumer.h>
>> +#include <linux/dma-mapping.h>
>>
>> /*
>> * The Meson SPICC controller could support DMA based transfers, but
>> is not
>> @@ -33,6 +34,20 @@
>> * - CS management is dumb, and goes UP between every burst, so is
>> really a
>> * "Data Valid" signal than a Chip Select, GPIO link should be
>> used instead
>> * to have a CS go down over the full transfer
>> + *
>> + * DMA achieves a transfer with one or more SPI bursts, each SPI
>> burst is made
>> + * up of one or more DMA bursts. The DMA burst implementation
>> mechanism is,
>> + * For TX, when the number of words in TXFIFO is less than the preset
>> + * reading threshold, SPICC starts a reading DMA burst, which reads
>> the preset
>> + * number of words from TX buffer, then writes them into TXFIFO.
>> + * For RX, when the number of words in RXFIFO is greater than the preset
>> + * writing threshold, SPICC starts a writing request burst, which
>> reads the
>> + * preset number of words from RXFIFO, then write them into RX buffer.
>> + * DMA works if the transfer meets the following conditions,
>> + * - 64 bits per word
>> + * - The transfer length in word must be multiples of the
>> dma_burst_len, and
>> + * the dma_burst_len should be one of 8,7...2, otherwise, it will
>> be split
>> + * into several SPI bursts by this driver
>
> Fine, but then also rephrase the previous paragraph since you're adding
> DMA.
>
Will do.
> Could you precise on which platform you tested the DMA ?
>
aq222(S4)
>> */
>>
>> #define SPICC_MAX_BURST 128
>> @@ -128,6 +143,29 @@
>>
>> #define SPICC_DWADDR 0x24 /* Write Address of DMA */
>>
>> +#define SPICC_LD_CNTL0 0x28
>> +#define VSYNC_IRQ_SRC_SELECT BIT(0)
>> +#define DMA_EN_SET_BY_VSYNC BIT(2)
>> +#define XCH_EN_SET_BY_VSYNC BIT(3)
>> +#define DMA_READ_COUNTER_EN BIT(4)
>> +#define DMA_WRITE_COUNTER_EN BIT(5)
>> +#define DMA_RADDR_LOAD_BY_VSYNC BIT(6)
>> +#define DMA_WADDR_LOAD_BY_VSYNC BIT(7)
>> +#define DMA_ADDR_LOAD_FROM_LD_ADDR BIT(8)
>> +
>> +#define SPICC_LD_CNTL1 0x2c
>> +#define DMA_READ_COUNTER GENMASK(15, 0)
>> +#define DMA_WRITE_COUNTER GENMASK(31, 16)
>> +#define DMA_BURST_LEN_DEFAULT 8
>> +#define DMA_BURST_COUNT_MAX 0xffff
>> +#define SPI_BURST_LEN_MAX (DMA_BURST_LEN_DEFAULT *
>> DMA_BURST_COUNT_MAX)
>> +
>> +enum {
>> + DMA_TRIG_NORMAL = 0,
>> + DMA_TRIG_VSYNC,
>> + DMA_TRIG_LINE_N,
>
> You're only using DMA_TRIG_NORMAL, what the other 2 values for ?
>
DMA_TRIG_VSYNC and DMA_TRIG_LINE_N are used by VOUT modules in certain
partial TV SoCs. These DMA triggering methods rely on special signal
lines, and are not supported in this context. I will delete the
corresponding information.
>
>> +
>> #define SPICC_ENH_CTL0 0x38 /* Enhanced Feature */
>> #define SPICC_ENH_CLK_CS_DELAY_MASK GENMASK(15, 0)
>> #define SPICC_ENH_DATARATE_MASK GENMASK(23, 16)
>> @@ -171,6 +209,9 @@ struct meson_spicc_device {
>> struct pinctrl *pinctrl;
>> struct pinctrl_state *pins_idle_high;
>> struct pinctrl_state *pins_idle_low;
>> + dma_addr_t tx_dma;
>> + dma_addr_t rx_dma;
>> + bool using_dma;
>> };
>>
>> #define pow2_clk_to_spicc(_div) container_of(_div, struct
>> meson_spicc_device, pow2_div)
>> @@ -202,6 +243,155 @@ static void meson_spicc_oen_enable(struct
>> meson_spicc_device *spicc)
>> writel_relaxed(conf, spicc->base + SPICC_ENH_CTL0);
>> }
>>
>> +static int meson_spicc_dma_map(struct meson_spicc_device *spicc,
>> + struct spi_transfer *t)
>> +{
>> + struct device *dev = spicc->host->dev.parent;
>> +
>> + if (!(t->tx_buf && t->rx_buf))
>> + return -EINVAL;
>> +
>> + t->tx_dma = dma_map_single(dev, (void *)t->tx_buf, t->len,
>> DMA_TO_DEVICE);
>> + if (dma_mapping_error(dev, t->tx_dma))
>> + return -ENOMEM;
>> +
>> + t->rx_dma = dma_map_single(dev, t->rx_buf, t->len,
>> DMA_FROM_DEVICE);
>> + if (dma_mapping_error(dev, t->rx_dma))
>> + return -ENOMEM;
>> +
>> + spicc->tx_dma = t->tx_dma;
>> + spicc->rx_dma = t->rx_dma;
>> +
>> + return 0;
>> +}
>> +
>> +static void meson_spicc_dma_unmap(struct meson_spicc_device *spicc,
>> + struct spi_transfer *t)
>> +{
>> + struct device *dev = spicc->host->dev.parent;
>> +
>> + if (t->tx_dma)
>> + dma_unmap_single(dev, t->tx_dma, t->len, DMA_TO_DEVICE);
>> + if (t->rx_dma)
>> + dma_unmap_single(dev, t->rx_dma, t->len, DMA_FROM_DEVICE);
>> +}
>> +
>> +/*
>> + * According to the remain words length, calculate a suitable spi
>> burst length
>> + * and a dma burst length for current spi burst
>> + */
>> +static u32 meson_spicc_calc_dma_len(struct meson_spicc_device *spicc,
>> + u32 len, u32 *dma_burst_len)
>> +{
>> + u32 i;
>> +
>> + if (len <= spicc->data->fifo_size) {
>> + *dma_burst_len = len;
>> + return len;
>> + }
>> +
>> + *dma_burst_len = DMA_BURST_LEN_DEFAULT;
>> +
>> + if (len == (SPI_BURST_LEN_MAX + 1))
>> + return SPI_BURST_LEN_MAX - DMA_BURST_LEN_DEFAULT;
>> +
>> + if (len >= SPI_BURST_LEN_MAX)
>> + return SPI_BURST_LEN_MAX;
>> +
>> + for (i = DMA_BURST_LEN_DEFAULT; i > 1; i--)
>> + if ((len % i) == 0) {
>> + *dma_burst_len = i;
>> + return len;
>> + }
>> +
>> + i = len % DMA_BURST_LEN_DEFAULT;
>> + len -= i;
>> +
>> + if (i == 1)
>> + len -= DMA_BURST_LEN_DEFAULT;
>> +
>> + return len;
>> +}
>> +
>> +static void meson_spicc_setup_dma(struct meson_spicc_device *spicc,
>> u8 trig)
>> +{
>> + unsigned int len;
>> + unsigned int dma_burst_len, dma_burst_count;
>> + unsigned int count_en = 0;
>> + unsigned int txfifo_thres = 0;
>> + unsigned int read_req = 0;
>> + unsigned int rxfifo_thres = 31;
>> + unsigned int write_req = 0;
>> + unsigned int ld_ctr1 = 0;
>> +
>> + writel_relaxed(spicc->tx_dma, spicc->base + SPICC_DRADDR);
>> + writel_relaxed(spicc->rx_dma, spicc->base + SPICC_DWADDR);
>> +
>> + /* Set the max burst length to support a transmission with
>> length of
>> + * no more than 1024 bytes(128 words), which must use the CS
>> management
>> + * because of some strict timing requirements
>> + */
>> + writel_bits_relaxed(SPICC_BURSTLENGTH_MASK, SPICC_BURSTLENGTH_MASK,
>> + spicc->base + SPICC_CONREG);
>> +
>> + len = meson_spicc_calc_dma_len(spicc, spicc->xfer_remain,
>> + &dma_burst_len);
>> + spicc->xfer_remain -= len;
>> + dma_burst_count = DIV_ROUND_UP(len, dma_burst_len);
>> + dma_burst_len--;
>> +
>> + if (trig == DMA_TRIG_LINE_N)
>> + count_en |= VSYNC_IRQ_SRC_SELECT;
>
> Is this the VPU VSYNC irq ? is this a tested and valid usecase ?
>
Yes, it is VPU VSYNC irq, This part of the code is not completely. NO
tested about it. I will delete it.
>> +
>> + if (spicc->tx_dma) {
>> + spicc->tx_dma += len;
>> + count_en |= DMA_READ_COUNTER_EN;
>> + if (trig == DMA_TRIG_VSYNC || trig == DMA_TRIG_LINE_N)
>> + count_en |= DMA_RADDR_LOAD_BY_VSYNC
>> + | DMA_ADDR_LOAD_FROM_LD_ADDR;
>> + txfifo_thres = spicc->data->fifo_size - dma_burst_len;
>> + read_req = dma_burst_len;
>> + ld_ctr1 |= FIELD_PREP(DMA_READ_COUNTER, dma_burst_count);
>> + }
>> +
>> + if (spicc->rx_dma) {
>> + spicc->rx_dma += len;
>> + count_en |= DMA_WRITE_COUNTER_EN;
>> + if (trig == DMA_TRIG_VSYNC || trig == DMA_TRIG_LINE_N)
>> + count_en |= DMA_WADDR_LOAD_BY_VSYNC
>> + | DMA_ADDR_LOAD_FROM_LD_ADDR;
>> + rxfifo_thres = dma_burst_len;
>> + write_req = dma_burst_len;
>> + ld_ctr1 |= FIELD_PREP(DMA_WRITE_COUNTER, dma_burst_count);
>> + }
>> +
>> + writel_relaxed(count_en, spicc->base + SPICC_LD_CNTL0);
>> + writel_relaxed(ld_ctr1, spicc->base + SPICC_LD_CNTL1);
>> + writel_relaxed(((trig == DMA_TRIG_NORMAL) ? SPICC_DMA_ENABLE : 0)
>> + | SPICC_DMA_URGENT
>> + | FIELD_PREP(SPICC_TXFIFO_THRESHOLD_MASK, txfifo_thres)
>> + | FIELD_PREP(SPICC_READ_BURST_MASK, read_req)
>> + | FIELD_PREP(SPICC_RXFIFO_THRESHOLD_MASK, rxfifo_thres)
>> + | FIELD_PREP(SPICC_WRITE_BURST_MASK, write_req),
>> + spicc->base + SPICC_DMAREG);
>> +}
>> +
>> +static void meson_spicc_dma_irq(struct meson_spicc_device *spicc)
>> +{
>> + if (readl_relaxed(spicc->base + SPICC_DMAREG) & SPICC_DMA_ENABLE)
>> + return;
>> +
>> + if (spicc->xfer_remain) {
>> + meson_spicc_setup_dma(spicc, DMA_TRIG_NORMAL);
>> + } else {
>> + writel_bits_relaxed(SPICC_SMC, 0, spicc->base +
>> SPICC_CONREG);
>> + writel_relaxed(0, spicc->base + SPICC_INTREG);
>> + writel_relaxed(0, spicc->base + SPICC_DMAREG);
>> + meson_spicc_dma_unmap(spicc, spicc->xfer);
>> + complete(&spicc->done);
>> + }
>> +}
>> +
>> static inline bool meson_spicc_txfull(struct meson_spicc_device *spicc)
>> {
>> return !!FIELD_GET(SPICC_TF,
>> @@ -293,6 +483,11 @@ static irqreturn_t meson_spicc_irq(int irq, void
>> *data)
>>
>> writel_bits_relaxed(SPICC_TC, SPICC_TC, spicc->base +
>> SPICC_STATREG);
>>
>> + if (spicc->using_dma) {
>> + meson_spicc_dma_irq(spicc);
>> + return IRQ_HANDLED;
>> + }
>
> Make meson_spicc_dma_irq() return irqreturn_t and return IRQ_HANDLED.
>
Will do.
>> +
>> /* Empty RX FIFO */
>> meson_spicc_rx(spicc);
>>
>> @@ -426,9 +621,6 @@ static int meson_spicc_transfer_one(struct
>> spi_controller *host,
>>
>> meson_spicc_reset_fifo(spicc);
>>
>> - /* Setup burst */
>> - meson_spicc_setup_burst(spicc);
>> -
>> /* Setup wait for completion */
>> reinit_completion(&spicc->done);
>>
>> @@ -442,11 +634,40 @@ static int meson_spicc_transfer_one(struct
>> spi_controller *host,
>> /* Increase it twice and add 200 ms tolerance */
>> timeout += timeout + 200;
>>
>> - /* Start burst */
>> - writel_bits_relaxed(SPICC_XCH, SPICC_XCH, spicc->base +
>> SPICC_CONREG);
>> + if (xfer->bits_per_word == 64) {
>> + int ret;
>>
>> - /* Enable interrupts */
>> - writel_relaxed(SPICC_TC_EN, spicc->base + SPICC_INTREG);
>> + /* must tx */
>> + if (!xfer->tx_buf)
>> + return -EINVAL;
>> +
>> + /* dma_burst_len 1 can't trigger a dma burst */
>> + if (xfer->len < 16)
>> + return -EINVAL;
>
> Those 2 checks should be done to enable the DMA mode, you should
> fallback to FIFO mode
> instead of returning EINVAL, except if 64 bits_per_word is only valid in
> DMA mode ?
>
I only support DMA when bits_per_word equals 64, because the register
operation is more complicated if use PIO module. The register is 32 bits
wide, a word needs to be written twice to the register.
>> +
>> + ret = meson_spicc_dma_map(spicc, xfer);
>> + if (ret) {
>> + meson_spicc_dma_unmap(spicc, xfer);
>> + dev_err(host->dev.parent, "dma map failed\n");
>> + return ret;
>> + }
>> +
>> + spicc->using_dma = true;
>> + spicc->xfer_remain = DIV_ROUND_UP(xfer->len,
>> spicc->bytes_per_word);
>> + meson_spicc_setup_dma(spicc, DMA_TRIG_NORMAL);
>> + writel_relaxed(SPICC_TE_EN, spicc->base + SPICC_INTREG);
>> + writel_bits_relaxed(SPICC_SMC, SPICC_SMC, spicc->base +
>> SPICC_CONREG);
>> + } else {
>> + spicc->using_dma = false;
>> + /* Setup burst */
>> + meson_spicc_setup_burst(spicc);
>> +
>> + /* Start burst */
>> + writel_bits_relaxed(SPICC_XCH, SPICC_XCH, spicc->base +
>> SPICC_CONREG);
>> +
>> + /* Enable interrupts */
>> + writel_relaxed(SPICC_TC_EN, spicc->base + SPICC_INTREG);
>> + }
>>
>> if (!wait_for_completion_timeout(&spicc->done,
>> msecs_to_jiffies(timeout)))
>> return -ETIMEDOUT;
>> @@ -853,10 +1074,10 @@ static int meson_spicc_probe(struct
>> platform_device *pdev)
>> host->num_chipselect = 4;
>> host->dev.of_node = pdev->dev.of_node;
>> host->mode_bits = SPI_CPHA | SPI_CPOL | SPI_CS_HIGH | SPI_LOOP;
>> - host->bits_per_word_mask = SPI_BPW_MASK(32) |
>> - SPI_BPW_MASK(24) |
>> - SPI_BPW_MASK(16) |
>> - SPI_BPW_MASK(8);
>> + /* DMA works at 64 bits, but it is invalidated by the spi core,
>> + * clr the mask to avoid the spi core validation check
>> + */
>> + host->bits_per_word_mask = 0;
>
> Fine, instead please add a check in meson_spicc_setup() to make sure
> we operate only in 8, 16, 24, 32 & 64 bits_per_word.
>
> So not need to clear it, the host buffer was allocated with
> spi_alloc_host() which
> allocates with kzalloc(), already zeroing the allocated memory.
>
Will drop this line, and check bits_per_word in meson_spicc_setup.
> Neil
>
>> host->flags = (SPI_CONTROLLER_MUST_RX | SPI_CONTROLLER_MUST_TX);
>> host->min_speed_hz = spicc->data->min_speed_hz;
>> host->max_speed_hz = spicc->data->max_speed_hz;
>>
>> ---
>> base-commit: 49807ed87851916ef655f72e9562f96355183090
>> change-id: 20250408-spi-dma-c499f560d295
>>
>> Best regards,
>
> With those fixed, the path is clear & clean, thanks !
>
> Neil
More information about the linux-arm-kernel
mailing list