drivers/dma/fsl-edma-common.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright 2013-2014 Freescale Semiconductor, Inc.
   4  * Copyright 2018 Angelo Dureghello <angelo@sysam.it>
   5  */
   6 #ifndef _FSL_EDMA_COMMON_H_
   7 #define _FSL_EDMA_COMMON_H_
   8
   9 #include <linux/dma-direction.h>
  10 #include <linux/platform_device.h>
  11 #include "virt-dma.h"
  12
  13 #define EDMA_CR_EDBG            BIT(1)
  14 #define EDMA_CR_ERCA            BIT(2)
  15 #define EDMA_CR_ERGA            BIT(3)
  16 #define EDMA_CR_HOE             BIT(4)
  17 #define EDMA_CR_HALT            BIT(5)
  18 #define EDMA_CR_CLM             BIT(6)
  19 #define EDMA_CR_EMLM            BIT(7)
  20 #define EDMA_CR_ECX             BIT(16)
  21 #define EDMA_CR_CX              BIT(17)
  22
  23 #define EDMA_SEEI_SEEI(x)       ((x) & GENMASK(4, 0))
  24 #define EDMA_CEEI_CEEI(x)       ((x) & GENMASK(4, 0))
  25 #define EDMA_CINT_CINT(x)       ((x) & GENMASK(4, 0))
  26 #define EDMA_CERR_CERR(x)       ((x) & GENMASK(4, 0))
  27
  28 #define EDMA_TCD_ATTR_DSIZE(x)          (((x) & GENMASK(2, 0)))
  29 #define EDMA_TCD_ATTR_DMOD(x)           (((x) & GENMASK(4, 0)) << 3)
  30 #define EDMA_TCD_ATTR_SSIZE(x)          (((x) & GENMASK(2, 0)) << 8)
  31 #define EDMA_TCD_ATTR_SMOD(x)           (((x) & GENMASK(4, 0)) << 11)
  32
  33 #define EDMA_TCD_CITER_CITER(x)         ((x) & GENMASK(14, 0))
  34 #define EDMA_TCD_BITER_BITER(x)         ((x) & GENMASK(14, 0))
  35
  36 #define EDMA_TCD_CSR_START              BIT(0)
  37 #define EDMA_TCD_CSR_INT_MAJOR          BIT(1)
  38 #define EDMA_TCD_CSR_INT_HALF           BIT(2)
  39 #define EDMA_TCD_CSR_D_REQ              BIT(3)
  40 #define EDMA_TCD_CSR_E_SG               BIT(4)
  41 #define EDMA_TCD_CSR_E_LINK             BIT(5)
  42 #define EDMA_TCD_CSR_ACTIVE             BIT(6)
  43 #define EDMA_TCD_CSR_DONE               BIT(7)
  44
  45 #define EDMAMUX_CHCFG_DIS               0x0
  46 #define EDMAMUX_CHCFG_ENBL              0x80
  47 #define EDMAMUX_CHCFG_SOURCE(n)         ((n) & 0x3F)
  48
  49 #define DMAMUX_NR       2
  50
  51 #define FSL_EDMA_BUSWIDTHS      (BIT(DMA_SLAVE_BUSWIDTH_1_BYTE) | \
  52                                  BIT(DMA_SLAVE_BUSWIDTH_2_BYTES) | \
  53                                  BIT(DMA_SLAVE_BUSWIDTH_4_BYTES) | \
  54                                  BIT(DMA_SLAVE_BUSWIDTH_8_BYTES))
  55 enum fsl_edma_pm_state {
  56         RUNNING = 0,
  57         SUSPENDED,
  58 };
  59
  60 struct fsl_edma_hw_tcd {
  61         __le32  saddr;
  62         __le16  soff;
  63         __le16  attr;
  64         __le32  nbytes;
  65         __le32  slast;
  66         __le32  daddr;
  67         __le16  doff;
  68         __le16  citer;
  69         __le32  dlast_sga;
  70         __le16  csr;
  71         __le16  biter;
  72 };
  73
  74 /*
  75  * These are iomem pointers, for both v32 and v64.
  76  */
  77 struct edma_regs {
  78         void __iomem *cr;
  79         void __iomem *es;
  80         void __iomem *erqh;
  81         void __iomem *erql;     /* aka erq on v32 */
  82         void __iomem *eeih;
  83         void __iomem *eeil;     /* aka eei on v32 */
  84         void __iomem *seei;
  85         void __iomem *ceei;
  86         void __iomem *serq;
  87         void __iomem *cerq;
  88         void __iomem *cint;
  89         void __iomem *cerr;
  90         void __iomem *ssrt;
  91         void __iomem *cdne;
  92         void __iomem *inth;
  93         void __iomem *intl;
  94         void __iomem *errh;
  95         void __iomem *errl;
  96         struct fsl_edma_hw_tcd __iomem *tcd;
  97 };
  98
  99 struct fsl_edma_sw_tcd {
 100         dma_addr_t                      ptcd;
 101         struct fsl_edma_hw_tcd          *vtcd;
 102 };
 103
 104 struct fsl_edma_chan {
 105         struct virt_dma_chan            vchan;
 106         enum dma_status                 status;
 107         enum fsl_edma_pm_state          pm_state;
 108         bool                            idle;
 109         u32                             slave_id;
 110         struct fsl_edma_engine          *edma;
 111         struct fsl_edma_desc            *edesc;
 112         struct dma_slave_config         cfg;
 113         u32                             attr;
 114         bool                            is_sw;
 115         struct dma_pool                 *tcd_pool;
 116         dma_addr_t                      dma_dev_addr;
 117         u32                             dma_dev_size;
 118         enum dma_data_direction         dma_dir;
 119         char                            chan_name[32];
 120 };
 121
 122 struct fsl_edma_desc {
 123         struct virt_dma_desc            vdesc;
 124         struct fsl_edma_chan            *echan;
 125         bool                            iscyclic;
 126         enum dma_transfer_direction     dirn;
 127         unsigned int                    n_tcds;
 128         struct fsl_edma_sw_tcd          tcd[];
 129 };
 130
 131 #define FSL_EDMA_DRV_HAS_DMACLK         BIT(0)
 132 #define FSL_EDMA_DRV_MUX_SWAP           BIT(1)
 133 #define FSL_EDMA_DRV_CONFIG32           BIT(2)
 134 #define FSL_EDMA_DRV_WRAP_IO            BIT(3)
 135 #define FSL_EDMA_DRV_EDMA64             BIT(4)
 136 struct fsl_edma_drvdata {
 137         u32                     dmamuxs;
 138         u32                     flags;
 139         int                     (*setup_irq)(struct platform_device *pdev,
 140                                              struct fsl_edma_engine *fsl_edma);
 141 };
 142
 143 struct fsl_edma_engine {
 144         struct dma_device       dma_dev;
 145         void __iomem            *membase;
 146         void __iomem            *muxbase[DMAMUX_NR];
 147         struct clk              *muxclk[DMAMUX_NR];
 148         struct clk              *dmaclk;
 149         struct mutex            fsl_edma_mutex;
 150         const struct fsl_edma_drvdata *drvdata;
 151         u32                     n_chans;
 152         int                     txirq;
 153         int                     errirq;
 154         bool                    big_endian;
 155         struct edma_regs        regs;
 156         struct fsl_edma_chan    chans[];
 157 };
 158
 159 /*
 160  * R/W functions for big- or little-endian registers:
 161  * The eDMA controller's endian is independent of the CPU core's endian.
 162  * For the big-endian IP module, the offset for 8-bit or 16-bit registers
 163  * should also be swapped opposite to that in little-endian IP.
 164  */
 165 static inline u32 edma_readl(struct fsl_edma_engine *edma, void __iomem *addr)
 166 {
 167         if (edma->big_endian)
 168                 return ioread32be(addr);
 169         else
 170                 return ioread32(addr);
 171 }
 172
 173 static inline void edma_writeb(struct fsl_edma_engine *edma,
 174                                u8 val, void __iomem *addr)
 175 {
 176         /* swap the reg offset for these in big-endian mode */
 177         if (edma->big_endian)
 178                 iowrite8(val, (void __iomem *)((unsigned long)addr ^ 0x3));
 179         else
 180                 iowrite8(val, addr);
 181 }
 182
 183 static inline void edma_writew(struct fsl_edma_engine *edma,
 184                                u16 val, void __iomem *addr)
 185 {
 186         /* swap the reg offset for these in big-endian mode */
 187         if (edma->big_endian)
 188                 iowrite16be(val, (void __iomem *)((unsigned long)addr ^ 0x2));
 189         else
 190                 iowrite16(val, addr);
 191 }
 192
 193 static inline void edma_writel(struct fsl_edma_engine *edma,
 194                                u32 val, void __iomem *addr)
 195 {
 196         if (edma->big_endian)
 197                 iowrite32be(val, addr);
 198         else
 199                 iowrite32(val, addr);
 200 }
 201
 202 static inline struct fsl_edma_chan *to_fsl_edma_chan(struct dma_chan *chan)
 203 {
 204         return container_of(chan, struct fsl_edma_chan, vchan.chan);
 205 }
 206
 207 static inline struct fsl_edma_desc *to_fsl_edma_desc(struct virt_dma_desc *vd)
 208 {
 209         return container_of(vd, struct fsl_edma_desc, vdesc);
 210 }
 211
 212 static inline void fsl_edma_err_chan_handler(struct fsl_edma_chan *fsl_chan)
 213 {
 214         fsl_chan->status = DMA_ERROR;
 215         fsl_chan->idle = true;
 216 }
 217
 218 void fsl_edma_tx_chan_handler(struct fsl_edma_chan *fsl_chan);
 219 void fsl_edma_disable_request(struct fsl_edma_chan *fsl_chan);
 220 void fsl_edma_chan_mux(struct fsl_edma_chan *fsl_chan,
 221                         unsigned int slot, bool enable);
 222 void fsl_edma_free_desc(struct virt_dma_desc *vdesc);
 223 int fsl_edma_terminate_all(struct dma_chan *chan);
 224 int fsl_edma_pause(struct dma_chan *chan);
 225 int fsl_edma_resume(struct dma_chan *chan);
 226 int fsl_edma_slave_config(struct dma_chan *chan,
 227                                  struct dma_slave_config *cfg);
 228 enum dma_status fsl_edma_tx_status(struct dma_chan *chan,
 229                 dma_cookie_t cookie, struct dma_tx_state *txstate);
 230 struct dma_async_tx_descriptor *fsl_edma_prep_dma_cyclic(
 231                 struct dma_chan *chan, dma_addr_t dma_addr, size_t buf_len,
 232                 size_t period_len, enum dma_transfer_direction direction,
 233                 unsigned long flags);
 234 struct dma_async_tx_descriptor *fsl_edma_prep_slave_sg(
 235                 struct dma_chan *chan, struct scatterlist *sgl,
 236                 unsigned int sg_len, enum dma_transfer_direction direction,
 237                 unsigned long flags, void *context);
 238 struct dma_async_tx_descriptor *fsl_edma_prep_memcpy(
 239                 struct dma_chan *chan, dma_addr_t dma_dst, dma_addr_t dma_src,
 240                 size_t len, unsigned long flags);
 241 void fsl_edma_xfer_desc(struct fsl_edma_chan *fsl_chan);
 242 void fsl_edma_issue_pending(struct dma_chan *chan);
 243 int fsl_edma_alloc_chan_resources(struct dma_chan *chan);
 244 void fsl_edma_free_chan_resources(struct dma_chan *chan);
 245 void fsl_edma_cleanup_vchan(struct dma_device *dmadev);
 246 void fsl_edma_setup_regs(struct fsl_edma_engine *edma);
 247
 248 #endif /* _FSL_EDMA_COMMON_H_ */