[linux-2.6-block.git] / include / linux / pxa2xx_ssp.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 *  pxa2xx_ssp.h
 *
 *  Copyright (C) 2003 Russell King, All Rights Reserved.
 *
 * This driver supports the following PXA CPU/SSP ports:-
 *
 *       PXA250     SSP
 *       PXA255     SSP, NSSP
 *       PXA26x     SSP, NSSP, ASSP
 *       PXA27x     SSP1, SSP2, SSP3
 *       PXA3xx     SSP1, SSP2, SSP3, SSP4
 */

#ifndef __LINUX_SSP_H
#define __LINUX_SSP_H

#include <linux/bits.h>
#include <linux/compiler_types.h>
#include <linux/io.h>
#include <linux/kconfig.h>
#include <linux/list.h>
#include <linux/types.h>

struct clk;
struct device;
struct device_node;

/*
 * SSP Serial Port Registers
 * PXA250, PXA255, PXA26x and PXA27x SSP controllers are all slightly different.
 * PXA255, PXA26x and PXA27x have extra ports, registers and bits.
 */

#define SSCR0		(0x00)  /* SSP Control Register 0 */
#define SSCR1		(0x04)  /* SSP Control Register 1 */
#define SSSR		(0x08)  /* SSP Status Register */
#define SSITR		(0x0C)  /* SSP Interrupt Test Register */
#define SSDR		(0x10)  /* SSP Data Write/Data Read Register */

#define SSTO		(0x28)  /* SSP Time Out Register */
#define DDS_RATE	(0x28)  /* SSP DDS Clock Rate Register (Intel Quark) */
#define SSPSP		(0x2C)  /* SSP Programmable Serial Protocol */
#define SSTSA		(0x30)  /* SSP Tx Timeslot Active */
#define SSRSA		(0x34)  /* SSP Rx Timeslot Active */
#define SSTSS		(0x38)  /* SSP Timeslot Status */
#define SSACD		(0x3C)  /* SSP Audio Clock Divider */
#define SSACDD		(0x40)	/* SSP Audio Clock Dither Divider */

/* Common PXA2xx bits first */
#define SSCR0_DSS	GENMASK(3, 0)	/* Data Size Select (mask) */
#define SSCR0_DataSize(x)  ((x) - 1)	/* Data Size Select [4..16] */
#define SSCR0_FRF	GENMASK(5, 4)	/* FRame Format (mask) */
#define SSCR0_Motorola	(0x0 << 4)	/* Motorola's Serial Peripheral Interface (SPI) */
#define SSCR0_TI	(0x1 << 4)	/* Texas Instruments' Synchronous Serial Protocol (SSP) */
#define SSCR0_National	(0x2 << 4)	/* National Microwire */
#define SSCR0_ECS	BIT(6)		/* External clock select */
#define SSCR0_SSE	BIT(7)		/* Synchronous Serial Port Enable */
#define SSCR0_SCR(x)	((x) << 8)	/* Serial Clock Rate (mask) */

/* PXA27x, PXA3xx */
#define SSCR0_EDSS	BIT(20)		/* Extended data size select */
#define SSCR0_NCS	BIT(21)		/* Network clock select */
#define SSCR0_RIM	BIT(22)		/* Receive FIFO overrrun interrupt mask */
#define SSCR0_TUM	BIT(23)		/* Transmit FIFO underrun interrupt mask */
#define SSCR0_FRDC	GENMASK(26, 24)	/* Frame rate divider control (mask) */
#define SSCR0_SlotsPerFrm(x) (((x) - 1) << 24)	/* Time slots per frame [1..8] */
#define SSCR0_FPCKE	BIT(29)		/* FIFO packing enable */
#define SSCR0_ACS	BIT(30)		/* Audio clock select */
#define SSCR0_MOD	BIT(31)		/* Mode (normal or network) */

#define SSCR1_RIE	BIT(0)		/* Receive FIFO Interrupt Enable */
#define SSCR1_TIE	BIT(1)		/* Transmit FIFO Interrupt Enable */
#define SSCR1_LBM	BIT(2)		/* Loop-Back Mode */
#define SSCR1_SPO	BIT(3)		/* Motorola SPI SSPSCLK polarity setting */
#define SSCR1_SPH	BIT(4)		/* Motorola SPI SSPSCLK phase setting */
#define SSCR1_MWDS	BIT(5)		/* Microwire Transmit Data Size */

