usbbulkdevlib.c

This the compressed USB driver source code for vxworks5.6. It has device controller driver and other

*
* The following are the input parameters 
*
* .IP <pBulkDev>
* pointer to USB/BULK-ONLY/SCSI device for which the command has to be formed.
*
* .IP <lun>
* logical unit number of media device
* 
* .IP <scsiCmd>
* identifies the SCSI command to be formed.
* 
* .IP <cmdParam1>
* parameter required to form a SCSI comamnd, if any.
*
* .IP <cmdParam2>
* parameter required to form a SCSI comamnd, if any.
*
* RETURNS: OK, or ERROR if the command is unsupported
* 
* ERRNO: none
*
*\NOMANUAL
*/

LOCAL STATUS usbBulkFormScsiCmd 
    (
    pUSB_BULK_DEV pBulkDev,        /* pointer to bulk device     */
    UINT8  lun,                    /* Logical Unit of media      */
    UINT16 scsiCmd,                /* SCSI command               */ 
    UINT32 cmdParam1,              /* command parameter          */
    UINT32 cmdParam2               /* command parameter          */
    )
    {

    BOOL status = OK;
    pUSB_BULK_DEV_LUN  pBulkDevLun = &pBulkDev->blkDevLun[lun];
    BLK_DEV           *pBlkDev     = (BLK_DEV *)pBulkDevLun;
    

    USB_BULK_DEBUG ("usbBulkFormScsiCmd: Forming command 0x%x 0x%x 0x%x" \
                   " on lun %d\n",scsiCmd,cmdParam1,cmdParam2,lun, 0, 0);

    /* Store the LUN value */
    pBulkDev->bulkCbw.lun       = lun;       

    switch (scsiCmd)
        {
        case USB_SCSI_WRITE10:    /* 10-byte SCSI WRITE command  */

             cmdParam1 += pBulkDevLun->blkOffset;  /* add offset to blk number */

            /* 
             * For WRITE10 command, cmdParam1 refers to the block number from
             * which cmdParam2 number of blocks are to be written. Calculate
             * the transfer length based on the block size and num. of blocks
             */

            pBulkDev->bulkCbw.dataXferLength = USB_BULK_SWAP_32(((cmdParam2) * 
                                               (pBlkDev->bd_bytesPerBlk))); 

            pBulkDev->bulkCbw.direction  = USB_CBW_DIR_OUT;

            pBulkDev->bulkCbw.length = 0x0A;

	    /* op code */
            pBulkDev->bulkCbw.CBD[0] = 0x2A;
	    
	    /* DPU, FOA,  and RELADR bits*/
            pBulkDev->bulkCbw.CBD[1] = 0x0;

	    /* lba is bytes 2-5  MSB first, LSB .last */
            pBulkDev->bulkCbw.CBD[2] = (UINT8) ((cmdParam1 & 0xFF000000)>>24); 
            pBulkDev->bulkCbw.CBD[3] = (UINT8) ((cmdParam1 & 0xFF0000)>>16);  
            pBulkDev->bulkCbw.CBD[4] = (UINT8) ((cmdParam1 & 0xFF00) >>8);
            pBulkDev->bulkCbw.CBD[5] = (UINT8)  (cmdParam1 & 0xFF);

	    /* Reserved */
            pBulkDev->bulkCbw.CBD[6] = 0x0;

	    /* transfer length */
            pBulkDev->bulkCbw.CBD[7] = (UINT8)((cmdParam2 & 0xFF00) >>8);
            pBulkDev->bulkCbw.CBD[8] = (UINT8)(cmdParam2 & 0xFF);

	    /* Control */
            pBulkDev->bulkCbw.CBD[9] = 0x0;	


            break;

        case USB_SCSI_WRITE6:    /* 6-byte SCSI WRITE command  */

             cmdParam1 += pBulkDevLun->blkOffset;  /* add offset to blk number */

            /* 
             * For WRITE6 command, cmdParam1 refers to the block number from
             * which cmdParam2 number of blocks are to be written. Calculate
             * the transfer length based on the block size and num. of blocks
             */

            pBulkDev->bulkCbw.dataXferLength = USB_BULK_SWAP_32(((cmdParam2) * 
                                               (pBlkDev->bd_bytesPerBlk))); 

            pBulkDev->bulkCbw.direction  = USB_CBW_DIR_OUT;
            
            pBulkDev->bulkCbw.length = 0x06;
            pBulkDev->bulkCbw.CBD[0] = USB_SCSI_WRITE6;
            pBulkDev->bulkCbw.CBD[1] = 0x0;
            pBulkDev->bulkCbw.CBD[2] = (UINT8)((cmdParam1 & 0xFF00) >>8) ;
            pBulkDev->bulkCbw.CBD[3] = (UINT8)(cmdParam1 & 0xFF);
            pBulkDev->bulkCbw.CBD[4] = (UINT8)cmdParam2;
            pBulkDev->bulkCbw.CBD[5] = 0x0; 
    
            break;

        case USB_SCSI_READ10:     /* 10-byte SCSI READ command */

             cmdParam1 += pBulkDevLun->blkOffset;  /* add offset to blk number */

            /* 
             * For READ10 command, cmdParam1 refers to the block number from
             * which cmdParam2 number of blocks are to be read. Calculate
             * the transfer length based on the block size and num. of blocks
             */ 
  
            pBulkDev->bulkCbw.dataXferLength = USB_BULK_SWAP_32(((cmdParam2) * 
                                               (pBlkDev->bd_bytesPerBlk))); 

            pBulkDev->bulkCbw.direction      = USB_CBW_DIR_IN;
            pBulkDev->bulkCbw.length = 0x0A;
            pBulkDev->bulkCbw.CBD[0] = 0x28;	/* op code */
            pBulkDev->bulkCbw.CBD[1] = 0x0;	/* DPU, FOA,  and RELADR bits*/
            pBulkDev->bulkCbw.CBD[2] = (UINT8) ((cmdParam1 & 0xFF000000)>>24); 
            pBulkDev->bulkCbw.CBD[3] = (UINT8) ((cmdParam1 & 0xFF0000)>>16);  
            pBulkDev->bulkCbw.CBD[4] = (UINT8) ((cmdParam1 & 0xFF00) >>8); /* lba is bytes 2-5 */
            pBulkDev->bulkCbw.CBD[5] = (UINT8)  (cmdParam1 & 0xFF);        /* lba is bytes 2-5  LSB*/
            pBulkDev->bulkCbw.CBD[6] = 0x0;	/* Reserved */
            pBulkDev->bulkCbw.CBD[7] = (UINT8)((cmdParam2 & 0xFF00) >>8);	/* transfer length MSB */
            pBulkDev->bulkCbw.CBD[8] = (UINT8)(cmdParam2 & 0xFF);	/* transfer length LSB */
            pBulkDev->bulkCbw.CBD[9] = 0x0;	/* Control */

            break;

        case USB_SCSI_READ6:     /* 6-byte SCSI READ command */

             cmdParam1 += pBulkDevLun->blkOffset;  /* add offset to blk number */

            /* 
             * For READ6 command, cmdParam1 refers to the block number from
             * which cmdParam2 number of blocks are to be read. Calculate
             * the transfer length based on the block size and num. of blocks
             */ 
  
            pBulkDev->bulkCbw.dataXferLength = USB_BULK_SWAP_32(((cmdParam2) * 
                                               (pBlkDev->bd_bytesPerBlk))); 

            pBulkDev->bulkCbw.direction      = USB_CBW_DIR_IN;
            pBulkDev->bulkCbw.length = 0x06;
            pBulkDev->bulkCbw.CBD[0] = USB_SCSI_READ6;
            pBulkDev->bulkCbw.CBD[1] = 0x0;
            pBulkDev->bulkCbw.CBD[2] = (UINT8)((cmdParam1 & 0xFF00) >>8) ;
            pBulkDev->bulkCbw.CBD[3] = (UINT8)(cmdParam1 & 0xFF);
            pBulkDev->bulkCbw.CBD[4] = (UINT8)cmdParam2;
            pBulkDev->bulkCbw.CBD[5] = 0x0; 

            break;

	case USB_SCSI_INQUIRY:   /* Standard 36-byte INQUIRY command */

            pBulkDev->bulkCbw.dataXferLength = USB_BULK_SWAP_32 (USB_SCSI_STD_INQUIRY_LEN); 
            pBulkDev->bulkCbw.direction      = USB_CBW_DIR_IN;

            pBulkDev->bulkCbw.length  = 0x06;
            pBulkDev->bulkCbw.CBD[0]  = USB_SCSI_INQUIRY;
            pBulkDev->bulkCbw.CBD[1]  = 0x0;
            pBulkDev->bulkCbw.CBD[2]  = 0x0;
            pBulkDev->bulkCbw.CBD[3]  = 0x0;
            pBulkDev->bulkCbw.CBD[4]  = USB_SCSI_STD_INQUIRY_LEN;
            pBulkDev->bulkCbw.CBD[5]  = 0x0; 

            break;

        case USB_SCSI_START_STOP_UNIT:      /* for Eject/start media command */

            /* Eject applicable only for removable media */

             if ((cmdParam1 == USB_SCSI_START_STOP_LOEJ) &
                (pBlkDev->bd_removable != TRUE)) 
                {
                status = ERROR;
                break;
                }

            pBulkDev->bulkCbw.dataXferLength = 0; 
            pBulkDev->bulkCbw.direction  = USB_CBW_DIR_NONE;

            pBulkDev->bulkCbw.length = 0x06;
            pBulkDev->bulkCbw.CBD[0] = USB_SCSI_START_STOP_UNIT;
            pBulkDev->bulkCbw.CBD[1] = 0x0;
            pBulkDev->bulkCbw.CBD[2] = 0x0;
            pBulkDev->bulkCbw.CBD[3] = 0x0;
            pBulkDev->bulkCbw.CBD[4] = (UINT8)cmdParam1;
            pBulkDev->bulkCbw.CBD[5] = 0x0; 

            break;

        case USB_SCSI_TEST_UNIT_READY: /* Test unit ready command */ 

            pBulkDev->bulkCbw.dataXferLength = 0; 
            pBulkDev->bulkCbw.direction  = USB_CBW_DIR_NONE;

            pBulkDev->bulkCbw.length = 0x06;
            pBulkDev->bulkCbw.CBD[0] = USB_SCSI_TEST_UNIT_READY;
            pBulkDev->bulkCbw.CBD[1] = 0x0;
            pBulkDev->bulkCbw.CBD[2] = 0x0;
            pBulkDev->bulkCbw.CBD[3] = 0x0;
            pBulkDev->bulkCbw.CBD[4] = 0x0;
            pBulkDev->bulkCbw.CBD[5] = 0x0; 

            break;
 
        case USB_SCSI_REQ_SENSE:      /* Request sense command */ 

            pBulkDev->bulkCbw.dataXferLength = 
                                    USB_BULK_SWAP_32(USB_SCSI_REQ_SENSE_LEN); 
            pBulkDev->bulkCbw.direction  = USB_CBW_DIR_IN;

            pBulkDev->bulkCbw.length = 0x06;
            pBulkDev->bulkCbw.CBD[0] = USB_SCSI_REQ_SENSE;
            pBulkDev->bulkCbw.CBD[1] = 0x0;
            pBulkDev->bulkCbw.CBD[2] = 0x0;
            pBulkDev->bulkCbw.CBD[3] = 0x0;
            pBulkDev->bulkCbw.CBD[4] = USB_SCSI_REQ_SENSE_LEN;
            pBulkDev->bulkCbw.CBD[5] = 0x0; 

            break;

        case USB_SCSI_FORMAT_UNIT:    /* Format Unit command */ 

            /* issue a FORMAT UNIT command with default parameters */

            pBulkDev->bulkCbw.dataXferLength = 0; 
            pBulkDev->bulkCbw.direction  = USB_CBW_DIR_NONE;

            pBulkDev->bulkCbw.length = 0x06;
            pBulkDev->bulkCbw.CBD[0] = USB_SCSI_FORMAT_UNIT;
            pBulkDev->bulkCbw.CBD[1] = 0x0;
            pBulkDev->bulkCbw.CBD[2] = 0x0;
            pBulkDev->bulkCbw.CBD[3] = 0x0;
            pBulkDev->bulkCbw.CBD[4] = 0x0;
            pBulkDev->bulkCbw.CBD[5] = 0x0; 

            break;
    
        case USB_SCSI_READ_CAPACITY:  /* Read capacity command */

            /* 
             * Provides a means to request information regarding the capacity 
             * of the logical unit. The response will consists of number of 
             * logical blocks present and the size of the block.
             */

            pBulkDev->bulkCbw.dataXferLength = 
                                      USB_BULK_SWAP_32(USB_SCSI_READ_CAP_LEN); 
            pBulkDev->bulkCbw.direction  = USB_CBW_DIR_IN;


            pBulkDev->bulkCbw.length = 0x0A; 
            memset(pBulkDev->bulkCbw.CBD,0,sizeof(pBulkDev->bulkCbw.CBD));
            pBulkDev->bulkCbw.CBD[0] = USB_SCSI_READ_CAPACITY;
            break;

        case USB_SCSI_PREVENT_REMOVAL: /* Prevent media removal command */

            /* Applicable only for removable media. Disables removal of media */    

            if (pBlkDev->bd_removable  != TRUE) 
                {
                status = ERROR;
                break;
                }

            pBulkDev->bulkCbw.dataXferLength = 0; 
            pBulkDev->bulkCbw.direction  = USB_CBW_DIR_NONE;

            pBulkDev->bulkCbw.length = 0x06;
            pBulkDev->bulkCbw.CBD[0] = USB_SCSI_PREVENT_REMOVAL;
            pBulkDev->bulkCbw.CBD[1] = 0x0;
            pBulkDev->bulkCbw.CBD[2] = 0x0;
            pBulkDev->bulkCbw.CBD[3] = 0x0;
            pBulkDev->bulkCbw.CBD[4] = 0x0;
            pBulkDev->bulkCbw.CBD[5] = 0x0; 

            break; 
         
        default: 
            status= ERROR;
        }
 
    return (status);
 
    } 

