1 // SPDX-License-Identifier: GPL-2.0 2 #include <scsi/scsi.h> 3 #include <scsi/scsi_host.h> 4 #include <scsi/scsi_cmnd.h> 5 #include <scsi/scsi_device.h> 6 #include <linux/usb.h> 7 #include <linux/module.h> 8 #include <linux/slab.h> 9 10 #include "usb.h" 11 #include "transport.h" 12 #include "protocol.h" 13 #include "scsiglue.h" 14 #include "sierra_ms.h" 15 #include "debug.h" 16 17 #define SWIMS_USB_REQUEST_SetSwocMode 0x0B 18 #define SWIMS_USB_REQUEST_GetSwocInfo 0x0A 19 #define SWIMS_USB_INDEX_SetMode 0x0000 20 #define SWIMS_SET_MODE_Modem 0x0001 21 22 #define TRU_NORMAL 0x01 23 #define TRU_FORCE_MS 0x02 24 #define TRU_FORCE_MODEM 0x03 25 26 static unsigned int swi_tru_install = 1; 27 module_param(swi_tru_install, uint, S_IRUGO | S_IWUSR); 28 MODULE_PARM_DESC(swi_tru_install, "TRU-Install mode (1=Full Logic (def)," 29 " 2=Force CD-Rom, 3=Force Modem)"); 30 31 struct swoc_info { 32 __u8 rev; 33 __u8 reserved[8]; 34 __u16 LinuxSKU; 35 __u16 LinuxVer; 36 __u8 reserved2[47]; 37 } __attribute__((__packed__)); 38 39 static bool containsFullLinuxPackage(struct swoc_info *swocInfo) 40 { 41 if ((swocInfo->LinuxSKU >= 0x2100 && swocInfo->LinuxSKU <= 0x2FFF) || 42 (swocInfo->LinuxSKU >= 0x7100 && swocInfo->LinuxSKU <= 0x7FFF)) 43 return true; 44 else 45 return false; 46 } 47 48 static int sierra_set_ms_mode(struct usb_device *udev, __u16 eSWocMode) 49 { 50 int result; 51 dev_dbg(&udev->dev, "SWIMS: %s", "DEVICE MODE SWITCH\n"); 52 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 53 SWIMS_USB_REQUEST_SetSwocMode, /* __u8 request */ 54 USB_TYPE_VENDOR | USB_DIR_OUT, /* __u8 request type */ 55 eSWocMode, /* __u16 value */ 56 0x0000, /* __u16 index */ 57 NULL, /* void *data */ 58 0, /* __u16 size */ 59 USB_CTRL_SET_TIMEOUT); /* int timeout */ 60 return result; 61 } 62 63 64 static int sierra_get_swoc_info(struct usb_device *udev, 65 struct swoc_info *swocInfo) 66 { 67 int result; 68 69 dev_dbg(&udev->dev, "SWIMS: Attempting to get TRU-Install info\n"); 70 71 result = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0), 72 SWIMS_USB_REQUEST_GetSwocInfo, /* __u8 request */ 73 USB_TYPE_VENDOR | USB_DIR_IN, /* __u8 request type */ 74 0, /* __u16 value */ 75 0, /* __u16 index */ 76 (void *) swocInfo, /* void *data */ 77 sizeof(struct swoc_info), /* __u16 size */ 78 USB_CTRL_SET_TIMEOUT); /* int timeout */ 79 80 /* 81 * A short IN transfer leaves the tail of swocInfo uninitialized; 82 * only a full transfer is valid. 83 */ 84 if (result != sizeof(struct swoc_info)) 85 return -EIO; 86 87 swocInfo->LinuxSKU = le16_to_cpu(swocInfo->LinuxSKU); 88 swocInfo->LinuxVer = le16_to_cpu(swocInfo->LinuxVer); 89 return result; 90 } 91 92 static void debug_swoc(const struct device *dev, struct swoc_info *swocInfo) 93 { 94 dev_dbg(dev, "SWIMS: SWoC Rev: %02d\n", swocInfo->rev); 95 dev_dbg(dev, "SWIMS: Linux SKU: %04X\n", swocInfo->LinuxSKU); 96 dev_dbg(dev, "SWIMS: Linux Version: %04X\n", swocInfo->LinuxVer); 97 } 98 99 100 static ssize_t truinst_show(struct device *dev, struct device_attribute *attr, 101 char *buf) 102 { 103 struct swoc_info *swocInfo; 104 struct usb_interface *intf = to_usb_interface(dev); 105 struct usb_device *udev = interface_to_usbdev(intf); 106 int result; 107 if (swi_tru_install == TRU_FORCE_MS) { 108 result = sysfs_emit(buf, "Forced Mass Storage\n"); 109 } else { 110 swocInfo = kmalloc_obj(struct swoc_info); 111 if (!swocInfo) { 112 sysfs_emit(buf, "Error\n"); 113 return -ENOMEM; 114 } 115 result = sierra_get_swoc_info(udev, swocInfo); 116 if (result < 0) { 117 dev_dbg(dev, "SWIMS: failed SWoC query\n"); 118 kfree(swocInfo); 119 sysfs_emit(buf, "Error\n"); 120 return -EIO; 121 } 122 debug_swoc(dev, swocInfo); 123 result = sysfs_emit(buf, 124 "REV=%02d SKU=%04X VER=%04X\n", 125 swocInfo->rev, 126 swocInfo->LinuxSKU, 127 swocInfo->LinuxVer); 128 kfree(swocInfo); 129 } 130 return result; 131 } 132 static DEVICE_ATTR_RO(truinst); 133 134 int sierra_ms_init(struct us_data *us) 135 { 136 int result, retries; 137 struct swoc_info *swocInfo; 138 struct usb_device *udev; 139 140 udev = us->pusb_dev; 141 142 /* Force Modem mode */ 143 if (swi_tru_install == TRU_FORCE_MODEM) { 144 usb_stor_dbg(us, "SWIMS: Forcing Modem Mode\n"); 145 result = sierra_set_ms_mode(udev, SWIMS_SET_MODE_Modem); 146 if (result < 0) 147 usb_stor_dbg(us, "SWIMS: Failed to switch to modem mode\n"); 148 return -EIO; 149 } 150 /* Force Mass Storage mode (keep CD-Rom) */ 151 else if (swi_tru_install == TRU_FORCE_MS) { 152 usb_stor_dbg(us, "SWIMS: Forcing Mass Storage Mode\n"); 153 goto complete; 154 } 155 /* Normal TRU-Install Logic */ 156 else { 157 usb_stor_dbg(us, "SWIMS: Normal SWoC Logic\n"); 158 159 swocInfo = kmalloc_obj(struct swoc_info); 160 if (!swocInfo) 161 return -ENOMEM; 162 163 retries = 3; 164 do { 165 retries--; 166 result = sierra_get_swoc_info(udev, swocInfo); 167 if (result < 0) { 168 usb_stor_dbg(us, "SWIMS: Failed SWoC query\n"); 169 schedule_timeout_uninterruptible(2*HZ); 170 } 171 } while (retries && result < 0); 172 173 if (result < 0) { 174 usb_stor_dbg(us, "SWIMS: Completely failed SWoC query\n"); 175 kfree(swocInfo); 176 return -EIO; 177 } 178 179 debug_swoc(&us->pusb_dev->dev, swocInfo); 180 181 /* 182 * If there is not Linux software on the TRU-Install device 183 * then switch to modem mode 184 */ 185 if (!containsFullLinuxPackage(swocInfo)) { 186 usb_stor_dbg(us, "SWIMS: Switching to Modem Mode\n"); 187 result = sierra_set_ms_mode(udev, 188 SWIMS_SET_MODE_Modem); 189 if (result < 0) 190 usb_stor_dbg(us, "SWIMS: Failed to switch modem\n"); 191 kfree(swocInfo); 192 return -EIO; 193 } 194 kfree(swocInfo); 195 } 196 complete: 197 return device_create_file(&us->pusb_intf->dev, &dev_attr_truinst); 198 } 199 200