#define SSSR_ALT_FRM_MASK	GENMASK(1, 0)	/* Masks the SFRM signal number */
#define SSSR_TNF		BIT(2)		/* Transmit FIFO Not Full */
#define SSSR_RNE		BIT(3)		/* Receive FIFO Not Empty */
#define SSSR_BSY		BIT(4)		/* SSP Busy */
#define SSSR_TFS		BIT(5)		/* Transmit FIFO Service Request */
#define SSSR_RFS		BIT(6)		/* Receive FIFO Service Request */
#define SSSR_ROR		BIT(7)		/* Receive FIFO Overrun */

#define RX_THRESH_DFLT	8
#define TX_THRESH_DFLT	8

#define SSSR_TFL_MASK	GENMASK(11, 8)	/* Transmit FIFO Level mask */
#define SSSR_RFL_MASK	GENMASK(15, 12)	/* Receive FIFO Level mask */

#define SSCR1_TFT	GENMASK(9, 6)	/* Transmit FIFO Threshold (mask) */
#define SSCR1_TxTresh(x) (((x) - 1) << 6)	/* level [1..16] */
#define SSCR1_RFT	GENMASK(13, 10)	/* Receive FIFO Threshold (mask) */
#define SSCR1_RxTresh(x) (((x) - 1) << 10)	/* level [1..16] */

#define RX_THRESH_CE4100_DFLT	2
#define TX_THRESH_CE4100_DFLT	2

#define CE4100_SSSR_TFL_MASK	GENMASK(9, 8)	/* Transmit FIFO Level mask */
#define CE4100_SSSR_RFL_MASK	GENMASK(13, 12)	/* Receive FIFO Level mask */

#define CE4100_SSCR1_TFT	GENMASK(7, 6)	/* Transmit FIFO Threshold (mask) */
#define CE4100_SSCR1_TxTresh(x) (((x) - 1) << 6)	/* level [1..4] */
#define CE4100_SSCR1_RFT	GENMASK(11, 10)	/* Receive FIFO Threshold (mask) */
#define CE4100_SSCR1_RxTresh(x) (((x) - 1) << 10)	/* level [1..4] */

/* QUARK_X1000 SSCR0 bit definition */
#define QUARK_X1000_SSCR0_DSS		GENMASK(4, 0)	/* Data Size Select (mask) */
#define QUARK_X1000_SSCR0_DataSize(x)	((x) - 1)	/* Data Size Select [4..32] */
#define QUARK_X1000_SSCR0_FRF		GENMASK(6, 5)	/* FRame Format (mask) */
#define QUARK_X1000_SSCR0_Motorola	(0x0 << 5)	/* Motorola's Serial Peripheral Interface (SPI) */

#define RX_THRESH_QUARK_X1000_DFLT	1
#define TX_THRESH_QUARK_X1000_DFLT	16

#define QUARK_X1000_SSSR_TFL_MASK	GENMASK(12, 8)	/* Transmit FIFO Level mask */
#define QUARK_X1000_SSSR_RFL_MASK	GENMASK(17, 13)	/* Receive FIFO Level mask */

#define QUARK_X1000_SSCR1_TFT	GENMASK(10, 6)	/* Transmit FIFO Threshold (mask) */
#define QUARK_X1000_SSCR1_TxTresh(x) (((x) - 1) << 6)	/* level [1..32] */
#define QUARK_X1000_SSCR1_RFT	GENMASK(15, 11)	/* Receive FIFO Threshold (mask) */
#define QUARK_X1000_SSCR1_RxTresh(x) (((x) - 1) << 11)	/* level [1..32] */
#define QUARK_X1000_SSCR1_EFWR	BIT(16)		/* Enable FIFO Write/Read */
#define QUARK_X1000_SSCR1_STRF	BIT(17)		/* Select FIFO or EFWR */

/* extra bits in PXA255, PXA26x and PXA27x SSP ports */
#define SSCR0_TISSP		(1 << 4)	/* TI Sync Serial Protocol */
#define SSCR0_PSP		(3 << 4)	/* PSP - Programmable Serial Protocol */

