[mirror_ubuntu-jammy-kernel.git] / drivers / spi / spi-pxa2xx.h

/*
 * Copyright (C) 2005 Stephen Street / StreetFire Sound Labs
 * Copyright (C) 2013, Intel Corporation
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef SPI_PXA2XX_H
#define SPI_PXA2XX_H

#include <linux/atomic.h>
#include <linux/dmaengine.h>
#include <linux/errno.h>
#include <linux/io.h>
#include <linux/interrupt.h>
#include <linux/platform_device.h>
#include <linux/pxa2xx_ssp.h>
#include <linux/scatterlist.h>
#include <linux/sizes.h>
#include <linux/spi/spi.h>
#include <linux/spi/pxa2xx_spi.h>

struct driver_data {
	/* Driver model hookup */
	struct platform_device *pdev;

	/* SSP Info */
	struct ssp_device *ssp;

	/* SPI framework hookup */
	enum pxa_ssp_type ssp_type;
	struct spi_master *master;

	/* PXA hookup */
	struct pxa2xx_spi_master *master_info;

	/* PXA private DMA setup stuff */
	int rx_channel;
	int tx_channel;
	u32 *null_dma_buf;

	/* SSP register addresses */
	void __iomem *ioaddr;
	u32 ssdr_physical;

	/* SSP masks*/
	u32 dma_cr1;
	u32 int_cr1;
	u32 clear_sr;
	u32 mask_sr;

	/* Maximun clock rate */
	unsigned long max_clk_rate;

	/* Message Transfer pump */
	struct tasklet_struct pump_transfers;

	/* DMA engine support */
	struct dma_chan *rx_chan;
	struct dma_chan *tx_chan;
	struct sg_table rx_sgt;
	struct sg_table tx_sgt;
	int rx_nents;
	int tx_nents;
	void *dummy;
	atomic_t dma_running;

	/* Current message transfer state info */
	struct spi_message *cur_msg;
	struct spi_transfer *cur_transfer;
	struct chip_data *cur_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;
	int (*write)(struct driver_data *drv_data);
	int (*read)(struct driver_data *drv_data);
	irqreturn_t (*transfer_handler)(struct driver_data *drv_data);
	void (*cs_control)(u32 command);
};

struct chip_data {
	u32 cr0;
	u32 cr1;
	u32 psp;
	u32 timeout;
	u8 n_bytes;
	u32 dma_burst_size;
	u32 threshold;
	u32 dma_threshold;
	u8 enable_dma;
	u8 bits_per_word;
	u32 speed_hz;
	union {
		int gpio_cs;
		unsigned int frm;
	};
	int gpio_cs_inverted;
	int (*write)(struct driver_data *drv_data);
	int (*read)(struct driver_data *drv_data);
	void (*cs_control)(u32 command);
};

#define DEFINE_SSP_REG(reg, off) \
static inline u32 read_##reg(void const __iomem *p) \
{ return __raw_readl(p + (off)); } \
\
static inline void write_##reg(u32 v, void __iomem *p) \
{ __raw_writel(v, p + (off)); }

DEFINE_SSP_REG(SSCR0, 0x00)
DEFINE_SSP_REG(SSCR1, 0x04)
DEFINE_SSP_REG(SSSR, 0x08)
DEFINE_SSP_REG(SSITR, 0x0c)
DEFINE_SSP_REG(SSDR, 0x10)
DEFINE_SSP_REG(SSTO, 0x28)
DEFINE_SSP_REG(SSPSP, 0x2c)

#define START_STATE ((void *)0)
#define RUNNING_STATE ((void *)1)
#define DONE_STATE ((void *)2)
#define ERROR_STATE ((void *)-1)

#define IS_DMA_ALIGNED(x)	IS_ALIGNED((unsigned long)(x), DMA_ALIGNMENT)
#define DMA_ALIGNMENT		8

