Renesas Synergy Software Package (SSP) v1.2.0-b.1 - Release Note · 2016-12-07 · Renesas Synergy™ Platform Renesas Synergy Software Package (SSP) v1.2.0-b.1 . R11UT0004EU0101

Release Note

R11UT0004EU0101 Rev.1.01 Page 1 of 40

Renesas Synergy™ Platform

Renesas Synergy Software Package (SSP) v1.2.0-b.1 Introduction This document describes the release notes for SSP release version 1.2.0-b.1.

Contents

1. Introduction .................................................................................................................... 5

2. Release information ....................................................................................................... 5

3. MCUs supported ............................................................................................................. 5

4. Compatible and tested tools (software and hardware environment) .......................... 6

5. Express Logic, Inc. component version information ................................................... 7

6. Information for upgrading existing projects ................................................................. 7 6.1 General Information .................................................................................................................... 7 6.2 Applications with GUIX ............................................................................................................... 8 6.3 Configuration Support for X-Ware™ ......................................................................................... 8

7. Release package and installation information ............................................................. 8

8. Changes from v1.1.3 to v1.2.0-b.1 release .................................................................... 9 8.1 New features ................................................................................................................................ 9

8.1.1 bsp (Board Support Package) ............................................................................................. 9 8.1.2 C++ support ........................................................................................................................... 9 8.1.3 fx (FileX) ................................................................................................................................. 9 8.1.4 fx_src (FileX Source) ............................................................................................................ 9 8.1.5 gx (GUIX) ................................................................................................................................ 9 8.1.6 gx_src (GUIX Source) ......................................................................................................... 10 8.1.7 NetX and NetX Applications Bundle Configuration Support .......................................... 10 8.1.8 r_ctsu (Capacitive Touch Sensing Unit) ........................................................................... 10 8.1.9 r_flash_hp (Flash Memory, High Performance) ............................................................... 10 8.1.10 r_flash_lp (Flash Memory, Low Power) ............................................................................ 11 8.1.11 r_qspi (Quad Serial Peripheral Interface) ......................................................................... 11 8.1.12 r_riic (IIC) ............................................................................................................................. 11 8.1.13 r_riic_slave (IIC) .................................................................................................................. 11 8.1.14 r_rspi (Serial Peripheral Interface) .................................................................................... 11 8.1.15 r_sce (Secure Crypto Engine) ............................................................................................ 11 8.1.16 r_sci_i2c (Serial Communication Interface I2C) .............................................................. 12

R11UT0004EU0101 Rev.1.01

Renesas Synergy™ Platform Renesas Synergy Software Package (SSP) v1.2.0-b.1

R11UT0004EU0101 Rev.1.01 Page 2 of 40

8.1.17 r_sci_spi (Serial Communication Interface SPI) .............................................................. 12 8.1.18 r_sci_uart (Serial Communication Interface UART) ........................................................ 12 8.1.19 r_ssi ((Inter IC Sound) interface [old: Serial Sound Int.] or r_i2s) ................................. 12 8.1.20 sf_audio_record_adc (Audio Record) ............................................................................... 12 8.1.21 sf_el_nx (Synergy NetX Interface) ..................................................................................... 12 8.1.22 sf_el_ux (Synergy USBX Interface) ................................................................................... 13 8.1.23 USBX Configuration Support ............................................................................................. 13

