Linux Audio

Check our new training course

Loading...
v5.14.15
  1/* SPDX-License-Identifier: GPL-2.0-only */
  2/* Driver for Realtek RTS5139 USB card reader
  3 *
  4 * Copyright(c) 2009-2013 Realtek Semiconductor Corp. All rights reserved.
  5 *
  6 * Author:
  7 *   Roger Tseng <rogerable@realtek.com>
  8 */
  9
 10#ifndef __RTSX_USB_H
 11#define __RTSX_USB_H
 12
 13#include <linux/usb.h>
 14
 15/* related module names */
 16#define RTSX_USB_SD_CARD	0
 17#define RTSX_USB_MS_CARD	1
 18
 19/* endpoint numbers */
 20#define EP_BULK_OUT		1
 21#define EP_BULK_IN		2
 22#define EP_INTR_IN		3
 23
 24/* USB vendor requests */
 25#define RTSX_USB_REQ_REG_OP	0x00
 26#define RTSX_USB_REQ_POLL	0x02
 27
 28/* miscellaneous parameters */
 29#define MIN_DIV_N		60
 30#define MAX_DIV_N		120
 31
 32#define MAX_PHASE		15
 33#define RX_TUNING_CNT		3
 34
 35#define QFN24			0
 36#define LQFP48			1
 37#define CHECK_PKG(ucr, pkg)	((ucr)->package == (pkg))
 38
 39/* data structures */
 40struct rtsx_ucr {
 41	u16			vendor_id;
 42	u16			product_id;
 43
 44	int			package;
 45	u8			ic_version;
 46	bool			is_rts5179;
 47
 48	unsigned int		cur_clk;
 49
 50	u8			*cmd_buf;
 51	unsigned int		cmd_idx;
 52	u8			*rsp_buf;
 53
 54	struct usb_device	*pusb_dev;
 55	struct usb_interface	*pusb_intf;
 56	struct usb_sg_request	current_sg;
 57	unsigned char		*iobuf;
 58	dma_addr_t		iobuf_dma;
 59
 60	struct timer_list	sg_timer;
 61	struct mutex		dev_mutex;
 62};
 63
 64/* buffer size */
 65#define IOBUF_SIZE		1024
 66
 67/* prototypes of exported functions */
 68extern int rtsx_usb_get_card_status(struct rtsx_ucr *ucr, u16 *status);
 69
 70extern int rtsx_usb_read_register(struct rtsx_ucr *ucr, u16 addr, u8 *data);
 71extern int rtsx_usb_write_register(struct rtsx_ucr *ucr, u16 addr, u8 mask,
 72		u8 data);
 73
 74extern int rtsx_usb_ep0_write_register(struct rtsx_ucr *ucr, u16 addr, u8 mask,
 75		u8 data);
 76extern int rtsx_usb_ep0_read_register(struct rtsx_ucr *ucr, u16 addr,
 77		u8 *data);
 78
 79extern void rtsx_usb_add_cmd(struct rtsx_ucr *ucr, u8 cmd_type,
 80		u16 reg_addr, u8 mask, u8 data);
 81extern int rtsx_usb_send_cmd(struct rtsx_ucr *ucr, u8 flag, int timeout);
 82extern int rtsx_usb_get_rsp(struct rtsx_ucr *ucr, int rsp_len, int timeout);
 83extern int rtsx_usb_transfer_data(struct rtsx_ucr *ucr, unsigned int pipe,
 84			      void *buf, unsigned int len, int use_sg,
 85			      unsigned int *act_len, int timeout);
 86
 87extern int rtsx_usb_read_ppbuf(struct rtsx_ucr *ucr, u8 *buf, int buf_len);
 88extern int rtsx_usb_write_ppbuf(struct rtsx_ucr *ucr, u8 *buf, int buf_len);
 89extern int rtsx_usb_switch_clock(struct rtsx_ucr *ucr, unsigned int card_clock,
 90		u8 ssc_depth, bool initial_mode, bool double_clk, bool vpclk);
 91extern int rtsx_usb_card_exclusive_check(struct rtsx_ucr *ucr, int card);
 92
 93/* card status */
 94#define SD_CD		0x01
 95#define MS_CD		0x02
 96#define XD_CD		0x04
 97#define CD_MASK		(SD_CD | MS_CD | XD_CD)
 98#define SD_WP		0x08
 99