static inline int pxa25x_ssp_comp(struct driver_data *drv_data)
{
	if (drv_data->ssp_type == PXA25x_SSP)
		return 1;
	if (drv_data->ssp_type == CE4100_SSP)
		return 1;
	return 0;
}

static inline void write_SSSR_CS(struct driver_data *drv_data, u32 val)
{
	void __iomem *reg = drv_data->ioaddr;

	if (drv_data->ssp_type == CE4100_SSP)
		val |= read_SSSR(reg) & SSSR_ALT_FRM_MASK;

	write_SSSR(val, reg);
}

extern int pxa2xx_spi_flush(struct driver_data *drv_data);
extern void *pxa2xx_spi_next_transfer(struct driver_data *drv_data);

/*
 * Select the right DMA implementation.
 */
#if defined(CONFIG_SPI_PXA2XX_PXADMA)
#define SPI_PXA2XX_USE_DMA	1
#define MAX_DMA_LEN		8191
#define DEFAULT_DMA_CR1		(SSCR1_TSRE | SSCR1_RSRE | SSCR1_TINTE)
#elif defined(CONFIG_SPI_PXA2XX_DMA)
#define SPI_PXA2XX_USE_DMA	1
#define MAX_DMA_LEN		SZ_64K
#define DEFAULT_DMA_CR1		(SSCR1_TSRE | SSCR1_RSRE | SSCR1_TRAIL)
#else
#undef SPI_PXA2XX_USE_DMA
#define MAX_DMA_LEN		0
#define DEFAULT_DMA_CR1		0
#endif

#ifdef SPI_PXA2XX_USE_DMA
extern bool pxa2xx_spi_dma_is_possible(size_t len);
extern int pxa2xx_spi_map_dma_buffers(struct driver_data *drv_data);
extern irqreturn_t pxa2xx_spi_dma_transfer(struct driver_data *drv_data);
extern int pxa2xx_spi_dma_prepare(struct driver_data *drv_data, u32 dma_burst);
extern void pxa2xx_spi_dma_start(struct driver_data *drv_data);
extern int pxa2xx_spi_dma_setup(struct driver_data *drv_data);
extern void pxa2xx_spi_dma_release(struct driver_data *drv_data);
extern void pxa2xx_spi_dma_resume(struct driver_data *drv_data);
extern int pxa2xx_spi_set_dma_burst_and_threshold(struct chip_data *chip,
						  struct spi_device *spi,
						  u8 bits_per_word,
						  u32 *burst_code,
						  u32 *threshold);
#else
static inline bool pxa2xx_spi_dma_is_possible(size_t len) { return false; }
static inline int pxa2xx_spi_map_dma_buffers(struct driver_data *drv_data)
{
	return 0;
}
#define pxa2xx_spi_dma_transfer NULL
static inline void pxa2xx_spi_dma_prepare(struct driver_data *drv_data,
					  u32 dma_burst) {}
static inline void pxa2xx_spi_dma_start(struct driver_data *drv_data) {}
static inline int pxa2xx_spi_dma_setup(struct driver_data *drv_data)
{
	return 0;
}
static inline void pxa2xx_spi_dma_release(struct driver_data *drv_data) {}
static inline void pxa2xx_spi_dma_resume(struct driver_data *drv_data) {}
static inline int pxa2xx_spi_set_dma_burst_and_threshold(struct chip_data *chip,
							 struct spi_device *spi,
							 u8 bits_per_word,
							 u32 *burst_code,
							 u32 *threshold)
{
	return -ENODEV;
}
#endif

