KernelLand/Modules/USB/MSC/main.c

   1 /*
   2  * Acess2 USB Stack Mass Storage Driver
   3  * - By John Hodge (thePowersGang)
   4  *
   5  * main.c
   6  * - Driver Core
   7  */
   8 #define DEBUG   1
   9 #define VERSION VER2(0,1)
  10 #include <acess.h>
  11 #include <modules.h>
  12 #include "common.h"
  13 #include "msc_proto.h"
  14
  15 // === PROTOTYPES ===
  16  int    MSC_Initialise(char **Arguments);
  17  int    MSC_Cleanup(void);
  18 void    MSC_DeviceConnected(tUSBInterface *Dev, void *Descriptors, size_t DescriptorsLen);
  19 void    MSC_DataIn(tUSBInterface *Dev, int EndPt, int Length, void *Data);
  20 // --- Internal Helpers
  21  int    MSC_int_CreateCBW(tMSC_CBW *Cbw, int bInput, size_t CmdLen, const void *CmdData, size_t DataLen);
  22 void    MSC_SendData(tUSBInterface *Dev, size_t CmdLen, const void *CmdData, size_t DataLen, const void *Data);
  23 void    MSC_RecvData(tUSBInterface *Dev, size_t CmdLen, const void *CmdData, size_t DataLen, void *Data);
  24
  25 // === GLOBALS ===
  26 MODULE_DEFINE(0, VERSION, USB_MSC, MSC_Initialise, MSC_Cleanup, "USB_Core", NULL);
  27 tUSBDriver      gMSC_Driver_BulkOnly = {
  28         .Name = "MSC_BulkOnly",
  29         .Match = {.Class = {0x080050, 0xFF00FF}},
  30         .Connected = MSC_DeviceConnected,
  31         .MaxEndpoints = 2,
  32         .Endpoints = {
  33                 {0x82, MSC_DataIn},
  34                 {0x02, NULL},
  35                 }
  36         };
  37 int giMSC_NextTag;
  38
  39 // === CODE ===
  40 int MSC_Initialise(char **Arguments)
  41 {
  42         USB_RegisterDriver( &gMSC_Driver_BulkOnly );
  43         return 0;
  44 }
  45
  46 int MSC_Cleanup(void)
  47 {
  48         return 0;
  49 }
  50
  51 void MSC_DeviceConnected(tUSBInterface *Dev, void *Descriptors, size_t DescriptorsLen)
  52 {
  53         tMSCInfo        *info;
  54         tLVM_VolType    *vt;
  55
  56         info = malloc( sizeof(*info) );
  57         USB_SetDeviceDataPtr(Dev, info);
  58
  59         // Get the class code (and hence what command set is in use)
  60         Uint8   sc = (USB_GetInterfaceClass(Dev) & 0x00FF00) >> 8;
  61         switch( sc )
  62         {
  63         // SCSI Transparent Command Set
  64         case 0x06:
  65                 info->BlockCount = MSC_SCSI_GetSize(Dev, &info->BlockSize);
  66                 vt = &gMSC_SCSI_VolType;
  67                 break;
  68         // Unknown, prepare to chuck sad
  69         default:
  70                 Log_Error("USB MSC", "Unknown sub-class 0x%02x", sc);
  71                 USB_SetDeviceDataPtr(Dev, NULL);
  72                 free(info);
  73                 return ;
  74         }
  75
  76         // Create device name from Vendor ID, Device ID and Serial Number
  77         Uint16  vendor, devid;
  78         char    *serial_number;
  79         USB_GetDeviceVendor(Dev, &vendor, &devid);
  80         serial_number = USB_GetSerialNumber(Dev);
  81         if( !serial_number ) {
  82                 // No serial number - this breaks spec, but it's easy to handle
  83                 Log_Warning("USB MSC", "Device does not have a serial number, using a random one");
  84                 serial_number = malloc(4+8+1);
  85                 sprintf(serial_number, "rand%08x", rand());
  86         }
  87         char    name[4 + 4 + 1 + 4 + 1 + strlen(serial_number) + 1];
  88         sprintf(name, "usb-%04x:%04x-%s", vendor, devid, serial_number);
  89         free(serial_number);
  90
  91         // Pass the buck to LVM
  92         LOG("Device '%s' has 0x%llx blocks of 0x%x bytes", name, info->BlockCount, info->BlockSize);
  93         LVM_AddVolume(vt, name, Dev, info->BlockSize, info->BlockCount);
  94 }
  95
  96 void MSC_DataIn(tUSBInterface *Dev, int EndPt, int Length, void *Data)
  97 {
  98         // Will this ever be needed?
  99 }
 100
 101 /**
 102  * \brief Create a CBW structure
 103  */
 104 int MSC_int_CreateCBW(tMSC_CBW *Cbw, int bInput, size_t CmdLen, const void *CmdData, size_t DataLen)
 105 {
 106         if( CmdLen == 0 ) {
 107                 Log_Error("MSC", "Zero length commands are invalid");
 108                 return -1;
 109         }
 110
 111         if( CmdLen > 16 ) {
 112                 Log_Error("MSC", "Command data >16 bytes (%i)", CmdLen);
 113                 return -1;
 114         }
 115
 116         Cbw->dCBWSignature = LittleEndian32(0x43425355);
 117         Cbw->dCBWTag    = giMSC_NextTag ++;
 118         Cbw->dCBWDataTransferLength = LittleEndian32(DataLen);
 119         Cbw->bmCBWFlags = (bInput ? 0x80 : 0x00);
 120         Cbw->bCBWLUN    = 0;    // TODO: Logical Unit Number (param from proto)
 121         Cbw->bCBWLength = CmdLen;
 122         memcpy(Cbw->CBWCB, CmdData, CmdLen);
 123
 124         return 0;
 125 }
 126
 127 void MSC_SendData(tUSBInterface *Dev, size_t CmdLen, const void *CmdData, size_t DataLen, const void *Data)
 128 {
 129         tMSC_CBW        cbw;
 130         tMSC_CSW        csw;
 131         const int       endpoint_out = 2;
 132         const int       endpoint_in = 1;
 133
 134         if( MSC_int_CreateCBW(&cbw, 0, CmdLen, CmdData, DataLen) )
 135                 return ;
 136
 137         // Send CBW
 138         USB_SendData(Dev, endpoint_out, sizeof(cbw), &cbw);
 139
 140         // Send Data
 141         USB_SendData(Dev, endpoint_out, DataLen, Data);
 142
 143         // Read CSW
 144         USB_RecvData(Dev, endpoint_in, sizeof(csw), &csw);
 145         // TODO: Validate CSW
 146 }
 147
 148 void MSC_RecvData(tUSBInterface *Dev, size_t CmdLen, const void *CmdData, size_t DataLen, void *Data)
 149 {
 150         tMSC_CBW        cbw;
 151         tMSC_CSW        csw;
 152         const int       endpoint_out = 2;
 153         const int       endpoint_in = 1;
 154
 155         if( MSC_int_CreateCBW(&cbw, 1, CmdLen, CmdData, DataLen) )
 156                 return ;
 157
 158         // Send CBW
 159         USB_SendData(Dev, endpoint_out, sizeof(cbw), &cbw);
 160
 161         // Read Data
 162         // TODO: use async version and wait for the transaction to complete
 163         USB_RecvData(Dev, endpoint_in, DataLen, Data);
 164
 165         // Read CSW
 166         USB_RecvData(Dev, endpoint_in, sizeof(csw), &csw);
 167         // TODO: Validate CSW
 168 }
 169