8.2 Updated features ....................................................................................................................... 13 8.2.1 Common update to all modules ........................................................................................ 13 8.2.2 bsp (Board Support Package) ........................................................................................... 14 8.2.3 NetX (HTTP, DNS, DHCP, FTP, TFTP, Telnet) ................................................................... 14 8.2.4 r_agt (Asynchronous General Purpose Timer) ................................................................ 15 8.2.5 r_cgc (Clock Generation Circuit) ....................................................................................... 15 8.2.6 r_dmac (Direct Memory Access Controller) ..................................................................... 15 8.2.7 r_dtc (Data Transfer Controller) ........................................................................................ 15 8.2.8 r_flash_hp (Flash Memory, High Performance) ............................................................... 15 8.2.9 r_flash_lp (Flash Memory, Low Power) ............................................................................ 15 8.2.10 r_lpmv2 (Low-Power Mode) ............................................................................................... 15 8.2.11 r_sce (Crypto Library) ........................................................................................................ 16 8.2.12 r_sdmmc (SDHI driver for SDIO and SD/MMC memory devices) ................................... 16 8.2.13 sf_el_nx_comms (Synergy NetX Communication Interface) .......................................... 16 8.2.14 sf_el_ux (Synergy USBX Interface) ................................................................................... 16 8.2.15 sf_message (Inter-Thread Messaging) ............................................................................. 16 8.2.16 sf_touch_panel_i2c (Touch Panel I2C) ............................................................................. 16 8.2.17 ux (USBX) ............................................................................................................................. 17 8.2.18 ux_device_class_cdc_acm (USBX Device Class CDC-ACM) ......................................... 17 8.2.19 ux_src (USBX (Source) ....................................................................................................... 17

9. Summary of bug fixes since SSP v1.1.3 ..................................................................... 17 9.1 BSP (Board Support Package) ................................................................................................. 17 9.2 r_adc (A/D converter) ................................................................................................................ 17 9.3 r_agt (Asynchronous General Purpose Timer) ...................................................................... 17 9.4 r_cgc (Clock Generation Circuit) ............................................................................................. 18 9.5 r_dac (Digital to Analog Converter) ........................................................................................ 18 9.6 r_dtc (Data Transfer Controller)............................................................................................... 18 9.7 r_flash_hp (Flash Memory, High Performance) ..................................................................... 18 9.8 r_flash_lp (Flash Memory, Low Power) .................................................................................. 18 9.9 r_gpt_input_capture (General Input Timer) ............................................................................ 18 9.10 r_ioport (General Purpose I/O Ports) ...................................................................................... 19 9.11 r_lpm (Low-Power Mode) ......................................................................................................... 19 9.12 r_ssi ((Inter-IC Sound) interface [old: Serial Sound Int.] or r_i2s) ....................................... 19


R11UT0004EU0101 Rev.1.01 Page 3 of 40

9.13 sf_el_gx (Synergy GUIX Interface) .......................................................................................... 19 9.14 sf_el_nx_comms (Synergy NetX Communication Interface) ................................................ 19 9.15 sf_el_ux (Synergy USBX Interface) ......................................................................................... 19 9.16 sf_el_ux_comms (Synergy USBX Communication Interface) .............................................. 20 9.17 sf_power_profiles (Power Mode Profile) ................................................................................ 20 9.18 sf_touch_panel_i2c (Touch Panel I2C) ................................................................................... 20 9.19 ux (USBX (Device Mode)) ......................................................................................................... 21 9.20 gx (GUIX) .................................................................................................................................... 21

10. Known issues and limitations in SSP v1.2.0-b.1 that are also present in SSP v1.1.3 ....................................................................................................................................... 21

10.1 Issues Common to all of SSP modules (generic): ................................................................. 21 10.2 bsp (Board Support Package) .................................................................................................. 22 10.3 DSP (CMSIS DSP Library) ........................................................................................................ 22 10.4 gx (GUIX) .................................................................................................................................... 23 10.5 nx_http_client (NetX HTTP Client) ........................................................................................... 23 10.6 nxd_dhcp (NetX Duo DHCP Client) ......................................................................................... 23 10.7 r_adc (A/D Converter) ............................................................................................................... 23 10.8 r_agt (Asynchronous General Purpose Timer) ...................................................................... 23 10.9 r_cgc (Clock Generation Circuit) ............................................................................................. 24 10.10 r_ctsu (Capacitive Touch Sensing Unit) ................................................................................. 24 10.11 r_dtc (Data Transfer Controller)............................................................................................... 24 10.12 r_gpt (General Purpose Timer) ................................................................................................ 24 10.13 r_gpt_input_capture (General Input Capture) ........................................................................ 25 10.14 r_ioport (General Purpose I/O Ports) ...................................................................................... 25 10.15 r_qspi (Quad Serial Peripheral Interface) ............................................................................... 25 10.16 r_rspi (Serial Peripheral Interface) .......................................................................................... 25 10.17 r_sce (Crypto Library) ............................................................................................................... 25 10.18 r_sci_i2c (Serial Communication Interface I2C)..................................................................... 26 10.19 r_sci_spi (Serial Communication Interface SPI) .................................................................... 26 10.20 r_sci_uart (Serial Communication Interface UART) .............................................................. 26 10.21 r_sdmmc (SDHI driver for SDIO and SD/MMC memory devices) ......................................... 27 10.22 sf_audio_playback (Audio Playback) ...................................................................................... 27 10.23 sf_el_nx (Synergy NetX Interface) ........................................................................................... 27 10.24 sf_el_nx_comms (Synergy NetX Communication Interface) ................................................ 27 10.25 sf_el_ux (Synergy USBX Interface) ......................................................................................... 27 10.26 sf_message (Messaging Framework) ..................................................................................... 29 10.27 tx (ThreadX) ............................................................................................................................... 29 10.28 tx_src (ThreadX Source) ........................................................................................................... 30 10.29 ux (USBX) ................................................................................................................................... 30 10.30 ux_host_class_hid (USBX Host Storage HID) ........................................................................ 30 10.31 ux_host_class_prolific (USBX Host Prolific Class) ............................................................... 30


R11UT0004EU0101 Rev.1.01 Page 4 of 40

10.32 ux_network_driver (USBX Network Driver) ............................................................................ 30

11. New issues and limitations in SSP v1.2.0-b.1 release ............................................... 31 11.1 Issues Common to all of SSP modules (generic): ................................................................. 31 11.2 Limitations connecting to boards ........................................................................................... 31 11.3 C++ support ............................................................................................................................... 31 11.4 GCC ARM Embedded Toolchain.............................................................................................. 32 11.5 gx (GUIX) .................................................................................................................................... 32 11.6 fx (FileX) ..................................................................................................................................... 32 11.7 nx (NetX (HTTP, DNS, DHCP, FTP, TFTP, Telnet)) ................................................................. 32 11.8 nx_http_server (NetX HTTP Server) ........................................................................................ 33 11.9 nx_pop3 (Applications Bundle - pop3 Client) ........................................................................ 33 11.10 nxd (NetX Duo) .......................................................................................................................... 33 11.11 r_dtc (Data Transfer Controller)............................................................................................... 33 11.12 r_flash_lp (Flash Memory, Low Power) .................................................................................. 33 11.13 r_riic_slave (IIC) ........................................................................................................................ 34 11.14 r_sci_uart (Serial Communication Interface UART) .............................................................. 35 11.15 r_sdmmc (SDHI driver for SDIO and SD/MMC memory devices) ......................................... 35 11.16 r_slcdc (Segment LCD Controller) .......................................................................................... 35 11.17 r_ssi (Serial Sound Interface or r_i2s) .................................................................................... 36 11.18 sf_audio_playback (Audio Playback) ...................................................................................... 36 11.19 sf_console (Console) ................................................................................................................ 37 11.20 sf_el_gx (GUIX Synergy Port) .................................................................................................. 37 11.21 sf_el_nx (Synergy NetX Interface) ........................................................................................... 37 11.22 sf_el_nx_comms (Synergy NetX Communication Interface) ................................................ 38 11.23 sf_el_ux_comms (Synergy USBX Communication Interface) .............................................. 38 11.24 sf_i2c (I2C Framework) ............................................................................................................. 39 11.25 sf_spi (SPI Framework) ............................................................................................................ 39

12. Additional Technical Notices ....................................................................................... 39

Website and Support ........................................................................................................... 40


R11UT0004EU0101 Rev.1.01 Page 5 of 40

1. Introduction This document describes the release notes for SSP release version 1.2.0-b.1.

2. Release information

SSP Release Version 1.2.0-b.1 Release Date December 2nd, 2016

Important notice for this release:

• The intended audience for this release is Renesas Synergy customers, prospective customers, partners, and support staff.

3. MCUs supported S7G2, S3A7, S124, S5D9 groups.


R11UT0004EU0101 Rev.1.01 Page 6 of 40

4. Compatible and tested tools (software and hardware environment)

Tool Version Description

e2 studio 5.2.1.016 Software development and debugging tool. Link: https://synergygallery.renesas.com/

IAR EW for Synergy 7.71.1 Software development and debugging tool. Link:

https://synergygallery.renesas.com/

SSC 5.2.1.016 Synergy Standalone Configurator. Used in combination with IAR EW for Synergy. Link: https://synergygallery.renesas.com

GNU ARM Compiler

eabi-4_9-2015q3-20150921-win32 GNU ARM® compiler GCC_4.9.3.20150529.

IAR Compiler 7.40.5 and 7.71.1 IAR ARM compiler toolchain

PE-HMI1 2.0 Product Example (PE) for Human Machine Interface to evaluate the Renesas Synergy™ S7G2 240 MHz ARM® Cortex®-M4 microcontroller.

DK-S124 3.0 Development Kit for Renesas Synergy™ S124, 32 MHz ARM® Cortex®-M0+ microcontroller in a LQFP64 package.

DK-S7G2 3.1 Development Kit for Renesas Synergy™ S7G2, 240 MHz ARM® Cortex®-M4 microcontroller in a BGA224 package.

SK-S7G2 3.1 Starter Kit for Renesas Synergy™ S7G2, 240 MHz ARM® Cortex®-M4 microcontroller in a LQFP176 package.

DK-S3A7 2.0 Development Kit for Renesas Synergy™ S3A7, 48 MHz ARM® Cortex®-M4 microcontroller in a LQFP144 package.

ASK-S5D9 3.1 Alpha Starter Kit for Renesas Synergy™ S5D9 – Currently this platform is used for Renesas internal development and testing only, and is not available for general distribution.

DK-S5D9 1.0 Development Kit for Renesas Synergy™ S5D9, 120MHz Cortex M4, a 176-pin LQFP package, 2MB Flash, 640KB SRAM.

J-Link Software 6.00h or later Segger J-Link™ debug probe is the quasi standard for

ARM® Cortex®-M based MCUs.





R11UT0004EU0101 Rev.1.01 Page 7 of 40

5. Express Logic, Inc. component version information

Component Version ThreadX® 5.7 NetX™ 5.9 NetX Duo 5.9 SP1 NetX Application bundle 5.9 SP1 USBXTM Host 5.7 USBXTM Device 5.7 SP4 FileX® 5.4 GUIX™ 5.3.2 TraceX® 5.2.0 GUIX™ Studio 5.3.2.2

6. Information for upgrading existing projects 6.1 General Information IMPORTANT NOTICE: This release is a Beta release of SSP, meaning all features have been completed (although there may be some limitations on some functions). Our intention with this release is to provide you with a preview of our latest platform, Synergy Software Package (SSP) v1.2.0-b.1. While we do not recommend taking this version into production of your own products, it will provide an early look at the basis of our future products.

IMPORTANT NOTICE: At this time it is recommended that SSP v1.2.0-b.1 be used for new projects and evaluation of Synergy Platform only. Documents providing information and process for upgrading existing projects based on SSP v1.1.z to SSP v1.2.0-b.1, using either the auto-upgrade feature in e2Studio and IAR EW, or manual/user-intervened upgrade, are still under development and are expected to be made available on Synergy Gallery in January 2017. However, developers who still want to upgrade their existing projects from 1.1.z releases to SSP v1.2.0-b.1 prior to the planned release of upgrade documents should note that at this time all projects that include NetX and USBX will require manual recreating of the projects and module configurations in e2Studio 5.2.1.016 or IAR 7.71.1.

IMPORTANT NOTICE: The pre-built library for USBX Host Mass Storage class v5.7 (libux_host_class_storage) in SSP release versions 1.1.z cannot be used with FileX v5.4 pre-built library (fx) or the Source code (fx_src) provided with SSP v1.2.0-b.1. If they are used together, your application will not work properly and cause unpredictable behavior since some of FileX structure members have been updated for FileX internal use. Make sure you use the pre-built library for USBX Host Mass Storage class v5.7 in SSP v1.2.0-b.1. The FileX Library provided with SSP releases prior to SSP v1.2.0-b.1 are not compatible with the new FileX module provided in this release. If you are using source code modules for both FileX and USBX Host Mass Storage classes, this does not apply.


R11UT0004EU0101 Rev.1.01 Page 8 of 40

Summary:

USBX Host MSC v5.7 in SSP1.1.3 USBX Host MSC v5.7 in SSP1.2.0-b.1

ux_host_class_storage ux_host_class_storage_src ux_host_class_storage ux_host_class_storage_src

FileX 5.2 in

SSP1.1.3

fx VALID VALID NOT VALID NOT VALID

fx_src VALID VALID NOT VALID VALID

FileX 5.4 in

SSP1.2.0-b.1

fx NOT VALID NOT VALID VALID VALID

fx_src NOT VALID VALID VALID VALID

6.2 Applications with GUIX IMPORTANT NOTICE: GUIX Studio auto-generated code (resources.c/.h and specifications.c/.h) must be regenerated from GUIX Studio v5.3.2.2. To upgrade your GUIX Studio project developed with GUIX Studio v5.3.0.1, follow the steps below:

1. Open your existing GUIX Studio project with GUIX Studio v5.3.2.2.

2. Go to Configure menu and open Configure Project window. Set GUIX Library Version to 5.3.2 and click Save to close the window.

3. Go to Project menu and select Generate All Output Files. No change is required, click Generate.

6.3 Configuration Support for X-Ware™ IMPORTANT NOTICE: X-Ware related components have been relocated to the X-Ware category in the graphical view in the Synergy Configurator, and redesigned to improve configurability. To maintain backward compatibility for existing user applications, existing projects using SSP v1.1.z with manually created configurations from the component window will be retained without change at the time of upgrading existing projects in e2Studio and IAR EW. However, these configurations will be tagged as [DEPRECATED] in the upgraded projects. In future, even while SSP will continue supporting these manual configurations, but they will not be further enhanced or maintained in SSP releases made after 1.2.0. It is recommended that existing projects based on SSP v1.1.z with manual configurations for NetX and USBX use the new Synergy configurators for these modules while upgrading to SSP v1.2.0-b.1, however this would require recreating of the project and reconfiguring the modules using Synergy configurators without using the auto-upgrade feature provided with e2Studio and IAR EW. More information on project upgrade is expected to be released on Synergy Gallery in January 2017.

IMPORTANT NOTICE: Only the manually created configurations for NetX and USBX are being deprecated, to be clear, the NetX and USBX modules are not being deprecated and will continue to be supported and enhanced in future SSP releases.

7. Release package and installation information Before installing SSP, ensure that the following items are installed on your PC:

• Renesas e2 studio ISDE v5.2.1.016 (download from Renesas Gallery https://synergygallery.renesas.com/)

• GNU ARM Compiler (included in Renesas e2 studio ISDE v5.2.1.016 installer)

To install the SSP, follow these steps:

1. Download the following items for the SSP Release from Synergy Gallery:

• SSP_Distribution_1.2.0-b.1.zip (SSP Package Installer, including SSP Package, SSP User’s Manual and readme_SSP.txt)



R11UT0004EU0101 Rev.1.01 Page 9 of 40

• Renesas Synergy Software Package (SSP) v1.2.0-b.1 Release Note r11ut0004eu0101-synergy-ssp-120-b1-relnote.pdf

2. Unzip the package and run the SSP_Distribution_1.2.0-b.1.exe installer.

3. Install the SSP in the root folder of a compatible e2 studio installation.

Note: The default installation folder for the SSP is C:\Renesas\e2_studio.

The SSP documentation installs by default to ~Renesas\Synergy\SSP Documentation. You can change the default location during the installation. The following documents will be installed:

• ssp-user-manual-html-v0.96-sspv1.2.0-b1.zip (HTML version of the SSP user’s manual)

• readme_SSP.txt (critical information and last-minute updates)

8. Changes from v1.1.3 to v1.2.0-b.1 release 8.1 New features 8.1.1 bsp (Board Support Package) Description

BSP and peripheral support has been added for the DK-S5D9 and ASK-S5D9 boards. Currently the ASK-S5D9 is used for Renesas internal development and testing only, and is not available for general distribution.

Applies to: DK-S5D9

8.1.2 C++ support Description

SSP modules shall support C++ application environment now, SSP modules can be configured and used in a C++ language environment supported by the e2 studio. Both GCC and IAR compilers can be used for C++ support.

The following are the configurations and other technical details of the SSP C++ support.

ISDE version: e2 studio v5.2.1.016 or later

1. ISDE e2 studio v5.2 and later will support “Synergy C Project “and “Synergy C++ project”. Synergy C++ project will have all the tool chain supports required for C++ applications.

2. For GCC compiler, the default C++ programming language standard supported by the tool is ISO 2011 C++ (-std=c++11).

3. For IAR, the default C++ programing language standard by the tool is ISO/IEC 14882:2003 (C++)

Please refer SSP C++ Usage Guide for more usage details.

Applies to: All Synergy boards

8.1.3 fx (FileX) Description

FileX is upgraded to version 5.4, which includes a new feature, Fault Tolerance. Existing user applications will not be impacted by this upgrade. But note important information provided in Section 6.2 of this Release Note.


8.1.4 fx_src (FileX Source) Description

FileX is upgraded to version 5.4, which includes a new feature, Fault Tolerance. Existing user applications will not be impacted by this upgrade. But note important information provided in Section 6.2 of this Release Note.


8.1.5 gx (GUIX) Description

GUIX is upgraded to version 5.3.2 (v5.3 Service Pack 2) and GUIX Studio version 5.3.2.2, which include a new feature, 8-bit CLUT format support. Existing user applications will not be impacted by this upgrade. But note important information provided in Section 6.3 of this Release Note.


R11UT0004EU0101 Rev.1.01 Page 10 of 40

Applies to: DK-S7G2, SK-S7G2, PE-HMI1, ASK-S5D9

8.1.6 gx_src (GUIX Source) Description

GUIX is upgraded to version 5.3.2 (v5.3 Service Pack 2) and GUIX Studio version 5.3.2.2, which include new feature - 8-bit CLUT format support. Existing user applications will not be impacted by this upgrade. But note important information provided in Section 6.2 of this Release Notes

Applies to: DK-S7G2, SK-S7G2, PE-HMI1, ASK-S5D9

8.1.7 NetX and NetX Applications Bundle Configuration Support Description

New configurators have been added for NetX and NetX Applications Bundle. Previously, all NetX and NetX applications modules were required to be added and configured using a component window. This improvement does the following:

• Allows you add NetX modules using thread stack window. • Auto-resolves all the dependencies by bringing in required modules. • Allows you specify and configure all the run time and compile time options using a configuration window. • Allows you share the modules that can be shared. • Allows you choose different options available for an interface. • Create an instance of all the required low-level modules and create an instance of a top-level module with user-

specified parameters by generating the appropriate C codes. This is applicable to: • nx(NetX) • nx_auto_ip (NetX Auto IP) • nx_bsd (NetX BSD) • nx_dhcp (NetX DHCP Client) • nx_dhcp_server (NetX DHCP Server) • nx_dns (NetX DNS) • nx_ftp_client (NetX FTP Client) • nx_ftp_server (NetX FTP Server) • nx_http_client (NetX HTTP Client) • nx_http_server (NetX HTTP Server) • nx_pop3 (NetX POP3) • nx_smtp (NetX SMTP) • nx_sntp (NetX SNTP) • nx_src (NetX Source) • nx_telnet_client (NetX Telnet Client) • nx_telnet_server (NetX Telnet Server) • nx_tftp_client (NetX TFTP Client) • nx_tftp_server (NetX TFTP Server) Applies to: All Synergy boards

8.1.8 r_ctsu (Capacitive Touch Sensing Unit) Description

Workbench is updated to read MCU information directly from the project configuration instead of manual entry.

Applies to: DK-S3A7, DK_S124, DK_S7G2

8.1.9 r_flash_hp (Flash Memory, High Performance) Description

Implemented Infoget() API function for the flash HP driver, which will return information about the underlying high-performance flash memory. This information includes the number of flash regions, minimum erase and write sizes for both code and data flash.

Applies to: All S7G2 and S5D9 boards


R11UT0004EU0101 Rev.1.01 Page 11 of 40

8.1.10 r_flash_lp (Flash Memory, Low Power) Description

Implemented Infoget() API function for the flash LP driver, which will return information about the underlying low-power flash memory. This information includes the number of flash regions, minimum erase and write sizes for both code and data flash.

Applies to: All S3A7, S124 boards

8.1.11 r_qspi (Quad Serial Peripheral Interface) Description

New API added to provide different erase sizes as well as information about the underline flash APIs

1. Added new API R_QSPI_Erase to r_qspi driver, which will erase block of memory depending on the input argument “byte_count” passed to the API (Typical byte_count value-4096,32768)

2. Added new API R_QSPI_InfoGet to r_qspi driver, which will provide information about the underlying flash like supported erase sizes, size of Flash, flash program size etc.

Applies to: DK-S7G2, SK-S7G2, DK-S3A7

8.1.12 r_riic (IIC) Description

Added DTC transfer support for SCI I2C. Addition of this feature would provide the user with the ability to use DTC to transfer data from receive buffer to user memory and from user memory to transfer memory without using CPU cycles.

Applies to: All MCUs

Description

Added DTC transfer support for RIIC. Addition of this feature would provide the user with the ability to use DTC to transfer data from receive buffer to user memory and from user memory to transfer memory without loading the CPU for data transfer operations.


8.1.13 r_riic_slave (IIC) Description

Added I2C Slave support to MCU so that Synergy board can communicate with other devices as slave.


8.1.14 r_rspi (Serial Peripheral Interface) Description

Added SPI slave support to MCU so that Synergy board can communicate with other devices as slave.


8.1.15 r_sce (Secure Crypto Engine) Description

RNG and AES cryptographic modules are now supported on the S124 device.

Applies to: DK-S124 v2.0

Description

Adds ability to use r_sce module from Synergy C++ projects.

Applies to: PE-HMI1, DK-S3A7, DK-S5D9, and DK-S124

Description

Added support for crypto libraries for the S5D9 device.

Applies to: DK-S5D9 v1.0


R11UT0004EU0101 Rev.1.01 Page 12 of 40

8.1.16 r_sci_i2c (Serial Communication Interface I2C) Description

Added bit-rate modulation function on all SCI modules to improve the accuracy of the baud-rate generation. Using the bit-rate modulation function, the bit rate can be evenly corrected using the number specified in the MDDR register. This will help to reduce % error on baud rates in data communications.

Note that this function is more beneficial for boards with odd frequency crystals and for lower baud-rate communications.


8.1.17 r_sci_spi (Serial Communication Interface SPI) Description




8.1.18 r_sci_uart (Serial Communication Interface UART) Description




8.1.19 r_ssi ((Inter IC Sound) interface [old: Serial Sound Int.] or r_i2s) Description

The SSI driver supports the new SSI v2 (SSIE) hardware in S5D9.

Applies to: S5D9

8.1.20 sf_audio_record_adc (Audio Record) Description

Added new audio recording ADC framework. Using this framework, the user can record audio from an analog device and get the digital recorded data into the buffer configured by user.

Applies to: PE-HMI

8.1.21 sf_el_nx (Synergy NetX Interface) Description

Added callback support to configure MAC address to network interface at run time. To use this feature, follow the steps below.

• Define user callback function void (*p_callback)(nx_mac_address_t *) to return the Ethernet MAC address through the argument.

• Set the name of your callback function to the "Callback" property in the NetX Port ETHER on sf_el_nx component properties in the Synergy Configuration tool.

Note that there is a known issue relevant to this feature. Refer to section 10, Known issues and limitations in SSP v1.2.0-b.1 that are also present in SSP v1.1.3, for more information.

Applies to: S7G2, S5D9


R11UT0004EU0101 Rev.1.01 Page 13 of 40

8.1.22 sf_el_ux (Synergy USBX Interface) Description

Added the feature to force the USBHS hardware to run in USB Host, FS mode. To enable the feature, set “Enable High Speed” configuration in the USBX Port HCD on sf_el_ux for USBHS component to “Disable”.

Applies to: All S7G2 boards

Description

The category of Synergy USBX Interface (USBX Port HS and FS on sf_el_ux) component on the Stacks view in "Threads" tab on Synergy Configurator was moved from Framework > USB to X-ware > USBX > Device>Synergy Port or Framework > USB to X-ware > USBX > Host > Synergy Port. All the X-Ware related components will be organized/placed/located at in this location in all future SSP releases. In addition of that, be aware of the component being split to 4 components in this release.

USBX Port DCD on sf_el_ux for USBFS (USBX Device Controller Driver for USBFS hardware)

USBX Port DCD on sf_el_ux for USBHS (USBX Device Controller Driver for USBHS hardware)

USBX Port HCD on sf_el_ux for USBFS (USBX Host Controller Driver for USBFS hardware)

USBX Port HCD on sf_el_ux for USBHS (USBX Host Controller Driver for USBHS hardware)

Applies to: DK-S7G2, SK-S7G2, DK-S3A7, DK-S124

8.1.23 USBX Configuration Support Description

USBX Host and Device Class stacks are now configurable through Synergy Configurator. By this feature addition, USBX Host/Device Mass Storage Class, HID Class and CDC-ACM Class stack configuration is supported and stack initialization is taken care of in the auto-generated code. For more details, see the SSP Usage Notes.

It’s applicable to:

• ux_host_class_cdc_acm (USBX Host CDC-ACM) • ux_host_class_cdc_acm_src (USBX Host CDC-ACM Source) • ux_host_class_hid (USBX Host HID Class) • ux_host_class_hid_src (USBX Host HID Class Source) • ux_host_class_storage (USBX Host Mass Storage Class) • ux_host_class_storage_src (USBX Host Mass Storage Class Source) • ux_host_class_hub (USBX Host HUB Class) • ux_host_class_hub_src (USBX Host HUB Class Source) • ux_device_class_cdc_acm (USBX Device CDC-ACM) • ux_device_class_cdc_acm_src (USBX Device CDC-ACM Source) • ux_device_class_hid (USBX Device HID Class) • ux_device_class_hid_src (USBX Device HID Class Source) • ux_device_class_storage (USBX Device Mass Storage Class) • ux_device_class_storage_src (USBX Device Mass Storage Class Source) • ux (USBX) • ux_src (USBX Source) Note that ux_device_class_cdc_acm and ux(USBX) have been supported in the Synergy Configurator in SSP v1.1.z but those are marked as [DEPRECATED] in this version, which means not recommended for new development.

Applies to: S7G2, S5D9, S3A7, S124

8.2 Updated features 8.2.1 Common update to all modules Description

The following architecture updates were made to all modules to improve portability between MCUs:

- A new API productFeatureGet has been added to the FMI to query the factory flash for MCU specific features and capabilities. All SSP modules now use this API to query the capabilities and features available in the MCU.


R11UT0004EU0101 Rev.1.01 Page 14 of 40

- The vector table and an associated vector information array are now built at link time from SSP_VECTOR_DEFINE macros instead of being a fixed list of pre-named vectors. This is handled by the Synergy Configuration tool when interrupts are enabled.

- Interrupt priorities are passed into each module during open() instead of being set once during initialization.

- Weak links to internal callbacks defined in the SSP generated code are no longer provided. If a user callback is used, it must be defined in the application code or a linker error will occur.

- The functions R_BSP_HardwareLock and R_BSP_HardwareUnlock now take ssp_feature_t as an argument instead of the bsp_hw_lock_t enumerated list.

- All control structures (<interface>_ctrl_t) have been moved from the interface header files (ssp/inc/api/<interface>_api.h) to the instance header file (ssp/inc/instances/<instance>.h). This change is transparent in code generated by the e2 studio Synergy Configuration tool. If a control structure is allocated in application code outside the Synergy Configuration tool, the typedef name used in the declaration must be changed from <interface>_ctrl_t to <instance>_instance_ctrl_t.

- A new API eventInfoGet has been added to the FMI to get the ELC event (elc_event_t) and IRQ number (IRQn_Type) for a given feature and signal.


Description

Module initialization code for shared/common modules used by multiple threads is run from the first thread to execute instead of being run before the RTOS has started.


Description

Added the feature in all framework XMLs to incorporate the following improvements:

1. To catch the failures in the initialization function in the generated code.

2. This feature is about creation of weak function in the generated code which can be overridden by the user in the application in a user defined function. If required.

3. Whenever the initialization function fails in the generated code, it calls the user defined function, if it is defined in the application.

If these steps are not followed, weak function will be called which has a break point macro BSP_CFG_HANDLE_UNRECOVERABLE_ERROR(0).


Description

All non-SSP externals drivers that goes alongside SSP are now moved to a new directory structure under renesas_sybd directory. Contents under renesas_sybd are in non-encrypted format and user can update existing drivers or add new custom drivers in to this folder. This folder will be visible only if your project contains any module using an external driver, for example the touch i2c framework.

See the SSP User’s Manual to learn how to add custom drivers to the framework.


8.2.2 bsp (Board Support Package) Description

When ThreadX is added to a project, BSP_CFG_RTOS (in bsp_cfg.h) is now automatically set, no longer requiring you to do so.


8.2.3 NetX (HTTP, DNS, DHCP, FTP, TFTP, Telnet) Description

All X-Ware user manual/guide documents are distributed through the Synergy Gallery. In case of inconsistency with the available document in the SSP pack, the user is advised to refer to the corresponding document available from the Synergy Gallery.


R11UT0004EU0101 Rev.1.01 Page 15 of 40


8.2.4 r_agt (Asynchronous General Purpose Timer) Description

Added set duty cycle support to AGT timer.


8.2.5 r_cgc (Clock Generation Circuit) Description

XML is created to create a cgc_clocks_cfg_t structure.

Applies to: All Synergy MCUs

Description

A new clocksCfg API is added to the CGC module. This API enables the application to start and stop multiple clocks and switch the clock source in a single API.


Description

Operating power control is now integrated into CGC. The user no longer needs to explicitly control the operating power control mode of the MCU. The only exception is if they need to use the operating power control mode "low voltage".


8.2.6 r_dmac (Direct Memory Access Controller) Description

Added support of blockReset() in DMA driver, to support run time reset of configuration parameters in a block transfer.


8.2.7 r_dtc (Data Transfer Controller) Description

Added support of blockReset() in dtc driver, to support run time reset of configuration parameters in a block transfer.


8.2.8 r_flash_hp (Flash Memory, High Performance) Description

Flash HP module now supports the S5D9 MCU in addition to the S7G2.

Applies to: S5D9

Description

r_flash_hp and r_flash_lp use 'f' suffix with floating point constants.

Applies to: All the S7G2 and S5D9 boards

8.2.9 r_flash_lp (Flash Memory, Low Power) Description

r_flash_hp and r_flash_lp use 'f' suffix with floating point constants.

Applies to: All the S7G2 and S5D9 boards

8.2.10 r_lpmv2 (Low-Power Mode) Description

LPM V2 is a new Low-Power Modes peripheral driver with enhanced configuration support available in the Threads tab of the e2 studio Synergy Configurator.



R11UT0004EU0101 Rev.1.01 Page 16 of 40

8.2.11 r_sce (Crypto Library) Description Added support for RNG and AES in Crypto Library for S124. Applies to: DK-S124 v2.0

8.2.12 r_sdmmc (SDHI driver for SDIO and SD/MMC memory devices) Description

Made transfer module a required option for SDIO transfer, whereas earlier it was optional. Also SDIO block overrides all the options in DMAC/DTC except for the name.

Applies to: DK-S7G2, DK-S3A7

Description

Added new control command SSP_COMMAND_SET_BLOCK_SIZE to change the block size of the SDMMC.


8.2.13 sf_el_nx_comms (Synergy NetX Communication Interface) Description

Modified Error handling in Read API as it returning SSP_ERR_INTERNAL instead of SSP_ERR_TIMEOUT whenever time out occurs.


8.2.14 sf_el_ux (Synergy USBX Interface) Description

Changed the implementation of the USBX Port Device Controller Driver (DCD) to utilize the Block Reset API if the Transfer Module is used.


Description

Double buffer feature is implemented in the USB Port Host Controller Driver (HCD).


8.2.15 sf_message (Inter-Thread Messaging) Description

Fixed issue of using keyword "class" in the st_sf_message_header. Member 'class' is now changed to 'class_code'. This change is made to make the module compatible with C++ language.


8.2.16 sf_touch_panel_i2c (Touch Panel I2C) Description

There has been a feature to rotate a GUIX screen in GUIX Synergy Port module (sf_el_gx) in SSP1.1.0. However, there was no function to rotate touch coordinates data in the Touch Panel I2C Framework module, so you were required to rotate the coordinates manually. With this update, you are able to rotate the touch coordinate data through the Synergy Configurator. You can configure the module property "Touch Coordinate Rotation Angle (Clockwise)" to apply 90|180|270 degree coordinate rotation.


Description

Touch chip drivers for ft5x06 and sx8654 are moved out from sf_touch_panel_i2c module. All external drivers are now placed under renesas_sybd folder. With this change, the external device drivers are in non-encrypted format.

Note: For existing projects using sf_touch_panel_i2c, you need to select the touch chip driver in the configuration (use the "Add Touch Driver" box to select the touch driver) and generate project content. You will see an additional directory structure for touch drivers when generating the project.

See the SSP User’s Manual to learn how to add custom drivers to the framework.


R11UT0004EU0101 Rev.1.01 Page 17 of 40

Applies to: DK-S7G2, DK-S5D9, ASK-S5D9, PE-HMI1

8.2.17 ux (USBX) Description

The category of USBX (USB on ux) component on the Stacks view in the "Threads" tab on Synergy Configurator was moved from Framework > USB to X-ware > USBX. All the X-Ware related components will be placed at this location in future SSP releases.

Note that we still have USBX (USB on ux) at Framework > USB but marked as [DEPRECATED] in this version, which means not recommended for new development.


8.2.18 ux_device_class_cdc_acm (USBX Device Class CDC-ACM) Description

The category of USBX Device Class CDC-ACM (ux_device_class_cdc_acm) component on the Stacks view in "Threads" tab on Synergy Configurator was moved from Framework > USB to X-ware > USBX > Classes. All the X-Ware related components will be placed at this location in future SSP releases. In addition to the category change, the USBX Device Class stack configuration is updated. When adding the module, all relevant modules, which the USBX Device Class stack relies on are automatically added to the project (auto-fill-in function).

Note that we still have USBX Device Class CDC-ACM (ux_device_class_cdc_acm) at Framework > USB but marked as [DEPRECATED] in this version, which means not recommended for new development.


8.2.19 ux_src (USBX (Source) Description

The category of USBX Source (ux_src) component on the Stacks view in "Threads" tab on Synergy Configurator was moved from Framework > USB to X-ware > USBX. All the X-Ware related components will be placed at this location in future SSP releases.


9. Summary of bug fixes since SSP v1.1.3 9.1 BSP (Board Support Package) Description

Added Critical Section around update for individual MCU Register protections.

Applies to: ASK-S5D9, DK-S7G2, SK-S7G2, DK-S3A7, DK-S124

Description

Typo in system_s124.h fixed.

Applies to: All S124 boards

Description

The IOPORT write function was not reentrant and as a result might not actually write the expected value because another thread could lock the register before the write occurs. This has been fixed.

Applies to: All S7G2, S124 and S3A7, S5D9 boards

9.2 r_adc (A/D converter) Description

r_adc API is updated to support 16 sample addition.

Applies to: All S3A7, S7G2, S124 boards

9.3 r_agt (Asynchronous General Purpose Timer) Description

AGTCR flags no longer cleared during start and stop.


R11UT0004EU0101 Rev.1.01 Page 18 of 40


9.4 r_cgc (Clock Generation Circuit) Description

The Systick timer interrupt priority was changed if the application changed the system clock source at runtime. This prevented the RTOS scheduler from running after the system source clock was changed.


9.5 r_dac (Digital to Analog Converter) Description

Added test cases to verify structural hole.


9.6 r_dtc (Data Transfer Controller) Description The DTC HAL driver limits the transfer size in normal mode to 1024. In synergy/ssp/src/driver/r_dtc.c, in the function R_DTC_Enable():

if (TRANSFER_MODE_NORMAL == p_local_info->mode) { SSP_ASSERT(p_local_info->length <= DTC_NORMAL_MAX_LENGTH); } Where (from synergy/ssp/inc/driver/instances/r_dtc.h) /** Length limited to 1024 transfers for normal mode */ #define DTC_NORMAL_MAX_LENGTH (0x400)

But the DTC HW can do up to 65535 transfers in normal mode (if CRA is set to 0xFFFF) .

In repeat mode the maximum data transfer size is 256 x 32 bits = 1024 bytes, or in Block transfer mode the maximum block size is 256 X 32 bits = 1024 bytes.

Applies to: All S7G2, S3A7 and S124, S5D9 boards

Description

The DTC xml buf fix for software event vector assignment completed.

Applies to: DK-S7G2, SK-S7G2

9.7 r_flash_hp (Flash Memory, High Performance) Description

Removed global variable g_flash_api_open and used available control structure member.

Applies to: DK-S7G2

9.8 r_flash_lp (Flash Memory, Low Power) Description

The API 'opened' flag has been moved into the flash_ctrl_t structure, and it’s no longer a global variable.

Applies to: DK-S3A7, DK-S124

9.9 r_gpt_input_capture (General Input Timer) Description

Typo in GPT XML display drop down for clock divisors fixed.


Description

Typo in GPT XML display drop-down for clock divisors fixed.



R11UT0004EU0101 Rev.1.01 Page 19 of 40

9.10 r_ioport (General Purpose I/O Ports) Description

Ensures that the PWPR register is protected and under control of a reference counter so that in a multithreaded system, its contents cannot be altered by another thread while executing an HW_IOPORT_PFSWrite() call.

Applies to: All S7G2, S124 and S3A7, S5D9 boards

9.11 r_lpm (Low-Power Mode) Description

An application using the LPM driver and ThreadX should revert the low-power mode to sleep immediately after wake from standby. The LPM driver usage notes in SSP User’s manual were updated to describe how to do this. This is not needed if Power Profiles framework is used.


9.12 r_ssi ((Inter-IC Sound) interface [old: Serial Sound Int.] or r_i2s) Description

Typo in I2S XML configuration, Enabled should be I2S_WS_CONTINUE_ON.


Description

Fixed receive typo transfer pointer in SSI XML.


Description

The SSI DTC activation source calculation for channel 1 was incorrect. This is fixed, and SSI channel 1 can be used with DTC.

Applies to: All S7G2 and S3A7 boards

9.13 sf_el_gx (Synergy GUIX Interface) Description

There was an issue in GUI Synergy Port module to cause slow rendering and tearing on LCD panel screen if you have following configurations:

• Rotate screen 90 or 270 degree.

• Enable 2DG engine (DRW module)

With this fix, the rendering speed got faster and tearing would not happen.


9.14 sf_el_nx_comms (Synergy NetX Communication Interface) Description

Chained Packet support was added in SSP v1.1.0 but one compiler warning remained unresolved. The warning is resolved.


9.15 sf_el_ux (Synergy USBX Interface) Description

Assigned proper fifo Index for USBX HCD Interrupt transfer, so that the driver use DFIFO for DMA Interrupt transfer, instead using CFIFO every time.



R11UT0004EU0101 Rev.1.01 Page 20 of 40

Description

On Synergy Configurator Stacks view, there is a constraint for the USBX Port (sf_el_ux) component to warn users to enable the USBFS interrupt if not enabled. However, the constraint was not functional for S3A7 parts. With this fix, the constraint works as designed.

In addition of that, please be aware of the component USBX Port (sf_el_ux) being split to four components in this release described in 8.1.22.

For S3A7 device, you can choose USBX Port HCD for USBFS for USB Host classes or USBX Port DCD for USBFS for USB Device classes.

Applies to: DK-S3A7

Description

USBHS hardware on S7G2 or S5D9 have a BUSWAIT register, which is used for adjusting access cycles to the USBHS registers from bus masters (CPU/DMAC or DTC). In SSP release 1.1.0, the setting was hard-coded to 7 cycles but it was only appropriate when the PCLKA frequency is 120 MHz. The access cycle calculation has been made configurable at run-time based on the PCLKA frequency configuration that is selected.


Description

USB data throughput is improved for USB HCD (Host Controller Driver) for bulk transfer, by adding continuous transfer, configurable FIFO size and optimized read (IN) and write (OUT) transfer logic.

The FIFO size can be configured using the macro UX_SYNERGY_MAX_BULK_PAYLOAD as a preprocessing option in your project. The valid values start from 64 bytes to 2K for Bulk transfer, recommend to configure the macro value to 2048, if we need to achieve maximum throughput.

The FIFO size configuration is valid in the case of High Speed Host and not valid for Full speed.


9.16 sf_el_ux_comms (Synergy USBX Communication Interface) Description

The USB CDC class initialization is moved from the open function call of sf_el_ux_comms framework to the code auto-generated by the USBx CDC XML configurator.

Applies to: All the Synergy boards

Description

Fixed coding standard violation in the underlying hcd and cdc ux driver.


9.17 sf_power_profiles (Power Mode Profile) Description

The clock configuration was not being verified before changing the operating power control mode of the MCU. The clock configuration is now verified to be compatible with the “Subosc-speed” operating power control mode.


Description

Power Profiles was updated to revert the low-power mode after wake from standby when ThreadX is part of a project.


9.18 sf_touch_panel_i2c (Touch Panel I2C) Description

The issue was found in getting a NAK return from SX8654 touch chip controller in the I2C communication. It resulted in the hang up of the Touch Panel I2C Framework module since the touch chip continue to hold the IRQ signal line to low. The framework module needs the IRQ signal line to be back high to handle the next touch event, so it need to have


R11UT0004EU0101 Rev.1.01 Page 21 of 40

the touch chip set the IRQ signal high. With this update, the SX8654 touch controller driver performs retry communications (up to 10 times) if the chip returned NAK and tries to return the IRQ signal back to high.

Applies to: DK-S7G2, SK-S7G2

9.19 ux (USBX (Device Mode)) Description

USBX Device CDC-ACM Class could stall in the service call ux_device_class_cdc_acm_read() when it met the following conditions:

• "requested_length" argument of ux_device_class_cdc_acm_read() is larger than wMaxPacketSize (*see note below).

• Reception data in bytes from USB Host CDC-ACM device was exactly the same number as wMaxPacketSize.

• USB Host CDC-ACM device did not send consequent data after sending bytes with wMaxPacketSize for some reason.

Note * wMaxPacketSize: Max payload size specified in BULK-OUT Endpoint Descriptor in the USB Device Descriptor (it is 64 in FS mode or 512 in HS mode in general).

This issue no longer happens in this release since the ux_device_class_cdc_acm_read() was updated to return back to the caller application when receiving data equal to wMaxPacketSize in bytes.

IMPORTANT NOTICE: The ux_device_class_cdc_acm_read() returns to caller when receiving data equal to wMaxPacketSize in bytes, regardless of the number specified to "requested_length". It is your responsibility to check the "actual_length" argument returned back from the service call to find out if the total reception bytes reached the "requested_length".

Applies to: All S7G2 boards, DK-S3A7, DK-S124

Description

Resolves an issue where ux_host_class_hub.h file has duplicate entries in synergy project and caused compilation errors in some situations.


9.20 gx (GUIX) Description

Resolved bug in GUIX API _gx_system_timer_expiration() not to set a member named 'gx_event_target' of the timer_event structure.

Applies to: DK-S7G2, SK-S7G2, PE-HMI1, DK-S5D9

10. Known issues and limitations in SSP v1.2.0-b.1 that are also present in SSP v1.1.3

10.1 Issues Common to all of SSP modules (generic): Description

If control structures are not all zeros, then function calls other than the open() may incorrectly determine that the Module has already been opened. If this occurs, then the Module may cause undefined behavior since it has not been properly initialized. Statically allocated control structures will be zeroed-out as part of the C runtime initialization by the BSP. An example of when a control structure should be explicitly zeroed-out is if it was allocated off the stack.

Workaround: Ensure that control structures are all zeros before first use.

Applies to: All the Synergy parts

Description

Information in the Description column of the Components pane of the Synergy Configurator in e2 studio might be invalid.


R11UT0004EU0101 Rev.1.01 Page 22 of 40

Workaround: Ignore the information in the Description column of the Components pane.

Applies to: All SSP modules

Description

Customers should use version 4.9 or greater of the GCC ARM Embedded Toolchain.

Otherwise the build might fail to build due to _sbrk function duplication (original exists in the GCC library). Improved version of _sbrk has been added to the SSP to fix the malloc() issue, however the compiler reports function duplicate on build and generates an error. Here's the workaround for GCC Toolchain 4.8:

In the project settings, the default linker flag: --specs=rdimon.specs should be changed to: --specs=nosys.specs

Applies to: Projects using GCC ARM Embedded Toolchain

Description

When building a project using GCC, it is possible that not all of the requested Heap area is made available to the application. As part of a fix for a prior issue with GCC which would allocate areas outside of the heap, we now provide our own _sbrk() function for Heap allocation. The library version of malloc() in use requires a minimum 4K pagesize. As a result, an request for memory via malloc() may fail even though there is sufficient space available for the request.

Workaround: If malloc() requests are failing and indicating no memory available, then increasing the Heap size would be necessary.

Applies to: All MCU

Description

The registers defined for the PWM Delay Generation Circuit (R_GPT_ODC) in S7G2.h and S5D9.h are not correct and should not be used to create custom drivers. This does not affect any existing SSP driver.

Workaround: Access the registers using the register addresses in the hardware manual.


Description

When using ThreadX applications with IAR compiler and use functions which relies on the fact that the static variables are zero initialized (For eg: standard library time functions) will cause application to cause run time failures

Workaround: Add the following lines to the linker script for building applications which are multi-threaded

initialize by copy with packing = none { section __DLIB_PERTHREAD }

Applies to: All MCU

10.2 bsp (Board Support Package) Description

On the boards listed, the setup of the QSPI interface by the BSP does not set all unused bits to a known value. This will not break any functionality of QSPI and does not impact the QSPI module itself. It is mentioned only in the event that someone is writing code to use/test the QSPI that is on the development boards.

Workaround: NONE

Applies to: DK_S3A7, DK_S7G2, SK_S7G2, DK_S5D9, ASK_S5D9

10.3 DSP (CMSIS DSP Library) Description

A linker error may occur when DSP library functions are used.

Workaround: Download the DSP library from ARM and add the file CMSIS\DSP_Lib\Source\CommonTables\arm_const_structs.c to your project. The CMSIS DSP library can be downloaded here: http://www.arm.com/products/processors/cortex-m/cortex-microcontroller-software-interface-standard.php.


http://www.arm.com/products/processors/cortex-m/cortex-microcontroller-software-interface-standard.php

http://www.arm.com/products/processors/cortex-m/cortex-microcontroller-software-interface-standard.php


R11UT0004EU0101 Rev.1.01 Page 23 of 40


A macro named GX_TICKS_SECOND defined in gx_port.h does not represent 1 second but 400 ms if ThreadX system tick time is set to 10 ms (default).

Workaround: Define the macro GX_TICKS_SECOND=50 as a C Compiler Preprocessor.

Applies to: DK-S7G2, SK-S7G2, PE-HMI1, DK-S5D9, DK-S3A7

Description

The IS_SIGNAL() macro is wrongly defined in gx_api.h and uses the label 'LAST_SIGNAL', which is not defined within GUIX but a typo of 'GX_LAST_SIGNAL'. The use of IS_SIGNAL() results in a build error.

Workaround: Define LAST_SIGNAL=0x00ffffff as a C Compiler Preprocessor.


Description

Multi-line texts drawn by _gx_multi_line_text_view_text_set() API may be gone from the widget if the widget is once hided under the other widget.

This issue fix has been addressed in GUIX5.3.2 by Express Logic but it has yet to be tested in this version.

Workaround: Not required.


10.5 nx_http_client (NetX HTTP Client) Description

NetX HTTP Client is hard coded to support HTTP 1.0 only. Some HTTP servers reject HTTP 1.0 GET requests so the HTTP client shall be made configurable in future SSP releases. Workaround: None, supports HTTP 1.0 only in this release.


Description

Memory leak may happen in nx_http_client_get_start() if we received a GOOD request without “Content-Length”. This issue has been fixed according to the code inspection but not tested yet in this version.

Workaround: Not required.


10.6 nxd_dhcp (NetX Duo DHCP Client) Description

nx_dhcp_user_option_retrieve() in NetX v5.9 SP1 returns an IP address of the DHCP server that is byte-swapped compared to NetX v5.9.

Workaround: Swap bytes of the IP address which is obtained by nx_dhcp_user_option_retrieve() in application code.


10.7 r_adc (A/D Converter) Description

Temperature readings may not be accurate if the PCLK value is not 60 MHz on the S7G2 and 24 MHz on the S3A7 and 8MHz on the S124.

Workaround: Use the SetSampleState APi call to set the sample state count when changing ADC operating clock frequency.

Applies to: S7G2, S3A7, S124

10.8 r_agt (Asynchronous General Purpose Timer) Description


R11UT0004EU0101 Rev.1.01 Page 24 of 40

Due to hardware limitations on the S3A7 MCU, maximum clock input to AGT is dependent on the selection of power domains between Vcc and Vbatt. When Vcc is selected, both AGTs can operate with a maximum input clock of 32 MHz. When Vbatt is selected, both AGTs can only operate with a maximum input clock of 32 KHz.

Due to hardware limitations on the S3A7 MCU, when operating mode transitions from Normal to Standby, Vbatt can go out of regulation temporarily. In some cases the interrupt required for transitioning operating mode from Standby to Normal (wakeup) is not negated. The result of this condition is that the interrupt that should cause an operating mode transition from Standby to Normal (wakeup) is not detected and the MCU remains in Standby mode.


10.9 r_cgc (Clock Generation Circuit) Description

Changing clocks at runtime may cause incorrect operating power control mode to be used.

Workaround: None


Description

May cause low speed mode to be used instead of subosc speed mode. Will occur if the system clock is changed from any other clock to subclock at runtime.

Workaround: Do not change the system clock from any other clock to subclock at runtime.


10.10 r_ctsu (Capacitive Touch Sensing Unit) Description

r_CTSU, sf_touch_ctsu, sf_touch_ctsu_buttons, sf_touch_ctsu_slider tests are conducted on DK-S3A7, DK-S124 and SK-S7G2 which are not designed for optimal CTSU operation and thus the test results may not be replicable.

Applies to: DK-S3A7, DK-S124 and SK-S7G2

10.11 r_dtc (Data Transfer Controller) Description

DTC_CFG_VECTOR_TABLE_SECTION_NAME and DTC_CFG_SOFTWARE_START_ENABLE are not configurable in the Synergy Configuration tool.

Workaround: To use ELC software events to start a DTC transfer in software, define DTC_CFG_SOFTWARE_START_ENABLE=1 on the command line.

Workaround: To place the vector table in a user named section:

1. Add this in the preprocessor defines: DTC_CFG_VECTOR_TABLE_SECTION_NAME='(".my_dtc_section")' Replace .my_dtc_section with the name of the section to place the DTC vector table in.

2. Remove the ${SECURE_BUILD_COMMAND} for r_dtc.c only (unfortunately, the secure builder seems to be stripping the quotation marks):

a. Right-click r_dtc.c and go to Properties.

b. Under Command Line Pattern, delete ${SECURE_BUILD_COMMAND}.

Applies to: All S7G2, S3A7, S124, S5D9 boards

10.12 r_gpt (General Purpose Timer) Description

The callback event field in the callback arguments is not initialized.

Workaround: Assume the callback event is TIMER_EVENT_EXPIRED. This is the only valid callback event for the timer API.



R11UT0004EU0101 Rev.1.01 Page 25 of 40

10.13 r_gpt_input_capture (General Input Capture) Description

Only GTIOCA can be used as a capture source by the GPT input capture module. GTIOCB cannot be used as a capture source.

Workaround: Use GTIOCA for the capture source.

Applies to: All S7G2, S3A7, S124 S5D9 boards

10.14 r_ioport (General Purpose I/O Ports) Description

IOPORT R_IOPORT_Init does not check pointer p_pin_cfg_data for NULL.

System may crash if pointer is NULL.

Workaround: Call R_IOPORT_Init with properly initialized p_pin_cfg_data.


10.15 r_qspi (Quad Serial Peripheral Interface) Description

The existing sectorErase() function available in the QSPI Interface does not provide adequate information to the user about the size of the erase being performed.

Workaround: A new function, erase(), has been added to the QSPI Interface which allows the user to specify the erase size. The size specified must match an erase size supported by the QSPI chip. Available erase sizes can be determined using the infoGet() function.

Applies to: DK-S7G2, SK-S7G2, ASK-S5D9, DK-S5D9, DK-S3A7, PE-HMI1

10.16 r_rspi (Serial Peripheral Interface) Description

In SPI slave mode operation, when using CPHA=0 configuration, the master receives incorrect data in some cases. It is recommended to use CPHA=1 configuration for SPI slave mode operations.

Workaround: The work around is to use CPHA=1 configuration for slave applications.


Description

If a bus error occurs and the SPI driver is configured to use callbacks to notify the user, the application might become unstable or result in a crash.

Workaround: Driver can be configured to use without callbacks. In that case the read and write will becoming blocking operation.

Applies to: All MCU

Description

When transferring a set of data, there is a gap in the clock between each set of data transfers. This is observed in both DTC and CPU transfer modes.

Workaround: There is no workaround for this.


10.17 r_sce (Crypto Library) Description

Cryptographic functions are not thread safe.

Workaround: User code will need to use mutex resources around cryptographic function calls.



R11UT0004EU0101 Rev.1.01 Page 26 of 40

10.18 r_sci_i2c (Serial Communication Interface I2C) Description

The I2C clock has a positive error which could result in a frequency higher than that defined by the standard. This might result in loss of communication with low speed slave devices.

Workaround: None


Description

When using S7G2 MCUs, if the PCLKA is chosen to have a frequency other than 120 MHz, the resultant I2C clock will have higher error rate.

Workaround: Set Clock frequency of PCLKA to 120MHz if possible.


Description

The SCI I2C driver generates a too-short clock pulse between ACK and STOP signal. This may interrupt communication with certain very sensitive I2C devices.

Workaround: Add a short software delay before issuing the stop condition in the driver.


10.19 r_sci_spi (Serial Communication Interface SPI) Description

SCI SPI with DTC generates receive overrun error for continues write only operations. It is recommended to not use DTC in the applications using SCI SPI that performs continuous write operation and no read operations.

Workaround: The work around is to avoid using DTC for the applications using write only operations and not performing any read operation.


Description

If a bus error occurs and the SPI driver is configured to use callbacks to notify the user, the application might become unstable or result in crash.

Workaround: Driver can be configured to used without callbacks, however doing so will make the read and write blocking operations.

Applies to: All Synergy MCU

Description

Current version of SSP doesn't support slave mode in the SCI SPI driver.

Workaround: The workaround is to use the other SPI peripheral that supports slave mode, SPI (r_rspi) driver in the current SSP supports slave mode.

Applies to: All Synergy MCU

10.20 r_sci_uart (Serial Communication Interface UART) Description

In the applications using UART with DTC, receive data will be available in the user buffer, data will not be available in the callback argument p_args->data.

Workaround: The workaround is to read the data from the user buffer, do not read from the p_args->data



R11UT0004EU0101 Rev.1.01 Page 27 of 40

10.21 r_sdmmc (SDHI driver for SDIO and SD/MMC memory devices) Description

MMC cards do not work with the SDMMC driver. The SDMMC driver does work with SD cards or eMMC devices with no issues.

Workaround: Use SD cards instead of MMC cards.

Applies to: All S3A7 and S7G2 boards

10.22 sf_audio_playback (Audio Playback) Description

In Audio_playback, stopping the audio play in the middle and starting again with new audio data will result in playback failure.

Workaround: Call pause and wait for the current buffer to finish playing before calling stop.

Applies to: All MCU

10.23 sf_el_nx (Synergy NetX Interface) Description

Timer callbacks in nx_hw_init.c takes too long polling PHY for PHY status under interrupt lock out. Total interrupt lock-out time was measured to be 500,000 cycles when both Ethernet controllers are active. Any application using Ethernet is affected by this issue.

Workaround: None.



After calling close, then calling open again for sf_el_nx_comms, the Telnet server connection times out.

Workaround: Do not call close() for sf_el_nx_comms.

Applies to: DK-S7G2, DK-S5D9

Description

The sf_el_nx_comms module does not support dual Ethernet connections.

Workaround: Use the NetX Telnet APIs instead of sf_el_nx_comms.


10.25 sf_el_ux (Synergy USBX Interface) Description

USBX Host HID Class is not supported yet in this release. There is a known issue that USB communication with HID devices such as Keyboards or Mice running at low speed is unstable.

Workaround: None

Applies to: All S7G2, S5D9 and S3A7 boards

Description

There is a bug found in _ux_hcd_synergy_control_td_add(). The USB Host Control Driver could set the wrong device addresses if a device is connected via a USB Hub.

Workaround: None. Do not connect USB device via a USB Hub.


Description

USBX Host Controller Driver (HCD) fails to configure PIPEs for bulk-transfer after several times of USB device insertion and removal are made. This is because ux_hcd_synergy_bulk_endpoint_create() increases ux_synergy_next_available_bufnum in the USBX HCD control block when a USB device is inserted, but it is not


R11UT0004EU0101 Rev.1.01 Page 28 of 40

decreased when removed. Due to this issue, in case of Mass Host Storage Class where UX_SYNEGY_MAX_BULK_PAYLOAD is set to 512, a USB flash drive can be re-inserted 7 times successfully but fails after that. If UX_SYNEGY_MAX_BULK_PAYLOAD is set to larger than 512, the available re-insertion time will be decreased.

Workaround: None

Applies to: DK-S7G2, SK-S7G2, PE-HMI1, DK-S5D9, DK-S3A7, DK-S124

Description

DTC support is not yet available for USBX Synergy Interface through Synergy Configuration. Although the transfer driver on r_dtc is selectable in the Synergy Configuration tool, do not select the component.

Workaround: For non S1 parts: Use DMAC instead or use CPU copy.

For S1 parts: Use CPU copy.


Description

A constraint is missing for the Interrupt Priority setting of USB peripheral in the USBX Port HCD|DCD on sf_el_ux component. The invalid setting should be notified to users by Synergy Configuration tool to avoid the mistake. The DMA interrupt priority has to be always higher than USB's, else the USBX Port driver does not work as expected.

Workaround: Set the DMA interrupt priority higher than USB.

Applies to: All the Synergy Parts

Description

[DEPRECATED] USB Port component in Synergy Configuration does not work. User projects would be built but do not run correctly on the target because the USB Interrupt priority level is set to 255, which is not valid for the hardware. The interrupt itself fires but hardware runs very slowly and USB enumeration fails.

Workaround (1):

1. Add a component named [DEPRICATED] USBX Port HS and FS on sf_el_gx ... > Framework > USB > [DEPRICATED] USBX Port HS and FS on sf_el_gx.

2, Set "Full Speed Interrupt Priority" or "High Speed Interrupt Priority" to appropriate level (such as 3 for CM-4 parts).

3. Define following macro(s) to Cross ARM C Compiler Preprocessor setting.

- "SF_EL_UX_DCD_CFG_FS_IRQ_IPL=N" to use USBFS in Device mode (where, N = IPL value).

- "SF_EL_UX_DCD_CFG_HS_IRQ_IPL=N" to use USBHS in Device mode.

- "SF_EL_UX_HCD_CFG_FS_IRQ_IPL=N" to use USBFS in Host mode.

- "SF_EL_UX_HCD_CFG_HS_IRQ_IPL=N" to use USBHS in Host mode.

4. Define following macros to Cross ARM C Compiler Preprocessor setting.

- "SF_EL_UX_DCD_FS_CFG_H_" to use USB Device at FS mode.

- "SF_EL_UX_DCD_HS_CFG_H_" to use USB Device at HS mode.

- "SF_EL_UX_HCD_FS_CFG_H_" to use USB Host at FS mode.

- "SF_EL_UX_HCD_HS_CFG_H_" to use USB Host at HS mode.

Workaround (2): Use the USBX stack configuration instead of using [DEPRICATED] USBX relevant components. The USBX stack configuration is newly introduced in SSP1.2.0-b.1. Some application code upgrade is required. Check the detail in SSP user's manual, User Guides > Framework Layer > Express Logic USBX section.

Applies to: All S7G2, S3A7, S124 and S5D9 boards

Description

The Synergy Configuration tool may crash if the upgrade of the pincfg file fails and sf_el_ux is in the project. If this happens, recreate the pincfg file.



R11UT0004EU0101 Rev.1.01 Page 29 of 40

Description

The USBX Host Mass Storage, File-write at HS mode does not work if the configuration property "FIFO size for Bulk Pipes" of the "USBX Port HCD on sf-el_ux for USBHS" component is set to either of 1024 bytes, 1536 bytes or 2048 bytes in the Synergy Configuration tool. The configuration does not work for File-write but File-read works fine with any settings. The issue is because of the illegal hardware configuration being made for a USB Bulk-Out PIPE, so the USBX Host CDC-ACM, Data-write also does not work if the configuration property is changed from the default value (512 bytes).

Workaround: Do not change the configuration property "FIFO size for Bulk Pipes" of the "USBX Port HCD on sf-el_ux for USBHS" component from the default value (512bytes).


Description

USB VBUS pin could be wrongly controlled to Active Low even though the "VBUSEN pin Signal Logic" property of USBX Port HCD on sf_el_ux for USBxS component is configures to "Active High".

Workaround:

If your project uses USBX Port HCD on sf_el_ux for USBHS component:

Add X-ware > USBX > Host > Synergy Port > USBX Port HCD on sf_el_ux for USBFS and check the "VBUSEN pin Signal Logic" property. It should be configured to "Active Low". Change the configuration to "Active High". Save the configuration and delete the component. The configuration will not be visible in the graphical view once the component is deleted but the configuration will be recorded in the configuration.xml and still valid for your project. To output logic High on the VBUSEN pin, both of components needs to configure the property to "Active High" in this version.

If your project uses USBX Port HCD on sf_el_ux for USBFS component:

Add X-ware > USBX > Host > Synergy Port > USBX Port HCD on sf_el_ux for USBHS and check the "VBUSEN pin Signal Logic" property. It should be configured to "Active Low". Change the configuration to "Active High". Save the configuration and delete the component.

If your project uses both of USBX Port HCD on sf_el_ux for USBHS and USBX Port HCD on sf_el_ux for USBFS components:

Same configuration is allowed to be set to both of USBHS and USBFS in this version. There is no workaround if your target board needed different VBUS control logic for USB controllers.

Applies to: S7G2 or S5D9

10.26 sf_message (Messaging Framework) Description

Messaging framework may not work if the size of message queue is set to more than 1 word (4 bytes). The issue is under investigation at the time of this version of SSP release.

Workaround: None, use the framework with setting the size of (each) message to 1 word. Messaging Configurator on e2 studio forces the size to set to 1 to minimize the memory requirement and optimize the performance.


10.27 tx (ThreadX) Description

ThreadX Source for CM0+ parts may end up in the default handler. The issue is under investigation.

Workaround: If you observed unintentional behavior relevant to ThreadX, use the prebuilt library as possible workaround.

Applies to: DK-S124 (CMO + core parts)

Description

Code will hard fault if the CM0+ ThreadX source is used on GCC with no optimization.

Workaround: If ThreadX source is used, apply -O2 optimization to tx_thread_schedule.c.



R11UT0004EU0101 Rev.1.01 Page 30 of 40

10.28 tx_src (ThreadX Source) Description

The file tx_port.h was editable in SSP1.1.0-alpha.1 releases but SSP1.1.0 or later, the file is no longer editable because it is overwritten by Synergy builder and any edits in the file will be gone. Build-time options in tx_port.h are configured through Synergy Configurator. Use the Properties in the ThreadX Source (tx_src) module to change the build-time options in tx_port.h. Note that your changed configurations are outputted to tx_src_user.h in \synergy_cfg\framework\el\ directory.

Workaround: Do not edit tx_port.h directly but use Synergy Configurator to change the ThreadX build-time options.


10.29 ux (USBX) Description

USB device macros cause build errors when both source and libs are used in the same project.

To avoid this, if you use ux_src then after Generate Project Content, remove ux from the list of libraries in the Cross ARM C Linker > Libraries section of the C/C++ Build > Settings in the project Properties. Also, define UX_SYSTEM_HOST *_ux_system_host; somewhere in the application.

Workaround: After Generate Project Content, remove ux from the list of libraries in the Cross ARM C Linker > Libraries section of the C/C++ Build > Settings in the project Properties. Also, define UX_SYSTEM_HOST *_ux_system_host; somewhere in the application.


Description

USBX Device RNDIS Class is yet tested so it may not work.

Workaround: Not applicable.


10.30 ux_host_class_hid (USBX Host Storage HID) Description

When the Synergy MCU is running as HID Host, it cannot drive low-speed devices properly, such as USB Keyboards or mice. Customers cannot use HID keyboards or mice on Synergy USB Host ports.

Workaround: None


10.31 ux_host_class_prolific (USBX Host Prolific Class) Description

USBX Host Prolific Class is not tested yet so it may not work.

Workaround: None.


10.32 ux_network_driver (USBX Network Driver) Description

Public header files for USBX Device RNDIS Class and USBX Network Driver are not stored in SSP public header file directory for X-Ware \synergy\ssp\omc\framework\el\ so user application would not build with such USBX components. RNDIS and USBX Network Driver are in SSP but still experimental modules. They are not tested, not supported so modules may not work.

Workaround: Add ux_device_class_rndis_src or ux_network_driver_src module to your project through Synergy Configurator Components tab. Use populated header files and move them to path\synergy\ssp\omc\framework\el\ to make them compile, or add file include path settings to the compiler include path setting in your e2 studio project property.


R11UT0004EU0101 Rev.1.01 Page 31 of 40

Note that USBX Device RNDIS Class and USBX Network Driver are experimental modules and not yet tested so they may not work.


Description

USBX Network Driver is yet tested so it may not work.

Workaround: Not applicable.


11. New issues and limitations in SSP v1.2.0-b.1 release This section describes the new issues in SSP v1.2.0-b.1 that fall under either one of the following categories:

1. Limitations in new features and enhancements that have been added in this release

2. Bugs in new feature and enhancements that have been added in this release

3. Regressions to features previously delivered in SSP v1.1.3 prior releases

11.1 Issues Common to all of SSP modules (generic): Description

Developer examples are not tested with 1.2.0-b.1. They are not supported in this release.

Applies to: N/A

11.2 Limitations connecting to boards • If you connect to a board without factory flash (pre-production parts might not include factory flash), you need to

enable the custom factory flash. If you need to enable custom factory flash:

o In the Threads tab, select HAL/Common.

o Click the g_fmi module.

o Make sure you are in the Synergy Configuration perspective (you should be by default after creating a project). You can switch perspectives in the upper right corner of e2 studio.

o Click the ‘Properties’ window in the lower left.

o Click the ‘Settings’ tab in the ‘Properties’ window.

o Change ‘Use Custom Factory Flash’ to ‘Enabled’.

o Open the file <project_name>/synergy/ssp/src/bsp/mcu/<mcu>/bsp_fmi_<part_number>.c.

o At the top of the file, you should see ‘#ifdef BSP_MCU_<PART_NUMBER>’. Copy the part after #ifdef (copy BSP_MCU_<PART_NUMBER>).

o Highlight the project directory and press Alt + T to open the toolchain settings.

o Under Cross ARM C Compiler > Preprocessor, click the ‘+’ to add a build time macro. Paste the BSP_MCU_<PART_NUMBER> you copied earlier.

o Click Apply and close out of all the windows.

11.3 C++ support Description

“Blinky” and “Blinky with Threadx” project templates cannot be used with C++ projects, as they will create an additional .c entry file during build process and builds using C compiler.

Workaround: None.


Description


R11UT0004EU0101 Rev.1.01 Page 32 of 40

In the current SSP code for C++, static constructor for C++ is not added by default, user needs to add this in the application code. This will be added as part of the SSP code in the next version. See the SSP User’s Manual to find out about how to add the static constructor in the applications.

Workaround: The workaround is to add the static constructor in the application code as mentioned in the SSP users manual.


11.4 GCC ARM Embedded Toolchain Description When using the GCC ARM Embedded Toolchain and if the user tries to shift the application location in flash in the linker script, the global variables within the linker script will not be correct. The user may do this if they are adding a bootloader to their system, creating an application image to be used by a bootloader. The declaration of vector information size symbols from linker are not correct since the calculation is within a linker section declaration. The calculations have to be outside of the linker section declaration.

For example, calculations such as the following must be outside the ".text" section description in the GCC linker script. __Vectors_Size = __Vectors_End - __Vectors;



JPEG hardware rendering may cause system crash when rendering a raw JPEG data. This issue was resolved and partially tested.

Workaround: If you noticed this issue, use 'Compress Output' instead of 'Raw Format' by selecting the Output Format option in GUIX Studio.


Description

Screen transition could happen on the visible side frame buffer when GUIX updates screen, although frame buffers are controlled to toggle right after the GUIX rendering completed on the working side frame buffer. The issue could happen if 2D Drawing engine is enabled and screen is rotated 90 or 270 degree. This issue was resolved and partially tested.

Workaround: None.


11.6 fx (FileX) Description

The FileX service call fx_file_write() could cause the hard-fault error because of a bad pointer happening when its trying to call a file_write_notify user callback function, which to be registered by fx_file_write_notify_set().

Workaround: Clear a FX_FILE structure (to set NULL to .fx_file_write_notify) in your application code before calling fx_file_open().


Description

fx_file_write_notify_set() (New API introduced in v5.4) is not usable since it causes the build error (there is a wrong macro definition at the line#1162 in fx_api.h).

Workaround: None.


11.7 nx (NetX (HTTP, DNS, DHCP, FTP, TFTP, Telnet)) Description

In this beta release, PPP and BSD are partially tested.

Workaround: Not Applicable


R11UT0004EU0101 Rev.1.01 Page 33 of 40


Description

POP3 and BSD applications of NetX have been partially tested in this release.

Workaround: None

11.8 nx_http_server (NetX HTTP Server) Description

USBX Host Mass Storage Class (MSC) and NetX HTTP Server cannot be used together. If they are, it results in a compile error with regard to a missing symbol for FileX Media control block (FX_MEDIA * type pointer variable). The auto-generated code for NetX HTTP Server requires a pointer to a FileX Media control block, which is for USBX flash drive. On the other hand, the auto-generated code for USBX Host MSC does not provide the pointer to FileX Media control block so NetX HTTP Server misses the symbol.

Workaround: Do not use USB Mass Storage Class for the media device to store a HTTP page. Use SD/MMC storage instead.


11.9 nx_pop3 (Applications Bundle - pop3 Client) Description

If using NetX POP3 in the Synergy Configurator then the user is likely to get an error when the nx_pop3_client_create() function is called in the generated code. This is because the nx_pop3_client_create() requires the NetX IP link to be initialized and ready to transmit. The IP instance would not be ready, for example, if DHCP was being used to obtain an IP address. The user can work around this by defining the error callback function that is called when an error from the nx_pop3_client_create() function is detected. The default function is a weak function that can be overridden.

Workaround: When the error from nx_pop3_client_create() is encountered, an error callback function is invoked. This callback is a weak function that the user can override. If the user wants, they can override this function in a fashion such that it handles the error and prevent the user application from stalling.


11.10 nxd (NetX Duo) Description

NetX Duo 5.9 does not compile when TraceX is enabled.

Workaround: Do not use TraceX if NetX Duo 5.9 is used.


11.11 r_dtc (Data Transfer Controller) Description

DTC data transfer fails if num_transfers is set to greater than one and given to the blockReset API. blockReset does not support the repeat mode in this release.

Workaround: None. Do not set a number greater than 1 to num_transfers if using the blockReset API.

Applies to: All S7G2, S3A7, S124, S5D9 boards

11.12 r_flash_lp (Flash Memory, Low Power) Description

When using Flash LP with Code Flash programming enabled: If accessWindowSet() is called before any other Flash operation for Code Flash (program, erase or blankcheck), the function will wrongly return SSP_ERR_INVALID_ADDRESS. Similarly if the operation just prior to the accessWindowSet() call was an operation for Data Flash, the function will wrongly return SSP_ERR_INVALID_ADDRESS.

Workaround: Always precede a call to accesswindowSet() with a call to an erase, blankcheck, or write function for any Code Flash address.


R11UT0004EU0101 Rev.1.01 Page 34 of 40

Example: err = p_flash_ptr->blankCheck(&ctrl, FLASH_CF_BLOCK_NEXT_TO_LAST, 4, &blank_check_result); err = p_flash_ptr->accessWindowSet(&ctrl, FLASH_CF_BLOCK_NEXT_TO_LAST, FLASH_CF_BLOCK_LAST);.

Applies to: S3A7, S124

Description

On Flash LP parts with 1-MB Code Flash and/or 16-KB Data Flash a Blankcheck spanning the midpoint memory boundary may return inaccurate results, possibly reflecting the Blank status of only part of the requested range.

Some Data Flash examples that meet this criteria:

• blankCheck(&ctrl, 0x40100000, 0x4000, &blank_check_result)

• blankCheck(&ctrl, 0x40101F00, 0x200, &blank_check_result)

Some Code Flash examples that meet this criteria:

• blankCheck(&ctrl, 0, 0x90000, &blank_check_result)


Workaround: To insure accurate results do not issue a singular Blank Check function whose range spans the midpoint of the Code or Data Flash memory. Instead break the request into two separate Blankcheck requests, one up to, but not crossing the midpoint, and a second Blankcheck making up the difference.

Using the examples above and breaking the operation into two separate operations, the operations would look like the following:

Workaround Data Flash examples:



• blankCheck(&ctrl, 0x40101F00, 0x100, &blank_check_result)

• blankCheck(&ctrl, 0x40102000, 0x100, &blank_check_result).

Example: err = p_flash_ptr->blankCheck(&ctrl, FLASH_CF_BLOCK_NEXT_TO_LAST, 4, &blank_check_result); err = p_flash_ptr->accessWindowSet(&ctrl, FLASH_CF_BLOCK_NEXT_TO_LAST, FLASH_CF_BLOCK_LAST);

Applies to: S3A7, S124

11.13 r_riic_slave (IIC) Description

In Slave Write API, corner cases are not covered which causes locking the bus in master.

The masterReadSlaveWrite API in r_riic_slave module, the driver will lock up the IIC bus for the following corner cases.

1. Master is reading ‘M’ bytes and Slave has ‘N’ bytes available to write. In this case (M < N) or (M > N).

2. Master and Slave both writing to bus at same time.

3. Master and Slave both reading from bus at same time.

The above mentioned corner cases are not covered in the current RIIC Slave Driver. The driver will lock up the IIC bus for these corner cases.


Description


R11UT0004EU0101 Rev.1.01 Page 35 of 40

Slave Read will not work when master writes less number of bytes then slave requested, causing deviation from expected protocol behavior.

Workaround: The number or bytes of transaction between the master write and slave read should be configured to be equal.

Applies to: All MCU

11.14 r_sci_uart (Serial Communication Interface UART) Description

The r_sci_uart module transmits incorrect data when channels that do not have a FIFO are used.

Applies to: S124 (channels 1 and 9)

Description

UART transmission does not work properly on non-FIFO only channels (channels 1 and 9) on S124 devices. An extra byte will be transferred during transmission. This issue will be fixed in the next SSP release.

Workaround:

Use channels which support FIFO channels instead of non-FIFO channels(1 and 9).


Description

UART communication protocol doesn't work properly on non FIFO channels.

Workaround: Use a UART channel with a FIFO.

Applies to: DK-S124

11.15 r_sdmmc (SDHI driver for SDIO and SD/MMC memory devices) Description

The SDMMC infoGet function does not provide information for: p_info->bus_width p_info->hs_timing p_info->device_type p_info->sdio

Workaround: The customer can read the correct information by reading from p_ctrl as follows: p_ctrl->bus_width p_ctrl->hs_timing p_ctrl->device_type p_ctrl->sdio . Applies to: All S3A7 and S7G2 boards

Description

For SD cards or eMMC the default block size is set to 512, no other block size is supported in this version. Also the read or write buffers must be at word (32-bit) boundaries.

Workaround: The work around is to use only 512 byte block size while configuring r_sdmmc driver module.

Applies to: All S3A7 and S7G2 boards

Description

For S3A7, the SD or eMMC media may or may not work, or may exhibit errors at a PCLKA speed greater than 32 MHz.

Workaround: Select a divisor that will lower PCLKA to 32 MHz or below. This clock will be divided by no less than 2, making the SDClock run at 16 MHz or less. Applies to: S3A7

11.16 r_slcdc (Segment LCD Controller) Description


R11UT0004EU0101 Rev.1.01 Page 36 of 40

This feature worked in Release 1.1.3. Subsequent architectural changes in SSP have rendered it non-working in this Release.

Workaround: Workaround for this issue is to save the Segment LCDC module driver outside of SSP directory and change the LCD register base address value as mentioned below.

1. Use the Synergy Configurator in the e2 studio ISDE to instantiate the SLCDC Module in your Synergy project.

2. Generate the project content.

3. Copy the SLCDC module’s source files to a directory outside of the directories used for Synergy code. Synergy directories are overwritten on every build. The recommended directory in which to place your custom Module is the top level src folder, which is at the same level as the synergy folder in the Project Explorer view in the e2 studio.

4. Open r_slcdc.c file from the copied r_slcdc folder, go to R_SLCDC_Open function line#160

5. Comment the line where p_ctrl->p_reg get address from info.ptr and assign the correct address value as shown below.

/* Comment this line as FMI address for SLCDC is not correct */

//p_ctrl->p_reg = (R_LCD_Type *) info.ptr;

/* Add this line with correct SLCDC register base address */

p_ctrl->p_reg = (R_LCD_Type *)0x40082000;

6. In the Synergy Project, exclude r_slcdc module from the build to avoid duplicated source (Right click on r_slcdc folder and “Exclude from build..”).

7. Build the project

For more details of how to customize an SSP module, please refer the Application Note titled "Customizing an SSP Module" available on Renesas.com site, along with many other Application Notes:

https://www.renesas.com/en-us/search/keyword-search.html#genre=document&productlayer=188814&productlayer=188815&productlayer=188816&productlayer=188817&productlayer=188819&productlayer=188820&productlayer=188821&productlayer=188822&documenttype=11&documenttype=232

Applies to: S3A7

11.17 r_ssi (Serial Sound Interface or r_i2s) Description

The DTC cannot be used on SSI channel 1 because the activation source calculation is incorrect.


Description

WS continue mode cannot be turned off for SSI on S5D9 MCUs. This means that the word select line is continuously output from the time the driver is opened until the driver is closed. If WS continue mode is Off in the Synergy Configuration tool, the driver ignores this setting and turns WS continue mode on.

Workaround: The workaround is built into the driver. There is no way to turn off WS continue mode on S3A3 or S5D9 MCUs.

Applies to: S5D9 MCU

11.18 sf_audio_playback (Audio Playback) Description

Calling sf_audio_playback start after calling sf_audio_playback stop during playback fails.

Workaround: Call pause and wait for the current buffer to finish playing before calling stop.


Description






R11UT0004EU0101 Rev.1.01 Page 37 of 40

When using mixing in sf_audio_playback and not using software volume control, shifting, or scaling, audio playback is incorrect (samples are not played in the correct order).

Workaround: Apply software volume control of 254 or less when mixing samples for output hardware with signed 16-bit data type (for example, I2S).


Description

sf_audio_playback stop() stops all streams in the system instead of just the stream stop() is called for. It will stop streams that are not intended to be stopped if multiple streams are playing at once.

Workaround: None.


11.19 sf_console (Console) Description

SF_EL_UX_Comms or SF_Console XML always execute the Open API call in the auto-generated code but it does not always work. The modules requires a USB host connected before the API call to make the open processing successfully, else the API returns an error because of USB CDC-ACM instance not being ready.

Workaround: Customers can override the error function e.g. g_sf_console0_err_callback by implementing in their application code so that they can know the open function failed in the auto-generated code.

Applies to: All the Synergy parts.

11.20 sf_el_gx (GUIX Synergy Port) Description

JPEG hardware rendering may cause system crash when rendering a raw JPEG data. The issue is now under investigation.

Workaround: If you noticed this issue, use 'Compress Output' instead of 'Raw Format' by selecting the Output Format option in GUIX Studio.


Description

Regardless of "Synergy JPEG support" property setting (enabled or disabled) of GUIX on gx component in Synergy Configurator, the module allocates JPEG work buffer with the size specified to "Size of JPEG Work Buffer" property of GUIX Port on sf_el_gx component.

Workaround: Set "Size of JPEG Work Buffer" property of GUIX Port on sf_el_gx component to '1' if not using JPEG hardware acceleration.

Applies to: All S7G2 and S5D9 boards

Description

Screen transition could happen on the visible side frame buffer when GUIX updates screen, although frame buffers are controlled to toggle right after the GUIX rendering completed on the working side frame buffer. The issue could happen if 2D Drawing engine is enabled and screen is rotated 90 or 270 degree. The issue is currently under investigation.

Workaround: None.


11.21 sf_el_nx (Synergy NetX Interface) Description

There is an implementation of the user callback support for the run-time Ethernet MAC address configuration but the feature is currently not available through the Synergy Configuration tool.

Workaround: Any users who have to configure the Ethernet MAC address at run-time can take the following workaround to use the feature.


R11UT0004EU0101 Rev.1.01 Page 38 of 40

1. Set the name of your callback function to the "Callback" property in the NetX Port ETHER on sf_el_nx component properties in the Synergy Configuration tool.

2. Generate Project Content.

3. Open common_data.c in your project.

4. Find the following step (the example below uses channel1): VOID (*g_sf_el_nx)(NX_IP_DRIVER * driver_req_ptr) = nx_ether_driver_eth1;

5. Modify it to the following: VOID (*g_sf_el_nx)(NX_IP_DRIVER * driver_req_ptr) = nx_ether_driver_wrapper1;

6. Change the file attribute of common_data.c to "Read-only" to prevent the file being updated by the Synergy Configuration tool.

Note 1: If you need to update any configuration in the Synergy Configuration tool, you need to change the file attribute of common_data and need to do the step 3 ~ 6 described above once you finish the configuration updates.

Note 2: The implementation of run-time MAC address feature is a subject to change. Notice the release note in a future SSP release for the possible change.



Communications Framework on sf_el_nx_comms component stacks two NetX Port ETHER on sf_el_nx components incorrectly. Users should only add the component to the position under NetX on nx. Do not add another component to the position under sf_el_nx_comms module. Otherwise the project could experience a build error.

Workaround: Add only one NetX Port ETHER on sf_el_nx component.


11.23 sf_el_ux_comms (Synergy USBX Communication Interface) Description

The close API is not functional and should not be used. The USBX communications framework can only be configured once. There is no workaround at this time. The configuration parameters passed into open and the descriptors defined in sf_el_ux_comms_port.h are permanent and cannot be updated at runtime after open is called.

Workaround: None. Calling close() for sf_el_ux_comms has no effect.

Applies to: All S7G2, S3A7, S124 and S5D9 boards

Description

Hardcoded "g_sf_comms0_instance_ctrl" is used in the XML generated code so only one instance (one COM channel) and default given name is available to use.

Workaround:

1. Use given name by default.

2. Change the name of instance(s) in auto-generated code by hand if more than two instances are used. To avoid your edit overwritten by e2 studio, the attribute of source file should be changed to be read-only.

Applies to: DK-S7G2, SK-S7G2, PE-HMI1, DK-S5D9, SK-S3A7, DK-S124

Description

SF_EL_UX_Comms or SF_Console XML always execute the Open API call in the auto-generated code but it does not always work. The modules requires a USB host connected before the API call to make the open processing successfully, else the API returns an error because of USB CDC-ACM instance not being ready.

Workaround: Customers can override the error function e.g. g_sf_console0_err_callback by implementing in their application code so that they can know the open function failed in the auto-generated code.

Applies to: All the Synergy parts.


R11UT0004EU0101 Rev.1.01 Page 39 of 40

11.24 sf_i2c (I2C Framework) Description

If multiple I2C devices are connected on a single bus and use I2C framework with SCI I2C as lower level driver, reconfiguration of the bus while switching from one device to another resets the I2C bus. This may interrupt the communication with some slave devices.

Workaround: Comment out the function HW_SCI_RegisterReset() from the sci_siic_open_hw_master() function.


Description Applications using multiple devices connected on the same channel need to define following macro in the pre-processor settings of your project, otherwise the project may not build correctly. SSP_SUPPRESS_ISR_<device_name> where "device_name" is the name of the additional device connected to the same channel. For example if three I2C devices g_i2c0, g_i2c1 and g_i2c2 are connected on a same channel, then define following two macros in the project pre-processor settings. #define SSP_SUPPRESS_ISR_g_i2c1 #define SSP_SUPPRESS_ISR_g_i2c2.

Workaround: Define "SSP_SUPPRESS_ISR_<module name> in the processor settings or in common header file as mentioned in the description.


11.25 sf_spi (SPI Framework) Description Applications using multiple devices connected on the same channel need to define the following macro in the pre-processor settings of your project. Otherwise the project may not build correctly.

SSP_SUPPRESS_ISR_<device_name> where "device_name" is the name of the additional device connected to the same channel. For example if three SPI devices g_spi0, g_spi1 and g_spi2 are connected on a same channel, then define following two macros in the project pre-processor settings. #define SSP_SUPPRESS_ISR_g_spi1 #define SSP_SUPPRESS_ISR_g_spi2.

Workaround: Define "SSP_SUPPRESS_ISR_<module name> in the processor settings or in common header file as mentioned in the description.


12. Additional Technical Notices Subscribe to the Synergy Technical Bulletin Board to receive the latest technical news and notifications about new features, known issues, workarounds, and release announcements. To subscribe, visit http://renesasrulz.com/synergy/synergy_tech_notes/f/214.aspx. Sign in to Renesas Rulz, and press ‘Email Subscribe to this forum’.

Additional technical information, including informative papers and articles on SSP and Synergy can be found at Synergy Knowledge Base, https://en-us.knowledgebase.renesas.com/English_Content/Renesas_Synergy%E2%84%A2_Platform

http://renesasrulz.com/synergy/synergy_tech_notes/f/214.aspx

https://en-us.knowledgebase.renesas.com/English_Content/Renesas_Synergy%E2%84%A2_Platform


R11UT0004EU0101 Rev.1.01 Page 40 of 40

Website and Support Support: https://synergygallery.renesas.com/support

Technical Contact Details:

America: https://renesas.zendesk.com/anonymous_requests/new

Europe: http://www.renesas.eu/support/index.jsp

Japan: http://japan.renesas.com/contact/index.jsp

All trademarks and registered trademarks are the property of their respective owners.

https://synergygallery.renesas.com/support

https://renesas.zendesk.com/anonymous_requests/new

http://www.renesas.eu/support/index.jsp

http://japan.renesas.com/contact/index.jsp

Notice1. Descriptions of circuits, software and other related information in this document are provided only to illustrate the operation of semiconductor products and application examples. You are fully responsible for

the incorporation of these circuits, software, and information in the design of your equipment. Renesas Electronics assumes no responsibility for any losses incurred by you or third parties arising from the use

of these circuits, software, or information.

2. Renesas Electronics has used reasonable care in preparing the information included in this document, but Renesas Electronics does not warrant that such information is error free. Renesas Electronics

assumes no liability whatsoever for any damages incurred by you resulting from errors in or omissions from the information included herein.

3. Renesas Electronics does not assume any liability for infringement of patents, copyrights, or other intellectual property rights of third parties by or arising from the use of Renesas Electronics products or

technical information described in this document. No license, express, implied or otherwise, is granted hereby under any patents, copyrights or other intellectual property rights of Renesas Electronics or

others.

4. You should not alter, modify, copy, or otherwise misappropriate any Renesas Electronics product, whether in whole or in part. Renesas Electronics assumes no responsibility for any losses incurred by you or

third parties arising from such alteration, modification, copy or otherwise misappropriation of Renesas Electronics product.

5. Renesas Electronics products are classified according to the following two quality grades: "Standard" and "High Quality". The recommended applications for each Renesas Electronics product depends on

the product's quality grade, as indicated below.

"Standard": Computers; office equipment; communications equipment; test and measurement equipment; audio and visual equipment; home electronic appliances; machine tools; personal electronic

equipment; and industrial robots etc.

"High Quality": Transportation equipment (automobiles, trains, ships, etc.); traffic control systems; anti-disaster systems; anti-crime systems; and safety equipment etc.

Renesas Electronics products are neither intended nor authorized for use in products or systems that may pose a direct threat to human life or bodily injury (artificial life support devices or systems, surgical

implantations etc.), or may cause serious property damages (nuclear reactor control systems, military equipment etc.). You must check the quality grade of each Renesas Electronics product before using it

in a particular application. You may not use any Renesas Electronics product for any application for which it is not intended. Renesas Electronics shall not be in any way liable for any damages or losses

incurred by you or third parties arising from the use of any Renesas Electronics product for which the product is not intended by Renesas Electronics.

6. You should use the Renesas Electronics products described in this document within the range specified by Renesas Electronics, especially with respect to the maximum rating, operating supply voltage

range, movement power voltage range, heat radiation characteristics, installation and other product characteristics. Renesas Electronics shall have no liability for malfunctions or damages arising out of the

use of Renesas Electronics products beyond such specified ranges.

7. Although Renesas Electronics endeavors to improve the quality and reliability of its products, semiconductor products have specific characteristics such as the occurrence of failure at a certain rate and

malfunctions under certain use conditions. Further, Renesas Electronics products are not subject to radiation resistance design. Please be sure to implement safety measures to guard them against the

possibility of physical injury, and injury or damage caused by fire in the event of the failure of a Renesas Electronics product, such as safety design for hardware and software including but not limited to

redundancy, fire control and malfunction prevention, appropriate treatment for aging degradation or any other appropriate measures. Because the evaluation of microcomputer software alone is very difficult,

please evaluate the safety of the final products or systems manufactured by you.

8. Please contact a Renesas Electronics sales office for details as to environmental matters such as the environmental compatibility of each Renesas Electronics product. Please use Renesas Electronics

products in compliance with all applicable laws and regulations that regulate the inclusion or use of controlled substances, including without limitation, the EU RoHS Directive. Renesas Electronics assumes

no liability for damages or losses occurring as a result of your noncompliance with applicable laws and regulations.

9. Renesas Electronics products and technology may not be used for or incorporated into any products or systems whose manufacture, use, or sale is prohibited under any applicable domestic or foreign laws or

regulations. You should not use Renesas Electronics products or technology described in this document for any purpose relating to military applications or use by the military, including but not limited to the

development of weapons of mass destruction. When exporting the Renesas Electronics products or technology described in this document, you should comply with the applicable export control laws and

regulations and follow the procedures required by such laws and regulations.

10. It is the responsibility of the buyer or distributor of Renesas Electronics products, who distributes, disposes of, or otherwise places the product with a third party, to notify such third party in advance of the

contents and conditions set forth in this document, Renesas Electronics assumes no responsibility for any losses incurred by you or third parties as a result of unauthorized use of Renesas Electronics

products.

11. This document may not be reproduced or duplicated in any form, in whole or in part, without prior written consent of Renesas Electronics.

12. Please contact a Renesas Electronics sales office if you have any questions regarding the information contained in this document or Renesas Electronics products, or if you have any other inquiries.

(Note 1) "Renesas Electronics" as used in this document means Renesas Electronics Corporation and also includes its majority-owned subsidiaries.

(Note 2) "Renesas Electronics product(s)" means any product developed or manufactured by or for Renesas Electronics.

http://www.renesas.comRefer to "http://www.renesas.com/" for the latest and detailed information.

Renesas Electronics America Inc.2801 Scott Boulevard Santa Clara, CA 95050-2549, U.S.A.Tel: +1-408-588-6000, Fax: +1-408-588-6130Renesas Electronics Canada Limited9251 Yonge Street, Suite 8309 Richmond Hill, Ontario Canada L4C 9T3Tel: +1-905-237-2004Renesas Electronics Europe LimitedDukes Meadow, Millboard Road, Bourne End, Buckinghamshire, SL8 5FH, U.KTel: +44-1628-585-100, Fax: +44-1628-585-900Renesas Electronics Europe GmbHArcadiastrasse 10, 40472 Düsseldorf, GermanyTel: +49-211-6503-0, Fax: +49-211-6503-1327Renesas Electronics (China) Co., Ltd.Room 1709, Quantum Plaza, No.27 ZhiChunLu Haidian District, Beijing 100191, P.R.ChinaTel: +86-10-8235-1155, Fax: +86-10-8235-7679Renesas Electronics (Shanghai) Co., Ltd.Unit 301, Tower A, Central Towers, 555 Langao Road, Putuo District, Shanghai, P. R. China 200333Tel: +86-21-2226-0888, Fax: +86-21-2226-0999Renesas Electronics Hong Kong LimitedUnit 1601-1611, 16/F., Tower 2, Grand Century Place, 193 Prince Edward Road West, Mongkok, Kowloon, Hong KongTel: +852-2265-6688, Fax: +852 2886-9022Renesas Electronics Taiwan Co., Ltd.13F, No. 363, Fu Shing North Road, Taipei 10543, TaiwanTel: +886-2-8175-9600, Fax: +886 2-8175-9670Renesas Electronics Singapore Pte. Ltd.80 Bendemeer Road, Unit #06-02 Hyflux Innovation Centre, Singapore 339949Tel: +65-6213-0200, Fax: +65-6213-0300Renesas Electronics Malaysia Sdn.Bhd.Unit 1207, Block B, Menara Amcorp, Amcorp Trade Centre, No. 18, Jln Persiaran Barat, 46050 Petaling Jaya, Selangor Darul Ehsan, MalaysiaTel: +60-3-7955-9390, Fax: +60-3-7955-9510Renesas Electronics India Pvt. Ltd.No.777C, 100 Feet Road, HALII Stage, Indiranagar, Bangalore, IndiaTel: +91-80-67208700, Fax: +91-80-67208777Renesas Electronics Korea Co., Ltd.12F., 234 Teheran-ro, Gangnam-Gu, Seoul, 135-080, KoreaTel: +82-2-558-3737, Fax: +82-2-558-5141

SALES OFFICES

© 2016 Renesas Electronics Corporation. All rights reserved.Colophon 5.0

http://www.renesas.com