#define SSCR1_EFWR		BIT(14)		/* Enable FIFO Write/Read */
#define SSCR1_STRF		BIT(15)		/* Select FIFO or EFWR */
#define SSCR1_IFS		BIT(16)		/* Invert Frame Signal */
#define SSCR1_PINTE		BIT(18)		/* Peripheral Trailing Byte Interrupt Enable */
#define SSCR1_TINTE		BIT(19)		/* Receiver Time-out Interrupt enable */
#define SSCR1_RSRE		BIT(20)		/* Receive Service Request Enable */
#define SSCR1_TSRE		BIT(21)		/* Transmit Service Request Enable */
#define SSCR1_TRAIL		BIT(22)		/* Trailing Byte */
#define SSCR1_RWOT		BIT(23)		/* Receive Without Transmit */
#define SSCR1_SFRMDIR		BIT(24)		/* Frame Direction */
#define SSCR1_SCLKDIR		BIT(25)		/* Serial Bit Rate Clock Direction */
#define SSCR1_ECRB		BIT(26)		/* Enable Clock request B */
#define SSCR1_ECRA		BIT(27)		/* Enable Clock Request A */
#define SSCR1_SCFR		BIT(28)		/* Slave Clock free Running */
#define SSCR1_EBCEI		BIT(29)		/* Enable Bit Count Error interrupt */
#define SSCR1_TTE		BIT(30)		/* TXD Tristate Enable */
#define SSCR1_TTELP		BIT(31)		/* TXD Tristate Enable Last Phase */

#define SSSR_PINT		BIT(18)		/* Peripheral Trailing Byte Interrupt */
#define SSSR_TINT		BIT(19)		/* Receiver Time-out Interrupt */
#define SSSR_EOC		BIT(20)		/* End Of Chain */
#define SSSR_TUR		BIT(21)		/* Transmit FIFO Under Run */
#define SSSR_CSS		BIT(22)		/* Clock Synchronisation Status */
#define SSSR_BCE		BIT(23)		/* Bit Count Error */

#define SSPSP_SCMODE(x)		((x) << 0)	/* Serial Bit Rate Clock Mode */
#define SSPSP_SFRMP		BIT(2)		/* Serial Frame Polarity */
#define SSPSP_ETDS		BIT(3)		/* End of Transfer data State */
#define SSPSP_STRTDLY(x)	((x) << 4)	/* Start Delay */
#define SSPSP_DMYSTRT(x)	((x) << 7)	/* Dummy Start */
#define SSPSP_SFRMDLY(x)	((x) << 9)	/* Serial Frame Delay */
#define SSPSP_SFRMWDTH(x)	((x) << 16)	/* Serial Frame Width */
#define SSPSP_DMYSTOP(x)	((x) << 23)	/* Dummy Stop */
#define SSPSP_FSRT		BIT(25)		/* Frame Sync Relative Timing */

/* PXA3xx */
#define SSPSP_EDMYSTRT(x)	((x) << 26)     /* Extended Dummy Start */
#define SSPSP_EDMYSTOP(x)	((x) << 28)     /* Extended Dummy Stop */
#define SSPSP_TIMING_MASK	(0x7f8001f0)

#define SSACD_ACDS(x)		((x) << 0)	/* Audio clock divider select */
#define SSACD_ACDS_1		(0)
#define SSACD_ACDS_2		(1)
#define SSACD_ACDS_4		(2)
#define SSACD_ACDS_8		(3)
#define SSACD_ACDS_16		(4)
#define SSACD_ACDS_32		(5)
#define SSACD_SCDB		BIT(3)		/* SSPSYSCLK Divider Bypass */
#define SSACD_SCDB_4X		(0)
#define SSACD_SCDB_1X		(1)
#define SSACD_ACPS(x)		((x) << 4)	/* Audio clock PLL select */
#define SSACD_SCDX8		BIT(7)		/* SYSCLK division ratio select */

/* LPSS SSP */
#define SSITF			0x44		/* TX FIFO trigger level */
#define SSITF_TxHiThresh(x)	(((x) - 1) << 0)
#define SSITF_TxLoThresh(x)	(((x) - 1) << 8)

#define SSIRF			0x48		/* RX FIFO trigger level */
#define SSIRF_RxThresh(x)	((x) - 1)

