Add Atmel Studio integration known issues.

[pub/USBasp.git] / Bootloaders / MassStorage / BootloaderMassStorage.txt

diff --git a/Bootloaders/MassStorage/BootloaderMassStorage.txt b/Bootloaders/MassStorage/BootloaderMassStorage.txt
index 19751d3..0b30cbf 100644 (file)
--- a/Bootloaders/MassStorage/BootloaderMassStorage.txt
+++ b/Bootloaders/MassStorage/BootloaderMassStorage.txt
@@ -13,7 +13,7 @@
  *  \li Series 7 USB AVRs (AT90USBxxx7)
  *  \li Series 6 USB AVRs (AT90USBxxx6)
  *  \li Series 4 USB AVRs (ATMEGAxxU4) - <i>See \ref SSec_Aux_Space</i>
  *  \li Series 7 USB AVRs (AT90USBxxx7)
  *  \li Series 6 USB AVRs (AT90USBxxx6)
  *  \li Series 4 USB AVRs (ATMEGAxxU4) - <i>See \ref SSec_Aux_Space</i>

- *  \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) - <i>See \ref SSec_Aux_Space</i>
+ *  \li ATMEGA32U2 - <i>See \ref SSec_Aux_Space</i>

  *
  *  \section Sec_Info USB Information:
  *
  *
  *  \section Sec_Info USB Information:
  *


@@ -71,6 +71,11 @@
  *
  *  The current device firmware can be read from the device by reading a file from the virtual FAT filesystem.
  *
  *
  *  The current device firmware can be read from the device by reading a file from the virtual FAT filesystem.
  *

+ *  \warning This bootloader is currently <b>incompatible with the Apple MacOS X OS Finder GUI</b>, due to the
+ *           large amount of meta files this OS attempts to write to the disk along with the new binaries. On
+ *           this platform, firmwares must be copied to the disk via the Terminal application only to prevent
+ *           firmware corruption.
+ *

  *  \section Sec_API User Application API
  *
  *  Several user application functions for FLASH and other special memory area manipulations are exposed by the bootloader,
  *  \section Sec_API User Application API
  *
  *  Several user application functions for FLASH and other special memory area manipulations are exposed by the bootloader,


@@ -166,15 +171,35 @@
  *  +----------------------------+ FLASHEND
  *  \endverbatim
  *
  *  +----------------------------+ FLASHEND
  *  \endverbatim
  *

+ *  \section Sec_KnownIssues Known Issues:
+ *
+ *  \par In some cases, the application is not fully loaded into the device.
+ *  Write-caching on some operating systems may interfere with the normal
+ *  operation of the bootloader. Write caching should be disabled when using the
+ *  Mass Storage bootloader, or the file system synced via an appropriate command
+ *  (such as the OS's normal disk ejection command) before disconnecting the device.
+ *
+ *  \par After loading an application, it is not run automatically on startup.
+ *  Some USB AVR boards ship with the BOOTRST fuse set, causing the bootloader
+ *  to run automatically when the device is reset. In most cases, the BOOTRST
+ *  fuse should be disabled and the HWBE fuse used instead to run the bootloader
+ *  when needed.
+ *

  *  \section Sec_Options Project Options
  *
  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  *
  *  <table>
  *   <tr>
  *  \section Sec_Options Project Options
  *
  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  *
  *  <table>
  *   <tr>

- *    <td>
- *     None
- *    </td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
+ *   </tr>
+ *   <tr>
+ *    <td>NO_APP_START_ON_EJECT</td>
+ *    <td>AppConfig.h</td>
+ *    <td>Define to disable automatic start of the loaded application when the virtual
+ *        Mass Storage disk is ejected on the host.</td>

  *   </tr>
  *  </table>
  */
  *   </tr>
  *  </table>
  */