1 // SPDX-License-Identifier: GPL-2.0
2 /******************************************************************************
4 * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
6 ******************************************************************************/
7 #define _RTL8188E_CMD_C_
9 #include <osdep_service.h>
10 #include <drv_types.h>
11 #include <recv_osdep.h>
12 #include <mlme_osdep.h>
13 #include <rtw_ioctl_set.h>
15 #include <rtl8188e_hal.h>
17 #define RTL88E_MAX_H2C_BOX_NUMS 4
18 #define RTL88E_MAX_CMD_LEN 7
19 #define RTL88E_MESSAGE_BOX_SIZE 4
20 #define RTL88E_EX_MESSAGE_BOX_SIZE 4
22 static u8 _is_fw_read_cmd_down(struct adapter *adapt, u8 msgbox_num)
30 valid = usb_read8(adapt, REG_HMETFR) & BIT(msgbox_num);
33 } while ((!read_down) && (retry_cnts--));
38 /*****************************************
41 *| 31 - 8 | 7-5 4 - 0 |
42 *| h2c_msg |Class_ID CMD_ID |
44 * Extend 0x1FF - 0x1F0
47 ******************************************/
48 static s32 FillH2CCmd_88E(struct adapter *adapt, u8 ElementID, u32 CmdLen, u8 *pCmdBuffer)
55 u8 cmd_idx, ext_cmd_len;
60 if (!adapt->bFWReady) {
61 DBG_88E("%s(): return H2C cmd because fw is not ready\n",
68 if (CmdLen > RTL88E_MAX_CMD_LEN)
70 if (adapt->bSurpriseRemoved)
73 /* pay attention to if race condition happened in H2C cmd setting. */
75 h2c_box_num = adapt->HalData->LastHMEBoxNum;
77 if (!_is_fw_read_cmd_down(adapt, h2c_box_num)) {
78 DBG_88E(" fw read cmd failed...\n");
82 *(u8 *)(&h2c_cmd) = ElementID;
85 memcpy((u8 *)(&h2c_cmd)+1, pCmdBuffer, CmdLen);
87 memcpy((u8 *)(&h2c_cmd)+1, pCmdBuffer, 3);
88 ext_cmd_len = CmdLen-3;
89 memcpy((u8 *)(&h2c_cmd_ex), pCmdBuffer+3, ext_cmd_len);
91 /* Write Ext command */
92 msgbox_ex_addr = REG_HMEBOX_EXT_0 + (h2c_box_num * RTL88E_EX_MESSAGE_BOX_SIZE);
93 for (cmd_idx = 0; cmd_idx < ext_cmd_len; cmd_idx++) {
94 usb_write8(adapt, msgbox_ex_addr+cmd_idx, *((u8 *)(&h2c_cmd_ex)+cmd_idx));
98 msgbox_addr = REG_HMEBOX_0 + (h2c_box_num * RTL88E_MESSAGE_BOX_SIZE);
99 for (cmd_idx = 0; cmd_idx < RTL88E_MESSAGE_BOX_SIZE; cmd_idx++) {
100 usb_write8(adapt, msgbox_addr+cmd_idx, *((u8 *)(&h2c_cmd)+cmd_idx));
104 adapt->HalData->LastHMEBoxNum =
105 (h2c_box_num+1) % RTL88E_MAX_H2C_BOX_NUMS;
107 } while ((!bcmd_down) && (retry_cnts--));
115 /* bitmap[0:27] = tx_rate_bitmap */
116 /* bitmap[28:31]= Rate Adaptive id */
117 /* arg[0:4] = macid */
118 /* arg[5] = Short GI */
119 void rtw_hal_add_ra_tid(struct adapter *pAdapter, u32 bitmap, u8 arg, u8 rssi_level)
121 struct odm_dm_struct *odmpriv = &pAdapter->HalData->odmpriv;
123 u8 macid, init_rate, raid, shortGIrate = false;
127 raid = (bitmap>>28) & 0x0f;
128 bitmap &= 0x0fffffff;
130 if (rssi_level != DM_RATR_STA_INIT)
131 bitmap = ODM_Get_Rate_Bitmap(odmpriv, macid, bitmap, rssi_level);
133 bitmap |= ((raid<<28)&0xf0000000);
135 init_rate = get_highest_rate_idx(bitmap&0x0fffffff)&0x3f;
137 shortGIrate = (arg & BIT(5)) ? true : false;
142 raid = (bitmap>>28) & 0x0f;
144 bitmap &= 0x0fffffff;
146 DBG_88E("%s=> mac_id:%d, raid:%d, ra_bitmap=0x%x, shortGIrate=0x%02x\n",
147 __func__, macid, raid, bitmap, shortGIrate);
149 ODM_RA_UpdateRateInfo_8188E(odmpriv, macid, raid, bitmap, shortGIrate);
152 void rtl8188e_set_FwPwrMode_cmd(struct adapter *adapt, u8 Mode)
154 struct setpwrmode_parm H2CSetPwrMode;
155 struct pwrctrl_priv *pwrpriv = &adapt->pwrctrlpriv;
156 u8 RLBM = 0; /* 0:Min, 1:Max, 2:User define */
158 DBG_88E("%s: Mode=%d SmartPS=%d UAPSD=%d\n", __func__,
159 Mode, pwrpriv->smart_ps, adapt->registrypriv.uapsd_enable);
163 H2CSetPwrMode.Mode = 0;
166 H2CSetPwrMode.Mode = 1;
170 H2CSetPwrMode.Mode = 1;
174 H2CSetPwrMode.Mode = 1;
176 case PS_MODE_UAPSD_WMM:
177 H2CSetPwrMode.Mode = 2;
180 H2CSetPwrMode.Mode = 0;
184 H2CSetPwrMode.SmartPS_RLBM = (((pwrpriv->smart_ps<<4)&0xf0) | (RLBM & 0x0f));
186 H2CSetPwrMode.AwakeInterval = 1;
188 H2CSetPwrMode.bAllQueueUAPSD = adapt->registrypriv.uapsd_enable;
191 H2CSetPwrMode.PwrState = 0x00;/* AllON(0x0C), RFON(0x04), RFOFF(0x00) */
193 H2CSetPwrMode.PwrState = 0x0C;/* AllON(0x0C), RFON(0x04), RFOFF(0x00) */
195 FillH2CCmd_88E(adapt, H2C_PS_PWR_MODE, sizeof(H2CSetPwrMode), (u8 *)&H2CSetPwrMode);
198 void rtl8188e_set_FwMediaStatus_cmd(struct adapter *adapt, __le16 mstatus_rpt)
201 u16 mst_rpt = le16_to_cpu(mstatus_rpt);
203 opmode = (u8)mst_rpt;
204 macid = (u8)(mst_rpt >> 8);
206 DBG_88E("### %s: MStatus=%x MACID=%d\n", __func__, opmode, macid);
207 FillH2CCmd_88E(adapt, H2C_COM_MEDIA_STATUS_RPT, sizeof(mst_rpt), (u8 *)&mst_rpt);
210 static void ConstructBeacon(struct adapter *adapt, u8 *pframe, u32 *pLength)
212 struct ieee80211_hdr *pwlanhdr;
214 u32 rate_len, pktlen;
215 struct mlme_ext_priv *pmlmeext = &(adapt->mlmeextpriv);
216 struct mlme_ext_info *pmlmeinfo = &(pmlmeext->mlmext_info);
217 struct wlan_bssid_ex *cur_network = &(pmlmeinfo->network);
218 u8 bc_addr[] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
220 pwlanhdr = (struct ieee80211_hdr *)pframe;
222 fctrl = &pwlanhdr->frame_control;
225 ether_addr_copy(pwlanhdr->addr1, bc_addr);
226 ether_addr_copy(pwlanhdr->addr2, myid(&(adapt->eeprompriv)));
227 ether_addr_copy(pwlanhdr->addr3, cur_network->MacAddress);
229 SetSeqNum(pwlanhdr, 0/*pmlmeext->mgnt_seq*/);
230 SetFrameSubType(pframe, WIFI_BEACON);
232 pframe += sizeof(struct ieee80211_hdr_3addr);
233 pktlen = sizeof(struct ieee80211_hdr_3addr);
235 /* timestamp will be inserted by hardware */
239 /* beacon interval: 2 bytes */
240 memcpy(pframe, (unsigned char *)(rtw_get_beacon_interval_from_ie(cur_network->ies)), 2);
245 /* capability info: 2 bytes */
246 memcpy(pframe, (unsigned char *)(rtw_get_capability_from_ie(cur_network->ies)), 2);
251 if ((pmlmeinfo->state&0x03) == WIFI_FW_AP_STATE) {
252 pktlen += cur_network->ie_length - sizeof(struct ndis_802_11_fixed_ie);
253 memcpy(pframe, cur_network->ies+sizeof(struct ndis_802_11_fixed_ie), pktlen);
255 goto _ConstructBeacon;
258 /* below for ad-hoc mode */
261 pframe = rtw_set_ie(pframe, _SSID_IE_, cur_network->Ssid.SsidLength, cur_network->Ssid.Ssid, &pktlen);
263 /* supported rates... */
264 rate_len = rtw_get_rateset_len(cur_network->SupportedRates);
265 pframe = rtw_set_ie(pframe, _SUPPORTEDRATES_IE_, min_t(u32, rate_len, 8), cur_network->SupportedRates, &pktlen);
267 /* DS parameter set */
268 pframe = rtw_set_ie(pframe, _DSSET_IE_, 1, (unsigned char *)&(cur_network->Configuration.DSConfig), &pktlen);
270 if ((pmlmeinfo->state&0x03) == WIFI_FW_ADHOC_STATE) {
272 /* IBSS Parameter Set... */
274 pframe = rtw_set_ie(pframe, _IBSS_PARA_IE_, 2, (unsigned char *)(&ATIMWindow), &pktlen);
279 /* EXTERNDED SUPPORTED RATE */
281 pframe = rtw_set_ie(pframe, _EXT_SUPPORTEDRATES_IE_, (rate_len - 8), (cur_network->SupportedRates + 8), &pktlen);
283 /* todo:HT for adhoc */
287 if ((pktlen + TXDESC_SIZE) > 512) {
288 DBG_88E("beacon frame too large\n");
295 static void ConstructPSPoll(struct adapter *adapt, u8 *pframe, u32 *pLength)
297 struct ieee80211_hdr *pwlanhdr;
298 struct mlme_ext_priv *pmlmeext = &(adapt->mlmeextpriv);
299 struct mlme_ext_info *pmlmeinfo = &(pmlmeext->mlmext_info);
301 struct wlan_bssid_ex *pnetwork = &(pmlmeinfo->network);
303 pwlanhdr = (struct ieee80211_hdr *)pframe;
306 fctrl = &pwlanhdr->frame_control;
309 SetFrameSubType(pframe, WIFI_PSPOLL);
312 SetDuration(pframe, (pmlmeinfo->aid | 0xc000));
315 ether_addr_copy(pwlanhdr->addr1, pnetwork->MacAddress);
318 ether_addr_copy(pwlanhdr->addr2, myid(&(adapt->eeprompriv)));
323 static void ConstructNullFunctionData(struct adapter *adapt, u8 *pframe,
331 struct ieee80211_hdr *pwlanhdr;
334 struct mlme_priv *pmlmepriv = &adapt->mlmepriv;
335 struct wlan_network *cur_network = &pmlmepriv->cur_network;
336 struct mlme_ext_priv *pmlmeext = &(adapt->mlmeextpriv);
337 struct mlme_ext_info *pmlmeinfo = &(pmlmeext->mlmext_info);
338 struct wlan_bssid_ex *pnetwork = &(pmlmeinfo->network);
340 pwlanhdr = (struct ieee80211_hdr *)pframe;
342 fctrl = &pwlanhdr->frame_control;
347 switch (cur_network->network.InfrastructureMode) {
348 case Ndis802_11Infrastructure:
350 ether_addr_copy(pwlanhdr->addr1, pnetwork->MacAddress);
351 ether_addr_copy(pwlanhdr->addr2, myid(&(adapt->eeprompriv)));
352 ether_addr_copy(pwlanhdr->addr3, StaAddr);
354 case Ndis802_11APMode:
356 ether_addr_copy(pwlanhdr->addr1, StaAddr);
357 ether_addr_copy(pwlanhdr->addr2, pnetwork->MacAddress);
358 ether_addr_copy(pwlanhdr->addr3, myid(&(adapt->eeprompriv)));
362 ether_addr_copy(pwlanhdr->addr1, StaAddr);
363 ether_addr_copy(pwlanhdr->addr2, myid(&(adapt->eeprompriv)));
364 ether_addr_copy(pwlanhdr->addr3, pnetwork->MacAddress);
368 SetSeqNum(pwlanhdr, 0);
371 struct ieee80211_qos_hdr *pwlanqoshdr;
373 SetFrameSubType(pframe, WIFI_QOS_DATA_NULL);
375 pwlanqoshdr = (struct ieee80211_qos_hdr *)pframe;
376 SetPriority(&pwlanqoshdr->qos_ctrl, AC);
377 SetEOSP(&pwlanqoshdr->qos_ctrl, bEosp);
379 pktlen = sizeof(struct ieee80211_qos_hdr);
381 SetFrameSubType(pframe, WIFI_DATA_NULL);
383 pktlen = sizeof(struct ieee80211_hdr_3addr);
389 static void ConstructProbeRsp(struct adapter *adapt, u8 *pframe, u32 *pLength, u8 *StaAddr, bool bHideSSID)
391 struct ieee80211_hdr *pwlanhdr;
395 struct mlme_ext_priv *pmlmeext = &(adapt->mlmeextpriv);
396 struct mlme_ext_info *pmlmeinfo = &(pmlmeext->mlmext_info);
397 struct wlan_bssid_ex *cur_network = &(pmlmeinfo->network);
399 pwlanhdr = (struct ieee80211_hdr *)pframe;
401 mac = myid(&(adapt->eeprompriv));
402 bssid = cur_network->MacAddress;
404 fctrl = &pwlanhdr->frame_control;
406 ether_addr_copy(pwlanhdr->addr1, StaAddr);
407 ether_addr_copy(pwlanhdr->addr2, mac);
408 ether_addr_copy(pwlanhdr->addr3, bssid);
410 SetSeqNum(pwlanhdr, 0);
411 SetFrameSubType(fctrl, WIFI_PROBERSP);
413 pktlen = sizeof(struct ieee80211_hdr_3addr);
416 if (cur_network->ie_length > MAX_IE_SZ)
419 memcpy(pframe, cur_network->ies, cur_network->ie_length);
420 pframe += cur_network->ie_length;
421 pktlen += cur_network->ie_length;
427 /* Description: Fill the reserved packets that FW will use to RSVD page. */
428 /* Now we just send 4 types packet to rsvd page. */
429 /* (1)Beacon, (2)Ps-poll, (3)Null data, (4)ProbeRsp. */
431 /* bDLFinished - false: At the first time we will send all the packets as a large packet to Hw, */
432 /* so we need to set the packet length to total length. */
433 /* true: At the second time, we should send the first packet (default:beacon) */
434 /* to Hw again and set the length in descriptor to the real beacon length. */
435 /* 2009.10.15 by tynli. */
436 static void SetFwRsvdPagePkt(struct adapter *adapt, bool bDLFinished)
438 struct xmit_frame *pmgntframe;
439 struct pkt_attrib *pattrib;
440 struct xmit_priv *pxmitpriv;
441 struct mlme_ext_priv *pmlmeext;
442 struct mlme_ext_info *pmlmeinfo;
443 u32 BeaconLength = 0, ProbeRspLength = 0, PSPollLength;
444 u32 NullDataLength, QosNullLength;
445 u8 *ReservedPagePacket;
446 u8 PageNum, PageNeed, TxDescLen;
449 struct rsvdpage_loc RsvdPageLoc;
450 struct wlan_bssid_ex *pnetwork;
452 DBG_88E("%s\n", __func__);
453 ReservedPagePacket = kzalloc(1000, GFP_KERNEL);
454 if (!ReservedPagePacket) {
455 DBG_88E("%s: alloc ReservedPagePacket fail!\n", __func__);
459 pxmitpriv = &adapt->xmitpriv;
460 pmlmeext = &adapt->mlmeextpriv;
461 pmlmeinfo = &pmlmeext->mlmext_info;
462 pnetwork = &(pmlmeinfo->network);
464 TxDescLen = TXDESC_SIZE;
467 /* 3 (1) beacon * 2 pages */
468 BufIndex = TXDESC_OFFSET;
469 ConstructBeacon(adapt, &ReservedPagePacket[BufIndex], &BeaconLength);
471 /* When we count the first page size, we need to reserve description size for the RSVD */
472 /* packet, it will be filled in front of the packet in TXPKTBUF. */
473 PageNeed = (u8)PageNum_128(TxDescLen + BeaconLength);
474 /* To reserved 2 pages for beacon buffer. 2010.06.24. */
478 adapt->HalData->FwRsvdPageStartOffset = PageNum;
480 BufIndex += PageNeed*128;
482 /* 3 (2) ps-poll *1 page */
483 RsvdPageLoc.LocPsPoll = PageNum;
484 ConstructPSPoll(adapt, &ReservedPagePacket[BufIndex], &PSPollLength);
485 rtl8188e_fill_fake_txdesc(adapt, &ReservedPagePacket[BufIndex-TxDescLen], PSPollLength, true, false);
487 PageNeed = (u8)PageNum_128(TxDescLen + PSPollLength);
490 BufIndex += PageNeed*128;
492 /* 3 (3) null data * 1 page */
493 RsvdPageLoc.LocNullData = PageNum;
494 ConstructNullFunctionData(adapt, &ReservedPagePacket[BufIndex], &NullDataLength, pnetwork->MacAddress, false, 0, 0, false);
495 rtl8188e_fill_fake_txdesc(adapt, &ReservedPagePacket[BufIndex-TxDescLen], NullDataLength, false, false);
497 PageNeed = (u8)PageNum_128(TxDescLen + NullDataLength);
500 BufIndex += PageNeed*128;
502 /* 3 (4) probe response * 1page */
503 RsvdPageLoc.LocProbeRsp = PageNum;
504 ConstructProbeRsp(adapt, &ReservedPagePacket[BufIndex], &ProbeRspLength, pnetwork->MacAddress, false);
505 rtl8188e_fill_fake_txdesc(adapt, &ReservedPagePacket[BufIndex-TxDescLen], ProbeRspLength, false, false);
507 PageNeed = (u8)PageNum_128(TxDescLen + ProbeRspLength);
510 BufIndex += PageNeed*128;
512 /* 3 (5) Qos null data */
513 RsvdPageLoc.LocQosNull = PageNum;
514 ConstructNullFunctionData(adapt, &ReservedPagePacket[BufIndex],
515 &QosNullLength, pnetwork->MacAddress, true, 0, 0, false);
516 rtl8188e_fill_fake_txdesc(adapt, &ReservedPagePacket[BufIndex-TxDescLen], QosNullLength, false, false);
518 PageNeed = (u8)PageNum_128(TxDescLen + QosNullLength);
521 TotalPacketLen = BufIndex + QosNullLength;
522 pmgntframe = alloc_mgtxmitframe(pxmitpriv);
526 /* update attribute */
527 pattrib = &pmgntframe->attrib;
528 update_mgntframe_attrib(adapt, pattrib);
529 pattrib->qsel = 0x10;
530 pattrib->last_txcmdsz = TotalPacketLen - TXDESC_OFFSET;
531 pattrib->pktlen = pattrib->last_txcmdsz;
532 memcpy(pmgntframe->buf_addr, ReservedPagePacket, TotalPacketLen);
534 rtw_hal_mgnt_xmit(adapt, pmgntframe);
536 DBG_88E("%s: Set RSVD page location to Fw\n", __func__);
537 FillH2CCmd_88E(adapt, H2C_COM_RSVD_PAGE, sizeof(RsvdPageLoc), (u8 *)&RsvdPageLoc);
540 kfree(ReservedPagePacket);
543 void rtl8188e_set_FwJoinBssReport_cmd(struct adapter *adapt, u8 mstatus)
545 struct hal_data_8188e *haldata = adapt->HalData;
546 struct mlme_ext_priv *pmlmeext = &(adapt->mlmeextpriv);
547 struct mlme_ext_info *pmlmeinfo = &(pmlmeext->mlmext_info);
548 bool bSendBeacon = false;
549 bool bcn_valid = false;
553 DBG_88E("%s mstatus(%x)\n", __func__, mstatus);
556 /* We should set AID, correct TSF, HW seq enable before set JoinBssReport to Fw in 88/92C. */
557 /* Suggested by filen. Added by tynli. */
558 usb_write16(adapt, REG_BCN_PSR_RPT, (0xC000|pmlmeinfo->aid));
559 /* Do not set TSF again here or vWiFi beacon DMA INT will not work. */
561 /* Set REG_CR bit 8. DMA beacon by SW. */
562 haldata->RegCR_1 |= BIT(0);
563 usb_write8(adapt, REG_CR+1, haldata->RegCR_1);
565 /* Disable Hw protection for a time which revserd for Hw sending beacon. */
566 /* Fix download reserved page packet fail that access collision with the protection time. */
567 /* 2010.05.11. Added by tynli. */
568 usb_write8(adapt, REG_BCN_CTRL, usb_read8(adapt, REG_BCN_CTRL)&(~BIT(3)));
569 usb_write8(adapt, REG_BCN_CTRL, usb_read8(adapt, REG_BCN_CTRL) | BIT(4));
571 if (haldata->RegFwHwTxQCtrl & BIT(6)) {
572 DBG_88E("HalDownloadRSVDPage(): There is an Adapter is sending beacon.\n");
576 /* Set FWHW_TXQ_CTRL 0x422[6]=0 to tell Hw the packet is not a real beacon frame. */
577 usb_write8(adapt, REG_FWHW_TXQ_CTRL+2, (haldata->RegFwHwTxQCtrl&(~BIT(6))));
578 haldata->RegFwHwTxQCtrl &= (~BIT(6));
580 /* Clear beacon valid check bit. */
581 rtw_hal_set_hwreg(adapt, HW_VAR_BCN_VALID, NULL);
585 /* download rsvd page. */
586 SetFwRsvdPagePkt(adapt, false);
591 /* check rsvd page download OK. */
592 rtw_hal_get_hwreg(adapt, HW_VAR_BCN_VALID, (u8 *)(&bcn_valid));
594 } while (!bcn_valid && (poll%10) != 0 && !adapt->bSurpriseRemoved && !adapt->bDriverStopped);
595 } while (!bcn_valid && DLBcnCount <= 100 && !adapt->bSurpriseRemoved && !adapt->bDriverStopped);
597 if (adapt->bSurpriseRemoved || adapt->bDriverStopped)
600 DBG_88E("%s: 1 Download RSVD page failed! DLBcnCount:%u, poll:%u\n", __func__, DLBcnCount, poll);
602 DBG_88E("%s: 1 Download RSVD success! DLBcnCount:%u, poll:%u\n", __func__, DLBcnCount, poll);
604 /* We just can send the reserved page twice during the time that Tx thread is stopped (e.g. pnpsetpower) */
605 /* because we need to free the Tx BCN Desc which is used by the first reserved page packet. */
606 /* At run time, we cannot get the Tx Desc until it is released in TxHandleInterrupt() so we will return */
607 /* the beacon TCB in the following code. 2011.11.23. by tynli. */
611 usb_write8(adapt, REG_BCN_CTRL, usb_read8(adapt, REG_BCN_CTRL) | BIT(3));
612 usb_write8(adapt, REG_BCN_CTRL, usb_read8(adapt, REG_BCN_CTRL)&(~BIT(4)));
614 /* To make sure that if there exists an adapter which would like to send beacon. */
615 /* If exists, the origianl value of 0x422[6] will be 1, we should check this to */
616 /* prevent from setting 0x422[6] to 0 after download reserved page, or it will cause */
617 /* the beacon cannot be sent by HW. */
618 /* 2010.06.23. Added by tynli. */
620 usb_write8(adapt, REG_FWHW_TXQ_CTRL+2, (haldata->RegFwHwTxQCtrl | BIT(6)));
621 haldata->RegFwHwTxQCtrl |= BIT(6);
624 /* Update RSVD page location H2C to Fw. */
626 rtw_hal_set_hwreg(adapt, HW_VAR_BCN_VALID, NULL);
627 DBG_88E("Set RSVD page location to Fw.\n");
630 /* Do not enable HW DMA BCN or it will cause Pcie interface hang by timing issue. 2011.11.24. by tynli. */
631 /* Clear CR[8] or beacon packet will not be send to TxBuf anymore. */
632 haldata->RegCR_1 &= (~BIT(0));
633 usb_write8(adapt, REG_CR+1, haldata->RegCR_1);