/* LPT/WPT SSP */
#define SSCR2		(0x40)	/* SSP Command / Status 2 */
#define SSPSP2		(0x44)	/* SSP Programmable Serial Protocol 2 */

enum pxa_ssp_type {
	SSP_UNDEFINED = 0,
	PXA25x_SSP,  /* pxa 210, 250, 255, 26x */
	PXA25x_NSSP, /* pxa 255, 26x (including ASSP) */
	PXA27x_SSP,
	PXA3xx_SSP,
	PXA168_SSP,
	MMP2_SSP,
	PXA910_SSP,
	CE4100_SSP,
	QUARK_X1000_SSP,
	LPSS_LPT_SSP, /* Keep LPSS types sorted with lpss_platforms[] */
	LPSS_BYT_SSP,
	LPSS_BSW_SSP,
	LPSS_SPT_SSP,
	LPSS_BXT_SSP,
	LPSS_CNL_SSP,
};

struct ssp_device {
	struct device	*dev;
	struct list_head	node;

	struct clk	*clk;
	void __iomem	*mmio_base;
	unsigned long	phys_base;

	const char	*label;
	int		port_id;
	enum pxa_ssp_type type;
	int		use_count;
	int		irq;

	struct device_node	*of_node;
};

/**
 * pxa_ssp_write_reg - Write to a SSP register
 *
 * @dev: SSP device to access
 * @reg: Register to write to
 * @val: Value to be written.
 */
static inline void pxa_ssp_write_reg(struct ssp_device *dev, u32 reg, u32 val)
{
	__raw_writel(val, dev->mmio_base + reg);
}

/**
 * pxa_ssp_read_reg - Read from a SSP register
 *
 * @dev: SSP device to access
 * @reg: Register to read from
 */
static inline u32 pxa_ssp_read_reg(struct ssp_device *dev, u32 reg)
{
	return __raw_readl(dev->mmio_base + reg);
}

#if IS_ENABLED(CONFIG_PXA_SSP)
struct ssp_device *pxa_ssp_request(int port, const char *label);
void pxa_ssp_free(struct ssp_device *);
struct ssp_device *pxa_ssp_request_of(const struct device_node *of_node,
				      const char *label);
#else
static inline struct ssp_device *pxa_ssp_request(int port, const char *label)
{
	return NULL;
}
static inline struct ssp_device *pxa_ssp_request_of(const struct device_node *n,
						    const char *name)
{
	return NULL;
}
static inline void pxa_ssp_free(struct ssp_device *ssp) {}
#endif

#endif
Commit	Line	Data
d2912cb1	1	/* SPDX-License-Identifier: GPL-2.0-only */
1da177e4	2	/*
8348c259	3	* pxa2xx_ssp.h
1da177e4 LT	4	*
	5	* Copyright (C) 2003 Russell King, All Rights Reserved.
	6	*
1da177e4 LT	7	* This driver supports the following PXA CPU/SSP ports:-
	8	*
	9	* PXA250 SSP
	10	* PXA255 SSP, NSSP
	11	* PXA26x SSP, NSSP, ASSP
	12	* PXA27x SSP1, SSP2, SSP3
88286450	13	* PXA3xx SSP1, SSP2, SSP3, SSP4
1da177e4 LT	14	*/
1da177e4 LT	15
8348c259 SAS	16	#ifndef __LINUX_SSP_H
8348c259 SAS	17	#define __LINUX_SSP_H
88286450	18
410f4cf7	19	#include <linux/bits.h>
e7aaf874	20	#include <linux/compiler_types.h>
63bef547	21	#include <linux/io.h>
e7aaf874 AS	22	#include <linux/kconfig.h>
	23	#include <linux/list.h>
	24	#include <linux/types.h>
6446221c	25
e7aaf874 AS	26	struct clk;
	27	struct device;
	28	struct device_node;
88286450	29
83f28896 EM	30	/*
	31	* SSP Serial Port Registers
	32	* PXA250, PXA255, PXA26x and PXA27x SSP controllers are all slightly different.
	33	* PXA255, PXA26x and PXA27x have extra ports, registers and bits.
	34	*/
	35
	36	#define SSCR0 (0x00) /* SSP Control Register 0 */
	37	#define SSCR1 (0x04) /* SSP Control Register 1 */
	38	#define SSSR (0x08) /* SSP Status Register */
	39	#define SSITR (0x0C) /* SSP Interrupt Test Register */
	40	#define SSDR (0x10) /* SSP Data Write/Data Read Register */
	41
	42	#define SSTO (0x28) /* SSP Time Out Register */
