Synergy Software Package (SSP) Release Notes · Synergy Software Packag e (SSP) Release Notes Revision 1.0 Page 2 of 28 1. Introduction This document describes the release notes for

Revision 1.0 Page 1 of 28

Synergy Software Package (SSP) Release Notes

Release Version 1.0.0-beta.3

12/15/2015

Table of Contents

1. Introduction ........................................................................................................................................ 2

2. Release Information ........................................................................................................................... 2

3. MCUs Supported ............................................................................................................................... 2

4. Compatible and Tested Tools (Software and Hardware Environment) ............................................. 2

5. Verification Status .............................................................................................................................. 2

6. Release Package and Installation Information .................................................................................. 3

7. Changes From v1.0.0-beta.1 to v1.0.0-beta.3 Release .................................................................... 3 7.1 New Features .................................................................................................................................... 3 7.2 Updated Features .............................................................................................................................. 4 7.3 Deprecated Features ......................................................................................................................... 5

8. Summary of Bug Fixes from v1.0.0-beta.1 to v1.0.0-beta.3 Release (Including fixes delivered in v1.0.0-beta.2 release) .......................................................................................................................... 5

9. Known Issues and Limitations in v1.0.0-beta.3 Release ................................................................. 11

10. Changes From v0.91.00C1 to v1.0.0-beta.1 Release ..................................................................... 16 10.1 New Features .................................................................................................................................. 16 10.2 Updated Features ............................................................................................................................ 19 10.3 Deprecated Features ....................................................................................................................... 22

11. Summary of Bug Fixes from v0.91.00C1 to v1.0.0-beta.1 Release ................................................ 23

12. Complete List of Modules available in this Release ........................................................................ 26

13. Customer Feedback ........................................................................................................................ 28



1. Introduction This document describes the release notes for SSP software release version 1.0.0-beta.3. SSP software was tested on the hardware platforms DK-S3A7, DK-S7G2 and PE-HMI1.

2. Release Information

SSP Release Version 1.0.0-beta.3

Release Date 15-Dec-2015

The following statements apply to this release:

• Intended audiences for this release are all customers and Renesas partners, internal developers, AEs, and FAEs.

3. MCUs Supported S7G2 series and S3A7 series

4. Compatible and Tested Tools (Software and Hardware Environment)

Tool Version Description

e2 studio 4.2.0.012 Software development and debugging tool

GNU ARM Compiler

eabi-4_8-2014q3-20140805-win32

GNU ARM® compiler gcc-arm-none-eabi-4_8-2014q3-20140805-win32. Please refer to section Known Issues and Limitations in v1.0.0-beta.3 Release.

IAR Compiler 7.40 Software development tool. Please refer to section Known Issues and Limitations in v1.0.0-beta.3 Release.

PE-HMI1 2.0

Product Example (PE) for Human Machine Interface to evaluate the Renesas SynergyTM S7G2 240 MHz ARM® Cortex®-M4 microcontroller. If you have an older version of this board please refer to section Known Issues and Limitations in v1.0.0-beta.3 Release.

DK-S7G2 3.0

Development Kit for Renesas SynergyTM S7G2, 240 MHz ARM® Cortex®-M4 microcontroller in a BGA224 package. If you have an older version of this board please refer to section Known Issues and Limitations in v1.0.0-beta.3 Release.

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

Debug Probe 5.x Segger J-Link™ debug probe is the quasi standard for ARM® Cortex®-M based MCUs.

5. Verification Status

Unit testing, functionality testing, integration testing and regression testing was performed for this release.



6. Release Package and Installation Information Before installing the SSP, ensure that the following items are installed on the PC:

• Renesas e2 studio ISDE v4.2.0.012 (download from Synergy Gallery) • GNU ARM Compiler (included in Renesas e2 studio ISDE v4.2.0.012 installer) • Segger J-Link USB Driver

To install the SSP, follow these steps:

1. Download the following items for the SSP Release from Synergy Gallery: • SSP_Distribution_1.0.0-beta.3.zip (SSP Package Installer, including SSP Package, HTML User’s

Manual and readme_SSP.txt) • Release_Notes_SSP_ver1.0.0-beta.3.pdf • Synergy Software Package 1.0.0-beta.3 User's Manual r01us0171eu0091_synergy_ssp.pdf

2. Unzip the package and run the SSP_Distribution_1.0.0-beta.3.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 will install 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.91-sspv1.0.0-beta.3.zip (HTML version of the SSP user’s manual) • readme_SSP.txt (critical information and last-minute updates)

Note: Projects created with version 1.0.0-beta.1 or 1.0.0-beta.2 must be updated to work with version 1.0.0-beta.3. To update projects created with version 1.0.0-beta.1 or 1.0.0-beta.2, download ssp_project_update_1.0.0-beta.3.zip from the Demos and Applications Tab under the SSP section of Gallery and follow the instructions in readme to update each project.

7. Changes From v1.0.0-beta.1 to v1.0.0-beta.3 Release 7.1 New Features

Module Description HW Platform

All Modules A new file ssp_version.h is added to the synergy/inc folder of all projects. This file contains version information that can be used to identify which version of the SSP the project is built with.

-



7.2 Updated Features


dave2d (2D Drawing Engine Driver)

TES/dave2d component can be added in the Threads tab of the ISDE project configurator.

PE-HMI1

Licensing Licensing scheme has been changed to allow viewing source code for SSP Application Framework using Evaluation License. In order to use this capability users will need to use the Evaluation License file provided with this release package.

Not applicable

r_ctsu (Capacitive Touch HAL Driver)

Tuning Configuration Support: CTSU XML updated to allow Tuning related configuration via ISDE.

DK-S7G2

r_dac (Digital to Analog Converter)

On S3A7 MCUs, a voltage reference must be selected to get a usable output from the DAC. Voltage reference control register data and hardware interface function declarations added. Default voltage reference select setting for S3A7 MCUs added to driver’s open API.

DK-S3A7

r_fmi (Factory Microcontroller Information)

Module Description XML file added. When incorporated in the CMSIS pack for SSP, the Synergy Project Configurator will read the Module Description XML file for the information it requires to display the FMI driver properties and generate code for an instance of the driver.

PE-HMI1, DK-S7G2, DK-S3A7

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

SDIO functions added to SDMMC xml. SDIO is under a separate driver category than SD/MMC. From the e2 studio the user can now select SDIO Driver on r_sdmmc.

This applies to boards with a SD card slot, DK-S7G2 and DK-S3A7.

sf_thread_monitor (Thread Monitor -Watchdog)

Macro THREAD_MONITOR_CFG_THREADX_TICKS_PER_SECOND replaced with ThreadX supplied equivalent TX_TIMER_TICKS_PER_SECOND in: sf_thread_monitor.c.

DK-S3A7 DK-S7G2


The Thread Monitor checks that threads are running as expected by checking values of counts the threads increment. If one or more threads are not executing as expected the Thread Monitor allows the low level watchdog to reset the device by not refreshing it.

DK-S3A7 DK-S7G2

tx, nx, fx, gx, ux (ThreadX, NetX, FileX, GUIX, USBX)

Updated serial number for Express Logic ThreadX and all the X-wares library files.

PE-HMI1



7.3 Deprecated Features

Module Function/API Description

gx

(GUIX)

Macro:

GX_TICKS_SECOND

The macro definition GX_TICKS_SECOND is deleted from gx_api.h. The alternative is GX_SYSTEM_TIMER_MS. The macro GX_TICKS_SECOND is used in the Weather Panel demo applications, so users have to change the code to use GX_SYSTEM_TIMER_MS to resolve the build error.


