xref: /linux/drivers/spi/spi-pxa2xx.h (revision f3a8b6645dc2e60d11f20c1c23afd964ff4e55ae)
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 	atomic_t dma_running;
54 
55 	/* Current message transfer state info */
56 	struct spi_transfer *cur_transfer;
57 	size_t len;
58 	void *tx;
59 	void *tx_end;
60 	void *rx;
61 	void *rx_end;
62 	u8 n_bytes;
63 	int (*write)(struct driver_data *drv_data);
64 	int (*read)(struct driver_data *drv_data);
65 	irqreturn_t (*transfer_handler)(struct driver_data *drv_data);
66 	void (*cs_control)(u32 command);
67 
68 	void __iomem *lpss_base;
69 
70 	/* GPIOs for chip selects */
71 	struct gpio_desc **cs_gpiods;
72 };
73 
74 struct chip_data {
75 	u32 cr1;
76 	u32 dds_rate;
77 	u32 timeout;
78 	u8 n_bytes;
79 	u32 dma_burst_size;
80 	u32 threshold;
81 	u32 dma_threshold;
82 	u16 lpss_rx_threshold;
83 	u16 lpss_tx_threshold;
84 	u8 enable_dma;
85 	union {
86 		int gpio_cs;
87 		unsigned int frm;
88 	};
89 	int gpio_cs_inverted;
90 	int (*write)(struct driver_data *drv_data);
91 	int (*read)(struct driver_data *drv_data);
92 	void (*cs_control)(u32 command);
93 };
94 
95 static inline u32 pxa2xx_spi_read(const struct driver_data *drv_data,
96 				  unsigned reg)
97 {
98 	return __raw_readl(drv_data->ioaddr + reg);
99 }
100 
101 static  inline void pxa2xx_spi_write(const struct driver_data *drv_data,
102 				     unsigned reg, u32 val)
103 {
104 	__raw_writel(val, drv_data->ioaddr + reg);
105 }
106 
107 #define START_STATE ((void *)0)
108 #define RUNNING_STATE ((void *)1)
109 #define DONE_STATE ((void *)2)
110 #define ERROR_STATE ((void *)-1)
111 
112 #define IS_DMA_ALIGNED(x)	IS_ALIGNED((unsigned long)(x), DMA_ALIGNMENT)
113 #define DMA_ALIGNMENT		8
114 
115 static inline int pxa25x_ssp_comp(struct driver_data *drv_data)
116 {
117 	switch (drv_data->ssp_type) {
118 	case PXA25x_SSP:
119 	case CE4100_SSP:
120 	case QUARK_X1000_SSP:
121 		return 1;
122 	default:
123 		return 0;
124 	}
125 }
126 
127 static inline void write_SSSR_CS(struct driver_data *drv_data, u32 val)
128 {
129 	if (drv_data->ssp_type == CE4100_SSP ||
130 	    drv_data->ssp_type == QUARK_X1000_SSP)
131 		val |= pxa2xx_spi_read(drv_data, SSSR) & SSSR_ALT_FRM_MASK;
132 
133 	pxa2xx_spi_write(drv_data, SSSR, val);
134 }
135 
136 extern int pxa2xx_spi_flush(struct driver_data *drv_data);
137 extern void *pxa2xx_spi_next_transfer(struct driver_data *drv_data);
138 
139 #define MAX_DMA_LEN		SZ_64K
140 #define DEFAULT_DMA_CR1		(SSCR1_TSRE | SSCR1_RSRE | SSCR1_TRAIL)
141 
142 extern irqreturn_t pxa2xx_spi_dma_transfer(struct driver_data *drv_data);
143 extern int pxa2xx_spi_dma_prepare(struct driver_data *drv_data, u32 dma_burst);
144 extern void pxa2xx_spi_dma_start(struct driver_data *drv_data);
145 extern int pxa2xx_spi_dma_setup(struct driver_data *drv_data);
146 extern void pxa2xx_spi_dma_release(struct driver_data *drv_data);
147 extern int pxa2xx_spi_set_dma_burst_and_threshold(struct chip_data *chip,
148 						  struct spi_device *spi,
149 						  u8 bits_per_word,
150 						  u32 *burst_code,
151 						  u32 *threshold);
152 
153 #endif /* SPI_PXA2XX_H */
154