1  /* SPDX-License-Identifier: GPL-2.0-or-later */
2  /* Driver for Realtek PCI-Express card reader
3   *
4   * Copyright(c) 2009-2013 Realtek Semiconductor Corp. All rights reserved.
5   *
6   * Author:
7   *   Wei WANG <wei_wang@realsil.com.cn>
8   */
9  
10  #ifndef __RTSX_PCR_H
11  #define __RTSX_PCR_H
12  
13  #include <linux/rtsx_pci.h>
14  
15  #define MIN_DIV_N_PCR		80
16  #define MAX_DIV_N_PCR		208
17  
18  #define RTS522A_PME_FORCE_CTL	0xFF78
19  #define RTS522A_AUTOLOAD_CFG1	0xFF7C
20  #define RTS522A_PM_CTRL3		0xFF7E
21  
22  #define RTS524A_PME_FORCE_CTL		0xFF78
23  #define REG_EFUSE_BYPASS		0x08
24  #define REG_EFUSE_POR			0x04
25  #define REG_EFUSE_POWER_MASK		0x03
26  #define REG_EFUSE_POWERON		0x03
27  #define REG_EFUSE_POWEROFF		0x00
28  #define RTS5250_CLK_CFG3		0xFF79
29  #define RTS525A_CFG_MEM_PD		0xF0
30  #define RTS524A_AUTOLOAD_CFG1		0xFF7C
31  #define RTS524A_PM_CTRL3		0xFF7E
32  #define RTS525A_BIOS_CFG		0xFF2D
33  #define RTS525A_LOAD_BIOS_FLAG	0x01
34  #define RTS525A_CLEAR_BIOS_FLAG	0x00
35  
36  #define RTS525A_EFUSE_CTL		0xFC32
37  #define REG_EFUSE_ENABLE		0x80
38  #define REG_EFUSE_MODE			0x40
39  #define RTS525A_EFUSE_ADD		0xFC33
40  #define REG_EFUSE_ADD_MASK		0x3F
41  #define RTS525A_EFUSE_DATA		0xFC35
42  
43  #define LTR_ACTIVE_LATENCY_DEF		0x883C
44  #define LTR_IDLE_LATENCY_DEF		0x892C
45  #define LTR_L1OFF_LATENCY_DEF		0x9003
46  #define L1_SNOOZE_DELAY_DEF		1
47  #define LTR_L1OFF_SSPWRGATE_5249_DEF		0xAF
48  #define LTR_L1OFF_SSPWRGATE_5250_DEF		0xFF
49  #define LTR_L1OFF_SNOOZE_SSPWRGATE_5249_DEF	0xAC
50  #define LTR_L1OFF_SNOOZE_SSPWRGATE_5250_DEF	0xF8
51  #define CMD_TIMEOUT_DEF		100
52  #define MASK_8_BIT_DEF		0xFF
53  
54  #define SSC_CLOCK_STABLE_WAIT	130
55  
56  #define RTS524A_OCP_THD_800	0x04
57  #define RTS525A_OCP_THD_800	0x05
58  #define RTS522A_OCP_THD_800	0x06
59  
60  
61  int __rtsx_pci_write_phy_register(struct rtsx_pcr *pcr, u8 addr, u16 val);
62  int __rtsx_pci_read_phy_register(struct rtsx_pcr *pcr, u8 addr, u16 *val);
63  
64  void rts5209_init_params(struct rtsx_pcr *pcr);
65  void rts5229_init_params(struct rtsx_pcr *pcr);
66  void rtl8411_init_params(struct rtsx_pcr *pcr);
67  void rtl8402_init_params(struct rtsx_pcr *pcr);
68  void rts5227_init_params(struct rtsx_pcr *pcr);
69  void rts522a_init_params(struct rtsx_pcr *pcr);
70  void rts5249_init_params(struct rtsx_pcr *pcr);
71  void rts524a_init_params(struct rtsx_pcr *pcr);
72  void rts525a_init_params(struct rtsx_pcr *pcr);
73  void rtl8411b_init_params(struct rtsx_pcr *pcr);
74  void rts5260_init_params(struct rtsx_pcr *pcr);
75  void rts5261_init_params(struct rtsx_pcr *pcr);
76  void rts5228_init_params(struct rtsx_pcr *pcr);
77  
map_sd_drive(int idx)78  static inline u8 map_sd_drive(int idx)
79  {
80  	u8 sd_drive[4] = {
81  		0x01,	/* Type D */
82  		0x02,	/* Type C */
83  		0x05,	/* Type A */
84  		0x03	/* Type B */
85  	};
86  
87  	return sd_drive[idx];
88  }
89  
90  #define rtsx_vendor_setting_valid(reg)		(!((reg) & 0x1000000))
91  #define rts5209_vendor_setting1_valid(reg)	(!((reg) & 0x80))
92  #define rts5209_vendor_setting2_valid(reg)	((reg) & 0x80)
93  
94  #define rtsx_check_mmc_support(reg)		((reg) & 0x10)
95  #define rtsx_reg_to_rtd3(reg)				((reg) & 0x02)
96  #define rtsx_reg_to_rtd3_uhsii(reg)				((reg) & 0x04)
97  #define rtsx_reg_to_aspm(reg)			(((reg) >> 28) & 0x03)
98  #define rtsx_reg_to_sd30_drive_sel_1v8(reg)	(((reg) >> 26) & 0x03)
99  #define rtsx_reg_to_sd30_drive_sel_3v3(reg)	(((reg) >> 5) & 0x03)
100  #define rtsx_reg_to_card_drive_sel(reg)		((((reg) >> 25) & 0x01) << 6)
101  #define rtsx_reg_check_reverse_socket(reg)	((reg) & 0x4000)
102  #define rts5209_reg_to_aspm(reg)		(((reg) >> 5) & 0x03)
103  #define rts5209_reg_check_ms_pmos(reg)		(!((reg) & 0x08))
104  #define rts5209_reg_to_sd30_drive_sel_1v8(reg)	(((reg) >> 3) & 0x07)
105  #define rts5209_reg_to_sd30_drive_sel_3v3(reg)	((reg) & 0x07)
106  #define rts5209_reg_to_card_drive_sel(reg)	((reg) >> 8)
107  #define rtl8411_reg_to_sd30_drive_sel_3v3(reg)	(((reg) >> 5) & 0x07)
108  #define rtl8411b_reg_to_sd30_drive_sel_3v3(reg)	((reg) & 0x03)
109  
110  #define set_pull_ctrl_tables(pcr, __device)				\
111  do {									\
112  	pcr->sd_pull_ctl_enable_tbl  = __device##_sd_pull_ctl_enable_tbl;  \
113  	pcr->sd_pull_ctl_disable_tbl = __device##_sd_pull_ctl_disable_tbl; \
114  	pcr->ms_pull_ctl_enable_tbl  = __device##_ms_pull_ctl_enable_tbl;  \
115  	pcr->ms_pull_ctl_disable_tbl = __device##_ms_pull_ctl_disable_tbl; \
116  } while (0)
117  
118  /* generic operations */
119  int rtsx_gops_pm_reset(struct rtsx_pcr *pcr);
120  int rtsx_set_ltr_latency(struct rtsx_pcr *pcr, u32 latency);
121  int rtsx_set_l1off_sub(struct rtsx_pcr *pcr, u8 val);
122  void rtsx_pci_init_ocp(struct rtsx_pcr *pcr);
123  void rtsx_pci_disable_ocp(struct rtsx_pcr *pcr);
124  void rtsx_pci_enable_ocp(struct rtsx_pcr *pcr);
125  int rtsx_pci_get_ocpstat(struct rtsx_pcr *pcr, u8 *val);
126  void rtsx_pci_clear_ocpstat(struct rtsx_pcr *pcr);
127  void rtsx_pci_enable_oobs_polling(struct rtsx_pcr *pcr);
128  void rtsx_pci_disable_oobs_polling(struct rtsx_pcr *pcr);
129  int rtsx_sd_power_off_card3v3(struct rtsx_pcr *pcr);
130  int rtsx_ms_power_off_card3v3(struct rtsx_pcr *pcr);
131  
132  #endif
133