메인 콘텐츠로 건너뛰기
Knowledgebase
Home
Renesas Korea

sf_el_ux Module Guide Resources

Last Updated:03/13/2018

Question:

Where can I find the references to module guide resources for the sf_el_ux module?

Answer:

Information on the module guide itself and the associated resources and known issues are available here.

Introduction

The USBX™ Synergy Port Framework module (sf_el_ux) is integrated into the SSP. This driver is intended to be used with USBX APIs from Express Logic. This module provides USB hardware port functions that are required to use the USBX stack on Renesas Synergy hardware. Application code using this module must use USBX API calls from Express Logic

The USBX Synergy Port Framework module supports the following features:

  • Implements Express Logic USBX in SSP—supports USBX APIs
  • Supports the Port Device Controller Driver (DCD) for USBHS peripheral
  • Supports the Port Device Controller Driver (DCD) for USBFS peripheral
  • Supports the Port Host Controller Driver (HCD) for USBHS peripheral
  • Supports the Port Host Controller Driver (HCD) for USBFS peripheral
  • Supports transfer module operation (optional)

Module Guide

The sf_el_ux module guide is targeted for SSP 1.2.0 and later and the SK-S7G2 Kit.

The most recent versions of the sf_el_ux module guide application note, application project and import guide are available here.

 

Module Guide Errata

Introduction: First paragraph removed, last sentence of second paragraph removed

The Express Logic USBX Synergy Port framework module (sf_el_ux) is integrated into the SSP. This driver is meant to be used with Express Logic USBX. For more information about USBX, including API references, refer to the USBX User Guide.

 

Section 2, API Overviews: Section reconstructed, should read:

Express Logic USBX Synergy Port Framework Module APIs Overview

The Express Logic USBX Synergy Port Framework module doesn’t have API calls of its own- it implements the API calls for the Express Logic USBX API calls. Documentation on these APIs is available in the Express Logic USBX User Manual.

 

Section 3.1.1:  Note added to Module Operational Notes

Note: The module uses the interrupt of a USB Controller. Set the appropriate interrupt priority level in the Synergy Configuration tool, otherwise it does not work. The module uses the interrupt of a Transfer module (implemented as DMAC or DTC) if it is used. Set the appropriate priority level in the Synergy Configuration tool. The level must be higher than the level for the USB Controller, otherwise it does not work.

 

Section 3.1.2:  3 bullet points removed, one added to Module Limitations

  • Synergy USB controllers (USBHS and USBFS) have a limited number of PIPEs you can use for the isochronous transfer type (PIPE1 and PIPE2). This will limit the number of UVC devices (two devices) you can connect to.
  • Refer to the most recent SSP Release Notes for any additional operational limitations for this module.

 

Section 4:  Including Module in an Application, text and screenshot added

The configurator has the capability to hide some modules from the user. This is done to simplify the selection of modules based on the context of the project. For example, some modules are not available for some MCUs, so if one of those MCUs is selected, these modules won’t be made available to add to a thread. The Express Logic USBX Synergy Port framework module is usually not added as a standalone module- it is usually added as a lower level module to a higher-level USB module. For the advanced user, a mode can be set to show all modules, not just those the configurator ‘thinks’ are appropriate for the current project. This mode must be enabled in order to see the Synergy Port module, as illustrated in the following figures.

SF_EL_UX_PortFig.PNG

Figure 4: Selecting the USBX Synergy Port Module When Hidden

This mode can be enabled by turning on the Synergy module developer mode. Simply select the Window dropdown on the top line of the ISDE and then select Preferences>C/C++>Renesas>Synergy Configurator Editor. Then check the box for Synergy module developer mode. Then click Apply. This will allow the configurator to show all modules, not just those useable in the current project. Make sure to come back and disable this mode, after using it for a specific case, to continue to benefit from the context aware view.

Once you can view the Synergy Port selections, to use the USBX Synergy Port in an application, simply add it to a thread using the stacks selection sequence given in the following table. (The default name for the USBX Synergy Port is g_sf_el_ux_hcd/dcd_hs/fs_0. This name can be changed in the associated Properties window.)

 

Section 5:  Configuration Tables updated

Table 4: Configuration Settings for Express Logic USBX Port DCD on sf_el_ux for USBFS

