Release notes for emUSB-Device version V3.18c

Program corrections

1. Renesas R8A66597: Receiving EPs are using now the continuous mode rather than the conventional mode.
2. RNDIS: Changed USB Class field value in Device descriptor to CDC which allows Windows to enumerate RNDIS properly.

Program corrections

1. MSD: When operating in idle (only TestUnitReady commands are sent from the host to the MSD device) it was sometimes possible for the MSD module to loose an incoming command which would cause the host to mark the MSD device as not responding and re-enumerate it. Fixed.

New Features

1. Add support for NXP RT105x controllers.
2. Add support for ST STM32L0538 controllers.
3. Enumeration: Allow a device to have no serial number.
4. Enumeration: Allow to set ISO transfers types in the endpoint descriptor.

Improvements

1. Synopsys DWC2 driver: Allow to configure endpoint memory buffer.
2. General: Moved USB_OS_Panic() from the respective RTOS layers into USB_ConfigIO.c.
3. Bulk host API: Function USBBULK_ResetPipe was removed. Functions USBBULK_ResetINPipe() and USBBULK_ResetOUTPipe() were added.

Program corrections

1. LPC546 FS driver: It was possible for a ClearFeatureHalt request to not clear the data toggle value. This could cause issues for protocols which use the STALL request on non-control EPs (e.g. MSD). Fixed.
2. MSD: When an MSD command was completed with an error and the error was not immediately cleared by the host it was possible for the module to enter a busy-loop until the error condition was resolved by the other side. Fixed.

Improvements

1. Renesas USB: All HS and FS have been merged to one driver including the external USB controller Renesas R8A66597.
2. Renesas USB: Timeout value for a FIFO stuck has been set to minimum value to reduce interrupt execution.

Program corrections

1. Synopsys DWC2 driver: Under some circumstances ISO OUT transfers did not work. Fixed

Program corrections

1. STM32L4xx driver: Workaround for the setup transfer issue of the hardware improved.

New Features

1. TZ1200: Added support for Toshiba TZ1200 series devices.

Improvements

1. MTP: USBD_MTP_SendEvent now has a return value indicating success or failure.

Program corrections

1. STM32L4xx driver: Setup OUT packets are sometimes get corrupted due to a hardware issue of the MCU. Workaround implemented.
2. MTP: USBD_MTP_SendEvent no longer sends data via an asynchronous write. This could result in events being lost if many events were sent at once. Fixed.

New Features

1. LPC54: Added support for the NXP LPC54xxx devices.
2. nRF52: Added support for the Nordic Semiconductor nRF52840 devices.
3. BULK interface: Added new functions USBD_BULK_ReadAsync() and USBD_BULK_WriteAsync().
4. CDC class: Added new functions USBD_CDC_ReadAsync() and USBD_CDC_WriteAsync().
5. Renesas FS driver: Added support for ISO transfers.

Improvements

1. EHCI driver: Allow to configure endpoint memory buffer.

Program corrections

1. BULK interface: Request for MS extended compatible id was not answered correctly if size >= maximum packet size of EP0. Fixed.
2. Atmel SAMD21 driver: USB_Read could not be retriggered in event callback function. Fixed.
3. Atmel SAMD21 driver: Read timeouts were not handled correctly on multi-packet reads. Fixed.
4. Renesas HS driver: It was possible for the BaseAddress variable to be set to 0, which would break communication. Fixed.

Program corrections

1. SAM3U: Added missing source file to driver package.

New Features

1. MTP: Added support for the GetPartialObject command.

Improvements

1. Core stack: Added new function USBD_RemoveOnEvent().
2. Logging: Functions USBD_SetLogFunc() and USBD_SetWarnFunc() are now obsolete. USB_X_Log() and USB_X_Warn() are now always called for log output.
3. ECM / RNDIS / IP-over-USB: Added de-initialization handlers.
4. Audio: Added tasks for read/write handling. Allows the read/write callbacks to notify the application of timeouts.

Program corrections

1. USBBULK API: USBBULK_CancelRead() did cancel all pending reads independent of the instance. Fixed.
2. Enumeration: Other speed descriptor may contain incorrect packet sizes. Fixed.

New Features

1. Added Audio class.
2. BULK interface: Added new function USBD_BULK_Add_Ex().

Improvements