c4827bb8	43	#define DDS_RATE (0x28) /* SSP DDS Clock Rate Register (Intel Quark) */
83f28896 EM	44	#define SSPSP (0x2C) /* SSP Programmable Serial Protocol */
	45	#define SSTSA (0x30) /* SSP Tx Timeslot Active */
	46	#define SSRSA (0x34) /* SSP Rx Timeslot Active */
	47	#define SSTSS (0x38) /* SSP Timeslot Status */
	48	#define SSACD (0x3C) /* SSP Audio Clock Divider */
83f28896	49	#define SSACDD (0x40) /* SSP Audio Clock Dither Divider */
83f28896 EM	50
83f28896 EM	51	/* Common PXA2xx bits first */
410f4cf7	52	#define SSCR0_DSS GENMASK(3, 0) /* Data Size Select (mask) */
83f28896	53	#define SSCR0_DataSize(x) ((x) - 1) /* Data Size Select [4..16] */
410f4cf7	54	#define SSCR0_FRF GENMASK(5, 4) /* FRame Format (mask) */
83f28896 EM	55	#define SSCR0_Motorola (0x0 << 4) /* Motorola's Serial Peripheral Interface (SPI) */
	56	#define SSCR0_TI (0x1 << 4) /* Texas Instruments' Synchronous Serial Protocol (SSP) */
	57	#define SSCR0_National (0x2 << 4) /* National Microwire */
410f4cf7 AS	58	#define SSCR0_ECS BIT(6) /* External clock select */
410f4cf7 AS	59	#define SSCR0_SSE BIT(7) /* Synchronous Serial Port Enable */
83f28896 EM	60	#define SSCR0_SCR(x) ((x) << 8) /* Serial Clock Rate (mask) */
83f28896 EM	61
004690f0	62	/* PXA27x, PXA3xx */
410f4cf7 AS	63	#define SSCR0_EDSS BIT(20) /* Extended data size select */
	64	#define SSCR0_NCS BIT(21) /* Network clock select */
	65	#define SSCR0_RIM BIT(22) /* Receive FIFO overrrun interrupt mask */
	66	#define SSCR0_TUM BIT(23) /* Transmit FIFO underrun interrupt mask */
	67	#define SSCR0_FRDC GENMASK(26, 24) /* Frame rate divider control (mask) */
83f28896	68	#define SSCR0_SlotsPerFrm(x) (((x) - 1) << 24) /* Time slots per frame [1..8] */
410f4cf7 AS	69	#define SSCR0_FPCKE BIT(29) /* FIFO packing enable */
	70	#define SSCR0_ACS BIT(30) /* Audio clock select */
	71	#define SSCR0_MOD BIT(31) /* Mode (normal or network) */
	72
	73	#define SSCR1_RIE BIT(0) /* Receive FIFO Interrupt Enable */
	74	#define SSCR1_TIE BIT(1) /* Transmit FIFO Interrupt Enable */
	75	#define SSCR1_LBM BIT(2) /* Loop-Back Mode */
	76	#define SSCR1_SPO BIT(3) /* Motorola SPI SSPSCLK polarity setting */
	77	#define SSCR1_SPH BIT(4) /* Motorola SPI SSPSCLK phase setting */
	78	#define SSCR1_MWDS BIT(5) /* Microwire Transmit Data Size */
	79
	80	#define SSSR_ALT_FRM_MASK GENMASK(1, 0) /* Masks the SFRM signal number */
	81	#define SSSR_TNF BIT(2) /* Transmit FIFO Not Full */
	82	#define SSSR_RNE BIT(3) /* Receive FIFO Not Empty */
	83	#define SSSR_BSY BIT(4) /* SSP Busy */
	84	#define SSSR_TFS BIT(5) /* Transmit FIFO Service Request */
	85	#define SSSR_RFS BIT(6) /* Receive FIFO Service Request */
	86	#define SSSR_ROR BIT(7) /* Receive FIFO Overrun */
