Minor documentation enhancements.
[pub/lufa.git] / LUFA / ManPages / ChangeLog.txt
index 1a7303b..e16a33d 100644 (file)
@@ -8,6 +8,72 @@
   *
   *  \section Sec_ChangeLogXXXXXX Version XXXXXX
   *  <b>New:</b>
+  *  - Added new SCSI_ASENSE_NOT_READY_TO_READY_CHANGE constant to the Mass Storage class driver, to indicate when a previously
+  *    not ready removable medium has now become ready for the host's use (thanks to Martin Degelsegger)
+  *  - Moved the Pipe and Endpoint stream related code to two new USB library core source files EndpointStream.c and PipeStream.c
+  *  - Added board hardware driver support for the Olimex AVR-USB-162 development board (thanks to Steve Fawcett)
+  *  - Added board hardware driver support for the Kernel Concepts USBFOO development board
+  *  - Added new USB_Device_GetFrameNumber() and USB_Host_GetFrameNumber() functions to retrieve the current USB frame number
+  *  - Added new USB_Host_EnableSOFEvents(), USB_Host_DisableSOFEvents() and EVENT_USB_Host_StartOfFrame() for the user application
+  *    handling of USB Start of Frame events while in USB Host mode
+  *  - Added new PRNT_Host_BytesReceived(), PRNT_Host_ReceiveByte(), PRNT_Host_SendByte() and PRNT_Host_Flush() functions to the
+  *    Print Host Class driver
+  *  - Added class specific descriptor alternative struct type defines with standard USB-IF element naming
+  *  - Added new project makefile template to the library and moved board driver stub files into in a new "CodeTemplates" directory
+  *  - Added board hardware driver support for the Linnix UDIP development board
+  *  - Added board hardware driver support for the Busware BUI development board
+  *  - Added board hardware driver support for the Arduino Uno development board
+  *  - Added board hardware driver support for the Busware CUL V3 868MHZ radio board
+  *
+  *  <b>Changed:</b>
+  *  - Removed complicated logic for the Endpoint_ConfigureEndpoint() function to use inlined or function called versions
+  *    depending of if the given bank size is a compile time constant, as the compiler does a better job of optimizing
+  *    with basic code
+  *  - Changed over all device demos to use a clearer algorithm for the configuring of the application's endpoints
+  *  - Added missing DataflashManager_CheckDataflashOperation() function to the MassStorageKeyboard demo, removed redundant
+  *    SCSI_Codes.h file as these values are part of the MassStorage Class Driver
+  *  - 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
+  *    not break communications with the host by exceeding the maximum control request stage timeout period
+  *  - Changed the signature of the CALLBACK_USB_GetDescriptor() callback function so that the descriptor pointer is const, to remove
+  *    the need for extra casting inside the callback (thanks to Jonathan Kollasch)
+  *  - Reduced HOST_DEVICE_SETTLE_DELAY_MS to 1000ms down from 1500ms to improve device compatibility while in USB Host mode
+  *  - 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
+  *  - All project makefiles now correctly clean intermediate build files from assembly and C++ sources (thanks to Daniel Czigany)
+  *  - Removed the EVENT_USB_InitFailure() event, not specifying a USB mode correctly now defaults to UID selection mode
+  *  - Renamed and moved class driver common constant definitions to make the naming scheme more uniform
+  *  - Changed default value for the reset polarity parameter in the AVRISP-MKII project so that it defaults to active low drive
+  *  - Changed configuration descriptor parser for all host mode projects and class drivers to ensure better compatibility with devices
+  *
+  *  <b>Fixed:</b>
+  *  - Fixed USB_GetHIDReportItemInfo() function modifying the given report item's data when the report item does not exist
+  *    within the supplied report of a multiple report HID device
+  *  - Fixed MassStorage based demos and projects resetting the SCSI sense values before the command is executed, leading to
+  *    missed SCSI sense values when the host retrieves the sense key (thanks to Martin Degelsegger)
+  *  - Fixed critical pipe/endpoint memory allocation issue where the bank memory address space could be silently overlapped
+  *    in the USB controller if the endpoints or pipes were allocated in anything other than ascending order (thanks to Martin Degelsegger)
+  *  - Fixed USBtoSerial and Benito project SetLineEncoding calls failing if the USART is busy, due to the RX ISR delaying the control
+  *    request handler
+  *  - Fixed LowLevel PrinterHost demo not sending control requests to the attached printer with the correct printer interface wIndex value
+  *  - Added LEDs_ToggleLEDs() function to several board LED drivers which were missing it (thanks to Andrei Krainev)
+  *  - Fixed SET FEATURE and CLEAR FEATURE control requests directed at an unconfigured endpoint causing request timeouts
+  *  - Fixed incorrect signature reported in the CDC class bootloader for the ATMEGA32U2
+  *  - Fixed USB_Host_ClearPipeStall() incorrectly determining the endpoint direction from the currently selected pipe
+  *  - Fixed JTAG_DEBUG_POINT() and JTAG_DEBUG_BREAK() macros not compiling under pure C99 standards mode
+  *  - Fixed endpoint selection within the CALLBACK_HID_Device_CreateHIDReport() callback function causing broken GET REPORT requests
+  *  - Fixed incorrect command name for EEPROM memory programming in the makefile dfu-ee target
+  *  - Fixed BootloaderCDC project failing on some operating systems due to removed Line Encoding options (thanks to Alexey Belyaev)
+  *  - Fixed incorrect LEDs_ChangeLEDs() function in the Benito board LED driver
+  *  - Fixed incorrect USB_DeviceState value when unconfiguring the device without an address set
+  *  - Fixed broken FLASH/EEPROM programming in the AVRISP-MKII clone project when writing in non-paged mode and the polling byte cannot be used
+  *  - Fixed SPI driver not explicitly setting /SS and MISO pins as inputs when SPI_Init() is called
+  *  - Fixed ISR definition conflict in the XPLAIN bridge between the software UART and the AVRISP-MKII ISP modules
+  *
+  *  \section Sec_ChangeLog100807 Version 100807
+  *  <b>New:</b>
   *  - Added new ADC_DisableChannel() function (thanks to Mich Davis)
   *  - Added new VTARGET_REF_VOLTS and VTARGET_SCALE_FACTOR compile time defines to the AVRISP-MKII programmer project to set
   *    the VTARGET reference voltage and scale factor
   *    minimal loads and stores rather than complicated shifts
   *  - The software UART in the XPLAINBridge has been largely altered to try to improve upon its performance and reliability
   *  - The USBtoSerial and Benito projects now flushes received data via a flush timer, so that several bytes can be transmitted at once
