xref: /OK3568_Linux_fs/external/rkwifibt/drivers/rtl8852be/include/rtw_sec_cam.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /******************************************************************************
2  *
3  * Copyright(c) 2007 - 2019 Realtek Corporation.
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of version 2 of the GNU General Public License as
7  * published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12  * more details.
13  *
14  *****************************************************************************/
15 #ifndef __RTW_SEC_CAM_H__
16 #define __RTW_SEC_CAM_H__
17 
18 #define SEC_STATUS_STA_PK_GK_CONFLICT_DIS_BMC_SEARCH	BIT0
19 
20 struct sec_cam_bmp {
21 	u32 m0;
22 #if (SEC_CAM_ENT_NUM_SW_LIMIT > 32)
23 	u32 m1;
24 #endif
25 #if (SEC_CAM_ENT_NUM_SW_LIMIT > 64)
26 	u32 m2;
27 #endif
28 #if (SEC_CAM_ENT_NUM_SW_LIMIT > 96)
29 	u32 m3;
30 #endif
31 };
32 
33 struct cam_ctl_t {
34 	_lock lock;
35 
36 	u8 sec_cap;
37 	u32 flags;
38 
39 	u8 num;
40 	struct sec_cam_bmp used;
41 
42 	_mutex sec_cam_access_mutex;
43 };
44 
45 struct sec_cam_ent {
46 	u16 ctrl;
47 	u8 mac[ETH_ALEN];
48 	u8 key[16];
49 };
50 
51 bool _rtw_camctl_chk_cap(_adapter *adapter, u8 cap);
52 void _rtw_camctl_set_flags(_adapter *adapter, u32 flags);
53 void rtw_camctl_set_flags(_adapter *adapter, u32 flags);
54 void _rtw_camctl_clr_flags(_adapter *adapter, u32 flags);
55 void rtw_camctl_clr_flags(_adapter *adapter, u32 flags);
56 bool _rtw_camctl_chk_flags(_adapter *adapter, u32 flags);
57 
58 void dump_sec_cam_map(void *sel, struct sec_cam_bmp *map, u8 max_num);
59 void rtw_sec_cam_map_set(struct sec_cam_bmp *map, u8 id);
60 void rtw_sec_cam_map_clr(struct sec_cam_bmp *map, u8 id);
61 void rtw_sec_cam_map_clr_all(struct sec_cam_bmp *map);
62 
63 bool rtw_sec_camid_is_used(struct cam_ctl_t *cam_ctl, u8 id);
64 
65 bool _rtw_camid_is_gk(_adapter *adapter, u8 cam_id);
66 bool rtw_camid_is_gk(_adapter *adapter, u8 cam_id);
67 s16 rtw_camid_search(_adapter *adapter, u8 *addr, s16 kid, s8 gk);
68 s16 rtw_camid_alloc(_adapter *adapter, struct sta_info *sta, u8 kid, u8 gk, bool ext_sec, bool *used);
69 void rtw_camid_free(_adapter *adapter, u8 cam_id);
70 u8 rtw_get_sec_camid(_adapter *adapter, u8 max_bk_key_num, u8 *sec_key_id);
71 
72 void _clear_cam_entry(_adapter *padapter, u8 entry);
73 void write_cam_from_cache(_adapter *adapter, u8 id);
74 void rtw_sec_cam_swap(_adapter *adapter, u8 cam_id_a, u8 cam_id_b);
75 void rtw_clean_dk_section(_adapter *adapter);
76 void rtw_clean_hw_dk_cam(_adapter *adapter);
77 
78 /* modify both HW and cache */
79 void write_cam(_adapter *padapter, u8 id, u16 ctrl, u8 *mac, u8 *key);
80 void clear_cam_entry(_adapter *padapter, u8 id);
81 
82 /* modify cache only */
83 void write_cam_cache(_adapter *adapter, u8 id, u16 ctrl, u8 *mac, u8 *key);
84 void clear_cam_cache(_adapter *adapter, u8 id);
85 
86 void invalidate_cam_all(_adapter *padapter);
87 
88 void flush_all_cam_entry(_adapter *padapter, enum phl_cmd_type cmd_type, u32 cmd_timeout);
89 
90 #if defined(DBG_CONFIG_ERROR_RESET) && defined(CONFIG_CONCURRENT_MODE)
91 void rtw_iface_bcmc_sec_cam_map_restore(_adapter *adapter);
92 #endif
93 
94 #ifdef  CONFIG_DBG_AX_CAM
95 
96 #define INDIRECT_ACCESS_ADDR	0xC04
97 #define INDIRECT_ACCESS_VALUE	0x40000
98 #define SEC_CAM_BASE_ADDR	0x18814000
99 #define BSSID_CAM_BASE_ADDR	0x18853000
100 #define ADDR_CAM_BASE_ADDR	0x18850000
101 
102 enum CAM_KEY_TYPE {
103 	KEY_TYPE_UNI = 0,
104 	KEY_TYPE_GROUP = 1,
105 	KEY_TYPE_BIP = 2,
106 	KEY_TYPE_NONE = 3
107 };
108 
109 /*Address cam field info DW0 - DW9*/
110 
111 /* DWORD 0 ; Offset 00h */
112 #define GET_AX_ADDR_CAM_VALID(__pCAM)		LE_BITS_TO_4BYTE(__pCAM, 0, 1)
113 #define GET_AX_ADDR_CAM_NET_TYPE(__pCAM)	LE_BITS_TO_4BYTE(__pCAM, 1, 2)
114 #define GET_AX_ADDR_CAM_BCN_HD_COND(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM, 3, 2)
115 #define GET_AX_ADDR_CAM_HIT_RULE(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM, 5, 2)
116 #define GET_AX_ADDR_CAM_BB_SEL(__pCAM)		LE_BITS_TO_4BYTE(__pCAM, 7, 1)
117 #define GET_AX_ADDR_CAM_ADDR_MASK(__pCAM)	LE_BITS_TO_4BYTE(__pCAM, 8, 6)
118 #define GET_AX_ADDR_CAM_MASK_SEL(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM, 14, 2)
119 #define GET_AX_ADDR_CAM_SMA_HASH(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM, 16, 8)
120 #define GET_AX_ADDR_CAM_TMA_HASH(__pCAM)	LE_BITS_TO_4BYTE(__pCAM, 24, 8)
121 
122 /* DWORD 1 ; Offset 04h */
123 #define GET_AX_ADDR_CAM_BSSID_CAM_IDX(__pCAM)	LE_BITS_TO_4BYTE(__pCAM+4, 0, 6)
124 /* DWORD 2 ; Offset 08h */
125 #define GET_AX_ADDR_CAM_SMA_0(__pCAM) 		LE_BITS_TO_4BYTE(__pCAM+8, 0, 8)
126 #define GET_AX_ADDR_CAM_SMA_1(__pCAM) 		LE_BITS_TO_4BYTE(__pCAM+8, 8, 8)
127 #define GET_AX_ADDR_CAM_SMA_2(__pCAM) 		LE_BITS_TO_4BYTE(__pCAM+8, 16, 8)
128 #define GET_AX_ADDR_CAM_SMA_3(__pCAM) 		LE_BITS_TO_4BYTE(__pCAM+8, 24, 8)
129 /* DWORD 3 ; Offset 0Ch */
130 #define GET_AX_ADDR_CAM_SMA_4(__pCAM) 		LE_BITS_TO_4BYTE(__pCAM+12, 8, 6)
131 #define GET_AX_ADDR_CAM_SMA_5(__pCAM) 		LE_BITS_TO_4BYTE(__pCAM+12, 14, 2)
132 #define GET_AX_ADDR_CAM_TMA_0(__pCAM) 		LE_BITS_TO_4BYTE(__pCAM+12, 16, 8)
133 #define GET_AX_ADDR_CAM_TMA_1(__pCAM)		LE_BITS_TO_4BYTE(__pCAM+12, 24, 8)
134 /* DWORD 4 ; Offset 10h */
135 #define GET_AX_ADDR_CAM_TMA_2(__pCAM)		LE_BITS_TO_4BYTE(__pCAM+16, 0, 8)
136 #define GET_AX_ADDR_CAM_TMA_3(__pCAM)		LE_BITS_TO_4BYTE(__pCAM+16, 8, 8)
137 #define GET_AX_ADDR_CAM_TMA_4(__pCAM) 		LE_BITS_TO_4BYTE(__pCAM+16, 16, 8)
138 #define GET_AX_ADDR_CAM_TMA_5(__pCAM) 		LE_BITS_TO_4BYTE(__pCAM+16, 24, 8)
139 /* DWORD 5 ; Offset 14h : RSVD ALL*/
140 /* DWORD 6 ; Offset 18h */
141 
142 #define GET_AX_ADDR_CAM_MACID(__pCAM) 		LE_BITS_TO_4BYTE(__pCAM+24, 0, 8)
143 #define GET_AX_ADDR_CAM_PORT_INT(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+24, 8, 3)
144 #define GET_AX_ADDR_CAM_TSF_SYNC(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+24, 11, 3)
145 #define GET_AX_ADDR_CAM_TF(__pCAM)		LE_BITS_TO_4BYTE(__pCAM+24, 14, 2)
146 #define GET_AX_ADDR_CAM_LSIG_TXOP(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+24, 16, 2)
147 #define GET_AX_ADDR_CAM_CTRLCNT_IDX(__pCAM)	LE_BITS_TO_4BYTE(__pCAM+24, 18, 4)
148 #define GET_AX_ADDR_CAM_CTRLCNT_VALID(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+24, 20, 1)
149 #define GET_AX_ADDR_CAM_TARGET_IND(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+24, 24, 3)
150 #define GET_AX_ADDR_CAM_FRM_TARGET_IND(__pCAM)	LE_BITS_TO_4BYTE(__pCAM+24, 27, 3)
151 
152 /* DWORD 7 ; Offset 1Ch */
153 #define GET_AX_ADDR_CAM_AID12_0(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+28, 0, 8)
154 #define GET_AX_ADDR_CAM_AID12_1(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+28, 8, 4)
155 #define GET_AX_ADDR_CAM_WOL_PATTERN(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+28, 12, 1)
156 #define GET_AX_ADDR_CAM_WOL_UC(__pCAM)		LE_BITS_TO_4BYTE(__pCAM+28, 13, 1)
157 #define GET_AX_ADDR_CAM_WOL_MAGIC(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+28, 14, 1)
158 #define GET_AX_ADDR_CAM_WAPI(__pCAM) 		LE_BITS_TO_4BYTE(__pCAM+28, 15, 1)
159 #define GET_AX_ADDR_CAM_SEC_ENT_MODE(__pCAM)	LE_BITS_TO_4BYTE(__pCAM+28, 16, 2)
160 #define GET_AX_ADDR_CAM_SEC_ENT0_KEYID(__pCAM)	LE_BITS_TO_4BYTE(__pCAM+28, 18, 2)
161 #define GET_AX_ADDR_CAM_SEC_ENT1_KEYID(__pCAM)	LE_BITS_TO_4BYTE(__pCAM+28, 20, 2)
162 #define GET_AX_ADDR_CAM_SEC_ENT2_KEYID(__pCAM)	LE_BITS_TO_4BYTE(__pCAM+28, 22, 2)
163 #define GET_AX_ADDR_CAM_SEC_ENT3_KEYID(__pCAM)	LE_BITS_TO_4BYTE(__pCAM+28, 24, 2)
164 #define GET_AX_ADDR_CAM_SEC_ENT4_KEYID(__pCAM)	LE_BITS_TO_4BYTE(__pCAM+28, 26, 2)
165 #define GET_AX_ADDR_CAM_SEC_ENT5_KEYID(__pCAM)	LE_BITS_TO_4BYTE(__pCAM+28, 28, 2)
166 #define GET_AX_ADDR_CAM_SEC_ENT6_KEYID(__pCAM)	LE_BITS_TO_4BYTE(__pCAM+28, 30, 2)
167 /* DWORD 8 ; Offset 20h */
168 #define GET_AX_ADDR_CAM_SEC_ENT_VALID(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+32, 0, 8)
169 #define GET_AX_ADDR_CAM_SEC_ENT0(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+32, 8, 8)
170 #define GET_AX_ADDR_CAM_SEC_ENT1(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+32, 16, 8)
171 #define GET_AX_ADDR_CAM_SEC_ENT2(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+32, 24, 8)
172 /* DWORD 9 ; Offset 24h */
173 #define GET_AX_ADDR_CAM_SEC_ENT3(__pCAM)	LE_BITS_TO_4BYTE(__pCAM+36, 0, 8)
174 #define GET_AX_ADDR_CAM_SEC_ENT4(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+36, 8, 8)
175 #define GET_AX_ADDR_CAM_SEC_ENT5(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+36, 16, 8)
176 #define GET_AX_ADDR_CAM_SEC_ENT6(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM+36, 24, 8)
177 
178 /* Security cam */
179 /*DWORD 0 ; offset 00h*/
180 #define GET_AX_SEC_CAM_TYPE(__pCAM) 		LE_BITS_TO_4BYTE(__pCAM, 0, 4)
181 #define GET_AX_SEC_CAM_EXT_KEY(__pCAM)		LE_BITS_TO_4BYTE(__pCAM, 4, 1)
182 #define GET_AX_SEC_SPP_MODE_(__pCAM) 		LE_BITS_TO_4BYTE(__pCAM, 5, 1)
183 
184 /*BSSID cam*/
185 /*DWORD 0 ; offset 00h*/
186 #define GET_AX_BSSID_CAM_VALID(__pCAM)		LE_BITS_TO_4BYTE(__pCAM, 0, 1)
187 #define GET_AX_BSSID_CAM_BB_SEL(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM, 1, 1)
188 #define GET_AX_BSSID_CAM_COLOR_(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM, 8, 6)
189 #define GET_AX_BSSID_CAM_BSSID_0(__pCAM)	LE_BITS_TO_4BYTE(__pCAM, 16, 8)
190 #define GET_AX_BSSID_CAM_BSSID_1(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM, 24, 8)
191 /*DWORD 1 ; offset 04h*/
192 #define GET_AX_BSSID_CAM_BSSID_2(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM, 0, 8)
193 #define GET_AX_BSSID_CAM_BSSID_3(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM, 8, 8)
194 #define GET_AX_BSSID_CAM_BSSID_4(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM, 16, 8)
195 #define GET_AX_BSSID_CAM_BSSID_5(__pCAM) 	LE_BITS_TO_4BYTE(__pCAM, 24, 8)
196 
197 int get_ax_sec_cam(void* sel, struct _ADAPTER *a);
198 int get_ax_address_cam(void* sel, struct _ADAPTER *a);
199 int get_ax_valid_key(void* sel, struct _ADAPTER *a);
200 
201 #endif /* CONFIG_DBG_AX_CAM */
202 
203 #endif /* __RTW_SEC_CAM_H__ */
204