Update bootloader documentation to include execution instructions.

[pub/lufa.git] / LUFA / DoxygenPages / MigrationInformation.txt

diff --git a/LUFA/DoxygenPages/MigrationInformation.txt b/LUFA/DoxygenPages/MigrationInformation.txt
index f97e768..e87fa16 100644 (file)
--- a/LUFA/DoxygenPages/MigrationInformation.txt
+++ b/LUFA/DoxygenPages/MigrationInformation.txt
@@ -10,7 +10,39 @@
  *  to the next version released. It does not indicate all new additions to the library in each version change, only
  *  areas relevant to making older projects compatible with the API changes of each new release.
  *
  *  to the next version released. It does not indicate all new additions to the library in each version change, only
  *  areas relevant to making older projects compatible with the API changes of each new release.
  *

- *  \section Sec_Migration120730 Migrating from 120219 to 120730 (BETA)
+ *  \section Sec_MigrationXXXXXX Migrating from 140302 to XXXXXX
+ *  None
+ *
+ *  \section Sec_Migration140302 Migrating from 130901 to 140302
+ *  <b>USB Core</b>
+ *    - The \c VERSION_BCD() macro has changed from accepting one floating point parameter to taking three distinct major/minor/revision integer parameters, as
+ *      some edge cases caused incorrect parsing of the input float into the final integer BCD encoded value.
+ *
+ *  <b>Non-USB Library Components</b>
+ *    - The \c ATTR_NEVER_INLINE macro, erroneously introduced in a previous release has been removed, as it duplicates the existing \c ATTR_NO_INLINE macro.
+ *
+ *  <b>Build System</b>
+ *    - The default configuration file for Doxygen is now "doxyfile" rather than "Doxygen.conf", to conform to the Doxygen project's own default file name.
+ *      Set \c DOXYGEN_CONF to override the new default file name.
+ *
+ *  \section Sec_Migration130901 Migrating from 130303 to 130901
+ *  <b>Non-USB Library Components</b>
+ *    - The Board Dataflash \c Dataflash_Init() function now automatically configures the appropriate communication interface.
+ *
+ *  \section Sec_Migration130303 Migrating from 120730 to 130303
+ *  <b>Device Mode</b>
+ *    - The \ref HID_KEYBOARD_LED_KANA macro was previously misspelled as \c HID_KEYBOARD_LED_KATANA, and had an incorrect value. User applications requiring this
+ *      constant should use the new name, and remove any workarounds for the previously incorrect macro definition.
+ *    - The \c HID_KEYBOARD_SC_EQUAL_SIGN macro has been renamed to \ref HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN, and the previous definition of
+ *      \c HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN has been renamed \ref HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN_AS400 to conform to the definitions in the HID specification.
+ *
+ *  <b>Host Mode</b>
+ *    - The \ref HID_KEYBOARD_LED_KANA macro was previously misspelled as \c HID_KEYBOARD_LED_KATANA, and had an incorrect value. User applications requiring this
+ *      constant should use the new name, and remove any workarounds for the previously incorrect macro definition.
+ *    - The \c HID_KEYBOARD_SC_EQUAL_SIGN macro has been renamed to \ref HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN, and the previous definition of
+ *      \c HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN has been renamed \ref HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN_AS400 to conform to the definitions in the HID specification.
+ *
+ *  \section Sec_Migration120730 Migrating from 120219 to 120730

  *  <b>Device Mode</b>
  *    - The device mode Audio Class driver now requires an additional configuration parameter, the Audio Control interface index. Existing applications should
  *      be adjusted to specify the additional configuration parameter.
  *  <b>Device Mode</b>
  *    - The device mode Audio Class driver now requires an additional configuration parameter, the Audio Control interface index. Existing applications should
  *      be adjusted to specify the additional configuration parameter.