THREAD_MONITOR_CFG_THREADX_TICKS_PER_SECOND

Macro THREAD_MONITOR_CFG_THREADX_TICKS_PER_SECOND no longer required as ThreadX now provides an equivalent - TX_TIMER_TICKS_PER_SECOND. Removed from sf_thread_monitor_cfg_ref.h.


THREAD_MONITOR_CFG_THREADX_TICKS_PER_SECOND

Macro THREAD_MONITOR_CFG_THREADX_TICKS_PER_SECOND no longer required as ThreadX now provides an equivalent - TX_TIMER_TICKS_PER_SECOND. Removed from sf_thread_monitor_cfg_ref.h

sf_timer (Timer Framework)

All APIs provided for the sf_timer module have been deprecated

The sf_timer module is deprecated and has been removed from this release. Replacement recommendation for sf_timer: The only feature sf_timer added on top of the HAL timer interface was a wait function that waits for a semaphore posted from the timer callback. Timing delays at the framework layer should typically by handled by the ThreadX function tx_thread_sleep(). If more precise timing than the RTOS tick is needed, the timer callback from the HAL layer should be used directly to avoid the indirection/overhead of waiting for the sf_timer to post a semaphore.

8. Summary of Bug Fixes from v1.0.0-beta.1 to v1.0.0-beta.3 Release (Including fixes delivered in v1.0.0-beta.2 release)

Module Description

HW Platform

bsp BSP xml file would cause e2 studio to generate an invalid setting for the USB clock divider when selecting a divisor of 5. This would result in a in a clock rate other than that specified for the USBFS module.

DK_S7G2



Module Description

HW Platform

bsp ISDE prior to v4.2.0.005 did not have the following part number: R7FS7G27H3A01CFC. This is the part number used by the SK-S7G2. To allow users to use the SK-S7G2 before this fix was implemented, the part number R7FS7G27H2A01CFC was used instead. Now that the ISDE has this part number, the BSP XML has been updated to use the proper part number.

SK-S7G2

bsp Fixed the SDRAM initialization sequence code.

SDRAM initialization in bsp_sdram.c could fail due to not sufficient SDRAMC controlling. If BCLK (SDRAMC module clock) was setup to 60MHz or less, a LMR command to be issued to SDRAM memory possibly missed and it resulted in the failure in the register setup in SDRAM memory and the failure in followed memory accesses.

PE-HMI1

bsp Added ssp_error_log function call in the SSP_ERROR_LOG macro not to generate the compiler warnings.

PE-HMI1

dave2d

(2D Drawing Engine Driver)

Fixed the typo in the XML (Dave/2d to D/AVE 2D). PE-HMI1

r_adc (A/D Convertor)

Group Interrupts were forced to be enabled in ISDE even if not used. Fixed to remove this condition.

DK-S7G2

r_cac

(Clock Frequency Accuracy Measurement Circuit)

Fixed CAC_ERROR_RETURN macro definition which specified wrong version data structure.

PE-HMI1

r_cgc (Clock Generation Circuit)

Fixed CGC S3A7 PLL would not start if clock was less than 32 MHz. Root cause: The S3A7 powers up in low voltage mode. The PLL can't run in low voltage mode. The code would only change from low voltage mode (to high speed mode) if the clock was higher than 32 MHz. Solution: Set MCU to Middle Speed mode if using PLL and speed is 12 MHz or less, set to High speed mode if above 12 MHz.



Issue: The templates for the HMI and DK-S7G2 boards were set to use an external oscillator as the main oscillator clock source when they should have been set to use a crystal.

Solution: The board templates have been changed to reflect the correct values.

PE-HMI1, DK-S7G2


The DAC driver for the S3A7 MCU did not properly set the reference voltage, which resulted in a severely limited output voltage range. This is corrected, and the full output voltage range can be achieved.

DK-S3A7

r_doc

(Data Operation Circuit)

Fixed DOC_ERROR_RETURN macro definition which specified wrong version data structure.

PE-HMI1

r_flash_lp(Flash Memory, Low Power)

R_FLASH_LP_UpdateFlashClockFreq defined in wrong header file. Previously the prototype for this function was incorrectly declared in r_flash_lp_private_api.h. It has been moved to r_flash_lp.h where the other Flash_LP API functions are defined.

DK-S7G2, DK-S3A7

r_glcd (Graphics LCD Controller)

Fixed the compiler warnings. PE-HMI1



Module Description

HW Platform

r_gpt (General PWM Timer)

The GPT open function did not initialize the duty cycle registers (GTCCRn) in timer mode. This is corrected. All GPT registers that affect timer/PWM functionality are now initialized in the open function.

DK-S7G2, SK-S7G2, PE-HMI1, DK-S3A7


GPT interrupts for channels 14 and 15 were removed since channels 14 and 15 do not exist on the S7G2 MCU.

DK-S7G2, SK-S7G2, PE-HMI1

r_iwdt (Independent Watchdog Timer)

If R_IWDT_StatusClear() is called in a short time period after the REFEF or UNDFF flags are set then the flags will not be cleared. This is a feature of the hardware where the flags cannot be cleared until after the cycle after they are set. This API modified to test and re-clear the flags until they are read as cleared.

DK-S3A7, DK-S7G2


IWDT XML code uses old callback arguments in callback functions. The XML code updated to replace:

wdt_user_cb_data_t with wdt_callback_args_t

DK-S3A7, DK-S7G2