100/* reader command field offset & parameters */
101#define READ_REG_CMD		0
102#define WRITE_REG_CMD		1
103#define CHECK_REG_CMD		2
104
105#define PACKET_TYPE		4
106#define CNT_H			5
107#define CNT_L			6
108#define STAGE_FLAG		7
109#define CMD_OFFSET		8
110#define SEQ_WRITE_DATA_OFFSET	12
111
112#define BATCH_CMD		0
113#define SEQ_READ		1
114#define SEQ_WRITE		2
115
116#define STAGE_R			0x01
117#define STAGE_DI		0x02
118#define STAGE_DO		0x04
119#define STAGE_MS_STATUS		0x08
120#define STAGE_XD_STATUS		0x10
121#define MODE_C			0x00
122#define MODE_CR			(STAGE_R)
123#define MODE_CDIR		(STAGE_R | STAGE_DI)
124#define MODE_CDOR		(STAGE_R | STAGE_DO)
125
126#define EP0_OP_SHIFT		14
127#define EP0_READ_REG_CMD	2
128#define EP0_WRITE_REG_CMD	3
129
130#define rtsx_usb_cmd_hdr_tag(ucr)		\
131	do {					\
132		ucr->cmd_buf[0] = 'R';		\
133		ucr->cmd_buf[1] = 'T';		\
134		ucr->cmd_buf[2] = 'C';		\
135		ucr->cmd_buf[3] = 'R';		\
136	} while (0)
137
138static inline void rtsx_usb_init_cmd(struct rtsx_ucr *ucr)
139{
140	rtsx_usb_cmd_hdr_tag(ucr);
141	ucr->cmd_idx = 0;
142	ucr->cmd_buf[PACKET_TYPE] = BATCH_CMD;
143}
144
145/* internal register address */
146#define FPDCTL				0xFC00
147#define SSC_DIV_N_0			0xFC07
148#define SSC_CTL1			0xFC09
149#define SSC_CTL2			0xFC0A
150#define CFG_MODE			0xFC0E
151#define CFG_MODE_1			0xFC0F
152#define RCCTL				0xFC14
153#define SOF_WDOG			0xFC28
154#define SYS_DUMMY0			0xFC30
155
156#define MS_BLKEND			0xFD30
157#define MS_READ_START			0xFD31
158#define MS_READ_COUNT			0xFD32
159#define MS_WRITE_START			0xFD33
160#define MS_WRITE_COUNT			0xFD34
161#define MS_COMMAND			0xFD35
162#define MS_OLD_BLOCK_0			0xFD36
163#define MS_OLD_BLOCK_1			0xFD37
164#define MS_NEW_BLOCK_0			0xFD38
165#define MS_NEW_BLOCK_1			0xFD39
166#define MS_LOG_BLOCK_0			0xFD3A
167#define MS_LOG_BLOCK_1			0xFD3B
168#define MS_BUS_WIDTH			0xFD3C
169#define MS_PAGE_START			0xFD3D
170#define MS_PAGE_LENGTH			0xFD3E
171#define MS_CFG				0xFD40
172#define MS_TPC				0xFD41
173#define MS_TRANS_CFG			0xFD42
174#define MS_TRANSFER			0xFD43
175#define MS_INT_REG			0xFD44
176#define MS_BYTE_CNT			0xFD45
177#define MS_SECTOR_CNT_L			0xFD46
178#define MS_SECTOR_CNT_H			0xFD47
179#define MS_DBUS_H			0xFD48
180
181#define CARD_DMA1_CTL			0xFD5C
182#define CARD_PULL_CTL1			0xFD60
183#define CARD_PULL_CTL2			0xFD61
184#define CARD_PULL_CTL3			0xFD62
185#define CARD_PULL_CTL4			0xFD63
186#define CARD_PULL_CTL5			0xFD64
187#define CARD_PULL_CTL6			0xFD65
188#define CARD_EXIST			0xFD6F
189#define CARD_INT_PEND			0xFD71
190
191#define LDO_POWER_CFG			0xFD7B
192
193#define SD_CFG1				0xFDA0
194#define SD_CFG2				0xFDA1
195#define SD_CFG3				0xFDA2
196#define SD_STAT1			0xFDA3
197#define SD_STAT2			0xFDA4
198#define SD_BUS_STAT			0xFDA5
199#define SD_PAD_CTL			0xFDA6
200#define SD_SAMPLE_POINT_CTL		0xFDA7
201#define SD_PUSH_POINT_CTL		0xFDA8
202#define SD_CMD0				0xFDA9
203#define SD_CMD1				0xFDAA
204#define SD_CMD2				0xFDAB
205#define SD_CMD3				0xFDAC
206#define SD_CMD4				0xFDAD
207#define SD_CMD5				0xFDAE
208#define SD_BYTE_CNT_L			0xFDAF
209#define SD_BYTE_CNT_H			0xFDB0
210#define SD_BLOCK_CNT_L			0xFDB1
211#define SD_BLOCK_CNT_H			0xFDB2
212#define SD_TRANSFER			0xFDB3
213#define SD_CMD_STATE			0xFDB5
214#define SD_DATA_STATE			0xFDB6
215#define SD_VPCLK0_CTL			0xFC2A
216#define SD_VPCLK1_CTL			0xFC2B
217#define SD_DCMPS0_CTL			0xFC2C
218#define SD_DCMPS1_CTL			0xFC2D
219
220#define CARD_DMA1_CTL			0xFD5C
221
222#define HW_VERSION			0xFC01
223
224#define SSC_CLK_FPGA_SEL		0xFC02
225#define CLK_DIV				0xFC03
226#define SFSM_ED				0xFC04
227
228#define CD_DEGLITCH_WIDTH		0xFC20
229#define CD_DEGLITCH_EN			0xFC21
230#define AUTO_DELINK_EN			0xFC23
231
232#define FPGA_PULL_CTL			0xFC1D
233#define CARD_CLK_SOURCE			0xFC2E
234
235#define CARD_SHARE_MODE			0xFD51
236#define CARD_DRIVE_SEL			0xFD52
237#define CARD_STOP			0xFD53
238#define CARD_OE				0xFD54
239#define CARD_AUTO_BLINK			0xFD55
240#define CARD_GPIO			0xFD56
241#define SD30_DRIVE_SEL			0xFD57
242
243#define CARD_DATA_SOURCE		0xFD5D
244#define CARD_SELECT			0xFD5E
245
246#define CARD_CLK_EN			0xFD79
247#define CARD_PWR_CTL			0xFD7A
248
249#define OCPCTL				0xFD80
250#define OCPPARA1			0xFD81
251#define OCPPARA2			0xFD82
252#define OCPSTAT				0xFD83
253
254#define HS_USB_STAT			0xFE01
255#define HS_VCONTROL			0xFE26
256#define HS_VSTAIN			0xFE27
257#define HS_VLOADM			0xFE28
258#define HS_VSTAOUT			0xFE29
259
260#define MC_IRQ				0xFF00
261#define MC_IRQEN			0xFF01
262#define MC_FIFO_CTL			0xFF02
263#define MC_FIFO_BC0			0xFF03
264#define MC_FIFO_BC1			0xFF04
265#define MC_FIFO_STAT			0xFF05
266#define MC_FIFO_MODE			0xFF06
267#define MC_FIFO_RD_PTR0			0xFF07
268#define MC_FIFO_RD_PTR1			0xFF08
269#define MC_DMA_CTL			0xFF10
270#define MC_DMA_TC0			0xFF11
271#define MC_DMA_TC1			0xFF12
272#define MC_DMA_TC2			0xFF13
273#define MC_DMA_TC3			0xFF14
274#define MC_DMA_RST			0xFF15
275
276#define RBUF_SIZE_MASK			0xFBFF
277#define RBUF_BASE			0xF000
278#define PPBUF_BASE1			0xF800
279#define PPBUF_BASE2			0xFA00
280
281/* internal register value macros */
282#define POWER_OFF			0x03
283#define PARTIAL_POWER_ON		0x02
284#define POWER_ON			0x00
285#define POWER_MASK			0x03
286#define LDO3318_PWR_MASK		0x0C
287#define LDO_ON				0x00
288#define LDO_SUSPEND			0x08
289#define LDO_OFF				0x0C
290#define DV3318_AUTO_PWR_OFF		0x10
291#define FORCE_LDO_POWERB		0x60
292
293/* LDO_POWER_CFG */
294#define TUNE_SD18_MASK			0x1C
295#define TUNE_SD18_1V7			0x00
296#define TUNE_SD18_1V8			(0x01 << 2)
297#define TUNE_SD18_1V9			(0x02 << 2)
298#define TUNE_SD18_2V0			(0x03 << 2)
299#define TUNE_SD18_2V7			(0x04 << 2)
300#define TUNE_SD18_2V8			(0x05 << 2)
301#define TUNE_SD18_2V9			(0x06 << 2)
302#define TUNE_SD18_3V3			(0x07 << 2)
303
304/* CLK_DIV */
305#define CLK_CHANGE			0x80
306#define CLK_DIV_1			0x00
307#define CLK_DIV_2			0x01
308#define CLK_DIV_4			0x02
309#define CLK_DIV_8			0x03
310
311#define SSC_POWER_MASK			0x01
312#define SSC_POWER_DOWN			0x01
313#define SSC_POWER_ON			0x00
314
315#define FPGA_VER			0x80
316#define HW_VER_MASK			0x0F
317
318#define EXTEND_DMA1_ASYNC_SIGNAL	0x02
319
320/* CFG_MODE*/
321#define XTAL_FREE			0x80
322#define CLK_MODE_MASK			0x03
323#define CLK_MODE_12M_XTAL		0x00
324#define CLK_MODE_NON_XTAL		0x01
325#define CLK_MODE_24M_OSC		0x02
326#define CLK_MODE_48M_OSC		0x03
327
328/* CFG_MODE_1*/
329#define RTS5179				0x02
330
331#define NYET_EN				0x01
332#define NYET_MSAK			0x01
333
334#define SD30_DRIVE_MASK			0x07
335#define SD20_DRIVE_MASK			0x03
336
337#define DISABLE_SD_CD			0x08
338#define DISABLE_MS_CD			0x10
339#define DISABLE_XD_CD			0x20
340#define SD_CD_DEGLITCH_EN		0x01
341#define MS_CD_DEGLITCH_EN		0x02
342#define XD_CD_DEGLITCH_EN		0x04
343
344#define	CARD_SHARE_LQFP48		0x04
345#define	CARD_SHARE_QFN24		0x00
346#define CARD_SHARE_LQFP_SEL		0x04
347#define	CARD_SHARE_XD			0x00
348#define	CARD_SHARE_SD			0x01
349#define	CARD_SHARE_MS			0x02
350#define CARD_SHARE_MASK			0x03
351
352
353/* SD30_DRIVE_SEL */
354#define DRIVER_TYPE_A			0x05
355#define DRIVER_TYPE_B			0x03
356#define DRIVER_TYPE_C			0x02
357#define DRIVER_TYPE_D			0x01
358
359/* SD_BUS_STAT */
360#define	SD_CLK_TOGGLE_EN		0x80
361#define	SD_CLK_FORCE_STOP	        0x40
362#define	SD_DAT3_STATUS		        0x10
363#define	SD_DAT2_STATUS		        0x08
364#define	SD_DAT1_STATUS		        0x04
365#define	SD_DAT0_STATUS		        0x02
366#define	SD_CMD_STATUS			0x01
367
368/* SD_PAD_CTL */
369#define	SD_IO_USING_1V8		        0x80
370#define	SD_IO_USING_3V3		        0x7F
371#define	TYPE_A_DRIVING		        0x00
372#define	TYPE_B_DRIVING			0x01
373#define	TYPE_C_DRIVING			0x02
374#define	TYPE_D_DRIVING		        0x03
375
376/* CARD_CLK_EN */
377#define SD_CLK_EN			0x04
378#define MS_CLK_EN			0x08
379
380/* CARD_SELECT */
381#define SD_MOD_SEL			2
382#define MS_MOD_SEL			3
383
384/* CARD_SHARE_MODE */
385#define	CARD_SHARE_LQFP48		0x04
386#define	CARD_SHARE_QFN24		0x00
387#define CARD_SHARE_LQFP_SEL		0x04
388#define	CARD_SHARE_XD			0x00
389#define	CARD_SHARE_SD			0x01
390#define	CARD_SHARE_MS			0x02
391#define CARD_SHARE_MASK			0x03
392
393/* SSC_CTL1 */
394#define SSC_RSTB			0x80
395#define SSC_8X_EN			0x40
396#define SSC_FIX_FRAC			0x20
397#define SSC_SEL_1M			0x00
398#define SSC_SEL_2M			0x08
399#define SSC_SEL_4M			0x10
400#define SSC_SEL_8M			0x18
401
402/* SSC_CTL2 */
403#define SSC_DEPTH_MASK			0x03
404#define SSC_DEPTH_DISALBE		0x00
405#define SSC_DEPTH_2M			0x01
406#define SSC_DEPTH_1M			0x02
407#define SSC_DEPTH_512K			0x03
408
409/* SD_VPCLK0_CTL */
410#define PHASE_CHANGE			0x80
411#define PHASE_NOT_RESET			0x40
412
413/* SD_TRANSFER */
414#define	SD_TRANSFER_START		0x80
415#define	SD_TRANSFER_END			0x40
416#define SD_STAT_IDLE			0x20
417#define	SD_TRANSFER_ERR			0x10
418#define	SD_TM_NORMAL_WRITE		0x00
419#define	SD_TM_AUTO_WRITE_3		0x01
420#define	SD_TM_AUTO_WRITE_4		0x02
421#define	SD_TM_AUTO_READ_3		0x05
422#define	SD_TM_AUTO_READ_4		0x06
423#define	SD_TM_CMD_RSP			0x08
424#define	SD_TM_AUTO_WRITE_1		0x09
425#define	SD_TM_AUTO_WRITE_2		0x0A
426#define	SD_TM_NORMAL_READ		0x0C
427#define	SD_TM_AUTO_READ_1		0x0D
428#define	SD_TM_AUTO_READ_2		0x0E
429#define	SD_TM_AUTO_TUNING		0x0F
430
431/* SD_CFG1 */
432#define SD_CLK_DIVIDE_0			0x00
433#define	SD_CLK_DIVIDE_256		0xC0
434#define	SD_CLK_DIVIDE_128		0x80
435#define SD_CLK_DIVIDE_MASK		0xC0
436#define	SD_BUS_WIDTH_1BIT		0x00
437#define	SD_BUS_WIDTH_4BIT		0x01
438#define	SD_BUS_WIDTH_8BIT		0x02
439#define	SD_ASYNC_FIFO_RST		0x10
440#define	SD_20_MODE			0x00
441#define	SD_DDR_MODE			0x04
442#define	SD_30_MODE			0x08
443
444/* SD_CFG2 */
445#define	SD_CALCULATE_CRC7		0x00
446#define	SD_NO_CALCULATE_CRC7		0x80
447#define	SD_CHECK_CRC16			0x00
448#define	SD_NO_CHECK_CRC16		0x40
449#define SD_WAIT_CRC_TO_EN		0x20
450#define	SD_WAIT_BUSY_END		0x08
451#define	SD_NO_WAIT_BUSY_END		0x00
452#define	SD_CHECK_CRC7			0x00
453#define	SD_NO_CHECK_CRC7		0x04
454#define	SD_RSP_LEN_0			0x00
455#define	SD_RSP_LEN_6			0x01
456#define	SD_RSP_LEN_17			0x02
457#define	SD_RSP_TYPE_R0			0x04
458#define	SD_RSP_TYPE_R1			0x01
459#define	SD_RSP_TYPE_R1b			0x09
460#define	SD_RSP_TYPE_R2			0x02
461#define	SD_RSP_TYPE_R3			0x05
462#define	SD_RSP_TYPE_R4			0x05
463#define	SD_RSP_TYPE_R5			0x01
464#define	SD_RSP_TYPE_R6			0x01
465#define	SD_RSP_TYPE_R7			0x01
466
467/* SD_STAT1 */
468#define	SD_CRC7_ERR			0x80
469#define	SD_CRC16_ERR			0x40
470#define	SD_CRC_WRITE_ERR		0x20
471#define	SD_CRC_WRITE_ERR_MASK		0x1C
472#define	GET_CRC_TIME_OUT		0x02
473#define	SD_TUNING_COMPARE_ERR		0x01
474
475/* SD_DATA_STATE */
476#define SD_DATA_IDLE			0x80
477
478/* CARD_DATA_SOURCE */
479#define PINGPONG_BUFFER			0x01
480#define RING_BUFFER			0x00
481
482/* CARD_OE */
483#define SD_OUTPUT_EN			0x04
484#define MS_OUTPUT_EN			0x08
485
486/* CARD_STOP */
487#define SD_STOP				0x04
488#define MS_STOP				0x08
489#define SD_CLR_ERR			0x40
490#define MS_CLR_ERR			0x80
491
492/* CARD_CLK_SOURCE */
493#define CRC_FIX_CLK			(0x00 << 0)
494#define CRC_VAR_CLK0			(0x01 << 0)
495#define CRC_VAR_CLK1			(0x02 << 0)
496#define SD30_FIX_CLK			(0x00 << 2)
497#define SD30_VAR_CLK0			(0x01 << 2)
498#define SD30_VAR_CLK1			(0x02 << 2)
499#define SAMPLE_FIX_CLK			(0x00 << 4)
500#define SAMPLE_VAR_CLK0			(0x01 << 4)
501#define SAMPLE_VAR_CLK1			(0x02 << 4)
502
503/* SD_SAMPLE_POINT_CTL */
504#define	DDR_FIX_RX_DAT			0x00
505#define	DDR_VAR_RX_DAT			0x80
506#define	DDR_FIX_RX_DAT_EDGE		0x00
507#define	DDR_FIX_RX_DAT_14_DELAY		0x40
508#define	DDR_FIX_RX_CMD			0x00
509#define	DDR_VAR_RX_CMD			0x20
510#define	DDR_FIX_RX_CMD_POS_EDGE		0x00
511#define	DDR_FIX_RX_CMD_14_DELAY		0x10
512#define	SD20_RX_POS_EDGE		0x00
513#define	SD20_RX_14_DELAY		0x08
514#define SD20_RX_SEL_MASK		0x08
515
516/* SD_PUSH_POINT_CTL */
517#define	DDR_FIX_TX_CMD_DAT		0x00
518#define	DDR_VAR_TX_CMD_DAT		0x80
519#define	DDR_FIX_TX_DAT_14_TSU		0x00
520#define	DDR_FIX_TX_DAT_12_TSU		0x40
521#define	DDR_FIX_TX_CMD_NEG_EDGE		0x00
522#define	DDR_FIX_TX_CMD_14_AHEAD		0x20
523#define	SD20_TX_NEG_EDGE		0x00
524#define	SD20_TX_14_AHEAD		0x10
525#define SD20_TX_SEL_MASK		0x10
526#define	DDR_VAR_SDCLK_POL_SWAP		0x01
527
528/* MS_CFG */
529#define	SAMPLE_TIME_RISING		0x00
530#define	SAMPLE_TIME_FALLING		0x80
531#define	PUSH_TIME_DEFAULT		0x00
532#define	PUSH_TIME_ODD			0x40
533#define	NO_EXTEND_TOGGLE		0x00
534#define	EXTEND_TOGGLE_CHK		0x20
535#define	MS_BUS_WIDTH_1			0x00
536#define	MS_BUS_WIDTH_4			0x10
537#define	MS_BUS_WIDTH_8			0x18
538#define	MS_2K_SECTOR_MODE		0x04
539#define	MS_512_SECTOR_MODE		0x00
540#define	MS_TOGGLE_TIMEOUT_EN		0x00
541#define	MS_TOGGLE_TIMEOUT_DISEN		0x01
542#define MS_NO_CHECK_INT			0x02
543
544/* MS_TRANS_CFG */
545#define	WAIT_INT			0x80
546#define	NO_WAIT_INT			0x00
547#define	NO_AUTO_READ_INT_REG		0x00
548#define	AUTO_READ_INT_REG		0x40
549#define	MS_CRC16_ERR			0x20
550#define	MS_RDY_TIMEOUT			0x10
551#define	MS_INT_CMDNK			0x08
552#define	MS_INT_BREQ			0x04
553#define	MS_INT_ERR			0x02
554#define	MS_INT_CED			0x01
555
556/* MS_TRANSFER */
557#define	MS_TRANSFER_START		0x80
558#define	MS_TRANSFER_END			0x40
559#define	MS_TRANSFER_ERR			0x20
560#define	MS_BS_STATE			0x10
561#define	MS_TM_READ_BYTES		0x00
562#define	MS_TM_NORMAL_READ		0x01
563#define	MS_TM_WRITE_BYTES		0x04
564#define	MS_TM_NORMAL_WRITE		0x05
565#define	MS_TM_AUTO_READ			0x08
566#define	MS_TM_AUTO_WRITE		0x0C
567#define MS_TM_SET_CMD			0x06
568#define MS_TM_COPY_PAGE			0x07
569#define MS_TM_MULTI_READ		0x02
570#define MS_TM_MULTI_WRITE		0x03
571
572/* MC_FIFO_CTL */
573#define FIFO_FLUSH			0x01
574
575/* MC_DMA_RST */
576#define DMA_RESET  0x01
577
578/* MC_DMA_CTL */
579#define DMA_TC_EQ_0			0x80
580#define DMA_DIR_TO_CARD			0x00
581#define DMA_DIR_FROM_CARD		0x02
582#define DMA_EN				0x01
583#define DMA_128				(0 << 2)
584#define DMA_256				(1 << 2)
585#define DMA_512				(2 << 2)
586#define DMA_1024			(3 << 2)
587#define DMA_PACK_SIZE_MASK		0x0C
588
589/* CARD_INT_PEND */
590#define XD_INT				0x10
591#define MS_INT				0x08
592#define SD_INT				0x04
593
594/* LED operations*/
595static inline int rtsx_usb_turn_on_led(struct rtsx_ucr *ucr)
596{
597	return  rtsx_usb_ep0_write_register(ucr, CARD_GPIO, 0x03, 0x02);
598}
599
600static inline int rtsx_usb_turn_off_led(struct rtsx_ucr *ucr)
601{
602	return rtsx_usb_ep0_write_register(ucr, CARD_GPIO, 0x03, 0x03);
603}
604
605/* HW error clearing */
606static inline void rtsx_usb_clear_fsm_err(struct rtsx_ucr *ucr)
607{
608	rtsx_usb_ep0_write_register(ucr, SFSM_ED, 0xf8, 0xf8);
609}
610
611static inline void rtsx_usb_clear_dma_err(struct rtsx_ucr *ucr)
612{
613	rtsx_usb_ep0_write_register(ucr, MC_FIFO_CTL,
614			FIFO_FLUSH, FIFO_FLUSH);
615	rtsx_usb_ep0_write_register(ucr, MC_DMA_RST, DMA_RESET, DMA_RESET);
616}
617#endif /* __RTS51139_H */
v5.4
  1/* SPDX-License-Identifier: GPL-2.0-only */
  2/* Driver for Realtek RTS5139 USB card reader
  3 *
  4 * Copyright(c) 2009-2013 Realtek Semiconductor Corp. All rights reserved.
  5 *
  6 * Author:
  7 *   Roger Tseng <rogerable@realtek.com>
  8 */
  9
 10#ifndef __RTSX_USB_H
 11#define __RTSX_USB_H
 12
 13#include <linux/usb.h>
 14
 15/* related module names */
 16#define RTSX_USB_SD_CARD	0
 17#define RTSX_USB_MS_CARD	1
 18
 19/* endpoint numbers */
 20#define EP_BULK_OUT		1
 21#define EP_BULK_IN		2
 22#define EP_INTR_IN		3
 23
 24/* USB vendor requests */
 25#define RTSX_USB_REQ_REG_OP	0x00
 26#define RTSX_USB_REQ_POLL	0x02
 27
 28/* miscellaneous parameters */
 29#define MIN_DIV_N		60
 30#define MAX_DIV_N		120
 31
 32#define MAX_PHASE		15
 33#define RX_TUNING_CNT		3
 34
 35#define QFN24			0
 36#define LQFP48			1
 37#define CHECK_PKG(ucr, pkg)	((ucr)->package == (pkg))
 38
 39/* data structures */
 40struct rtsx_ucr {
 41	u16			vendor_id;
 42	u16			product_id;
 43
 44	int			package;
 45	u8			ic_version;
 46	bool			is_rts5179;
 47
 48	unsigned int		cur_clk;
 49
 50	u8			*cmd_buf;
 51	unsigned int		cmd_idx;
 52	u8			*rsp_buf;
 53
 54	struct usb_device	*pusb_dev;
 55	struct usb_interface	*pusb_intf;
 56	struct usb_sg_request	current_sg;
 57	unsigned char		*iobuf;
 58	dma_addr_t		iobuf_dma;
 59
 60	struct timer_list	sg_timer;
 61	struct mutex		dev_mutex;
 62};
 63
 64/* buffer size */
 65#define IOBUF_SIZE		1024
 66
 67/* prototypes of exported functions */
 68extern int rtsx_usb_get_card_status(struct rtsx_ucr *ucr, u16 *status);
 69
 70extern int rtsx_usb_read_register(struct rtsx_ucr *ucr, u16 addr, u8 *data);
 71extern int rtsx_usb_write_register(struct rtsx_ucr *ucr, u16 addr, u8 mask,
 72		u8 data);
 73
 74extern int rtsx_usb_ep0_write_register(struct rtsx_ucr *ucr, u16 addr, u8 mask,
 75		u8 data);
 76extern int rtsx_usb_ep0_read_register(struct rtsx_ucr *ucr, u16 addr,
 77		u8 *data);
 78
 79extern void rtsx_usb_add_cmd(struct rtsx_ucr *ucr, u8 cmd_type,
 80		u16 reg_addr, u8 mask, u8 data);
 81extern int rtsx_usb_send_cmd(struct rtsx_ucr *ucr, u8 flag, int timeout);
 82extern int rtsx_usb_get_rsp(struct rtsx_ucr *ucr, int rsp_len, int timeout);
 83extern int rtsx_usb_transfer_data(struct rtsx_ucr *ucr, unsigned int pipe,
 84			      void *buf, unsigned int len, int use_sg,
 85			      unsigned int *act_len, int timeout);
 86
 87extern int rtsx_usb_read_ppbuf(struct rtsx_ucr *ucr, u8 *buf, int buf_len);
 88extern int rtsx_usb_write_ppbuf(struct rtsx_ucr *ucr, u8 *buf, int buf_len);
 89extern int rtsx_usb_switch_clock(struct rtsx_ucr *ucr, unsigned int card_clock,
 90		u8 ssc_depth, bool initial_mode, bool double_clk, bool vpclk);
 91extern int rtsx_usb_card_exclusive_check(struct rtsx_ucr *ucr, int card);
 92
 93/* card status */
 94#define SD_CD		0x01
 95#define MS_CD		0x02
 96#define XD_CD		0x04
 97#define CD_MASK		(SD_CD | MS_CD | XD_CD)
 98#define SD_WP		0x08
 99