1. Atmel SAMA5D2x, SAMA5D3x driver: Transfer speed improved.
2. Synopsys DWC2 driver: Support ISO transfers.
3. EHCI driver: Allow ISO transfers.
4. Atmel High speed driver: Allow ISO transfers.
5. SmartMSD: Changed USB_SMSD_FILE_INFO to access the short dir entry directly, removed long dir entry from the documentation as it is only used internally.

Program corrections

1. USBBULK API: In case starting the device failed, the memory was not cleaned up and the failed instance was still in memory. Fixed.
2. USBBULK API: Removed fixed DLL binding to CancelIoEx() which only be used when Windows version > Windows XP -> dynamically used. Removed some minor errors.
3. Renesas FS driver: Big Endian was not handled properly. Fixed.
4. Renesas FS driver: When aborting a write transfer, remaining FIFO contents was not flushed. Fixed.
5. RNDIS: EP0 send-data have been modified after the USBD_WriteEP0FromISR() was called. Fixed.
6. Atmel High speed driver (SAM3U, SAMA5D2/3/4x, SAM9x25): Write timeout was not handled correctly. Fixed.

Improvements

1. MTP: Changed USB Class/Subclass/Protocol to PTP in order to allow to be enumerated as PTP in case MTP is not recognized.

New Features

1. Cypress MB9BFxxx support: Added support for MB9BFxxx devices.
2. New function USBD_AddEPEx which allows to configure the maximum packet size of an endpoint.

Improvements

1. EHCI driver: Dynamic endpoint buffer configuration allows reduced RAM usage, if not all endpoints are used.
2. Synopsys DWC2 driver: Dynamic endpoint buffer configuration allows reduced RAM usage, if not all endpoints are used.
3. RNDIS: Changed USB Class/Subclass/Protocol to USB.org assigned IDs (0xE0/0x01/0x03).

Program corrections

1. Synopsys DWC2 driver: High speed controller did not work correctly when enumerated in full speed. Fixed.
2. Renasas FS driver (RX, Synergy): Under some circumstances a GET control request (EP0) was not handled properly after a SET control request (EP0) was executed. Fixed.
   Double-buffering has been disabled on RX targets for safety reasons (data loss).
3. USBBULK API: CancelOperation was pending even though the handle was closed and a new open was initiated. Fixed.
   Reference counter was not locked in release version which can have undefined behavior. Fixed.
4. IP-over-USB: IP_Config_IP_over_USB.c did not initialize the Init structure for USBD_IP_Add() which could cause an exception. Fixed.

New Features

1. ST STM32H7 support: Added support for STM32H7xx devices.
2. SliliconLabs EFM32GG11 support: Added support for EFM32GG11 devices.

New Features

1. USBBULK.net: Added new methods WriteTimed and ReadTimed.

Program corrections

1. Kinetis KHCI driver: Abort of an endpoint did not work correctly. Fixed.
2. MSD: LUN serial numbers longer than 32 bytes would cause a memcpy with a negative array offset, potentially leading to undefined behaviour. Fixed.

Improvements

1. USB BULK API: The Windows host API can now detect devices which have been enumerated by a third party USB 3.0 host controller driver. These drivers do not handle MS OS descriptors properly, which could cause enumeration to fail.

Program corrections

1. Renesas USB FS driver: Stalling a setup request sometimes did not work. Fixed.
2. MSD: USBD_MSD_Disconnect() became ineffective after new enumeration. Fixed.
3. Synopsys DWC2 driver: Driver for HS controller in FS mode separated.
4. Synopsys DWC2 driver: HS controller in FS mode reported high-speed state wrongly. Fixed.
5. Renesas Synergy FS driver: Sometimes NULL packets were not sent to the host. Fixed.

Improvements

1. USB BULK API: New functionality added to allow to send SETUP requests to target devices. For USBBULK.dll and USBBULK.net a new function was introduced. On target side new callbacks can be registered to retrieve SETUP vendor requests or any other SETUP request.

Program corrections

1. IP-over-USB: Under certain circumstances switching between ECM mode and RNDIS may not work properly. Fixed.

Improvements

1. XMC4500, STM32L4xx driver: Improved write transfer speed using dynamic FIFO allocation and double buffering.

Program corrections

1. ATSAMV7x driver: On a write timeout the endpoint was not reset correctly and gets blocked. Fixed.
2. XMC4500 driver: Setup responses with multiple packet size length did not work correctly. Fixed.

New Features

1. IP-over-USB, CDC-ECM, RNDIS: This release makes the requirement for tasks obsolete. USBD_IP_Task(), USBD_ECM_Task() or USBD_RNDIS_Task() are no longer necessary as everything is handled through callbacks (thereby reducing overhead). To use this feature embOS/IP V3.22b or newer is required.

