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

/*
 *  pxa2xx_ssp.h
 *
 *  Copyright (C) 2003 Russell King, All Rights Reserved.
 *
 * 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.
 *
 * 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/list.h>
#include <linux/io.h>

/*
 * 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 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	(0x0000000f)	/* Data Size Select (mask) */
#define SSCR0_DataSize(x)  ((x) - 1)	/* Data Size Select [4..16] */
#define SSCR0_FRF	(0x00000030)	/* 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	(1 << 6)	/* External clock select */
#define SSCR0_SSE	(1 << 7)	/* Synchronous Serial Port Enable */
#define SSCR0_SCR(x)	((x) << 8)	/* Serial Clock Rate (mask) */

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


#define SSCR1_RIE	(1 << 0)	/* Receive FIFO Interrupt Enable */
#define SSCR1_TIE	(1 << 1)	/* Transmit FIFO Interrupt Enable */
#define SSCR1_LBM	(1 << 2)	/* Loop-Back Mode */
#define SSCR1_SPO	(1 << 3)	/* Motorola SPI SSPSCLK polarity setting */
#define SSCR1_SPH	(1 << 4)	/* Motorola SPI SSPSCLK phase setting */
#define SSCR1_MWDS	(1 << 5)	/* Microwire Transmit Data Size */
#define SSCR1_TFT	(0x000003c0)	/* Transmit FIFO Threshold (mask) */
#define SSCR1_TxTresh(x) (((x) - 1) << 6) /* level [1..16] */
#define SSCR1_RFT	(0x00003c00)	/* Receive FIFO Threshold (mask) */
#define SSCR1_RxTresh(x) (((x) - 1) << 10) /* level [1..16] */

#define SSSR_TNF	(1 << 2)	/* Transmit FIFO Not Full */
#define SSSR_RNE	(1 << 3)	/* Receive FIFO Not Empty */
#define SSSR_BSY	(1 << 4)	/* SSP Busy */
#define SSSR_TFS	(1 << 5)	/* Transmit FIFO Service Request */
#define SSSR_RFS	(1 << 6)	/* Receive FIFO Service Request */
#define SSSR_ROR	(1 << 7)	/* Receive FIFO Overrun */
#define SSSR_TFL_MASK   (0xf << 8)	/* Transmit FIFO Level mask */
#define SSSR_RFL_MASK   (0xf << 12)	/* Receive FIFO Level mask */

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

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


#define SSPSP_SCMODE(x)		((x) << 0)	/* Serial Bit Rate Clock Mode */
#define SSPSP_SFRMP		(1 << 2)	/* Serial Frame Polarity */
#define SSPSP_ETDS		(1 << 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		(1 << 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_SCDB		(1 << 3)	/* SSPSYSCLK Divider Bypass */
#define SSACD_ACPS(x)		((x) << 4)	/* Audio clock PLL select */
#define SSACD_ACDS(x)		((x) << 0)	/* Audio clock divider select */
#define SSACD_SCDX8		(1 << 7)	/* SYSCLK division ratio select */

enum pxa_ssp_type {
	SSP_UNDEFINED = 0,
	PXA25x_SSP,  /* pxa 210, 250, 255, 26x */
	PXA25x_NSSP, /* pxa 255, 26x (including ASSP) */
	PXA27x_SSP,
	PXA168_SSP,
};

struct ssp_device {
	struct platform_device *pdev;
	struct list_head	node;

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

	const char	*label;
	int		port_id;
	int		type;
	int		use_count;
	int		irq;
	int		drcmr_rx;
	int		drcmr_tx;
};

