uas.c 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776
  1. /*
  2. * USB Attached SCSI
  3. * Note that this is not the same as the USB Mass Storage driver
  4. *
  5. * Copyright Matthew Wilcox for Intel Corp, 2010
  6. * Copyright Sarah Sharp for Intel Corp, 2010
  7. *
  8. * Distributed under the terms of the GNU GPL, version two.
  9. */
  10. #include <linux/blkdev.h>
  11. #include <linux/slab.h>
  12. #include <linux/types.h>
  13. #include <linux/usb.h>
  14. #include <linux/usb/storage.h>
  15. #include <scsi/scsi.h>
  16. #include <scsi/scsi_dbg.h>
  17. #include <scsi/scsi_cmnd.h>
  18. #include <scsi/scsi_device.h>
  19. #include <scsi/scsi_host.h>
  20. #include <scsi/scsi_tcq.h>
  21. /* Common header for all IUs */
  22. struct iu {
  23. __u8 iu_id;
  24. __u8 rsvd1;
  25. __be16 tag;
  26. };
  27. enum {
  28. IU_ID_COMMAND = 0x01,
  29. IU_ID_STATUS = 0x03,
  30. IU_ID_RESPONSE = 0x04,
  31. IU_ID_TASK_MGMT = 0x05,
  32. IU_ID_READ_READY = 0x06,
  33. IU_ID_WRITE_READY = 0x07,
  34. };
  35. struct command_iu {
  36. __u8 iu_id;
  37. __u8 rsvd1;
  38. __be16 tag;
  39. __u8 prio_attr;
  40. __u8 rsvd5;
  41. __u8 len;
  42. __u8 rsvd7;
  43. struct scsi_lun lun;
  44. __u8 cdb[16]; /* XXX: Overflow-checking tools may misunderstand */
  45. };
  46. /*
  47. * Also used for the Read Ready and Write Ready IUs since they have the
  48. * same first four bytes
  49. */
  50. struct sense_iu {
  51. __u8 iu_id;
  52. __u8 rsvd1;
  53. __be16 tag;
  54. __be16 status_qual;
  55. __u8 status;
  56. __u8 rsvd7[7];
  57. __be16 len;
  58. __u8 sense[SCSI_SENSE_BUFFERSIZE];
  59. };
  60. /*
  61. * The r00-r01c specs define this version of the SENSE IU data structure.
  62. * It's still in use by several different firmware releases.
  63. */
  64. struct sense_iu_old {
  65. __u8 iu_id;
  66. __u8 rsvd1;
  67. __be16 tag;
  68. __be16 len;
  69. __u8 status;
  70. __u8 service_response;
  71. __u8 sense[SCSI_SENSE_BUFFERSIZE];
  72. };
  73. enum {
  74. CMD_PIPE_ID = 1,
  75. STATUS_PIPE_ID = 2,
  76. DATA_IN_PIPE_ID = 3,
  77. DATA_OUT_PIPE_ID = 4,
  78. UAS_SIMPLE_TAG = 0,
  79. UAS_HEAD_TAG = 1,
  80. UAS_ORDERED_TAG = 2,
  81. UAS_ACA = 4,
  82. };
  83. struct uas_dev_info {
  84. struct usb_interface *intf;
  85. struct usb_device *udev;
  86. int qdepth;
  87. unsigned cmd_pipe, status_pipe, data_in_pipe, data_out_pipe;
  88. unsigned use_streams:1;
  89. unsigned uas_sense_old:1;
  90. };
  91. enum {
  92. ALLOC_STATUS_URB = (1 << 0),
  93. SUBMIT_STATUS_URB = (1 << 1),
  94. ALLOC_DATA_IN_URB = (1 << 2),
  95. SUBMIT_DATA_IN_URB = (1 << 3),
  96. ALLOC_DATA_OUT_URB = (1 << 4),
  97. SUBMIT_DATA_OUT_URB = (1 << 5),
  98. ALLOC_CMD_URB = (1 << 6),
  99. SUBMIT_CMD_URB = (1 << 7),
  100. };
  101. /* Overrides scsi_pointer */
  102. struct uas_cmd_info {
  103. unsigned int state;
  104. unsigned int stream;
  105. struct urb *cmd_urb;
  106. struct urb *status_urb;
  107. struct urb *data_in_urb;
  108. struct urb *data_out_urb;
  109. struct list_head list;
  110. };
  111. /* I hate forward declarations, but I actually have a loop */
  112. static int uas_submit_urbs(struct scsi_cmnd *cmnd,
  113. struct uas_dev_info *devinfo, gfp_t gfp);
  114. static DEFINE_SPINLOCK(uas_work_lock);
  115. static LIST_HEAD(uas_work_list);
  116. static void uas_do_work(struct work_struct *work)
  117. {
  118. struct uas_cmd_info *cmdinfo;
  119. struct list_head list;
  120. spin_lock_irq(&uas_work_lock);
  121. list_replace_init(&uas_work_list, &list);
  122. spin_unlock_irq(&uas_work_lock);
  123. list_for_each_entry(cmdinfo, &list, list) {
  124. struct scsi_pointer *scp = (void *)cmdinfo;
  125. struct scsi_cmnd *cmnd = container_of(scp,
  126. struct scsi_cmnd, SCp);
  127. uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_NOIO);
  128. }
  129. }
  130. static DECLARE_WORK(uas_work, uas_do_work);
  131. static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
  132. {
  133. struct sense_iu *sense_iu = urb->transfer_buffer;
  134. struct scsi_device *sdev = cmnd->device;
  135. if (urb->actual_length > 16) {
  136. unsigned len = be16_to_cpup(&sense_iu->len);
  137. if (len + 16 != urb->actual_length) {
  138. int newlen = min(len + 16, urb->actual_length) - 16;
  139. if (newlen < 0)
  140. newlen = 0;
  141. sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
  142. "disagrees with IU sense data length %d, "
  143. "using %d bytes of sense data\n", __func__,
  144. urb->actual_length, len, newlen);
  145. len = newlen;
  146. }
  147. memcpy(cmnd->sense_buffer, sense_iu->sense, len);
  148. }
  149. cmnd->result = sense_iu->status;
  150. if (sdev->current_cmnd)
  151. sdev->current_cmnd = NULL;
  152. cmnd->scsi_done(cmnd);
  153. usb_free_urb(urb);
  154. }
  155. static void uas_sense_old(struct urb *urb, struct scsi_cmnd *cmnd)
  156. {
  157. struct sense_iu_old *sense_iu = urb->transfer_buffer;
  158. struct scsi_device *sdev = cmnd->device;
  159. if (urb->actual_length > 8) {
  160. unsigned len = be16_to_cpup(&sense_iu->len) - 2;
  161. if (len + 8 != urb->actual_length) {
  162. int newlen = min(len + 8, urb->actual_length) - 8;
  163. if (newlen < 0)
  164. newlen = 0;
  165. sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
  166. "disagrees with IU sense data length %d, "
  167. "using %d bytes of sense data\n", __func__,
  168. urb->actual_length, len, newlen);
  169. len = newlen;
  170. }
  171. memcpy(cmnd->sense_buffer, sense_iu->sense, len);
  172. }
  173. cmnd->result = sense_iu->status;
  174. if (sdev->current_cmnd)
  175. sdev->current_cmnd = NULL;
  176. cmnd->scsi_done(cmnd);
  177. usb_free_urb(urb);
  178. }
  179. static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
  180. unsigned direction)
  181. {
  182. struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
  183. int err;
  184. cmdinfo->state = direction | SUBMIT_STATUS_URB;
  185. err = uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_ATOMIC);
  186. if (err) {
  187. spin_lock(&uas_work_lock);
  188. list_add_tail(&cmdinfo->list, &uas_work_list);
  189. spin_unlock(&uas_work_lock);
  190. schedule_work(&uas_work);
  191. }
  192. }
  193. static void uas_stat_cmplt(struct urb *urb)
  194. {
  195. struct iu *iu = urb->transfer_buffer;
  196. struct scsi_device *sdev = urb->context;
  197. struct uas_dev_info *devinfo = sdev->hostdata;
  198. struct scsi_cmnd *cmnd;
  199. u16 tag;
  200. if (urb->status) {
  201. dev_err(&urb->dev->dev, "URB BAD STATUS %d\n", urb->status);
  202. usb_free_urb(urb);
  203. return;
  204. }
  205. tag = be16_to_cpup(&iu->tag) - 1;
  206. if (sdev->current_cmnd)
  207. cmnd = sdev->current_cmnd;
  208. else
  209. cmnd = scsi_find_tag(sdev, tag);
  210. if (!cmnd)
  211. return;
  212. switch (iu->iu_id) {
  213. case IU_ID_STATUS:
  214. if (urb->actual_length < 16)
  215. devinfo->uas_sense_old = 1;
  216. if (devinfo->uas_sense_old)
  217. uas_sense_old(urb, cmnd);
  218. else
  219. uas_sense(urb, cmnd);
  220. break;
  221. case IU_ID_READ_READY:
  222. uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
  223. break;
  224. case IU_ID_WRITE_READY:
  225. uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
  226. break;
  227. default:
  228. scmd_printk(KERN_ERR, cmnd,
  229. "Bogus IU (%d) received on status pipe\n", iu->iu_id);
  230. }
  231. }
  232. static void uas_data_cmplt(struct urb *urb)
  233. {
  234. struct scsi_data_buffer *sdb = urb->context;
  235. sdb->resid = sdb->length - urb->actual_length;
  236. usb_free_urb(urb);
  237. }
  238. static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
  239. unsigned int pipe, u16 stream_id,
  240. struct scsi_data_buffer *sdb,
  241. enum dma_data_direction dir)
  242. {
  243. struct usb_device *udev = devinfo->udev;
  244. struct urb *urb = usb_alloc_urb(0, gfp);
  245. if (!urb)
  246. goto out;
  247. usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length, uas_data_cmplt,
  248. sdb);
  249. if (devinfo->use_streams)
  250. urb->stream_id = stream_id;
  251. urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
  252. urb->sg = sdb->table.sgl;
  253. out:
  254. return urb;
  255. }
  256. static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
  257. struct scsi_cmnd *cmnd, u16 stream_id)
  258. {
  259. struct usb_device *udev = devinfo->udev;
  260. struct urb *urb = usb_alloc_urb(0, gfp);
  261. struct sense_iu *iu;
  262. if (!urb)
  263. goto out;
  264. iu = kzalloc(sizeof(*iu), gfp);
  265. if (!iu)
  266. goto free;
  267. usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
  268. uas_stat_cmplt, cmnd->device);
  269. urb->stream_id = stream_id;
  270. urb->transfer_flags |= URB_FREE_BUFFER;
  271. out:
  272. return urb;
  273. free:
  274. usb_free_urb(urb);
  275. return NULL;
  276. }
  277. static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
  278. struct scsi_cmnd *cmnd, u16 stream_id)
  279. {
  280. struct usb_device *udev = devinfo->udev;
  281. struct scsi_device *sdev = cmnd->device;
  282. struct urb *urb = usb_alloc_urb(0, gfp);
  283. struct command_iu *iu;
  284. int len;
  285. if (!urb)
  286. goto out;
  287. len = cmnd->cmd_len - 16;
  288. if (len < 0)
  289. len = 0;
  290. len = ALIGN(len, 4);
  291. iu = kzalloc(sizeof(*iu) + len, gfp);
  292. if (!iu)
  293. goto free;
  294. iu->iu_id = IU_ID_COMMAND;
  295. iu->tag = cpu_to_be16(stream_id);
  296. iu->prio_attr = UAS_SIMPLE_TAG;
  297. iu->len = len;
  298. int_to_scsilun(sdev->lun, &iu->lun);
  299. memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
  300. usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
  301. usb_free_urb, NULL);
  302. urb->transfer_flags |= URB_FREE_BUFFER;
  303. out:
  304. return urb;
  305. free:
  306. usb_free_urb(urb);
  307. return NULL;
  308. }
  309. /*
  310. * Why should I request the Status IU before sending the Command IU? Spec
  311. * says to, but also says the device may receive them in any order. Seems
  312. * daft to me.
  313. */
  314. static int uas_submit_urbs(struct scsi_cmnd *cmnd,
  315. struct uas_dev_info *devinfo, gfp_t gfp)
  316. {
  317. struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
  318. if (cmdinfo->state & ALLOC_STATUS_URB) {
  319. cmdinfo->status_urb = uas_alloc_sense_urb(devinfo, gfp, cmnd,
  320. cmdinfo->stream);
  321. if (!cmdinfo->status_urb)
  322. return SCSI_MLQUEUE_DEVICE_BUSY;
  323. cmdinfo->state &= ~ALLOC_STATUS_URB;
  324. }
  325. if (cmdinfo->state & SUBMIT_STATUS_URB) {
  326. if (usb_submit_urb(cmdinfo->status_urb, gfp)) {
  327. scmd_printk(KERN_INFO, cmnd,
  328. "sense urb submission failure\n");
  329. return SCSI_MLQUEUE_DEVICE_BUSY;
  330. }
  331. cmdinfo->state &= ~SUBMIT_STATUS_URB;
  332. }
  333. if (cmdinfo->state & ALLOC_DATA_IN_URB) {
  334. cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, gfp,
  335. devinfo->data_in_pipe, cmdinfo->stream,
  336. scsi_in(cmnd), DMA_FROM_DEVICE);
  337. if (!cmdinfo->data_in_urb)
  338. return SCSI_MLQUEUE_DEVICE_BUSY;
  339. cmdinfo->state &= ~ALLOC_DATA_IN_URB;
  340. }
  341. if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
  342. if (usb_submit_urb(cmdinfo->data_in_urb, gfp)) {
  343. scmd_printk(KERN_INFO, cmnd,
  344. "data in urb submission failure\n");
  345. return SCSI_MLQUEUE_DEVICE_BUSY;
  346. }
  347. cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
  348. }
  349. if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
  350. cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, gfp,
  351. devinfo->data_out_pipe, cmdinfo->stream,
  352. scsi_out(cmnd), DMA_TO_DEVICE);
  353. if (!cmdinfo->data_out_urb)
  354. return SCSI_MLQUEUE_DEVICE_BUSY;
  355. cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
  356. }
  357. if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
  358. if (usb_submit_urb(cmdinfo->data_out_urb, gfp)) {
  359. scmd_printk(KERN_INFO, cmnd,
  360. "data out urb submission failure\n");
  361. return SCSI_MLQUEUE_DEVICE_BUSY;
  362. }
  363. cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
  364. }
  365. if (cmdinfo->state & ALLOC_CMD_URB) {
  366. cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, gfp, cmnd,
  367. cmdinfo->stream);
  368. if (!cmdinfo->cmd_urb)
  369. return SCSI_MLQUEUE_DEVICE_BUSY;
  370. cmdinfo->state &= ~ALLOC_CMD_URB;
  371. }
  372. if (cmdinfo->state & SUBMIT_CMD_URB) {
  373. if (usb_submit_urb(cmdinfo->cmd_urb, gfp)) {
  374. scmd_printk(KERN_INFO, cmnd,
  375. "cmd urb submission failure\n");
  376. return SCSI_MLQUEUE_DEVICE_BUSY;
  377. }
  378. cmdinfo->state &= ~SUBMIT_CMD_URB;
  379. }
  380. return 0;
  381. }
  382. static int uas_queuecommand_lck(struct scsi_cmnd *cmnd,
  383. void (*done)(struct scsi_cmnd *))
  384. {
  385. struct scsi_device *sdev = cmnd->device;
  386. struct uas_dev_info *devinfo = sdev->hostdata;
  387. struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
  388. int err;
  389. BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
  390. if (!cmdinfo->status_urb && sdev->current_cmnd)
  391. return SCSI_MLQUEUE_DEVICE_BUSY;
  392. if (blk_rq_tagged(cmnd->request)) {
  393. cmdinfo->stream = cmnd->request->tag + 1;
  394. } else {
  395. sdev->current_cmnd = cmnd;
  396. cmdinfo->stream = 1;
  397. }
  398. cmnd->scsi_done = done;
  399. cmdinfo->state = ALLOC_STATUS_URB | SUBMIT_STATUS_URB |
  400. ALLOC_CMD_URB | SUBMIT_CMD_URB;
  401. switch (cmnd->sc_data_direction) {
  402. case DMA_FROM_DEVICE:
  403. cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
  404. break;
  405. case DMA_BIDIRECTIONAL:
  406. cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
  407. case DMA_TO_DEVICE:
  408. cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
  409. case DMA_NONE:
  410. break;
  411. }
  412. if (!devinfo->use_streams) {
  413. cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
  414. cmdinfo->stream = 0;
  415. }
  416. err = uas_submit_urbs(cmnd, devinfo, GFP_ATOMIC);
  417. if (err) {
  418. /* If we did nothing, give up now */
  419. if (cmdinfo->state & SUBMIT_STATUS_URB) {
  420. usb_free_urb(cmdinfo->status_urb);
  421. return SCSI_MLQUEUE_DEVICE_BUSY;
  422. }
  423. spin_lock(&uas_work_lock);
  424. list_add_tail(&cmdinfo->list, &uas_work_list);
  425. spin_unlock(&uas_work_lock);
  426. schedule_work(&uas_work);
  427. }
  428. return 0;
  429. }
  430. static DEF_SCSI_QCMD(uas_queuecommand)
  431. static int uas_eh_abort_handler(struct scsi_cmnd *cmnd)
  432. {
  433. struct scsi_device *sdev = cmnd->device;
  434. sdev_printk(KERN_INFO, sdev, "%s tag %d\n", __func__,
  435. cmnd->request->tag);
  436. /* XXX: Send ABORT TASK Task Management command */
  437. return FAILED;
  438. }
  439. static int uas_eh_device_reset_handler(struct scsi_cmnd *cmnd)
  440. {
  441. struct scsi_device *sdev = cmnd->device;
  442. sdev_printk(KERN_INFO, sdev, "%s tag %d\n", __func__,
  443. cmnd->request->tag);
  444. /* XXX: Send LOGICAL UNIT RESET Task Management command */
  445. return FAILED;
  446. }
  447. static int uas_eh_target_reset_handler(struct scsi_cmnd *cmnd)
  448. {
  449. struct scsi_device *sdev = cmnd->device;
  450. sdev_printk(KERN_INFO, sdev, "%s tag %d\n", __func__,
  451. cmnd->request->tag);
  452. /* XXX: Can we reset just the one USB interface?
  453. * Would calling usb_set_interface() have the right effect?
  454. */
  455. return FAILED;
  456. }
  457. static int uas_eh_bus_reset_handler(struct scsi_cmnd *cmnd)
  458. {
  459. struct scsi_device *sdev = cmnd->device;
  460. struct uas_dev_info *devinfo = sdev->hostdata;
  461. struct usb_device *udev = devinfo->udev;
  462. sdev_printk(KERN_INFO, sdev, "%s tag %d\n", __func__,
  463. cmnd->request->tag);
  464. if (usb_reset_device(udev))
  465. return SUCCESS;
  466. return FAILED;
  467. }
  468. static int uas_slave_alloc(struct scsi_device *sdev)
  469. {
  470. sdev->hostdata = (void *)sdev->host->hostdata[0];
  471. return 0;
  472. }
  473. static int uas_slave_configure(struct scsi_device *sdev)
  474. {
  475. struct uas_dev_info *devinfo = sdev->hostdata;
  476. scsi_set_tag_type(sdev, MSG_ORDERED_TAG);
  477. scsi_activate_tcq(sdev, devinfo->qdepth - 1);
  478. return 0;
  479. }
  480. static struct scsi_host_template uas_host_template = {
  481. .module = THIS_MODULE,
  482. .name = "uas",
  483. .queuecommand = uas_queuecommand,
  484. .slave_alloc = uas_slave_alloc,
  485. .slave_configure = uas_slave_configure,
  486. .eh_abort_handler = uas_eh_abort_handler,
  487. .eh_device_reset_handler = uas_eh_device_reset_handler,
  488. .eh_target_reset_handler = uas_eh_target_reset_handler,
  489. .eh_bus_reset_handler = uas_eh_bus_reset_handler,
  490. .can_queue = 65536, /* Is there a limit on the _host_ ? */
  491. .this_id = -1,
  492. .sg_tablesize = SG_NONE,
  493. .cmd_per_lun = 1, /* until we override it */
  494. .skip_settle_delay = 1,
  495. .ordered_tag = 1,
  496. };
  497. static struct usb_device_id uas_usb_ids[] = {
  498. { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
  499. { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
  500. /* 0xaa is a prototype device I happen to have access to */
  501. { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, 0xaa) },
  502. { }
  503. };
  504. MODULE_DEVICE_TABLE(usb, uas_usb_ids);
  505. static int uas_is_interface(struct usb_host_interface *intf)
  506. {
  507. return (intf->desc.bInterfaceClass == USB_CLASS_MASS_STORAGE &&
  508. intf->desc.bInterfaceSubClass == USB_SC_SCSI &&
  509. intf->desc.bInterfaceProtocol == USB_PR_UAS);
  510. }
  511. static int uas_switch_interface(struct usb_device *udev,
  512. struct usb_interface *intf)
  513. {
  514. int i;
  515. if (uas_is_interface(intf->cur_altsetting))
  516. return 0;
  517. for (i = 0; i < intf->num_altsetting; i++) {
  518. struct usb_host_interface *alt = &intf->altsetting[i];
  519. if (alt == intf->cur_altsetting)
  520. continue;
  521. if (uas_is_interface(alt))
  522. return usb_set_interface(udev,
  523. alt->desc.bInterfaceNumber,
  524. alt->desc.bAlternateSetting);
  525. }
  526. return -ENODEV;
  527. }
  528. static void uas_configure_endpoints(struct uas_dev_info *devinfo)
  529. {
  530. struct usb_host_endpoint *eps[4] = { };
  531. struct usb_interface *intf = devinfo->intf;
  532. struct usb_device *udev = devinfo->udev;
  533. struct usb_host_endpoint *endpoint = intf->cur_altsetting->endpoint;
  534. unsigned i, n_endpoints = intf->cur_altsetting->desc.bNumEndpoints;
  535. devinfo->uas_sense_old = 0;
  536. for (i = 0; i < n_endpoints; i++) {
  537. unsigned char *extra = endpoint[i].extra;
  538. int len = endpoint[i].extralen;
  539. while (len > 1) {
  540. if (extra[1] == USB_DT_PIPE_USAGE) {
  541. unsigned pipe_id = extra[2];
  542. if (pipe_id > 0 && pipe_id < 5)
  543. eps[pipe_id - 1] = &endpoint[i];
  544. break;
  545. }
  546. len -= extra[0];
  547. extra += extra[0];
  548. }
  549. }
  550. /*
  551. * Assume that if we didn't find a control pipe descriptor, we're
  552. * using a device with old firmware that happens to be set up like
  553. * this.
  554. */
  555. if (!eps[0]) {
  556. devinfo->cmd_pipe = usb_sndbulkpipe(udev, 1);
  557. devinfo->status_pipe = usb_rcvbulkpipe(udev, 1);
  558. devinfo->data_in_pipe = usb_rcvbulkpipe(udev, 2);
  559. devinfo->data_out_pipe = usb_sndbulkpipe(udev, 2);
  560. eps[1] = usb_pipe_endpoint(udev, devinfo->status_pipe);
  561. eps[2] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
  562. eps[3] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
  563. } else {
  564. devinfo->cmd_pipe = usb_sndbulkpipe(udev,
  565. eps[0]->desc.bEndpointAddress);
  566. devinfo->status_pipe = usb_rcvbulkpipe(udev,
  567. eps[1]->desc.bEndpointAddress);
  568. devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
  569. eps[2]->desc.bEndpointAddress);
  570. devinfo->data_out_pipe = usb_sndbulkpipe(udev,
  571. eps[3]->desc.bEndpointAddress);
  572. }
  573. devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1, 3, 256,
  574. GFP_KERNEL);
  575. if (devinfo->qdepth < 0) {
  576. devinfo->qdepth = 256;
  577. devinfo->use_streams = 0;
  578. } else {
  579. devinfo->use_streams = 1;
  580. }
  581. }
  582. /*
  583. * XXX: What I'd like to do here is register a SCSI host for each USB host in
  584. * the system. Follow usb-storage's design of registering a SCSI host for
  585. * each USB device for the moment. Can implement this by walking up the
  586. * USB hierarchy until we find a USB host.
  587. */
  588. static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
  589. {
  590. int result;
  591. struct Scsi_Host *shost;
  592. struct uas_dev_info *devinfo;
  593. struct usb_device *udev = interface_to_usbdev(intf);
  594. if (uas_switch_interface(udev, intf))
  595. return -ENODEV;
  596. devinfo = kmalloc(sizeof(struct uas_dev_info), GFP_KERNEL);
  597. if (!devinfo)
  598. return -ENOMEM;
  599. result = -ENOMEM;
  600. shost = scsi_host_alloc(&uas_host_template, sizeof(void *));
  601. if (!shost)
  602. goto free;
  603. shost->max_cmd_len = 16 + 252;
  604. shost->max_id = 1;
  605. shost->sg_tablesize = udev->bus->sg_tablesize;
  606. result = scsi_add_host(shost, &intf->dev);
  607. if (result)
  608. goto free;
  609. shost->hostdata[0] = (unsigned long)devinfo;
  610. devinfo->intf = intf;
  611. devinfo->udev = udev;
  612. uas_configure_endpoints(devinfo);
  613. scsi_scan_host(shost);
  614. usb_set_intfdata(intf, shost);
  615. return result;
  616. free:
  617. kfree(devinfo);
  618. if (shost)
  619. scsi_host_put(shost);
  620. return result;
  621. }
  622. static int uas_pre_reset(struct usb_interface *intf)
  623. {
  624. /* XXX: Need to return 1 if it's not our device in error handling */
  625. return 0;
  626. }
  627. static int uas_post_reset(struct usb_interface *intf)
  628. {
  629. /* XXX: Need to return 1 if it's not our device in error handling */
  630. return 0;
  631. }
  632. static void uas_disconnect(struct usb_interface *intf)
  633. {
  634. struct usb_device *udev = interface_to_usbdev(intf);
  635. struct usb_host_endpoint *eps[3];
  636. struct Scsi_Host *shost = usb_get_intfdata(intf);
  637. struct uas_dev_info *devinfo = (void *)shost->hostdata[0];
  638. scsi_remove_host(shost);
  639. eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
  640. eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
  641. eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
  642. usb_free_streams(intf, eps, 3, GFP_KERNEL);
  643. kfree(devinfo);
  644. }
  645. /*
  646. * XXX: Should this plug into libusual so we can auto-upgrade devices from
  647. * Bulk-Only to UAS?
  648. */
  649. static struct usb_driver uas_driver = {
  650. .name = "uas",
  651. .probe = uas_probe,
  652. .disconnect = uas_disconnect,
  653. .pre_reset = uas_pre_reset,
  654. .post_reset = uas_post_reset,
  655. .id_table = uas_usb_ids,
  656. };
  657. static int uas_init(void)
  658. {
  659. return usb_register(&uas_driver);
  660. }
  661. static void uas_exit(void)
  662. {
  663. usb_deregister(&uas_driver);
  664. }
  665. module_init(uas_init);
  666. module_exit(uas_exit);
  667. MODULE_LICENSE("GPL");
  668. MODULE_AUTHOR("Matthew Wilcox and Sarah Sharp");