xref: /linux/drivers/net/wireless/rsi/rsi_91x_sdio_ops.c (revision 91ec2035134982b98fab0609a9fd8480e8217dc1)
1 /*
2  * Copyright (c) 2014 Redpine Signals Inc.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  *
16  */
17 
18 #include <linux/firmware.h>
19 #include <net/rsi_91x.h>
20 #include "rsi_sdio.h"
21 #include "rsi_common.h"
22 
23 /**
24  * rsi_sdio_master_access_msword() - This function sets the AHB master access
25  *				     MS word in the SDIO slave registers.
26  * @adapter: Pointer to the adapter structure.
27  * @ms_word: ms word need to be initialized.
28  *
29  * Return: status: 0 on success, -1 on failure.
30  */
rsi_sdio_master_access_msword(struct rsi_hw * adapter,u16 ms_word)31 int rsi_sdio_master_access_msword(struct rsi_hw *adapter, u16 ms_word)
32 {
33 	u8 byte;
34 	u8 function = 0;
35 	int status = 0;
36 
37 	byte = (u8)(ms_word & 0x00FF);
38 
39 	rsi_dbg(INIT_ZONE,
40 		"%s: MASTER_ACCESS_MSBYTE:0x%x\n", __func__, byte);
41 
42 	status = rsi_sdio_write_register(adapter,
43 					 function,
44 					 SDIO_MASTER_ACCESS_MSBYTE,
45 					 &byte);
46 	if (status) {
47 		rsi_dbg(ERR_ZONE,
48 			"%s: fail to access MASTER_ACCESS_MSBYTE\n",
49 			__func__);
50 		return -1;
51 	}
52 
53 	byte = (u8)(ms_word >> 8);
54 
55 	rsi_dbg(INIT_ZONE, "%s:MASTER_ACCESS_LSBYTE:0x%x\n", __func__, byte);
56 	status = rsi_sdio_write_register(adapter,
57 					 function,
58 					 SDIO_MASTER_ACCESS_LSBYTE,
59 					 &byte);
60 	return status;
61 }
62 
63 static void rsi_rx_handler(struct rsi_hw *adapter);
64 
rsi_sdio_rx_thread(void * data)65 int rsi_sdio_rx_thread(void *data)
66 {
67 	struct rsi_common *common = data;
68 	struct rsi_hw *adapter = common->priv;
69 	struct rsi_91x_sdiodev *sdev = adapter->rsi_dev;
70 
71 	do {
72 		rsi_wait_event(&sdev->rx_thread.event, EVENT_WAIT_FOREVER);
73 		rsi_reset_event(&sdev->rx_thread.event);
74 		rsi_rx_handler(adapter);
75 	} while (!atomic_read(&sdev->rx_thread.thread_done));
76 
77 	rsi_dbg(INFO_ZONE, "%s: Terminated SDIO RX thread\n", __func__);
78 	atomic_inc(&sdev->rx_thread.thread_done);
79 	kthread_complete_and_exit(&sdev->rx_thread.completion, 0);
80 }
81 
82 /**
83  * rsi_process_pkt() - This Function reads rx_blocks register and figures out
84  *		       the size of the rx pkt.
85  * @common: Pointer to the driver private structure.
86  *
87  * Return: 0 on success, -1 on failure.
88  */
rsi_process_pkt(struct rsi_common * common)89 static int rsi_process_pkt(struct rsi_common *common)
90 {
91 	struct rsi_hw *adapter = common->priv;
92 	struct rsi_91x_sdiodev *dev = adapter->rsi_dev;
93 	u8 num_blks = 0;
94 	u32 rcv_pkt_len = 0;
95 	int status = 0;
96 	u8 value = 0;
97 
98 	num_blks = ((adapter->interrupt_status & 1) |
99 			((adapter->interrupt_status >> RECV_NUM_BLOCKS) << 1));
100 
101 	if (!num_blks) {
102 		status = rsi_sdio_read_register(adapter,
103 						SDIO_RX_NUM_BLOCKS_REG,
104 						&value);
105 		if (status) {
106 			rsi_dbg(ERR_ZONE,
107 				"%s: Failed to read pkt length from the card:\n",
108 				__func__);
109 			return status;
110 		}
111 		num_blks = value & 0x1f;
112 	}
113 
114 	if (dev->write_fail == 2)
115 		rsi_sdio_ack_intr(common->priv, (1 << MSDU_PKT_PENDING));
116 
117 	if (unlikely(!num_blks)) {
118 		dev->write_fail = 2;
119 		return -1;
120 	}
121 
122 	rcv_pkt_len = (num_blks * 256);
123 
124 	status = rsi_sdio_host_intf_read_pkt(adapter, dev->pktbuffer,
125 					     rcv_pkt_len);
126 	if (status) {
127 		rsi_dbg(ERR_ZONE, "%s: Failed to read packet from card\n",
128 			__func__);
129 		return status;
130 	}
131 
132 	status = rsi_read_pkt(common, dev->pktbuffer, rcv_pkt_len);
133 	if (status) {
134 		rsi_dbg(ERR_ZONE, "Failed to read the packet\n");
135 		return status;
136 	}
137 
138 	return 0;
139 }
140 
141 /**
142  * rsi_init_sdio_slave_regs() - This function does the actual initialization
143  *				of SDBUS slave registers.
144  * @adapter: Pointer to the adapter structure.
145  *
146  * Return: status: 0 on success, -1 on failure.
147  */
rsi_init_sdio_slave_regs(struct rsi_hw * adapter)148 int rsi_init_sdio_slave_regs(struct rsi_hw *adapter)
149 {
150 	struct rsi_91x_sdiodev *dev = adapter->rsi_dev;
151 	u8 function = 0;
152 	u8 byte;
153 	int status = 0;
154 
155 	if (dev->next_read_delay) {
156 		byte = dev->next_read_delay;
157 		status = rsi_sdio_write_register(adapter,
158 						 function,
159 						 SDIO_NXT_RD_DELAY2,
160 						 &byte);
161 		if (status) {
162 			rsi_dbg(ERR_ZONE,
163 				"%s: Failed to write SDIO_NXT_RD_DELAY2\n",
164 				__func__);
165 			return -1;
166 		}
167 	}
168 
169 	if (dev->sdio_high_speed_enable) {
170 		rsi_dbg(INIT_ZONE, "%s: Enabling SDIO High speed\n", __func__);
171 		byte = 0x3;
172 
173 		status = rsi_sdio_write_register(adapter,
174 						 function,
175 						 SDIO_REG_HIGH_SPEED,
176 						 &byte);
177 		if (status) {
178 			rsi_dbg(ERR_ZONE,
179 				"%s: Failed to enable SDIO high speed\n",
180 				__func__);
181 			return -1;
182 		}
183 	}
184 
185 	/* This tells SDIO FIFO when to start read to host */
186 	rsi_dbg(INIT_ZONE, "%s: Initializing SDIO read start level\n", __func__);
187 	byte = 0x24;
188 
189 	status = rsi_sdio_write_register(adapter,
190 					 function,
191 					 SDIO_READ_START_LVL,
192 					 &byte);
193 	if (status) {
194 		rsi_dbg(ERR_ZONE,
195 			"%s: Failed to write SDIO_READ_START_LVL\n", __func__);
196 		return -1;
197 	}
198 
199 	rsi_dbg(INIT_ZONE, "%s: Initializing FIFO ctrl registers\n", __func__);
200 	byte = (128 - 32);
201 
202 	status = rsi_sdio_write_register(adapter,
203 					 function,
204 					 SDIO_READ_FIFO_CTL,
205 					 &byte);
206 	if (status) {
207 		rsi_dbg(ERR_ZONE,
208 			"%s: Failed to write SDIO_READ_FIFO_CTL\n", __func__);
209 		return -1;
210 	}
211 
212 	byte = 32;
213 	status = rsi_sdio_write_register(adapter,
214 					 function,
215 					 SDIO_WRITE_FIFO_CTL,
216 					 &byte);
217 	if (status) {
218 		rsi_dbg(ERR_ZONE,
219 			"%s: Failed to write SDIO_WRITE_FIFO_CTL\n", __func__);
220 		return -1;
221 	}
222 
223 	return 0;
224 }
225 
226 /**
227  * rsi_rx_handler() - Read and process SDIO interrupts.
228  * @adapter: Pointer to the adapter structure.
229  *
230  * Return: None.
231  */
rsi_rx_handler(struct rsi_hw * adapter)232 static void rsi_rx_handler(struct rsi_hw *adapter)
233 {
234 	struct rsi_common *common = adapter->priv;
235 	struct rsi_91x_sdiodev *dev = adapter->rsi_dev;
236 	int status;
237 	u8 isr_status = 0;
238 	u8 fw_status = 0;
239 
240 	dev->rx_info.sdio_int_counter++;
241 
242 	do {
243 		mutex_lock(&common->rx_lock);
244 		status = rsi_sdio_read_register(common->priv,
245 						RSI_FN1_INT_REGISTER,
246 						&isr_status);
247 		if (status) {
248 			rsi_dbg(ERR_ZONE,
249 				"%s: Failed to Read Intr Status Register\n",
250 				__func__);
251 			mutex_unlock(&common->rx_lock);
252 			return;
253 		}
254 		adapter->interrupt_status = isr_status;
255 
256 		if (isr_status == 0) {
257 			rsi_set_event(&common->tx_thread.event);
258 			dev->rx_info.sdio_intr_status_zero++;
259 			mutex_unlock(&common->rx_lock);
260 			return;
261 		}
262 
263 		rsi_dbg(ISR_ZONE, "%s: Intr_status = %x %d %d\n",
264 			__func__, isr_status, (1 << MSDU_PKT_PENDING),
265 			(1 << FW_ASSERT_IND));
266 
267 		if (isr_status & BIT(PKT_BUFF_AVAILABLE)) {
268 			status = rsi_sdio_check_buffer_status(adapter, 0);
269 			if (status < 0)
270 				rsi_dbg(ERR_ZONE,
271 					"%s: Failed to check buffer status\n",
272 					__func__);
273 			rsi_sdio_ack_intr(common->priv,
274 					  BIT(PKT_BUFF_AVAILABLE));
275 			rsi_set_event(&common->tx_thread.event);
276 
277 			rsi_dbg(ISR_ZONE, "%s: ==> BUFFER_AVAILABLE <==\n",
278 				__func__);
279 			dev->buff_status_updated = true;
280 
281 			isr_status &= ~BIT(PKT_BUFF_AVAILABLE);
282 		}
283 
284 		if (isr_status & BIT(FW_ASSERT_IND)) {
285 			rsi_dbg(ERR_ZONE, "%s: ==> FIRMWARE Assert <==\n",
286 				__func__);
287 			status = rsi_sdio_read_register(common->priv,
288 							SDIO_FW_STATUS_REG,
289 							&fw_status);
290 			if (status) {
291 				rsi_dbg(ERR_ZONE,
292 					"%s: Failed to read f/w reg\n",
293 					__func__);
294 			} else {
295 				rsi_dbg(ERR_ZONE,
296 					"%s: Firmware Status is 0x%x\n",
297 					__func__, fw_status);
298 				rsi_sdio_ack_intr(common->priv,
299 						  BIT(FW_ASSERT_IND));
300 			}
301 
302 			common->fsm_state = FSM_CARD_NOT_READY;
303 
304 			isr_status &= ~BIT(FW_ASSERT_IND);
305 		}
306 
307 		if (isr_status & BIT(MSDU_PKT_PENDING)) {
308 			rsi_dbg(ISR_ZONE, "Pkt pending interrupt\n");
309 			dev->rx_info.total_sdio_msdu_pending_intr++;
310 
311 			status = rsi_process_pkt(common);
312 			if (status) {
313 				rsi_dbg(ERR_ZONE, "%s: Failed to read pkt\n",
314 					__func__);
315 				mutex_unlock(&common->rx_lock);
316 				return;
317 			}
318 
319 			isr_status &= ~BIT(MSDU_PKT_PENDING);
320 		}
321 
322 		if (isr_status) {
323 			rsi_sdio_ack_intr(common->priv, isr_status);
324 			dev->rx_info.total_sdio_unknown_intr++;
325 			isr_status = 0;
326 			rsi_dbg(ISR_ZONE, "Unknown Interrupt %x\n",
327 				isr_status);
328 		}
329 
330 		mutex_unlock(&common->rx_lock);
331 	} while (1);
332 }
333 
334 /* This function is used to read buffer status register and
335  * set relevant fields in rsi_91x_sdiodev struct.
336  */
rsi_sdio_check_buffer_status(struct rsi_hw * adapter,u8 q_num)337 int rsi_sdio_check_buffer_status(struct rsi_hw *adapter, u8 q_num)
338 {
339 	struct rsi_common *common = adapter->priv;
340 	struct rsi_91x_sdiodev *dev = adapter->rsi_dev;
341 	u8 buf_status = 0;
342 	int status = 0;
343 	static int counter = 4;
344 
345 	if (!dev->buff_status_updated && counter) {
346 		counter--;
347 		goto out;
348 	}
349 
350 	dev->buff_status_updated = false;
351 	status = rsi_sdio_read_register(common->priv,
352 					RSI_DEVICE_BUFFER_STATUS_REGISTER,
353 					&buf_status);
354 
355 	if (status) {
356 		rsi_dbg(ERR_ZONE,
357 			"%s: Failed to read status register\n", __func__);
358 		return -1;
359 	}
360 
361 	if (buf_status & (BIT(PKT_MGMT_BUFF_FULL))) {
362 		if (!dev->rx_info.mgmt_buffer_full)
363 			dev->rx_info.mgmt_buf_full_counter++;
364 		dev->rx_info.mgmt_buffer_full = true;
365 	} else {
366 		dev->rx_info.mgmt_buffer_full = false;
367 	}
368 
369 	if (buf_status & (BIT(PKT_BUFF_FULL))) {
370 		if (!dev->rx_info.buffer_full)
371 			dev->rx_info.buf_full_counter++;
372 		dev->rx_info.buffer_full = true;
373 	} else {
374 		dev->rx_info.buffer_full = false;
375 	}
376 
377 	if (buf_status & (BIT(PKT_BUFF_SEMI_FULL))) {
378 		if (!dev->rx_info.semi_buffer_full)
379 			dev->rx_info.buf_semi_full_counter++;
380 		dev->rx_info.semi_buffer_full = true;
381 	} else {
382 		dev->rx_info.semi_buffer_full = false;
383 	}
384 
385 	if (dev->rx_info.mgmt_buffer_full || dev->rx_info.buf_full_counter)
386 		counter = 1;
387 	else
388 		counter = 4;
389 
390 out:
391 	if ((q_num == MGMT_SOFT_Q) && (dev->rx_info.mgmt_buffer_full))
392 		return QUEUE_FULL;
393 
394 	if ((q_num < MGMT_SOFT_Q) && (dev->rx_info.buffer_full))
395 		return QUEUE_FULL;
396 
397 	return QUEUE_NOT_FULL;
398 }
399 
400 /**
401  * rsi_sdio_determine_event_timeout() - This Function determines the event
402  *					timeout duration.
403  * @adapter: Pointer to the adapter structure.
404  *
405  * Return: timeout duration is returned.
406  */
rsi_sdio_determine_event_timeout(struct rsi_hw * adapter)407 int rsi_sdio_determine_event_timeout(struct rsi_hw *adapter)
408 {
409 	struct rsi_91x_sdiodev *dev = adapter->rsi_dev;
410 
411 	/* Once buffer full is seen, event timeout to occur every 2 msecs */
412 	if (dev->rx_info.buffer_full)
413 		return 2;
414 
415 	return EVENT_WAIT_FOREVER;
416 }
417