/**
 * 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);
}

struct ssp_device *pxa_ssp_request(int port, const char *label);
void pxa_ssp_free(struct ssp_device *);
#endif
Commit	Line	Data
1da177e4	1	/*
8348c259	2	* pxa2xx_ssp.h
1da177e4 LT	3	*
	4	* Copyright (C) 2003 Russell King, All Rights Reserved.
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License version 2 as
	8	* published by the Free Software Foundation.
	9	*
	10	* This driver supports the following PXA CPU/SSP ports:-
	11	*
	12	* PXA250 SSP
	13	* PXA255 SSP, NSSP
	14	* PXA26x SSP, NSSP, ASSP
	15	* PXA27x SSP1, SSP2, SSP3
88286450	16	* PXA3xx SSP1, SSP2, SSP3, SSP4
1da177e4 LT	17	*/
1da177e4 LT	18
8348c259 SAS	19	#ifndef __LINUX_SSP_H
8348c259 SAS	20	#define __LINUX_SSP_H
88286450	21
88286450	22	#include <linux/list.h>
63bef547	23	#include <linux/io.h>
88286450	24
83f28896 EM	25	/*
	26	* SSP Serial Port Registers
	27	* PXA250, PXA255, PXA26x and PXA27x SSP controllers are all slightly different.
	28	* PXA255, PXA26x and PXA27x have extra ports, registers and bits.
	29	*/
	30
	31	#define SSCR0 (0x00) /* SSP Control Register 0 */
	32	#define SSCR1 (0x04) /* SSP Control Register 1 */
	33	#define SSSR (0x08) /* SSP Status Register */
	34	#define SSITR (0x0C) /* SSP Interrupt Test Register */
	35	#define SSDR (0x10) /* SSP Data Write/Data Read Register */
	36
	37	#define SSTO (0x28) /* SSP Time Out Register */
	38	#define SSPSP (0x2C) /* SSP Programmable Serial Protocol */
	39	#define SSTSA (0x30) /* SSP Tx Timeslot Active */
	40	#define SSRSA (0x34) /* SSP Rx Timeslot Active */
	41	#define SSTSS (0x38) /* SSP Timeslot Status */
	42	#define SSACD (0x3C) /* SSP Audio Clock Divider */
83f28896	43	#define SSACDD (0x40) /* SSP Audio Clock Dither Divider */
83f28896 EM	44
	45	/* Common PXA2xx bits first */
	46	#define SSCR0_DSS (0x0000000f) /* Data Size Select (mask) */
	47	#define SSCR0_DataSize(x) ((x) - 1) /* Data Size Select [4..16] */
	48	#define SSCR0_FRF (0x00000030) /* FRame Format (mask) */
	49	#define SSCR0_Motorola (0x0 << 4) /* Motorola's Serial Peripheral Interface (SPI) */
	50	#define SSCR0_TI (0x1 << 4) /* Texas Instruments' Synchronous Serial Protocol (SSP) */
	51	#define SSCR0_National (0x2 << 4) /* National Microwire */
	52	#define SSCR0_ECS (1 << 6) /* External clock select */
	53	#define SSCR0_SSE (1 << 7) /* Synchronous Serial Port Enable */
	54	#define SSCR0_SCR(x) ((x) << 8) /* Serial Clock Rate (mask) */
	55
004690f0	56	/* PXA27x, PXA3xx */
83f28896 EM	57	#define SSCR0_EDSS (1 << 20) /* Extended data size select */
	58	#define SSCR0_NCS (1 << 21) /* Network clock select */
	59	#define SSCR0_RIM (1 << 22) /* Receive FIFO overrrun interrupt mask */
	60	#define SSCR0_TUM (1 << 23) /* Transmit FIFO underrun interrupt mask */
	61	#define SSCR0_FRDC (0x07000000) /* Frame rate divider control (mask) */
	62	#define SSCR0_SlotsPerFrm(x) (((x) - 1) << 24) /* Time slots per frame [1..8] */
