drivers/net/wireless/rockchip_wlan/rtl8723cs/include/rtw_mcc.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2015 Realtek Corporation. All rights reserved.
   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  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  17  *
  18  ******************************************************************************/
  19 #ifdef CONFIG_MCC_MODE
  20
  21 #ifndef _RTW_MCC_H_
  22 #define _RTW_MCC_H_
  23
  24 #include <drv_types.h> /* PADAPTER */
  25
  26 #define MCC_STATUS_PROCESS_MCC_START_SETTING BIT0
  27 #define MCC_STATUS_PROCESS_MCC_STOP_SETTING BIT1
  28 #define MCC_STATUS_NEED_MCC BIT2
  29 #define MCC_STATUS_DOING_MCC BIT3
  30
  31
  32 #define MCC_SWCH_FW_EARLY_TIME 10 /* ms */
  33 #define MCC_EXPIRE_TIME 50 /* ms */
  34 #define MCC_TOLERANCE_TIME 2 /* 2*2 = 4s */
  35
  36 #define MCC_ROLE_STA_GC_MGMT_QUEUE_MACID 0
  37 #define MCC_ROLE_SOFTAP_GO_MGMT_QUEUE_MACID 1
  38
  39 /* Lower for stop, Higher for start */
  40 #define MCC_SETCMD_STATUS_STOP_DISCONNECT 0x0
  41 #define MCC_SETCMD_STATUS_STOP_SCAN_START 0x1
  42 #define MCC_SETCMD_STATUS_START_CONNECT 0x80
  43 #define MCC_SETCMD_STATUS_START_SCAN_DONE 0x81
  44
  45 /*
  46 * depenad platform or customer requirement(TP unit:Mbps),
  47 * must be provided by PM or sales or product document
  48 * too large value means not to limit tx bytes (current for ap mode)
  49 * NOTE: following values ref from test results
  50 */
  51 #define MCC_AP_BW20_TARGET_TX_TP (300)
  52 #define MCC_AP_BW40_TARGET_TX_TP (300)
  53 #define MCC_AP_BW80_TARGET_TX_TP (300)
  54 #define MCC_STA_BW20_TARGET_TX_TP (35)
  55 #define MCC_STA_BW40_TARGET_TX_TP (70)
  56 #define MCC_STA_BW80_TARGET_TX_TP (140)
  57 #define MCC_SINGLE_TX_CRITERIA 5 /* Mbps */
  58
  59 #define MAX_MCC_NUM 2
  60
  61 #define MCC_STOP(adapter) (adapter->mcc_adapterpriv.mcc_tx_stop)
  62 #define MCC_EN(adapter) (adapter->registrypriv.en_mcc)
  63
  64 /* Represent Channel Tx Null setting */
  65 enum mcc_channel_tx_null {
  66         MCC_ENABLE_TX_NULL = 0,
  67         MCC_DISABLE_TX_NULL = 1,
  68 };
  69
  70 /* Represent C2H Report setting */
  71 enum mcc_c2h_report {
  72         MCC_C2H_REPORT_DISABLE = 0,
  73         MCC_C2H_REPORT_FAIL_STATUS = 1,
  74         MCC_C2H_REPORT_ALL_STATUS = 2,
  75 };
  76
  77 /* Represent Channel Scan */
  78 enum mcc_channel_scan {
  79         MCC_CHIDX = 0,
  80         MCC_SCANCH_RSVD_LOC = 1,
  81 };
  82
  83 /* Represent FW status report of channel switch */
  84 enum mcc_status_rpt {
  85         MCC_RPT_SUCCESS = 0,
  86         MCC_RPT_TXNULL_FAIL = 1,
  87         MCC_RPT_STOPMCC = 2,
  88         MCC_RPT_READY = 3,
  89         MCC_RPT_SWICH_CHANNEL_NOTIFY = 7,
  90         MCC_RPT_UPDATE_NOA_START_TIME = 8,
  91         MCC_RPT_MAX,
  92 };
  93
  94 enum MCC_ROLE {
  95         MCC_ROLE_STA = 0,
  96         MCC_ROLE_AP = 1,
  97         MCC_ROLE_GC = 2,
  98         MCC_ROLE_GO = 3,
  99         MCC_ROLE_MAX,
 100 };
 101
 102 struct mcc_iqk_backup {
 103         u16 TX_X;
 104         u16 TX_Y;
 105         u16 RX_X;
 106         u16 RX_Y;
 107 };
 108
 109 /*  mcc data for adapter */
 110 struct mcc_adapter_priv {
 111         u8 order;               /* FW document, softap/AP must be 0 */
 112         u8 role;                        /* MCC role(AP,STA,GO,GC) */
 113         u8 mcc_duration; /* channel stay period, UNIT:1TU */
 114
 115         /* flow control */
 116         u8 mcc_tx_stop;                         /* check if tp stop or not */
 117         u8 mcc_tp_limit;                                /* check if tp limit or not */
 118         u32 mcc_target_tx_bytes_to_port;                /* customer require  */
 119         u32 mcc_tx_bytes_to_port;       /* already tx to tx fifo (write port) */
 120
 121         /* data from kernel to check if enqueue data or netif stop queue */
 122         u32 mcc_tp;
 123         u64 mcc_tx_bytes_from_kernel;
 124         u64 mcc_last_tx_bytes_from_kernel;
 125
 126         /* Backup IQK value for MCC */
 127         struct mcc_iqk_backup mcc_iqk_arr[MAX_RF_PATH];
 128
 129         /* mgmt queue macid to avoid RA issue */
 130         u8 mgmt_queue_macid;
 131
 132         /* set macid bitmap to let fw know which macid should be tx pause */
 133         /* all interface share total 16 macid */
 134         u16 mcc_macid_bitmap;
 135
 136         /* use for NoA start time (unit: mircoseconds) */
 137         u32 noa_start_time;
 138
 139         u8 p2p_go_noa_ie[MAX_P2P_IE_LEN];
 140         u32 p2p_go_noa_ie_len;
 141 };
 142
 143 struct mcc_obj_priv {
 144         u8 duration; /* channel stay period, UNIT:1TU */
 145         u8 mcc_c2h_status;
 146         u8 cur_mcc_success_cnt; /* used for check mcc switch channel success */
 147         u8 prev_mcc_success_cnt; /* used for check mcc switch channel success */
 148         u8 mcc_tolerance_time; /* used for detect mcc switch channel success */
 149         u8 mcc_loc_rsvd_paga[MAX_MCC_NUM];  /* mcc rsvd page */
 150         u8 mcc_status; /* mcc status stop or start .... */
 151         u8 policy_index;
 152         u32 mcc_launch_time; /* mcc launch time, used for starting detect mcc switch channel success */
 153         _mutex mcc_mutex;
 154         _lock mcc_lock;
 155         PADAPTER iface[MAX_MCC_NUM]; /* by order, use for mcc parameter cmd */
 156         struct submit_ctx mcc_sctx;
 157 };
 158
 159 /* backup IQK val */
 160 void rtw_hal_mcc_restore_iqk_val(PADAPTER padapter);
 161
 162 /* check mcc status */
 163 u8 rtw_hal_check_mcc_status(PADAPTER padapter, u8 mcc_status);
 164
 165 /* set mcc status */
 166 void rtw_hal_set_mcc_status(PADAPTER padapter, u8 mcc_status);
 167
 168 /* clear mcc status */
 169 void rtw_hal_clear_mcc_status(PADAPTER padapter, u8 mcc_status);
 170
 171 /* dl mcc rsvd page */
 172 u8 rtw_hal_dl_mcc_fw_rsvd_page(_adapter *adapter, u8 *pframe, u16 *index
 173         , u8 tx_desc, u32 page_size, u8 *page_num, u32 *total_pkt_len, RSVDPAGE_LOC *rsvd_page_loc);
 174
 175 /* handle C2H */
 176 void rtw_hal_mcc_c2h_handler(PADAPTER padapter, u8 buflen, u8 *tmpBuf);
 177
 178 /* switch channel successfully or not */
 179 void rtw_hal_mcc_sw_status_check(PADAPTER padapter);
 180
 181 /* change some scan flags under site survey */
 182 u8 rtw_hal_mcc_change_scan_flag(PADAPTER padapter, u8 *ch, u8 *bw, u8 *offset);
 183
 184 /* record data kernel TX to driver to check MCC concurrent TX  */
 185 void rtw_hal_mcc_calc_tx_bytes_from_kernel(PADAPTER padapter, u32 len);
 186
 187 /* record data to port to let driver do flow ctrl  */
 188 void rtw_hal_mcc_calc_tx_bytes_to_port(PADAPTER padapter, u32 len);
 189
 190 /* check stop write port or not  */
 191 u8 rtw_hal_mcc_stop_tx_bytes_to_port(PADAPTER padapter);
 192
 193 u8 rtw_hal_set_mcc_setting_scan_start(PADAPTER padapter);
 194
 195 u8 rtw_hal_set_mcc_setting_scan_complete(PADAPTER padapter);
 196
 197 u8 rtw_hal_set_mcc_setting_start_bss_network(PADAPTER padapter, u8 chbw_grouped);
 198
 199 u8 rtw_hal_set_mcc_setting_disconnect(PADAPTER padapter);
 200
 201 u8 rtw_hal_set_mcc_setting_join_done_chk_ch(PADAPTER padapter);
 202
 203 u8 rtw_hal_set_mcc_setting_chk_start_clnt_join(PADAPTER padapter, u8 *ch, u8 *bw, u8 *offset, u8 chbw_allow);
 204
 205 void rtw_hal_dump_mcc_info(void *sel, struct dvobj_priv *dvobj);
 206
 207 void update_mcc_mgntframe_attrib(_adapter *padapter, struct pkt_attrib *pattrib);
 208
 209 u8 rtw_hal_mcc_link_status_chk(_adapter *padapter, const char *msg);
 210
 211 void rtw_hal_mcc_issue_null_data(_adapter *padapter, u8 chbw_allow, u8 ps_mode);
 212
 213 u8 *rtw_hal_mcc_append_go_p2p_ie(PADAPTER padapter, u8 *pframe, u32 *len);
 214
 215 void rtw_hal_mcc_update_switch_channel_policy_table(PADAPTER padapter);
 216
 217 void rtw_hal_dump_mcc_policy_table(void *sel);
 218
 219 #endif /* _RTW_MCC_H_ */
 220 #endif /* CONFIG_MCC_MODE */