diff options
Diffstat (limited to 'LUFA/ManPages')
-rw-r--r-- | LUFA/ManPages/ChangeLog.txt | 3 | ||||
-rw-r--r-- | LUFA/ManPages/CompileTimeTokens.txt | 5 | ||||
-rw-r--r-- | LUFA/ManPages/FutureChanges.txt | 1 | ||||
-rw-r--r-- | LUFA/ManPages/MigrationInformation.txt | 6 |
4 files changed, 14 insertions, 1 deletions
diff --git a/LUFA/ManPages/ChangeLog.txt b/LUFA/ManPages/ChangeLog.txt index 34e772d63..1bce5faba 100644 --- a/LUFA/ManPages/ChangeLog.txt +++ b/LUFA/ManPages/ChangeLog.txt @@ -10,6 +10,8 @@ * <b>New:</b> * - Core: * - Added new MIDIToneGenerator project + * - Added new ORDERED_EP_CONFIG compile time option to restrict endpoint/pipe configuration to ascending order + * in exchange for a smaller compiled program binary size * - Library Applications: * - Added new incomplete MIDIToneGenerator project * - Added ability to write protect Mass Storage disk write operations from the host OS @@ -17,6 +19,7 @@ * * <b>Changed:</b> * - Core: + * - Unordered Endpoint/Pipe configuration is now allowed once again via the previous reconfig workaround * - Refactored Host mode Class Driver *_Host_ConfigurePipes() routines to be more space efficient when compiled * - Added new *_ENUMERROR_PipeConfigurationFailed error codes for the *_Host_ConfigurePipes() routines * - Library Applications: diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt index 28b7cfc6b..b120617e0 100644 --- a/LUFA/ManPages/CompileTimeTokens.txt +++ b/LUFA/ManPages/CompileTimeTokens.txt @@ -77,6 +77,11 @@ * \section Sec_SummaryUSBTokens General USB Driver Related Tokens * This section describes compile tokens which affect USB driver stack as a whole in the LUFA library. * + * <b>ORDERED_EP_CONFIG</b> - ( \ref Group_EndpointManagement , \ref Group_PipeManagement )\n + * The USB AVRs do not allow for Endpoints and Pipes to be configured out of order; they <i>must</i> be configured in an ascending order to + * prevent data corruption issues. However, by default LUFA employs a workaround to allow for unordered Endpoint/Pipe initialisation. This compile + * time token may be used to restrict the intialisation order to ascending indexes only in exchange for a smaller compiled binary size. + * * <b>NO_STREAM_CALLBACKS</b> - ( \ref Group_EndpointPacketManagement , \ref Group_PipePacketManagement )\n * Both the endpoint and the pipe driver code contains stream functions, allowing for arrays of data to be sent to or from the * host easily via a single function call (rather than complex routines worrying about sending full packets, waiting for the endpoint/ diff --git a/LUFA/ManPages/FutureChanges.txt b/LUFA/ManPages/FutureChanges.txt index 7ae15aa0b..bfa5a530f 100644 --- a/LUFA/ManPages/FutureChanges.txt +++ b/LUFA/ManPages/FutureChanges.txt @@ -20,6 +20,7 @@ * -# Re-add interrupt Pipe/Endpoint support * -# Add HID report macros to make HID report editing easier * -# Investigate dynamically created device descriptors + * -# Check if ALL the workaround reg save/restore code in the unordered EP config is required * - Documentation/Support * -# Add detailed overviews of how each demo works * -# Add board overviews diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt index d12c3f9e9..3bbe5a195 100644 --- a/LUFA/ManPages/MigrationInformation.txt +++ b/LUFA/ManPages/MigrationInformation.txt @@ -11,7 +11,11 @@ * areas relevant to making older projects compatible with the API changes of each new release. * * \section Sec_MigrationXXXXXX Migrating from 101122 to XXXXXX - * None yet. + * <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 + * size, the new 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. * * \section Sec_Migration101122 Migrating from 100807 to 101122 * <b>USB Core</b> |