Improvements

1. Printer class: Taskless operation is possible now, if all printer data can be processed in an interrupt.
2. STM32 driver (STM32F0/F3): Enhanced overall read speed in the driver.
3. ATSAMV7x driver: Optimize DPRAM usage to have more endpoints.
4. EHCI driver: Reduce RAM usage.

Program corrections

1. TI OMAP-L138 driver: Under some circumstances the RX buffer can overflow, resulting in data loss. Fixed.
2. Renesas USB HS driver: Stalling a setup request sometimes did not work. Fixed.
3. Renesas USB FS driver: With a self-powered device it was possible upon a second enumeration for the first two packets to be sent in the wrong order. Fixed.
4. Interrupt endpoints: Interval settings < 1ms were not handled correctly, if the device was enumerated in full speed. Fixed.

New Features

1. Drivers: Migrated STR91x driver to emUSB 3 API.

New Features

1. Drivers: Migrated Toshiba TMPA900 driver to emUSB 3 API.

New Features

1. IP-over-USB: Added new component emUSB-Device-IP to easily run any IP-based protocol over USB.

New Features

1. Synopsys DWC2 driver: Added BSP and configuration files for the STM32F769 Discovery evaluation board.

Program corrections

1. Printer class: USB_PRINTER_Task did not work correctly on USB disconnect. Fixed.

New Features

1. MTP: Support for Read/Write callbacks added.
2. MSD / MTP: Added MSD and MTP combination feature.
3. SystemView: SystemView support added.

Program corrections

1. EHCI driver: Receiving non-setup OUT data on endpoint 0 could lead to controller fatal error. Fixed.
2. Synopsys DWC2 driver on STM32: High speed controller did not work when enumerated in full speed. Fixed.
3. Renesas USB HS driver: Enumeration or setup requests may fail due to wrong interrupt handling. Fixed.
4. HID: On some devices the setup request SET_REPORT was not handled correctly. Fixed.
5. MTP: A missing interface name string descriptor prevented emUSB-Device-MTP from being recognized as MTP by Android. Fixed.

New Features

1. AT91SAM9X25: Added Support for Atmel AT91SAM9X25 devices.

Program corrections

1. Synopsys DWC2 driver on STM32: Under some circumstances the FIFO size registers could not be written. Workaround implemented.

New Features

1. IP: Preliminary version of component emUSB-Device-IP to easily run any IP-based protocol over USB.
2. STM32F7: Added Support for STM32F7 devices -> more endpoints available.

Improvements

1. USBBULK .net component: Updated new version that contains USBBULK.net V1.20.
2. Renesas Synergy HS driver: Enhanced overall read/write speeds in the driver.

Program corrections

1. MSD: Under some circumstances the MSD task could hang when the device is removed from host. Fixed.
2. MSD: After re-plugging a MSD device to host the device may not work. Fixed.
3. MTP: The IAR ARM compiler generates wrong code for the function ExecGetObjectPropList when using high optimization level. Fixed.

Improvements

1. KHCI driver: Enhanced read speed in KHCI driver.

Program corrections

1. LPC43xx driver: Maximum number of endpoints for full speed corrected.
2. Synopsys DWC2 driver: Controller may receive an extra packet after an endpoint is disabled. Handling of extra packets implemented.
3. Renesas RX driver: Driver did not properly function with RX231 and RX113. Fixed.
4. MSD: When user assigned a value to pInstData->DriverData.NumSectors the value was ignored. Fixed.
5. MSD: Sending the CSW did not return when device is disconnected from host. Fixed.
6. MSD: Internal variables were not reset after leaving the MSD Task loop. Fixed.
7. Enumeration: Endpoint descriptors for interrupt endpoints did not always contain the correct value for 'bInterval'. Fixed.
8. Enumeration: Unit of the 'Interval' parameter of the function USBD_AddEP() was changed to 125us.
9. Enumeration: It was possible for the callback set by USBD_SetGetStringFunc to not be called because the internal handler incorrectly reduced the received string index. Fixed.

New Features

1. SAMA5D2x: Added Support for Atmel SAMA5D2x devices.

Program corrections

1. RX driver: Handling of Zero-Length-Packets was not handled correctly. Fixed. Waiting for the FIFO setting until the setting are set was not done. Fixed.

New Features