r_iwdt (Independent Watchdog Timer

WDT and IWDT XMLs did not provide unique string so Thread Monitor could ensure the module was added. WDT and IWDT XMLs had hard coded cfg struct name. If user changed name from default then it no longer worked.

DK-S3A7, DK-S7G2

r_jpeg_decode (JPEG Decode)

Added constraints in the XML file to notify JEDI and JDTI interrupts are not enabled. PE-HMI1


The XML did not generate a user callback function for the module. Fixed the XML to generate code to support a user callback function.

PE-HMI1



r_riic

(IIC) RIIC read operation does not gets aborted when addressed device does not ACKs. DK-S7G2,

DK-S3A7

r_riic

(IIC)

Data transfer rate of RIIC in fast plus mode was not as expected. This has been corrected in this release.

DK-S3A7, DK-S7G2

r_riic (IIC)

Output clock frequency of RIIC was not correct for Standard mode, it was above 500 kHz instead of 100 kHz. This has been corrected in this release.

DK-S3A7, DK-S7G2

r_riic

(IIC)

Fixed RIIC_ERROR_RETURN macro definition which specified wrong version data structure.

PE-HMI1

r_rspi (Serial Peripheral Interface)

Fixed compiler warning in the Open function of RSPI. DK-S7G2, DK-S3A7


XML change: Changed RSPI XML to generate extended configuration name with device name, earlier it was created based on the channel selected.

DK-S7G2, DK-S3A7


Fixed O2 level optimization issues in RSPI. DK-S7G2, DK-S3A7



Module Description

HW Platform

r_rtc (Realtime Clock)

The RTC controller was always being set to 12 hour mode. Now it is set to 24 hour mode.

DK-S3A7, DK-S7G2, PE-HMI1


R_RTC_CalendarAlarmSet did not work when compiled with optimization setting –O2. Fixed.



R_RTC_Open was failing to open with success when ICLK = 240 MHz and clock source was SUBCLK. Fixed.


r_sci_i2c (Serial Communication Interface I2C)

Fixed bug in SCI I2C channel check validation. Added channel check function in parameter checking.

DK-S7G2

r_sci_i2c (Serial Communication Interface I2C)

SCI I2C receive data count size increased from (256 byte to 4 Giga byte size. DK-S7G2

r_sci_spi (Serial Communication Interface SPI)

Fixed compiler warning in the Open function of SCI SPI. DK-S7G2, DK-S3A7


Fixed bug in SCI SPI channel check validation. Added channel check function in parameter checking.

DK-S7G2, DK-S3A7


XML change: Exported HAL config structure to make it available to framework modules in different threads.

DK-S7G2, DK-S3A7


Added constraint in SPI XMLs to set same priority for RXI and TXI interrupts. This will prompt the user to set same priority to transmit and receive interrupts, so that received data will not be missed due to different interrupt priorities.

Both RSPI and SCI SPI XML’s were modified.

DK-S3A7, DK-S7G2

r_sci_uart

(Serial Communication Interface UART)

Fixed following bugs. (1) SCI UART code setup one of the Rx port register in the setup code for the data

transmission.

(2) Some portion of code in the open API was not compiled out as expected when

specifying the Synergy Configuration properties for UART Driver, “Reception” to

“Disable” or “Transmission” to “Disable”. This resulted in the build error.

DK-S7G2


Multiple issues, SD/MMC and SDIO failing at high speed, above 30 MHZ clock. This is related to the drive level of the MCU I/O peripheral pins. The solution was to configure board templates using SD/MMC devices to use the high output drive level.



The SDMMC erase function was failing the first time after reset, on eMMC devices. This was fixed by increasing the timeout for erase commands.

PE-HMI1, DK-S7G2

r_wdt (Watchdog Timer)

If R_WDT_StatusClear() is called in a short time period after the REFEF or UNDFF flags are set then the flags will not be cleared. This is a feature of the hardware where the flags cannot be cleared until after the cycle after they are set.




Module Description

HW Platform

This API was modified to test and re-clear the flags until they are read as cleared.


The XML for the WDT sets the wdt_cfg_t::stop_control incorrectly. When enabled the clock should be stopped in lower power mode and when disabled it should not be stopped. The XML has the enable and disable swapped. XML updated to correctly configure this setting.



WDT XML code uses old callback arguments in callback functions. The XML code updated to replace:

wdt_user_cb_data_t with wdt_callback_args_t



WDT and IWDT XMLs did not provide unique string so Thread Monitor could ensure the module was added. WDT and IWDT XMLs had hard coded cfg struct name. If user changed name from default then it no longer worked.

DK-S3A7, DK-S7G2

sf_console (Console)

The console framework always returns "Unexpected Command" when the CR+LF line ending is used. This is corrected, and now the following line endings are supported: CR, CR+LF, and CR+NULL.


sf_el_gx (Synergy GUIX Interface)

Fixed 1bpp/4bpp glyph draw functions, which run out of memory for dave2d display lists if the amount of glyphs to draw is too large.

PE-HMI1


Fixed not to have the hardware fault if user callback are not registered. PE-HMI1



sf_el_nx (Synergy NetX Interface)

The Ethernet driver became unresponsive during a large TCP transmission test. This is corrected. A 5 second wait during PHY negotiation was also removed.


sf_el_nx (Synergy NetX Interface)

The Ethernet PHY code in SSP v1.0.0-beta.1 supports the KSZ8091RNB PHY only. This PHY is used on the DK-S7G2, DK-S3A7, and PE-HMI1-S7G2 boards. The SK-S7G2 board has a different Ethernet PHY (KSZ8081RNACA), and with this update Ethernet is now supported for the PHY on the SK-S7G2 board.

The Ethernet PHY files (in folder synergy/ssp/src/framework/sf_el_nx/phy/) are no longer encrypted and can now be customized for other PHYs.


sf_el_nx_comms (Synergy NetX Communication Interface)

In the Synergy Configuration tool, IP address Byte 1 and Subnet Mask Byte 1 could not be edited. This is corrected, and these fields can now be updated.



If a multibyte read comes in as two separate packets, the second packet would be placed at the beginning of the destination buffer, overwriting data from the first packet. This is corrected, and now multibyte reads that span multiple packets are supported.



Telnet communication did not work properly if the Telnet connection was closed and reopened. This is corrected, and the Telnet connection can now be closed and reopened.


sf_el_ux The insertion interrupt for USB host was not generated when a USB device was inserted. This is corrected, and host insertion at runtime is now possible.

DK-S7G2, SK-S7G2,



Module Description

HW Platform

(Synergy USBX Interface) PE-HMI1, DK-S3A7

sf_el_ux_comms (Synergy USBX Communication Interface)

The USBX communications framework would hang if a transfer size was requested that was a multiple of 64 bytes (maximum packet size), but less than the input buffer length. This is fixed and transfer that are multiples of 64 bytes but less than the input buffer length will complete successfully.



If a multibyte read comes in as two separate transfers, the second transfer would be placed at the beginning of the destination buffer, overwriting data from the first transfer. This is corrected, and now multibyte reads that span multiple transfers are supported.


sf_jpeg_decode (JPEG Decode)

The XML generated sf_jpeg_decode configuration wrongly. Fixed the XML description to generate code, which works properly.

PE-HMI1


Added constraints in the XML file to notify r_jpeg_decode module is needed for the module.

PE-HMI1



sf_message (Inter-Thread Messaging)

Fixed the compiler warnings. DK-S7G2

sf_power_profiles (Power Mode Profile)

Power Profiles module required RTC even when RTC mode is not selected.

When configuring the Power Profiles framework, the user would be required to include the RTC module, even if RTC mode was not the selected Power Profiles operational mode.

DK-S7G2, DK-S3A7


Power Profiles Module did not check/keep pointer for RTC ctrl.

This would cause the Power Profiles framework to incorrectly restore the sub-clk and/or LOCO clocks to their prior running/stopped status after waking up.

DK-S7G2, DK-S3A7


Power Profiles xml file did not generate instance name consistent with ssp standards. Also ioport definitions needed to be redefined. Previous implementation would generate build errors when supplying a wakeup and/or sleep table configuration.

DK-S7G2, DK-S3A7

sf_spi (Serial Communication Interface)

Added parameter check for TX_NO_WAIT timeout value in read, write and writeread functions, valid timeout value will be from 1 to TX_WAIT_FOREVER.

DK-S7G2, DK-S3A7


Lock function was not returning any error code if it is already taken. Added a check in the lock function for locked flag, if lock is already taken by the device this will return an error code.

DK-S3A7, DK-S7G2

sf_tes_2d_drw (2D Drawing Engine Framework)

Fixed wrong constraints in the XML, which says it requires GUIX but actually not.

PE-HMI1

sf_tes_2d_drw (2D Drawing Engine Framework)




Module Description

HW Platform

sf_thread_monitor (Thread Monitor - Watchdog)

Thread Monitor XML does not prototype instance structure in new_thread.h. Result is an error building a project using the Thread Monitor unless following is included:

extern const sf_thread_monitor_instance_t g_sf_thread_monitor;

XML updated to include prototype.

DK-S3A7, DK-S7G2

sf_thread_monitor (Thread Monitor - Watchdog)

Thread Monitor XML had enum for choosing WDT or IWDT for lower layer. Should just have a name so as to not hard code it. TM XML used lower level module name as its unique ID in XML. Should use its own name. The fix is in interface.hand in XM file.

DK-S3A7, DK-S7G2

sf_touch_ctsu

(Capacitive Touch Sensing Unit)

Fixed SF_TOUCH_CTSU_ERROR_RETURN macro definition which specified wrong version data structure.

PE-HMI1

sf_touch_panel_i2c (Touch Panel I2C)

Corrected the low level driver for sx8654 touch controller to work properly if compiled with GCC -O2 build option.

DK-S7G2, SK-S7G2


Fixed the compiler warnings. DK-S7G2, SK-S7G2

sf_uart_comms (UART Framework)

The queue memory size was allocated in bytes, when it should have been allocated in words. This caused memory corruption if the queue filled more than 25% of the maximum size when DTC was not used. This is corrected.


9. Known Issues and Limitations in v1.0.0-beta.3 Release

Module Description

HW Platform

All Modules The ssp_version_t structure used in the versionGet API provided by all SSP modules has the API minor version in the most significant byte. In the future, the API major version will be in the most significant byte.


BSP SK-S7G2 projects created with SSP v1.0.0-beta-2 and earlier will have the part number set as R7FS7G27H2A01CFC when the actual part number is R7FS7G27H3A01CFC. The ISDE now has support for R7FS7G27H3A01CFC and new projects created for the SK-S7G2 will use R7FS7G27H3A01CFC. If the user upgrades an existing project to this version of SSP the part number in their project will not change. If the user tries to update the part number in the ISDE through the BSP tab of the Synergy Configurator then the ISDE will bring in a template pin configuration for the device and will set the BSP to the S7G2-User board. If the user does not change the part number then no problems will occur. If user does wish to change the part number it is recommended they contact Renesas for instructions.

SK-S7G2

dave2d

(2D Drawing Engine Driver)

With this release applications using TES (D/AVE 2D) module will not build correctly. This is due to licensing changes made for Application Framework. In order to use

DK-S7G2, SK-S7G2,



Module Description

HW Platform

TES component (D/AVE 2D) with a development and production license, users are required to re-order a new production license from Synergy Gallery.

PE-HMI1, DK-S3A7

Nx (NetX)

Chained packet support in dual Ethernet driver. Issues when sending chained NetX packets to the driver: If the packet pool packet size is set to packet sizes lower than the transmit MTU, the driver will require chained packets to work. This would be an issue for systems with constrained resources, or for users who want to take advantage of creating packet pools with smaller packet sizes.

PE-HMI, DK-7G2, DK-S3A7

r_adc (A/D Convertor)

Group mode Priority has not been tested in this release. DK-S7G2, DK-S3A7

r_agt (Asynchronous General Purpose Timer)

Due to hardware limitations on 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. Workarounds, such as operating only one AGT channel at maximum input clock (cascade mode) are also being tested. Due to hardware limitations on S3A7 MCU, when transitioning operating mode from Normal to Standby, Vbat 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.

DK-S3A7


CGC needs a callback function for Oscillator Stop detection. The xml has an enable for the detection but needs to have the ability to specify a callback function.

DK-S7G2, DK-S3A7


S3A7 MCU has a register to select one of four voltage references for the DAC. For now, Vcc is the default voltage reference selected. To allow the caller to select a DAC voltage reference other than the default, the open API needs to be modified to add a configuration parameter to select any of the four voltage references.

DK-S3A7

r_dmac (Direct Memory Access Controller)

The reset API in repeat mode does not reset the number of times to repeat the transfer. To reset the number of times to repeat the transfer, set the DMCRB register from the application code.



Factory MCU Information consists of three record types: Product Information, Software Provisioning, and IP Information. Product Information is the only record programmed into the S7G2 WS2 MCUs, and is the only record fetched by the FMI driver. When MCUs are available with other records programmed, the FMI driver will add API functions to fetch them.

PE-HMI1, DK-S7G2


The number of horizontal total cycles in a line has to be larger than or equal to the total number of (Horizontal back porch cycles + Horizontal active video cycles + Horizontal front porch cycles), where, Horizontal front porch cycles are minimum 16 cycles in case of 32-bit color formats for the GLCDC output (ARGB8888 and RGB888), 32 cycles in case of 16-bit color formats (RGB565, ARGB1555 and ARGB4444), and 64 cycles for the other formats. If the number of cycles are not given for the Horizontal front porch cycles, the GLCDC driver does not display the screen properly.

SK-S7G2



Module Description

HW Platform

r_gpt

(General PWM Timer)

An overflow can occur in the GPT duty cycle set calculation when the GPT is used in PWM mode.



The GPT close function does not power down the GPT peripheral. If powering down the GPT is desired, it must be done in the application code by setting the appropriate bit in the R_MSTP register after calling the close API. Refer to the hardware manual for details.



The GPT close function does not power down the GPT peripheral. If powering down the GPT is desired, it must be done in the application code by setting the appropriate bit in the R_MSTP register after calling the close API. Refer to the hardware manual for details.


r_gpt_input_capture (General Input Capture)

This module is provided for reference only and should not be used for any application development at this time. The API for this module might change and if you would like to use this module before the next release, please contact the Synergy Support team.



This module is provided for reference only and should not be used for any application development at this time. The API may change and if you would like to use this module before the next release, please contact the Synergy Support team.


r_jpeg_decode

(JPEG Decode)

There are two properties in the Synergy Configuration explained as below, which are duplicated but one of them (2nd one) is typo.

“Byte Order for Output Data Format” -> “Output Data Color Format”

Impact Analysis: Simple typo, no impact on usage.

SK-S7G2

r_lpm (Low Power Mode)

Cannot debug through Software Standby or Deep Software Standby. DK-S7G2, SK-S7G2, PE-HMI1, DK-S3A7

r_qspi (Quad Serial Peripheral Interface)

The pin strength of all QSPI pins must be set to HIGH on the DK-S7G2 v3.0 using the pin configurator.

DK-S7G2 v3.0

r_riic

(IIC)

Restart does not work for RIIC read function. With this bug, the user cannot use Restart with the Read function. It is possible to use the Read function without using restarts.

DK-S7G2, DK-S3A7

r_riic

(IIC)

Fast plus transfer mode in RIIC is not tested. It is tested for normal and fast mode operations.

DK-S7G2, DK-S3A7

r_sce (Crypto Library)

UpdateHash() does not use hash_ctrl_t as an input parameter. PE-HMI1, DK-S7G2


sign() and verify() for DSA do not use dsa_ctrl_t as an input parameter. PE-HMI1, DK-S7G2



Module Description

HW Platform


AES GCM mode requires multiples of 16-bytes for authentication data and input data.



SPI interrupt priority can make interrupt handler not store RX data. User impact: If SCI RX interrupt priority get to be higher than the TX the SPI driver will miss the data that was just received. Work around for this is to keep both RX and TX interrupt priorities same.

DK-S7G2, DK-S3A7


SCI SPI data transfer is limited to maximum 15MHz speed. DK-S7G2, DK-S3A7


Some MCUs do not have pins brought out for SD card detect. There needs to be an option to select CD, SDDAT3, or None for card detect in the XML.

This applies to boards with a SD card slot: DK-S7G2 and DK-S3A7.

r_slcdc (Segment LCD Controller)

Following functionalities are not tested in SLCDC driver, • Contrast increase and decrease functions are not tested. • LCD configuration with Time slice 2, 3 , 4 and 8 and Bias methods 3 and 4

are not tested. • LCD configuration with voltage generator source Internal and Capacitor split

methods are not tested.

DK-S3A7

r_slcdc

(Segment LCD Controller)

Following functionalities are not tested in SLCDC driver, • Contrast increase and decrease functions. • LCD configuration with Time slice 2, 3 , 4 and 8 and Bias methods 3 and 4. • LCD configuration with voltage generator source Internal and Capacitor split

methods.

S3A7-DK

sf_adc_periodic (Periodic Sampling ADC)

Periodic ADC Framework only usable with GPT timer. • Will not be able to use other timers with Periodic Framework. This will prevent

the framework from being used in low power applications since the GPT cannot be used in low power mode as opposed to some other timers.

DK-S7G2, DK-S3A7

sf_el_gx

(Synergy GUIX Interface)

• Ellipse draw does not work fully. It is not recommended to use Ellipse draw. Ellipse draw with simple outline or color fill work but pixel map draw or brush context property may not be applied to the drawing.

• Out format is tested withRGB565 format. ARGB8888 format has yet to be tested and the other formats are not supported in this release.

Multiple display instance is not supported in this release.

DK-S7G2, PE-HMI1, DK-S3A7

sf_el_ux (Synergy USBX Interface)

USBX CDC read spins forever when receiving an actual length buffer that is a multiple of 64 bytes (wMaxPacketSize of the endpoint) but less than the maximum read length parameter.

Analysis: It is pending on a semaphore in ux_dcd_rx_transfer_request.c line 255. The semaphore is typically set when the transfer completes in line 302 of ux_dcd_rx_transfer_callback.c. According to research "When a transfer has an exact multiple of wMaxPacketSize bytes, the endpoint returns wMaxPacketSize bytes in one or more transactions until all of the data has been sent. The endpoint then indicates the end of the transfer by responding to an IN token packet with a zero-length packet (ZLP), which is a data packet with no data bytes."

PE-HMI, DK-7G2, DK-S3A7



Module Description

HW Platform

The device doesn't seem to receive this ZLP. This could be because the PC isn't sending it or the hardware isn't configured to receive it. No USBFS interrupt occurs after the last 64 byte packet. Workaround: If you expect packets that are multiples of 64 bytes, give the exact expected length or read 64 bytes at a time.

sf_el_ux_comms

(Synergy USBX Communication Interface)

The read API timeout will only return with a timeout error if the device is not plugged in. Read will not time out if the device is enumerated but no data arrives in the specified time. Workaround: If a timeout is needed for reading data after the connection is established, we recommend buffering the data in a separate thread. We will consider doing this internally as a future enhancement to sf_el_ux_comms. For now, it can be done in a separate thread that pends on USB data by waiting forever then posts received data to a queue. Then the application thread can pend on the queue with a timeout.


sf_el_ux_comms


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.


sf_el_ux_comms


The read API timeout will only return with a timeout error if the device is not plugged in. Read will not time out if the device is enumerated but no data arrives in the specified time.

Workaround: If a timeout is needed for reading data after the connection is established, we recommend buffering the data in a separate thread. We will consider doing this internally as a future enhancement to sf_el_ux_comms. For now, it can be done in a separate thread that pends on USB data by waiting forever and then posts received data to a queue. Then the application thread can pend on the queue with a timeout.


sf_el_ux_comms


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.


sf_message

(Inter-Thread Messaging)

Messaging Framework Configurator on ISDE is not yet available. Users should use the sf_message_configurator tool instead for this version to generate the Event class/Event code (defined in sf_message_port.h) and Subscriber list (defined in sf_message_cfg.c). sf_message_configurator is bundled with the SSP package and you can refer SSP User’s Manual - User Guides – Using e2 studio to Write an Application with the Touch Panel Framework Interface for instructions how to use it.

DK-S7G2, PE-HMI1, DK-S3A7


If RTC mode is selected as the operation mode, then e2 studio will warn that the RTC support option must be enabled and the RTC module is required. If the RTC support option is then enabled, then all RTC warning messages disappear, even if the RTC module has not yet been added. Building the project without adding the RTC module in this case will generate build errors as the Power Profiles framework requires the RTC module when in RTC mode.

The workaround is to add the RTC module if you are using RTC mode.

DK-S7G2 DK-S3A7



Module Description

HW Platform


The module is not considered to handle a user callback function for I2C-BUS Driver, which is associated with the Touch Panel I2C Framework. Only NULL is allowed to be given to the callback property in the Synergy Configuration for the I2C-BUS Driver.

Impact Analysis:

The module does not work if a user callback function is given to the I2C-BUS Driver, since the internal touch thread does not wait the end of I2C-BUS communication after the thread started the communication and run into the next processing before the touch data is obtained through I2C-BUS from touch chip.


tx (ThreadX)

EPK support missing from the ThreadX XML The impact is that users cannot yet enable EL EPK support via the ISDE configurator.

Board with WS2 parts

10. Changes From v0.91.00C1 to v1.0.0-beta.1 Release 10.1 New Features


bsp (Board Support Package)

Added BSP for the SK-S7G2 Starter Kit. SK-S7G2

dave2d (2D Drawing Engine)

New module added. dave2d device driver is a driver for DRW hardware. The module supports vector drawing objects like line, arc, circle, polygon, texture mapping and BitBLT.

PE-HMI1

r_adc (A/D Converter)

Function R_ADC_InfoGet() added. This function is required for the ADC HAL driver to be linked and used by the Transfer API. The function returns the ADC Event Type, ADC Event Name, length of configured ADC Channels (required to determine length of the Transfer) and the starting address of the first configured channel.

DK-S7G2, DK-S3A7

r_cgc

(Clock Generation Circuit)

Function R_CGC_SystickUpdate() added. This function allows reconfiguration of the SysTick based on a provided period and current system clock frequency. Also, if an RTOS is in use, the function updates the SysTick period based on the new frequency using the ThreadX SysTick period in microseconds.


r_ctsu


Capacitive Touch Sensing Unit driver added. This module supports self-capacitance single scan mode and mutual capacitance full scan mode.

DK-S3A7 + CapTouch Board


New Module added. This module retrieves the Product Information Record from the factory-programmed Flash.



• Function R_GPT_InfoGet() added to provide the current period, clock frequency, count direction, and current status (counting or stopped).

• Function R_GPT_DutyCycleSet() added (moved from r_gpt_pwm) and duty cycle settings to the timer open function. PWM mode was added, and the duty cycle settings only apply in PWM mode.

DK-S3A7





• Function R_IWDT_TimeoutGet() added. Provides the (required) ability to retrieve clock frequency (after divider) the IWDT is operating on and the timeout (number of clocks) of the IWDT. This is a requirement of the Thread Monitor framework module.

• Internal function added to provide the ability to get the clock divider for the IWDT clock in numerical form.


r_lpm (Low Power Modes)

New module added for Low Power Modes support. DK-S7G2, DK-S3A7

r_sce (Secure Crypto Engine)

Added Crypto API support for DK-S3A7 device class. Supported crypto functions:

• TRNG (True random number generation) and • AES (Advanced Encryption Standard) encryption/decryption

DK-S3A7

Added Libraries for IAR Compiler for DK-S7G2 and DK-S3A7 platforms. DK-S7G2, DK-S3A7

r_sci_uart (Serial Communication Interface UART)

R_SCI_UartInfoGet() function added to query maximum transfer length. DK-S3A7


• New Commands ACMD51 and CMD6 added for SD switch to High Speed.

• SDIO support implemented.

DK-S7G2, DK-S3A7

• New Commands ACMD51 and CMD6 added for SD switch to High Speed.

• Support for eMMC devices above 2 GB.

PE-HMI


Added function R_WDT_TimeoutGet(). This function provides the (required) ability to retrieve clock frequency (after divider) the WDT is operating on and the timeout (number of clocks) of the WDT. This is a requirement of the Thread Monitor framework module.

DK-S7G2, DK-S3A7

• Added internal function to provide the ability to get the clock divider for WDT clock in numerical form.

• Added new structure wdt_timeout_values_t to support data returned by new R_WDT_TimeoutGet() function.

DK-S7G2, DK-S3A7

DK-S7G2, DK-S3A7


• DTC support for UART transfers (both transmit and receive) is now available.

• Unless a DTC transfer has been requested (suppressing interrupts until requested number of bytes arrive), UART read will provide all data bytes received to the callback function.

DK-S3A7

sf_adc_periodic (Periodic Sampling ADC)

New module added with the following functions: • Perform initialization of the framework in a thread-safe manner including

lower level ADC and Timer and DTC drivers. Starts the ADC periodic scans and uses DTC to move sampled data into user buffer.

• Stop the ADC Periodic scans and buffering. • Close the Framework module including the low level ADC, Timer and

DTC drivers. • Retrieve the version number of the framework.

DK-S7G2




sf_audio_playback_hw_dac (Audio Playback HW DAC)

New module added. The sf_audio_playback module abstracts the hardware-independent interface for audio playback and moves them to sf_audio_playback_hw_api (currently implemented only by sf_audio_playback_hw_dac). The following functions were added:

• A callback function that can be registered to notify the application when a buffer is done playing and released.

• Configure audio hardware (timer, transfer, and DAC) based on application settings.

• Start timer and DAC hardware. • Stop timer and DAC hardware • Start playback of a single buffer by starting a transfer from the buffer to

the DAC output register at the sampling frequency specified by the timer. • Provide expected data type (number of bits and sign). • Close timer, transfer, and DAC drivers.

DK-S3A7

sf_el_gx (Express Logic, Inc. GUIXTM Adaptation Framework)

New Module added with the following functions:

• Open function. Stores user configurations for Synergy graphics device drivers in the module control block.

• Set up graphics device drivers. • Initialize the memory address for a canvas. Users have to call this

function after calling gx_studio_display_configure. • Close sf_el_gx module and finalize Synergy graphics device drivers. • Get version of sf_ex_gx module.

PE-HMI1

sf_power_profiles

(Power Mode Profile)

New module added with the following functions: • Initialize module and lower level drivers. • Enter Software Standby mode. • Release any resources allocated by Open().


sf_tes_2d_drw (2D Drawing Engine)

New module added. sf_tes_2d_drw module is driver for DRW hardware. The module is the high level layer driver of DRW driver on top of tes (dave2d).

PE-HMI1


Added internal structure for configuring the maximum number of threads to file sf_thread_monitor_cfg_ref.h.

DK-S7G2, DK-S3A7

sf_timer (Timer Framework) SF_TIMER_InfoGet() function was added to provide the current period, clock frequency, count direction, and current status (counting or stopped).

DK-S3A7

sf_touch_ctsu


New framework module for providing capacitive touch system services to applications with the following functions:

• Perform initialization of the framework in a thread-safe manner including lower level CTSU drivers.

• Read CTSU results data. • Close the Framework module including the low level CTSU driver. • Retrieve the version number of the framework.


sf_touch_ctsu_button New framework module added with the following functions:

• Perform initialization of the framework in a thread-safe manner including lower level CTSU and the CTSU Framework module.





(Capacitive Touch Sensing Button framework)

• Enable a specific button. • Disable a specific button. • Close the Framework module. • Retrieve the version number of the framework.

sf_uart_comms (UART framework)

• The UART framework now implements the common communications interface. As part of this change, the UART framework module was renamed from sf_uart to sf_uart_comms.

• The UART framework read function supports buffered character reception, allowing bytes to be read even if they come in before read is called provided there is space in internal the read queue. The size of the internal read queue can be configured in the Synergy Configuration tool.

DK-S7G2

10.2 Updated Features


bsp (Board Support Package)

Adjust ROM and RAM wait states for optimum performance based on the system clock.

DK-S7G2, DK-S3A7

• All BSP API functions that previously returned bsp_err_t now return the standard ssp_err_t.

• CMSIS-CORE files updated to version 4.10.

PE-HMI1 DK-S7G2, DK-S3A7

r_adc

(A/D Converter)

Added support for new S7G2 channels and temperature and voltage sensors on unit 0.

DK-S7G2

14-bit ADC support for this HW platform added. DK-S3A7


DK-S3A7 mode must be changed to high speed mode to support system clock rates > 32 MHz.

DK-S3A7

r_glcdc (GLCDC) Changed default_pixel clock divider value from 1/2 x to 1/8x, since the pixel clock source in the S7G2 W2 chip was changed.

-

r_gpt

(General Purpose Timer)

• Added macros around interrupts to ensure no build errors occur for undefined interrupts on S3A7.

• Fixed warnings reported by GCC.

DK-S3A7


• Added macros around interrupts to ensure no build errors occur for undefined interrupts on S3A7.

• Fixed warnings reported by GCC.

DK-S3A7




r_ioport

(General Purpose I/O Ports)

XML modified to make ELC, CGC and IOPORT layout consistent. IOPORT instance name now configurable.


r_iwdt

(Independent Watchdog Timer)

Name updated in XML to remove reference to iwdt. PE-HMI1, DK-S7G2, DK-S3A7

r_riic

(IIC)

• Modified RIIC project by renaming EEI0 instances to EEI as the error interrupt name is changed in the hardware manual.

• Replaced all instance of BSP_IRQ_CFG_RIIC to BSP_IRQ_CFG_IIC as part of ELC naming changes.

• Changed all EEI0 to ERI as part of ELC naming changes.

DK-S7G2, DK-S3A7

r_rspi

(SPI)

• In functions R_RSPI_Open(), R_RSPI_Close(), and internal function rspi_write_read_common(). Replaced references to BSP_ERR error codes and bsp_err_t to SSP error codes for consistency with rest of SSP.

• Added XML configuration for RSPI module to configure this module through ISDE.

DK-S7G2, DK-S3A7

r_sce

(Secure Crypto Engine)

• Renamed crypto error code names in the error code enum definition e_sf_crypto_err in the file sf_crypto_err.h.

• Unused error codes removed from the enum structure. • Crypto library is now supported on S3A7.

PE-HMI1 DK-S7G2, DK-S3A7

r_sci_spi

(Serial Communication Interface SPI)

In internal function r_sci_sspi_write_read_common() replaced references to BSP_ERR error codes and bsp_err_t to SSP error codes for consistency with rest of SSP.

DK-S7G2, DK-S3A7

r_slcdc

(Segment LCD Controller)

In functions R_SLCDC_Open() and R_SLCDC_Close() replaced references to BSP_ERR error codes and bsp_err_t to SSP error codes for consistency with rest of SSP.

DK-S3A7

r_wdt

(Watchdog Timer)

Name updated in XML to remove reference to wdt. DK-S7G2, DK-S3A7

sf_audio_playback (Audio Playback)

The audio framework uses the messaging framework internally for start, stop, pause, and resume functions. This difference is transparent from the user API point of view.

DK-S3A7

sf_el_gx (Express Logic, Inc. GUIXTM Adaptation Framework)

• Added 2DG accelerated drawing functions (circle, arc and polygon) in addition to line drawing and BitBLT.

• Added support for JPEG output buffer streaming.

PE-HMI1

sf_el_nx

(Synergy NetXTM Interface)

MAC address and PHY reset pins are now configurable.

UPGRADE NOTE: Projects based on DHCP, DNS, and Webserver template examples may not build after upgrading from the 0.91.00_C1 engineering release due to this change. To fix this, do the following:

1. Highlight a Thread on the Threads tab in the Synergy Configuration tool.

PE-HMI, DK-S7G2, DK-S3A7




2. Add the following module: New > Framework > Networking > NetX Port ETHER on sf_el_nx.

After adding this module, a missing include file will be generated and the project will build again.


• Both Ethernet channels supported. • Close API destroys created RTOS objects. • Subnet mask is now configurable in the Synergy configuration tool.


sf_el_ux_comms


USB descriptors are moved to a template file (src/sf_el_ux_comms_port.h) so they can be edited.


sf_external_irq (External IRQ Framework)

• Individual structure members initialized separately in structure sf_external_irq_versionget.

• Internal rename from sf_external_irq_on_sf_external_irq to sf_external_irq.

DK-S7G2


• Renamed sf_thread_monitor_task to sf_thread_monitor_thread. • Changed “task” to “thread” to be consistent with ThreadX • Replaced use of lower level providing timeout period in config structure to

using lower level API to provide this data. • Lower level API instance structure used. • Profiling mode can now be enabled/disabled in configuration structure and

control structure. • Removed WDT and IWDT specific macro usage. Now this API creates an

instance which can use either. • Makes use of instance structures. • Renamed OPEN macro to TM_OPEN to minimize possibility of a name clash. • In function SF_THREAD_MONITOR_Close(), added call to internal function

tx_thread_terminate() prior to deleting the thread. A thread can only be deleted when in the terminated or completed state.

• In function SF_THREAD_MONITOR_ThreadRegister(), changed API so a global thread counter no longer needs to be passed. Only the thread’s minimum and maximum expect values are passed in new structure sf_thread_monitor_counter_min_max_t. This API now determines thread being monitored using tx_thread_identify.

• In function SF_THREAD_MONITOR_ThreadUnregister(), the API now no longer needs global counter for a thread to be passed. Thread being unregistered uses tx_thread_identify to determine thread being unregistered.

• In function SF_THREAD_MONITOR_CountIncrement(), the API now no longer needs global counter for a thread to be passed. Thread having count incremented uses tx_thread_identify to determine thread being incremented.

• Changed to store count information within the control structure rather than globally declared by the thread being monitored.

• Updated to make use of the new architecture and instance structure.

DK-S7G2, DK-S3A7

sf_uart_comms

(UART framework)

The UART framework supports the receive complete event provided by the driver, allowing multiple characters to be read directly into the destination buffer at once.

DK-S7G2




tx

(ThreadX)

• The Synergy ThreadX Port now automatically detects if the FPU is being used and will save the FPU context appropriately when needed.

• The Synergy ThreadX Port now uses CMSIS-CORE functions when possible. • There were previously two Synergy ThreadX Ports for CM4 devices. One for

GCC and one for IAR. These ports were merged and there is now one port for CM4 devices that supports both GCC and IAR.

• The ThreadX code included with SSP was updated to version 5.7.

• The updated Synergy ThreadX Port supports using the hardware stack monitors for detecting stack overflows.

PE-HMI1, DK-S7G2

10.3 Deprecated Features


r_gpt

(General PWM Timer)

statusget API Use infoGet API for current status.

periodget API Use infoGet API for current period.

timer_period_t typedef Recommend using timer_size_t instead, but the typedef is still provided for compatibility.

PWM functionality now part of r_gpt The r_gpt_pwm module is now deprecated. All GPT PWM functionality is provided in the r_gpt module.


FIFO mode selected by default Non-FIFO mode is no longer configurable. FIFO mode is always used.

ByteQ module not required The r_byteq module is no longer required for SCI UART.

The default mode is now zero copy mode, which will write directly from the user’s input buffer and provide read data in the callback function. There is also an option to use the DTC for hardware accelerated transmission and reception. Using the DTC will reduce the number of interrupts required for data transfer.


sf_thread_monitor_cfg_wdt_support_enable Removed from sf_thread_monitor_cfg_ref.h

sf_thread_monitor_task Renamed sf_thread_monitor_task to sf_thread_monitor_thread.

sf_thread_monitor_cfg_iwdt_support_enable Removed from sf_thread_monitor_cfg_ref.h

sf_thread_monitor_cfg_profiling_mode_enable

Removed from sf_thread_monitor_cfg_ref.h

sf_thread_monitor_cfg_debugging_mode_enable





sf_thread_monitor_cfg_max_wdt_number_of_threads


sf_thread_monitor_cfg_max_iwdt_number_of_threads


sf_thread_monitor_cfg_thread_priority Removed from sf_thread_monitor_cfg_ref.h

sf_thread_monitor_cfg_thread_stack_size Removed from sf_thread_monitor_cfg_ref.h

statusget API Use infoGet API for current status.

periodget API Use infoGet API for current period.

sf_uart_comms

(UART framework)

Baud set API removed The baud set API is no longer provided because it does not fit in to the standard communications interface. To update the baud rate, close the UART framework and reopen it with an updated baud rate setting.

11. Summary of Bug Fixes from v0.91.00C1 to v1.0.0-beta.1 Release

Module Description

HW Platform

bsp Corrected flash_lp register addresses for both FLWAITR and FENTRYR in S3A7.h.

DK-S3A7

Corrected incorrect padding of S3A7 and S7G2 IOPORT PFS registers. PE-HMI1 DK-S7G2, DK-S3A7

Fixed BSP_CFG_BCLK_OUTPUT == 2 in bsp_clocks.c. BClk configurator setting was not used before this fix.

DK-S7G2

r_cac (Clock Frequency Accuracy Measurement Circuit)

• Fixed compilation errors after CAC component was added to an ISDE generated project for the S3A7.

• Updated XML file, which is used by the ISDE to generate the CAC module info, to provide a p_api member which points to the CAC instance. Also fixed several property fields.


r_flash_hp (Flash Memory, High Performance

Fixed BGO mode failing in a threaded environment. When operating from within a threaded environment, the Flash HP interrupt routines did not restore the ThreadX context in all cases causing the application to crash.

DK-S3A7

r_flash_lp (Flash Memory, Low Power)

Fixed BGO mode failing in a threaded environment. When operating from within a threaded environment, the Flash LP interrupt routines did not restore the ThreadX context in all cases causing the application to crash.

DK-S3A7



Module Description

HW Platform


The variable type for the framebuffer was expected to be uint8_t but it was defined as uint32_t in the configuration XML file. As a result of this fix, the correct buffer size is allocated.

PE-HMI1


Channels 4-7 are now powered correctly on the S3A7. DK-D3A7


Changed the name for the function pointer to JPEG interface from “g_jpeg_decode_on_jpeg” to “g_jpeg_decode_on_jpeg_decode”.

r_riic (IIC)

• Added additional sequence of operations in the RIIC driver to make single byte read functional.

• Enabled data transfer of more than 255 bytes. RIIC data receive buffer index size changed from uint8_t to uint32_t

DK-S7G2, DK-S3A7

RIIC driver now working on the DK-S3A7 module. Updated I/O configuration. DK-S3A7

r_rspi (SPI)

• Fixed rspi_baud_set limits value of the SPBR register from max 5 to 255. • Added a SPI idle state to check before finish a transfer.

DK-S7G2, DK-S3A7

r_sce (Secure Crypto Engine)

r_sce_aes_256ecbencrypt: function updated to ignore p_iv parameter. Not needed for ECB mode.

-

r_sci_i2c (Serial Communication Interface I2C

• Fixed read and read write operation. Blocking read operation failed in SCI I2C, successive operations like write address and then read value were failing in case of NULL callback configurations. With the fix, there is no need to add delay between read and write or any successive operations.

• Added flag transaction_completed to check completion of transaction. Added volatile keyword to few other flags to avoid compiler optimization.

• Removed parameter check for p_extend as it is not required in SCI I2C. • Fixed Stop Condition.

DK-S7G2


• Fixed SCI SPI clock polarity reverse defect. Polarity bit in SPMR register was set incorrectly in the r_sci_sspi_open function.

Note: For existing SCI SPI and SPI framework (with SCI SPI as implementation) applications, users may need to invert the clock polarity in the configuration.

• Hardware lock error fixed. SCI SPI channel was not released if Close function calls before transfer completion. Hence any successive read or write operations will give HW Lock error. This issue was fixed by putting HW lock release in close function.

DK-S7G2, DK-S3A7


• Erase function fixed. Erase function was not checking write protection. • Erroneous Interrupt status fixed... Interrupt status not properly set, Module

could expect interrupts that are enabled when in fact they are not. The change initializes the "interrupts_in_use" state to false and checks for the proper channel being enabled in the macro.

• DMA fixed. DMA not working on HMI board. Found uninitialized pointers that could cause serious problems. DMA should not be used on any prior versions of this code.




Module Description

HW Platform

eMMC Initialization fixed. Initialization on HMI board was failing occasionally. Extended delay in mmc_card_type_check function in sdmmc_driver.c

PE-HMI1

sf_audio_playback (Audio Playback)

• Tread is created with a name now. The audio playback framework was creating a thread with a null pointer for the name, which causes it to show up unintelligible in the RTOS debugging view of e2 studio and tools like TraceX.

• Mutexes weren’t released correctly in some branches of the audio framework. This no longer applies because there are no mutexes in the latest audio framework module.

• The audio framework no longer turns the hardware off after playback of one buffer completes if there is already another buffer ready for playback.

DK-S7G2


• JPEG work buffer was fixed to be mapped in .sdram section in v0.91.02. Changed configurablilty via e2 studio ISDE.

• Added missing module name definition in sf_el_gx.c. • Changed the internal function for JPEG drawing. The function was changed

from symbol “g_jpeg_decode_on_jpeg” to “g_jpeg_decode_on_jpeg_decode” according to the JPEG driver module.

• Removed the duplicated XML configuration for JPEG work buffer size from the XML configuration file for SF_EL_GX module.

PE-HMI1


Fixed read failure sf_el_ux_comms read fails with an overflow error if the length of the data in the endpoint is greater than the requested read length. Added an internal buffer to ensure information is not lost.

DK-S7G2


Number of lines returned by JPEG API function fixed. After the image is decoded, the application can find out how many lines are decoded into the buffer, but the driver returned incorrect number if the buffer size is bigger than the amount of JPEG image to be decoded (e.g. the output buffer is large enough to hold 80 lines but the image is only 16 lines tall).

PE-HMI1

sf_message (Messaging Interface)

Removed an unintentional “\” from the XML configuration file for SF_EL_GX module.

-


• Renamed writeread function pointer to writeRead in SPI Framework. Updated to comply with coding standard. Previously, SPI framework users had to change their “writeread“ function call to “writeRead”, otherwise it will break the build.

• API versionget() format changed as per coding standards. • rspi support is added to SPI framework. Now users can select rspi or sci SPI

as lower level implementation.

DK-S7G2, DK-S3A7

sf_touch_ctsu (Capacitive Touch Sensing Unit)

SF_TOUCH_CTSU_Close() function now implemented to terminate internal thread.

DK-S3A7 + CapTouch Board.


The built-in low level function for the touch panel controller sx865x, which is mounted on DKS7 and SKS7 board is updated. The sensitivity setting for the chip is optimized.

PE-HMI1



Module Description

HW Platform

tx (ThreadX)

The port code now uses CMSIS-CORE to get the core clock speed to set the SysTick appropriately. The SysTick was set to a constant value in the Synergy ThreadX Port previously.

PE-HMI1, DK-S7G2

12. Complete List of Modules available in this Release

Module Name SSP Feature Framework

sf_adc_perodic Periodic Sampling ADC

sf_audio_playback Audio Playback

sf_audio_playback_hw_dac Audio Playback HW DAC

dave2d 2D Drawing Engine Driver

sf_block_media_sdmmc Block Media Interface for SD Multi Media Card

sf_console Console

sf_el_fx Synergy FileX Interface

sf_el_gx Synergy GUIX Interface

sf_el_nx Synergy NetX Interface

sf_el_nx_comms Synergy NetX Communication Interface

sf_el_ux Synergy USBX Interface

sf_el_ux_comms Synergy USBX Communication Interface

sf_external_irq External Interrupt Framework

sf_i2c I2C Framework

sf_jpeg_decode JPEG Decode

sf_message Inter-Thread Messaging

sf_power_profiles Power Mode Profile

sf_spi Serial Communication Interface

sf_tes_2d_drw 2D Drawing Engine Framework

sf_thread_monitor Thread Monitor (Watchdog)

sf_touch_ctsu Capacitive Touch Sensing Unit

sf_touch_ctsu_button Capacitive Touch Sensing Unit Button

sf_touch_panel_i2c Touch Panel I2C

sf_uart_comms UART framework



Module Name SSP Feature Driver

bsp BSP - PE-HMI1

bsp BSP - DK-S7G2

bsp BSP - DK-S3A7

bsp BSP - SK-S7G2

r_adc A/D Convertor

r_agt Asynchronous General Purpose Timer

r_cac Clock Frequency Accuracy Measurement Circuit

r_cgc Clock Generation Circuit

r_crc Cyclic Redundancy Check calculator

r_ctsu Capacitive Touch Sensing Unit

r_dac Digital to Analog Converter

r_dmac Direct Memory Access Controller

r_doc Data Operation Circuit

r_dtc Data Transfer Controller

r_elc Event Link Controller

r_flash_hp Flash Memory, High Performance

r_flash_lp Flash Memory, Low Power

r_fmi Factory Microcontroller Information

r_glcd Graphics LCD Controller

r_gpt General Purpose Timer

r_gpt_input_capture General Input Capture

r_icu Interrupt Controller Unit

r_ioport General Purpose I/O Ports

r_iwdt Independent Watchdog Timer

r_jpeg_decode JPEG Decode

r_kint Keyboard Interrupt Interface

r_lpm Low Power Mode

r_qspi Quad Serial Peripheral Interface

r_riic IIC

r_rspi Serial Peripheral Interface

r_rtc Realtime Clock



Module Name SSP Feature

r_sce Secure Crypto Engine (TRNG, AES, RSA, TDES, HASH, DSA, ARC4)

r_sci_i2c Serial Communication Interface I2C

r_sci_spi Serial Communication Interface SPI

r_sci_uart Serial Communication Interface UART

r_sdmmc SDHI driver for SDIO and SD/MMC memory devices

r_slcdc Segment LCD Controller

r_wdt Watchdog Timer

Services

CMSIS CMSIS DSP Library

r_sce Crypto Library

X-Ware Stacks

fx FileX

gx GUIX

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

tx ThreadX

ux USBX (Host and Device, HID all classes, mass storage and CDC)

13. Customer Feedback Customers can provide their feedback regarding Release Notes at the following link. https://synergygallery.renesas.com/support

https://synergygallery.renesas.com/support

Documents

Synergy Software Package (SSP) Release Notes · Synergy Software Packag e (SSP) Release Notes Revision 1.0 Page 2 of 28 1. Introduction This document describes the release notes for