drivers/spi/spi-pxa2xx.h

   1 /*
   2  * Copyright (C) 2005 Stephen Street / StreetFire Sound Labs
   3  * Copyright (C) 2013, Intel Corporation
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2 as
   7  * published by the Free Software Foundation.
   8  */
   9
  10 #ifndef SPI_PXA2XX_H
  11 #define SPI_PXA2XX_H
  12
  13 #include <linux/atomic.h>
  14 #include <linux/dmaengine.h>
  15 #include <linux/errno.h>
  16 #include <linux/io.h>
  17 #include <linux/interrupt.h>
  18 #include <linux/platform_device.h>
  19 #include <linux/pxa2xx_ssp.h>
  20 #include <linux/scatterlist.h>
  21 #include <linux/sizes.h>
  22 #include <linux/spi/spi.h>
  23 #include <linux/spi/pxa2xx_spi.h>
  24
  25 struct driver_data {
  26         /* Driver model hookup */
  27         struct platform_device *pdev;
  28
  29         /* SSP Info */
  30         struct ssp_device *ssp;
  31
  32         /* SPI framework hookup */
  33         enum pxa_ssp_type ssp_type;
  34         struct spi_master *master;
  35
  36         /* PXA hookup */
  37         struct pxa2xx_spi_master *master_info;
  38
  39         /* SSP register addresses */
  40         void __iomem *ioaddr;
  41         u32 ssdr_physical;
  42
  43         /* SSP masks*/
  44         u32 dma_cr1;
  45         u32 int_cr1;
  46         u32 clear_sr;
  47         u32 mask_sr;
  48
  49         /* Message Transfer pump */
  50         struct tasklet_struct pump_transfers;
  51
  52         /* DMA engine support */
  53         struct dma_chan *rx_chan;
  54         struct dma_chan *tx_chan;
  55         struct sg_table rx_sgt;
  56         struct sg_table tx_sgt;
  57         int rx_nents;
  58         int tx_nents;
  59         void *dummy;
  60         atomic_t dma_running;
  61
  62         /* Current message transfer state info */
  63         struct spi_message *cur_msg;
  64         struct spi_transfer *cur_transfer;
  65         struct chip_data *cur_chip;
  66         size_t len;
  67         void *tx;
  68         void *tx_end;
  69         void *rx;
  70         void *rx_end;
  71         int dma_mapped;
  72         dma_addr_t rx_dma;
  73         dma_addr_t tx_dma;
  74         size_t rx_map_len;
  75         size_t tx_map_len;
  76         u8 n_bytes;
  77         int (*write)(struct driver_data *drv_data);
  78         int (*read)(struct driver_data *drv_data);
  79         irqreturn_t (*transfer_handler)(struct driver_data *drv_data);
  80         void (*cs_control)(u32 command);
  81
  82         void __iomem *lpss_base;
  83 };
  84
  85 struct chip_data {
  86         u32 cr1;
  87         u32 dds_rate;
  88         u32 psp;
  89         u32 timeout;
  90         u8 n_bytes;
  91         u32 dma_burst_size;
  92         u32 threshold;
  93         u32 dma_threshold;
  94         u16 lpss_rx_threshold;
  95         u16 lpss_tx_threshold;
  96         u8 enable_dma;
  97         union {
  98                 int gpio_cs;
  99                 unsigned int frm;
 100         };
 101         int gpio_cs_inverted;
 102         int (*write)(struct driver_data *drv_data);
 103         int (*read)(struct driver_data *drv_data);
 104         void (*cs_control)(u32 command);
 105 };
 106
 107 static inline u32 pxa2xx_spi_read(const struct driver_data *drv_data,
 108                                   unsigned reg)
 109 {
 110         return __raw_readl(drv_data->ioaddr + reg);
 111 }
 112
 113 static  inline void pxa2xx_spi_write(const struct driver_data *drv_data,
 114                                      unsigned reg, u32 val)
 115 {
 116         __raw_writel(val, drv_data->ioaddr + reg);
 117 }
 118
 119 #define START_STATE ((void *)0)
 120 #define RUNNING_STATE ((void *)1)
 121 #define DONE_STATE ((void *)2)
 122 #define ERROR_STATE ((void *)-1)
 123
 124 #define IS_DMA_ALIGNED(x)       IS_ALIGNED((unsigned long)(x), DMA_ALIGNMENT)
 125 #define DMA_ALIGNMENT           8
 126
 127 static inline int pxa25x_ssp_comp(struct driver_data *drv_data)
 128 {
 129         switch (drv_data->ssp_type) {
 130         case PXA25x_SSP:
 131         case CE4100_SSP:
 132         case QUARK_X1000_SSP:
 133                 return 1;
 134         default:
 135                 return 0;
 136         }
 137 }
 138
 139 static inline void write_SSSR_CS(struct driver_data *drv_data, u32 val)
 140 {
 141         if (drv_data->ssp_type == CE4100_SSP ||
 142             drv_data->ssp_type == QUARK_X1000_SSP)
 143                 val |= pxa2xx_spi_read(drv_data, SSSR) & SSSR_ALT_FRM_MASK;
 144
 145         pxa2xx_spi_write(drv_data, SSSR, val);
 146 }
 147
 148 extern int pxa2xx_spi_flush(struct driver_data *drv_data);
 149 extern void *pxa2xx_spi_next_transfer(struct driver_data *drv_data);
 150
 151 /*
 152  * Select the right DMA implementation.
 153  */
 154 #if defined(CONFIG_SPI_PXA2XX_DMA)
 155 #define SPI_PXA2XX_USE_DMA      1
 156 #define MAX_DMA_LEN             SZ_64K
 157 #define DEFAULT_DMA_CR1         (SSCR1_TSRE | SSCR1_RSRE | SSCR1_TRAIL)
 158 #else
 159 #undef SPI_PXA2XX_USE_DMA
 160 #define MAX_DMA_LEN             0
 161 #define DEFAULT_DMA_CR1         0
 162 #endif
 163
 164 #ifdef SPI_PXA2XX_USE_DMA
 165 extern bool pxa2xx_spi_dma_is_possible(size_t len);
 166 extern int pxa2xx_spi_map_dma_buffers(struct driver_data *drv_data);
 167 extern irqreturn_t pxa2xx_spi_dma_transfer(struct driver_data *drv_data);
 168 extern int pxa2xx_spi_dma_prepare(struct driver_data *drv_data, u32 dma_burst);
 169 extern void pxa2xx_spi_dma_start(struct driver_data *drv_data);
 170 extern int pxa2xx_spi_dma_setup(struct driver_data *drv_data);
 171 extern void pxa2xx_spi_dma_release(struct driver_data *drv_data);
 172 extern int pxa2xx_spi_set_dma_burst_and_threshold(struct chip_data *chip,
 173                                                   struct spi_device *spi,
 174                                                   u8 bits_per_word,
 175                                                   u32 *burst_code,
 176                                                   u32 *threshold);
 177 #else
 178 static inline bool pxa2xx_spi_dma_is_possible(size_t len) { return false; }
 179 static inline int pxa2xx_spi_map_dma_buffers(struct driver_data *drv_data)
 180 {
 181         return 0;
 182 }
 183 #define pxa2xx_spi_dma_transfer NULL
 184 static inline void pxa2xx_spi_dma_prepare(struct driver_data *drv_data,
 185                                           u32 dma_burst) {}
 186 static inline void pxa2xx_spi_dma_start(struct driver_data *drv_data) {}
 187 static inline int pxa2xx_spi_dma_setup(struct driver_data *drv_data)
 188 {
 189         return 0;
 190 }
 191 static inline void pxa2xx_spi_dma_release(struct driver_data *drv_data) {}
 192 static inline int pxa2xx_spi_set_dma_burst_and_threshold(struct chip_data *chip,
 193                                                          struct spi_device *spi,
 194                                                          u8 bits_per_word,
 195                                                          u32 *burst_code,
 196                                                          u32 *threshold)
 197 {
 198         return -ENODEV;
 199 }
 200 #endif
 201
 202 #endif /* SPI_PXA2XX_H */