-  *  - Removed the automated checking of event names in the demo, project and bootloader makefiles due to inconsistancies between the
+  *  - Removed the automated checking of event names in the demo, project and bootloader makefiles due to inconsistencies between the
   *    behaviour of the command line tools used to perform the check on each platform
   *  - Internal USB driver source files renamed and moved to ease future possible architecture ports
   *  - All internal pseudo-function macros have been converted to true inline functions for type-safety and readability
   *  - Changed LED indicator masks for the AVRISP-MKII project, so that there are defined roles for each LED
+  *  - Altered the CDC Device and Host Class drivers' receive byte routines, so that no data is indicated by the function returning a
+  *    negative value (thanks to Andreas Paulin)
+  *  - Added auto flushing of OUT data to the CDC Host Class driver's USBTask function to automatically flush the send pipe buffer
   *
   *  <b>Fixed:</b>
   *  - Fixed AVRISP project sending a LOAD EXTENDED ADDRESS command to 128KB AVRs after programming or reading from
   *  - Fixed MIDI_Device_SendEventPacket() not correctly waiting for the endpoint to become ready (thanks to Robin Green)
   *  - Fixed Benito and USBtoSerial projects not turning off the USART before reconfiguring it, which could cause incorrect
   *    operation to occur (thanks to Bob Paddock)
+  *  - Fixed Serial peripheral driver not turning off the USART before reconfiguring it, which would cause incorrect operation
+  *    to occur (thanks to Bob Paddock)
+  *  - Fixed software application start command broken in the DFU class bootloader when dfu-programmer is used due to application
+  *    start address corruption
   *
   *  \section Sec_ChangeLog100513 Version 100513
   *  <b>New:</b>
   *
   *  <b>Changed:</b>
   *  - Removed code in the Keyboard demos to send zeroed reports between two reports with differing numbers of key codes
-  *    as this relied on non-standard OS driver behavior to repeat key groups
+  *    as this relied on non-standard OS driver behaviour to repeat key groups
   *  - The SCSI_Request_Sense_Response_t and SCSI_Inquiry_Response_t type defines are now part of the Mass Storage Class
   *    driver common defines, rather than being defined in the Host mode Class driver section only
   *  - The USB_MODE_HOST token is now defined even when host mode is not available
   *  - Added new "Common" section to the class drivers, to hold all mode-independent definitions for clarity
   *  - Moved SCSI command/sense constants into the Mass Storage Class driver, instead of the user-code
   *  - Altered the SCSI commands in the LowLevel Mass Storage Host to save on FLASH space by reducing function calls