1. Renesas Synergy devices: Added Support for Highspeed Controller in Synergy S3,S7 devices.

New Features

1. ST STM32L4 support: Added support for STM32L4x6 devices.

New Features

1. Renesas Synergy devices: Added support for FullSpeed Controller in Synergy S1,S3,S7 devices.

New Features

1. Renesas SH7269: Added support for SH7269.

New Features

1. Atmel SAMA5D4: Added support for SAMA5D4.
2. Renesas R7FS7G2: Added support for R7FS7G2.

Improvements

1. ST STM32F4x, EnergyMicro EFM32GG: Improved write transfer speed using dynamic FIFO allocation and double buffering.

Program corrections

1. EHCI driver: Correct handling of multiple TX packets on systems using cache.

Improvements

1. BULK interface: Improve write speed when using SEGGER Windows driver on the host.
2. BULK interface: Removed FriendlyName entry from MS_ExtendedProperties table. This entry causes a lot of Windows versions to crash (BSOD) when the device is disconnected.
3. Debug Logging: Replace USBD_PrintSafe with SEGGER equivalent.
4. Synopsys DWC2 driver: Added a USB core reset at init, this alleviates issues with multiple re-enumerations on certain MCUs which use this USB controller.

Program corrections

1. Atmel UDP driver, Synopsys DWC2 driver, Freescale KHCI driver: Re-Initialization (after USBD_DeInit) is done correctly now.
2. MTP: Add timeout for reading zero packet.

Program corrections

1. Initialization: Not all static variables were initialized correctly after low-power mode. Fixed.

Improvements

1. MSD: Handle timeouts during communication with host.
2. DA1468x driver: Handling of endpoint table changed to allow re-initialization.

Program corrections

1. SMSD: API functions renamed (Old API function names still work).
2. Deinitialization: USBD_DeInit() did not always deinitialize all interfaces correctly. Fixed.

New Features

1. Atmel AT91SAM3X: Added support for AT91SAM3X.

New Features

1. BULK: Support WinUSB driver for BULK communication.

Improvements

1. CDC: CDC devices can now be used on Windows 10 without installing a driver.
2. RNDIS, ECM: Added handling (self generated MAC addresses) when user did not assign a MAC address.
3. BULK: Support Windows/Linux/MacOSX hosts with the same target application.

Program corrections

1. CDC: Under some circumstances a serial state packet was not send to the host. Fixed.
2. BSP.c/BSP_USB.c: It was possible for two interrupt handler routines (one for emUSB-Device and one for emUSB-Host) to be registered for one controller. This caused issues for OTG. Fixed.

New Features

1. MTP: Added support for the GetNumObjects MTP command.
2. MSD: Added new function USBD_MSD_RequestRefresh() to force reread of the storage by the host.
3. BULK: Added host API for Linux and Mac OSX.

Improvements

1. SmartMSD: Improvements for using with Mac OSX.
2. DA1468x support: Update OS layer.

Program corrections

1. MTP: MTP_SUPPORT_EVENTS configuration define did not completely disable event handling when set to zero. Fixed.
2. STM32 driver: Check for overflow of buffer memory corrected.

New Features

1. DA1468x support: Add support for Dialog Semiconductor DA1468x.

Improvements

1. SmartMSD: API improved.
2. RNDIS, CDC_ECM: Updated IP driver with new embOS/IP function which allow us to access need information without accessing internal embOS/IP structures directly.
3. FreeRTOS layer: Allow static allocation of objects with FreeRTOS 9.0.0.

Program corrections

1. CDC API: Definition of function USB_CDC_WriteTimedEx in migration layer corrected.
2. BULK interface: USBD_BULK_WriteEx(NumBytes=0, Timeout>=0) didn't wait for completion of pending write transfers: Fixed.
3. STM32 driver: Buffer sizes were not set properly which could lead to all sorts of strange effects.
4. STM32 driver: Added a panic check for endpoint allocations which makes sure users do not allocate more endpoints than there is RAM for them.
5. STM32 driver: Added handling for unaligned access when using access width of 16.
6. STM32F0 driver: Merged with STM32 driver.

New Features

1. TI AM335: Driver using DMA implemented.
2. STM32F7xx support: Added USB config files for the popular STM32F746 DISCO evalboard.

Improvements

