Hide the PROGMEM attribute from Doxygen, as it appears to confuse the parser in some...
[pub/lufa.git] / LUFA / ManPages / MigrationInformation.txt
index d345332..3a23df0 100644 (file)
  *      enhanced \ref USB_Device_SendRemoteWakeup() function. Existing code may now discard any checks to USB_Device_IsRemoteWakeupSent().
  *    - The USB_Device_IsUSBSuspended() macro has been removed, as it is obsolete. Existing code should compare \ref USB_DeviceState
  *      to see if it the device is in the \ref DEVICE_STATE_Suspended state instead.
+ *    - The \ref CDC_Device_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
+ *      number of queued bytes received is not needed.
+ *
+ *  <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
+ *      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().
  *
  * \section Sec_Migration100513 Migrating from 100219 to 100513
  *
@@ -71,7 +81,7 @@
  *  <b>Host Mode</b>
  *    - The MIDI Host Class driver send and receive routines now operate on packed events, where multiple MIDI events may be
  *      packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send
- *      pipe bank is full. To override this new behavior and revert to the previous behavior, the user application may manually
+ *      pipe bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually
  *      flush the queued event(s) to the device by calling \ref MIDI_Host_Flush().
  *    - The Pipe_IsEndpointBound() function now takes the endpoint's direction into account, by checking if the MSB of the endpoint's address
  *      is set to denote IN endpoints. If the previous functionality where the direction is to be discounted is required, mask the endpoint
@@ -80,7 +90,7 @@
  *  <b>Device Mode</b>
  *    - The MIDI Device Class driver send and receive routines now operate on packed events, where multiple MIDI events may be
  *      packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send
- *      endpoint bank is full. To override this new behavior and revert to the previous behavior, the user application may manually
+ *      endpoint bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually
  *      flush the queued event(s) to the host by calling \ref MIDI_Device_Flush().
  *
  * \section Sec_Migration091223 Migrating from 091122 to 091223
  *      call to SPI_Init() before using the Dataflash driver
  *
  *  <b>Host Mode</b>
- *    - The USB_GetDeviceConfigDescriptor() function's parameters and behavior has changed; the user is required to
+ *    - The USB_GetDeviceConfigDescriptor() function's parameters and behaviour has changed; the user is required to
  *      preallocate the largest allowable buffer, and pass the size of the buffer to the function. This allows for a single
  *      call to the function to retrieve, size check and validate the Configuration Descriptor rather than having the user
  *      application perform these intermediary steps.
  *
  *  <b>Library Demos</b>
  *    - The RNDIS demo application has been updated so that it is functional on Linux under earlier implementations
- *      of the RNDIS specification, which had non-standard behavior. Projects built upon the demo should upgrade
+ *      of the RNDIS specification, which had non-standard behaviour. Projects built upon the demo should upgrade
  *      to the latest code.
  *    - The DFU class bootloader has had several bugs corrected in this release. It is recommended that where
  *      possible any existing devices upgrade to the latest bootloader code.