usbd_msc.c 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963
  1. /*
  2. * Copyright (c) 2022, sakumisu
  3. * Copyright (c) 2024, zhihong chen
  4. *
  5. * SPDX-License-Identifier: Apache-2.0
  6. */
  7. #include "usbd_core.h"
  8. #include "usbd_msc.h"
  9. #include "usb_scsi.h"
  10. #undef USB_DBG_TAG
  11. #define USB_DBG_TAG "usbd_msc"
  12. #include "usb_log.h"
  13. #define MSD_OUT_EP_IDX 0
  14. #define MSD_IN_EP_IDX 1
  15. /* Describe EndPoints configuration */
  16. static struct usbd_endpoint mass_ep_data[CONFIG_USBDEV_MAX_BUS][2];
  17. /* MSC Bulk-only Stage */
  18. enum Stage {
  19. MSC_READ_CBW = 0, /* Command Block Wrapper */
  20. MSC_DATA_OUT = 1, /* Data Out Phase */
  21. MSC_DATA_IN = 2, /* Data In Phase */
  22. MSC_SEND_CSW = 3, /* Command Status Wrapper */
  23. MSC_WAIT_CSW = 4, /* Command Status Wrapper */
  24. };
  25. /* Device data structure */
  26. USB_NOCACHE_RAM_SECTION struct usbd_msc_priv {
  27. /* state of the bulk-only state machine */
  28. enum Stage stage;
  29. USB_MEM_ALIGNX struct CBW cbw;
  30. USB_MEM_ALIGNX struct CSW csw;
  31. USB_MEM_ALIGNX bool readonly;
  32. bool popup;
  33. uint8_t sKey; /* Sense key */
  34. uint8_t ASC; /* Additional Sense Code */
  35. uint8_t ASQ; /* Additional Sense Qualifier */
  36. uint8_t max_lun;
  37. uint32_t start_sector;
  38. uint32_t nsectors;
  39. uint32_t scsi_blk_size[CONFIG_USBDEV_MSC_MAX_LUN];
  40. uint32_t scsi_blk_nbr[CONFIG_USBDEV_MSC_MAX_LUN];
  41. USB_MEM_ALIGNX uint8_t block_buffer[CONFIG_USBDEV_MSC_MAX_BUFSIZE];
  42. #if defined(CONFIG_USBDEV_MSC_THREAD)
  43. usb_osal_mq_t usbd_msc_mq;
  44. usb_osal_thread_t usbd_msc_thread;
  45. uint32_t nbytes;
  46. #elif defined(CONFIG_USBDEV_MSC_POLLING)
  47. uint32_t event;
  48. uint32_t nbytes;
  49. #endif
  50. } g_usbd_msc[CONFIG_USBDEV_MAX_BUS];
  51. #ifdef CONFIG_USBDEV_MSC_THREAD
  52. static void usbdev_msc_thread(CONFIG_USB_OSAL_THREAD_SET_ARGV);
  53. #endif
  54. static void usdb_msc_set_max_lun(uint8_t busid)
  55. {
  56. g_usbd_msc[busid].max_lun = CONFIG_USBDEV_MSC_MAX_LUN - 1u;
  57. }
  58. static void usbd_msc_reset(uint8_t busid)
  59. {
  60. g_usbd_msc[busid].stage = MSC_READ_CBW;
  61. }
  62. static int msc_storage_class_interface_request_handler(uint8_t busid, struct usb_setup_packet *setup, uint8_t **data, uint32_t *len)
  63. {
  64. USB_LOG_DBG("MSC Class request: "
  65. "bRequest 0x%02x\r\n",
  66. setup->bRequest);
  67. switch (setup->bRequest) {
  68. case MSC_REQUEST_RESET:
  69. usbd_msc_reset(busid);
  70. break;
  71. case MSC_REQUEST_GET_MAX_LUN:
  72. (*data)[0] = g_usbd_msc[busid].max_lun;
  73. *len = 1;
  74. break;
  75. default:
  76. return -1;
  77. }
  78. return 0;
  79. }
  80. void msc_storage_notify_handler(uint8_t busid, uint8_t event, void *arg)
  81. {
  82. (void)arg;
  83. switch (event) {
  84. case USBD_EVENT_INIT:
  85. #if defined(CONFIG_USBDEV_MSC_THREAD)
  86. g_usbd_msc[busid].usbd_msc_mq = usb_osal_mq_create(1);
  87. if (g_usbd_msc[busid].usbd_msc_mq == NULL) {
  88. USB_LOG_ERR("No memory to alloc for g_usbd_msc[busid].usbd_msc_mq\r\n");
  89. }
  90. g_usbd_msc[busid].usbd_msc_thread = usb_osal_thread_create("usbd_msc", CONFIG_USBDEV_MSC_STACKSIZE, CONFIG_USBDEV_MSC_PRIO, usbdev_msc_thread, (void *)(uint32_t)busid);
  91. if (g_usbd_msc[busid].usbd_msc_thread == NULL) {
  92. USB_LOG_ERR("No memory to alloc for g_usbd_msc[busid].usbd_msc_thread\r\n");
  93. }
  94. #elif defined(CONFIG_USBDEV_MSC_POLLING)
  95. g_usbd_msc[busid].event = 0;
  96. #endif
  97. break;
  98. case USBD_EVENT_DEINIT:
  99. #if defined(CONFIG_USBDEV_MSC_THREAD)
  100. if (g_usbd_msc[busid].usbd_msc_mq) {
  101. usb_osal_mq_delete(g_usbd_msc[busid].usbd_msc_mq);
  102. }
  103. if (g_usbd_msc[busid].usbd_msc_thread) {
  104. usb_osal_thread_delete(g_usbd_msc[busid].usbd_msc_thread);
  105. }
  106. #endif
  107. break;
  108. case USBD_EVENT_RESET:
  109. usbd_msc_reset(busid);
  110. break;
  111. case USBD_EVENT_CONFIGURED:
  112. USB_LOG_DBG("Start reading cbw\r\n");
  113. usbd_ep_start_read(busid, mass_ep_data[busid][MSD_OUT_EP_IDX].ep_addr, (uint8_t *)&g_usbd_msc[busid].cbw, USB_SIZEOF_MSC_CBW);
  114. break;
  115. default:
  116. break;
  117. }
  118. }
  119. static void usbd_msc_bot_abort(uint8_t busid)
  120. {
  121. if ((g_usbd_msc[busid].cbw.bmFlags == 0) && (g_usbd_msc[busid].cbw.dDataLength != 0)) {
  122. usbd_ep_set_stall(busid, mass_ep_data[busid][MSD_OUT_EP_IDX].ep_addr);
  123. }
  124. usbd_ep_set_stall(busid, mass_ep_data[busid][MSD_IN_EP_IDX].ep_addr);
  125. usbd_ep_start_read(busid, mass_ep_data[busid][0].ep_addr, (uint8_t *)&g_usbd_msc[busid].cbw, USB_SIZEOF_MSC_CBW);
  126. }
  127. static void usbd_msc_send_csw(uint8_t busid, uint8_t CSW_Status)
  128. {
  129. g_usbd_msc[busid].csw.dSignature = MSC_CSW_Signature;
  130. g_usbd_msc[busid].csw.bStatus = CSW_Status;
  131. /* updating the State Machine , so that we wait CSW when this
  132. * transfer is complete, ie when we get a bulk in callback
  133. */
  134. g_usbd_msc[busid].stage = MSC_WAIT_CSW;
  135. USB_LOG_DBG("Send csw\r\n");
  136. usbd_ep_start_write(busid, mass_ep_data[busid][MSD_IN_EP_IDX].ep_addr, (uint8_t *)&g_usbd_msc[busid].csw, sizeof(struct CSW));
  137. }
  138. static void usbd_msc_send_info(uint8_t busid, uint8_t *buffer, uint8_t size)
  139. {
  140. size = MIN(size, g_usbd_msc[busid].cbw.dDataLength);
  141. /* updating the State Machine , so that we send CSW when this
  142. * transfer is complete, ie when we get a bulk in callback
  143. */
  144. g_usbd_msc[busid].stage = MSC_SEND_CSW;
  145. usbd_ep_start_write(busid, mass_ep_data[busid][MSD_IN_EP_IDX].ep_addr, buffer, size);
  146. g_usbd_msc[busid].csw.dDataResidue -= size;
  147. g_usbd_msc[busid].csw.bStatus = CSW_STATUS_CMD_PASSED;
  148. }
  149. static bool SCSI_processWrite(uint8_t busid, uint32_t nbytes);
  150. static bool SCSI_processRead(uint8_t busid);
  151. /**
  152. * @brief SCSI_SetSenseData
  153. * Load the last error code in the error list
  154. * @param sKey: Sense Key
  155. * @param ASC: Additional Sense Code
  156. * @retval none
  157. */
  158. static void SCSI_SetSenseData(uint8_t busid, uint32_t KCQ)
  159. {
  160. g_usbd_msc[busid].sKey = (uint8_t)(KCQ >> 16);
  161. g_usbd_msc[busid].ASC = (uint8_t)(KCQ >> 8);
  162. g_usbd_msc[busid].ASQ = (uint8_t)(KCQ);
  163. }
  164. /**
  165. * @brief SCSI Command list
  166. *
  167. */
  168. static bool SCSI_testUnitReady(uint8_t busid, uint8_t **data, uint32_t *len)
  169. {
  170. if (g_usbd_msc[busid].cbw.dDataLength != 0U) {
  171. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  172. return false;
  173. }
  174. *data = NULL;
  175. *len = 0;
  176. return true;
  177. }
  178. static bool SCSI_requestSense(uint8_t busid, uint8_t **data, uint32_t *len)
  179. {
  180. uint8_t data_len = SCSIRESP_FIXEDSENSEDATA_SIZEOF;
  181. if (g_usbd_msc[busid].cbw.dDataLength == 0U) {
  182. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  183. return false;
  184. }
  185. if (g_usbd_msc[busid].cbw.CB[4] < SCSIRESP_FIXEDSENSEDATA_SIZEOF) {
  186. data_len = g_usbd_msc[busid].cbw.CB[4];
  187. }
  188. uint8_t request_sense[SCSIRESP_FIXEDSENSEDATA_SIZEOF] = {
  189. 0x70,
  190. 0x00,
  191. 0x00, /* Sense Key */
  192. 0x00,
  193. 0x00,
  194. 0x00,
  195. 0x00,
  196. SCSIRESP_FIXEDSENSEDATA_SIZEOF - 8,
  197. 0x00,
  198. 0x00,
  199. 0x00,
  200. 0x00,
  201. 0x00, /* Additional Sense Code */
  202. 0x00, /* Additional Sense Request */
  203. 0x00,
  204. 0x00,
  205. 0x00,
  206. 0x00,
  207. };
  208. request_sense[2] = g_usbd_msc[busid].sKey;
  209. request_sense[12] = g_usbd_msc[busid].ASC;
  210. request_sense[13] = g_usbd_msc[busid].ASQ;
  211. #if 0
  212. request_sense[ 2] = 0x06; /* UNIT ATTENTION */
  213. request_sense[12] = 0x28; /* Additional Sense Code: Not ready to ready transition */
  214. request_sense[13] = 0x00; /* Additional Sense Code Qualifier */
  215. #endif
  216. #if 0
  217. request_sense[ 2] = 0x02; /* NOT READY */
  218. request_sense[12] = 0x3A; /* Additional Sense Code: Medium not present */
  219. request_sense[13] = 0x00; /* Additional Sense Code Qualifier */
  220. #endif
  221. #if 0
  222. request_sense[ 2] = 0x05; /* ILLEGAL REQUEST */
  223. request_sense[12] = 0x20; /* Additional Sense Code: Invalid command */
  224. request_sense[13] = 0x00; /* Additional Sense Code Qualifier */
  225. #endif
  226. #if 0
  227. request_sense[ 2] = 0x00; /* NO SENSE */
  228. request_sense[12] = 0x00; /* Additional Sense Code: No additional code */
  229. request_sense[13] = 0x00; /* Additional Sense Code Qualifier */
  230. #endif
  231. memcpy(*data, (uint8_t *)request_sense, data_len);
  232. *len = data_len;
  233. return true;
  234. }
  235. static bool SCSI_inquiry(uint8_t busid, uint8_t **data, uint32_t *len)
  236. {
  237. uint8_t data_len = SCSIRESP_INQUIRY_SIZEOF;
  238. uint8_t inquiry00[6] = {
  239. 0x00,
  240. 0x00,
  241. 0x00,
  242. (0x06 - 4U),
  243. 0x00,
  244. 0x80
  245. };
  246. /* USB Mass storage VPD Page 0x80 Inquiry Data for Unit Serial Number */
  247. uint8_t inquiry80[8] = {
  248. 0x00,
  249. 0x80,
  250. 0x00,
  251. (0x08 - 4U),
  252. 0x20, /* Put Product Serial number */
  253. 0x20,
  254. 0x20,
  255. 0x20
  256. };
  257. uint8_t inquiry[SCSIRESP_INQUIRY_SIZEOF] = {
  258. /* 36 */
  259. /* LUN 0 */
  260. 0x00,
  261. 0x80,
  262. 0x02,
  263. 0x02,
  264. (SCSIRESP_INQUIRY_SIZEOF - 5),
  265. 0x00,
  266. 0x00,
  267. 0x00,
  268. ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', /* Manufacturer : 8 bytes */
  269. ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', /* Product : 16 Bytes */
  270. ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ',
  271. ' ', ' ', ' ', ' ' /* Version : 4 Bytes */
  272. };
  273. memcpy(&inquiry[8], CONFIG_USBDEV_MSC_MANUFACTURER_STRING, strlen(CONFIG_USBDEV_MSC_MANUFACTURER_STRING));
  274. memcpy(&inquiry[16], CONFIG_USBDEV_MSC_PRODUCT_STRING, strlen(CONFIG_USBDEV_MSC_PRODUCT_STRING));
  275. memcpy(&inquiry[32], CONFIG_USBDEV_MSC_VERSION_STRING, strlen(CONFIG_USBDEV_MSC_VERSION_STRING));
  276. if (g_usbd_msc[busid].cbw.dDataLength == 0U) {
  277. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  278. return false;
  279. }
  280. if ((g_usbd_msc[busid].cbw.CB[1] & 0x01U) != 0U) { /* Evpd is set */
  281. if (g_usbd_msc[busid].cbw.CB[2] == 0U) { /* Request for Supported Vital Product Data Pages*/
  282. data_len = 0x06;
  283. memcpy(*data, (uint8_t *)inquiry00, data_len);
  284. } else if (g_usbd_msc[busid].cbw.CB[2] == 0x80U) { /* Request for VPD page 0x80 Unit Serial Number */
  285. data_len = 0x08;
  286. memcpy(*data, (uint8_t *)inquiry80, data_len);
  287. } else { /* Request Not supported */
  288. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDFIELDINCBA);
  289. return false;
  290. }
  291. } else {
  292. if (g_usbd_msc[busid].cbw.CB[4] < SCSIRESP_INQUIRY_SIZEOF) {
  293. data_len = g_usbd_msc[busid].cbw.CB[4];
  294. }
  295. memcpy(*data, (uint8_t *)inquiry, data_len);
  296. }
  297. *len = data_len;
  298. return true;
  299. }
  300. static bool SCSI_startStopUnit(uint8_t busid, uint8_t **data, uint32_t *len)
  301. {
  302. if (g_usbd_msc[busid].cbw.dDataLength != 0U) {
  303. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  304. return false;
  305. }
  306. if ((g_usbd_msc[busid].cbw.CB[4] & 0x3U) == 0x1U) /* START=1 */
  307. {
  308. //SCSI_MEDIUM_UNLOCKED;
  309. } else if ((g_usbd_msc[busid].cbw.CB[4] & 0x3U) == 0x2U) /* START=0 and LOEJ Load Eject=1 */
  310. {
  311. //SCSI_MEDIUM_EJECTED;
  312. g_usbd_msc[busid].popup = true;
  313. } else if ((g_usbd_msc[busid].cbw.CB[4] & 0x3U) == 0x3U) /* START=1 and LOEJ Load Eject=1 */
  314. {
  315. //SCSI_MEDIUM_UNLOCKED;
  316. } else {
  317. }
  318. *data = NULL;
  319. *len = 0;
  320. return true;
  321. }
  322. static bool SCSI_preventAllowMediaRemoval(uint8_t busid, uint8_t **data, uint32_t *len)
  323. {
  324. if (g_usbd_msc[busid].cbw.dDataLength != 0U) {
  325. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  326. return false;
  327. }
  328. if (g_usbd_msc[busid].cbw.CB[4] == 0U) {
  329. //SCSI_MEDIUM_UNLOCKED;
  330. } else {
  331. //SCSI_MEDIUM_LOCKED;
  332. }
  333. *data = NULL;
  334. *len = 0;
  335. return true;
  336. }
  337. static bool SCSI_modeSense6(uint8_t busid, uint8_t **data, uint32_t *len)
  338. {
  339. uint8_t data_len = 4;
  340. if (g_usbd_msc[busid].cbw.dDataLength == 0U) {
  341. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  342. return false;
  343. }
  344. if (g_usbd_msc[busid].cbw.CB[4] < SCSIRESP_MODEPARAMETERHDR6_SIZEOF) {
  345. data_len = g_usbd_msc[busid].cbw.CB[4];
  346. }
  347. uint8_t sense6[SCSIRESP_MODEPARAMETERHDR6_SIZEOF] = { 0x03, 0x00, 0x00, 0x00 };
  348. if (g_usbd_msc[busid].readonly) {
  349. sense6[2] = 0x80;
  350. }
  351. memcpy(*data, (uint8_t *)sense6, data_len);
  352. *len = data_len;
  353. return true;
  354. }
  355. static bool SCSI_modeSense10(uint8_t busid, uint8_t **data, uint32_t *len)
  356. {
  357. uint8_t data_len = 27;
  358. if (g_usbd_msc[busid].cbw.dDataLength == 0U) {
  359. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  360. return false;
  361. }
  362. if (g_usbd_msc[busid].cbw.CB[8] < 27) {
  363. data_len = g_usbd_msc[busid].cbw.CB[8];
  364. }
  365. uint8_t sense10[27] = {
  366. 0x00,
  367. 0x26,
  368. 0x00,
  369. 0x00,
  370. 0x00,
  371. 0x00,
  372. 0x00,
  373. 0x00,
  374. 0x08,
  375. 0x12,
  376. 0x00,
  377. 0x00,
  378. 0x00,
  379. 0x00,
  380. 0x00,
  381. 0x00,
  382. 0x00,
  383. 0x00,
  384. 0x00,
  385. 0x00,
  386. 0x00,
  387. 0x00,
  388. 0x00,
  389. 0x00,
  390. 0x00,
  391. 0x00,
  392. 0x00
  393. };
  394. memcpy(*data, (uint8_t *)sense10, data_len);
  395. *len = data_len;
  396. return true;
  397. }
  398. static bool SCSI_readFormatCapacity(uint8_t busid, uint8_t **data, uint32_t *len)
  399. {
  400. if (g_usbd_msc[busid].cbw.dDataLength == 0U) {
  401. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  402. return false;
  403. }
  404. uint8_t format_capacity[SCSIRESP_READFORMATCAPACITIES_SIZEOF] = {
  405. 0x00,
  406. 0x00,
  407. 0x00,
  408. 0x08, /* Capacity List Length */
  409. (uint8_t)((g_usbd_msc[busid].scsi_blk_nbr[g_usbd_msc[busid].cbw.bLUN] >> 24) & 0xff),
  410. (uint8_t)((g_usbd_msc[busid].scsi_blk_nbr[g_usbd_msc[busid].cbw.bLUN] >> 16) & 0xff),
  411. (uint8_t)((g_usbd_msc[busid].scsi_blk_nbr[g_usbd_msc[busid].cbw.bLUN] >> 8) & 0xff),
  412. (uint8_t)((g_usbd_msc[busid].scsi_blk_nbr[g_usbd_msc[busid].cbw.bLUN] >> 0) & 0xff),
  413. 0x02, /* Descriptor Code: Formatted Media */
  414. 0x00,
  415. (uint8_t)((g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN] >> 8) & 0xff),
  416. (uint8_t)((g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN] >> 0) & 0xff),
  417. };
  418. memcpy(*data, (uint8_t *)format_capacity, SCSIRESP_READFORMATCAPACITIES_SIZEOF);
  419. *len = SCSIRESP_READFORMATCAPACITIES_SIZEOF;
  420. return true;
  421. }
  422. static bool SCSI_readCapacity10(uint8_t busid, uint8_t **data, uint32_t *len)
  423. {
  424. if (g_usbd_msc[busid].cbw.dDataLength == 0U) {
  425. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  426. return false;
  427. }
  428. uint8_t capacity10[SCSIRESP_READCAPACITY10_SIZEOF] = {
  429. (uint8_t)(((g_usbd_msc[busid].scsi_blk_nbr[g_usbd_msc[busid].cbw.bLUN] - 1) >> 24) & 0xff),
  430. (uint8_t)(((g_usbd_msc[busid].scsi_blk_nbr[g_usbd_msc[busid].cbw.bLUN] - 1) >> 16) & 0xff),
  431. (uint8_t)(((g_usbd_msc[busid].scsi_blk_nbr[g_usbd_msc[busid].cbw.bLUN] - 1) >> 8) & 0xff),
  432. (uint8_t)(((g_usbd_msc[busid].scsi_blk_nbr[g_usbd_msc[busid].cbw.bLUN] - 1) >> 0) & 0xff),
  433. (uint8_t)((g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN] >> 24) & 0xff),
  434. (uint8_t)((g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN] >> 16) & 0xff),
  435. (uint8_t)((g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN] >> 8) & 0xff),
  436. (uint8_t)((g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN] >> 0) & 0xff),
  437. };
  438. memcpy(*data, (uint8_t *)capacity10, SCSIRESP_READCAPACITY10_SIZEOF);
  439. *len = SCSIRESP_READCAPACITY10_SIZEOF;
  440. return true;
  441. }
  442. static bool SCSI_read10(uint8_t busid, uint8_t **data, uint32_t *len)
  443. {
  444. (void)data;
  445. (void)len;
  446. if (((g_usbd_msc[busid].cbw.bmFlags & 0x80U) != 0x80U) || (g_usbd_msc[busid].cbw.dDataLength == 0U)) {
  447. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  448. return false;
  449. }
  450. g_usbd_msc[busid].start_sector = GET_BE32(&g_usbd_msc[busid].cbw.CB[2]); /* Logical Block Address of First Block */
  451. g_usbd_msc[busid].nsectors = GET_BE16(&g_usbd_msc[busid].cbw.CB[7]); /* Number of Blocks to transfer */
  452. if ((g_usbd_msc[busid].start_sector + g_usbd_msc[busid].nsectors) > g_usbd_msc[busid].scsi_blk_nbr[g_usbd_msc[busid].cbw.bLUN]) {
  453. SCSI_SetSenseData(busid, SCSI_KCQIR_LBAOUTOFRANGE);
  454. return false;
  455. }
  456. if (g_usbd_msc[busid].cbw.dDataLength != (g_usbd_msc[busid].nsectors * g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN])) {
  457. return false;
  458. }
  459. g_usbd_msc[busid].stage = MSC_DATA_IN;
  460. #if defined(CONFIG_USBDEV_MSC_THREAD)
  461. usb_osal_mq_send(g_usbd_msc[busid].usbd_msc_mq, MSC_DATA_IN);
  462. return true;
  463. #elif defined(CONFIG_USBDEV_MSC_POLLING)
  464. g_usbd_msc[busid].event = MSC_DATA_IN;
  465. return true;
  466. #else
  467. return SCSI_processRead(busid);
  468. #endif
  469. }
  470. static bool SCSI_read12(uint8_t busid, uint8_t **data, uint32_t *len)
  471. {
  472. (void)data;
  473. (void)len;
  474. if (((g_usbd_msc[busid].cbw.bmFlags & 0x80U) != 0x80U) || (g_usbd_msc[busid].cbw.dDataLength == 0U)) {
  475. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  476. return false;
  477. }
  478. g_usbd_msc[busid].start_sector = GET_BE32(&g_usbd_msc[busid].cbw.CB[2]); /* Logical Block Address of First Block */
  479. g_usbd_msc[busid].nsectors = GET_BE32(&g_usbd_msc[busid].cbw.CB[6]); /* Number of Blocks to transfer */
  480. if ((g_usbd_msc[busid].start_sector + g_usbd_msc[busid].nsectors) > g_usbd_msc[busid].scsi_blk_nbr[g_usbd_msc[busid].cbw.bLUN]) {
  481. SCSI_SetSenseData(busid, SCSI_KCQIR_LBAOUTOFRANGE);
  482. return false;
  483. }
  484. if (g_usbd_msc[busid].cbw.dDataLength != (g_usbd_msc[busid].nsectors * g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN])) {
  485. return false;
  486. }
  487. g_usbd_msc[busid].stage = MSC_DATA_IN;
  488. #if defined(CONFIG_USBDEV_MSC_THREAD)
  489. usb_osal_mq_send(g_usbd_msc[busid].usbd_msc_mq, MSC_DATA_IN);
  490. return true;
  491. #elif defined(CONFIG_USBDEV_MSC_POLLING)
  492. g_usbd_msc[busid].event = MSC_DATA_IN;
  493. return true;
  494. #else
  495. return SCSI_processRead(busid);
  496. #endif
  497. }
  498. static bool SCSI_write10(uint8_t busid, uint8_t **data, uint32_t *len)
  499. {
  500. uint32_t data_len = 0;
  501. (void)data;
  502. (void)len;
  503. if (((g_usbd_msc[busid].cbw.bmFlags & 0x80U) != 0x00U) || (g_usbd_msc[busid].cbw.dDataLength == 0U)) {
  504. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  505. return false;
  506. }
  507. g_usbd_msc[busid].start_sector = GET_BE32(&g_usbd_msc[busid].cbw.CB[2]); /* Logical Block Address of First Block */
  508. g_usbd_msc[busid].nsectors = GET_BE16(&g_usbd_msc[busid].cbw.CB[7]); /* Number of Blocks to transfer */
  509. data_len = g_usbd_msc[busid].nsectors * g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN];
  510. if ((g_usbd_msc[busid].start_sector + g_usbd_msc[busid].nsectors) > g_usbd_msc[busid].scsi_blk_nbr[g_usbd_msc[busid].cbw.bLUN]) {
  511. return false;
  512. }
  513. if (g_usbd_msc[busid].cbw.dDataLength != data_len) {
  514. return false;
  515. }
  516. g_usbd_msc[busid].stage = MSC_DATA_OUT;
  517. data_len = MIN(data_len, CONFIG_USBDEV_MSC_MAX_BUFSIZE);
  518. usbd_ep_start_read(busid, mass_ep_data[busid][MSD_OUT_EP_IDX].ep_addr, g_usbd_msc[busid].block_buffer, data_len);
  519. return true;
  520. }
  521. static bool SCSI_write12(uint8_t busid, uint8_t **data, uint32_t *len)
  522. {
  523. uint32_t data_len = 0;
  524. (void)data;
  525. (void)len;
  526. if (((g_usbd_msc[busid].cbw.bmFlags & 0x80U) != 0x00U) || (g_usbd_msc[busid].cbw.dDataLength == 0U)) {
  527. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  528. return false;
  529. }
  530. g_usbd_msc[busid].start_sector = GET_BE32(&g_usbd_msc[busid].cbw.CB[2]); /* Logical Block Address of First Block */
  531. g_usbd_msc[busid].nsectors = GET_BE32(&g_usbd_msc[busid].cbw.CB[6]); /* Number of Blocks to transfer */
  532. data_len = g_usbd_msc[busid].nsectors * g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN];
  533. if ((g_usbd_msc[busid].start_sector + g_usbd_msc[busid].nsectors) > g_usbd_msc[busid].scsi_blk_nbr[g_usbd_msc[busid].cbw.bLUN]) {
  534. return false;
  535. }
  536. if (g_usbd_msc[busid].cbw.dDataLength != data_len) {
  537. return false;
  538. }
  539. g_usbd_msc[busid].stage = MSC_DATA_OUT;
  540. data_len = MIN(data_len, CONFIG_USBDEV_MSC_MAX_BUFSIZE);
  541. usbd_ep_start_read(busid, mass_ep_data[busid][MSD_OUT_EP_IDX].ep_addr, g_usbd_msc[busid].block_buffer, data_len);
  542. return true;
  543. }
  544. static bool SCSI_processRead(uint8_t busid)
  545. {
  546. uint32_t transfer_len;
  547. USB_LOG_DBG("read lba:%d\r\n", g_usbd_msc[busid].start_sector);
  548. transfer_len = MIN(g_usbd_msc[busid].nsectors * g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN], CONFIG_USBDEV_MSC_MAX_BUFSIZE);
  549. if (usbd_msc_sector_read(busid, g_usbd_msc[busid].cbw.bLUN, g_usbd_msc[busid].start_sector, g_usbd_msc[busid].block_buffer, transfer_len) != 0) {
  550. SCSI_SetSenseData(busid, SCSI_KCQHE_UREINRESERVEDAREA);
  551. return false;
  552. }
  553. g_usbd_msc[busid].start_sector += (transfer_len / g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN]);
  554. g_usbd_msc[busid].nsectors -= (transfer_len / g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN]);
  555. g_usbd_msc[busid].csw.dDataResidue -= transfer_len;
  556. if (g_usbd_msc[busid].nsectors == 0) {
  557. g_usbd_msc[busid].stage = MSC_SEND_CSW;
  558. }
  559. usbd_ep_start_write(busid, mass_ep_data[busid][MSD_IN_EP_IDX].ep_addr, g_usbd_msc[busid].block_buffer, transfer_len);
  560. return true;
  561. }
  562. static bool SCSI_processWrite(uint8_t busid, uint32_t nbytes)
  563. {
  564. uint32_t data_len = 0;
  565. USB_LOG_DBG("write lba:%d\r\n", g_usbd_msc[busid].start_sector);
  566. if (usbd_msc_sector_write(busid, g_usbd_msc[busid].cbw.bLUN, g_usbd_msc[busid].start_sector, g_usbd_msc[busid].block_buffer, nbytes) != 0) {
  567. SCSI_SetSenseData(busid, SCSI_KCQHE_WRITEFAULT);
  568. return false;
  569. }
  570. g_usbd_msc[busid].start_sector += (nbytes / g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN]);
  571. g_usbd_msc[busid].nsectors -= (nbytes / g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN]);
  572. g_usbd_msc[busid].csw.dDataResidue -= nbytes;
  573. if (g_usbd_msc[busid].nsectors == 0) {
  574. usbd_msc_send_csw(busid, CSW_STATUS_CMD_PASSED);
  575. } else {
  576. data_len = MIN(g_usbd_msc[busid].nsectors * g_usbd_msc[busid].scsi_blk_size[g_usbd_msc[busid].cbw.bLUN], CONFIG_USBDEV_MSC_MAX_BUFSIZE);
  577. usbd_ep_start_read(busid, mass_ep_data[busid][MSD_OUT_EP_IDX].ep_addr, g_usbd_msc[busid].block_buffer, data_len);
  578. }
  579. return true;
  580. }
  581. static bool SCSI_CBWDecode(uint8_t busid, uint32_t nbytes)
  582. {
  583. uint8_t *buf2send = g_usbd_msc[busid].block_buffer;
  584. uint32_t len2send = 0;
  585. bool ret = false;
  586. if (nbytes != sizeof(struct CBW)) {
  587. USB_LOG_ERR("size != sizeof(cbw)\r\n");
  588. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  589. return false;
  590. }
  591. g_usbd_msc[busid].csw.dTag = g_usbd_msc[busid].cbw.dTag;
  592. g_usbd_msc[busid].csw.dDataResidue = g_usbd_msc[busid].cbw.dDataLength;
  593. if ((g_usbd_msc[busid].cbw.dSignature != MSC_CBW_Signature) || (g_usbd_msc[busid].cbw.bCBLength < 1) || (g_usbd_msc[busid].cbw.bCBLength > 16)) {
  594. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  595. return false;
  596. } else {
  597. USB_LOG_DBG("Decode CB:0x%02x\r\n", g_usbd_msc[busid].cbw.CB[0]);
  598. switch (g_usbd_msc[busid].cbw.CB[0]) {
  599. case SCSI_CMD_TESTUNITREADY:
  600. ret = SCSI_testUnitReady(busid, &buf2send, &len2send);
  601. break;
  602. case SCSI_CMD_REQUESTSENSE:
  603. ret = SCSI_requestSense(busid, &buf2send, &len2send);
  604. break;
  605. case SCSI_CMD_INQUIRY:
  606. ret = SCSI_inquiry(busid, &buf2send, &len2send);
  607. break;
  608. case SCSI_CMD_STARTSTOPUNIT:
  609. ret = SCSI_startStopUnit(busid, &buf2send, &len2send);
  610. break;
  611. case SCSI_CMD_PREVENTMEDIAREMOVAL:
  612. ret = SCSI_preventAllowMediaRemoval(busid, &buf2send, &len2send);
  613. break;
  614. case SCSI_CMD_MODESENSE6:
  615. ret = SCSI_modeSense6(busid, &buf2send, &len2send);
  616. break;
  617. case SCSI_CMD_MODESENSE10:
  618. ret = SCSI_modeSense10(busid, &buf2send, &len2send);
  619. break;
  620. case SCSI_CMD_READFORMATCAPACITIES:
  621. ret = SCSI_readFormatCapacity(busid, &buf2send, &len2send);
  622. break;
  623. case SCSI_CMD_READCAPACITY10:
  624. ret = SCSI_readCapacity10(busid, &buf2send, &len2send);
  625. break;
  626. case SCSI_CMD_READ10:
  627. ret = SCSI_read10(busid, NULL, 0);
  628. break;
  629. case SCSI_CMD_READ12:
  630. ret = SCSI_read12(busid, NULL, 0);
  631. break;
  632. case SCSI_CMD_WRITE10:
  633. ret = SCSI_write10(busid, NULL, 0);
  634. break;
  635. case SCSI_CMD_WRITE12:
  636. ret = SCSI_write12(busid, NULL, 0);
  637. break;
  638. case SCSI_CMD_VERIFY10:
  639. ret = false;
  640. break;
  641. case SCSI_CMD_SYNCHCACHE10:
  642. ret = true;
  643. break;
  644. default:
  645. SCSI_SetSenseData(busid, SCSI_KCQIR_INVALIDCOMMAND);
  646. ret = false;
  647. break;
  648. }
  649. }
  650. if (ret) {
  651. if (g_usbd_msc[busid].stage == MSC_READ_CBW) {
  652. if (len2send) {
  653. USB_LOG_DBG("Send info len: %d\r\n", len2send);
  654. usbd_msc_send_info(busid, buf2send, len2send);
  655. } else {
  656. usbd_msc_send_csw(busid, CSW_STATUS_CMD_PASSED);
  657. }
  658. }
  659. }
  660. return ret;
  661. }
  662. void mass_storage_bulk_out(uint8_t busid, uint8_t ep, uint32_t nbytes)
  663. {
  664. (void)ep;
  665. switch (g_usbd_msc[busid].stage) {
  666. case MSC_READ_CBW:
  667. if (SCSI_CBWDecode(busid, nbytes) == false) {
  668. USB_LOG_ERR("Command: 0x%02x decode err\r\n", g_usbd_msc[busid].cbw.CB[0]);
  669. usbd_msc_bot_abort(busid);
  670. return;
  671. }
  672. break;
  673. case MSC_DATA_OUT:
  674. switch (g_usbd_msc[busid].cbw.CB[0]) {
  675. case SCSI_CMD_WRITE10:
  676. case SCSI_CMD_WRITE12:
  677. #if defined(CONFIG_USBDEV_MSC_THREAD)
  678. g_usbd_msc[busid].nbytes = nbytes;
  679. usb_osal_mq_send(g_usbd_msc[busid].usbd_msc_mq, MSC_DATA_OUT);
  680. #elif defined(CONFIG_USBDEV_MSC_POLLING)
  681. g_usbd_msc[busid].nbytes = nbytes;
  682. g_usbd_msc[busid].event = MSC_DATA_OUT;
  683. #else
  684. if (SCSI_processWrite(busid, nbytes) == false) {
  685. usbd_msc_send_csw(busid, CSW_STATUS_CMD_FAILED); /* send fail status to host,and the host will retry*/
  686. }
  687. #endif
  688. break;
  689. default:
  690. break;
  691. }
  692. break;
  693. default:
  694. break;
  695. }
  696. }
  697. void mass_storage_bulk_in(uint8_t busid, uint8_t ep, uint32_t nbytes)
  698. {
  699. (void)ep;
  700. (void)nbytes;
  701. switch (g_usbd_msc[busid].stage) {
  702. case MSC_DATA_IN:
  703. switch (g_usbd_msc[busid].cbw.CB[0]) {
  704. case SCSI_CMD_READ10:
  705. case SCSI_CMD_READ12:
  706. #if defined(CONFIG_USBDEV_MSC_THREAD)
  707. usb_osal_mq_send(g_usbd_msc[busid].usbd_msc_mq, MSC_DATA_IN);
  708. #elif defined(CONFIG_USBDEV_MSC_POLLING)
  709. g_usbd_msc[busid].event = MSC_DATA_IN;
  710. #else
  711. if (SCSI_processRead(busid) == false) {
  712. usbd_msc_send_csw(busid, CSW_STATUS_CMD_FAILED); /* send fail status to host,and the host will retry*/
  713. return;
  714. }
  715. #endif
  716. break;
  717. default:
  718. break;
  719. }
  720. break;
  721. /*the device has to send a CSW*/
  722. case MSC_SEND_CSW:
  723. usbd_msc_send_csw(busid, CSW_STATUS_CMD_PASSED);
  724. break;
  725. /*the host has received the CSW*/
  726. case MSC_WAIT_CSW:
  727. g_usbd_msc[busid].stage = MSC_READ_CBW;
  728. USB_LOG_DBG("Start reading cbw\r\n");
  729. usbd_ep_start_read(busid, mass_ep_data[busid][MSD_OUT_EP_IDX].ep_addr, (uint8_t *)&g_usbd_msc[busid].cbw, USB_SIZEOF_MSC_CBW);
  730. break;
  731. default:
  732. break;
  733. }
  734. }
  735. #if defined(CONFIG_USBDEV_MSC_THREAD)
  736. static void usbdev_msc_thread(CONFIG_USB_OSAL_THREAD_SET_ARGV)
  737. {
  738. uintptr_t event;
  739. int ret;
  740. uint8_t busid = (uint8_t)CONFIG_USB_OSAL_THREAD_GET_ARGV;
  741. while (1) {
  742. ret = usb_osal_mq_recv(g_usbd_msc[busid].usbd_msc_mq, (uintptr_t *)&event, USB_OSAL_WAITING_FOREVER);
  743. if (ret < 0) {
  744. continue;
  745. }
  746. if (event == MSC_DATA_OUT) {
  747. if (SCSI_processWrite(busid, g_usbd_msc[busid].nbytes) == false) {
  748. usbd_msc_send_csw(busid, CSW_STATUS_CMD_FAILED); /* send fail status to host,and the host will retry*/
  749. }
  750. } else if (event == MSC_DATA_IN) {
  751. if (SCSI_processRead(busid) == false) {
  752. usbd_msc_send_csw(busid, CSW_STATUS_CMD_FAILED); /* send fail status to host,and the host will retry*/
  753. }
  754. } else {
  755. }
  756. }
  757. }
  758. #elif defined(CONFIG_USBDEV_MSC_POLLING)
  759. void usbd_msc_polling(uint8_t busid)
  760. {
  761. uint8_t event;
  762. event = g_usbd_msc[busid].event;
  763. if (event != 0) {
  764. g_usbd_msc[busid].event = 0;
  765. if (event == MSC_DATA_OUT) {
  766. if (SCSI_processWrite(busid, g_usbd_msc[busid].nbytes) == false) {
  767. usbd_msc_send_csw(busid, CSW_STATUS_CMD_FAILED); /* send fail status to host,and the host will retry*/
  768. }
  769. } else if (event == MSC_DATA_IN) {
  770. if (SCSI_processRead(busid) == false) {
  771. usbd_msc_send_csw(busid, CSW_STATUS_CMD_FAILED); /* send fail status to host,and the host will retry*/
  772. }
  773. } else {
  774. }
  775. }
  776. }
  777. #endif
  778. struct usbd_interface *usbd_msc_init_intf(uint8_t busid, struct usbd_interface *intf, const uint8_t out_ep, const uint8_t in_ep)
  779. {
  780. intf->class_interface_handler = msc_storage_class_interface_request_handler;
  781. intf->class_endpoint_handler = NULL;
  782. intf->vendor_handler = NULL;
  783. intf->notify_handler = msc_storage_notify_handler;
  784. mass_ep_data[busid][MSD_OUT_EP_IDX].ep_addr = out_ep;
  785. mass_ep_data[busid][MSD_OUT_EP_IDX].ep_cb = mass_storage_bulk_out;
  786. mass_ep_data[busid][MSD_IN_EP_IDX].ep_addr = in_ep;
  787. mass_ep_data[busid][MSD_IN_EP_IDX].ep_cb = mass_storage_bulk_in;
  788. usbd_add_endpoint(busid, &mass_ep_data[busid][MSD_OUT_EP_IDX]);
  789. usbd_add_endpoint(busid, &mass_ep_data[busid][MSD_IN_EP_IDX]);
  790. memset((uint8_t *)&g_usbd_msc[busid], 0, sizeof(struct usbd_msc_priv));
  791. usdb_msc_set_max_lun(busid);
  792. for (uint8_t i = 0u; i <= g_usbd_msc[busid].max_lun; i++) {
  793. usbd_msc_get_cap(busid, i, &g_usbd_msc[busid].scsi_blk_nbr[i], &g_usbd_msc[busid].scsi_blk_size[i]);
  794. if (CONFIG_USBDEV_MSC_MAX_BUFSIZE % g_usbd_msc[busid].scsi_blk_size[i]) {
  795. USB_LOG_ERR("CONFIG_USBDEV_MSC_MAX_BUFSIZE must be a multiple of block size\r\n");
  796. while (1) {
  797. }
  798. }
  799. }
  800. return intf;
  801. }
  802. void usbd_msc_set_readonly(uint8_t busid, bool readonly)
  803. {
  804. g_usbd_msc[busid].readonly = readonly;
  805. }
  806. bool usbd_msc_get_popup(uint8_t busid)
  807. {
  808. return g_usbd_msc[busid].popup;
  809. }
  810. __WEAK void usbd_msc_get_cap(uint8_t busid, uint8_t lun, uint32_t *block_num, uint32_t *block_size)
  811. {
  812. (void)busid;
  813. (void)lun;
  814. *block_num = 0;
  815. *block_size = 0;
  816. }
  817. __WEAK int usbd_msc_sector_read(uint8_t busid, uint8_t lun, uint32_t sector, uint8_t *buffer, uint32_t length)
  818. {
  819. (void)busid;
  820. (void)lun;
  821. (void)sector;
  822. (void)buffer;
  823. (void)length;
  824. return 0;
  825. }
  826. __WEAK int usbd_msc_sector_write(uint8_t busid, uint8_t lun, uint32_t sector, uint8_t *buffer, uint32_t length)
  827. {
  828. (void)busid;
  829. (void)lun;
  830. (void)sector;
  831. (void)buffer;
  832. (void)length;
  833. return 0;
  834. }