diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2011-01-13 22:56:49 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2011-01-13 22:56:49 +0000 |
commit | 70d55f6e0ca1f262bd8811ad8d4149e33125819a (patch) | |
tree | 5e618c7cc5bfc8ee4f410c44578d8704bfe72b0a /LUFA/ManPages | |
parent | 9c7594e7db5b06b2703a9975f2b250056ee0c212 (diff) | |
download | lufa-70d55f6e0ca1f262bd8811ad8d4149e33125819a.tar.gz lufa-70d55f6e0ca1f262bd8811ad8d4149e33125819a.tar.bz2 lufa-70d55f6e0ca1f262bd8811ad8d4149e33125819a.zip |
Added new high level TWI packet read/write commands, altered behaviour of the TWI_StartTransmission() function.
Spell check source code files.
Diffstat (limited to 'LUFA/ManPages')
-rw-r--r-- | LUFA/ManPages/ChangeLog.txt | 11 | ||||
-rw-r--r-- | LUFA/ManPages/MigrationInformation.txt | 10 |
2 files changed, 14 insertions, 7 deletions
diff --git a/LUFA/ManPages/ChangeLog.txt b/LUFA/ManPages/ChangeLog.txt index b7a7aad99..edf354c55 100644 --- a/LUFA/ManPages/ChangeLog.txt +++ b/LUFA/ManPages/ChangeLog.txt @@ -37,6 +37,7 @@ * - Combined page and word ISP programming mode code in the AVRISP-MKII clone project to reduce compiled size and * increase maintainability of the code * - Changed over library projects to use the new general ring buffer library driver module + * - Added new high level TWI packet read/write commands, altered behaviour of the TWI_StartTransmission() function * - Changed TempDataLogger project's DS1307 driver to simplify the function interface and prevent a possible race condition * * <b>Fixed:</b> @@ -106,7 +107,7 @@ * - Renamed ENDPOINT_DOUBLEBANK_SUPPORTED() to ENDPOINT_BANKS_SUPPORTED() and changed it to return the maximum number of supported banks for * the given endpoint * - Better algorithm to extract and convert the internal device serial number into a string descriptor (if present) - * - All USB class drivers are now automatically included when LUFA/Drivers/USB.h is included, and no longer need to be seperately included + * - All USB class drivers are now automatically included when LUFA/Drivers/USB.h is included, and no longer need to be separately included * - The MIDI class drivers now automatically flushes the MIDI interface when the MIDI class driver's USBTask() function is called * - Renamed the EVENT_USB_Device_UnhandledControlRequest() event to EVENT_USB_Device_ControlRequest() as it is now fired before the library * request handlers, not afterwards @@ -117,7 +118,7 @@ * - Added compile time error to the AVRISP-MKII project when built for the U4 chips, as the default VTARGET detection ADC channel * does not exist on these chips (thanks to Marco) * - Changed all Device mode LowLevel demos and Device Class drivers so that the control request is acknowledged and any data - * transferred as quickly as possible without any processing inbetween sections, so that long callbacks or event handlers will + * transferred as quickly as possible without any processing in between sections, so that long callbacks or event handlers will * not break communications with the host by exceeding the maximum control request stage timeout period * - Changed over all demos, drivers and internal functions to use the current frame number over the Start of Frame flag where possible * to free up the Start of Frame flag for interrupt use in the user application @@ -127,8 +128,8 @@ * - All LowLevel demos changed to use the constants and types defined in the USB class drivers * - Changed AudioInput and AudioOutput demos to reload the next sample via an interrupt rather than polling the sample timer * - Rescue clock of the AVRISP-MKII moved to the AVR's OCR1A pin, so that the clock can be generated at all times - * - Changed ClassDriver MIDI demos to process all incomming events in a loop until the bank becomes empty rather than one at a time - * - Changed LowLevel MIDI demos to only clear the incomming event bank once it has become empty to support packed event packets + * - Changed ClassDriver MIDI demos to process all incoming events in a loop until the bank becomes empty rather than one at a time + * - Changed LowLevel MIDI demos to only clear the incoming event bank once it has become empty to support packed event packets * * <b>Fixed:</b> * - Core: @@ -599,7 +600,7 @@ * of device configurations can be defined statically * - Removed VBUS events, as they are already exposed to the user application via the regular device connection and disconnection events * - Renamed and altered existing events to properly separate out Host and Device mode events - * - All demos switched over from GNU99 standards mode to C99 standards mode, to reduce the dependancies on GCC-only language extensions + * - All demos switched over from GNU99 standards mode to C99 standards mode, to reduce the dependencies on GCC-only language extensions * * <b>Fixed:</b> * - Changed bootloaders to use FLASHEND rather than the existence of RAMPZ to determine if far FLASH pointers are needed to fix diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt index 489e91a21..8f8fbcd29 100644 --- a/LUFA/ManPages/MigrationInformation.txt +++ b/LUFA/ManPages/MigrationInformation.txt @@ -11,6 +11,12 @@ * areas relevant to making older projects compatible with the API changes of each new release. * * \section Sec_MigrationXXXXXX Migrating from 101122 to XXXXXX + * <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 + * against the \ref TWI_ERROR_NoError return value for success instead of a boolean true value, or it will not function + * correctly. + * * <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 @@ -43,7 +49,7 @@ * - The USB mode specifier constants have been moved into a new enum and renamed. Existing projects should use the equivalent * value in the new \ref USB_Modes_t enum. * - All class driver headers are now included as part of the standard LUFA/Drivers/USB/USB.h master dispatch header, and should - * no longer be included seperately. Class driver module source files must still be added as a seperate module in the project's + * no longer be included separately. Class driver module source files must still be added as a separate module in the project's * makefile if used. * * <b>Device Mode</b> @@ -57,7 +63,7 @@ * for each class driver for the new class specific descriptor type names. * - The ENDPOINT_DOUBLEBANK_SUPPORTED() macro is has been renamed \ref ENDPOINT_BANKS_SUPPORTED() and now returns the total number of * banks supported by the given endpoint. Existing code should switch to the new naming scheme, and test that the return value of the - * macro is equal to or greated than 2 to regain the previous functionality. + * macro is equal to or greater than 2 to regain the previous functionality. * - The EVENT_USB_Device_UnhandledControlRequest() event is now named \ref EVENT_USB_Device_ControlRequest() and fires before (not after) * the internal library event handlers. Existing code should rename the event handlers in the user application to match the new event * name, and should ensure that the new execution order does not affect the application's operation. |