uas.c 20 KB

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