d0777f2c	87
d0777f2c SAS	88	#define RX_THRESH_DFLT 8
	89	#define TX_THRESH_DFLT 8
	90
410f4cf7 AS	91	#define SSSR_TFL_MASK GENMASK(11, 8) /* Transmit FIFO Level mask */
410f4cf7 AS	92	#define SSSR_RFL_MASK GENMASK(15, 12) /* Receive FIFO Level mask */
d0777f2c	93
410f4cf7	94	#define SSCR1_TFT GENMASK(9, 6) /* Transmit FIFO Threshold (mask) */
63971c56	95	#define SSCR1_TxTresh(x) (((x) - 1) << 6) /* level [1..16] */
410f4cf7	96	#define SSCR1_RFT GENMASK(13, 10) /* Receive FIFO Threshold (mask) */
63971c56	97	#define SSCR1_RxTresh(x) (((x) - 1) << 10) /* level [1..16] */
d0777f2c	98
7c7289a4 AS	99	#define RX_THRESH_CE4100_DFLT 2
7c7289a4 AS	100	#define TX_THRESH_CE4100_DFLT 2
d0777f2c	101
410f4cf7 AS	102	#define CE4100_SSSR_TFL_MASK GENMASK(9, 8) /* Transmit FIFO Level mask */
410f4cf7 AS	103	#define CE4100_SSSR_RFL_MASK GENMASK(13, 12) /* Receive FIFO Level mask */
d0777f2c	104
410f4cf7	105	#define CE4100_SSCR1_TFT GENMASK(7, 6) /* Transmit FIFO Threshold (mask) */
7c7289a4	106	#define CE4100_SSCR1_TxTresh(x) (((x) - 1) << 6) /* level [1..4] */
410f4cf7	107	#define CE4100_SSCR1_RFT GENMASK(11, 10) /* Receive FIFO Threshold (mask) */
7c7289a4	108	#define CE4100_SSCR1_RxTresh(x) (((x) - 1) << 10) /* level [1..4] */
83f28896	109
e5262d05	110	/* QUARK_X1000 SSCR0 bit definition */
410f4cf7	111	#define QUARK_X1000_SSCR0_DSS GENMASK(4, 0) /* Data Size Select (mask) */
63971c56	112	#define QUARK_X1000_SSCR0_DataSize(x) ((x) - 1) /* Data Size Select [4..32] */
410f4cf7	113	#define QUARK_X1000_SSCR0_FRF GENMASK(6, 5) /* FRame Format (mask) */
e5262d05 WC	114	#define QUARK_X1000_SSCR0_Motorola (0x0 << 5) /* Motorola's Serial Peripheral Interface (SPI) */
	115
	116	#define RX_THRESH_QUARK_X1000_DFLT 1
	117	#define TX_THRESH_QUARK_X1000_DFLT 16
	118
410f4cf7 AS	119	#define QUARK_X1000_SSSR_TFL_MASK GENMASK(12, 8) /* Transmit FIFO Level mask */
410f4cf7 AS	120	#define QUARK_X1000_SSSR_RFL_MASK GENMASK(17, 13) /* Receive FIFO Level mask */
e5262d05	121
410f4cf7	122	#define QUARK_X1000_SSCR1_TFT GENMASK(10, 6) /* Transmit FIFO Threshold (mask) */
e5262d05	123	#define QUARK_X1000_SSCR1_TxTresh(x) (((x) - 1) << 6) /* level [1..32] */
410f4cf7	124	#define QUARK_X1000_SSCR1_RFT GENMASK(15, 11) /* Receive FIFO Threshold (mask) */
e5262d05	125	#define QUARK_X1000_SSCR1_RxTresh(x) (((x) - 1) << 11) /* level [1..32] */
410f4cf7 AS	126	#define QUARK_X1000_SSCR1_EFWR BIT(16) /* Enable FIFO Write/Read */
410f4cf7 AS	127	#define QUARK_X1000_SSCR1_STRF BIT(17) /* Select FIFO or EFWR */
e5262d05	128
83f28896 EM	129	/* extra bits in PXA255, PXA26x and PXA27x SSP ports */
	130	#define SSCR0_TISSP (1 << 4) /* TI Sync Serial Protocol */
	131	#define SSCR0_PSP (3 << 4) /* PSP - Programmable Serial Protocol */
