Merge branch 'for-linville' of git://github.com/kvalo/ath
[firefly-linux-kernel-4.4.55.git] / drivers / staging / winbond / wb35rx.c
1 /*
2  * ============================================================================
3  *  Copyright (c) 1996-2002 Winbond Electronic Corporation
4  *
5  *  Module Name:
6  *    Wb35Rx.c
7  *
8  *  Abstract:
9  *    Processing the Rx message from down layer
10  *
11  * ============================================================================
12  */
13 #include <linux/usb.h>
14 #include <linux/slab.h>
15
16 #include "core.h"
17 #include "wb35rx_f.h"
18
19 static void packet_came(struct ieee80211_hw *hw, char *pRxBufferAddress,
20         int PacketSize)
21 {
22         struct wbsoft_priv *priv = hw->priv;
23         struct sk_buff *skb;
24         struct ieee80211_rx_status rx_status = {0};
25
26         if (!priv->enabled)
27                 return;
28
29         skb = dev_alloc_skb(PacketSize);
30         if (!skb) {
31                 printk("Not enough memory for packet, FIXME\n");
32                 return;
33         }
34
35         memcpy(skb_put(skb, PacketSize), pRxBufferAddress, PacketSize);
36
37         memcpy(IEEE80211_SKB_RXCB(skb), &rx_status, sizeof(rx_status));
38         ieee80211_rx_irqsafe(hw, skb);
39 }
40
41 static void Wb35Rx_adjust(struct wb35_descriptor *pRxDes)
42 {
43         u32     *pRxBufferAddress;
44         u32     DecryptionMethod;
45         u32     i;
46         u16     BufferSize;
47
48         DecryptionMethod = pRxDes->R01.R01_decryption_method;
49         pRxBufferAddress = pRxDes->buffer_address[0];
50         BufferSize = pRxDes->buffer_size[0];
51
52         /* Adjust the last part of data. Only data left */
53         BufferSize -= 4; /* For CRC-32 */
54         if (DecryptionMethod)
55                 BufferSize -= 4;
56         if (DecryptionMethod == 3) /* For CCMP */
57                 BufferSize -= 4;
58
59         /* Adjust the IV field which after 802.11 header and ICV field. */
60         if (DecryptionMethod == 1) { /* For WEP */
61                 for (i = 6; i > 0; i--)
62                         pRxBufferAddress[i] = pRxBufferAddress[i - 1];
63                 pRxDes->buffer_address[0] = pRxBufferAddress + 1;
64                 BufferSize -= 4; /* 4 byte for IV */
65         } else if (DecryptionMethod) { /* For TKIP and CCMP */
66                 for (i = 7; i > 1; i--)
67                         pRxBufferAddress[i] = pRxBufferAddress[i - 2];
68                 /* Update the descriptor, shift 8 byte */
69                 pRxDes->buffer_address[0] = pRxBufferAddress + 2;
70                 BufferSize -= 8; /* 8 byte for IV + ICV */
71         }
72         pRxDes->buffer_size[0] = BufferSize;
73 }
74
75 static u16 Wb35Rx_indicate(struct ieee80211_hw *hw)
76 {
77         struct wbsoft_priv      *priv = hw->priv;
78         struct hw_data          *pHwData = &priv->sHwData;
79         struct wb35_descriptor  RxDes;
80         struct wb35_rx          *pWb35Rx = &pHwData->Wb35Rx;
81         u8                      *pRxBufferAddress;
82         u16                     PacketSize;
83         u16                     stmp, BufferSize, stmp2 = 0;
84         u32                     RxBufferId;
85
86         /* Only one thread be allowed to run into the following */
87         do {
88                 RxBufferId = pWb35Rx->RxProcessIndex;
89                 if (pWb35Rx->RxOwner[RxBufferId]) /* Owner by VM */
90                         break;
91
92                 pWb35Rx->RxProcessIndex++;
93                 pWb35Rx->RxProcessIndex %= MAX_USB_RX_BUFFER_NUMBER;
94
95                 pRxBufferAddress = pWb35Rx->pDRx;
96                 BufferSize = pWb35Rx->RxBufferSize[RxBufferId];
97
98                 /* Parse the bulkin buffer */
99                 while (BufferSize >= 4) {
100                         /* Is ending? */
101                         if ((cpu_to_le32(*(u32 *)pRxBufferAddress) & 0x0fffffff) ==
102                                 RX_END_TAG)
103                                 break;
104
105                         /* Get the R00 R01 first */
106                         RxDes.R00.value = le32_to_cpu(*(u32 *)pRxBufferAddress);
107                         PacketSize = (u16)RxDes.R00.R00_receive_byte_count;
108                         RxDes.R01.value = le32_to_cpu(*((u32 *)(pRxBufferAddress + 4)));
109                         /* For new DMA 4k */
110                         if ((PacketSize & 0x03) > 0)
111                                 PacketSize -= 4;
112
113                         /* Basic check for Rx length. Is length valid? */
114                         if (PacketSize > MAX_PACKET_SIZE) {
115                                 pr_debug("Serious ERROR : Rx data size too long, size =%d\n",
116                                         PacketSize);
117                                 pWb35Rx->EP3vm_state = VM_STOP;
118                                 pWb35Rx->Ep3ErrorCount2++;
119                                 break;
120                         }
121
122                         /*
123                          * Wb35Rx_indicate() is called synchronously so it isn't
124                          * necessary to set "RxDes.Desctriptor_ID = RxBufferID;"
125                          */
126                         /* subtract 8 byte for 35's USB header length */
127                         BufferSize -= 8;
128                         pRxBufferAddress += 8;
129
130                         RxDes.buffer_address[0] = pRxBufferAddress;
131                         RxDes.buffer_size[0] = PacketSize;
132                         RxDes.buffer_number = 1;
133                         RxDes.buffer_start_index = 0;
134                         RxDes.buffer_total_size = RxDes.buffer_size[0];
135                         Wb35Rx_adjust(&RxDes);
136
137                         packet_came(hw, pRxBufferAddress, PacketSize);
138
139                         /* Move RxBuffer point to the next */
140                         stmp = PacketSize + 3;
141                         stmp &= ~0x03; /* 4n alignment */
142                         pRxBufferAddress += stmp;
143                         BufferSize -= stmp;
144                         stmp2 += stmp;
145                 }
146
147                 /* Reclaim resource */
148                 pWb35Rx->RxOwner[RxBufferId] = 1;
149         } while (true);
150         return stmp2;
151 }
152
153 static void Wb35Rx(struct ieee80211_hw *hw);
154
155 static void Wb35Rx_Complete(struct urb *urb)
156 {
157         struct ieee80211_hw     *hw = urb->context;
158         struct wbsoft_priv      *priv = hw->priv;
159         struct hw_data          *pHwData = &priv->sHwData;
160         struct wb35_rx          *pWb35Rx = &pHwData->Wb35Rx;
161         u8                      *pRxBufferAddress;
162         u32                     SizeCheck;
163         u16                     BulkLength;
164         u32                     RxBufferId;
165         struct R00_descriptor           R00;
166
167         /* Variable setting */
168         pWb35Rx->EP3vm_state = VM_COMPLETED;
169         pWb35Rx->EP3VM_status = urb->status; /* Store the last result of Irp */
170
171         RxBufferId = pWb35Rx->CurrentRxBufferId;
172
173         pRxBufferAddress = pWb35Rx->pDRx;
174         BulkLength = (u16)urb->actual_length;
175
176         /* The IRP is completed */
177         pWb35Rx->EP3vm_state = VM_COMPLETED;
178
179         if (pHwData->SurpriseRemove) /* Must be here, or RxBufferId is invalid */
180                 goto error;
181
182         if (pWb35Rx->rx_halt)
183                 goto error;
184
185         /* Start to process the data only in successful condition */
186         pWb35Rx->RxOwner[RxBufferId] = 0; /* Set the owner to driver */
187         R00.value = le32_to_cpu(*(u32 *)pRxBufferAddress);
188
189         /* The URB is completed, check the result */
190         if (pWb35Rx->EP3VM_status != 0) {
191                 pr_debug("EP3 IoCompleteRoutine return error\n");
192                 pWb35Rx->EP3vm_state = VM_STOP;
193                 goto error;
194         }
195
196         /* For recovering. check if operating in single USB mode */
197         if (!HAL_USB_MODE_BURST(pHwData)) {
198                 SizeCheck = R00.R00_receive_byte_count;
199                 if ((SizeCheck & 0x03) > 0)
200                         SizeCheck -= 4;
201                 SizeCheck = (SizeCheck + 3) & ~0x03;
202                 SizeCheck += 12; /* 8 + 4 badbeef */
203                 if ((BulkLength > 1600) ||
204                         (SizeCheck > 1600) ||
205                         (BulkLength != SizeCheck) ||
206                         (BulkLength == 0)) { /* Add for fail Urb */
207                         pWb35Rx->EP3vm_state = VM_STOP;
208                         pWb35Rx->Ep3ErrorCount2++;
209                 }
210         }
211
212         /* Indicating the receiving data */
213         pWb35Rx->ByteReceived += BulkLength;
214         pWb35Rx->RxBufferSize[RxBufferId] = BulkLength;
215
216         if (!pWb35Rx->RxOwner[RxBufferId])
217                 Wb35Rx_indicate(hw);
218
219         kfree(pWb35Rx->pDRx);
220         /* Do the next receive */
221         Wb35Rx(hw);
222         return;
223
224 error:
225         pWb35Rx->RxOwner[RxBufferId] = 1; /* Set the owner to hardware */
226         atomic_dec(&pWb35Rx->RxFireCounter);
227         pWb35Rx->EP3vm_state = VM_STOP;
228 }
229
230 /* This function cannot reentrain */
231 static void Wb35Rx(struct ieee80211_hw *hw)
232 {
233         struct wbsoft_priv      *priv = hw->priv;
234         struct hw_data          *pHwData = &priv->sHwData;
235         struct wb35_rx          *pWb35Rx = &pHwData->Wb35Rx;
236         u8                      *pRxBufferAddress;
237         struct urb              *urb = pWb35Rx->RxUrb;
238         int                     retv;
239         u32                     RxBufferId;
240
241         /* Issuing URB */
242         if (pHwData->SurpriseRemove)
243                 goto error;
244
245         if (pWb35Rx->rx_halt)
246                 goto error;
247
248         /* Get RxBuffer's ID */
249         RxBufferId = pWb35Rx->RxBufferId;
250         if (!pWb35Rx->RxOwner[RxBufferId]) {
251                 /* It's impossible to run here. */
252                 pr_debug("Rx driver fifo unavailable\n");
253                 goto error;
254         }
255
256         /* Update buffer point, then start to bulkin the data from USB */
257         pWb35Rx->RxBufferId++;
258         pWb35Rx->RxBufferId %= MAX_USB_RX_BUFFER_NUMBER;
259
260         pWb35Rx->CurrentRxBufferId = RxBufferId;
261
262         pWb35Rx->pDRx = kzalloc(MAX_USB_RX_BUFFER, GFP_ATOMIC);
263         if (!pWb35Rx->pDRx) {
264                 dev_info(&hw->wiphy->dev, "w35und: Rx memory alloc failed\n");
265                 goto error;
266         }
267         pRxBufferAddress = pWb35Rx->pDRx;
268
269         usb_fill_bulk_urb(urb, pHwData->udev,
270                           usb_rcvbulkpipe(pHwData->udev, 3),
271                           pRxBufferAddress, MAX_USB_RX_BUFFER,
272                           Wb35Rx_Complete, hw);
273
274         pWb35Rx->EP3vm_state = VM_RUNNING;
275
276         retv = usb_submit_urb(urb, GFP_ATOMIC);
277
278         if (retv != 0) {
279                 dev_info(&hw->wiphy->dev, "Rx URB sending error\n");
280                 goto error;
281         }
282         return;
283
284 error:
285         /* VM stop */
286         pWb35Rx->EP3vm_state = VM_STOP;
287         atomic_dec(&pWb35Rx->RxFireCounter);
288 }
289
290 void Wb35Rx_start(struct ieee80211_hw *hw)
291 {
292         struct wbsoft_priv      *priv = hw->priv;
293         struct hw_data          *pHwData = &priv->sHwData;
294         struct wb35_rx          *pWb35Rx = &pHwData->Wb35Rx;
295
296         /* Allow only one thread to run into the Wb35Rx() function */
297         if (atomic_inc_return(&pWb35Rx->RxFireCounter) == 1) {
298                 pWb35Rx->EP3vm_state = VM_RUNNING;
299                 Wb35Rx(hw);
300         } else
301                 atomic_dec(&pWb35Rx->RxFireCounter);
302 }
303
304 static void Wb35Rx_reset_descriptor(struct hw_data *pHwData)
305 {
306         struct wb35_rx  *pWb35Rx = &pHwData->Wb35Rx;
307         u32             i;
308
309         pWb35Rx->ByteReceived = 0;
310         pWb35Rx->RxProcessIndex = 0;
311         pWb35Rx->RxBufferId = 0;
312         pWb35Rx->EP3vm_state = VM_STOP;
313         pWb35Rx->rx_halt = 0;
314
315         /* Initial the Queue. The last buffer is reserved for used
316          * if the Rx resource is unavailable.
317          */
318         for (i = 0; i < MAX_USB_RX_BUFFER_NUMBER; i++)
319                 pWb35Rx->RxOwner[i] = 1;
320 }
321
322 unsigned char Wb35Rx_initial(struct hw_data *pHwData)
323 {
324         struct wb35_rx *pWb35Rx = &pHwData->Wb35Rx;
325
326         /* Initial the Buffer Queue */
327         Wb35Rx_reset_descriptor(pHwData);
328
329         pWb35Rx->RxUrb = usb_alloc_urb(0, GFP_ATOMIC);
330         return !!pWb35Rx->RxUrb;
331 }
332
333 void Wb35Rx_stop(struct hw_data *pHwData)
334 {
335         struct wb35_rx *pWb35Rx = &pHwData->Wb35Rx;
336
337         /* Canceling the Irp if already sends it out. */
338         if (pWb35Rx->EP3vm_state == VM_RUNNING) {
339                 /* Only use unlink, let Wb35Rx_destroy to free them */
340                 usb_unlink_urb(pWb35Rx->RxUrb);
341                 pr_debug("EP3 Rx stop\n");
342         }
343 }
344
345 /* Needs process context */
346 void Wb35Rx_destroy(struct hw_data *pHwData)
347 {
348         struct wb35_rx *pWb35Rx = &pHwData->Wb35Rx;
349
350         do {
351                 msleep(10); /* Delay for waiting function enter */
352         } while (pWb35Rx->EP3vm_state != VM_STOP);
353         msleep(10); /* Delay for waiting function exit */
354
355         usb_free_urb(pWb35Rx->RxUrb);
356         pr_debug("Wb35Rx_destroy OK\n");
357 }
358