Minor documentation fix for the RelayBoard project.

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

diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt
index a85d63f..390dd88 100644 (file)
--- a/LUFA/ManPages/MigrationInformation.txt
+++ b/LUFA/ManPages/MigrationInformation.txt
@@ -10,7 +10,18 @@
  *  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_MigrationXXXXXX Migrating from 101122 to XXXXXX
+ *  \section Sec_MigrationXXXXXX Migrating from 110528 to XXXXXX
+ *  <b>Device Mode</b>
+ *    - The definition of the Audio class \ref USB_Audio_Descriptor_Format_t has been altered, to remove the fixed singular
+ *      audio sample rate in the descriptor definition, and to rename the \c SampleFrequencyType to the more appropriate
+ *      \c TotalDiscreteSampleRates. Existing applications will need to add an array of \ref USB_Audio_SampleFreq_t elements
+ *      immediately following any \ref USB_Audio_Descriptor_Format_t descriptors, and insert the appropriate sampling rates
+ *      supported by the device, as well as rename the descriptor elements to match the updated element names.
+ *    - The device mode Audio class driver now requires a new user application callback, \ref CALLBACK_Audio_Device_GetSetEndpointProperty().
+ *      Existing applications must implement this new callback, however if multiple sample rates or pitch control is not used,
+ *      this function may be hard-coded to always return false for previous behaviour to be retained.
+ *
+ *  \section Sec_Migration110528 Migrating from 101122 to 110528

  *  <b>Non-USB Library Components</b>
  *    - The TWI driver \ref TWI_StartTransmission() function return type has now changed, so that the function returns an
  *      error code from the \ref TWI_ErrorCodes_t enum instead of a boolean success flag. Existing code must now check
  *  <b>Non-USB Library Components</b>
  *    - The TWI driver \ref TWI_StartTransmission() function return type has now changed, so that the function returns an
  *      error code from the \ref TWI_ErrorCodes_t enum instead of a boolean success flag. Existing code must now check


@@ -22,12 +33,18 @@
  *      with a \c NULL parameter.
  *    - The \ref Serial_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was
  *      received.
  *      with a \c NULL parameter.
  *    - The \ref Serial_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was
  *      received.

+ *    - The TWI driver \ref TWI_Init() function now expects additional prescaler and bitlength parameters. See the function
+ *      documentation for more details.
+ *    - The name postfix on all driver modules to turn off and disable that module has been changed from *_ShutDown() to *_Disable().
+ *      Rename all references to these functions to use the new function names.

  *
  *  <b>USB Core</b>
  *    - By default, unordered Endpoint and Pipe configuration is now allowed once again, via the previous workaround of
  *
  *  <b>USB Core</b>
  *    - By default, unordered Endpoint and Pipe configuration is now allowed once again, via the previous workaround of

- *      reconfiguring all Endpoints/Pipes in order each time a new Endpoint/Pipe is created. To minimise the compiled program
+ *      reconfiguring all Endpoints/Pipes in order each time a new Endpoint/Pipe is created. To minimize the compiled program

  *      size, the new \c ORDERED_EP_CONFIG compile time option may be defined in the project makefile to restrict the ordering
  *      in exchange for a smaller compiled binary size.
  *      size, the new \c ORDERED_EP_CONFIG compile time option may be defined in the project makefile to restrict the ordering
  *      in exchange for a smaller compiled binary size.

+ *    - The previous F_CLOCK symbol, required in the project makefile, has been renamed to F_USB. This is due to the previous name
+ *      being far too generic for use in future architecture ports, where multiple clock domains are used.

  *
  *  <b>Device Mode</b>
  *    - The Endpoint stream functions now all require a \c BytesProcessed parameter instead of the previous callback parameter.
  *
  *  <b>Device Mode</b>
  *    - The Endpoint stream functions now all require a \c BytesProcessed parameter instead of the previous callback parameter.


@@ -37,6 +54,17 @@
  *      error code to allow the user application to determine when to send the next chunk of data.
  *    - The \ref CDC_Device_SendString() function now expects a null terminated string instead of an explicit length. Existing code
  *      should use the new \ref CDC_Device_SendData() function, or remove the length parameter from the function call.
  *      error code to allow the user application to determine when to send the next chunk of data.
  *    - The \ref CDC_Device_SendString() function now expects a null terminated string instead of an explicit length. Existing code
  *      should use the new \ref CDC_Device_SendData() function, or remove the length parameter from the function call.

+ *    - The Endpoint_ResetFIFO() function has been renamed to \ref Endpoint_ResetEndpoint(), to make the API function names more
+ *      consistent. Existing applications using the old function name should simply replace it with a call to the new function name.
+ *    - The Endpoint_*_Byte() functions have been renamed Endpoint_*_8() 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 Endpoint_*_Word() functions have been renamed Endpoint_*_16() 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 Endpoint_*_DWord() functions have been renamed Endpoint_*_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 Device mode RNDIS class driver no longer stores the incoming and outgoing packets in the class driver instance; the user is
+ *      now expected to manually define a storage location for the packet data. Packets must now be sent and received manually via a call
+ *      to \ref RNDIS_Device_ReadPacket() and/or \ref RNDIS_Device_SendPacket().

  *
  *  <b>Host Mode</b>
  *    - The Pipe stream functions now all require a \c BytesProcessed parameter instead of the previous callback parameter.
  *
  *  <b>Host Mode</b>
  *    - The Pipe stream functions now all require a \c BytesProcessed parameter instead of the previous callback parameter.