ISDE Property

Value

Description

Full Speed Interrupt Priority

Priority 0 (highest), Priority 1:2, Priority 3 (CM4: valid, CM0+: lowest- not valid if using ThreadX), Priority 4:14 (CM4: valid, CM0+: invalid), Priority 15 (CM4 lowest - not valid if using ThreadX, CM0+: invalid)

Default: Disabled

Select the priority level of the full speed interrupt.

LDO Regulator (Only for S3 and S1 MCUs)

Enable, Disable

 

Default: Disable

Select if the LDO regulator will be enabled.

Name

g_sf_el_ux_dcd_fs_0

Module name.

USB Controller Selection

USBFS

Select the USB controller.

 

Table 4: Configuration Settings for Express Logic USBX Port DCD on sf_el_ux for USBHS

ISDE Property

Value

Description

Full Speed Interrupt Priority

Priority 0 (highest), Priority 1:2, Priority 3 (CM4: valid, CM0+: lowest- not valid if using ThreadX), Priority 4:14 (CM4: valid, CM0+: invalid), Priority 15 (CM4 lowest - not valid if using ThreadX, CM0+: invalid)

Default: Disabled

Select the interrupt priority for high speed USB.

Name

g_sf_el_ux_dcd_hs_0

Module name.

USB Controller Selection

USBHS

Select the USB controller.

 

Configuration Settings for Express Logic USBX Port HCD on sf_el_ux for USBFS

ISDE Property

Value

Description

High Speed Interrupt Priority

Priority 0 (highest), Priority 1:2, Priority 3 (CM4: valid, CM0+: lowest- not valid if using ThreadX), Priority 4:14 (CM4: valid, CM0+: invalid), Priority 15 (CM4 lowest - not valid if using ThreadX, CM0+: invalid)

Default: Disabled

Select the interrupt priority for full speed USB.

VBUSEN pin Signal Logic

Active High, Active Low

 

Default: Active High

Select the VBUSEN pin signal logic.

LDO Regulator (Only for S3 and S1 MCUs)

Enable, Disable

 

Default: Disable

Select if the LDO regulator will be enabled.

Name

g_sf_el_ux_hcd_fs_0

Module name.

USB Controller Selection

USBFS

Select the USB controller.

 

Configuration Settings for Express Logic USBX Port HCD on sf_el_ux for USBHS

ISDE Property

Value

Description

High Speed Interrupt Priority

Priority 0 (highest), Priority 1:2, Priority 3 (CM4: valid, CM0+: lowest- not valid if using ThreadX), Priority 4:14 (CM4: valid, CM0+: invalid), Priority 15 (CM4 lowest - not valid if using ThreadX, CM0+: invalid)

Default: Disabled

Select the interrupt priority for high speed USB.

FIFO size for Bulk/Isochronous Pipes

512, 1024, 1536, 2048 bytes

 

Default: 512 bytes

Select the FIFO size for bulk and isochronous transfers.

Number of Isochronous Pipes Reserved

0,1,2

 

Default: 0

Select the number of isochronous pipes to reserve.

VBUSEN pin Signal Logic

Active High, Active Low

 

Default: Active High

Select the VBUSEN pin signal logic.

Enable High Speed

Enable, Disable

 

Default: Enable

Select if high speed should be enabled.

Name

g_sf_el_ux_dcd_fs_0

Module name.

USB Controller Selection

USBFS

Select the USB controller.

Note: The example values and defaults are for a project using the Synergy S7G2 MCU Family. Other MCUs may have different default values and available configuration settings.

Section 5: Paragraph and note at end of Configuration section removed.

 

Module Guide Resources

The following application projects use the sf_el_ux module and are available from the Renesas web site at the referenced url.

  • Communications Framework on USBX™ Module Guide - Application Project here.
  • NetX DHCP Client Module Guide- Application Project here.
  • NetX DNS: Getting Started Guide- Application project here.
  • Getting started with NetX DHCP- Application Project here.
  • Getting Started with NetX Duo DHCP- Application Project here.

Known issues

  • The Pool Size shown in Table# 12 is  32768 but it is actually 65536 in the application project.
  • Refer to the SSP release notes for known issues, available here.
Suitable Products
SSP 1.2.0 and above
  • 이 기사가 도움이 되셨나요?