On 23/09/2020 9.34, Vinod Koul wrote:
> Some complex dmaengine controllers have capability to program the
> peripheral device, so pass on the peripheral configuration as part of
> dma_slave_config
>
> Signed-off-by: Vinod Koul <vkoul@xxxxxxxxxx>
> ---
> include/linux/dmaengine.h | 91 +++++++++++++++++++++++++++++++++++++++
> 1 file changed, 91 insertions(+)
>
> diff --git a/include/linux/dmaengine.h b/include/linux/dmaengine.h
> index 6fbd5c99e30c..bbc32271ad7f 100644
> --- a/include/linux/dmaengine.h
> +++ b/include/linux/dmaengine.h
> @@ -380,6 +380,94 @@ enum dma_slave_buswidth {
> DMA_SLAVE_BUSWIDTH_64_BYTES = 64,
> };
>
> +/**
> + * enum spi_transfer_cmd - spi transfer commands
> + */
> +enum spi_transfer_cmd {
> + SPI_TX = 1,
> + SPI_RX,
> + SPI_DUPLEX,
> +};
> +
> +/**
> + * struct dmaengine_spi_config - spi config for peripheral
> + *
> + * @loopback_en: spi loopback enable when set
> + * @clock_pol: clock polarity
> + * @data_pol: data polarity
*_pol_high ?
> + * @pack_en: process tx/rx buffers as packed
what does this mean?
> + * @word_len: spi word length
> + * @clk_div: source clock divider
> + * @clk_src: serial clock
we tend to use common clock framework for clock configuration?
> + * @cmd: spi cmd
> + * @cs: chip select toggle
> + */
> +struct dmaengine_spi_config {
> + u8 loopback_en;
> + u8 clock_pol;
> + u8 data_pol;
> + u8 pack_en;
> + u8 word_len;
> + u32 clk_div;
> + u32 clk_src;
> + u8 fragmentation;
This is not documented and I can not really guess what it is.
> + enum spi_transfer_cmd cmd;
> + u8 cs;
> +};
> +
> +enum i2c_op {
> + I2C_WRITE = 1,
> + I2C_READ,
> +};
> +
> +/**
> + * struct dmaengine_i2c_config - i2c config for peripheral
> + *
> + * @pack_enable: process tx/rx buffers as packed
Is this the same thing as with the spi?
> + * @cycle_count: clock cycles to be sent
> + * @high_count: high period of clock
> + * @low_count: low period of clock
> + * @clk_div: source clock divider
> + * @addr: i2c bus address
> + * @stretch: stretch the clock at eot
> + * @op: i2c cmd
> + */
> +struct dmaengine_i2c_config {
> + u8 pack_enable;
> + u8 cycle_count;
> + u8 high_count;
> + u8 low_count;
> + u16 clk_div;
> + u8 addr;
> + u8 stretch;
> + enum i2c_op op;
> + bool multi_msg;
Not documented.
Is it indicates multiple-byte read/write or multiple messages?
> +};
> +
> +enum dmaengine_peripheral {
> + DMAENGINE_PERIPHERAL_SPI = 1,
> + DMAENGINE_PERIPHERAL_UART = 2,
> + DMAENGINE_PERIPHERAL_I2C = 3,
> + DMAENGINE_PERIPHERAL_LAST = DMAENGINE_PERIPHERAL_I2C,
> +};
> +
> +/**
> + * struct dmaengine_peripheral_config - peripheral configuration for
> + * dmaengine peripherals
> + *
> + * @peripheral: type of peripheral to DMA to/from
> + * @set_config: set peripheral config
> + * @rx_len: receive length for buffer
Why is it part of the peripheral config? You get the buffer via
prep_slave_sg(). Or is this something else?
The GPI driver uses the rx_len for DMA_MEM_TO_DEV (tx) setup.
> + * @spi: peripheral config for spi
> + * @i2c: peripheral config for i2c
> + */
> +struct dmaengine_peripheral_config {
> + enum dmaengine_peripheral peripheral;
> + u8 set_config;
> + u32 rx_len;
> + struct dmaengine_spi_config spi;
> + struct dmaengine_i2c_config i2c;
I know that you want this to be as generic as much as it is possible,
but do we really want to?
GPIv2 will also handle I2S peripheral, other vendor's similar solution
would require different sets of parameters unique to their IPs?
How we are going to handle similar setups for DMA which is used for
networking, SPI/I2C/I2S/NAND/display/capture, etc?
Imho these settings are really part of the peripheral's domain and not
the DMA. It is just a small detail that instead of direct register
writes, your setup is using the DMA descriptors to write.
It is similar to what I use as metadata (part of the descriptor belongs
and owned by the client driver).
I think it would be better to have:
enum dmaengine_peripheral {
DMAENGINE_PERIPHERAL_GPI_SPI = 1,
DMAENGINE_PERIPHERAL_GPI_UART,
DMAENGINE_PERIPHERAL_GPI_I2C,
DMAENGINE_PERIPHERAL_XYZ_SPI,
DMAENGINE_PERIPHERAL_XYZ_AASRC,
DMAENGINE_PERIPHERAL_ABC_CAM,
...
DMAENGINE_PERIPHERAL_LAST,
};
enum dmaengine_peripheral peripheral_type;
void *peripheral_config;
and that's it. The set_config is specific to GPI.
It can be debated where the structs should be defined, in the generic
dmaengine.h or in include/linux/dma/ as controller specific
(gpi_peripheral.h) or a generic one, like dmaengine_peripheral.h
The SPI/I2C/UART client of yours would pass the GPI specific struct as
in any case it has to know what is the DMA it is serviced by.
> +};
> /**
> * struct dma_slave_config - dma slave channel runtime config
> * @direction: whether the data shall go in or out on this slave
> @@ -418,6 +506,8 @@ enum dma_slave_buswidth {
> * @slave_id: Slave requester id. Only valid for slave channels. The dma
> * slave peripheral will have unique id as dma requester which need to be
> * pass as slave config.
> + * @peripheral: peripheral configuration for programming peripheral for
> + * dmaengine transfer
> *
> * This struct is passed in as configuration data to a DMA engine
> * in order to set up a certain channel for DMA transport at runtime.
> @@ -443,6 +533,7 @@ struct dma_slave_config {
> u32 dst_port_window_size;
> bool device_fc;
> unsigned int slave_id;
> + struct dmaengine_peripheral_config *peripheral;
> };
>
> /**
>
- Péter
Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki.
Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki
