xref: /wlan-driver/qca-wifi-host-cmn/hif/src/sdio/hif_sdio_dev.c (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2013-2020 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name  *
5*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
6*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
7*5113495bSYour Name  * above copyright notice and this permission notice appear in all
8*5113495bSYour Name  * copies.
9*5113495bSYour Name  *
10*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
18*5113495bSYour Name  */
19*5113495bSYour Name 
20*5113495bSYour Name #define ATH_MODULE_NAME hif
21*5113495bSYour Name #include "a_debug.h"
22*5113495bSYour Name 
23*5113495bSYour Name #include <qdf_types.h>
24*5113495bSYour Name #include <qdf_status.h>
25*5113495bSYour Name #include <qdf_timer.h>
26*5113495bSYour Name #include <qdf_time.h>
27*5113495bSYour Name #include <qdf_lock.h>
28*5113495bSYour Name #include <qdf_mem.h>
29*5113495bSYour Name #include <qdf_util.h>
30*5113495bSYour Name #include <qdf_defer.h>
31*5113495bSYour Name #include <qdf_atomic.h>
32*5113495bSYour Name #include <qdf_nbuf.h>
33*5113495bSYour Name #include <athdefs.h>
34*5113495bSYour Name #include <qdf_net_types.h>
35*5113495bSYour Name #include <a_types.h>
36*5113495bSYour Name #include <athdefs.h>
37*5113495bSYour Name #include <a_osapi.h>
38*5113495bSYour Name #include <hif.h>
39*5113495bSYour Name #include <htc_services.h>
40*5113495bSYour Name #include "hif_sdio_internal.h"
41*5113495bSYour Name #include "if_sdio.h"
42*5113495bSYour Name #include "regtable_sdio.h"
43*5113495bSYour Name 
44*5113495bSYour Name /**
45*5113495bSYour Name  * hif_dev_alloc_rx_buffer() - allocate rx buffer.
46*5113495bSYour Name  * @pdev: sdio device context
47*5113495bSYour Name  *
48*5113495bSYour Name  *
49*5113495bSYour Name  * Return: htc buffer pointer
50*5113495bSYour Name  */
hif_dev_alloc_rx_buffer(struct hif_sdio_device * pdev)51*5113495bSYour Name HTC_PACKET *hif_dev_alloc_rx_buffer(struct hif_sdio_device *pdev)
52*5113495bSYour Name {
53*5113495bSYour Name 	HTC_PACKET *packet;
54*5113495bSYour Name 	qdf_nbuf_t netbuf;
55*5113495bSYour Name 	uint32_t bufsize = 0, headsize = 0;
56*5113495bSYour Name 
57*5113495bSYour Name 	bufsize = HIF_SDIO_RX_BUFFER_SIZE + HIF_SDIO_RX_DATA_OFFSET;
58*5113495bSYour Name 	headsize = sizeof(HTC_PACKET);
59*5113495bSYour Name 	netbuf = qdf_nbuf_alloc(NULL, bufsize + headsize, 0, 4, false);
60*5113495bSYour Name 	if (!netbuf) {
61*5113495bSYour Name 		hif_err_rl("Allocate netbuf failed");
62*5113495bSYour Name 		return NULL;
63*5113495bSYour Name 	}
64*5113495bSYour Name 	packet = (HTC_PACKET *) qdf_nbuf_data(netbuf);
65*5113495bSYour Name 	qdf_nbuf_reserve(netbuf, headsize);
66*5113495bSYour Name 
67*5113495bSYour Name 	SET_HTC_PACKET_INFO_RX_REFILL(packet,
68*5113495bSYour Name 				      pdev,
69*5113495bSYour Name 				      qdf_nbuf_data(netbuf),
70*5113495bSYour Name 				      bufsize, ENDPOINT_0);
71*5113495bSYour Name 	SET_HTC_PACKET_NET_BUF_CONTEXT(packet, netbuf);
72*5113495bSYour Name 	return packet;
73*5113495bSYour Name }
74*5113495bSYour Name 
75*5113495bSYour Name /**
76*5113495bSYour Name  * hif_dev_create() - create hif device after probe.
77*5113495bSYour Name  * @hif_device: HIF context
78*5113495bSYour Name  * @callbacks: htc callbacks
79*5113495bSYour Name  * @target: HIF target
80*5113495bSYour Name  *
81*5113495bSYour Name  *
82*5113495bSYour Name  * Return: int
83*5113495bSYour Name  */
hif_dev_create(struct hif_sdio_dev * hif_device,struct hif_msg_callbacks * callbacks,void * target)84*5113495bSYour Name struct hif_sdio_device *hif_dev_create(struct hif_sdio_dev *hif_device,
85*5113495bSYour Name 			struct hif_msg_callbacks *callbacks, void *target)
86*5113495bSYour Name {
87*5113495bSYour Name 
88*5113495bSYour Name 	QDF_STATUS status;
89*5113495bSYour Name 	struct hif_sdio_device *pdev;
90*5113495bSYour Name 
91*5113495bSYour Name 	HIF_ENTER();
92*5113495bSYour Name 	pdev = qdf_mem_malloc(sizeof(struct hif_sdio_device));
93*5113495bSYour Name 	if (!pdev) {
94*5113495bSYour Name 		A_ASSERT(false);
95*5113495bSYour Name 		return NULL;
96*5113495bSYour Name 	}
97*5113495bSYour Name 
98*5113495bSYour Name 	qdf_spinlock_create(&pdev->Lock);
99*5113495bSYour Name 	qdf_spinlock_create(&pdev->TxLock);
100*5113495bSYour Name 	qdf_spinlock_create(&pdev->RxLock);
101*5113495bSYour Name 
102*5113495bSYour Name 	pdev->HIFDevice = hif_device;
103*5113495bSYour Name 	pdev->pTarget = target;
104*5113495bSYour Name 	status = hif_configure_device(NULL, hif_device,
105*5113495bSYour Name 				      HIF_DEVICE_SET_HTC_CONTEXT,
106*5113495bSYour Name 				      (void *)pdev, sizeof(pdev));
107*5113495bSYour Name 	if (status != QDF_STATUS_SUCCESS)
108*5113495bSYour Name 		hif_err("set context failed");
109*5113495bSYour Name 
110*5113495bSYour Name 	A_MEMCPY(&pdev->hif_callbacks, callbacks, sizeof(*callbacks));
111*5113495bSYour Name 
112*5113495bSYour Name 	HIF_EXIT();
113*5113495bSYour Name 	return pdev;
114*5113495bSYour Name }
115*5113495bSYour Name 
116*5113495bSYour Name /**
117*5113495bSYour Name  * hif_dev_destroy() - destroy hif device.
118*5113495bSYour Name  * @pdev: sdio device context
119*5113495bSYour Name  *
120*5113495bSYour Name  *
121*5113495bSYour Name  * Return: none
122*5113495bSYour Name  */
hif_dev_destroy(struct hif_sdio_device * pdev)123*5113495bSYour Name void hif_dev_destroy(struct hif_sdio_device *pdev)
124*5113495bSYour Name {
125*5113495bSYour Name 	QDF_STATUS status;
126*5113495bSYour Name 
127*5113495bSYour Name 	status = hif_configure_device(NULL, pdev->HIFDevice,
128*5113495bSYour Name 				      HIF_DEVICE_SET_HTC_CONTEXT,
129*5113495bSYour Name 				      (void *)NULL, 0);
130*5113495bSYour Name 	if (status != QDF_STATUS_SUCCESS)
131*5113495bSYour Name 		hif_err("set context failed");
132*5113495bSYour Name 
133*5113495bSYour Name 	qdf_mem_free(pdev);
134*5113495bSYour Name }
135*5113495bSYour Name 
136*5113495bSYour Name /**
137*5113495bSYour Name  * hif_dev_from_hif() - get sdio device from hif device.
138*5113495bSYour Name  * @hif_device: hif device context
139*5113495bSYour Name  *
140*5113495bSYour Name  *
141*5113495bSYour Name  * Return: hif sdio device context
142*5113495bSYour Name  */
hif_dev_from_hif(struct hif_sdio_dev * hif_device)143*5113495bSYour Name struct hif_sdio_device *hif_dev_from_hif(struct hif_sdio_dev *hif_device)
144*5113495bSYour Name {
145*5113495bSYour Name 	struct hif_sdio_device *pdev = NULL;
146*5113495bSYour Name 	QDF_STATUS status;
147*5113495bSYour Name 
148*5113495bSYour Name 	status = hif_configure_device(NULL, hif_device,
149*5113495bSYour Name 				      HIF_DEVICE_GET_HTC_CONTEXT,
150*5113495bSYour Name 				      (void **)&pdev,
151*5113495bSYour Name 				      sizeof(struct hif_sdio_device));
152*5113495bSYour Name 	if (status != QDF_STATUS_SUCCESS)
153*5113495bSYour Name 		hif_err("set context failed");
154*5113495bSYour Name 
155*5113495bSYour Name 	return pdev;
156*5113495bSYour Name }
157*5113495bSYour Name 
158*5113495bSYour Name /**
159*5113495bSYour Name  * hif_dev_disable_interrupts() - disable hif device interrupts.
160*5113495bSYour Name  * @pdev: sdio device context
161*5113495bSYour Name  *
162*5113495bSYour Name  *
163*5113495bSYour Name  * Return: int
164*5113495bSYour Name  */
hif_dev_disable_interrupts(struct hif_sdio_device * pdev)165*5113495bSYour Name QDF_STATUS hif_dev_disable_interrupts(struct hif_sdio_device *pdev)
166*5113495bSYour Name {
167*5113495bSYour Name 	QDF_STATUS status = QDF_STATUS_SUCCESS;
168*5113495bSYour Name 
169*5113495bSYour Name 	HIF_ENTER();
170*5113495bSYour Name 
171*5113495bSYour Name 	hif_dev_mask_interrupts(pdev);
172*5113495bSYour Name 
173*5113495bSYour Name 	/* To Do mask the host controller interrupts */
174*5113495bSYour Name 	hif_mask_interrupt(pdev->HIFDevice);
175*5113495bSYour Name 
176*5113495bSYour Name 	HIF_EXIT();
177*5113495bSYour Name 	return status;
178*5113495bSYour Name }
179*5113495bSYour Name 
180*5113495bSYour Name /**
181*5113495bSYour Name  * hif_dev_enable_interrupts() - enables hif device interrupts.
182*5113495bSYour Name  * @pdev: sdio device context
183*5113495bSYour Name  *
184*5113495bSYour Name  *
185*5113495bSYour Name  * Return: int
186*5113495bSYour Name  */
hif_dev_enable_interrupts(struct hif_sdio_device * pdev)187*5113495bSYour Name QDF_STATUS hif_dev_enable_interrupts(struct hif_sdio_device *pdev)
188*5113495bSYour Name {
189*5113495bSYour Name 	QDF_STATUS status;
190*5113495bSYour Name 
191*5113495bSYour Name 	HIF_ENTER();
192*5113495bSYour Name 
193*5113495bSYour Name 	/* for good measure, make sure interrupt are disabled
194*5113495bSYour Name 	 * before unmasking at the HIF layer.
195*5113495bSYour Name 	 * The rationale here is that between device insertion
196*5113495bSYour Name 	 * (where we clear the interrupts the first time)
197*5113495bSYour Name 	 * and when HTC is finally ready to handle interrupts,
198*5113495bSYour Name 	 * other software can perform target "soft" resets.
199*5113495bSYour Name 	 */
200*5113495bSYour Name 	status = hif_dev_disable_interrupts(pdev);
201*5113495bSYour Name 
202*5113495bSYour Name 	/* Unmask the host controller interrupts */
203*5113495bSYour Name 	hif_un_mask_interrupt(pdev->HIFDevice);
204*5113495bSYour Name 
205*5113495bSYour Name 	hif_dev_unmask_interrupts(pdev);
206*5113495bSYour Name 
207*5113495bSYour Name 	HIF_EXIT();
208*5113495bSYour Name 
209*5113495bSYour Name 	return status;
210*5113495bSYour Name }
211*5113495bSYour Name 
212*5113495bSYour Name /**
213*5113495bSYour Name  * hif_dev_setup() - set up sdio device.
214*5113495bSYour Name  * @pdev: sdio device context
215*5113495bSYour Name  *
216*5113495bSYour Name  *
217*5113495bSYour Name  * Return: int
218*5113495bSYour Name  */
hif_dev_setup(struct hif_sdio_device * pdev)219*5113495bSYour Name QDF_STATUS hif_dev_setup(struct hif_sdio_device *pdev)
220*5113495bSYour Name {
221*5113495bSYour Name 	QDF_STATUS status;
222*5113495bSYour Name 	struct htc_callbacks htc_cbs;
223*5113495bSYour Name 	struct hif_sdio_dev *hif_device = pdev->HIFDevice;
224*5113495bSYour Name 
225*5113495bSYour Name 	HIF_ENTER();
226*5113495bSYour Name 
227*5113495bSYour Name 	status = hif_dev_setup_device(pdev);
228*5113495bSYour Name 
229*5113495bSYour Name 	if (status != QDF_STATUS_SUCCESS) {
230*5113495bSYour Name 		hif_err("device specific setup failed");
231*5113495bSYour Name 		return QDF_STATUS_E_INVAL;
232*5113495bSYour Name 	}
233*5113495bSYour Name 
234*5113495bSYour Name 	pdev->BlockMask = pdev->BlockSize - 1;
235*5113495bSYour Name 	A_ASSERT((pdev->BlockSize & pdev->BlockMask) == 0);
236*5113495bSYour Name 
237*5113495bSYour Name 	/* assume we can process HIF interrupt events asynchronously */
238*5113495bSYour Name 	pdev->HifIRQProcessingMode = HIF_DEVICE_IRQ_ASYNC_SYNC;
239*5113495bSYour Name 
240*5113495bSYour Name 	/* see if the HIF layer overrides this assumption */
241*5113495bSYour Name 	hif_configure_device(NULL, hif_device,
242*5113495bSYour Name 			     HIF_DEVICE_GET_IRQ_PROC_MODE,
243*5113495bSYour Name 			     &pdev->HifIRQProcessingMode,
244*5113495bSYour Name 			     sizeof(pdev->HifIRQProcessingMode));
245*5113495bSYour Name 
246*5113495bSYour Name 	switch (pdev->HifIRQProcessingMode) {
247*5113495bSYour Name 	case HIF_DEVICE_IRQ_SYNC_ONLY:
248*5113495bSYour Name 		AR_DEBUG_PRINTF(ATH_DEBUG_WARN,
249*5113495bSYour Name 			("HIF Interrupt processing is SYNC ONLY\n"));
250*5113495bSYour Name 		/* see if HIF layer wants HTC to yield */
251*5113495bSYour Name 		hif_configure_device(NULL, hif_device,
252*5113495bSYour Name 				     HIF_DEVICE_GET_IRQ_YIELD_PARAMS,
253*5113495bSYour Name 				     &pdev->HifIRQYieldParams,
254*5113495bSYour Name 				     sizeof(pdev->HifIRQYieldParams));
255*5113495bSYour Name 
256*5113495bSYour Name 		if (pdev->HifIRQYieldParams.recv_packet_yield_count > 0) {
257*5113495bSYour Name 			AR_DEBUG_PRINTF(ATH_DEBUG_WARN,
258*5113495bSYour Name 				("HIF req of DSR yield per %d RECV packets\n",
259*5113495bSYour Name 				 pdev->HifIRQYieldParams.
260*5113495bSYour Name 				 recv_packet_yield_count));
261*5113495bSYour Name 			pdev->DSRCanYield = true;
262*5113495bSYour Name 		}
263*5113495bSYour Name 		break;
264*5113495bSYour Name 	case HIF_DEVICE_IRQ_ASYNC_SYNC:
265*5113495bSYour Name 		AR_DEBUG_PRINTF(ATH_DEBUG_TRC,
266*5113495bSYour Name 			("HIF Interrupt processing is ASYNC and SYNC\n"));
267*5113495bSYour Name 		break;
268*5113495bSYour Name 	default:
269*5113495bSYour Name 		A_ASSERT(false);
270*5113495bSYour Name 		break;
271*5113495bSYour Name 	}
272*5113495bSYour Name 
273*5113495bSYour Name 	pdev->HifMaskUmaskRecvEvent = NULL;
274*5113495bSYour Name 
275*5113495bSYour Name 	/* see if the HIF layer implements the mask/unmask recv
276*5113495bSYour Name 	 * events function
277*5113495bSYour Name 	 */
278*5113495bSYour Name 	hif_configure_device(NULL, hif_device,
279*5113495bSYour Name 			     HIF_DEVICE_GET_RECV_EVENT_MASK_UNMASK_FUNC,
280*5113495bSYour Name 			     &pdev->HifMaskUmaskRecvEvent,
281*5113495bSYour Name 			     sizeof(pdev->HifMaskUmaskRecvEvent));
282*5113495bSYour Name 
283*5113495bSYour Name 	status = hif_dev_disable_interrupts(pdev);
284*5113495bSYour Name 
285*5113495bSYour Name 	qdf_mem_zero(&htc_cbs, sizeof(struct htc_callbacks));
286*5113495bSYour Name 	/* the device layer handles these */
287*5113495bSYour Name 	htc_cbs.rw_compl_handler = hif_dev_rw_completion_handler;
288*5113495bSYour Name 	htc_cbs.dsr_handler = hif_dev_dsr_handler;
289*5113495bSYour Name 	htc_cbs.context = pdev;
290*5113495bSYour Name 	status = hif_attach_htc(pdev->HIFDevice, &htc_cbs);
291*5113495bSYour Name 
292*5113495bSYour Name 	HIF_EXIT();
293*5113495bSYour Name 	return status;
294*5113495bSYour Name }
295