@@ -47,6 +75,14 @@
  *    - The \ref PRNT_Host_SendString() and \ref CDC_Host_SendString() functions now expect a null terminated string instead of an explicit
  *      length. Existing code should use the new \ref PRNT_Host_SendData() and \ref CDC_Host_SendData() functions, or remove the
  *      length parameter from the function call.
  *    - The \ref PRNT_Host_SendString() and \ref CDC_Host_SendString() functions now expect a null terminated string instead of an explicit
  *      length. Existing code should use the new \ref PRNT_Host_SendData() and \ref CDC_Host_SendData() functions, or remove the
  *      length parameter from the function call.

+ *    - The Pipe_ClearErrorFlags() function has been removed, as the pipe error flags are now automatically cleared when the
+ *      \ref Pipe_ClearError() function is called.
+ *    - The Pipe_*_Byte() functions have been renamed Pipe_*_8() 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 Pipe_*_Word() functions have been renamed Pipe_*_16() 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 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.

  *
  *  \section Sec_Migration101122 Migrating from 100807 to 101122
  *  <b>USB Core</b>
  *
  *  \section Sec_Migration101122 Migrating from 100807 to 101122
  *  <b>USB Core</b>


@@ -118,7 +154,7 @@
  *
  *  <b>Host Mode</b>
  *    - The \ref CDC_Host_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was
  *
  *  <b>Host Mode</b>
  *    - The \ref CDC_Host_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was

- *      received. This allows for more efficient coding, as a call to \ref CDC_Device_BytesReceived() is no longer needed if the exact
+ *      received. This allows for more efficient coding, as a call to \ref CDC_Host_BytesReceived() is no longer needed if the exact

  *      number of queued bytes received is not needed.
  *    - The \ref CDC_Host_USBTask() now calls \ref CDC_Host_Flush() automatically, flushing any queued data to the attached device. Manual
  *      flushing of the interface is no longer needed if the flushes should be in sync with calls to \ref CDC_Host_USBTask().
  *      number of queued bytes received is not needed.
  *    - The \ref CDC_Host_USBTask() now calls \ref CDC_Host_Flush() automatically, flushing any queued data to the attached device. Manual
  *      flushing of the interface is no longer needed if the flushes should be in sync with calls to \ref CDC_Host_USBTask().


@@ -303,7 +339,7 @@
  *    - The HWB driver has changed to the \c Buttons driver. See the board Buttons driver documentation for the new API.
  *
  *  <b>Dual Role Mode</b>
  *    - The HWB driver has changed to the \c Buttons driver. See the board Buttons driver documentation for the new API.
  *
  *  <b>Dual Role Mode</b>

- *    - The \c USB_PowerOnFail even has been renamed to \c USB_InitFailure.
+ *    - The \c USB_PowerOnFail event has been renamed to \c USB_InitFailure.

  *    - The functions in \c OTG.h have been renamed to remain more consistent with the library API. See the functions in \c OTG.h for more
  *      details.
  *
  *    - The functions in \c OTG.h have been renamed to remain more consistent with the library API. See the functions in \c OTG.h for more
  *      details.
  *


@@ -344,7 +380,7 @@
  *    - All pipe read/write/discard aliases which did not have an explicitly endianness specifier (such as \c Pipe_Read_Word()) have
  *      been removed for clarity. Existing projects should use the \c _LE suffix on such calls to use the explicit Little Endian versions.
  *    - The \c Host_IsResetBusDone() macro has been renamed to \c Host_IsBusResetComplete().
  *    - All pipe read/write/discard aliases which did not have an explicitly endianness specifier (such as \c Pipe_Read_Word()) have
  *      been removed for clarity. Existing projects should use the \c _LE suffix on such calls to use the explicit Little Endian versions.
  *    - The \c Host_IsResetBusDone() macro has been renamed to \c Host_IsBusResetComplete().

- *    - The \c Pipe_Ignore_Word() and \c Pipe_Ignore_DWord() functions have been renamed to \ref Pipe_Discard_Word() and \ref Pipe_Discard_DWord()
+ *    - The \c Pipe_Ignore_Word() and \c Pipe_Ignore_DWord() functions have been renamed to \c Pipe_Discard_Word() and \c Pipe_Discard_DWord()

  *      to remain consistent with the rest of the pipe API.
  *    - It is no longer needed to manually include the headers from \c LUFA/Drivers/USB/Class, as they are now included along with the rest
  *      of the USB headers when \c LUFA/Drivers/USB/USB.h is included.
  *      to remain consistent with the rest of the pipe API.
  *    - It is no longer needed to manually include the headers from \c LUFA/Drivers/USB/Class, as they are now included along with the rest
  *      of the USB headers when \c LUFA/Drivers/USB/USB.h is included.


@@ -360,7 +396,7 @@
  *  \section Sec_Migration090401 Migrating from 090209 to 090401
  *
  *  <b>All</b>
  *  \section Sec_Migration090401 Migrating from 090209 to 090401
  *
  *  <b>All</b>

- *    - LUFA projects must now give the raw input clock frequency (before any prescaling) as a compile time constant \c F_CLOCK,
+ *    - LUFA projects must now give the raw input clock frequency (before any prescaling) as a compile time constant \c F_USB,

  *      defined in the project makefile and passed to the compiler via the -D switch.
  *    - The makefile EEPROM programming targets for FLIP and dfu-programmer no longer program in the FLASH data in addition to the
  *      EEPROM data into the device. If both are to be programmed, both the EEPROM and FLASH programming targets must be called.
  *      defined in the project makefile and passed to the compiler via the -D switch.
  *    - The makefile EEPROM programming targets for FLIP and dfu-programmer no longer program in the FLASH data in addition to the
  *      EEPROM data into the device. If both are to be programmed, both the EEPROM and FLASH programming targets must be called.