spi-dw.h 5.9 KB
Newer Older
1 2
#ifndef DW_SPI_HEADER_H
#define DW_SPI_HEADER_H
Feng Tang's avatar
Feng Tang committed
3

4
#include <linux/io.h>
Jiri Slaby's avatar
Jiri Slaby committed
5
#include <linux/scatterlist.h>
6
#include <linux/gpio.h>
7

8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
/* Register offsets */
#define DW_SPI_CTRL0			0x00
#define DW_SPI_CTRL1			0x04
#define DW_SPI_SSIENR			0x08
#define DW_SPI_MWCR			0x0c
#define DW_SPI_SER			0x10
#define DW_SPI_BAUDR			0x14
#define DW_SPI_TXFLTR			0x18
#define DW_SPI_RXFLTR			0x1c
#define DW_SPI_TXFLR			0x20
#define DW_SPI_RXFLR			0x24
#define DW_SPI_SR			0x28
#define DW_SPI_IMR			0x2c
#define DW_SPI_ISR			0x30
#define DW_SPI_RISR			0x34
#define DW_SPI_TXOICR			0x38
#define DW_SPI_RXOICR			0x3c
#define DW_SPI_RXUICR			0x40
#define DW_SPI_MSTICR			0x44
#define DW_SPI_ICR			0x48
#define DW_SPI_DMACR			0x4c
#define DW_SPI_DMATDLR			0x50
#define DW_SPI_DMARDLR			0x54
#define DW_SPI_IDR			0x58
#define DW_SPI_VERSION			0x5c
#define DW_SPI_DR			0x60

35 36 37 38 39 40 41 42 43 44 45 46
/* Bit fields in CTRLR0 */
#define SPI_DFS_OFFSET			0

#define SPI_FRF_OFFSET			4
#define SPI_FRF_SPI			0x0
#define SPI_FRF_SSP			0x1
#define SPI_FRF_MICROWIRE		0x2
#define SPI_FRF_RESV			0x3

#define SPI_MODE_OFFSET			6
#define SPI_SCPH_OFFSET			6
#define SPI_SCOL_OFFSET			7
47

48
#define SPI_TMOD_OFFSET			8
49
#define SPI_TMOD_MASK			(0x3 << SPI_TMOD_OFFSET)
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
#define	SPI_TMOD_TR			0x0		/* xmit & recv */
#define SPI_TMOD_TO			0x1		/* xmit only */
#define SPI_TMOD_RO			0x2		/* recv only */
#define SPI_TMOD_EPROMREAD		0x3		/* eeprom read mode */

#define SPI_SLVOE_OFFSET		10
#define SPI_SRL_OFFSET			11
#define SPI_CFS_OFFSET			12

/* Bit fields in SR, 7 bits */
#define SR_MASK				0x7f		/* cover 7 bits */
#define SR_BUSY				(1 << 0)
#define SR_TF_NOT_FULL			(1 << 1)
#define SR_TF_EMPT			(1 << 2)
#define SR_RF_NOT_EMPT			(1 << 3)
#define SR_RF_FULL			(1 << 4)
#define SR_TX_ERR			(1 << 5)
#define SR_DCOL				(1 << 6)

/* Bit fields in ISR, IMR, RISR, 7 bits */
#define SPI_INT_TXEI			(1 << 0)
#define SPI_INT_TXOI			(1 << 1)
#define SPI_INT_RXUI			(1 << 2)
#define SPI_INT_RXOI			(1 << 3)
#define SPI_INT_RXFI			(1 << 4)
#define SPI_INT_MSTI			(1 << 5)

77 78 79 80
/* Bit fields in DMACR */
#define SPI_DMA_RDMAE			(1 << 0)
#define SPI_DMA_TDMAE			(1 << 1)

Lucas De Marchi's avatar
Lucas De Marchi committed
81
/* TX RX interrupt level threshold, max can be 256 */
82 83 84 85 86 87 88 89
#define SPI_INT_THRESHOLD		32

enum dw_ssi_type {
	SSI_MOTO_SPI = 0,
	SSI_TI_SSP,
	SSI_NS_MICROWIRE,
};

Feng Tang's avatar
Feng Tang committed
90 91 92 93 94 95 96
struct dw_spi;
struct dw_spi_dma_ops {
	int (*dma_init)(struct dw_spi *dws);
	void (*dma_exit)(struct dw_spi *dws);
	int (*dma_transfer)(struct dw_spi *dws, int cs_change);
};

97 98 99 100
struct dw_spi {
	struct spi_master	*master;
	struct spi_device	*cur_dev;
	enum dw_ssi_type	type;
101
	char			name[16];
102 103 104 105

	void __iomem		*regs;
	unsigned long		paddr;
	int			irq;
106
	u32			fifo_len;	/* depth of the FIFO buffer */
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
	u32			max_freq;	/* max bus freq supported */

	u16			bus_num;
	u16			num_cs;		/* supported slave numbers */

	/* Message Transfer pump */
	struct tasklet_struct	pump_transfers;

