1// SPDX-License-Identifier: GPL-2.0
2/******************************************************************************
3 * os_intfs.c
4 *
5 * Copyright(c) 2007 - 2010 Realtek Corporation. All rights reserved.
6 * Linux device driver for RTL8192SU
7 *
8 * Modifications for inclusion into the Linux staging tree are
9 * Copyright(c) 2010 Larry Finger. All rights reserved.
10 *
11 * Contact information:
12 * WLAN FAE <wlanfae@realtek.com>.
13 * Larry Finger <Larry.Finger@lwfinger.net>
14 *
15 ******************************************************************************/
16
17#define _OS_INTFS_C_
18
19#include <linux/module.h>
20#include <linux/kthread.h>
21#include <linux/firmware.h>
22#include "osdep_service.h"
23#include "drv_types.h"
24#include "xmit_osdep.h"
25#include "recv_osdep.h"
26#include "rtl871x_ioctl.h"
27#include "usb_osintf.h"
28
29MODULE_LICENSE("GPL");
30MODULE_DESCRIPTION("rtl871x wireless lan driver");
31MODULE_AUTHOR("Larry Finger");
32
33static char ifname[IFNAMSIZ] = "wlan%d";
34
35/* module param defaults */
36static int chip_version = RTL8712_2ndCUT;
37static int rfintfs = HWPI;
38static int lbkmode = RTL8712_AIR_TRX;
39static int hci = RTL8712_USB;
40static int ampdu_enable = 1;/*for enable tx_ampdu*/
41
42/* The video_mode variable is for video mode.*/
43/* It may be specify when inserting module with video_mode=1 parameter.*/
44static int video_mode = 1;   /* enable video mode*/
45
46/*Ndis802_11Infrastructure; infra, ad-hoc, auto*/
47static int network_mode = Ndis802_11IBSS;
48static int channel = 1;/*ad-hoc support requirement*/
49static int wireless_mode = WIRELESS_11BG;
50static int vrtl_carrier_sense = AUTO_VCS;
51static int vcs_type = RTS_CTS;
52static int frag_thresh = 2346;
53static int preamble = PREAMBLE_LONG;/*long, short, auto*/
54static int scan_mode = 1;/*active, passive*/
55static int adhoc_tx_pwr = 1;
56static int soft_ap;
57static int smart_ps = 1;
58static int power_mgnt = PS_MODE_ACTIVE;
59static int radio_enable = 1;
60static int long_retry_lmt = 7;
61static int short_retry_lmt = 7;
62static int busy_thresh = 40;
63static int ack_policy = NORMAL_ACK;
64static int mp_mode;
65static int software_encrypt;
66static int software_decrypt;
67
68static int wmm_enable;/* default is set to disable the wmm.*/
69static int uapsd_enable;
70static int uapsd_max_sp = NO_LIMIT;
71static int uapsd_acbk_en;
72static int uapsd_acbe_en;
73static int uapsd_acvi_en;
74static int uapsd_acvo_en;
75
76static int ht_enable = 1;
77static int cbw40_enable = 1;
78static int rf_config = RTL8712_RF_1T2R;  /* 1T2R*/
79static int low_power;
80/* mac address to use instead of the one stored in Efuse */
81char *r8712_initmac;
82static char *initmac;
83/* if wifi_test = 1, driver will disable the turbo mode and pass it to
84 * firmware private.
85 */
86static int wifi_test;
87
88module_param_string(ifname, ifname, sizeof(ifname), 0644);
89module_param(wifi_test, int, 0644);
90module_param(initmac, charp, 0644);
91module_param(video_mode, int, 0644);
92module_param(chip_version, int, 0644);
93module_param(rfintfs, int, 0644);
94module_param(lbkmode, int, 0644);
95module_param(hci, int, 0644);
96module_param(network_mode, int, 0644);
97module_param(channel, int, 0644);
98module_param(mp_mode, int, 0644);
99module_param(wmm_enable, int, 0644);
100module_param(vrtl_carrier_sense, int, 0644);
101module_param(vcs_type, int, 0644);
102module_param(busy_thresh, int, 0644);
103module_param(ht_enable, int, 0644);
104module_param(cbw40_enable, int, 0644);
105module_param(ampdu_enable, int, 0644);
106module_param(rf_config, int, 0644);
107module_param(power_mgnt, int, 0644);
108module_param(low_power, int, 0644);
109
110MODULE_PARM_DESC(ifname, " Net interface name, wlan%d=default");
111MODULE_PARM_DESC(initmac, "MAC-Address, default: use FUSE");
112
113static int netdev_open(struct net_device *pnetdev);
114static int netdev_close(struct net_device *pnetdev);
115
116static void loadparam(struct _adapter *padapter, struct  net_device *pnetdev)
117{
118	struct registry_priv  *registry_par = &padapter->registrypriv;
119
120	registry_par->chip_version = (u8)chip_version;
121	registry_par->rfintfs = (u8)rfintfs;
122	registry_par->lbkmode = (u8)lbkmode;
123	registry_par->hci = (u8)hci;
124	registry_par->network_mode  = (u8)network_mode;
125	memcpy(registry_par->ssid.Ssid, "ANY", 3);
126	registry_par->ssid.SsidLength = 3;
127	registry_par->channel = (u8)channel;
128	registry_par->wireless_mode = (u8)wireless_mode;
129	registry_par->vrtl_carrier_sense = (u8)vrtl_carrier_sense;
130	registry_par->vcs_type = (u8)vcs_type;
131	registry_par->frag_thresh = (u16)frag_thresh;
132	registry_par->preamble = (u8)preamble;
133	registry_par->scan_mode = (u8)scan_mode;
134	registry_par->adhoc_tx_pwr = (u8)adhoc_tx_pwr;
135	registry_par->soft_ap = (u8)soft_ap;
136	registry_par->smart_ps = (u8)smart_ps;
137	registry_par->power_mgnt = (u8)power_mgnt;
138	registry_par->radio_enable = (u8)radio_enable;
139	registry_par->long_retry_lmt = (u8)long_retry_lmt;
140	registry_par->short_retry_lmt = (u8)short_retry_lmt;
141	registry_par->busy_thresh = (u16)busy_thresh;
142	registry_par->ack_policy = (u8)ack_policy;
143	registry_par->mp_mode = (u8)mp_mode;
144	registry_par->software_encrypt = (u8)software_encrypt;
145	registry_par->software_decrypt = (u8)software_decrypt;
146	/*UAPSD*/
147	registry_par->wmm_enable = (u8)wmm_enable;
148	registry_par->uapsd_enable = (u8)uapsd_enable;
149	registry_par->uapsd_max_sp = (u8)uapsd_max_sp;
150	registry_par->uapsd_acbk_en = (u8)uapsd_acbk_en;
151	registry_par->uapsd_acbe_en = (u8)uapsd_acbe_en;
152	registry_par->uapsd_acvi_en = (u8)uapsd_acvi_en;
153	registry_par->uapsd_acvo_en = (u8)uapsd_acvo_en;
154	registry_par->ht_enable = (u8)ht_enable;
155	registry_par->cbw40_enable = (u8)cbw40_enable;
156	registry_par->ampdu_enable = (u8)ampdu_enable;
157	registry_par->rf_config = (u8)rf_config;
158	registry_par->low_power = (u8)low_power;
159	registry_par->wifi_test = (u8)wifi_test;
160	r8712_initmac = initmac;
161}
162
163static int r871x_net_set_mac_address(struct net_device *pnetdev, void *p)
164{
165	struct _adapter *padapter = netdev_priv(pnetdev);
166	struct sockaddr *addr = p;
167
168	if (!padapter->bup)
169		eth_hw_addr_set(pnetdev, addr->sa_data);
170	return 0;
171}
172
173static struct net_device_stats *r871x_net_get_stats(struct net_device *pnetdev)
174{
175	struct _adapter *padapter = netdev_priv(pnetdev);
176	struct xmit_priv *pxmitpriv = &padapter->xmitpriv;
177	struct recv_priv *precvpriv = &padapter->recvpriv;
178
179	padapter->stats.tx_packets = pxmitpriv->tx_pkts;
180	padapter->stats.rx_packets = precvpriv->rx_pkts;
181	padapter->stats.tx_dropped = pxmitpriv->tx_drop;
182	padapter->stats.rx_dropped = precvpriv->rx_drop;
183	padapter->stats.tx_bytes = pxmitpriv->tx_bytes;
184	padapter->stats.rx_bytes = precvpriv->rx_bytes;
185	return &padapter->stats;
186}
187
188static const struct net_device_ops rtl8712_netdev_ops = {
189	.ndo_open = netdev_open,
190	.ndo_stop = netdev_close,
191	.ndo_start_xmit = r8712_xmit_entry,
192	.ndo_set_mac_address = r871x_net_set_mac_address,
193	.ndo_get_stats = r871x_net_get_stats,
194	.ndo_do_ioctl = r871x_ioctl,
195};
196
197struct net_device *r8712_init_netdev(void)
198{
199	struct _adapter *padapter;
200	struct net_device *pnetdev;
201
202	pnetdev = alloc_etherdev(sizeof(struct _adapter));
203	if (!pnetdev)
204		return NULL;
205	if (dev_alloc_name(pnetdev, ifname) < 0) {
206		strscpy(ifname, "wlan%d", sizeof(ifname));
207		dev_alloc_name(pnetdev, ifname);
208	}
209	padapter = netdev_priv(pnetdev);
210	padapter->pnetdev = pnetdev;
211	pr_info("r8712u: register rtl8712_netdev_ops to netdev_ops\n");
212	pnetdev->netdev_ops = &rtl8712_netdev_ops;
213	pnetdev->watchdog_timeo = HZ; /* 1 second timeout */
214	pnetdev->wireless_handlers = (struct iw_handler_def *)
215				     &r871x_handlers_def;
216	loadparam(padapter, pnetdev);
217	netif_carrier_off(pnetdev);
218	padapter->pid = 0;  /* Initial the PID value used for HW PBC.*/
219	return pnetdev;
220}
221
222static u32 start_drv_threads(struct _adapter *padapter)
223{
224	padapter->cmd_thread = kthread_run(r8712_cmd_thread, padapter, "%s", padapter->pnetdev->name);
225	if (IS_ERR(padapter->cmd_thread))
226		return _FAIL;
227	return _SUCCESS;
228}
229
230void r8712_stop_drv_threads(struct _adapter *padapter)
231{
232	struct completion *completion =
233		&padapter->cmdpriv.terminate_cmdthread_comp;
234
235	/*Below is to terminate r8712_cmd_thread & event_thread...*/
236	complete(&padapter->cmdpriv.cmd_queue_comp);
237	if (padapter->cmd_thread)
238		wait_for_completion_interruptible(completion);
239	padapter->cmdpriv.cmd_seq = 1;
240}
241
242static void start_drv_timers(struct _adapter *padapter)
243{
244	mod_timer(&padapter->mlmepriv.sitesurveyctrl.sitesurvey_ctrl_timer,
245		  jiffies + msecs_to_jiffies(5000));
246	mod_timer(&padapter->mlmepriv.wdg_timer,
247		  jiffies + msecs_to_jiffies(2000));
248}
249
250void r8712_stop_drv_timers(struct _adapter *padapter)
251{
252	del_timer_sync(&padapter->mlmepriv.assoc_timer);
253	del_timer_sync(&padapter->securitypriv.tkip_timer);
254	del_timer_sync(&padapter->mlmepriv.scan_to_timer);
255	del_timer_sync(&padapter->mlmepriv.dhcp_timer);
256	del_timer_sync(&padapter->mlmepriv.wdg_timer);
257	del_timer_sync(&padapter->mlmepriv.sitesurveyctrl.sitesurvey_ctrl_timer);
258}
259
260static void init_default_value(struct _adapter *padapter)
261{
262	struct registry_priv *pregistrypriv = &padapter->registrypriv;
263	struct xmit_priv *pxmitpriv = &padapter->xmitpriv;
264	struct mlme_priv *pmlmepriv = &padapter->mlmepriv;
265	struct security_priv *psecuritypriv = &padapter->securitypriv;
266
267	/*xmit_priv*/
268	pxmitpriv->vcs_setting = pregistrypriv->vrtl_carrier_sense;
269	pxmitpriv->vcs = pregistrypriv->vcs_type;
270	pxmitpriv->vcs_type = pregistrypriv->vcs_type;
271	pxmitpriv->rts_thresh = pregistrypriv->rts_thresh;
272	pxmitpriv->frag_len = pregistrypriv->frag_thresh;
273	/* mlme_priv */
274	/* Maybe someday we should rename this variable to "active_mode"(Jeff)*/
275	pmlmepriv->passive_mode = 1; /* 1: active, 0: passive. */
276	/*ht_priv*/
277	{
278		int i;
279		struct ht_priv	 *phtpriv = &pmlmepriv->htpriv;
280
281		phtpriv->ampdu_enable = false;/*set to disabled*/
282		for (i = 0; i < 16; i++)
283			phtpriv->baddbareq_issued[i] = false;
284	}
285	/*security_priv*/
286	psecuritypriv->sw_encrypt = pregistrypriv->software_encrypt;
287	psecuritypriv->sw_decrypt = pregistrypriv->software_decrypt;
288	psecuritypriv->binstallGrpkey = _FAIL;
289	/*pwrctrl_priv*/
290	/*registry_priv*/
291	r8712_init_registrypriv_dev_network(padapter);
292	r8712_update_registrypriv_dev_network(padapter);
293	/*misc.*/
294}
295
296int r8712_init_drv_sw(struct _adapter *padapter)
297{
298	int ret;
299
300	ret = r8712_init_cmd_priv(&padapter->cmdpriv);
301	if (ret)
302		return ret;
303	padapter->cmdpriv.padapter = padapter;
304	ret = r8712_init_evt_priv(&padapter->evtpriv);
305	if (ret)
306		goto free_cmd;
307	ret = r8712_init_mlme_priv(padapter);
308	if (ret)
309		goto free_evt;
310	ret = _r8712_init_xmit_priv(&padapter->xmitpriv, padapter);
311	if (ret)
312		goto free_mlme;
313	ret = _r8712_init_recv_priv(&padapter->recvpriv, padapter);
314	if (ret)
315		goto free_xmit;
316	memset((unsigned char *)&padapter->securitypriv, 0,
317	       sizeof(struct security_priv));
318	timer_setup(&padapter->securitypriv.tkip_timer,
319		    r8712_use_tkipkey_handler, 0);
320	ret = _r8712_init_sta_priv(&padapter->stapriv);
321	if (ret)
322		goto free_recv;
323	padapter->stapriv.padapter = padapter;
324	r8712_init_bcmc_stainfo(padapter);
325	r8712_init_pwrctrl_priv(padapter);
326	mp871xinit(padapter);
327	init_default_value(padapter);
328	r8712_InitSwLeds(padapter);
329	mutex_init(&padapter->mutex_start);
330
331	return 0;
332
333free_recv:
334	_r8712_free_recv_priv(&padapter->recvpriv);
335free_xmit:
336	_free_xmit_priv(&padapter->xmitpriv);
337free_mlme:
338	r8712_free_mlme_priv(&padapter->mlmepriv);
339free_evt:
340	r8712_free_evt_priv(&padapter->evtpriv);
341free_cmd:
342	r8712_free_cmd_priv(&padapter->cmdpriv);
343	return ret;
344}
345
346void r8712_free_drv_sw(struct _adapter *padapter)
347{
348	r8712_free_cmd_priv(&padapter->cmdpriv);
349	r8712_free_evt_priv(&padapter->evtpriv);
350	r8712_DeInitSwLeds(padapter);
351	r8712_free_mlme_priv(&padapter->mlmepriv);
352	_free_xmit_priv(&padapter->xmitpriv);
353	_r8712_free_sta_priv(&padapter->stapriv);
354	_r8712_free_recv_priv(&padapter->recvpriv);
355	mp871xdeinit(padapter);
356}
357
358static void enable_video_mode(struct _adapter *padapter, int cbw40_value)
359{
360	/*   bit 8:
361	 *   1 -> enable video mode to 96B AP
362	 *   0 -> disable video mode to 96B AP
363	 *   bit 9:
364	 *   1 -> enable 40MHz mode
365	 *   0 -> disable 40MHz mode
366	 *   bit 10:
367	 *   1 -> enable STBC
368	 *   0 -> disable STBC
369	 */
370	u32  intcmd = 0xf4000500;   /* enable bit8, bit10*/
371
372	if (cbw40_value) {
373		/* if the driver supports the 40M bandwidth,
374		 * we can enable the bit 9.
375		 */
376		intcmd |= 0x200;
377	}
378	r8712_fw_cmd(padapter, intcmd);
379}
380
381/*
382 *
383 * This function intends to handle the activation of an interface
384 * i.e. when it is brought Up/Active from a Down state.
385 *
386 */
387static int netdev_open(struct net_device *pnetdev)
388{
389	struct _adapter *padapter = netdev_priv(pnetdev);
390
391	mutex_lock(&padapter->mutex_start);
392	if (!padapter->bup) {
393		padapter->driver_stopped = false;
394		padapter->surprise_removed = false;
395		padapter->bup = true;
396		if (rtl871x_hal_init(padapter) != _SUCCESS)
397			goto netdev_open_error;
398		if (!r8712_initmac) {
399			/* Use the mac address stored in the Efuse */
400			eth_hw_addr_set(pnetdev,
401					padapter->eeprompriv.mac_addr);
402		} else {
403			/* We have to inform f/w to use user-supplied MAC
404			 * address.
405			 */
406			msleep(200);
407			r8712_setMacAddr_cmd(padapter,
408					     (const u8 *)pnetdev->dev_addr);
409			/*
410			 * The "myid" function will get the wifi mac address
411			 * from eeprompriv structure instead of netdev
412			 * structure. So, we have to overwrite the mac_addr
413			 * stored in the eeprompriv structure. In this case,
414			 * the real mac address won't be used anymore. So that,
415			 * the eeprompriv.mac_addr should store the mac which
416			 * users specify.
417			 */
418			memcpy(padapter->eeprompriv.mac_addr,
419			       pnetdev->dev_addr, ETH_ALEN);
420		}
421		if (start_drv_threads(padapter) != _SUCCESS)
422			goto netdev_open_error;
423		if (!padapter->dvobjpriv.inirp_init)
424			goto netdev_open_error;
425		else
426			padapter->dvobjpriv.inirp_init(padapter);
427		r8712_set_ps_mode(padapter, padapter->registrypriv.power_mgnt,
428				  padapter->registrypriv.smart_ps);
429	}
430	if (!netif_queue_stopped(pnetdev))
431		netif_start_queue(pnetdev);
432	else
433		netif_wake_queue(pnetdev);
434
435	if (video_mode)
436		enable_video_mode(padapter, cbw40_enable);
437	/* start driver mlme relation timer */
438	start_drv_timers(padapter);
439	padapter->ledpriv.LedControlHandler(padapter, LED_CTL_NO_LINK);
440	mutex_unlock(&padapter->mutex_start);
441	return 0;
442netdev_open_error:
443	padapter->bup = false;
444	netif_carrier_off(pnetdev);
445	netif_stop_queue(pnetdev);
446	mutex_unlock(&padapter->mutex_start);
447	return -1;
448}
449
450/*
451 *
452 * This function intends to handle the shutdown of an interface
453 * i.e. when it is brought Down from an Up/Active state.
454 *
455 */
456static int netdev_close(struct net_device *pnetdev)
457{
458	struct _adapter *padapter = netdev_priv(pnetdev);
459
460	/* Close LED*/
461	padapter->ledpriv.LedControlHandler(padapter, LED_CTL_POWER_OFF);
462	msleep(200);
463
464	/*s1.*/
465	if (pnetdev) {
466		if (!netif_queue_stopped(pnetdev))
467			netif_stop_queue(pnetdev);
468	}
469	/*s2.*/
470	/*s2-1.  issue disassoc_cmd to fw*/
471	r8712_disassoc_cmd(padapter);
472	/*s2-2.  indicate disconnect to os*/
473	r8712_ind_disconnect(padapter);
474	/*s2-3.*/
475	r8712_free_assoc_resources(padapter);
476	/*s2-4.*/
477	r8712_free_network_queue(padapter);
478	return 0;
479}
480
481#include "mlme_osdep.h"
482