Merge pull request #147 from adafruit/msc-writable-callback

Msc writable callback

Author: hathach

examples/MassStorage/msc_external_flash/msc_external_flash.ino

@@ -17,6 +17,9 @@
  * Note: Adafruit fork of SdFat enabled ENABLE_EXTENDED_TRANSFER_CLASS and FAT12_SUPPORT
  * in SdFatConfig.h, which is needed to run SdFat on external flash. You can use original
  * SdFat library and manually change those macros
+ *
+ * Note2: If your flash is not formatted as FAT12 previously, you could format it using
+ * follow sketch https://github.com/adafruit/Adafruit_SPIFlash/tree/master/examples/SdFat_format
  */
 
 #include "SPI.h"
@@ -143,7 +146,7 @@ void loop()
 // return number of copied bytes (must be multiple of block size) 
 int32_t msc_read_cb (uint32_t lba, void* buffer, uint32_t bufsize)
 {
-  // Note: SPIFLash Bock API: readBlocks/writeBlocks/syncBlocks
+  // Note: SPIFLash Block API: readBlocks/writeBlocks/syncBlocks
   // already include 4K sector caching internally. We don't need to cache it, yahhhh!!
   return flash.readBlocks(lba, (uint8_t*) buffer, bufsize/512) ? bufsize : -1;
 }
@@ -155,7 +158,7 @@ int32_t msc_write_cb (uint32_t lba, uint8_t* buffer, uint32_t bufsize)
 {
   digitalWrite(LED_BUILTIN, HIGH);
 
-  // Note: SPIFLash Bock API: readBlocks/writeBlocks/syncBlocks
+  // Note: SPIFLash Block API: readBlocks/writeBlocks/syncBlocks
   // already include 4K sector caching internally. We don't need to cache it, yahhhh!!
   return flash.writeBlocks(lba, buffer, bufsize/512) ? bufsize : -1;
 }

examples/MassStorage/msc_sdfat/.funhouse.test.skip

@@ -112,6 +112,11 @@ void Adafruit_USBD_MSC::setReadyCallback(uint8_t lun, ready_callback_t cb) {
   _lun_info[lun].ready_cb = cb;
 }
 
+void Adafruit_USBD_MSC::setWritableCallback(uint8_t lun,
+                                            writable_callback_t cb) {
+  _lun_info[lun].writable_cb = cb;
+}
+
 bool Adafruit_USBD_MSC::begin(void) {
   if (!TinyUSBDevice.addInterface(*this)) {
     return false;
@@ -256,6 +261,16 @@ void tud_msc_write10_complete_cb(uint8_t lun) {
   return _msc_dev->_lun_info[lun].fl_cb();
 }
 
+// Invoked to check if device is writable as part of SCSI WRITE10
+// Default mode is writable
+bool tud_msc_is_writable_cb(uint8_t lun) {
+  if (!(_msc_dev && _msc_dev->_lun_info[lun].writable_cb)) {
+    return true;
+  }
+
+  return _msc_dev->_lun_info[lun].writable_cb();
+}
+
 } // extern "C"
 
 #endif // TUSB_OPT_DEVICE_ENABLED

examples/MassStorage/msc_sdfat/.magtag.test.skip

@@ -35,6 +35,7 @@ class Adafruit_USBD_MSC : public Adafruit_USBD_Interface {
                                       uint32_t bufsize);
   typedef void (*flush_callback_t)(void);
   typedef bool (*ready_callback_t)(void);
+  typedef bool (*writable_callback_t)(void);
 
   Adafruit_USBD_MSC(void);
 
@@ -51,6 +52,7 @@ class Adafruit_USBD_MSC : public Adafruit_USBD_Interface {
   void setReadWriteCallback(uint8_t lun, read_callback_t rd_cb,
                             write_callback_t wr_cb, flush_callback_t fl_cb);
   void setReadyCallback(uint8_t lun, ready_callback_t cb);
+  void setWritableCallback(uint8_t lun, writable_callback_t cb);
 
   //------------- Single LUN API -------------//
   void setID(const char *vendor_id, const char *product_id,
@@ -70,18 +72,22 @@ class Adafruit_USBD_MSC : public Adafruit_USBD_Interface {
   }
 
   void setReadyCallback(ready_callback_t cb) { setReadyCallback(0, cb); }
+  void setWritableCallback(writable_callback_t cb) {
+    setWritableCallback(0, cb);
+  }
 
   // from Adafruit_USBD_Interface
   virtual uint16_t getInterfaceDescriptor(uint8_t itfnum, uint8_t *buf,
                                           uint16_t bufsize);
 
 private:
-  enum { MAX_LUN = 2 };
+  enum { MAX_LUN = 2 }; // TODO make it configurable
   struct {
     read_callback_t rd_cb;
     write_callback_t wr_cb;
     flush_callback_t fl_cb;
     ready_callback_t ready_cb;
+    writable_callback_t writable_cb;
 
     const char *_inquiry_vid;
     const char *_inquiry_pid;
@@ -107,6 +113,7 @@ class Adafruit_USBD_MSC : public Adafruit_USBD_Interface {
   friend int32_t tud_msc_write10_cb(uint8_t lun, uint32_t lba, uint32_t offset,
                                     uint8_t *buffer, uint32_t bufsize);
   friend void tud_msc_write10_complete_cb(uint8_t lun);
+  friend bool tud_msc_is_writable_cb(uint8_t lun);
 };
 
 #endif /* ADAFRUIT_USBD_MSC_H_ */