diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2011-04-04 12:52:30 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2011-04-04 12:52:30 +0000 |
commit | 899df7d3318e478859d940ec8debe679888476a5 (patch) | |
tree | 79955f88fa3d6d47c4de00a0f83cdbd6a7809935 /LUFA/ManPages | |
parent | 2efa79d3ec0630d6baf1cad13fc8f323d090da61 (diff) | |
download | lufa-899df7d3318e478859d940ec8debe679888476a5.tar.gz lufa-899df7d3318e478859d940ec8debe679888476a5.tar.bz2 lufa-899df7d3318e478859d940ec8debe679888476a5.zip |
Renamed all low level Endpoint_Read_*, Endpoint_Write_* and Endpoint_Discard_* functions to use the number of bits instead of a symbolic size (Byte, Word, DWord) so that the function names are applicable and correct across all architectures.
Renamed all low level Pipe_Read_*, Pipe_Write_* and Pipe_Discard_* functions to use the number of bits instead of a symbolic size (Byte, Word, DWord) so that the function names are applicable and correct across all architectures.
Diffstat (limited to 'LUFA/ManPages')
-rw-r--r-- | LUFA/ManPages/ChangeLog.txt | 4 | ||||
-rw-r--r-- | LUFA/ManPages/MigrationInformation.txt | 14 |
2 files changed, 17 insertions, 1 deletions
diff --git a/LUFA/ManPages/ChangeLog.txt b/LUFA/ManPages/ChangeLog.txt index 7b5c667e6..5d5f6db1a 100644 --- a/LUFA/ManPages/ChangeLog.txt +++ b/LUFA/ManPages/ChangeLog.txt @@ -61,6 +61,10 @@ * - Endpoint_ResetFIFO() renamed to Endpoint_ResetEndpoint(), to be consistent with the Pipe_ResetPipe() function name * - Implemented on-demand PLL clock generation for the U4, U6 and U7 series USB AVRs when automatic PLL mode is specified * - F_CLOCK changed to F_USB to be more descriptive, and applicable on future architecture ports + * - Renamed all low level Endpoint_Read_*, Endpoint_Write_* and Endpoint_Discard_* functions to use the number of bits instead of + * a symbolic size (Byte, Word, DWord) so that the function names are applicable and correct across all architectures + * - Renamed all low level Pipe_Read_*, Pipe_Write_* and Pipe_Discard_* functions to use the number of bits instead of + * a symbolic size (Byte, Word, DWord) so that the function names are applicable and correct across all architectures * - Library Applications: * - Changed the XPLAINBridge software UART to use the regular timer CTC mode instead of the alternative CTC mode * via the Input Capture register, to reduce user confusion diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt index cb94bad9a..8d35bbd4c 100644 --- a/LUFA/ManPages/MigrationInformation.txt +++ b/LUFA/ManPages/MigrationInformation.txt @@ -45,6 +45,12 @@ * 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. * * <b>Host Mode</b> * - The Pipe stream functions now all require a \c BytesProcessed parameter instead of the previous callback parameter. @@ -57,6 +63,12 @@ * 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> @@ -354,7 +366,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(). - * - 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. |