83f28896	132
410f4cf7 AS	133	#define SSCR1_EFWR BIT(14) /* Enable FIFO Write/Read */
	134	#define SSCR1_STRF BIT(15) /* Select FIFO or EFWR */
	135	#define SSCR1_IFS BIT(16) /* Invert Frame Signal */
	136	#define SSCR1_PINTE BIT(18) /* Peripheral Trailing Byte Interrupt Enable */
	137	#define SSCR1_TINTE BIT(19) /* Receiver Time-out Interrupt enable */
	138	#define SSCR1_RSRE BIT(20) /* Receive Service Request Enable */
	139	#define SSCR1_TSRE BIT(21) /* Transmit Service Request Enable */
	140	#define SSCR1_TRAIL BIT(22) /* Trailing Byte */
	141	#define SSCR1_RWOT BIT(23) /* Receive Without Transmit */
	142	#define SSCR1_SFRMDIR BIT(24) /* Frame Direction */
	143	#define SSCR1_SCLKDIR BIT(25) /* Serial Bit Rate Clock Direction */
	144	#define SSCR1_ECRB BIT(26) /* Enable Clock request B */
	145	#define SSCR1_ECRA BIT(27) /* Enable Clock Request A */
	146	#define SSCR1_SCFR BIT(28) /* Slave Clock free Running */
	147	#define SSCR1_EBCEI BIT(29) /* Enable Bit Count Error interrupt */
	148	#define SSCR1_TTE BIT(30) /* TXD Tristate Enable */
	149	#define SSCR1_TTELP BIT(31) /* TXD Tristate Enable Last Phase */
	150
	151	#define SSSR_PINT BIT(18) /* Peripheral Trailing Byte Interrupt */
	152	#define SSSR_TINT BIT(19) /* Receiver Time-out Interrupt */
	153	#define SSSR_EOC BIT(20) /* End Of Chain */
	154	#define SSSR_TUR BIT(21) /* Transmit FIFO Under Run */
	155	#define SSSR_CSS BIT(22) /* Clock Synchronisation Status */
	156	#define SSSR_BCE BIT(23) /* Bit Count Error */
83f28896	157
83f28896	158	#define SSPSP_SCMODE(x) ((x) << 0) /* Serial Bit Rate Clock Mode */
410f4cf7 AS	159	#define SSPSP_SFRMP BIT(2) /* Serial Frame Polarity */
410f4cf7 AS	160	#define SSPSP_ETDS BIT(3) /* End of Transfer data State */
004690f0 HZ	161	#define SSPSP_STRTDLY(x) ((x) << 4) /* Start Delay */
	162	#define SSPSP_DMYSTRT(x) ((x) << 7) /* Dummy Start */
	163	#define SSPSP_SFRMDLY(x) ((x) << 9) /* Serial Frame Delay */
	164	#define SSPSP_SFRMWDTH(x) ((x) << 16) /* Serial Frame Width */
	165	#define SSPSP_DMYSTOP(x) ((x) << 23) /* Dummy Stop */
410f4cf7	166	#define SSPSP_FSRT BIT(25) /* Frame Sync Relative Timing */
004690f0 HZ	167
	168	/* PXA3xx */
	169	#define SSPSP_EDMYSTRT(x) ((x) << 26) /* Extended Dummy Start */
	170	#define SSPSP_EDMYSTOP(x) ((x) << 28) /* Extended Dummy Stop */
	171	#define SSPSP_TIMING_MASK (0x7f8001f0)
83f28896	172
83f28896	173	#define SSACD_ACDS(x) ((x) << 0) /* Audio clock divider select */
05739375 DM	174	#define SSACD_ACDS_1 (0)
	175	#define SSACD_ACDS_2 (1)
	176	#define SSACD_ACDS_4 (2)
	177	#define SSACD_ACDS_8 (3)
	178	#define SSACD_ACDS_16 (4)
	179	#define SSACD_ACDS_32 (5)