	/* Current message transfer state info */
	struct spi_message	*cur_msg;
	struct spi_transfer	*cur_transfer;
	struct chip_data	*cur_chip;
	struct chip_data	*prev_chip;
	size_t			len;
	void			*tx;
	void			*tx_end;
	void			*rx;
	void			*rx_end;
	int			dma_mapped;
	dma_addr_t		rx_dma;
	dma_addr_t		tx_dma;
	size_t			rx_map_len;
	size_t			tx_map_len;
	u8			n_bytes;	/* current is a 1/2 bytes op */
	u8			max_bits_per_word;	/* maxim is 16b */
	u32			dma_width;
	irqreturn_t		(*transfer_handler)(struct dw_spi *dws);
	void			(*cs_control)(u32 command);

	/* Dma info */
	int			dma_inited;
	struct dma_chan		*txchan;
Feng Tang's avatar
Feng Tang committed
139
	struct scatterlist	tx_sgl;
140
	struct dma_chan		*rxchan;
Feng Tang's avatar
Feng Tang committed
141
	struct scatterlist	rx_sgl;
142
	unsigned long		dma_chan_busy;
143
	struct device		*dma_dev;
Feng Tang's avatar
Feng Tang committed
144 145 146
	dma_addr_t		dma_addr; /* phy address of the Data register */
	struct dw_spi_dma_ops	*dma_ops;
	void			*dma_priv; /* platform relate info */
147 148 149 150 151 152 153 154

	/* Bus interface info */
	void			*priv;
#ifdef CONFIG_DEBUG_FS
	struct dentry *debugfs;
#endif
};

155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
static inline u32 dw_readl(struct dw_spi *dws, u32 offset)
{
	return __raw_readl(dws->regs + offset);
}

static inline void dw_writel(struct dw_spi *dws, u32 offset, u32 val)
{
	__raw_writel(val, dws->regs + offset);
}

static inline u16 dw_readw(struct dw_spi *dws, u32 offset)
{
	return __raw_readw(dws->regs + offset);
}

static inline void dw_writew(struct dw_spi *dws, u32 offset, u16 val)
{
	__raw_writew(val, dws->regs + offset);
}
174 175 176

static inline void spi_enable_chip(struct dw_spi *dws, int enable)
{
177
	dw_writel(dws, DW_SPI_SSIENR, (enable ? 1 : 0));
178 179 180 181
}

static inline void spi_set_clk(struct dw_spi *dws, u16 div)
{
182
	dw_writel(dws, DW_SPI_BAUDR, div);
183 184
}

185 186
static inline void spi_chip_sel(struct dw_spi *dws, struct spi_device *spi,
		int active)
187
{
188 189 190
	u16 cs = spi->chip_select;
	int gpio_val = active ? (spi->mode & SPI_CS_HIGH) :
		!(spi->mode & SPI_CS_HIGH);
191 192

	if (dws->cs_control)
193 194 195
		dws->cs_control(active);
	if (gpio_is_valid(spi->cs_gpio))
		gpio_set_value(spi->cs_gpio, gpio_val);
196

197 198
	if (active)
		dw_writel(dws, DW_SPI_SER, 1 << cs);
199 200 201 202 203 204 205
}

/* Disable IRQ bits */
static inline void spi_mask_intr(struct dw_spi *dws, u32 mask)
{
	u32 new_mask;

206 207
	new_mask = dw_readl(dws, DW_SPI_IMR) & ~mask;
	dw_writel(dws, DW_SPI_IMR, new_mask);
208 209 210 211 212 213 214
}

/* Enable IRQ bits */
static inline void spi_umask_intr(struct dw_spi *dws, u32 mask)
{
	u32 new_mask;

215 216
	new_mask = dw_readl(dws, DW_SPI_IMR) | mask;
	dw_writel(dws, DW_SPI_IMR, new_mask);
217 218 219 220 221 222
}

/*
 * Each SPI slave device to work with dw_api controller should
 * has such a structure claiming its working mode (PIO/DMA etc),
 * which can be save in the "controller_data" member of the
223
 * struct spi_device.
224 225
 */
struct dw_spi_chip {
226 227
	u8 poll_mode;	/* 1 for controller polling mode */
	u8 type;	/* SPI/SSP/MicroWire */
228 229 230 231
	u8 enable_dma;
	void (*cs_control)(u32 command);
};

232
extern int dw_spi_add_host(struct device *dev, struct dw_spi *dws);
233 234 235
extern void dw_spi_remove_host(struct dw_spi *dws);
extern int dw_spi_suspend_host(struct dw_spi *dws);
extern int dw_spi_resume_host(struct dw_spi *dws);
Feng Tang's avatar
Feng Tang committed
236 237 238 239
extern void dw_spi_xfer_done(struct dw_spi *dws);

/* platform related setup */
extern int dw_spi_mid_init(struct dw_spi *dws); /* Intel MID platforms */
240
#endif /* DW_SPI_HEADER_H */