2 * Copyright (c) 1996, 2003 VIA Networking Technologies, Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 * Purpose: Handle USB control endpoint
29 * CONTROLnsRequestOut - Write variable length bytes to MEM/BB/MAC/EEPROM
30 * CONTROLnsRequestIn - Read variable length bytes from MEM/BB/MAC/EEPROM
31 * ControlvWriteByte - Write one byte to MEM/BB/MAC/EEPROM
32 * ControlvReadByte - Read one byte from MEM/BB/MAC/EEPROM
33 * ControlvMaskByte - Read one byte from MEM/BB/MAC/EEPROM and clear/set some bits in the same address
36 * 04-05-2004 Jerry Chen: Initial release
37 * 11-24-2004 Warren Hsu: Add ControlvWriteByte,ControlvReadByte,ControlvMaskByte
50 //endpoint 1: interrupt
51 //endpoint 2: read bulk
52 //endpoint 3: write bulk
54 //static int msglevel =MSG_LEVEL_DEBUG;
55 static int msglevel
=MSG_LEVEL_INFO
;
57 #define USB_CTL_WAIT 500 //ms
59 #ifndef URB_ASYNC_UNLINK
60 #define URB_ASYNC_UNLINK 0
63 static void s_nsInterruptUsbIoCompleteRead(struct urb
*urb
);
64 static void s_nsBulkInUsbIoCompleteRead(struct urb
*urb
);
65 static void s_nsBulkOutIoCompleteWrite(struct urb
*urb
);
66 static void s_nsControlInUsbIoCompleteRead(struct urb
*urb
);
67 static void s_nsControlInUsbIoCompleteWrite(struct urb
*urb
);
69 int PIPEnsControlOutAsyn(struct vnt_private
*pDevice
, u8 byRequest
,
70 u16 wValue
, u16 wIndex
, u16 wLength
, u8
*pbyBuffer
)
74 if (pDevice
->Flags
& fMP_DISCONNECTED
)
75 return STATUS_FAILURE
;
77 if (pDevice
->Flags
& fMP_CONTROL_WRITES
)
78 return STATUS_FAILURE
;
81 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"in_interrupt return ..byRequest %x\n", byRequest
);
82 return STATUS_FAILURE
;
85 ntStatus
= usb_control_msg(
87 usb_sndctrlpipe(pDevice
->usb
, 0),
97 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"usb_sndctrlpipe ntStatus= %d\n", ntStatus
);
100 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"usb_sndctrlpipe fail, ntStatus= %d\n", ntStatus
);
106 int PIPEnsControlOut(struct vnt_private
*pDevice
, u8 byRequest
, u16 wValue
,
107 u16 wIndex
, u16 wLength
, u8
*pbyBuffer
)
112 if (pDevice
->Flags
& fMP_DISCONNECTED
)
113 return STATUS_FAILURE
;
115 if (pDevice
->Flags
& fMP_CONTROL_WRITES
)
116 return STATUS_FAILURE
;
118 if (pDevice
->Flags
& fMP_CONTROL_READS
)
119 return STATUS_FAILURE
;
121 if (pDevice
->pControlURB
->hcpriv
)
122 return STATUS_FAILURE
;
124 MP_SET_FLAG(pDevice
, fMP_CONTROL_WRITES
);
126 pDevice
->sUsbCtlRequest
.bRequestType
= 0x40;
127 pDevice
->sUsbCtlRequest
.bRequest
= byRequest
;
128 pDevice
->sUsbCtlRequest
.wValue
= cpu_to_le16p(&wValue
);
129 pDevice
->sUsbCtlRequest
.wIndex
= cpu_to_le16p(&wIndex
);
130 pDevice
->sUsbCtlRequest
.wLength
= cpu_to_le16p(&wLength
);
131 pDevice
->pControlURB
->transfer_flags
|= URB_ASYNC_UNLINK
;
132 pDevice
->pControlURB
->actual_length
= 0;
133 // Notice, pbyBuffer limited point to variable buffer, can't be constant.
134 usb_fill_control_urb(pDevice
->pControlURB
, pDevice
->usb
,
135 usb_sndctrlpipe(pDevice
->usb
, 0), (char *) &pDevice
->sUsbCtlRequest
,
136 pbyBuffer
, wLength
, s_nsControlInUsbIoCompleteWrite
, pDevice
);
138 ntStatus
= usb_submit_urb(pDevice
->pControlURB
, GFP_ATOMIC
);
140 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
141 "control send request submission failed: %d\n",
143 MP_CLEAR_FLAG(pDevice
, fMP_CONTROL_WRITES
);
144 return STATUS_FAILURE
;
147 spin_unlock_irq(&pDevice
->lock
);
148 for (ii
= 0; ii
<= USB_CTL_WAIT
; ii
++) {
150 if (pDevice
->Flags
& fMP_CONTROL_WRITES
)
155 if (ii
>= USB_CTL_WAIT
) {
156 DBG_PRT(MSG_LEVEL_DEBUG
,
157 KERN_INFO
"control send request submission timeout\n");
158 spin_lock_irq(&pDevice
->lock
);
159 MP_CLEAR_FLAG(pDevice
, fMP_CONTROL_WRITES
);
160 return STATUS_FAILURE
;
163 spin_lock_irq(&pDevice
->lock
);
165 return STATUS_SUCCESS
;
168 int PIPEnsControlIn(struct vnt_private
*pDevice
, u8 byRequest
, u16 wValue
,
169 u16 wIndex
, u16 wLength
, u8
*pbyBuffer
)
174 if (pDevice
->Flags
& fMP_DISCONNECTED
)
175 return STATUS_FAILURE
;
177 if (pDevice
->Flags
& fMP_CONTROL_READS
)
178 return STATUS_FAILURE
;
180 if (pDevice
->Flags
& fMP_CONTROL_WRITES
)
181 return STATUS_FAILURE
;
183 if (pDevice
->pControlURB
->hcpriv
)
184 return STATUS_FAILURE
;
186 MP_SET_FLAG(pDevice
, fMP_CONTROL_READS
);
188 pDevice
->sUsbCtlRequest
.bRequestType
= 0xC0;
189 pDevice
->sUsbCtlRequest
.bRequest
= byRequest
;
190 pDevice
->sUsbCtlRequest
.wValue
= cpu_to_le16p(&wValue
);
191 pDevice
->sUsbCtlRequest
.wIndex
= cpu_to_le16p(&wIndex
);
192 pDevice
->sUsbCtlRequest
.wLength
= cpu_to_le16p(&wLength
);
193 pDevice
->pControlURB
->transfer_flags
|= URB_ASYNC_UNLINK
;
194 pDevice
->pControlURB
->actual_length
= 0;
195 usb_fill_control_urb(pDevice
->pControlURB
, pDevice
->usb
,
196 usb_rcvctrlpipe(pDevice
->usb
, 0), (char *) &pDevice
->sUsbCtlRequest
,
197 pbyBuffer
, wLength
, s_nsControlInUsbIoCompleteRead
, pDevice
);
199 ntStatus
= usb_submit_urb(pDevice
->pControlURB
, GFP_ATOMIC
);
201 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
202 "control request submission failed: %d\n", ntStatus
);
203 MP_CLEAR_FLAG(pDevice
, fMP_CONTROL_READS
);
204 return STATUS_FAILURE
;
207 spin_unlock_irq(&pDevice
->lock
);
208 for (ii
= 0; ii
<= USB_CTL_WAIT
; ii
++) {
210 if (pDevice
->Flags
& fMP_CONTROL_READS
)
215 if (ii
>= USB_CTL_WAIT
) {
216 DBG_PRT(MSG_LEVEL_DEBUG
,
217 KERN_INFO
"control rcv request submission timeout\n");
218 spin_lock_irq(&pDevice
->lock
);
219 MP_CLEAR_FLAG(pDevice
, fMP_CONTROL_READS
);
220 return STATUS_FAILURE
;
223 spin_lock_irq(&pDevice
->lock
);
228 static void s_nsControlInUsbIoCompleteWrite(struct urb
*urb
)
230 struct vnt_private
*pDevice
= (struct vnt_private
*)urb
->context
;
232 pDevice
= urb
->context
;
233 switch (urb
->status
) {
237 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"ctrl write urb status EINPROGRESS%d\n", urb
->status
);
240 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"ctrl write urb status ENOENT %d\n", urb
->status
);
243 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"ctrl write urb status %d\n", urb
->status
);
246 MP_CLEAR_FLAG(pDevice
, fMP_CONTROL_WRITES
);
251 * Complete function of usb Control callback
255 * pDevice - Pointer to the adapter
260 * Return Value: STATUS_INSUFFICIENT_RESOURCES or result of IoCallDriver
264 static void s_nsControlInUsbIoCompleteRead(struct urb
*urb
)
266 struct vnt_private
*pDevice
= (struct vnt_private
*)urb
->context
;
268 switch (urb
->status
) {
272 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"ctrl read urb status EINPROGRESS%d\n", urb
->status
);
275 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"ctrl read urb status = ENOENT %d\n", urb
->status
);
278 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"ctrl read urb status %d\n", urb
->status
);
281 MP_CLEAR_FLAG(pDevice
, fMP_CONTROL_READS
);
286 * Allocates an usb interrupt in irp and calls USBD.
290 * pDevice - Pointer to the adapter
294 * Return Value: STATUS_INSUFFICIENT_RESOURCES or result of IoCallDriver
298 int PIPEnsInterruptRead(struct vnt_private
*pDevice
)
300 int ntStatus
= STATUS_FAILURE
;
302 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"---->s_nsStartInterruptUsbRead()\n");
304 if(pDevice
->intBuf
.bInUse
== true){
305 return (STATUS_FAILURE
);
307 pDevice
->intBuf
.bInUse
= true;
308 // pDevice->bEventAvailable = false;
309 pDevice
->ulIntInPosted
++;
312 // Now that we have created the urb, we will send a
313 // request to the USB device object.
315 pDevice
->pInterruptURB
->interval
= pDevice
->int_interval
;
317 usb_fill_bulk_urb(pDevice
->pInterruptURB
,
319 usb_rcvbulkpipe(pDevice
->usb
, 1),
320 (void *) pDevice
->intBuf
.pDataBuf
,
322 s_nsInterruptUsbIoCompleteRead
,
325 ntStatus
= usb_submit_urb(pDevice
->pInterruptURB
, GFP_ATOMIC
);
327 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"Submit int URB failed %d\n", ntStatus
);
330 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"<----s_nsStartInterruptUsbRead Return(%x)\n",ntStatus
);
336 * Complete function of usb interrupt in irp.
340 * pDevice - Pointer to the adapter
345 * Return Value: STATUS_INSUFFICIENT_RESOURCES or result of IoCallDriver
349 static void s_nsInterruptUsbIoCompleteRead(struct urb
*urb
)
351 struct vnt_private
*pDevice
= (struct vnt_private
*)urb
->context
;
354 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"---->s_nsInterruptUsbIoCompleteRead\n");
356 // The context given to IoSetCompletionRoutine is the receive buffer object
360 // We have a number of cases:
361 // 1) The USB read timed out and we received no data.
362 // 2) The USB read timed out and we received some data.
363 // 3) The USB read was successful and fully filled our irp buffer.
364 // 4) The irp was cancelled.
365 // 5) Some other failure from the USB device object.
367 ntStatus
= urb
->status
;
369 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"s_nsInterruptUsbIoCompleteRead Status %d\n", ntStatus
);
371 // if we were not successful, we need to free the int buffer for future use right here
372 // otherwise interrupt data handler will free int buffer after it handle it.
373 if (( ntStatus
!= STATUS_SUCCESS
)) {
374 pDevice
->ulBulkInError
++;
375 pDevice
->intBuf
.bInUse
= false;
377 // if (ntStatus == USBD_STATUS_CRC) {
378 // pDevice->ulIntInContCRCError++;
381 // if (ntStatus == STATUS_NOT_CONNECTED )
383 pDevice
->fKillEventPollingThread
= true;
385 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"IntUSBIoCompleteControl STATUS = %d\n", ntStatus
);
387 pDevice
->ulIntInBytesRead
+= (unsigned long) urb
->actual_length
;
388 pDevice
->ulIntInContCRCError
= 0;
389 pDevice
->bEventAvailable
= true;
390 INTnsProcessData(pDevice
);
393 if (pDevice
->fKillEventPollingThread
!= true) {
394 usb_fill_bulk_urb(pDevice
->pInterruptURB
,
396 usb_rcvbulkpipe(pDevice
->usb
, 1),
397 (void *) pDevice
->intBuf
.pDataBuf
,
399 s_nsInterruptUsbIoCompleteRead
,
402 ntStatus
= usb_submit_urb(pDevice
->pInterruptURB
, GFP_ATOMIC
);
404 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"Submit int URB failed %d\n", ntStatus
);
408 // We return STATUS_MORE_PROCESSING_REQUIRED so that the completion
409 // routine (IofCompleteRequest) will stop working on the irp.
416 * Allocates an usb BulkIn irp and calls USBD.
420 * pDevice - Pointer to the adapter
424 * Return Value: STATUS_INSUFFICIENT_RESOURCES or result of IoCallDriver
428 int PIPEnsBulkInUsbRead(struct vnt_private
*pDevice
, struct vnt_rcb
*pRCB
)
433 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"---->s_nsStartBulkInUsbRead\n");
435 if (pDevice
->Flags
& fMP_DISCONNECTED
)
436 return STATUS_FAILURE
;
438 pDevice
->ulBulkInPosted
++;
442 // Now that we have created the urb, we will send a
443 // request to the USB device object.
445 if (pRCB
->skb
== NULL
) {
446 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"pRCB->skb is null \n");
450 usb_fill_bulk_urb(pUrb
,
452 usb_rcvbulkpipe(pDevice
->usb
, 2),
453 (void *) (pRCB
->skb
->data
),
454 MAX_TOTAL_SIZE_WITH_ALL_HEADERS
,
455 s_nsBulkInUsbIoCompleteRead
,
458 ntStatus
= usb_submit_urb(pUrb
, GFP_ATOMIC
);
460 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"Submit Rx URB failed %d\n", ntStatus
);
461 return STATUS_FAILURE
;
464 pRCB
->bBoolInUse
= true;
471 * Complete function of usb BulkIn irp.
475 * pDevice - Pointer to the adapter
480 * Return Value: STATUS_INSUFFICIENT_RESOURCES or result of IoCallDriver
484 static void s_nsBulkInUsbIoCompleteRead(struct urb
*urb
)
486 struct vnt_rcb
*pRCB
= (struct vnt_rcb
*)urb
->context
;
487 struct vnt_private
*pDevice
= pRCB
->pDevice
;
488 unsigned long bytesRead
;
489 int bIndicateReceive
= false;
490 int bReAllocSkb
= false;
493 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"---->s_nsBulkInUsbIoCompleteRead\n");
494 status
= urb
->status
;
495 bytesRead
= urb
->actual_length
;
498 pDevice
->ulBulkInError
++;
499 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"BULK In failed %d\n", status
);
501 // if (status == USBD_STATUS_CRC) {
502 // pDevice->ulBulkInContCRCError++;
504 // if (status == STATUS_DEVICE_NOT_CONNECTED )
506 // MP_SET_FLAG(pDevice, fMP_DISCONNECTED);
510 bIndicateReceive
= true;
511 pDevice
->ulBulkInContCRCError
= 0;
512 pDevice
->ulBulkInBytesRead
+= bytesRead
;
515 if (bIndicateReceive
) {
516 spin_lock(&pDevice
->lock
);
517 if (RXbBulkInProcessData(pDevice
, pRCB
, bytesRead
) == true)
519 spin_unlock(&pDevice
->lock
);
524 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"RxvFreeNormal %d \n",pDevice
->NumRecvFreeList
);
525 spin_lock(&pDevice
->lock
);
526 RXvFreeRCB(pRCB
, bReAllocSkb
);
527 spin_unlock(&pDevice
->lock
);
535 * Allocates an usb BulkOut irp and calls USBD.
539 * pDevice - Pointer to the adapter
543 * Return Value: STATUS_INSUFFICIENT_RESOURCES or result of IoCallDriver
547 int PIPEnsSendBulkOut(struct vnt_private
*pDevice
,
548 struct vnt_usb_send_context
*pContext
)
553 pDevice
->bPWBitOn
= false;
556 if (pDevice->pPendingBulkOutContext != NULL) {
557 pDevice->NumContextsQueued++;
558 EnqueueContext(pDevice->FirstTxContextQueue, pDevice->LastTxContextQueue, pContext);
559 status = STATUS_PENDING;
560 DBG_PRT(MSG_LEVEL_DEBUG, KERN_INFO"Send pending!\n");
565 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"s_nsSendBulkOut\n");
567 if (MP_IS_READY(pDevice
) && (pDevice
->Flags
& fMP_POST_WRITES
)) {
569 pUrb
= pContext
->pUrb
;
570 pDevice
->ulBulkOutPosted
++;
571 // pDevice->pPendingBulkOutContext = pContext;
575 usb_sndbulkpipe(pDevice
->usb
, 3),
576 (void *) &(pContext
->Data
[0]),
578 s_nsBulkOutIoCompleteWrite
,
581 status
= usb_submit_urb(pUrb
, GFP_ATOMIC
);
584 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"Submit Tx URB failed %d\n", status
);
585 pContext
->bBoolInUse
= false;
586 return STATUS_FAILURE
;
588 return STATUS_PENDING
;
591 pContext
->bBoolInUse
= false;
592 return STATUS_RESOURCES
;
597 * Description: s_nsBulkOutIoCompleteWrite
598 * 1a) Indicate to the protocol the status of the write.
599 * 1b) Return ownership of the packet to the protocol.
601 * 2) If any more packets are queue for sending, send another packet
603 * If the attempt to send the packet to the driver fails,
604 * return ownership of the packet to the protocol and
605 * try another packet (until one succeeds).
609 * pdoUsbDevObj - pointer to the USB device object which
611 * pIrp - the irp which was completed by the
613 * pContext - the context given to IoSetCompletionRoutine
614 * before calling IoCallDriver on the irp
615 * The pContext is a pointer to the USB device object.
619 * Return Value: STATUS_MORE_PROCESSING_REQUIRED - allows the completion routine
620 * (IofCompleteRequest) to stop working on the irp.
624 static void s_nsBulkOutIoCompleteWrite(struct urb
*urb
)
626 struct vnt_private
*pDevice
;
628 CONTEXT_TYPE ContextType
;
629 unsigned long ulBufLen
;
630 struct vnt_usb_send_context
*pContext
;
632 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"---->s_nsBulkOutIoCompleteWrite\n");
634 // The context given to IoSetCompletionRoutine is an USB_CONTEXT struct
636 pContext
= (struct vnt_usb_send_context
*)urb
->context
;
638 pDevice
= pContext
->pDevice
;
639 ContextType
= pContext
->Type
;
640 ulBufLen
= pContext
->uBufLen
;
642 if (!netif_device_present(pDevice
->dev
))
646 // Perform various IRP, URB, and buffer 'sanity checks'
649 status
= urb
->status
;
651 if(status
== STATUS_SUCCESS
) {
652 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"Write %d bytes\n",(int)ulBufLen
);
653 pDevice
->ulBulkOutBytesWrite
+= ulBufLen
;
654 pDevice
->ulBulkOutContCRCError
= 0;
656 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"BULK Out failed %d\n", status
);
657 pDevice
->ulBulkOutError
++;
660 // pDevice->ulCheckForHangCount = 0;
661 // pDevice->pPendingBulkOutContext = NULL;
663 if ( CONTEXT_DATA_PACKET
== ContextType
) {
664 // Indicate to the protocol the status of the sent packet and return
665 // ownership of the packet.
666 if (pContext
->pPacket
!= NULL
) {
667 dev_kfree_skb_irq(pContext
->pPacket
);
668 pContext
->pPacket
= NULL
;
669 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"tx %d bytes\n",(int)ulBufLen
);
672 pDevice
->dev
->trans_start
= jiffies
;
674 if (status
== STATUS_SUCCESS
) {
675 pDevice
->packetsSent
++;
678 DBG_PRT(MSG_LEVEL_DEBUG
, KERN_INFO
"Send USB error! [%08xh]\n", status
);
679 pDevice
->packetsSentDropped
++;
683 if (pDevice
->bLinkPass
== true) {
684 if (netif_queue_stopped(pDevice
->dev
))
685 netif_wake_queue(pDevice
->dev
);
687 pContext
->bBoolInUse
= false;