410f4cf7	180	#define SSACD_SCDB BIT(3) /* SSPSYSCLK Divider Bypass */
05739375 DM	181	#define SSACD_SCDB_4X (0)
05739375 DM	182	#define SSACD_SCDB_1X (1)
410f4cf7 AS	183	#define SSACD_ACPS(x) ((x) << 4) /* Audio clock PLL select */
410f4cf7 AS	184	#define SSACD_SCDX8 BIT(7) /* SYSCLK division ratio select */
83f28896	185
a0d2642e MW	186	/* LPSS SSP */
a0d2642e MW	187	#define SSITF 0x44 /* TX FIFO trigger level */
410f4cf7	188	#define SSITF_TxHiThresh(x) (((x) - 1) << 0)
a0d2642e	189	#define SSITF_TxLoThresh(x) (((x) - 1) << 8)
a0d2642e MW	190
	191	#define SSIRF 0x48 /* RX FIFO trigger level */
	192	#define SSIRF_RxThresh(x) ((x) - 1)
	193
a2bee00c CR	194	/* LPT/WPT SSP */
	195	#define SSCR2 (0x40) /* SSP Command / Status 2 */
	196	#define SSPSP2 (0x44) /* SSP Programmable Serial Protocol 2 */
	197
88286450	198	enum pxa_ssp_type {
	199	SSP_UNDEFINED = 0,
	200	PXA25x_SSP, /* pxa 210, 250, 255, 26x */
	201	PXA25x_NSSP, /* pxa 255, 26x (including ASSP) */
	202	PXA27x_SSP,
972a55b6	203	PXA3xx_SSP,
7e499228	204	PXA168_SSP,
87ae1d2d	205	MMP2_SSP,
60172215	206	PXA910_SSP,
2a8626a9	207	CE4100_SSP,
e5262d05	208	QUARK_X1000_SSP,
dccf7369	209	LPSS_LPT_SSP, /* Keep LPSS types sorted with lpss_platforms[] */
03fbf488	210	LPSS_BYT_SSP,
30f3a6ab	211	LPSS_BSW_SSP,
34cadd9c	212	LPSS_SPT_SSP,
b7c08cf8	213	LPSS_BXT_SSP,
fc0b2acc	214	LPSS_CNL_SSP,
88286450	215	};
	216
	217	struct ssp_device {
4f3d9577	218	struct device *dev;
88286450	219	struct list_head node;
	220
	221	struct clk *clk;
	222	void __iomem *mmio_base;
	223	unsigned long phys_base;
	224
	225	const char *label;
	226	int port_id;
55ef8262	227	enum pxa_ssp_type type;
88286450	228	int use_count;
88286450	229	int irq;
6446221c DM	230
6446221c DM	231	struct device_node *of_node;
88286450	232	};
1da177e4	233
63bef547	234	/**
baffe169	235	* pxa_ssp_write_reg - Write to a SSP register
63bef547 MB	236	*
	237	* @dev: SSP device to access
	238	* @reg: Register to write to
	239	* @val: Value to be written.
	240	*/
baffe169	241	static inline void pxa_ssp_write_reg(struct ssp_device *dev, u32 reg, u32 val)
63bef547 MB	242	{
	243	__raw_writel(val, dev->mmio_base + reg);
	244	}
	245
	246	/**
baffe169	247	* pxa_ssp_read_reg - Read from a SSP register
63bef547 MB	248	*
	249	* @dev: SSP device to access
	250	* @reg: Register to read from
	251	*/
baffe169	252	static inline u32 pxa_ssp_read_reg(struct ssp_device *dev, u32 reg)
63bef547 MB	253	{
	254	return __raw_readl(dev->mmio_base + reg);
	255	}
	256
1ced9a5b	257	#if IS_ENABLED(CONFIG_PXA_SSP)
baffe169 HZ	258	struct ssp_device pxa_ssp_request(int port, const char label);
baffe169 HZ	259	void pxa_ssp_free(struct ssp_device *);
6446221c DM	260	struct ssp_device pxa_ssp_request_of(const struct device_node of_node,
6446221c DM	261	const char *label);
851bacf5 MW	262	#else
	263	static inline struct ssp_device pxa_ssp_request(int port, const char label)
	264	{
	265	return NULL;
	266	}
6446221c DM	267	static inline struct ssp_device pxa_ssp_request_of(const struct device_node n,
	268	const char *name)
	269	{
	270	return NULL;
	271	}
851bacf5 MW	272	static inline void pxa_ssp_free(struct ssp_device *ssp) {}
	273	#endif
	274
8348c259	275	#endif