#endif /* SPI_PXA2XX_H */
Commit	Line	Data
cd7bed00 MW	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
5928808e MW	13	#include <linux/atomic.h>
5928808e MW	14	#include <linux/dmaengine.h>
cd7bed00 MW	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>
5928808e MW	20	#include <linux/scatterlist.h>
5928808e MW	21	#include <linux/sizes.h>
cd7bed00 MW	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	/* PXA private DMA setup stuff */
	40	int rx_channel;
	41	int tx_channel;
	42	u32 *null_dma_buf;
	43
	44	/* SSP register addresses */
	45	void __iomem *ioaddr;
	46	u32 ssdr_physical;
	47
	48	/* SSP masks*/
	49	u32 dma_cr1;
	50	u32 int_cr1;
	51	u32 clear_sr;
	52	u32 mask_sr;
	53
	54	/* Maximun clock rate */
	55	unsigned long max_clk_rate;
	56
	57	/* Message Transfer pump */
	58	struct tasklet_struct pump_transfers;
	59
5928808e MW	60	/* DMA engine support */
	61	struct dma_chan *rx_chan;
	62	struct dma_chan *tx_chan;
	63	struct sg_table rx_sgt;
	64	struct sg_table tx_sgt;
	65	int rx_nents;
	66	int tx_nents;
	67	void *dummy;
	68	atomic_t dma_running;
	69
cd7bed00 MW	70	/* Current message transfer state info */
	71	struct spi_message *cur_msg;
	72	struct spi_transfer *cur_transfer;
	73	struct chip_data *cur_chip;
	74	size_t len;
	75	void *tx;
	76	void *tx_end;
	77	void *rx;
	78	void *rx_end;
	79	int dma_mapped;
	80	dma_addr_t rx_dma;
	81	dma_addr_t tx_dma;
	82	size_t rx_map_len;
	83	size_t tx_map_len;
	84	u8 n_bytes;
	85	int (write)(struct driver_data drv_data);
	86	int (read)(struct driver_data drv_data);
	87	irqreturn_t (transfer_handler)(struct driver_data drv_data);
	88	void (*cs_control)(u32 command);
	89	};
	90
	91	struct chip_data {
	92	u32 cr0;
	93	u32 cr1;
	94	u32 psp;
	95	u32 timeout;
	96	u8 n_bytes;
	97	u32 dma_burst_size;
	98	u32 threshold;
	99	u32 dma_threshold;
	100	u8 enable_dma;
	101	u8 bits_per_word;
	102	u32 speed_hz;
	103	union {
	104	int gpio_cs;
	105	unsigned int frm;
	106	};
	107	int gpio_cs_inverted;
	108	int (write)(struct driver_data drv_data);
	109	int (read)(struct driver_data drv_data);
	110	void (*cs_control)(u32 command);
	111	};
	112
	113	#define DEFINE_SSP_REG(reg, off) \
	114	static inline u32 read_##reg(void const __iomem *p) \
	115	{ return __raw_readl(p + (off)); } \
	116	\
	117	static inline void write_##reg(u32 v, void __iomem *p) \
	118	{ __raw_writel(v, p + (off)); }
	119
	120	DEFINE_SSP_REG(SSCR0, 0x00)
	121	DEFINE_SSP_REG(SSCR1, 0x04)
	122	DEFINE_SSP_REG(SSSR, 0x08)
	123	DEFINE_SSP_REG(SSITR, 0x0c)
	124	DEFINE_SSP_REG(SSDR, 0x10)
	125	DEFINE_SSP_REG(SSTO, 0x28)
	126	DEFINE_SSP_REG(SSPSP, 0x2c)
	127
	128	#define START_STATE ((void *)0)
	129	#define RUNNING_STATE ((void *)1)
	130	#define DONE_STATE ((void *)2)
	131	#define ERROR_STATE ((void *)-1)
	132