1. OS Layer: New operating system layer interface implemented (Can be activated with '#define USBD_OS_LAYER_EX 1' in USB_Conf.h).
2. BULK: Added new configuration macro: USB_EXACT_DATASIZE_ON_CANCEL to speed up BULK reads on particular USB controllers (disables exact behaviour on cancelled read operations).
3. STM32F107: Merged the STM32F107 driver into the DWC2 driver.
4. TI AM335: Added Detach function.

Program corrections

1. USB enumeration: A ZLP was sent for getdescriptor requests when the size of the descriptor matched the ep0 size. Fixed.
2. MSD: The device had to stall bulk ep IN when it sent less data than requested to the host. Fixed.
3. MSD: Fixed MSD_Task so that it correctly considers all return values of USBD_Receive.
4. MSD: Fixes for USB_V2_V3_MIGRATION_MSD_LUN_INFO
5. MSD: StorageRAM: Fixed GetBuffer* functions, previously they did not check buffer limits at all.
6. MTP: Updated NULL Packet handling in _ReceiveBytes function (MTP transfer could have hang up on particular file sizes).
7. MTP: Fixes for USB_V2_V3_MIGRATION_MTP_INFO
8. STM32F1/2/4xx, EFM32GG, XMC45xx: Fix an issue in the driver if using Keil/ARM compiler with optimization (HardFault).
9. Sample configurations: emPower board: Bus muster priorities corrected. STM3210C-EVAL: config file updated.

Improvements

1. Freescale KHCI: Added optimized SendEP routine.

Program corrections

1. Atmel SAMD21 driver: NVM values for USB D+ and D- pads have been read in the wrong byte order. Fixed.
2. Atmel SAMD21 driver: Control request with a DATA OUT phase (CDC: SetLineCoding) did not work properly. Fixed.
3. Atmel SAMD21 driver: Setting an OUT Endpoint to NAK was done before the endpoint was properly initialized. Fixed.
4. TI AM335x driver: Start of frame interrupt removed as it is not necessary for the driver functionality.
5. TI AM335x driver: FIFO addresses were set incorrectly which could cause undefined behaviour when using multiple classes (composite device). Fixed.
6. MTP class: Certain return values during retrival of the object property list were ignored. Fixed.
7. Printer class: The receive data callback wrongly received the return values of the lower-level receive function. The callback is only to be called when at least one bytes is received. Fixed.

New Features

1. BULK: Added new configuration macro: USBD_BULK_REGULAR_2048_XFER to remove the optimization which is used with the SEGGER Windows Bulk driver. By default this macro is not set, it is only necessary when you are writing your own host driver, in that case it can be added to the USB_Conf.h file.

Improvements

1. OS-Layer: Free-RTOS layer improved once more.

Program corrections

1. Atmel SAMD21 driver: Coming out of the USB suspend state did not work. Fixed.
2. uC/OS-II RTOS layer: Read functions would return with the busy flag (-4) under certain circumstances. Fixed.

New Features

1. MTP: Added new configuration macro: USB_MTP_NAME_CASE_SENSITIVE to ignore case sensitivity.

Program corrections

1. MTP:When MTP_SAVE_FILE_INFO was enabled function _AddObject did not compile due to wrong function call. Fixed.
2. MTP:_SetObjectPropObjectFileName: Wrong function was called to remove the object from the object store, resulted that a rename was not shown on the host. Fixed.
3. MTP:USBD_MTP_SendEvent: Calling the function with USB_MTP_EVENT_OBJECTADDED resulted in an undefined behaviour when searching for the object. Fixed.
4. MTP:USBD_MTP_SendEvent: USB_MTP_EVENT_OBJECTREMOVED used the file name instead of the file path to notify the host that the object was removed which resulted in showing the host the wrong file or that no file was removed.

New Features

1. HID: A callback can be set to be notified when a SET_REPORT or GET_REPORT is sent from the host.

Improvements

1. OS-Layer: The OS-Layer for Free-RTOS and uC/OS-II have been improved.
2. Renesas RX driver: Renesas RX62N driver has been renamed to Renesas RX, driver file name and its name has been renamed. Compatibility macros has been added.

Program corrections

1. CDC-ECM: When disconnecting the CDC-ECM device from host, the disconnect was not properly handled. Fixed.
2. Atmel SAMD21: USB Resume interrupt did not work. Fixed.
3. Atmel SAMD21: Read and write operation did not check for proper data alignment. Fixed.

New Features

1. Initial version. Customers coming from emUSB-Device V2 should read the emUSB-Device V3 migration guide. (Doc\AN09001_emUSB_V3_MigrationGuide.pdf).