Introduction
The purpose of this User Guide is to provide detailed information regarding the usage of MCAL configurator/generator package. Each MCAL driver has a driver implementation portion and a configurator/generator portion. The configurator portion is described in this user guide.
The TI MCAL uses Elektrobit Tresos for configuration of MCAL modules.
- MCAL module’s ECU parameter definition is captured in Elektrobit xdm format.
- MCAL modules are delivered in the form of EB Tresos plugins.
- The configuration of the MCAL modules can be done using the Elektrobit Tresos Configuration Editor.
- Once the configuration is complete, code can be generated for supported variants of the drivers.
Software Dependencies
Access to EB Tresos Tool and License
All required configurator installer are packaged with the configurator package. These installers are present at MCAL Configuration Install Directory
Document | Description |
EB_Tresos_ACG8.5.0_Installer.zip | EB Tresos Studio 24.x Installer. |
EB_Tresos_ACG8.8.10_Installer.zip | EB Tresos Studio 29.x Installer. |
EB_Client_License_Administrator_1_5_1_Setup.exe | EB Tresos License Administrator. |
EB_Tresos_Activation_Customer_License_TexasInstruments.pdf | Activation Key for License Administrator Setup |
- EB provides limited-pool of license that could be shared by TI with its customers
- Classified as limited-period license & permanent license
- Limited-period license are expected to be used during development (typically 3 months, 6 months) and permanent license for production
- In cases where development is greater than license validity period, TI can provide additional licenses
- Login to the below link, and Request Access to the EB Tresos Tool and License from here [License Request] (https://www.ti.com/secureresources/PROCESSOR-SDK-MCAL-EB-TRESOS)
- Once license are received
- Follows steps listed in (Tool Installation and Activation)
- IMPORTANT
- TI shares user details with EB on quarterly basis (name of organization and email id to whom license is released, fulfillment-id and user name). EB uses this data for license administration
- Share Fulfillment ID : Once license is activated, the "fulfillment-id" is to be shared with FAE/TI Engineer who provided license
- Third party (AUTOSAR Vendor / Other co-development organizations)
- TI can provide the EB licenses to other third party which is engaged by customers
- Steps and procedure will remain same as listed above
- Number of licenses
- Since TI receives finite-set of licenses from EB, TI will have to ration these among it's customers
- Based on customer needs / business needs number of license released to customer will be restricted
- Please request licenses on need basis
Note: Refer Release Notes or Getting Started section for more details on EB Tresos version related information.
Tool Installation and Activation
EB Tresos Installation can be segregated into three major steps:
- Installation of Client License Administrator as it requires an activation key for machine where EB would be installed.
- Installation of EB Tresos installer
- Elektrobit Tresos License Troubleshooting ( Optional step in case of any license related issues )
Client License Administrator Installation
- EB_Client_License_Administrator_1_5_1_Setup.exe
- Install the executable as an administrator. On successful installation you should see icon “EB Client License Administrator X.Y.Z” on your desktop.
- Launch EB Client License Administrator
- Enter the activation key provided.
- Click “Activate” button
- Check the status of the license activation sequence. If successful your license is ready to use.
Fig.2.1 EB Tresos License Activation
Note: For details refer LicensingUsersGuide.pdf Chapter 5 ({Installation Drive}/EB/EB_Client_License_Administrator/Doc/LicensingUsersGuide.pdf)
EB Tresos Tool Installation
- EB_Tresos_ACGX.X.X_Installer.zip
- Contains an self installing exe
- Ensure to install as an administrator
- On successful installation, an icon "Tresos Studio XX" would be created.
Fig.2.2 EB Tresos Tool Installation
Note: Post installation, launch “Tresos Studio XX.X” and confirm no license errors are seen.
Elektrobit Tresos License Troubleshooting
In cases where License Error are seen (post successful installation of Client License Administrator Client License Administrator), please try following steps
- Check if “Flexnet Licensing Service” service is started in the Windows Service Manager Panel (Control Panel -> Administrative Tools -> Services). If it is not started, please start it manually.
- Disable any "Anti Virus" software on the machine
- In cases where "Anti Virus" software cannot be disabled, please add user defined exceptions in "Anti Virus" software to the following folders (With the assumption that EB is installed in C Drive):
- "C:\EB\"
4. If license issues are still not resolved, contact EB support via Help->EB tresos support in EB tresos tool.
@section mcusw_cfg_ug_ref Reference EB Documentation
<hr>
<table class="markdownTable">
<tr class="markdownTableHead"> <th class="markdownTableHeadNone"> Document
Description
Link
2.1_Studio_documentation_users_guide.pdf
EB Tresos User Guide: Provides detailed information on using EB Tresos for configuration and code generation.
Official EB Tresos Documentation
LicensingUsersGuide.pdf
EB License Activation Guide: Explains how to activate EB licenses and use the EB Client License Administrator.
EB Licensing Guide
fnp_LicAdmin.pdf
FlexNet Licensing Tools Guide: Describes the usage of FlexNet licensing tools for managing EB licenses.
FlexNet Licensing Documentation
Please refer (MCUSW Configurator Install Directory/mcal_config/Elektrobit/docs)
Directory Structure
[Refer User Guide for Directory Structure] (MCAL) for top level directory structure, below diagram details mcal_config folder.
MCAL Configurator Directory Structure
A Typical Driver or Module Directory
A typical module would contain following files
- Module Definition
- Module.xdm : Module description
- Module.epd :
- Module_NonEB.xdm : EB/XDM provides advanced operations for parameter checking, which might not be supported by all configurators. These files excludes these parameter checks. One could use associated *_NonEB.xdm as module descriptor. Also refer (Generation of ARXML)
- Module Recommended values
- Module_Rec.xdm : Provides modules recommended values for TI EVM / MCAL example applications
- Code Generation Templates
- Module_Cfg.h : Provides template to generate header file
- Module_Cfg.c : Provides template to generate Compile Time module configurations.
- Module_Lcfg.c : Provides template to generate Link Time module configurations
- Module_PBcfg.c : Provides template to generate Post Build module configurations
- Module Details Module_Bswmd.arxml : Modules details such stack usage, files, exclusive area, etc...
- MANIFEST.MF : Licensing information of the module (required by EB)
- plugin.xml : Describes the module that would be used by EB tresos Studio GUI
A Typical Module Contents
Reference Modules
Texas Instruments provides MCAL modules for select peripheral of Automotive SoCs. Plugins are provided SOC specific, user has to select SOC specific plugins onto their project.
Other BSW or modules such Dem, EcuM, Os, etc... are included per SOC for validation of inter-module dependencies in the configurator. It's expected that these modules are replaced by modules provided by AUTOSAR vendor.
Getting started with EB Tresos
Copy plugins from mcusw repo to tresos
Below figures depict the steps required to generate MCAL module configurations Please ensure below, before attempting to generate configuration
- Close any open EB tresos instances
- Copy only Platform Specific MCAL plugins.(For Eg: Adc_TI_J722S for J722S, Adc_TI_J722S for J722S and Adc_TI_J722S for J722S)
- From mcusw_xx_yy_zz_bb/mcal_drv/mcal_config/config_input/soc folder to (EB Tresos Installation Dir>/plugins)
- Copy bsw stubs plugins like Os,Dem,EcuM provided with the package as some of the ecuc parameters like DEM errors have reference to these plugins.Please note that error/warning shall be reported if these plugins are not loaded along with the driver plugins while creating a new project. Please note that below are indicative snap-shots.SOC versions need to be selected based on SOC.
Note:
When copying plugins into EB Tresos, copy plugins for a single device at a time (e.g., AM62X or AM275X).
Avoid mixing plugins for different devices (e.g., AM62X and AM275X) as it may lead to conflicts or errors.
Create an EB project
Follow the below steps to Create EB Tresos project
- Launch the EB Tresos tool. On the Welcome Screen, Click on Start Icon.
Fig.2.5 Launch tresos Studio
- Now Click on File->New->Configuration Project to create a new project in the workspace.
Fig.2.6 New Configuration Project
- Enter the Project name and select the location. Then Click on Next > Button
>***Use Default Location** checkbox can be unchecked and custom location for the project can be provided*
When the GPTimer and PWM mdoule configurations are loaded in the configurator, if a particular Timer instance is already configured use by the GPTimer module, an error is reported. Please note that it is applicable only for Jacinto. SMPU/SPMCU does not support timer based PWM support.
- In the Configuration Project Data Window, Enter the appropriate name for the ECU instance for the configuration.
- Select the Target from the list as R5F/TDA4x and then Click on Next > Button.
Fig.2.8 Project Configuration Data
Load plugins
- In the Module Configuration Window, Select all the required plugins listed and add to module configuration.
Fig.2.9 EB module configuration
Fig.2.10 Choosen Required Modules
Note: If any Default configuration is present for the selected module, Ensure that Default Recommended Configuration is selected in Recommended Configuration section.
- Once All the required modules are added, click on next and then click on Finish Button to create the project.
- Created project and Modules can be seen in Project Explorer tab once the project created is completed.
Fig.2.11 EB Project Created
Generate plugins
- Load the Modules and configure according to the requirement and save the project.
- Click on Settings button down arrow button -> Unattended wizard configurations.
Fig.2.12 EB Unattended Wizard Configuration
- Check AutoCalc (Calculate Derivable Values) checkbox and select default values and calculated values checkbox and click on Run to auto-calculate derivable values.
Fig.2.13 EB Unattended Wizard Config Dialog
Note: Unattended wizard configurations settings needs to be configured once during configuration of project where AutoCalc (Calculate Derivable Values) checkbox needs to be set. Post settings are done just clicking on the settings icon->AutoCalc will auto calculate all the values and any other configuration updates in the project.
- Right Click on the project in the Project explorer and choose Verify Project to see any errors or warnings in the configuration.
Fig.2.14 Configuration Created
- Next Right Click on the project in the Project explorer and choose Generate Project to generate the Output Files.
- Generated Files will be present in output folder.
For more details on how to configure AUTOSAR modules using EB tresos studio, Refer 2.1_Studio_documentation_users_guide.
Generation using tresos Studio Command Line Interface
Optionally MCAL module configurations could be generated using tresos batch file and recommended configuration of a given module. The following steps details the sequence of operations required. Based on the SOC, you need to select corresponding plugins. Below is shown for J722S SOC.
- The command below could be used
C:\EB\tresos\bin\tresos_cmd.bat -Decuid=mcal_example_config_1 -Dtarget=R5F -Dderivate=J722S legacy generate -n Can -g Can_TI_J722S -o c:\temp mcusw_xx_yy_zz_bb\mcal_drv\mcal_config\plugins\Can_TI_J722S\config_ext\Can_Rec.xdm
Options used are
-Decuid
Specifies the ID of the imported ECU
-Dtarget
Defines the target architecture ECU
-Dderivate
Defines the targets derivate
-n
Specifies the name of the module configurations of the configuration files to load
-g
Module Id
-o
Sets the directory to which the generated files are written
Generation of EPD and ARXML
EB Tresos provides utility to convert XDM files to EPD or ARXML module definitions. As noted in (A Typical Driver or Module Directory) XDM provides additional functionality that aids parameter checking. This feature might not be supported by other vendors. An additional module description is provided that do not use these EB specific parameter checking and these are named as (Module Name)_NonEB.xdm
Please use (Module Name)_NonEB.xdm to generate epd or arxml files
Generation of EPD
- Open a command prompt
- Go to mcusw configurator install directory (i.e. mcusw_xx_yy_zz/mcal_drv/mcal_config/plugins)
- Assuming EB is installed in "C:/EB", run the command below to generate EPD for Can module.Based on the SOC, you need to select corresponding plugins. Below is shown for J722S SOC.
C:\EB\tresos\bin\tresos_cmd.bat -Duuids=true -DecuParamDef=true -DValidate=true -DrestrictShortName=true -DwriteDefaults=true legacy convert
mcusw_xx_yy_zz_bb\mcal_drv\mcal_config\plugins\Can_TI_J722S\config\Can_NonEB.xdm
mcusw_xx_yy_zz_bb\mcal_drv\mcal_config\plugins\Can_TI_J722S\config\Can.epd@asc:4.3.1
Generation of ARXML
- Open a command prompt
- Go to mcusw configurator install directory (i.e. mcusw_xx_yy_zz/mcal_drv/mcal_config/plugins)
- Assuming EB is installed in "C:/EB", run the command below to generate ARXML for Can module.Based on the SOC, you need to select corresponding plugins. Below is shown for J722S SOC.
C:\EB\tresos\bin\tresos_cmd.bat -DValidate=false -DwriteXPathAttributes=false legacy convert
mcusw_xx_yy_zz_bb\mcal_drv\mcal_config\plugins\Can_TI_J722S\config\Can_NonEB.xdm
mcusw_xx_yy_zz_bb\mcal_drv\mcal_config\plugins\Can_TI_J722S\Can_J722s.arxml@asc:4.3.1
- Please note that if there are warning(s) on use of XPATH, please rerun with
DwriteXPathAttributes=true
- The generated arxml was validated using a compliance checker.
Run Export
The Configurations generated in EB Tresos can be exported to other configuration tools like DaVinci Configurator, ETAS ISOLAR-AB etc.
To export the configuration from EB to AUTOSAR XML (ARXML) format, following steps can be followed :
- Right-Click the EB Project from the workspace which needs to be exported
- Click on Im- and Exporters....
Fig.2.17 Export configurations
- Click on Create new Im- or Exporter button (+ Symbol).
Fig.2.18 Create New Exporter
- Fill the Name and select Mode as Export Only and Click on Next Button.
Fig.2.19 Exporter Name
- In the next window, click on browse and select the file.
Fig.2.20 Exporter select File
- Select Autosar version as 4.3.1, and Click Finish.
Fig.2.21 AS Version Select
- Select the exporter and click on Run Exporter button.
Fig.2.22 EB Run Exporter
Note: Once the Exporter run is successful, the generated arxml file can be used as the input file to the other configurator tools.