cd7bed00 MW	133	#define IS_DMA_ALIGNED(x) IS_ALIGNED((unsigned long)(x), DMA_ALIGNMENT)
	134	#define DMA_ALIGNMENT 8
	135
	136	static inline int pxa25x_ssp_comp(struct driver_data *drv_data)
	137	{
	138	if (drv_data->ssp_type == PXA25x_SSP)
	139	return 1;
	140	if (drv_data->ssp_type == CE4100_SSP)
	141	return 1;
	142	return 0;
	143	}
	144
	145	static inline void write_SSSR_CS(struct driver_data *drv_data, u32 val)
	146	{
	147	void __iomem *reg = drv_data->ioaddr;
	148
	149	if (drv_data->ssp_type == CE4100_SSP)
	150	val \|= read_SSSR(reg) & SSSR_ALT_FRM_MASK;
	151
	152	write_SSSR(val, reg);
	153	}
	154
	155	extern int pxa2xx_spi_flush(struct driver_data *drv_data);
	156	extern void pxa2xx_spi_next_transfer(struct driver_data drv_data);
	157
5928808e MW	158	/*
	159	* Select the right DMA implementation.
	160	*/
cd7bed00	161	#if defined(CONFIG_SPI_PXA2XX_PXADMA)
5928808e MW	162	#define SPI_PXA2XX_USE_DMA 1
	163	#define MAX_DMA_LEN 8191
	164	#define DEFAULT_DMA_CR1 (SSCR1_TSRE \| SSCR1_RSRE \| SSCR1_TINTE)
	165	#elif defined(CONFIG_SPI_PXA2XX_DMA)
	166	#define SPI_PXA2XX_USE_DMA 1
	167	#define MAX_DMA_LEN SZ_64K
	168	#define DEFAULT_DMA_CR1 (SSCR1_TSRE \| SSCR1_RSRE \| SSCR1_TRAIL)
	169	#else
	170	#undef SPI_PXA2XX_USE_DMA
	171	#define MAX_DMA_LEN 0
	172	#define DEFAULT_DMA_CR1 0
	173	#endif
	174
	175	#ifdef SPI_PXA2XX_USE_DMA
cd7bed00 MW	176	extern bool pxa2xx_spi_dma_is_possible(size_t len);
	177	extern int pxa2xx_spi_map_dma_buffers(struct driver_data *drv_data);
	178	extern irqreturn_t pxa2xx_spi_dma_transfer(struct driver_data *drv_data);
	179	extern int pxa2xx_spi_dma_prepare(struct driver_data *drv_data, u32 dma_burst);
	180	extern void pxa2xx_spi_dma_start(struct driver_data *drv_data);
	181	extern int pxa2xx_spi_dma_setup(struct driver_data *drv_data);
	182	extern void pxa2xx_spi_dma_release(struct driver_data *drv_data);
	183	extern void pxa2xx_spi_dma_resume(struct driver_data *drv_data);
	184	extern int pxa2xx_spi_set_dma_burst_and_threshold(struct chip_data *chip,
	185	struct spi_device *spi,
	186	u8 bits_per_word,
	187	u32 *burst_code,
	188	u32 *threshold);
	189	#else
	190	static inline bool pxa2xx_spi_dma_is_possible(size_t len) { return false; }
	191	static inline int pxa2xx_spi_map_dma_buffers(struct driver_data *drv_data)
	192	{
	193	return 0;
	194	}
	195	#define pxa2xx_spi_dma_transfer NULL
	196	static inline void pxa2xx_spi_dma_prepare(struct driver_data *drv_data,
	197	u32 dma_burst) {}
	198	static inline void pxa2xx_spi_dma_start(struct driver_data *drv_data) {}
	199	static inline int pxa2xx_spi_dma_setup(struct driver_data *drv_data)
	200	{
	201	return 0;
	202	}
	203	static inline void pxa2xx_spi_dma_release(struct driver_data *drv_data) {}
	204	static inline void pxa2xx_spi_dma_resume(struct driver_data *drv_data) {}
	205	static inline int pxa2xx_spi_set_dma_burst_and_threshold(struct chip_data *chip,
	206	struct spi_device *spi,
	207	u8 bits_per_word,
	208	u32 *burst_code,
	209	u32 *threshold)
	210	{
	211	return -ENODEV;
	212	}
	213	#endif
	214
	215	#endif /* SPI_PXA2XX_H */