@@ -27,8 +59,8 @@
  *      to update their class driver struct instantiation to match the new scheme (see \ref USB_Endpoint_Table_t).
  *    - The \c ENDPOINT_BANKS_SUPPORTED() and \c ENDPOINT_MAX_ENDPOINT_SIZE() macros have been removed, as these do not function correctly with the new addressing
  *      scheme for the endpoint APIs. Please refer to the target device's datasheet for the maximum bank size of each endpoint.
  *      to update their class driver struct instantiation to match the new scheme (see \ref USB_Endpoint_Table_t).
  *    - The \c ENDPOINT_BANKS_SUPPORTED() and \c ENDPOINT_MAX_ENDPOINT_SIZE() macros have been removed, as these do not function correctly with the new addressing
  *      scheme for the endpoint APIs. Please refer to the target device's datasheet for the maximum bank size of each endpoint.

- *    - The MIDI class driver \ref MIDI_EventPacket_t event packet no longer contains seperate \c CableIndex and \c Command entries; these have been combined
- *      into a single \c Event element which can be contructed using the new macro \ref MIDI_EVENT(). Existing applications should use the new macro and structure
+ *    - The MIDI class driver \ref MIDI_EventPacket_t event packet no longer contains separate \c CableIndex and \c Command entries; these have been combined
+ *      into a single \c Event element which can be constructed using the new macro \ref MIDI_EVENT(). Existing applications should use the new macro and structure

  *      element name.
  *
  *  <b>Host Mode</b>
  *      element name.
  *
  *  <b>Host Mode</b>


@@ -42,7 +74,7 @@
  *    - All host mode class drivers have been updated to use a new unified pipe description structure for all pipes; existing applications will need to update
  *      their class driver struct instantiation to match the new scheme (see \ref USB_Pipe_Table_t).
  *    - The MIDI class driver \ref MIDI_EventPacket_t event packet no longer contains seperate \c CableIndex and \c Command entries; these have been combined
  *    - All host mode class drivers have been updated to use a new unified pipe description structure for all pipes; existing applications will need to update
  *      their class driver struct instantiation to match the new scheme (see \ref USB_Pipe_Table_t).
  *    - The MIDI class driver \ref MIDI_EventPacket_t event packet no longer contains seperate \c CableIndex and \c Command entries; these have been combined

- *      into a single \c Event element which can be contructed using the new macro \ref MIDI_EVENT(). Existing applications should use the new macro and structure
+ *      into a single \c Event element which can be constructed using the new macro \ref MIDI_EVENT(). Existing applications should use the new macro and structure

  *      element name.
  *    - The library "LUFA/Drivers/USB/Core/ConfigDescriptor.c" source file has been renamed "LUFA/Drivers/USB/Core/ConfigDescriptors.c" as this was clashing with
  *      files in some low level host mode demo applications, preventing parallel project builds. If you are referencing the project source files directly instead
  *      element name.
  *    - The library "LUFA/Drivers/USB/Core/ConfigDescriptor.c" source file has been renamed "LUFA/Drivers/USB/Core/ConfigDescriptors.c" as this was clashing with
  *      files in some low level host mode demo applications, preventing parallel project builds. If you are referencing the project source files directly instead


@@ -128,7 +160,7 @@
  *      these functions should replace the previous function names with the new function names.
  *    - The \c Pipe_*_DWord() functions have been renamed Pipe_*_32() to ensure they are correct across all architectures. Existing code using
  *      these functions should replace the previous function names with the new function names.
  *      these functions should replace the previous function names with the new function names.
  *    - The \c Pipe_*_DWord() functions have been renamed Pipe_*_32() to ensure they are correct across all architectures. Existing code using
  *      these functions should replace the previous function names with the new function names.

- *    - The \c USB_Host_ClearPipeStall() function has been renamed to USB_Host_ClearEndpointStall(), as it operates on a full endpoing address
+ *    - The \c USB_Host_ClearPipeStall() function has been renamed to USB_Host_ClearEndpointStall(), as it operates on a full endpoint address

  *      within the attached device and not a pipe within the host. Existing code using the old function name should update the function calls and
  *      check for correct usage.
  *
  *      within the attached device and not a pipe within the host. Existing code using the old function name should update the function calls and
  *      check for correct usage.
  *