004690f0	63	#define SSCR0_FPCKE (1 << 29) /* FIFO packing enable */
83f28896 EM	64	#define SSCR0_ACS (1 << 30) /* Audio clock select */
83f28896 EM	65	#define SSCR0_MOD (1 << 31) /* Mode (normal or network) */
83f28896	66
83f28896 EM	67
	68	#define SSCR1_RIE (1 << 0) /* Receive FIFO Interrupt Enable */
	69	#define SSCR1_TIE (1 << 1) /* Transmit FIFO Interrupt Enable */
	70	#define SSCR1_LBM (1 << 2) /* Loop-Back Mode */
	71	#define SSCR1_SPO (1 << 3) /* Motorola SPI SSPSCLK polarity setting */
	72	#define SSCR1_SPH (1 << 4) /* Motorola SPI SSPSCLK phase setting */
	73	#define SSCR1_MWDS (1 << 5) /* Microwire Transmit Data Size */
	74	#define SSCR1_TFT (0x000003c0) /* Transmit FIFO Threshold (mask) */
	75	#define SSCR1_TxTresh(x) (((x) - 1) << 6) /* level [1..16] */
	76	#define SSCR1_RFT (0x00003c00) /* Receive FIFO Threshold (mask) */
	77	#define SSCR1_RxTresh(x) (((x) - 1) << 10) /* level [1..16] */
	78
	79	#define SSSR_TNF (1 << 2) /* Transmit FIFO Not Full */
	80	#define SSSR_RNE (1 << 3) /* Receive FIFO Not Empty */
	81	#define SSSR_BSY (1 << 4) /* SSP Busy */
	82	#define SSSR_TFS (1 << 5) /* Transmit FIFO Service Request */
	83	#define SSSR_RFS (1 << 6) /* Receive FIFO Service Request */
	84	#define SSSR_ROR (1 << 7) /* Receive FIFO Overrun */
4a25605f SAS	85	#define SSSR_TFL_MASK (0xf << 8) /* Transmit FIFO Level mask */
4a25605f SAS	86	#define SSSR_RFL_MASK (0xf << 12) /* Receive FIFO Level mask */
83f28896 EM	87
	88	/* extra bits in PXA255, PXA26x and PXA27x SSP ports */
	89	#define SSCR0_TISSP (1 << 4) /* TI Sync Serial Protocol */
	90	#define SSCR0_PSP (3 << 4) /* PSP - Programmable Serial Protocol */
	91	#define SSCR1_TTELP (1 << 31) /* TXD Tristate Enable Last Phase */
	92	#define SSCR1_TTE (1 << 30) /* TXD Tristate Enable */
	93	#define SSCR1_EBCEI (1 << 29) /* Enable Bit Count Error interrupt */
	94	#define SSCR1_SCFR (1 << 28) /* Slave Clock free Running */
	95	#define SSCR1_ECRA (1 << 27) /* Enable Clock Request A */
	96	#define SSCR1_ECRB (1 << 26) /* Enable Clock request B */
	97	#define SSCR1_SCLKDIR (1 << 25) /* Serial Bit Rate Clock Direction */
	98	#define SSCR1_SFRMDIR (1 << 24) /* Frame Direction */
	99	#define SSCR1_RWOT (1 << 23) /* Receive Without Transmit */
	100	#define SSCR1_TRAIL (1 << 22) /* Trailing Byte */
	101	#define SSCR1_TSRE (1 << 21) /* Transmit Service Request Enable */
	102	#define SSCR1_RSRE (1 << 20) /* Receive Service Request Enable */
	103	#define SSCR1_TINTE (1 << 19) /* Receiver Time-out Interrupt enable */
	104	#define SSCR1_PINTE (1 << 18) /* Peripheral Trailing Byte Interupt Enable */
	105	#define SSCR1_IFS (1 << 16) /* Invert Frame Signal */
	106	#define SSCR1_STRF (1 << 15) /* Select FIFO or EFWR */
	107	#define SSCR1_EFWR (1 << 14) /* Enable FIFO Write/Read */
	108
	109	#define SSSR_BCE (1 << 23) /* Bit Count Error */
	110	#define SSSR_CSS (1 << 22) /* Clock Synchronisation Status */
	111	#define SSSR_TUR (1 << 21) /* Transmit FIFO Under Run */
	112	#define SSSR_EOC (1 << 20) /* End Of Chain */
	113	#define SSSR_TINT (1 << 19) /* Receiver Time-out Interrupt */
	114	#define SSSR_PINT (1 << 18) /* Peripheral Trailing Byte Interrupt */
	115