/***************************************************************************
*
* usbBulkCmdExecute - Executes a previously formed command block. 
*
* This routine transports the CBW across the BULK_OUT endpoint followed by
* a data transfer phase(if required) to/from the device depending on the 
* direction bit.  After data transfer, CSW is received from the device.
* 
* All transactions to the device are done by forming IRP's initilized with  
* command dependent values.
*
* RETURNS: OK on success, or ERROR if failed to execute
*
* ERRNO:
* \is
* \i USB_INTERNAL_ERROR
* Error in USB Stack
* 
* \i USB_IRP_FAILED
* Failed to transfer the IRP
*
* \i USB_BULK_IO_ERROR
* Bulk input\optput layer
*
* \i USB_INVALID_CSW
* Invalid Command Status Wrapper
*
* \i USB_DATA_INCOMPLETE
* Data Transfer did not complete
*
* \i USB_COMMAND_FAILED
* Failed to execute the command sent in CBW
*
* \i USB_PHASE_ERROR
* Phase Error while executing the command
* \ie
*
*\NOMANUAL
*/

LOCAL USB_COMMAND_STATUS usbBulkCmdExecute
    ( 
    pUSB_BULK_DEV pBulkDev       /* pointer to bulk device */ 
    )
    {
    pUSB_BULK_CSW pCsw ;

    /* Verify the parameter is non-null */
    if (pBulkDev == NULL)
        return(USB_INTERNAL_ERROR);

    if ( pBulkDev->connected == FALSE )
	return (USB_INTERNAL_ERROR);


    if ( OSS_SEM_TAKE (pBulkDev->bulkIrpSem, usbBulkIrpTimeOut + 1000) == ERROR )
        {
        USB_BULK_DEBUG ("usbBulkCmdExecute: Irp in Use \n", 0, 0, 0, 0, 0, 0);
        return (USB_INTERNAL_ERROR);
        }


    /* Form an IRP to submit the command block on BULK OUT pipe */
    pBulkDev->outIrp.result            = 0; 
    pBulkDev->outIrp.transferLen       = USB_CBW_LENGTH;


    pBulkDev->outIrp.bfrList[0].pBfr   = (UINT8 *)&(pBulkDev->bulkCbw);
    pBulkDev->outIrp.bfrList[0].bfrLen = USB_CBW_LENGTH;

    /* Submit IRP */
 
    if (usbdTransfer (usbdHandle, 
		      pBulkDev->outPipeHandle, 
		      &(pBulkDev->outIrp)) 
		    != OK)
        {
        USB_BULK_ERR ("usbBulkCmdExecute: Unable to submit CBW IRP for transfer\n",
                      0, 0, 0, 0, 0, 0);
        return (USB_INTERNAL_ERROR);
        }

    /* Wait till the transfer of IRP completes or time out */
 
    if ( OSS_SEM_TAKE (pBulkDev->bulkIrpSem, 
                       usbBulkIrpTimeOut + USB_BULK_OFFS) 
		     == ERROR )
        {
        USB_BULK_DEBUG ("usbBulkCmdExecute: Irp Time out \n", 0, 0, 0, 0, 0, 0);

        /* Cancel the IRP */
        usbdTransferAbort(usbdHandle,
                          pBulkDev->outPipeHandle, 
                          &(pBulkDev->outIrp));