1 /******************************************************************************
3 * Copyright(c) 2007 - 2010 Realtek Corporation. All rights reserved.
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.
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
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
18 * Modifications for inclusion into the Linux staging tree are
19 * Copyright(c) 2010 Larry Finger. All rights reserved.
21 * Contact information:
25 ******************************************************************************/
26 #ifndef __RTL871X_CMD_H_
27 #define __RTL871X_CMD_H_
29 #include "wlan_bssdef.h"
30 #include "rtl871x_rf.h"
31 #define C2H_MEM_SZ (16*1024)
33 #include "osdep_service.h"
34 #include "ieee80211.h"
36 #define FREE_CMDOBJ_SZ 128
39 #define MAX_EVTSZ 1024
40 #define CMDBUFF_ALIGN_SZ 512
49 struct list_head list;
53 struct completion cmd_queue_comp;
54 struct completion terminate_cmdthread_comp;
55 struct __queue cmd_queue;
57 u8 *cmd_buf; /*shall be non-paged, and 4 bytes aligned*/
58 u8 *cmd_allocated_buf;
59 u8 *rsp_buf; /*shall be non-paged, and 4 bytes aligned*/
60 u8 *rsp_allocated_buf;
64 struct _adapter *padapter;
72 struct list_head list;
76 struct __queue evt_queue;
78 u8 *evt_buf; /*shall be non-paged, and 4 bytes aligned*/
79 u8 *evt_allocated_buf;
81 struct tasklet_struct event_tasklet;
84 #define init_h2fwcmd_w_parm_no_rsp(pcmd, pparm, code) \
86 INIT_LIST_HEAD(&pcmd->list);\
87 pcmd->cmdcode = code;\
88 pcmd->parmbuf = (u8 *)(pparm);\
89 pcmd->cmdsz = sizeof(*pparm);\
94 u32 r8712_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
95 u32 r8712_enqueue_cmd_ex(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
96 struct cmd_obj *r8712_dequeue_cmd(struct __queue *queue);
97 void r8712_free_cmd_obj(struct cmd_obj *pcmd);
98 int r8712_cmd_thread(void *context);
99 u32 r8712_init_cmd_priv(struct cmd_priv *pcmdpriv);
100 void r8712_free_cmd_priv(struct cmd_priv *pcmdpriv);
101 u32 r8712_init_evt_priv(struct evt_priv *pevtpriv);
102 void r8712_free_evt_priv(struct evt_priv *pevtpriv);
104 enum rtl871x_drvint_cid {
117 * Caller Mode: Infra, Ad-HoC(C)
118 * Notes: To enter USB suspend mode
121 struct usb_suspend_parm {
122 u32 action; /* 1: sleep, 0:resume */
126 * Caller Mode: Infra, Ad-HoC(C)
127 * Notes: To disconnect the current associated BSS
130 struct disconnect_parm {
135 * Caller Mode: AP, Ad-HoC, Infra
136 * Notes: To set the NIC mode of RTL8711
138 * The definition of mode:
140 * #define IW_MODE_AUTO 0 // Let the driver decides which AP to join
141 * #define IW_MODE_ADHOC 1 // Single cell network (Ad-Hoc Clients)
142 * #define IW_MODE_INFRA 2 // Multi cell network, roaming, ..
143 * #define IW_MODE_MASTER 3 // Synchronisation master or AP
144 * #define IW_MODE_REPEAT 4 // Wireless Repeater (forwarder)
145 * #define IW_MODE_SECOND 5 // Secondary master/repeater (backup)
146 * #define IW_MODE_MONITOR 6 // Passive monitor (listen only)
148 struct setopmode_parm {
154 * Caller Mode: AP, Ad-HoC, Infra
155 * Notes: To ask RTL8711 performing site-survey
158 struct sitesurvey_parm {
159 sint passive_mode; /*active: 1, passive: 0 */
160 sint bsslimit; /* 1 ~ 48 */
162 u8 ss_ssid[IW_ESSID_MAX_SIZE + 1];
167 * Notes: To set the auth type of RTL8711. open/shared/802.1x
170 struct setauth_parm {
171 u8 mode; /*0: legacy open, 1: legacy shared 2: 802.1x*/
172 u8 _1x; /*0: PSK, 1: TLS*/
178 * a. algorithm: wep40, wep104, tkip & aes
179 * b. keytype: grp key/unicast key
182 * when shared key ==> keyid is the camid
183 * when 802.1x ==> keyid [0:1] ==> grp key
184 * when 802.1x ==> keyid > 2 ==> unicast key
187 u8 algorithm; /* encryption algorithm, could be none, wep40,
191 u8 grpkey; /* 1: this is the grpkey for 802.1x.
192 * 0: this is the unicast key for 802.1x
194 u8 key[16]; /* this could be 40 or 104 */
198 * When in AP or Ad-Hoc mode, this is used to
199 * allocate an sw/hw entry for a newly associated sta.
201 * when shared key ==> algorithm/keyid
203 struct set_stakey_parm {
209 struct set_stakey_rsp {
215 struct SetMacAddr_param {
216 u8 MacAddr[ETH_ALEN];
222 * Command -Rsp(AID == CAMID) mode
224 * This is to force fw to add an sta_data entry per driver's request.
226 * FW will write an cam entry associated with it.
229 struct set_assocsta_parm {
233 struct set_assocsta_rsp {
243 * This is to force fw to del an sta_data entry per driver's request
245 * FW will invalidate the cam entry associated with it.
248 struct del_assocsta_parm {
253 * Caller Mode: AP/Ad-HoC(M)
255 * Notes: To notify fw that given staid has changed its power state
260 struct setstapwrstate_parm {
269 * Notes: To setup the basic rate of RTL8711
274 struct setbasicrate_parm {
275 u8 basicrates[NumRates];
281 * Notes: To read the current basic rate
286 struct getbasicrate_parm {
290 struct getbasicrate_rsp {
291 u8 basicrates[NumRates];
297 * Notes: To setup the data rate of RTL8711
302 struct setdatarate_parm {
304 u8 datarates[NumRates];
307 enum _RT_CHANNEL_DOMAIN {
308 RT_CHANNEL_DOMAIN_FCC = 0,
309 RT_CHANNEL_DOMAIN_IC = 1,
310 RT_CHANNEL_DOMAIN_ETSI = 2,
311 RT_CHANNEL_DOMAIN_SPAIN = 3,
312 RT_CHANNEL_DOMAIN_FRANCE = 4,
313 RT_CHANNEL_DOMAIN_MKK = 5,
314 RT_CHANNEL_DOMAIN_MKK1 = 6,
315 RT_CHANNEL_DOMAIN_ISRAEL = 7,
316 RT_CHANNEL_DOMAIN_TELEC = 8,
318 /* Be compatible with old channel plan. No good! */
319 RT_CHANNEL_DOMAIN_MIC = 9,
320 RT_CHANNEL_DOMAIN_GLOBAL_DOAMIN = 10,
321 RT_CHANNEL_DOMAIN_WORLD_WIDE_13 = 11,
322 RT_CHANNEL_DOMAIN_TELEC_NETGEAR = 12,
324 RT_CHANNEL_DOMAIN_NCC = 13,
325 RT_CHANNEL_DOMAIN_5G = 14,
326 RT_CHANNEL_DOMAIN_5G_40M = 15,
327 /*===== Add new channel plan above this line===============*/
328 RT_CHANNEL_DOMAIN_MAX,
332 struct SetChannelPlan_param {
333 enum _RT_CHANNEL_DOMAIN ChannelPlan;
339 * Notes: To read the current data rate
344 struct getdatarate_parm {
348 struct getdatarate_rsp {
349 u8 datarates[NumRates];
355 * AP: AP can use the info for the contents of beacon frame
356 * Infra: STA can use the info when sitesurveying
358 * Ad-HoC(C): Like STA
361 * Notes: To set the phy capability of the NIC
370 * Notes: To set the channel/modem/band
371 * This command will be used when channel/modem/band is changed.
379 * Notes: To get the current setting of channel/modem/band
396 struct readTSSI_parm {
399 struct readTSSI_rsp {
403 struct writeBB_parm {
408 struct writePTM_parm {
419 struct writeRF_parm {
424 struct setrfintfs_parm {
428 struct getrfintfs_parm {
433 * Notes: This command is used for H2C/C2H loopback testing
436 * ==> CMD mode, return H2C_SUCCESS.
437 * The following condition must be ture under CMD mode
438 * mac[1] == mac[4], mac[2] == mac[3], mac[0]=mac[5]= 0;
439 * s0 == 0x1234, s1 == 0xabcd, w0 == 0x78563412, w1 == 0x5aa5def7;
440 * s2 == (b1 << 8 | b0);
443 * ==> CMD_RSP mode, return H2C_SUCCESS_RSP
445 * The rsp layout shall be:
462 * ==> CMD_EVENT mode, return H2C_SUCCESS
463 * The event layout shall be:
467 * mac[2] = event's sequence number, starting from 1 to parm's marc[3]
471 * s0 = swap16(s0) - event.mac[2];
472 * s1 = s1 + event.mac[2];
475 * s2 = s0 + event.mac[2]
477 * w1 = swap32(w1) - event.mac[2];
479 * parm->mac[3] is the total event counts that host requested.
482 * event will be the same with the cmd's param.
486 /* CMD param Formart for DRV INTERNAL CMD HDL*/
487 struct drvint_cmd_parm {
488 int i_cid; /*internal cmd id*/
493 /*------------------- Below are used for RF/BB tunning ---------------------*/
495 struct setantenna_parm {
502 struct enrateadaptive_parm {
506 struct settxagctbl_parm {
507 u32 txagc[MAX_RATES_LENGTH];
510 struct gettxagctbl_parm {
513 struct gettxagctbl_rsp {
514 u32 txagc[MAX_RATES_LENGTH];
517 struct setagcctrl_parm {
518 u32 agcctrl; /* 0: pure hw, 1: fw */
521 struct setssup_parm {
522 u32 ss_ForceUp[MAX_RATES_LENGTH];
525 struct getssup_parm {
529 u8 ss_ForceUp[MAX_RATES_LENGTH];
532 struct setssdlevel_parm {
533 u8 ss_DLevel[MAX_RATES_LENGTH];
536 struct getssdlevel_parm {
539 struct getssdlevel_rsp {
540 u8 ss_DLevel[MAX_RATES_LENGTH];
543 struct setssulevel_parm {
544 u8 ss_ULevel[MAX_RATES_LENGTH];
547 struct getssulevel_parm {
550 struct getssulevel_rsp {
551 u8 ss_ULevel[MAX_RATES_LENGTH];
554 struct setcountjudge_parm {
555 u8 count_judge[MAX_RATES_LENGTH];
558 struct getcountjudge_parm {
562 struct getcountjudge_rsp {
563 u8 count_judge[MAX_RATES_LENGTH];
566 struct setpwrmode_parm {
568 u8 flag_low_traffic_en;
570 u8 flag_rf_low_snr_en;
571 u8 flag_dps_en; /* 1: dps, 0: 32k */
573 u8 bcn_pass_cnt; /* fw report one beacon information to
574 * driver when it receives bcn_pass_cnt
577 u8 bcn_to; /* beacon TO (ms). ¡§=0¡¨ no limit.*/
579 u8 app_itv; /* only for VOIP mode. */
582 u8 bcn_pass_time; /* unit: 100ms */
585 struct setatim_parm {
586 u8 op; /*0: add, 1:del*/
587 u8 txid; /* id of dest station.*/
590 struct setratable_parm {
591 u8 ss_ForceUp[NumRates];
592 u8 ss_ULevel[NumRates];
593 u8 ss_DLevel[NumRates];
594 u8 count_judge[NumRates];
597 struct getratable_parm {
600 struct getratable_rsp {
601 u8 ss_ForceUp[NumRates];
602 u8 ss_ULevel[NumRates];
603 u8 ss_DLevel[NumRates];
604 u8 count_judge[NumRates];
607 /*to get TX,RX retry count*/
608 struct gettxretrycnt_parm {
612 struct gettxretrycnt_rsp {
613 unsigned long tx_retrycnt;
616 struct getrxretrycnt_parm {
620 struct getrxretrycnt_rsp {
621 unsigned long rx_retrycnt;
624 /*to get BCNOK,BCNERR count*/
625 struct getbcnokcnt_parm {
629 struct getbcnokcnt_rsp {
630 unsigned long bcnokcnt;
633 struct getbcnerrcnt_parm {
636 struct getbcnerrcnt_rsp {
637 unsigned long bcnerrcnt;
640 /* to get current TX power level*/
641 struct getcurtxpwrlevel_parm {
645 struct getcurtxpwrlevel_rsp {
646 unsigned short tx_power;
649 /*dynamic on/off DIG*/
651 unsigned char dig_on; /* 1:on , 0:off */
654 /*dynamic on/off RA*/
656 unsigned char ra_on; /* 1:on , 0:off */
659 struct setprobereqextraie_parm {
661 unsigned char ie_len;
665 struct setassocreqextraie_parm {
667 unsigned char ie_len;
671 struct setproberspextraie_parm {
673 unsigned char ie_len;
677 struct setassocrspextraie_parm {
679 unsigned char ie_len;
683 struct addBaReq_parm {
687 /*H2C Handler index: 46 */
688 struct SetChannel_parm {
692 /*H2C Handler index: 61 */
693 struct DisconnectCtrlEx_param {
694 /* MAXTIME = (2 * FirstStageTO) + (TryPktCnt * TryPktInterval) */
695 unsigned char EnableDrvCtrl;
696 unsigned char TryPktCnt;
697 unsigned char TryPktInterval; /* Unit: ms */
699 unsigned int FirstStageTO; /* Unit: ms */
702 #define GEN_CMD_CODE(cmd) cmd ## _CMD_
707 * 0x01: success, and check Response.
708 * 0x02: cmd ignored due to duplicated sequence number
709 * 0x03: cmd dropped due to invalid cmd code
713 #define H2C_RSP_OFFSET 512
714 #define H2C_SUCCESS 0x00
715 #define H2C_SUCCESS_RSP 0x01
716 #define H2C_DUPLICATED 0x02
717 #define H2C_DROPPED 0x03
718 #define H2C_PARAMETERS_ERROR 0x04
719 #define H2C_REJECTED 0x05
720 #define H2C_CMD_OVERFLOW 0x06
721 #define H2C_RESERVED 0x07
723 u8 r8712_setMacAddr_cmd(struct _adapter *padapter, u8 *mac_addr);
724 u8 r8712_setassocsta_cmd(struct _adapter *padapter, u8 *mac_addr);
725 u8 r8712_sitesurvey_cmd(struct _adapter *padapter,
726 struct ndis_802_11_ssid *pssid);
727 u8 r8712_createbss_cmd(struct _adapter *padapter);
728 u8 r8712_setstakey_cmd(struct _adapter *padapter, u8 *psta, u8 unicast_key);
729 u8 r8712_joinbss_cmd(struct _adapter *padapter,
730 struct wlan_network *pnetwork);
731 u8 r8712_disassoc_cmd(struct _adapter *padapter);
732 u8 r8712_setopmode_cmd(struct _adapter *padapter,
733 enum NDIS_802_11_NETWORK_INFRASTRUCTURE networktype);
734 u8 r8712_setdatarate_cmd(struct _adapter *padapter, u8 *rateset);
735 u8 r8712_set_chplan_cmd(struct _adapter *padapter, int chplan);
736 u8 r8712_setbasicrate_cmd(struct _adapter *padapter, u8 *rateset);
737 u8 r8712_getrfreg_cmd(struct _adapter *padapter, u8 offset, u8 *pval);
738 u8 r8712_setrfintfs_cmd(struct _adapter *padapter, u8 mode);
739 u8 r8712_setrfreg_cmd(struct _adapter *padapter, u8 offset, u32 val);
740 u8 r8712_setrttbl_cmd(struct _adapter *padapter,
741 struct setratable_parm *prate_table);
742 u8 r8712_setfwdig_cmd(struct _adapter *padapter, u8 type);
743 u8 r8712_setfwra_cmd(struct _adapter *padapter, u8 type);
744 u8 r8712_addbareq_cmd(struct _adapter *padapter, u8 tid);
745 u8 r8712_wdg_wk_cmd(struct _adapter *padapter);
746 void r8712_survey_cmd_callback(struct _adapter *padapter,
747 struct cmd_obj *pcmd);
748 void r8712_disassoc_cmd_callback(struct _adapter *padapter,
749 struct cmd_obj *pcmd);
750 void r8712_joinbss_cmd_callback(struct _adapter *padapter,
751 struct cmd_obj *pcmd);
752 void r8712_createbss_cmd_callback(struct _adapter *padapter,
753 struct cmd_obj *pcmd);
754 void r8712_getbbrfreg_cmdrsp_callback(struct _adapter *padapter,
755 struct cmd_obj *pcmd);
756 void r8712_readtssi_cmdrsp_callback(struct _adapter *padapter,
757 struct cmd_obj *pcmd);
758 void r8712_setstaKey_cmdrsp_callback(struct _adapter *padapter,
759 struct cmd_obj *pcmd);
760 void r8712_setassocsta_cmdrsp_callback(struct _adapter *padapter,
761 struct cmd_obj *pcmd);
762 u8 r8712_disconnectCtrlEx_cmd(struct _adapter *adapter, u32 enableDrvCtrl,
763 u32 tryPktCnt, u32 tryPktInterval, u32 firstStageTO);
765 struct _cmd_callback {
767 void (*callback)(struct _adapter *padapter, struct cmd_obj *cmd);
770 #include "rtl8712_cmd.h"