Change over unix line-endings to dos line endings.

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

diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt
index cf81901..11dd346 100644 (file)
--- a/LUFA/ManPages/MigrationInformation.txt
+++ b/LUFA/ManPages/MigrationInformation.txt
@@ -10,13 +10,44 @@
  *  to the next version released. It does not indicate all new additions to the library in each version change, only\r
  *  areas relevant to making older projects compatible with the API changes of each new release.\r
  *\r
  *  to the next version released. It does not indicate all new additions to the library in each version change, only\r
  *  areas relevant to making older projects compatible with the API changes of each new release.\r
  *\r

- * \section Sec_MigrationXXXXXX Migrating from 091223 to XXXXXX\r
+ * \section Sec_MigrationXXXXXX Migrating from 100219 to XXXXXX\r
+ *\r
+ *  <b>Non-USB Library Components</b>\r
+ *    - The \ref TWI_StartTransmission() function now takes in a timeout period, expressed in milliseconds, within which the addressed\r
+ *      device must respond or the function will abort.\r
+ *\r
+ *  <b>Device Mode</b>\r
+ *    - The \ref USB_Init() function no longer calls sei() to enable global interrupts, as the user application may need\r
+ *      to perform other initialization before it is ready to handle global interrupts. The user application is now responsible\r
+ *      for enabling global interrupts before or shortly after calling \ref USB_Init() to ensure that the enumeration process\r
+ *      functions correctly.\r
+ *    - The USBInterrupt.c USB driver source file has been relocated from LUFA/Drivers/USB/HighLevel/ to LUFA/Drivers/USB/LowLevel.\r
+ *      Projects must update their makefile SRC values accordingly.\r
+ *\r
+ *  <b>Host Mode</b>\r
+ *    - The \ref USB_Init() function no longer calls sei() to enable global interrupts, as the user application may need\r
+ *      to perform other initialization before it is ready to handle global interrupts. The user application is now responsible\r
+ *      for enabling global interrupts before or shortly after calling \ref USB_Init() to ensure that the enumeration process\r
+ *      functions correctly.\r
+ *    - The USBInterrupt.c USB driver source file has been relocated from LUFA/Drivers/USB/HighLevel/ to LUFA/Drivers/USB/LowLevel.\r
+ *      Projects must update their makefile SRC values accordingly.\r
+ *\r
+ * \section Sec_Migration100219 Migrating from 091223 to 100219\r
+ *\r
+ *  <b>Non-USB Library Components</b>\r
+ *    - Due to some ADC channels not being identical to their ADC MUX selection masks for single-ended conversions on some AVR models,\r
+ *      the ADC driver now has explicit masks for each of the standard ADC channels (see \ref Group_ADC). These masks should be used \r
+ *      when calling the ADC functions to ensure proper operation across all AVR models. Note that the \ref ADC_SetupChannel() function \r
+ *      is an exception, and should always be called with a channel number rather than a channel mask.\r

  *\r
  *  <b>Host Mode</b>\r
  *    - The MIDI Host Class driver send and receive routines now operate on packed events, where multiple MIDI events may be\r
  *      packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send\r
  *      pipe bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually\r
  *      flush the queued event(s) to the device by calling \ref MIDI_Host_Flush().\r
  *\r
  *  <b>Host Mode</b>\r
  *    - The MIDI Host Class driver send and receive routines now operate on packed events, where multiple MIDI events may be\r
  *      packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send\r
  *      pipe bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually\r
  *      flush the queued event(s) to the device by calling \ref MIDI_Host_Flush().\r

+ *    - The Pipe_IsEndpointBound() function now takes the endpoint's direction into account, by checking if the MSB of the endpoint's address\r
+ *      is set to denote IN endpoints. If the previous functionality where the direction is to be discounted is required, mask the endpoint\r
+ *      address against the \ref PIPE_EPNUM_MASK token before calling Pipe_IsEndpointBound().\r

  *\r
  *  <b>Device Mode</b>\r
  *    - The MIDI Device Class driver send and receive routines now operate on packed events, where multiple MIDI events may be\r
  *\r
  *  <b>Device Mode</b>\r
  *    - The MIDI Device Class driver send and receive routines now operate on packed events, where multiple MIDI events may be\r