100/* reader command field offset & parameters */
101#define READ_REG_CMD		0
102#define WRITE_REG_CMD		1
103#define CHECK_REG_CMD		2
104
105#define PACKET_TYPE		4
106#define CNT_H			5
107#define CNT_L			6
108#define STAGE_FLAG		7
109#define CMD_OFFSET		8
110#define SEQ_WRITE_DATA_OFFSET	12
111
112#define BATCH_CMD		0
113#define SEQ_READ		1
114#define SEQ_WRITE		2
115
116#define STAGE_R			0x01
117#define STAGE_DI		0x02
118#define STAGE_DO		0x04
119#define STAGE_MS_STATUS		0x08
120#define STAGE_XD_STATUS		0x10
121#define MODE_C			0x00
122#define MODE_CR			(STAGE_R)
123#define MODE_CDIR		(STAGE_R | STAGE_DI)
124#define MODE_CDOR		(STAGE_R | STAGE_DO)
125
126#define EP0_OP_SHIFT		14
127#define EP0_READ_REG_CMD	2
128#define EP0_WRITE_REG_CMD	3
129
130#define rtsx_usb_cmd_hdr_tag(ucr)		\
131	do {					\
132		ucr->cmd_buf[0] = 'R';		\
133		ucr->cmd_buf[1] = 'T';		\
134		ucr->cmd_buf[2] = 'C';		\
135		ucr->cmd_buf[3] = 'R';		\
136	} while (0)
137
138static inline void rtsx_usb_init_cmd(struct rtsx_ucr *ucr)
139{
140	rtsx_usb_cmd_hdr_tag(ucr);
141	ucr->cmd_idx = 0;
142	ucr->cmd_buf[PACKET_TYPE] = BATCH_CMD;
143}
144
145/* internal register address */
146#define FPDCTL				0xFC00
147#define SSC_DIV_N_0			0xFC07
148#define SSC_CTL1			0xFC09
149#define SSC_CTL2			0xFC0A
150#define CFG_MODE			0xFC0E
151#define CFG_MODE_1			0xFC0F
152#define RCCTL				0xFC14
153#define SOF_WDOG			0xFC28
154#define SYS_DUMMY0			0xFC30
155
156#define MS_BLKEND			0xFD30
157#define MS_READ_START			0xFD31
158#define MS_READ_COUNT			0xFD32
159#define MS_WRITE_START			0xFD33
160#define MS_WRITE_COUNT			0xFD34
161#define MS_COMMAND			0xFD35
162#define MS_OLD_BLOCK_0			0xFD36
163#define MS_OLD_BLOCK_1			0xFD37
164#define MS_NEW_BLOCK_0			0xFD38
165#define MS_NEW_BLOCK_1			0xFD39
166#define MS_LOG_BLOCK_0			0xFD3A
167#define MS_LOG_BLOCK_1			0xFD3B
168#define MS_BUS_WIDTH			0xFD3C
169#define MS_PAGE_START			0xFD3D
170#define MS_PAGE_LENGTH			0xFD3E
171#define MS_CFG				0xFD40
172#define MS_TPC				0xFD41
173#define MS_TRANS_CFG			0xFD42
174#define MS_TRANSFER			0xFD43
175#define MS_INT_REG			0xFD44
176#define MS_BYTE_CNT			0xFD45
177#define MS_SECTOR_CNT_L			0xFD46
178#define MS_SECTOR_CNT_H			0xFD47
179#define MS_DBUS_H			0xFD48
180
181#define CARD_DMA1_CTL			0xFD5C
182#define CARD_PULL_CTL1			0xFD60
183#define CARD_PULL_CTL2			0xFD61
184#define CARD_PULL_CTL3			0xFD62
185#define CARD_PULL_CTL4			0xFD63
186#define CARD_PULL_CTL5			0xFD64
187#define CARD_PULL_CTL6			0xFD65
188#define CARD_EXIST			0xFD6F
189#define CARD_INT_PEND			0xFD71
190
191#define LDO_POWER_CFG			0xFD7B
192
193#define SD_CFG1				0xFDA0
194#define SD_CFG2				0xFDA1
195#define SD_CFG3				0xFDA2
196#define SD_STAT1			0xFDA3
197#define SD_STAT2			0xFDA4
198#define SD_BUS_STAT			0xFDA5
199#define SD_PAD_CTL			0xFDA6
200#define SD_SAMPLE_POINT_CTL		0xFDA7
201#define SD_PUSH_POINT_CTL		0xFDA8
202#define SD_CMD0				0xFDA9
203#define SD_CMD1				0xFDAA
204#define SD_CMD2				0xFDAB
205#define SD_CMD3				0xFDAC
206#define SD_CMD4				0xFDAD
207#define SD_CMD5				0xFDAE
208#define SD_BYTE_CNT_L			0xFDAF
209#define SD_BYTE_CNT_H			0xFDB0
210#define SD_BLOCK_CNT_L			0xFDB1
211#define SD_BLOCK_CNT_H			0xFDB2
212#define SD_TRANSFER			0xFDB3
213#define SD_CMD_STATE			0xFDB5
214#define SD_DATA_STATE			0xFDB6
215#define SD_VPCLK0_CTL			0xFC2A
216#define SD_VPCLK1_CTL			0xFC2B
217#define SD_DCMPS0_CTL			0xFC2C
218#define SD_DCMPS1_CTL			0xFC2D
219
220#define CARD_DMA1_CTL			0xFD5C
221
222#define HW_VERSION			0xFC01
223
224#define SSC_CLK_FPGA_SEL		0xFC02
225#define CLK_DIV				0xFC03
226#define SFSM_ED				0xFC04
227
228#define CD_DEGLITCH_WIDTH		0xFC20
229#define CD_DEGLITCH_EN			0xFC21
230#define AUTO_DELINK_EN			0xFC23
231
232#define FPGA_PULL_CTL			0xFC1D
233#define CARD_CLK_SOURCE			0xFC2E
234
235#define CARD_SHARE_MODE			0xFD51
236#define CARD_DRIVE_SEL			0xFD52
237#define CARD_STOP			0xFD53
238#define CARD_OE				0xFD54
239#define CARD_AUTO_BLINK			0xFD55
240#define CARD_GPIO			0xFD56
241#define SD30_DRIVE_SEL			0xFD57
242
243#define CARD_DATA_SOURCE		0xFD5D
244#define CARD_SELECT			0xFD5E
245
246#define CARD_CLK_EN			0xFD79
247#define CARD_PWR_CTL			0xFD7A
248
249#define OCPCTL				0xFD80
250#define OCPPARA1			0xFD81
251#define OCPPARA2			0xFD82
252#define OCPSTAT				0xFD83
253
254#define HS_USB_STAT			0xFE01
255#define HS_VCONTROL			0xFE26
256#define HS_VSTAIN			0xFE27
257#define HS_VLOADM			0xFE28
258#define HS_VSTAOUT			0xFE29
259
260#define MC_IRQ				0xFF00
261#define MC_IRQEN			0xFF01
262#define MC_FIFO_CTL			0xFF02
263#define MC_FIFO_BC0			0xFF03
264#define MC_FIFO_BC1			0xFF04
265#define MC_FIFO_STAT			0xFF05
266#define MC_FIFO_MODE			0xFF06
267#define MC_FIFO_RD_PTR0			0xFF07
268#define MC_FIFO_RD_PTR1			0xFF08
269#define MC_DMA_CTL			0xFF10
270#define MC_DMA_TC0			0xFF11
271#define MC_DMA_TC1			0xFF12
272#define MC_DMA_TC2			0xFF13
273#define MC_DMA_TC3			0xFF14
274#define MC_DMA_RST			0xFF15
275
276#define RBUF_SIZE_MASK			0xFBFF
277#define RBUF_BASE			0xF000
278#define PPBUF_BASE1			0xF800
279#define PPBUF_BASE2			0xFA00
280
281/* internal register value macros */
282#define POWER_OFF			0x03
283#define PARTIAL_POWER_ON		0x02
284#define POWER_ON			0x00
285#define POWER_MASK			0x03
286#define LDO3318_PWR_MASK		0x0C
287#define LDO_ON				0x00
288#define LDO_SUSPEND			0x08
289#define LDO_OFF				0x0C
290#define DV3318_AUTO_PWR_OFF		0x10
291#define FORCE_LDO_POWERB		0x60
292
293/* LDO_POWER_CFG */
294#define TUNE_SD18_MASK			0x1C
295#define TUNE_SD18_1V7			0x00
296#define TUNE_SD18_1V8			(0x01 << 2)
297#define TUNE_SD18_1V9			(0x02 << 2)
298#define TUNE_SD18_2V0			(0x03 << 2)
299#define TUNE_SD18_2V7			(0x04 << 2)
300#define TUNE_SD18_2V8			(0x05 << 2)
301#define TUNE_SD18_2V9			(0x06 << 2)
302#define TUNE_SD18_3V3			(0x07 << 2)
303
304/* CLK_DIV */
305#define CLK_CHANGE			0x80
306#define CLK_DIV_1			0x00
307#define CLK_DIV_2			0x01
308#define CLK_DIV_4			0x02
309#define CLK_DIV_8			0x03
310
311#define SSC_POWER_MASK			0x01
312#define SSC_POWER_DOWN			0x01
313#define SSC_POWER_ON			0x00
314
315#define FPGA_VER			0x80
316#define HW_VER_MASK			0x0F
317
318#define EXTEND_DMA1_ASYNC_SIGNAL	0x02
319
320/* CFG_MODE*/
321#define XTAL_FREE			0x80
322#define CLK_MODE_MASK			0x03
323#define CLK_MODE_12M_XTAL		0x00
324#define CLK_MODE_NON_XTAL		0x01
325#define CLK_MODE_24M_OSC		0x02
326#define CLK_MODE_48M_OSC		0x03
327
328/* CFG_MODE_1*/
329#define RTS5179				0x02
330
331#define NYET_EN				0x01
332#define NYET_MSAK			0x01
333
334#define SD30_DRIVE_MASK			0x07
335#define SD20_DRIVE_MASK			0x03
336
337#define DISABLE_SD_CD			0x08
338#define DISABLE_MS_CD			0x10
339#define DISABLE_XD_CD			0x20
340#define SD_CD_DEGLITCH_EN		0x01
341#define MS_CD_DEGLITCH_EN		0x02
342#define XD_CD_DEGLITCH_EN		0x04
343
344#define	CARD_SHARE_LQFP48		0x04
345#define	CARD_SHARE_QFN24		0x00
346#define CARD_SHARE_LQFP_SEL		0x04
347#define	CARD_SHARE_XD			0x00
348#define	CARD_SHARE_SD			0x01
349#define	CARD_SHARE_MS			0x02
350#define CARD_SHARE_MASK			0x03
351
352
353/* SD30_DRIVE_SEL */
354#define DRIVER_TYPE_A			0x05
355#define DRIVER_TYPE_B			0x03
356#define DRIVER_TYPE_C			0x02
357#define DRIVER_TYPE_D			0x01
358
359/* SD_BUS_STAT */
360#define	SD_CLK_TOGGLE_EN		0x80
361#define	SD_CLK_FORCE_STOP	        0x40
362#define	SD_DAT3_STATUS		        0x10
363#define	SD_DAT2_STATUS		        0x08
364#define	SD_DAT1_STATUS		        0x04
365#define	SD_DAT0_STATUS		        0x02
366#define	SD_CMD_STATUS			0x01
367
368/* SD_PAD_CTL */
369#define	SD_IO_USING_1V8		        0x80
370#define	SD_IO_USING_3V3		        0x7F
371#define	TYPE_A_DRIVING		        0x00
372#define	TYPE_B_DRIVING			0x01
373#define	TYPE_C_DRIVING			0x02
374#define	TYPE_D_DRIVING		        0x03
375
376/* CARD_CLK_EN */
377#define SD_CLK_EN			0x04
378#define MS_CLK_EN			0x08
379
380/* CARD_SELECT */
381#define SD_MOD_SEL			2
382#define MS_MOD_SEL			3
383
384/* CARD_SHARE_MODE */
385#define	CARD_SHARE_LQFP48		0x04
386#define	CARD_SHARE_QFN24		0x00
387#define CARD_SHARE_LQFP_SEL		0x04
388#define	CARD_SHARE_XD			0x00
389#define	CARD_SHARE_SD			0x01
390#define	CARD_SHARE_MS			0x02
391#define CARD_SHARE_MASK			0x03
392
393/* SSC_CTL1 */
394#define SSC_RSTB			0x80
395#define SSC_8X_EN			0x40
396#define SSC_FIX_FRAC			0x20
397#define SSC_SEL_1M			0x00
398#define SSC_SEL_2M			0x08
399#define SSC_SEL_4M			0x10
400#define SSC_SEL_8M			0x18
401
402/* SSC_CTL2 */
403#define SSC_DEPTH_MASK			0x03
404#define SSC_DEPTH_DISALBE		0x00
405#define SSC_DEPTH_2M			0x01
406#define SSC_DEPTH_1M			0x02
407#define SSC_DEPTH_512K			0x03
408
409/* SD_VPCLK0_CTL */
410#define PHASE_CHANGE			0x80
411#define PHASE_NOT_RESET			0x40
412
413/* SD_TRANSFER */
414#define	SD_TRANSFER_START		0x80
415#define	SD_TRANSFER_END			0x40
416#define SD_STAT_IDLE			0x20
417#define	SD_TRANSFER_ERR			0x10
418#define	SD_TM_NORMAL_WRITE		0x00
419#define	SD_TM_AUTO_WRITE_3		0x01
420#define	SD_TM_AUTO_WRITE_4		0x02
421#define	SD_TM_AUTO_READ_3		0x05
422#define	SD_TM_AUTO_READ_4		0x06
423#define	SD_TM_CMD_RSP			0x08
424#define	SD_TM_AUTO_WRITE_1		0x09
425#define	SD_TM_AUTO_WRITE_2		0x0A
426#define	SD_TM_NORMAL_READ		0x0C
427#define	SD_TM_AUTO_READ_1		0x0D
428#define	SD_TM_AUTO_READ_2		0x0E
429#define	SD_TM_AUTO_TUNING		0x0F
430
431/* SD_CFG1 */
432#define SD_CLK_DIVIDE_0			0x00
433#define	SD_CLK_DIVIDE_256		0xC0
434#define	SD_CLK_DIVIDE_128		0x80
435#define SD_CLK_DIVIDE_MASK		0xC0
436#define	SD_BUS_WIDTH_1BIT		0x00
437#define	SD_BUS_WIDTH_4BIT		0x01
438#define	SD_BUS_WIDTH_8BIT		0x02
439#define	SD_ASYNC_FIFO_RST		0x10
440#define	SD_20_MODE			0x00
441#define	SD_DDR_MODE			0x04
442#define	SD_30_MODE			0x08
443
444/* SD_CFG2 */
445#define	SD_CALCULATE_CRC7		0x00
446#define	SD_NO_CALCULATE_CRC7		0x80
447#define	SD_CHECK_CRC16			0x00
448#define	SD_NO_CHECK_CRC16		0x40
449#define SD_WAIT_CRC_TO_EN		0x20
450#define	SD_WAIT_BUSY_END		0x08
451#define	SD_NO_WAIT_BUSY_END		0x00
452#define	SD_CHECK_CRC7			0x00
453#define	SD_NO_CHECK_CRC7		0x04
454#define	SD_RSP_LEN_0			0x00
455#define	SD_RSP_LEN_6			0x01
456#define	SD_RSP_LEN_17			0x02
457#define	SD_RSP_TYPE_R0			0x04
458#define	SD_RSP_TYPE_R1			0x01
459#define	SD_RSP_TYPE_R1b			0x09
460#define	SD_RSP_TYPE_R2			0x02
461#define	SD_RSP_TYPE_R3			0x05
462#define	SD_RSP_TYPE_R4			0x05
463#define	SD_RSP_TYPE_R5			0x01
464#define	SD_RSP_TYPE_R6			0x01
465#define	SD_RSP_TYPE_R7			0x01
466
467/* SD_STAT1 */
468#define	SD_CRC7_ERR			0x80
469#define	SD_CRC16_ERR			0x40
470#define	SD_CRC_WRITE_ERR		0x20
471#define	SD_CRC_WRITE_ERR_MASK		0x1C
472#define	GET_CRC_TIME_OUT		0x02
473#define	SD_TUNING_COMPARE_ERR		0x01
474
475/* SD_DATA_STATE */
476#define SD_DATA_IDLE			0x80
477
478/* CARD_DATA_SOURCE */
479#define PINGPONG_BUFFER			0x01
480#define RING_BUFFER			0x00
481
482/* CARD_OE */
483#define SD_OUTPUT_EN			0x04
484#define MS_OUTPUT_EN			0x08
485
486/* CARD_STOP */
487#define SD_STOP				0x04
488#define MS_STOP				0x08
489#define SD_CLR_ERR			0x40
490#define MS_CLR_ERR			0x80
491
492/* CARD_CLK_SOURCE */
493#define CRC_FIX_CLK			(0x00 << 0)
494#define CRC_VAR_CLK0			(0x01 << 0)
495#define CRC_VAR_CLK1			(0x02 << 0)
496#define SD30_FIX_CLK			(0x00 << 2)
497#define SD30_VAR_CLK0			(0x01 << 2)
498#define SD30_VAR_CLK1			(0x02 << 2)
499#define SAMPLE_FIX_CLK			(0x00 << 4)
500#define SAMPLE_VAR_CLK0			(0x01 << 4)
501#define SAMPLE_VAR_CLK1			(0x02 << 4)
502
503/* SD_SAMPLE_POINT_CTL */
504#define	DDR_FIX_RX_DAT			0x00
505#define	DDR_VAR_RX_DAT			0x80
506#define	DDR_FIX_RX_DAT_EDGE		0x00
507#define	DDR_FIX_RX_DAT_14_DELAY		0x40
508#define	DDR_FIX_RX_CMD			0x00
509#define	DDR_VAR_RX_CMD			0x20
510#define	DDR_FIX_RX_CMD_POS_EDGE		0x00
511#define	DDR_FIX_RX_CMD_14_DELAY		0x10
512#define	SD20_RX_POS_EDGE		0x00
513#define	SD20_RX_14_DELAY		0x08
514#define SD20_RX_SEL_MASK		0x08
515
516/* SD_PUSH_POINT_CTL */
517#define	DDR_FIX_TX_CMD_DAT		0x00
518#define	DDR_VAR_TX_CMD_DAT		0x80
519#define	DDR_FIX_TX_DAT_14_TSU		0x00
520#define	DDR_FIX_TX_DAT_12_TSU		0x40
521#define	DDR_FIX_TX_CMD_NEG_EDGE		0x00
522#define	DDR_FIX_TX_CMD_14_AHEAD		0x20
523#define	SD20_TX_NEG_EDGE		0x00
524#define	SD20_TX_14_AHEAD		0x10
525#define SD20_TX_SEL_MASK		0x10
526#define	DDR_VAR_SDCLK_POL_SWAP		0x01
527
528/* MS_CFG */
529#define	SAMPLE_TIME_RISING		0x00
530#define	SAMPLE_TIME_FALLING		0x80
531#define	PUSH_TIME_DEFAULT		0x00
532#define	PUSH_TIME_ODD			0x40
533#define	NO_EXTEND_TOGGLE		0x00
534#define	EXTEND_TOGGLE_CHK		0x20
535#define	MS_BUS_WIDTH_1			0x00
536#define	MS_BUS_WIDTH_4			0x10
537#define	MS_BUS_WIDTH_8			0x18
538#define	MS_2K_SECTOR_MODE		0x04
539#define	MS_512_SECTOR_MODE		0x00
540#define	MS_TOGGLE_TIMEOUT_EN		0x00
541#define	MS_TOGGLE_TIMEOUT_DISEN		0x01
542#define MS_NO_CHECK_INT			0x02
543
544/* MS_TRANS_CFG */
545#define	WAIT_INT			0x80
546#define	NO_WAIT_INT			0x00
547#define	NO_AUTO_READ_INT_REG		0x00
548#define	AUTO_READ_INT_REG		0x40
549#define	MS_CRC16_ERR			0x20
550#define	MS_RDY_TIMEOUT			0x10
551#define	MS_INT_CMDNK			0x08
552#define	MS_INT_BREQ			0x04
553#define	MS_INT_ERR			0x02
554#define	MS_INT_CED			0x01
555
556/* MS_TRANSFER */
557#define	MS_TRANSFER_START		0x80
558#define	MS_TRANSFER_END			0x40
559#define	MS_TRANSFER_ERR			0x20
560#define	MS_BS_STATE			0x10
561#define	MS_TM_READ_BYTES		0x00
562#define	MS_TM_NORMAL_READ		0x01
563#define	MS_TM_WRITE_BYTES		0x04
564#define	MS_TM_NORMAL_WRITE		0x05
565#define	MS_TM_AUTO_READ			0x08
566#define	MS_TM_AUTO_WRITE		0x0C
567#define MS_TM_SET_CMD			0x06
568#define MS_TM_COPY_PAGE			0x07
569#define MS_TM_MULTI_READ		0x02
570#define MS_TM_MULTI_WRITE		0x03
571
572/* MC_FIFO_CTL */
573#define FIFO_FLUSH			0x01
574
575/* MC_DMA_RST */
576#define DMA_RESET  0x01
577
578/* MC_DMA_CTL */
579#define DMA_TC_EQ_0			0x80
580#define DMA_DIR_TO_CARD			0x00
581#define DMA_DIR_FROM_CARD		0x02
582#define DMA_EN				0x01
583#define DMA_128				(0 << 2)
584#define DMA_256				(1 << 2)
585#define DMA_512				(2 << 2)
586#define DMA_1024			(3 << 2)
587#define DMA_PACK_SIZE_MASK		0x0C
588
589/* CARD_INT_PEND */
590#define XD_INT				0x10
591#define MS_INT				0x08
592#define SD_INT				0x04
593
594/* LED operations*/
595static inline int rtsx_usb_turn_on_led(struct rtsx_ucr *ucr)
596{
597	return  rtsx_usb_ep0_write_register(ucr, CARD_GPIO, 0x03, 0x02);
598}
599
600static inline int rtsx_usb_turn_off_led(struct rtsx_ucr *ucr)
601{
602	return rtsx_usb_ep0_write_register(ucr, CARD_GPIO, 0x03, 0x03);
603}
604
605/* HW error clearing */
606static inline void rtsx_usb_clear_fsm_err(struct rtsx_ucr *ucr)
607{
608	rtsx_usb_ep0_write_register(ucr, SFSM_ED, 0xf8, 0xf8);
609}
610
611static inline void rtsx_usb_clear_dma_err(struct rtsx_ucr *ucr)
612{
613	rtsx_usb_ep0_write_register(ucr, MC_FIFO_CTL,
614			FIFO_FLUSH, FIFO_FLUSH);
615	rtsx_usb_ep0_write_register(ucr, MC_DMA_RST, DMA_RESET, DMA_RESET);
616}
617#endif /* __RTS51139_H */