83f28896	116
83f28896	117	#define SSPSP_SCMODE(x) ((x) << 0) /* Serial Bit Rate Clock Mode */
004690f0 HZ	118	#define SSPSP_SFRMP (1 << 2) /* Serial Frame Polarity */
	119	#define SSPSP_ETDS (1 << 3) /* End of Transfer data State */
	120	#define SSPSP_STRTDLY(x) ((x) << 4) /* Start Delay */
	121	#define SSPSP_DMYSTRT(x) ((x) << 7) /* Dummy Start */
	122	#define SSPSP_SFRMDLY(x) ((x) << 9) /* Serial Frame Delay */
	123	#define SSPSP_SFRMWDTH(x) ((x) << 16) /* Serial Frame Width */
	124	#define SSPSP_DMYSTOP(x) ((x) << 23) /* Dummy Stop */
	125	#define SSPSP_FSRT (1 << 25) /* Frame Sync Relative Timing */
	126
	127	/* PXA3xx */
	128	#define SSPSP_EDMYSTRT(x) ((x) << 26) /* Extended Dummy Start */
	129	#define SSPSP_EDMYSTOP(x) ((x) << 28) /* Extended Dummy Stop */
	130	#define SSPSP_TIMING_MASK (0x7f8001f0)
83f28896 EM	131
	132	#define SSACD_SCDB (1 << 3) /* SSPSYSCLK Divider Bypass */
	133	#define SSACD_ACPS(x) ((x) << 4) /* Audio clock PLL select */
	134	#define SSACD_ACDS(x) ((x) << 0) /* Audio clock divider select */
83f28896	135	#define SSACD_SCDX8 (1 << 7) /* SYSCLK division ratio select */
83f28896	136
88286450	137	enum pxa_ssp_type {
	138	SSP_UNDEFINED = 0,
	139	PXA25x_SSP, /* pxa 210, 250, 255, 26x */
	140	PXA25x_NSSP, /* pxa 255, 26x (including ASSP) */
	141	PXA27x_SSP,
7e499228	142	PXA168_SSP,
88286450	143	};
	144
	145	struct ssp_device {
	146	struct platform_device *pdev;
	147	struct list_head node;
	148
	149	struct clk *clk;
	150	void __iomem *mmio_base;
	151	unsigned long phys_base;
	152
	153	const char *label;
	154	int port_id;
	155	int type;
	156	int use_count;
	157	int irq;
	158	int drcmr_rx;
	159	int drcmr_tx;
	160	};
1da177e4	161
63bef547	162	/**
baffe169	163	* pxa_ssp_write_reg - Write to a SSP register
63bef547 MB	164	*
	165	* @dev: SSP device to access
	166	* @reg: Register to write to
	167	* @val: Value to be written.
	168	*/
baffe169	169	static inline void pxa_ssp_write_reg(struct ssp_device *dev, u32 reg, u32 val)
63bef547 MB	170	{
	171	__raw_writel(val, dev->mmio_base + reg);
	172	}
	173
	174	/**
baffe169	175	* pxa_ssp_read_reg - Read from a SSP register
63bef547 MB	176	*
	177	* @dev: SSP device to access
	178	* @reg: Register to read from
	179	*/
baffe169	180	static inline u32 pxa_ssp_read_reg(struct ssp_device *dev, u32 reg)
63bef547 MB	181	{
	182	return __raw_readl(dev->mmio_base + reg);
	183	}
	184
baffe169 HZ	185	struct ssp_device pxa_ssp_request(int port, const char label);
baffe169 HZ	186	void pxa_ssp_free(struct ssp_device *);
8348c259	187	#endif