-  *  - Changed the parameters and behavior of the USB_GetDeviceConfigDescriptor() function so that it now performs size checks
+  *  - Changed the parameters and behaviour of the USB_GetDeviceConfigDescriptor() function so that it now performs size checks
   *    and data validations internally, to simplify user code
   *  - Changed HIDParser to only zero out important values in the Parsed HID Report Item Information structure to save cycles
   *  - The HID report parser now always processed FEATURE items - HID_ENABLE_FEATURE_PROCESSING token now has no effect
   *    internal control
   *  - Interrupts are no longer disabled during the processing of Control Requests on the default endpoint while in device mode
   *  - AudioOutput demos now always output to board LEDs, regardless of output mode (removed AUDIO_OUT_LEDS project option)
-  *  - Removed SINGLE_DEVICE_CONFIGURATION compile time option in favour of the new FIXED_NUM_CONFIGURATIONS option so that the exact number
+  *  - Removed SINGLE_DEVICE_CONFIGURATION compile time option in favor of the new FIXED_NUM_CONFIGURATIONS option so that the exact number
   *    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
   *
   *  <b>Fixed:</b>
   *  - Changed bootloaders to use FLASHEND rather than the existence of RAMPZ to determine if far FLASH pointers are needed to fix
   *    pipes can be used with the function
   *  - The USB Host management task now saves and restores the currently selected pipe before and after the task completes
   *  - Fixed GenericHIDHost demo report write routine incorrect for control type requests (thanks to Andrei Krainev)
-  *  - Removed Endpoint_ClearCurrentBank() and Pipe_ClearCurrentBank() in favour of new Endpoint_ClearIN(), Endpoint_ClearOUT(),
+  *  - Removed Endpoint_ClearCurrentBank() and Pipe_ClearCurrentBank() in favor of new Endpoint_ClearIN(), Endpoint_ClearOUT(),
   *    Pipe_ClearIN() and Pipe_ClearOUT() macros (done to allow for the detection of packets of zero length)
   *  - Renamed *_ReadWriteAllowed() macros to *_IsReadWriteAllowed() to remain consistent with the rest of the LUFA API
   *  - Endpoint_IsSetupReceived() macro has been renamed to Endpoint_IsSETUPReceived(), Endpoint_ClearSetupReceived() macro has been
   *  - Changed over all deprecated GCC structure tag initializers to the standardized C99 format (thanks to Mike Alexander)
   *  - USB_HostRequest renamed to USB_ControlRequest, entire control request header is now read into USB_ControlRequest in Device mode
   *    rather than having the library pass only partially read header data to the application
-  *  - The USB_UnhandledControlPacket event has had its parameters removed, in favour of accessing the new USB_ControlRequest structure
+  *  - The USB_UnhandledControlPacket event has had its parameters removed, in favor of accessing the new USB_ControlRequest structure
   *  - The Endpoint control stream functions now correctly send a ZLP to the host when less data than requested is sent
   *  - Fixed USB_RemoteWakeupEnabled flag never being set (the REMOTE WAKEUP Set Feature request was not being handled)
   *  - Renamed the FEATURELESS_CONTROL_ONLY_DEVICE compile-time token to CONTROL_ONLY_DEVICE
   *
   *  - Fixed SwapEndian_32() function in Common.h so that it now works correctly (wrong parameter types)
   *  - Updated RNDIS demo - notification endpoint is no longer blocking so that it works with faulty Linux RNDIS
-  *    implementations (where the notification endpoint is ignored in favour of polling the control endpoint)
+  *    implementations (where the notification endpoint is ignored in favor of polling the control endpoint)
   *  - Fixed incorrect Vendor Description string return size in RNDIS demo for the OID_GEN_VENDOR_DESCRIPTION OID token
   *  - Added very basic TCP/IP stack and HTTP/TELNET servers to RNDIS demo
   *  - Fixed DFU bootloader exit causing programming software to complain about failed writes
   *  - Separated out SPI code into new SPI driver in AT90USBXXX driver directory
   *  - Bootloader now returns correct PID for the selected USB AVR model, not just the AT90USB128X PID
   *  - Added support for the RZUSBSTICK board
-  *  - Bicolour driver removed in favour of generic LEDs driver
+  *  - Bicolour driver removed in favor of generic LEDs driver
   *  - Added support for the ATMEGA32U4 AVR
   *  - Added MANUAL_PLL_CONTROL compile time option to prevent the USB library from manipulating the PLL
   *