3 - AUTOSAR_WDG_Component_UserManuals
AUTOSAR MCAL R4.0.3
User‟s Manual
WDG Driver Component Ver.1.0.4
Embedded User‟s Manual
Target Device:
RH850/P1x
All information contained in these materials, including products and product specifications,
represents information on the product at the time of publication and is subject to change by
Renesas Electronics Corp. without notice. Please review the latest information published by
Renesas Electronics Corp. through various means, including the Renesas Electronics Corp.
website
(http://www.renesas.com). www.renesas.com Rev.0.01 Apr 2015
2
Notice
1.
All information included in this document is current as of the date this document is issued. Such information, however, is subject to
change without any prior notice. Before purchasing or using any Renesas Electronics products listed herein, please confirm the latest
product information with a Renesas Electronics sales office. Also, please pay regular and careful attention to additional and different
information to be disclosed by Renesas Electronics such as that disclosed through our website.
2.
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.
3.
You should not alter, modify, copy, or otherwise misappropriate any Renesas Electronics product, whether in whole or in part.
4.
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.
5.
When exporting the 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. You should not use Renesas Electronics products
or the 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. 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.
6.
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.
7.
Renesas Electronics products are classified according to the following three quality grades: "Standard", "High Quality", and
"Specific". The recommended applications for each Renesas Electronics product depends on the product's quality grade, as indicated
below. 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 categorized as "Specific" without the prior written consent of Renesas
Electronics. Further, you may not use any Renesas Electronics product for any application for which it is not intended without the
prior written consent of Renesas Electronics. 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 an application categorized as "Specific" or for which
the product is not intended where you have failed to obtain the prior written consent of Renesas Electronics. The quality grade of
each Renesas Electronics product is "Standard" unless otherwise expressly specified in a Renesas Electronics data sheets or data
books, etc.
"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.
"High Quality": Transportation equipment (automobiles, trains, ships, etc.); traffic control systems; anti-disaster systems; anti- crime
systems; safety equipment; and medical equipment not specifically designed for life support.
"Specific":
Aircraft; aerospace equipment; submersible repeaters; nuclear reactor control systems; medical equipment or
systems for life support (e.g. artificial life support devices or systems), surgical implantations, or healthcare
intervention (e.g. excision, etc.), and any other applications or purposes that pose a direct threat to human life.
8.
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.
9.
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 system manufactured by you.
10.
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.
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.
3
4
Abbreviations and Acronyms Abbreviation / Acronym Description ADC
Analog Digital Converter
ANSI
American National Standards Institute
API
Application Programming Interface
AUTOSAR
Automotive Open System ARchitecture
CAN
Controller Area Network
DEM
Diagnostic Event Manager
DET/Det
Development Error Tracer
DIO
Digital Input And Output
ECU
Electronic Control Unit
EEPROM
Electrical Erasable Programmable Read Only Memory
ID/Id
Identifier
ISR
Interrupt Service Routine
LIN
Local Interconnect Network
MCAL
Microcontroller Abstraction Layer
MCU
MicroController Unit
PWM
Pulse Width Modulation
RAM
Random Access Memory
ROM
Read Only Memory
SCI
Serial Communication Interface
SPI
Serial Peripheral Interface
WDG/wdg
WatchDog
WDT
WatchDog Timer
WDGIF
WatchDog Interface
CDD
Complex Device Driver
Definitions Term Represented by Sl. No.
Serial Number
WDTAEVAC
Watchdog Timer Enable Register for Varying Activation Code
WDTAMD
Watchdog Timer Mode Register
WDTAWDTE
Watchdog Timer Enable Register for Fixed Activation Code
5
6
Table Of Contents Chapter 1 Introduction ..................................................................... 11 1.1. Document Overview ........................................................................................................... 13 Chapter 2 Reference Documents ..................................................... 15 Chapter 3 Integration And Build Process ....................................... 17 3.1. WDG Driver Component Makefile ..................................................................................... 17 3.1.1. Folder Structure.................................................................................................... 17 Chapter 4 Forethoughts ................................................................... 19 4.1. General ................................................................................................................................. 19 4.2. Preconditions ...................................................................................................................... 20 4.3. Data Consistency ................................................................................................................ 20 4.4. WDG State Diagram ............................................................................................................ 21 4.5. WDTA 75% ISR Usage Details for R4.0.3 .......................................................................... 22 4.6. Deviation List ...................................................................................................................... 24 4.7. User mode and supervisor mode ...................................................................................... 25 4.8. Register Read-Back ............................................................................................................ 25 Chapter 5 Architecture Details ......................................................... 27 Chapter 6 Registers Details ............................................................. 29 Chapter 7 Interaction Between The User And WDG Driver
Component .......................................................................................... 31 7.1. Services Provided By WDG Driver Component To the User .......................................... 31 Chapter 8 WDG Driver Component Header And Source File
Description .......................................................................................... 33 Chapter 9 Generation Tool Guide .................................................... 35 Chapter 10 Application Programming Interface ............................... 37 10.1. Imported Types ................................................................................................................... 37 10.1.1. Standard Types .................................................................................................... 37 10.1.2. Other Module Types ............................................................................................. 37 10.2. Type Definitions .................................................................................................................. 37 10.2.1. Wdg_59_DriverA_ConfigType .............................................................................. 37 10.3. Function Definitions ........................................................................................................... 38 Chapter 11 Development And Production Errors ............................. 39 11.1. WDG Driver Component Development Errors ................................................................. 39 11.2. WDG Driver Component Production Errors ..................................................................... 39 7
Chapter 12 Memory Organization ...................................................... 41 Chapter 13 P1M Specific Information ................................................ 43 13.1. Interaction Between The User And WDG Driver Component .......................................... 43 13.1.1. ISR Function Mapping Interrupt Vector Table ...................................................... 43 13.1.2. Translation Header File ........................................................................................ 43 13.1.3. Parameter Definition File ...................................................................................... 44 13.2. Sample Application............................................................................................................. 44 13.2.1 Sample Application Structure ............................................................................... 44 13.2.2 Building Sample Application ................................................................................. 46 13.2.2.1 Configuration Example ..................................................................... 46 13.2.2.2 Debugging The Sample Application ................................................. 46 13.3. Memory and Throughput for R4.0.3 .................................................................................. 47 13.3.1 ROM/RAM Usage ................................................................................................ 47 13.3.2 Stack Depth .......................................................................................................... 48 13.3.3 Throughput Details ............................................................................................... 48 Chapter 14 Release Details ................................................................ 49
8
List Of Figures Figure 1-1 System Overview Of AUTOSAR Architecture ...................................................... 11 Figure 1-2 System Overview Of The WDG Driver In AUTOSAR MCAL Layer ...................... 12 Figure 4-1 State Diagram of WDG when WdgDisableAllowed is true .................................... 21 Figure 4-2 State Diagram of WDG when WdgDisableAllowed is false .................................. 21 Figure 4-3 WDG behavior during Data exchange with hardware ........................................... 22 Figure 4-4 WDG behavior when Wdg_SetTriggerCondition is called ................................... 23 Figure 5-1 Watch Driver And Watchdog Interface Architecture ............................................ 27 Figure 5-2 Basic Architecture Of WDG Component .............................................................. 28 Figure 12-1 Memory Organization Of WDG Driver Component .............................................. 41 Figure 13-1 Overview Of WDG Driver Sample Application ..................................................... 44 List Of Tables
Table 4-1 WDG Driver Deviation List ................................................................................... 24 Table 4-2 Supervisor mode and User mode details ............................................................. 25 Table 4-3 Registers categorization definition ....................................................................... 25 Table 4-4 Watchdog module Static Register Table .............................................................. 26 Table 6-1 Register Details .................................................................................................... 29 Table 8-1 Description Of The WDG Driver Component Files ............................................... 34 Table 10-1 APIs provided by the WDG Driver Component .................................................... 38 Table 11-1 DET Errors Of WDG Driver Component .............................................................. 39 Table 11-2 DEM Errors Of WDG Driver Component .............................................................. 40 Table 13-1 Interrupt Vector Table .......................................................................................... 43 Table 13-2 PDF information for P1M ...................................................................................... 44 Table 13-8 ROM/RAM Details Without DET .......................................................................... 47 Table 13-9 ROM/RAM Details With DET ............................................................................... 48 Table 13-10 Throughput Details Of The APIs .......................................................................... 48 9
10
Introduction Chapter 1 Chapter 1 Introduction The purpose of this document is to describe the information related to WDG
Driver Component for Renesas P1x microcontrollers.
This document shall be used as reference by the users of WDG Driver
Component. The system overview of complete AUTOSAR architecture is
shown in the below Figure:
Application Layer
AUTOSAR RTE
System Services
On board Device Abstraction
WDG Driver Microcontroller
Figure 1-1 System Overview Of AUTOSAR Architecture The WDG Component comprises embedded software and the Configuration
Tool to achieve scalability and configurability.
The WDG Generation Tool is a command line tool that accepts ECU
configuration description files as input and generates source and header files.
The configuration description is an ARXML file that contains information about
the configuration for Watchdog timer. The tool generates the
Wdg_59_DriverA_PBcfg.c and Wdg_59_DriverA_Cfg.h for Watchdog
Driver A.
11
Chapter 1 Introduction The Figure in the following page depicts the WDG Driver as part of layered
AUTOSAR MCAL Layer:
Microcontroller Drivers
Memory Drivers
Communication Drivers
I/O Drivers
In
Ex
In
te
Wa t
r
te
e
n
GP
M
r
a
Fl
tcr
P
n
C
R
n
l
PWM
CU
a
C
L
e
A
I
D
O
ha
E
CU
o
A
T
l
I
A
x
DC
I
dl
r
M
EP
N
R
O
R
F
N
o e
F
g l
ay
l
a
T
a
R
s
s
h
O
h
M
E
P
GP
W
x
F
E
L
CA
IC
P
Cl
o
M
t.
L
E
SPI
A
S
I
DI
w
N
W
D
Micro B
A
M
P
o
CU
C
U
DC
N
T
e
T
ck
US
S
RO
O
r
I
o
M
&
H
r
Controller Figure 1-2 System Overview Of The WDG Driver In AUTOSAR MCAL Layer Watchdog Driver module provides the services for initializing, changing the
operation mode and triggering the watchdog.
12
Introduction Chapter 1 1.1. Document Overview The document has been segmented for easy reference. The table below
provides user with an overview of the contents of each section:
Section Contents Section 1 (Introduction)
This section provides an introduction and overview of WDG Driver
Component.
Section 2 (Reference Documents) This section lists the documents referred for developing this document.
Section 3 (Integration And Build
This section explains the folder structure, Makefile structure for WDG
Process)
Driver Component. This section also explains about the Makefile
descriptions, Integration of WDG Driver Component with other
components, building the WDG Driver Component along with a sample
application.
Section 4 (Forethoughts)
This section provides brief information about the WDG Driver
Component, the preconditions that should be known to the user before it
is used, data consistency details, WDG State Diagram, WDTA 75% ISR
Usage Details, deviation list, Support For Different Interrupt Categories,
user-mode and supervisor mode API support list, register read-back.
Section 5 (Architecture Details)
This section describes the layered architectural details of the WDG
Driver Component.
Section 6 (Register Details)
This section describes the register details of WDG Driver Component.
Section 7 (Interaction Between
This section describes interaction of the WDG Driver Component with
The User And WDG Driver
the upper layers.
Component)
Section 8 (WDG Driver
This section provides information about the WDG Driver Component
Component Header And Source
source files is mentioned. This section also contains the brief note on the
File Description)
tool generated output file.
Section 9 (Generation Tool Guide) This section provides information on the WDG Driver Component Code
Generation Tool.
Section 10 (Application
This section explains all the APIs provided by the WDG Driver
Programming Interface)
Component.
Section 11 (Development And
This section lists the DET and DEM errors.
Production Errors)
Section 12 (Memory
This section provides the typical memory organization, which must be
Organization)
met for proper functioning of component.
Section 13 (P1M Specific
This section provides the P1M Specific Information.
Information)
Section 14 (Release Details)
This section provides release details with version name and base
version.
13
Chapter 1 Introduction 14
Reference Documents Chapter 2 Chapter 2 Reference Documents Sl. No. Title Version 1.
Autosar R3.2
2.3.0
AUTOSAR_SWS_WatchdogDriver.pdf
2.
Autosar R4.0
2.5.0
AUTOSAR_SWS_WatchdogDriver.pdf
3.
AUTOSAR BUGZILLA (http://www.autosar.org/bugzilla) -
Note: AUTOSAR BUGZILLA is a database, which contains concerns raised
against information present in AUTOSAR Specifications.
4.
r01uh0436ej0070_rh850p1x.pdf
0.70
5.
AUTOSAR_SWS_CompilerAbstraction.pdf
3.2.0
6.
AUTOSAR_SWS_MemoryMapping.pdf
1.4.0
7.
AUTOSAR_SWS_PlatformTypes.pdf
2.5.0
8.
AUTOSAR_BSW_MakefileInterface.pdf
0.3
15
Chapter 2 Reference Documents 16
Integration And Build Process Chapter 3 Chapter 3 Integration And Build Process In this section the folder structure of the WDG Driver Component is explained.
Description of the Makefiles along with samples is provided in this section.
Remark The details about the C Source and Header files that are generated by the
WDG Driver Generation Tool are mentioned in the
“AUTOSAR_WDG_Tool_UserManual.pdf”.
3.1. WDG Driver Component Makefile The Makefile provided with the WDG Driver Component consists of the GNU
Make compatible script to build the WDG Driver Component in case of any
change in the configuration. This can be used in the upper level Makefile (of
the application) to link and build the final application executable.
3.1.1. Folder Structure The files are organized in the following folders:
Remark Trailing slash „\‟ at the end indicates a folder
X1X\common_platform\modules\wdg\src\ Wdg_59_DriverA.c
\Wdg_59_DriverA_Irq.c
\Wdg_59_DriverA_Private.c
\Wdg_59_DriverA_Ram.c
\Wdg_59_DriverA_Version.c
X1X\common_platform\modules\wdg\include\Wdg_59_DriverA.h
\Wdg_59_DriverA_Debug.h
\Wdg_59_DriverA_Irq.h
\Wdg_59_DriverA_PBTypes.h
\Wdg_59_DriverA_Private.h
\Wdg_59_DriverA_Ram.h
\Wdg_59_DriverA_RegReadBack.h
\Wdg_59_DriverA_Types.h
\Wdg_59_DriverA_Version.h
X1X\P1x\modules\wdg\sample_application\<SubVariant>\make\<Complier>
\App_WDG_P1M_Sample.mak
X1X\P1x\modules\wdg\sample_application\<SubVariant>\obj\<Complier>
(Note: For example compiler can be ghs.)
X1X\P1x\modules\wdg\generator
17
Chapter 3 Integration And Build Process \R403_WDG_P1x_BSWMDT.arxml
X1X\common_platform\modules\wdg\generator\Wdg_X1x.exe
X1X\P1x\common_family\generator
\Sample_Application_P1x.trxml
\P1x_translation.h
X1X\P1x\modules\wdg\user_manual
(User manuals will be available in this folder)
Notes: 1. <Compiler> can be ghs.
2. <SubVariant> can be P1M.
3. <AUTOSAR_version> should be 4.0.3.
18
Forethoughts Chapter 4 Chapter 4 Forethoughts 4.1. General Following information will aid the user to use the WDG Driver Component
software efficiently:
•
The WDG Component does not enable or disable the ECU or
Microcontroller power supply. The upper layer should handle this
operation.
•
Option byte values required for the operation of watchdog will be flashed
through Start up code.
•
The WDG Component does not implement any scheduled functions.
•
WDG Component does not implement any Call Back Notification functions.
•
Example code mentioned in this document shall be taken only as a
reference for implementation.
•
The Watchdog hardware supports only Driver A. Hence, WDG Driver
Component is implemented as Driver A. WDG_DRIVER_INSTANCE
variable of Base Make file is updated for Driver A.
•
All development errors will be reported to Det by using the API
Det_ReportError() provided by DET.
•
All production errors will be reported to Dem by using the API
Dem_ReportErrorStatus() provided by DEM.
•
"It should be ensured that the respective clock source is switched ON
before Watchdog is set to corresponding Clock Unit in
Wdg_59_DriverA_Init() API.
•
The API Wdg_59_DriverA_SetTriggerCondition() initializes the trigger
counter global variable with timeout value divided by either slow or fast time
Value generated by the configuration.
•
For WDG Reset functionality in debug mode, unmask the reset in debug
mode during debug session with GHS command "target pinmask k".
•
The file Interrupt_VectorTable.c provided is just a Demo and not all
interrupts will be mapped in this file. So the user has to update the
Interrupt_VectorTable.c as per his configuration.
19
Chapter 4 Forethoughts 4.2. Preconditions Following preconditions have to be adhered by the user, for proper
functioning of the WDG Driver Component:
•
The user should ensure that WDG Component API requests are invoked in
the correct and expected sequence along with correct input arguments.
•
User should ensure that the appropriate option bytes are flashed for the
configured mode in the watchdog driver module.
•
Validation of input parameters are done only when the static configuration
parameter WDG_59_DRIVERA_DEV_ERROR_DETECT is enabled.
Application should ensure that the right parameters are passed while
invoking the APIs when WDG_59_DRIVERA_DEV_ERROR_DETECT is
disabled.
•
A mismatch in the version numbers will result in compilation error. Ensure
that the correct versions of the header and the source files are used.
•
The files Wdg_59_DriverA_Cfg.h and Wdg_59_DriverA_PBcfg.c
generated using watchdog driver generation tool has to be linked along
with WDG Component source files.
•
File Wdg_59_DriverA_PBcfg.c generated for single configuration set using
Watchdog Driver Generation Tool can be compiled and linked
independently.
•
The WDG Component needs to be initialized before accepting any API
requests. Wdg_59_DriverA_Init should be called by the ECU State
Manager Module to initialize WDG Component. It should not be called
more than once.
4.3. Data Consistency To support the re-entrance and interrupt services, the AUTOSAR WDG
component will ensure the data consistency while switching the watchdog
mode and during the watchdog trigger routine. The WDG Driver component
will use SchM_Enter_Wdg and SchM_Exit_Wdg functions. The
SchM_Enter_Wdg function is called before the data needs to be protected
and SchM_Exit_Wdg function is called after the data is accessed.
The following exclusive areas along with scheduler services are used to
provide data integrity for shared resources:
TRIGG_PROTECTION
MODE_SWITCH_PROTECTION
The protection areas TRIGG_PROTECTION and
MODE_SWITCH_PROTECTION are used to protect the WDG
triggering and WDG mode switching respectively.
The functions SchM_Enter_Wdg and SchM_Exit_Wdg can be disabled by
disabling the configuration parameter „WdgCriticalSectionProtection‟.
20
Forethoughts Chapter 4 4.4. WDG State Diagram The State diagram of WDG Driver is as shown below
Figure 4-1 State Diagram of WDG when WdgDisableAllowed is true
WDG Driver supports following modes when configuration parameter
WdgDisableAllowed is true.
1.WDGIF_OFF_MODE
2.WDGIF_SLOW_MODE
3.WDGIF_FAST_MODE
No Initialization
Wdg_59_DriverA_Init() with
Wdg_59_DriverA_Init() with
WDGIF_S LOW_MODE
WDGIF_FAST_MODE
FAST
SLOW
Figure 4-2 State Diagram of WDG when WdgDisableAllowed is false 21
Chapter 4 Forethoughts WDG Driver supports following modes when configuration parameter
WdgDisableAllowed is false
1. WDGIF_SLOW_MODE
2. WDGIF_FAST_MODE
Like shown in the above figures when WDG Driver is initialized by the API
Wdg_59_DriverA_Init(), the WDG Driver gets into one of the modes based on
the default value configured during configuration. Also the modes can be
changed by the API Wdg_59_DriverA_SetMode() only once after
Wdg_59_DriverA_Init(), if the current mode is WDGIF_OFF_MODE.
4.5. WDTA 75% ISR Usage Details for R4.0.3 WDG Driver using '75% interrupt output' feature services the Watchdog
hardware to trigger watchdog hardware as long as the trigger condition is
valid. If the trigger condition becomes invalid the Wdg Driver stops triggering
and the watchdog expires.
Maximum counter
value 0xFFFF
75% of maximum
counter value
Counter Value
Wdg_59_DriverA_Init()
75% of Time Period
Reset Release
Wdg_59_DriverA_SetTriggerCondition()
Wdg_59_DriverA_SetTriggerCondition()
INTWDTn(75% Interrupt)
WDG Trigger
B
A
A
WDTAnTRES
Figure 4-3 WDG behavior during Data exchange with hardware
22
Forethoughts Chapter 4
Figure 4-4 WDG behavior when Wdg_SetTriggerCondition is called Note User should adjust the Timeout value in such a way that the corrections of 'A‟
and 'B' are considered while passing the 'timeout' value to API
'Wdg_59_DriverA_SetTriggerCondition‟.
The above figure illustrates the scenario where
Wdg_59_DriverA_SetTriggerCondition API
is called before the expiry of the Initial Timeout value.
The 75% duration calculation for one WDG trigger cycle in slow mode WDTATCKI = 240 kHz
For example considering current mode settings = WDTATCKI/2^16
Period = 2^16/240k = 0.273 sec
Total window time = 273 msec
75% interrupt time = 204.7 msec
Generation tool will round off the 75% interrupt time “204.7 msec” to “205
msec” and rounded value is displayed on the command prompt. For the
above example the information on command prompt for slow mode will be
displayed as given below.
The duration of 75% of one WDG trigger cycle for slow mode is <205
msec> If the timeout value passed by the API Wdg_59_DriverA_Settriggercondition
is 410 msec, then the counter value will be calculated in the WDG Driver as
2.
23
Chapter 4 Forethoughts The duration of 75% of one WDG trigger cycle calculation for fast mode WDTATCKI = 240 kHz
For example considering current mode settings = WDTATCKI/2^9
Period = 2^9/240k = 0.0021 sec
Total window time = 2.1 msec
75% interrupt time = 1.5 msec
Generation tool will round off the 75% interrupt time “1.5 msec” to “2 msec”
and rounded value is displayed on the command prompt. For the above
example the information on command prompt for fast mode will be displayed
as given below.
The duration of 75% of one WDG trigger cycle for fast mode is <2
msec> If the timeout value passed by the API
Wdg_59_DriverA_Settriggercondition() is 50 msec, then the counter value
will be calculated in the WDG Driver as 25.
The API Wdg_59_DriverA_SetTriggerCondition() will not trigger the
watchdog hardware it will only calculate the trigger counter value.
In General the user should use the below formula while calculating the
Timeout Period by considering the corrections of 75% duration round off, A
and B values.
Timeout Period = (Trigger Count)* (75% of Time Period + A)+B
where „A” is the time required for the ISR to trigger the WDG hardware and
„B‟ is the time gap between Wdg_59_DriverA_SetTriggerCondition() execution
and next WDG trigger from 75% ISR.
4.6. Deviation List Table 4-1 WDG Driver Deviation List Sl. No. Description AUTOSAR Bugzilla 1.
"WDG_SETTINGS_SLOW" and
-
"WDG_SETTINGS_FAST" is configured from the list of
clock selections (16 choices are possible) and depending
on the mode configured for "WDG_DEFAULT_MODE",
watchdog settings is initialized in the API
Wdg_59_DriverA_Init().
2.
The requirement 'WDG025' is handled in the generation
-
tool itself by the error 'ERR102009'.
3.
If the API Wdg_59_DriverA_SetTriggerCondition, is
-
invoked with the timeout value "0" will not result in
instantaneous watchdog reset of the ECU like mentioned
in WDG140, instead the trigger counter will be set to "0"
and watchdog reset will occur after the WatchDog counter
value has reached its maximum value.
4.
The API Wdg_59_DriverA_GetVersionInfo is
-
implemented as macro without DET error
Wdg_59_DriverA_E_PARAM_POINTER.
24
Forethoughts Chapter 4 4.7. User mode and supervisor mode The below table specifies the APIs which can run in user mode, supervisor
mode or both modes
Table 4-2 Supervisor mode and User mode details Sl.No API Name User Mode Supervisor mode 1
Wdg_59_DriverA_Init
-
x
2
Wdg_59_DriverA_SetMode
x
x
3
Wdg_59_DriverA_SetTriggerCondition
x
x
4
Wdg_59_DriverA_GetVersionInfo
x
x
4.8. Register Read-Back Categorization of registers Register read-back is a functional safety based implementation were all the
registers used in the module are categorized into two different category which
are as fallows
1
Static registers.
2 Dynamic registers.
Static Registers: Static registers is defined as the registers which are written only in
Wdg_59_DriverA_Init () API and not changed during runtime.
Dynamic Registers: Dynamic register is defined as the register which are written during runtime
API‟s independently to that of it is used in Wdg_59_DriverA_Init ().
Table 4-3 Registers categorization definition Static Registers Dynamic Registers HW Write-read-verify performed for each
Write-read-verify performed for each register
Register register write. DEM report in case of
write. DEM report in case of error.
error.
RAM Only for static registers same value
Write-read-verify performed for each register
mirror as written to the register is written to
write. DEM report in case of error.
RAM mirror.
Register read-back In register read-back implementation each register which is written in the WDG
timer is verified by doing read-back on that registers. However a global copy of
the register value is always kept in the RAM for static registers and a global
copy is not made for dynamic registers. These variables can be used to verify
the registers in CDD.
25
Chapter 4 Forethoughts In the below table, details about the static register, global mirror variable and
mask value to be used in connective with the register is provided. The Global
mask provided in the table is of logical “&” based mask
Table 4-4 Watchdog module Static Register Table Sl.No. Register Global Mirror variable Global Mask Variable Name 1.
Wdg_59_DriverA_GulIMR1Mask
IMR0
Wdg_59_DriverA_GulIMR1Mirror
(0xFFFFFDFF)
26
Architecture Details Chapter 5 Chapter 5 Architecture Details The WDG Driver architecture is shown in the following figure. The WDG user
shall directly use the APIs to configure and execute the WDG conversions:
Watchdog Interface
Watchdog Driver Hardware Registers
Figure 5-1 Watch Driver And Watchdog Interface Architecture Watchdog Interface invokes the corresponding Driver. The Driver APIs will
access the hardware register of the Watchdog Timers for changing the mode
and trigger the Watchdog Timer.
Watchdog Driver component:
The Watchdog Driver component is composed of following modules:
•
Watchdog Driver Initialization module
•
Watchdog Driver SetMode module
•
Watchdog Driver SetTriggerCondition module
•
Watchdog Driver VersionInfo module
27
Chapter 5 Architecture Details The basic architecture of the Watchdog Driver component is illustrated in the
following figure:
Watch Dog Driver Initialization Module SetMode Module SetTriggerCondition VersionInfo Module Module Figure 5-2 Basic Architecture Of WDG Component
Watchdog Driver Initialization module:
This module initializes the watchdog driver and watchdog hardware. It
provides the API Wdg_59_DriverA_Init(). This API should be invoked before
the usage of any other APIs of Watchdog Driver Module.
Watchdog Driver SetMode module:
This module will handle the functionality for setting the modes. It provides the
API Wdg_59_DriverA_SetMode(). Following are the possible mode settings:
•
WDGIF_SLOW_MODE
•
WDGIF_FAST_MODE
Remark The above settings are configured using the WDTAMD register. SetMode will
support mode switch as described in the
chapter 4.4 WDG State Diagram.
SetMode API will set module‟s state to WDG_BUSY during execution and
reset the module‟s state to WDG_IDLE before return.
Watchdog Driver SetTriggerCondition module:
This module will handle the functionality to reset the watchdog timeout
counter according to the timeout value passed. It provides the API
Wdg_59_DriverA_SetTriggerCondition.
There are two types of Activation codes to trigger the Watchdog. They are
•
Fixed Activation Code.
•
Varying Activation code.
Depending on the Activation code chosen, this function has to trigger the
corresponding register.
•
WDTAWDTE register will be used for Fixed Activation Code.
•
WDTAEVAC register will be used for Varying Activation Code.
Watchdog Driver VersionInfo module:
This module will provide the current version of the Watchdog Driver Module. It
contains the API Wdg_59_DriverA_GetVersionInfo().
28
Registers Details Chapter 6 Chapter 6 Registers Details This section describes the register details of WDG Driver Component.
Table 6-1 Register Details API Name Registers Config Parameter Macro/Variable Wdg_59_DriverA_Init
IMRn
WdgErrorModeSetting WDG_59_DRIVERA_INTWDTIM
R_MASK
WDTAnMD
WdgDefaultMode
ucWdtamdDefaultValue.
Wdg_59_DriverA_SetMode
WDTAnMD
-
ucWdtamdSlowValue,
ucWdtamdFastValue
Autosar R4.0:
-
-
-
Wdg_59_DriverA_SetTriggerCon
dition
Wdg_59_DriverA_GetVersionInfo -
-
-
Wdg_59_DriverATrigger
WDTAnEVAC -
WDG_59_DRIVERA_RESTART -
WDG_59_DRIVERA_WDTAREF
_ADDRESS
WDTAnWDT
-
WDG_59_DRIVERA_RESTART
E
WDTAnREF
-
-
29
Chapter 6 Registers Details 30
Interaction Between The User And WDG Driver Component Chapter 7 Chapter 7 Interaction Between The User And WDG Driver Component The details of the services supported by the WDG Driver Component to the
upper layer users are provided in the following sections:
7.1. Services Provided By WDG Driver Component To the
User The WDG Driver Component provides the following functions to upper layers:
•
To Initialize Watchdog Timer
•
To Set the Mode of the Watchdog Timer
•
To handle the functionality of calculating the trigger counter value
•
To Read the WDG Component Version Information.
31
Chapter 7 Interaction Between The User And WDG Driver Component 32
WDG Driver Component Header And Source File Description Chapter 8 Chapter 8 WDG Driver Component Header And Source File Description This section explains the WDG Driver Component‟s C Source and C Header
files. These files have to be included in the project application while
integrating with other modules.
The C header file generated by WDG Driver Generation Tool:
•
Wdg_59_DriverA_Cfg.h
The C source file generated by WDG Driver Generation Tool:
•
Wdg_59_DriverA_PBcfg.c
The WDG Driver Component C header files:
•
Wdg_59_DriverA.h
•
Wdg_59_DriverA_Debug.h
•
Wdg_59_DriverA_Irq.h
•
Wdg_59_DriverA_PBTypes.h
•
Wdg_59_DriverA_Private.h
•
Wdg_59_DriverA_Ram.h
•
Wdg_59_DriverA_Types.h
•
Wdg_59_DriverA_Version.h
•
Wdg_59_DriverA_RegReadBack.h
The WDG Driver Component source files:
•
Wdg_59_DriverA.c
•
Wdg_59_DriverA_Irq.c
•
Wdg_59_DriverA_Private.c
•
Wdg_59_DriverA_Ram.c
•
Wdg_59_DriverA_Version.c
The port specific C header files:
•
Compiler.h
•
Compiler_Cfg.h
•
MemMap.h
•
Platform_Types.h
•
rh850_Types.h
33
Chapter 8 WDG Driver Component Header And Source File Description The description of the WDG Driver Component files is provided in the table
below:
Table 8-1 Description Of The WDG Driver Component Files File Details Wdg_59_DriverA_Cfg.h
This file is generated by the WDG Generation Tool for various WDG component
pre-compile time parameters. Generated macros and the parameters will vary
with respect to the configuration in the input ARXML file.
Wdg_59_DriverA_PBcfg.c
This file contains post-build configuration data. The structures related to WDG
Initialization are provided in this file. Data structures will vary with respect to
parameters configured.
Wdg_59_DriverA.h
This file provides extern declarations for all the WDG Component APIs. This file
provides service IDs of APIs, DET Error codes and type definitions for
Watchdog Driver initialization structure. This header file shall be included in
other modules to use the features of WDG Component.
Wdg_59_DriverA_Debug.h
This file provides Provision of global variables for debugging purpose.
Wdg_59_DriverA_Irq.h
This file contains the macro for the WDG Timer channels. It also contains the
external declaration for the interrupt functions used by WDG Driver component.
Wdg_59_DriverA_PBTypes.h
This file contains the macros used internally by the WDG Component code and
the structure declarations related to watchdog control registers.
Wdg_59_DriverA_Private.h
This file contains the declarations of the internally used functions.
Wdg_59_DriverA_Ram.h
This file contains the extern declarations for the global variables that are
defined in Wdg_59_DriverA_Ram.c file and the version information of the file.
Wdg_59_DriverA_Types.h
This file contains the common macro definitions and the data types required
internally by the WDG software component.
Wdg_59_DriverA_Version.h
This file contains the macros of AUTOSAR version numbers of all modules that
are interfaced to WDG.
Wdg_59_DriverA_RegReadBa This file contains the extern declarations for the global variables that are
ck.h
defined in Wdg_59_DriverA_Ram.c file for read-back functionality.
Wdg_59_DriverA.c
This file contains the implementation of all APIs.
Wdg_59_DriverA_Irq.c
This file contains the implementation of all the interrupt functions used by WDG
Driver Component.
Wdg_59_DriverA_Private.c
This file contains the definition of the internal functions that access the
hardware registers.
Wdg_59_DriverA_Ram.c
This file contains the global variables used by WDG Component.
Wdg_59_DriverA_Version.c
This file contains the code for checking version of all modules that are
interfaced to WDG.
Compiler.h
Provides compiler specific (non-ANSI) keywords. All mappings of keywords,
which are not standardized, and/or compiler specific are placed and organized
in this compiler specific header.
Compiler_Cfg.h
This file contains the memory and pointer classes.
MemMap.h
This file allows to map variables, constants and code of modules to individual
memory sections. Memory mapping can be modified as per ECU specific
needs.
Platform_Types.h
This file provides provision for defining platform and compiler dependent types.
rh850_Types.h
This file provides macros to perform supervisor mode (SV) write enabled
Register ICxxx and IMR register writing using OR/AND/Direct operation.
34
Generation Tool Guide Chapter 9 Chapter 9 Generation Tool Guide For information on the WDG Driver Component Code Generation Tool,
please refer “AUTOSAR_WDG_Tool_UserManual.pdf” document.
35
Chapter 9 Generation Tool Guide 36
Application Programming Interface Chapter 10 Chapter 10 Application Programming Interface This section explains the Data types and APIs provided by the WDG Driver
Component to the Upper layers.
10.1. Imported Types This section explains the Data types imported by the WDG Driver Component
and lists its dependency on other modules.
10.1.1. Standard Types In this section all types included from the Std_Types.h are listed:
•
Std_ReturnType
•
Std_VersionInfoType
10.1.2. Other Module Types In this section all types included from the WdgIf_Types.h and Dem.h are listed.
•
WdgIf_ModeType
•
WdgIf_Statustype
•
Dem_EventIdType
•
Dem_EventStatusType
10.2. Type Definitions This section explains the type definitions of WDG Driver Component
according to AUTOSAR Specification.
10.2.1. Wdg_59_DriverA_ConfigType Name: Wdg_59_DriverA_ConfigType
Type: Structure
Type Name Explanation unit32
ulStartOfDbToc
Database start
value
uint16
usInitTimerCountValue
Trigger counter
value
uint16
usSlowTimeValue
SLOW mode
value of
WDTAMD
register
uint16
usFastTimeValue
FAST mode
value of
WDTAMD
register
Element: uint8
ucWdtamdSlowValue
WDTAnMD
register value for
the Slow Mode.
37
Chapter 10 Application Programming Interface Name: Wdg_59_DriverA_ConfigType
Type: Structure
uint8
ucWdtamdFastValue
WDTAnMD
register value for
the Fast Mode.
uint16
usDefaultTimeValue
75% time value
of either slow or
fast mode in
milliseconds
uint8
ucWdtamdDefaultValue
Watchdog
default mode
WdgIf_ModeType
ddWdtamdDefaultMode
Default mode
value configured
by the user
Description: This is the type of the data structure required for initializing the Watchdog Hardware unit.
10.3. Function Definitions This section explains the APIs provided by the WDG Driver Component.
Table 10-1 APIs provided by the WDG Driver Component SI.No API’s 1.
Wdg_59_DriverA_Init
2.
Wdg_59_DriverA_SetMode
3.
Wdg_59_DriverA_SetTriggerCondition
4.
Wdg_59_DriverA_GetVersionInfo
38
Development And Production Errors Chapter 11 Chapter 11 Development And Production Errors In this section the development errors that are reported by the WDG Driver
Component are tabulated. The development errors will be reported only when
the pre compiler option WdgDevErrorDetect is enabled in the configuration.
11.1. WDG Driver Component Development Errors The following table contains the DET errors that are reported by WDG Driver
Component. These errors are reported to Development Error Tracer Module
when the WDG Driver Component APIs are invoked with wrong input
parameters or without initialization of the driver.
Table 11-1 DET Errors Of WDG Driver Component Sl. No. 1 Error Code
WDG_59_DRIVERA_E_PARAM_CONFIG
Related API(s)
Wdg_59_DriverA_Init
Source of Error
When the API service is called with a configuration set which is not within the allowed
boundaries.
Sl. No. 2 Error Code
WDG_59_DRIVERA_E_PARAM_MODE
Related API(s)
Wdg_59_DriverA_SetMode
Source of Error
When the API service is called the Driver is not possible to change the mode.
Sl. No. 3 Error Code
WDG_59_DRIVERA_E_DRIVER_STATE
Related API(s)
Wdg_59_DriverA_SetMode, Wdg_59_DriverA_Trigger and
Wdg_59_DriverA_SetTriggerCondition.
Source of Error
If the API service is called when the driver state is not in idle state.
Sl. No. 4 Error Code
WDG_59_DRIVERA_E_INVALID_DATABASE
Related API(s)
Wdg_59_DriverA_Init
Source of Error
When the API service is called with wrong database.
Sl. No. 5 Error Code
WDG_59_DRIVERA_E_PARAM_TIMEOUT
Related API(s)
Wdg_59_DriverA_SetTriggerCondition
Source of Error
When the API service Wdg_59_DriverA_SetTriggerCondition is called with timeout
value greater maximum timeout value (WdgMaxTimeout).
11.2. WDG Driver Component Production Errors The following table contains the DEM errors that are reported by WDG
Component
39
Chapter 11 Development And Production Errors Table 11-2 DEM Errors Of WDG Driver Component Sl. No. 1 Error Code
WDG_59_DRIVERA_E_DISABLE_REJECTED
Related API(s)
Wdg_Init
Source of Error
If error during mode switch failed, the above error is reported to DEM
Sl. No. 2 Error Code
WDG_59_DRIVERA_E_MODE_FAILED
Related API(s)
Wdg_Init
Source of Error
When switching between the modes is failed above error is reported to DEM.
Sl. No. 3 Error Code
WDG_59_DRIVERA_ READBACK_FAILURE
Related API(s)
In Wdg_Init, Wdg_59_DriverA_SetMode and Wdg_59_DriverA_Trigger API read
back failure report DEM error.
Source of Error
Read back failure is caused whenever a register is written and the register is not
updated with the written value then this error is reported.
40
Memory Organization Chapter 12 Chapter 12 Memory Organization Following picture depicts a typical memory organization, which must be met for
proper functioning of WDG Component software.
ROM Section WDG Driver Component RAM ect Library Object es Global RAM required for WDG functioning.
WDG Driver component APIs are placed in this
Segment Name:
code memory.
Y1 NOINIT_RAM_UNSPECIFIED X1 Segment Name:
WDG59_A_PUBLIC_CODE_ROM Global bit RAM to be initialized by WDG
Driver.
Segment Name:
Y2 NOINIT_RAM_16BIT WDG Driver code related to internal and ISR
functions are placed in this memory.
Global bit RAM to be initialized by WDG
Segment Name:
X2 Driver.
WDG_59_DRIVERA_FAST_CODE_ROM Y3 Segment Name:
NOINIT_RAM_32BIT Tool Generated Files The const section in the file
Wdg_59_DriverA_PBCfg.c is placed in this
memory.
Segment Name:
X3 WDG59_A_CFG_DBTOC_UNSPECIFIED
Figure 12-1 Memory Organization Of WDG Driver Component ROM Section (X1, X2 and X3): WDG59_A_PUBLIC_CODE_ROM (X1): API(s) of WDG Driver Component,
which can be located in code memory.
WDG_59_DRIVERA_FAST_CODE_ROM (X2): Internal and ISR functions of
WDG Driver Component code are placed in this code memory.
WDG59_A_CFG_DBTOC_UNSPECIFIED(X3): This section consists of
WDG Component database generated by the Watchdog Driver Generation
Tool and the constant structures used in AUTOSAR Renesas WDG Driver
Component. This can be located in code memory.
41
Chapter 12 Memory Organization RAM Section (Y1, Y2 and Y3): NOINIT_RAM_UNSPECIFIED (Y1): This section consists of the global RAM
variables that are used internally by WDG Component and other software
components. The specific sections of respective software components will
be merged into this RAM section accordingly.
NOINIT_RAM_16BIT (Y2): This section consists of the global RAM variables
of 16-bit size that are used internally by WDG Driver Component. This can be
located in data memory.
NOINIT_RAM_32BIT (Y3): This section consists of the global RAM variables
of 32-bit size that are used internally by WDG Driver Component. This can be
located in data memory.
•
X1, X2, Y1, Y2 and Y3 pertain to only WDG Component and do not
include memory occupied by Wdg_59_DriverA_PBCfg.c file generated
by Watchdog Driver Generation Tool.
•
User must ensure that none of the memory areas overlap with each other.
Even „debug‟ information should not overlap.
42
P1M Specific Information Chapter 13 Chapter 13 P1M Specific Information P1M supports following devices:
R7F701304
R7F701305
R7F701310
R7F701311
R7F701312
R7F701313
R7F701314
R7F701315
R7F701318
R7F701319
R7F701320
R7F701321
R7F701322
R7F701323
13.1. Interaction Between The User And WDG Driver Component 13.1.1. ISR Function Mapping Interrupt Vector Table The table below provides the list of handler addresses corresponding to the
hardware unit ISR(s) in WDG Driver Component. The user should configure
the ISR functions mentioned below:
Table 13-1 Interrupt Vector Table Interrupt Source Name of the ISR Function Autosar R4.0 only
WDG_59_DRIVERA_TRIGGERFUNCTION_ISR
EI level mask able interrupt
WDG_59_DRIVERA_TRIGGERFUNCTION_CAT2_ISR
13.1.2. Translation Header File P1x_translation.h supports following devices:
R7F701304
R7F701305
R7F701310
R7F701311
R7F701312
R7F701313
R7F701314
R7F701315
R7F701318
R7F701319
43
Chapter 13 P1M Specific Information R7F701320
R7F701321
R7F701322
R7F701323
13.1.3. Parameter Definition File Parameter definition files support information for P1M
Table 13-2 PDF information for P1M PDF files Devices supported 701304, 701305, 701310, 701311, 701312, 701313,
R403_WDG_P1M_04_05_10_to_1
701314, 701315, 701318, 701319, 701320, 701321,
5_18_to_23
701322, 701323
13.2. Sample Application 13.2.1 Sample Application Structure The Sample Application is provided as reference to the user to understand the
method in which the WDG APIs can be invoked from the application.
Generic
V850 RH850 AUTOSAR TYPES COMPILER TYPES
Devices
COMMON P1x STUB STUB STUB STUB Dem Det SchM WdgIf WDG WDG Sample Sample Application Application STUB Os
Figure 13-1 Overview Of WDG Driver Sample Application The Sample Application of the P1M is available in the path
X1X\P1x\modules\wdg\sample_application
The Sample Application consists of the following folder structure
X1X\P1x\modules\wdg\definition\<AUTOSAR_version>\<SubVariant>
\ R403_WDG_P1M_04_05_10_to_15_18_to_23.arxml
X1X\P1x\modules\wdg\sample_application\<SubVariant>\<AUTOSAR_version>
\src\WDG_59_DriverA_PBcfg.c
\inc\WDG_59_DriverA_cfg.h
44
P1M Specific Information Chapter 13 \config\App_WDG_P1M_701304_Sample.one
\config\App_WDG_P1M_701304_Sample.arxml
\config\App_WDG_P1M_701304_Sample.html
\config\App_WDG_P1M_701305_Sample.one
\config\App_WDG_P1M_701305_Sample.arxml
\config\App_WDG_P1M_701305_Sample.html
\config\App_WDG_P1M_701310_Sample.one
\config\App_WDG_P1M_701310_Sample.arxml
\config\App_WDG_P1M_701310_Sample.html
\config\App_WDG_P1M_701311_Sample.one
\config\App_WDG_P1M_701311_Sample.arxml
\config\App_WDG_P1M_701311_Sample.html
\config\App_WDG_P1M_701312_Sample.one
\config\App_WDG_P1M_701312_Sample.arxml
\config\App_WDG_P1M_701312_Sample.html
\config\App_WDG_P1M_701313_Sample.one
\config\App_WDG_P1M_701313_Sample.arxml
\config\App_WDG_P1M_701313_Sample.html
\config\App_WDG_P1M_701314_Sample.one
\config\App_WDG_P1M_701314_Sample.arxml
\config\App_WDG_P1M_701314_Sample.html
\config\App_WDG_P1M_701315_Sample.one
\config\App_WDG_P1M_701315_Sample.arxml
\config\App_WDG_P1M_701315_Sample.html
\config\App_WDG_P1M_701318_Sample.one
\config\App_WDG_P1M_701318_Sample.arxml
\config\App_WDG_P1M_701318_Sample.html
\config\App_WDG_P1M_701319_Sample.one
\config\App_WDG_P1M_701319_Sample.arxml
\config\App_WDG_P1M_701319_Sample.html
\config\App_WDG_P1M_701320_Sample.one
\config\App_WDG_P1M_701320_Sample.arxml
\config\App_WDG_P1M_701320_Sample.html
\config\App_WDG_P1M_701321_Sample.one
\config\App_WDG_P1M_701321_Sample.arxml
\config\App_WDG_P1M_701321_Sample.html
\config\App_WDG_P1M_701322_Sample.one
\config\App_WDG_P1M_701322_Sample.arxml
\config\App_WDG_P1M_701322_Sample.html
\config\App_WDG_P1M_701323_Sample.one
\config\App_WDG_P1M_701323_Sample.arxml
\config\App_WDG_P1M_701323_Sample.html
In the Sample Application all the WDG APIs are invoked in the following
sequence
When DriverA (WDTA0) is selected:
•
The API Wdg_59_DriverA_GetVersionInfo is invoked to get the version of
the WDG Driver module with a variable of Std_VersionInfoType, after the
call of this API the passed parameter will get updated with the WDG Driver
version details.
•
The API Wdg_59_DriverA_Init is invoked with a valid database address for
45
Chapter 13 P1x Specific Information the proper initialization of the WDG Driver, all the WDG Driver control
registers and RAM variables will get initialized after this API is called.
•
The API Wdg_59_DriverA_SetMode is invoked with the mode which needs
to be set, this API changes the mode of the Watchdog.
The API Wdg_59_DriverA_SetTriggerCondition initializes the trigger counter
global variable with timeout value divided by either usSlowTimeValue or
usFastTimeValue based on the current mode of Watchdog'.
13.2.2 Building Sample Application 13.2.2.1 Configuration Example This section contains the typical configuration which is used for measuring
RAM/ROM consumption, stack depth and throughput details.
Configuration Details:
App_WDG_<SubVariant>_<Device_Number>_Sample.html
The <Device Number> indicates the device to be compiled, which can be
701304, 701305, 701310, 701311, 701312, 701313, 701314, 701315, 701318,
701319, 701320, 701321, 701322 and 701323.
Remark In this typical configuration, all the conversion modes available for WDG
Driver Component are configured so that each API‟s throughput analysis could
be performed. Throughput is measured by toggling a port pin before invoking
the API and again toggling the same port pin after the execution of the API.
Following Opbyte setting shall be followed:
If Variable activation code is enabled, Opbyte value = 0x71DF3FEB.
If Variable activation code is disabled, Opbyte value = 0x719F3FEB.
In debug mode unmask the reset using GHS command "target pinmask".
13.2.2.2 Debugging The Sample Application GNU Make utility version 3.81 or above must be installed and available in the
path as defined by the environment user variable “GNUMAKE” to complete the
build process using the delivered sample files.
•
Open a Command window and change the current working directory
to”make”directory present as mentioned in below path:
“X1X\P1x\common_family\make\<Complier>”
Now execute the batch file SampleApp.bat with following parameters
SampleApp.bat Wdg < AUTOSAR_version> <Device_Name>
•
After this, the tool output files will be generated with the configuration as
mentioned in App_WDG_<SubVariant>_<Device_Number>_Sample.html
file available in the path:
“X1X\P1x\modules\wdg\sample_application\<SubVariant>\<AUTOSAR_ve
rsion>\config”.
•
After this, all the object files, map file and the executable file
46
P1M Specific Information Chapter 13 App_WDG_P1M_Sample.out will be available in the output folder
(“X1X\P1x\modules\wdg\sample_application\<SubVariant>\obj\
<Complier>”).
(Note: For example compiler can be ghs.)
•
The executable can be loaded into the debugger and the sample application
can be executed.
Remark Executable files with „*.out‟ extension can be downloaded into the target
hardware with the help of Green Hills debugger.
•
If any configuration changes (only post-build) are made to the ECU
Configuration Description files
“X1X\P1x\modules\wdg\<SubVariant>\<AUTOSAR_version>
\config\App_WDG_<SubVariant>_<Device_name>_Sample.html”
•
The database alone can be generated by using the following commands.
make –f App_WDG_<SubVariant>_Sample.mak generate_wdg_config
make –f App_WDG_<SubVariant>_Sample.mak
App_WDG_<SubVariant>_Sample.s37
•
After this, a flashable Motorola S-Record file
App_WDG_<SubVariant>_Sample.s37 is available in the output folder.
Notes: 1. <Compiler> can be ghs.
2. <Device_name> can be 701304, 701305, 701310, 701311, 701312,
701313, 701314, 701315, 701318, 701319, 701320, 701321, 701322
and 701323.
3. <AUTOSAR_version> can be 4.0.3.
4. <SubVariant> can be P1M
13.3. Memory and Throughput for R4.0.3 13.3.1 ROM/RAM Usage The details of memory usage for the typical configuration provided in Section
13.2.2.1
Configuration Example are provided in this section.
Table 13-8 ROM/RAM Details Without DET Sl. No ROM/R Segment Name Size in AM bytes for 701312 1.
ROM
WDG59_A_PUBLIC_CODE_ROM
262
WDG_59_DRIVERA_FAST_CODE_ROM
98
WDG59_A_CFG_DBTOC_UNSPECIFIED
16
2.
RAM
NOINIT_RAM_UNSPECIFIED
5
47
Chapter 13 P1M Specific Information The details of memory usage for the typical configuration, with DET enabled
and all other configurations as provided in 13.2.2.1
Configuration Example are
provided in this section.
Table 13-9 ROM/RAM Details With DET Segment Name Size in Sl. No ROM/Rbytes for AM 701312 1.
ROM
WDG59_A_PUBLIC_CODE_ROM
4
56
WDG_59_DRIVERA_FAST_CODE_ROM
106
WDG59_A_CFG_DBTOC_UNSPECIFIED
16
2.
RAM
NOINIT_RAM_UNSPECIFIED
5
13.3.2 Stack Depth The worst-case stack depth for WDG Driver Component is 12 bytes for the
typical configuration provided in Section13.2.2.1
Configuration Example.
13.3.3 Throughput Details The throughput details of the APIs for the configuration mentioned in the
Section13.2.2.1
Configuration Example are listed here. The clock frequency
used to measure the throughput is 80MHz for all APIs.
Table 13-10 Throughput Details Of The APIs API Name Throughput in Remarks Sl. microsecond No. for 701312 1.
Wdg_59_DriverA0.587
Timing is measured with
_Init
default mode as
WDGIF_SLOW_MODE
2.
Wdg_59_DriverA0.175
Timing is measured
_SetMode
with default mode as
WDGIF_SLOW_MODE
3.
Wdg_59_Driver 0.137
-
A_SetTriggerCo
n dition
4.
Wdg_59_DriverA0.12
-
_GetVersionInfo
5.
WDG_59_DRIV 13.59
-
ERA_TRIGGER
FUNCTION_ISR
48
Release Details Chapter 14 Chapter 14 Release Details WDG Driver Software R4.0.3
Version: 1.0.9
49
Chapter 14 Release Details 50
Revision History Sl.No Description Version Date 1.
Initial Version
1.0.0
18-Oct-2013
2
Following changes are made:
1.0.1
04-Feb-2014
1. In chapter 2, Reference Documents and Device manual
version changed.
2.100 pin Device names are added.
3. Compiler version and options are changed.
4. ROM/RAM table is updated for 100 pin device.
5. Sample application folder path is updated for 100 pin
device.
3
Following changes are made:
1.0.2
26-Sep-2014
1. In chapter 2, Reference Documents and Device manual
version changed.
2 .In chapter 13, translation header file that supports
P1M devices are listed.
3. In chapter 13, sample application structure is modified
according to P1M supporting devices.
4. In chapter 13, 13.1.2 ISR Function Mapping Interrupt
Vector Table and 13.1.3 Parameter Definition File are
added.
5. In chapter 13, Throughput details and ROM/RAM Usage
are added.
4.
Headers are corrected in chaper10 and 11.
1.0.3
21-Nov-2014
5.
Following changes are made:
1.0.4
28-Apr-2015
1. Updated Chapter 4.1 to add notes.
2. Updated Chapter 13 to add new device support.
3. Removed sections for Compiler, Linker and Assembler.
4. Updated Chapter 13.3 with memory and throughput
details.
51
AUTOSAR MCAL R4.0.3 User's Manual WDG Driver Component Ver.1.0.4
Embedded User’s Manual Publication Date: Rev.0.01, April 28, 2015
Published by: Renesas Electronics Corporation
SALES OFFICES http://www.renesas.com Refer
to "http://www.renesas.com/" for the latest and de tailed information.
Renesas Electronics America Inc. 2880 Scott Boulevard Santa Clara, CA 95050-2554, U.S.A.
Tel: +1-408-588-6000, Fax: +1-408-588-6130
Renesas Electronics Canada Limited 1101 Nicholson Road, Newmarket, Ontario L3Y 9C3, Canada
Tel: +1-905-898-5441, Fax: +1-905-898-3220
Renesas Electronics Europe Limited Dukes Meadow, Millboard Road, Bourne End, Buckinghamshire, SL8 5FH, U.K
Tel: +44-1628-585-100, Fax: +44-1628-585-900
Renesas Electronics Europe GmbH
Arcadiastrasse 10, 40472 Düsseldorf, Germany
Tel: +49-211-65030, Fax: +49-211-6503-1327
Renesas Electronics (China) Co., Ltd. 7th Floor, Quantum Plaza, No.27 ZhiChunLu Haidian District, Beijing 100083, P.R.China
Tel: +86-10-8235-1155, Fax: +86-10-8235-7679
Renesas Electronics (Shanghai) Co., Ltd. Unit 204, 205, AZIA Center, No.1233 Lujiazui Ring Rd., Pudong District, Shanghai 200120, China
Tel: +86-21-5877-1818, Fax: +86-21-6887-7858 / -7898
Renesas Electronics Hong Kong Limited Unit 1601-1613, 16/F., Tower 2, Grand Century Place, 193 Prince Edward Road West, Mongkok, Kowloon, Hong Kong
Tel: +852-2886-9318, Fax: +852 2886-9022/9044
Renesas Electronics Taiwan Co., Ltd. 7F, No. 363 Fu Shing North Road Taipei, Taiwan
Tel: +886-2-8175-9600, Fax: +886 2-8175-9670
Renesas Electronics Singapore Pte. Ltd. 1 harbourFront Avenue, #06-10, keppel Bay Tower, Singapore 098632
Tel: +65-6213-0200, Fax: +65-6278-8001
Renesas Electronics Malaysia Sdn.Bhd. Unit 906, Block B, Menara Amcorp, Amcorp Trade Centre, No. 18, Jln Persiaran Barat, 46050 Petaling Jaya, Selangor Darul Ehsan, Malaysia
Tel: +60-3-7955-9390, Fax: +60-3-7955-9510
Renesas Electronics Korea Co., Ltd. 11F., Samik Lavied' or Bldg., 720-2 Yeoksam-Dong, Kangnam-Ku, Seoul 135-080, Korea
Tel: +82-2-558-3737, Fax: +82-2-558-5141
© 2015 Renesas Electronics Corporation. All rights reserved.
Colophon 1.0
AUTOSAR MCAL R4.0.3
User‟s Manual
Document Outline
6 - AUTOSAR_WDG_Tool_UserManuals
AUTOSAR MCAL R4.0.3
User’s Manual
WDG Driver Component Ver.1.0.2
Generation Tool User’s Manual
Target Device:
RH850/P1x
All information contained in these materials, including products and product specifications,
represents information on the product at the time of publication and is subject to change by
Renesas Electronics Corp. without notice. Please review the latest information published by
Renesas Electronics Corp. through various means, including the Renesas Electronics Corp.
website
(http://www.renesas.com). www.renesas.com Rev.0.01 Apr 2015
2
Notice
1.
All information included in this document is current as of the date this document is issued. Such information, however, is subject to
change without any prior notice. Before purchasing or using any Renesas Electronics products listed herein, please confirm the latest
product information with a Renesas Electronics sales office. Also, please pay regular and careful attention to additional and different
information to be disclosed by Renesas Electronics such as that disclosed through our website.
2.
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.
3.
You should not alter, modify, copy, or otherwise misappropriate any Renesas Electronics product, whether in whole or in part.
4.
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.
5.
When exporting the 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. You should not use Renesas Electronics products
or the 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. 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.
6.
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.
7.
Renesas Electronics products are classified according to the following three quality grades: "Standard", "High Quality", and
"Specific". The recommended applications for each Renesas Electronics product depends on the product's quality grade, as indicated
below. 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 categorized as "Specific" without the prior written consent of Renesas
Electronics. Further, you may not use any Renesas Electronics product for any application for which it is not intended without the
prior written consent of Renesas Electronics. 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 an application categorized as "Specific" or for which
the product is not intended where you have failed to obtain the prior written consent of Renesas Electronics. The quality grade of
each Renesas Electronics product is "Standard" unless otherwise expressly specified in a Renesas Electronics data sheets or data
books, etc.
"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.
"High Quality": Transportation equipment (automobiles, trains, ships, etc.); traffic control systems; anti-disaster systems; anti- crime
systems; safety equipment; and medical equipment not specifically designed for life support.
"Specific":
Aircraft; aerospace equipment; submersible repeaters; nuclear reactor control systems; medical equipment or
systems for life support (e.g. artificial life support devices or systems), surgical implantations, or healthcare
intervention (e.g. excision, etc.), and any other applications or purposes that pose a direct threat to human life.
8.
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.
9.
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 system manufactured by you.
10.
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.
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.
4
Abbreviations and Acronyms Abbreviation / Acronym Description API
Application Programming Interface
AUTOSAR
AUTomotive Open System ARchitecture
BSWMDT
Basic Software Module Description Template
DEM
Diagnostic Event Manager
ECU
Electronic Control Unit
ID/Id
Identifier
MCAL
MicroController Abstraction Layer
MCU
MicroController Unit
WDG/Wdg
Watchdog Driver
WDTA
Window Watchdog Timer A
XML
eXtensible Mark-up Language
Definitions Terminology Description BSWMDT File
This file contains Common Published Information of WDG driver.
ECU Configuration Description
Input file to WDG Driver Generation Tool. It is generated by ECU
File
Configuration Editor.
Sl.No.
Serial Number
Translation XML File
This file contains the translation and device specific header file path.
5
6
Table of Contents Chapter 1 Introduction ........................................................................................... 9 1.1 Document Overview .................................................................................................................. 9 Chapter 2 Reference ............................................................................................. 11 2.1 Reference Documents ............................................................................................................. 11 2.2 Trademark Notice .................................................................................................................... 11 Chapter 3 WDG Driver Generation Tool Overview ............................................. 13 Chapter 4 Input Files ............................................................................................ 15 Chapter 5 Output Files ......................................................................................... 17 Chapter 6 Precautions .......................................................................................... 19 Chapter 7 User Configuration Validation ............................................................ 21 Chapter 8 Messages ............................................................................................. 23 8.1 Error Messages ........................................................................................................................ 23 8.2 Warning Messages .................................................................................................................. 26 8.3 Information Messages ............................................................................................................. 26 Chapter 9 Notes .................................................................................................... 27
7
List of Figures Figure 3-1 Overview of WDG Driver Generation Tool ................................................................ 13 List of Tables
Table 5-1 Output Files Description ............................................................................................ 17 8
Introduction Chapter 1 Chapter 1 Introduction The Watchdog Driver provides services for initialization, changing the
operation mode and triggering the Watchdog.
The WDG Driver module comprises of two sections as Embedded Software
and the Generation Tool to achieve scalability and configurability.
The document describes the features of the WDG Driver Generation Tool.
WDG Driver Generation Tool is a command line tool that extracts information
from ECU Configuration Description File and BSWMDT File and generates
WDG Driver C Source and C Header files (Wdg_59_Driver<A>_Cfg.h and
Wdg_59_Driver<A>_PBcfg.c).
This document contains information on the options, input and output files of the
WDG Driver Generation Tool. In addition, this manual covers a step-by-step
procedure for the usage of tool. ECU Configuration Description File contains
information about WDG configuration.
Remark Based on the value for the parameter ‘VendorApiInfix’, WDG Generation Tool
generates Wdg_59_DriverA_Cfg.h and Wdg_59_DriverA_PBcfg.c files.
Hence in this document ‘Wdg_59_Driver<A>_Cfg.h and Wdg_59
_Driver<A>_PBcfg.c’ term is used.
1.1 Document Overview This user manual is organized as given in the table below:
Section Contents Section 1 (Introduction)
Provides an introduction to the document and explains how information
is organized in this manual.
Section 2 (Reference)
Provides a list of documents referred while developing this document.
Section 3 (WDG Driver
Provides the WDG Driver Generation Tool Overview.
Generation Tool Overview)
Section 4 (Input Files)
Provides information about ECU Configuration Description File.
Section 5 (Output Files)
Explains the output files that are generated by the WDG Driver
Generation Tool.
Section 6 (Precautions)
Contains precautions to be taken during configuration of ECU
Configuration Description File.
Section 7 (User Configuration
Describes about user configuration validation done by the WDG Driver
Validation)
Generation Tool.
Section 8 (Messages)
Describes all the Error/Warning/Information messages of R4.0.3 which
helps the user to understand the probable reason for the same.
Section 9 (Notes)
Provides notes to help the user to understand this document better.
9
Chapter 1 Introduction
10
Reference Chapter 2 Chapter 2 Reference 2.1 Reference Documents The following table lists the documents referred to create this document:
Sl. No Title Version 1.
Autosar R4.0 2.5.0
AUTOSAR_SWS_WatchdogDriver.pdf
2.
P1x Parameter Definition File 1.0.3
R403_WDG_P1M_04_05_10_to_15_18_to_23.arxml
2.2 Trademark Notice Microsoft and Windows are trademarks/registered trademarks of Microsoft
Corporation.
11
Chapter 2 Reference 12
WDG Driver Generation Tool Overview Chapter 3 Chapter 3 WDG Driver Generation Tool Overview WDG Driver Generation Tool overview is shown below.
ECU Configuration Wdg_59_Driver<ADescription File, WDG Driver >_Cfg.h and BSWMDT File, Generation Wdg_59_Driver<ATranslation XML Tool >_PBcfg.c File and Configuration XML File Figure 3-1 Overview of WDG Driver Generation Tool WDG Driver Generation Tool is a command line tool that extracts, analyzes
the configuration details provided in the input file and validates correctness of
the data and provides scalability and configurability for WDG Driver module. It
accepts ECU Configuration Description File(s), BSWMDT File, Translation
XML File and Configuration XML File as input and displays appropriate
context sensitive error messages for wrong input and exits. Tool creates the
Log file (Wdg.log) that contains the list of Error/Warning/Information
messages in the output directory.
For the error free input file, the tool generates the following output files:
Wdg_59_Driver<A>_Cfg.h and Wdg_59_Driver<A>_PBcfg.c
Wdg_59_Driver<A>_Cfg.h will be compiled and linked with WDG Driver
Component. Wdg_59_Driver<A>_PBcfg.c will be compiled and linked
separately from the other C Source files and placed in flash.
Remark •
In case of errors the generation tool returns a 1, in case of no errors the
generation tool returns a 0.
•
WDG Driver Generation Tool uses “Common Published Information” from
WDG module specific BSWMDT File. WDG module specific BSWMDT File
should not be updated manually since it is “Static Configuration” file.
13
Chapter 3 WDG Driver Generation Tool Overview 14
Input Files Chapter 4 Chapter 4 Input Files WDG Driver Generation Tool accepts ECU Configuration Description File(s),
BSWMDT File, Translation XML File and Configuration XML File as input.
WDG Driver Generation Tool needs information about WDG Driver module.
Hence ECU Configuration Description File should contain configuration of
WDG Driver module. Generation Tool ignores any other AUTOSAR
component configured in the ECU Configuration Description File. ECU
Configuration Description File can be generated using configuration editor.
ECU Configuration Description File must comply with AUTOSAR standard
ECU Configuration Description File format.
Remark The detailed explanation about the parameters and containers are found in
Parameter Definition File mentioned in the Reference Documents section.
15
Chapter 4 Input Files
16
Output Files Chapter 5 Chapter 5 Output Files WDG Driver Generation Tool generates configuration details in C Header and
C Source files (Wdg_59_Driver<A>_Cfg.h, Wdg_59_Driver<A>_PBcfg.c).
The content of each output file is given in the table below:
Table 5-1 Output Files Description Output File Details Wdg_59_Driver<A
This file contains pre-compile time parameters. This file also contains the macro
>_Cfg.h
definitions for development error detect, version info API, compile switch to allow/
forbid disabling Watchdog Driver during runtime and Watchdog Driver Id. This file also
contains information for maximum Watchdog Timer timeout, Minimum Watchdog
Timer timeout, configuration set handles, resolution of Watchdog time out period and
Watchdog trigger mode.
Wdg_59_Driver<A
This file contains post-build configuration data.
>_PBcfg.c
Remark Output files generated by WDG Driver Generation Tool should not be modified
or edited manually.
17
Chapter 5 Output Files
18
Precautions Chapter 6 Chapter 6 Precautions • ECU Configuration Description File and BSWMDT File must comply with
AUTOSAR standard for R4.0.3 ECU Configuration Description File and
BSWMDT File respectively.
• The input file must contain WDG Driver, MCU Driver and DEM component
related configuration.
• Default Translation XML File (Wdg_X1x.trxml) should be present in same
location of Wdg_X1x.exe when the variant specific trxml file is not given as
input in command line.
• Default Configuration XML File (Wdg_X1x.cfgxml) must be present in same
location of Wdg_X1x.exe.
• If Translation XML File is not provided on the command line,
Wdg_X1x.trxml which is present in same location of Wdg_X1x.exe is
considered as ‘default’ Translation XML File.
• If Configuration XML File is not provided on the command line,
Wdg_X1x.cfgxml which is present in same location of Wdg_X1x.exe is
considered as ‘default’ Configuration XML File.
• Translation XML File should contain the file extension ‘.trxml’.
• Configuration XML File should contain the file extension ‘.cfgxml’.
• All the function names and the string values configured should follow C
syntax for variables. It can only contain alphanumeric characters and “_”. It
should start with an alphabet.
• If the output files generated by WDG Driver Generation Tool are modified
externally, then they may not produce the expected results or may lead to
error/warning/Information messages.
• Short Name for a container should be unique within a name space.
• C Source and C Header files will be generated by the Watchdog Driver
Generation Tool based on the configuration of the parameters ‘VENDOR-
ID’ and ‘VENDOR-API-INFIX’ in the WDG Driver specific BSWMDT File.
• An error free ECU Configuration Description File generated from
configuration editor has to be provided as input to the WDG Driver
Generation Tool. Otherwise Tool may not produce the expected results or
may lead to errors/warnings/information.
• User has to make sure that the respective device specific configuration file
is used, otherwise Tool may not produce the expected results or may lead
to errors/warnings/information messages.
• The description file should always be generated using AUTOSAR specified
configuration editor and it should not be edited manually.
Remark Please refer the WDG Component User Manual for deviations from AUTOSAR
specifications, if any.
19
Chapter 6 Precautions 20
User Configuration Validation Chapter 7 Chapter 7 User Configuration Validation This section provides help to analyze the error, warning and information
messages displayed during the execution of WDG Driver Generation Tool. It
ensures conformance of input files with syntax and semantics. It also
performs validation on the input file for correctness of the data.
For more details on list of Error/Warning/Information messages that are
displayed as a result of input file validation, refer Chapter 8 “
Messages”.
The Generation Tool displays errors or warning or information when the user
has configured incorrect inputs. The format of Error/Warning/Information
message is as shown below.
• ERR/WRN/INF<mid><xxx>: <Error/Warning/Information Message>.
where,
<mid>: 102 - WDG Driver Module Id (102) for user configuration checks.
000 - for command line checks.
<xxx>: 001-999 - Message Id.
• File Name: Name of the file in which the error has occurred.
• Path: Absolute Path of the container in which the parameter is present.
‘File Name’ and ‘Path’ need not be present for all Error/Warning/Information
messages.
21
Chapter 7 User Configuration Validation 22
Messages Chapter 8 Chapter 8 Messages The messages help to identify the syntax or semantic errors in the ECU
Configuration Description File. Hence it ensures validity and correctness of
the information available in the ECU Configuration Description File.
The following section gives the list of error, warning and information
messages displayed by the Generation Tool.
8.1 Error Messages ERR102001: Number of fields is not same for the entity 'Structure Name'. This error occurs, if the number of fields is not same in the structure that is to
be generated in the output file.
ERR102002: Field 'Field Name' is empty in the entity 'Structure Name'. This error occurs, if the structure fields that are to be generated in the output
file are empty.
ERR102003: 'WDG Driver' Component is not present in the input file(s). This error occurs, if WDG Driver Component is not present in the input ECU
Configuration Description File(s).
ERR102004: The parameter 'parameter name' in the container 'container
name' should be configured. This error occurs, if any of the mandatory configuration parameter(s)
mentioned below is (are) not configured in ECU Configuration Description File.
The list of mandatory parameters with respect to container is listed below:
Parameter Name Container Name WdgDevErrorDetect
WdgDisableAllowed
WdgIndex
WdgVersionInfoApi
WdgGeneral
WdgVaryingActivationCodeMode
WdgTriggerLocation
WdgDeviceName
WdgInitialTimeout
WdgRunArea
23
Chapter 8 Messages Parameter Name Container Name WdgMaxTimeout
WdgGeneral
WdgCriticalSectionProtection
WdgVersionCheckExternalModules
WdgClockRef
WdgRegReadBackEnable
WdgTriggerMode
WdgPublishedInformation
WdgClkSettingsFast
WdgSettingsFast
WdgClkSettingsSlow
WdgSettingsSlow
-
WdgSettingsOff
WdgDefaultMode
WdgSettingsConfig
ERR102005: The reference path <path> provided for the parameter ‘Parameter Name’ within the container ‘Container Name’ is incorrect. This error occurs, if path provided for the reference parameters mentioned in
the below table are incorrect:
Parameter Name Container Name WdgClockRef
WdgGeneral
WDG_E_DISABLE_REJECTED
WdgDemEventParameterRefs
WDG_E_MODE_FAILED
WDG_E_TRIGGER_TIMEOUT
WDG_E_READBACK_FAILURE
ERR102006: The value configured for the parameter ‘WdgClkSettingsFast’ in the container ‘WdgSettingsFast’ and value of
the parameter ‘WdgClkSettingsSlow’ in the container ‘WdgSettingsSlow’
are same. This error occurs, if the value configured for the parameter
WdgClkSettingsFast in the container WdgSettingsFast and value of the
parameter WdgClkSettingsSlow in the container WdgSettingsSlow are same.
ERR102007: The value configured for the parameter ‘WdgClkSettingsSlow’ in the container ‘WdgSettingsSlow’ is faster
(valid configuration should be WdgClkSettingsSlow > WdgSettingsFast)
than the value of the parameter ‘WdgClkSettingsFast’ in the container ‘WdgSettingsFast’. This error occurs, if the value configured for the parameter
WdgClkSettingsSlow in the container WdgSettingsSlow is faster than the
value of the parameter WdgClkSettingsFast in the container
WdgSettingsFast.
ERR102008: The value of the parameter ‘WdgInitialTimeout’ is greater
than the value of the parameter ‘WdgMaxTimeout’. This error occurs, if the value of the parameter WdgInitialTimeout is greater
than the value of the parameter WdgMaxTimeout.
24
Messages Chapter 8 ERR102009: The value of the parameter ‘WdgDisableAllowed’ should
not be <false> since the value of the parameter ‘WdgDefaultMode’ is
configured as <WDGIF_OFF_MODE>. This error occurs, if the value of the parameter WdgDisableAllowed is false
and the value of the parameter WdgDefaultMode is configured as
WDGIF_OFF_MODE.
ERR102010: The total instances of ‘WdgSettingsConfig’ container per WDTA instance is more than <1>. This error occurs, if the total instance of WdgSettingsConfig container per
WDTA instance is more than 1.
ERR102011: The macro definition <Macro name> is not found in <Translation Header File name> translation C Header File. The macro
label format should be 'Macro format'. This error occurs, if the macro definitions “RENESAS_ICWDTA<WDG
instance>NMI_IMR” and “RENESAS_ICWDTA<WDG instance>_IMR” are not
present in Translation Header File.
ERR102012: "DriverA" or "DriverB" WDG instance is not present in
input ECU Configuration Description File(s). "DEFINITION-REF" tags in
WDG specific ECU Configuration Description File should contain
"DriverA/ Wdg" or "DriverB/Wdg". This error occurs, if “DriverA” or “DriverB” WDG instance is not present in
description file.
Note: P1x device supports only one instance i.e. DriverA.
ERR102014: The reference to BSWMDT file 'MODULE-DESCRIPTION-
REF' should not refer to the same 'VendorApiInfix' for two different WDG
drivers. 'VendorApiInfix' should be unique for each hardware driver.
This error occurs, if the value of ‘VendorApiInfix’ is not unique for each
hardware driver.
ERR102015: The value configured for the parameter 'WdgIndex' is same
for all the configured WDG drivers. The value of WdgIndex should be
unique for each hardware driver. This error occurs, if the value configured for the parameter WdgIndex is same
for all the configured WDG drivers.
ERR102016: The short name of the container ‘WdgSettingsConfig’ should be unique across the Drivers. This error occurs, if the short name of WdgSettingsConfig container is not
same across the Drivers.
25
Chapter 8 Messages ERR102017: The parameter 'WDG_E_READBACK_FAILURE' in the
container ‘WdgDemEventParameterRefs’ should be should be configured
since parameter 'WdgRegReadBackEnable' in container 'WdgGeneral' is
not configured as 'DISABLED'.
This error will occur, if the parameter 'WDG_E_READBACK_FAILURE' in
the container WdgDemEventParameterRefs’ is not configured when
parameter 'WdgRegReadBackEnable' in container 'WdgGeneral' is not
configured as 'DISABLED'.
8.2 Warning Messages WRN102001: The value of the parameter 'WdgInitialTimeout' is
configured as <0> and 'WdgDefaultMode' is not configured as <WDGIF_OFF_MODE>. Hence, Watchdog hardware will be enabled
directly after Wdg Module initialization and WDG counter will expire
after <calculated_value in msec>. This warning occurs, if WdgInitialTimeout parameter is configured as 0 and
WdgDefaultMode is not configured as WDGIF_OFF_MODE.
8.3 Information Messages INF102001: The duration of 75% of one WDG trigger cycle for slow mode
is <slow_time_value msec>. This information occurs to provide 75% interrupt time for slow mode. In this
information message ‘slow_time_value’ will be evaluated as follows:
slow_value = Power factor from WdgClkSettingsSlow slow_time_value =
integer ((0.75((2slow_value)/clock))/1000)
INF102002: The duration of 75% of one WDG trigger cycle for fast mode
is <fast_time_value msec>. This information occurs to provide 75% interrupt time for fast mode. In this
information message ‘fast_time_value’ will be evaluated as follows:
fast_value = Power factor from WdgClkSettingsFast fast_time_value = integer
((0.75((2fast_value)/clock))/1000)
26
Notes Chapter 9 Chapter 9 Notes “Generation Tool” and “Tool” terminologies are used interchangeably to refer
WDG Driver Generation Tool.
27
Chapter 9 Notes 28
Revision History
Sl.No. Description Version Date 1.
Initial Version
1.0.0
18-Oct-2013
2.
Following changes are made:
1.0.1
26-Sep-2014
1. Chapter 2 is updated for addition of PDF reference.
2. WdgRegReadBackEnable parameter is added in ERR102004 error
message table.
3. A note is added for ERR102012 error message.
4. WdgDemEventParameterRefs container and its parameters are added in
the table of error message ERR102005.
5. Error message ERR102017 is added newly.
6. Error messages ERR102015 and ERR102016 are rephrased.
7. Chapter 6 Precautions is updated.
3.
Following change is made:
1.0.2
28-Apr-2015
1. Updated Chapter 2 to add PDF reference.
29
AUTOSAR MCAL R4.0.3 User's Manual WDG Driver Component Ver.1.0.2 Generation Tool User's Manual Publication Date: Rev.0.01, April 28, 2015
Published by: Renesas Electronics Corporation
SALES OFFICES Refer t
o for the latest and detailed
SALES OFFICES http://www.renesas.com Renesas Electronics America 2880
Ref Sc
er t
ot t " Bhtoutp l: e// varwwd w S.r anten ae s Ca lars.ca,o CAm/" for the latest and
detailed information.
Tel:
Fax:
RenR esasen Eesas leEl ctrec ot nr io cns i Cacs nA admeari ca Inc. 1101 N
2880 ic
S h
c ol
ot s
t on
B Road
oulev ,
ar N
d ew
Sam
nt ar
a ket
Cl ,a O
ra nt
, ar
CAi o L3Y
9505
0 9C
-253,
5 4, U.S.A.
Tel
T :
el: +1-408-588-60 Fa
00, x:
F ax: +1-408-588-
6130
RenR esasen Eesas leEl ctrec ot nr io cns i Eurcs opeCana da Limit ed Dukes
1101 M
N e
i adow
chols ,
o M
n il
R lboar
oad, d
N R
e oad
wm ,
a r B
k ou
et, r ne
O
nt E
a nd,
rio
L3Y 9C3, Canada SL8 5FH,
Tel
T :
el: +1-905-898-5441, F
a
F x:
a
x: +1-905-898-3220
RenR esasen Eesas leEl ctrec ot nr io cns i Ec urs Eopeur ope Limited Dukes Me
1
adow 0,
,
M4047
illbo 2
a r D
d üs
R seldor
oad, f,
B G
ouer
r m
ne any
End, Buckinghamshire, SL8 5FH, U.K
Tel
T :
el: +44-1628-585- Fa
10 x:
0, Fax: +44-1628-585 -900
RenR esasen Eesas leEl ctrec ot nr io cns i (c Cs h iE naur ) Cope o .,G mbH 7th
A r F
c loor
adi ,
asQ
tr ua
as nt
s um
e 1
0,P
laza,
40472 N
o.
D 27
üs
s Z
elhi
d Chun
orf, Lu
Ger H
m aidi
any an
District, Beijing 100083,
Tel
T :
el: +49-211-65030, F F
a a
x:x:
+49-211-6503-13
27
RenR esasen Eesas leEl ctrec ot nr io cns i (Scs ha (Cnghahina i) ) CoCo., ., Ltd. Uni
7t t
h 204
Flo , 205,
or, Q
u A
a ZI
nt A
umC
en
Pl t
a er
z ,
a , No.
N 1
o. 233
27
Z L
hiuj
Ciaz
h ui
un Ri
Lu n
Hg
ai Rd
dia .,
n P
Diudong
strict, D
Be istr
ijin ict
g , Shangh
100083, ai
P. 200120
R.China ,
Tel
T :
el: +86-10-8235-11
F
55, a
x:
Fa x: +86-10-8235-76 /
79
RenR esasen Eesas leEl ctrec ot nr io cns i Hocs n( gS Kha ongn ghai) Co., Ltd. Unit
Uni 1601
t
-
204,161
3,
205, 16/
AZ F
I .
A , To
C w
ent er
er , 2,
N G
o. rand
1233 C
ent
Luji ur
az y
ui Pl
a
Ri c
n e
g , 193
Rd., P
P rince E
udong dw
Dis ar
tri d
c R
t, o
S ad
ha W
ng es
ha ti, Mongk
200120,ok
,
C K
hiow
na l oon, Hong
Tel
T :
el: +86-21-5877-18 Fa
18 x:
,
F+
a 85
x: 2
+86-21-6887-78
58 / -7898
RenR esasen Eesas leEl ctrec ot nr io cns i Taics wH anong CKo., ong L imited 7F,
UnN
it o.
36
16
3
01
- Fu
161Shi
3, ng
16/ N
F.,or
t
T h
o R
w oad
er
2, Tai
Gr pei,
and
Century Place, 193 Prince Edward Road West, Mongkok, Kowloon, Hong Kong
Tel
T :
el: +852-2886-9318, F
F a
a x:
x:
+
+ 886
852
2886-9022/
9044
RenR esasen Eesas leEl ctrec ot nr io cns i Sc is n gaTai pw oran e PtCo., e . Ltd. 1 7F, No. 363
A
Fu ven
Shi u
n e,
g #06
Nort -10,
h R Kep
oad p
T el
ai
p Ba
ei, y
TTo
ai w
w er,
an
Singapore 098632
Tel
T :
el: +886-2-8175- F
96 ax:
00
, Fax: +886 2-
8175-9670
RenR esasen Eesas leEl cte rc ot nr io cns i Mcs al Sai ysingaa pore Pte. L td. Un
1 i t 906
harb , Bl
our o
F c
r k B,
ont
A M
v e
e nar
nue a
,
# Amc
06- o
10 rp
, ,
K A
ep mc
pel o
rp
Ba T
y rade
Tow C
er,en
t
S r
i e,
n
g No.
apo r 18
e , Jl
09 n
86 Per
32 siaran Barat, 46050 Petaling Jaya, Selangor Darul Ehsan,
Tel
T :
el: +65-6213-0200, Fa
Fa x:
x:
+65-6278-8001
RenR esasen Eesas leEl ctrec ot nr io cns i Kocs reM aal a Co.ysi , a Sd n.Bhd. 11F.
Un ,
i
t Sam
906,i k
B Lav
loc i
k e
d'
B, or
M B
en ldg.
ar ,
a
720
Amc -2
o
rp, Amcorp Trade Centre, No.
S
18, e
oul
Jln 135
Per -
s 080
iara,
n Barat, 46050 Petaling Jaya, Selangor Darul Ehsan, Malaysia
Tel
T :
el: +60-3-7955-93 Fa
90, x:
Fax: +60-3-7955-
9510
Renesas Electronics Korea Co., Ltd. 11F. Samik Lavied' or Bldg., 720-2 Yeoksam-Dong, Kangnam-Ku, Seoul 135-080, Korea
Tel: +82-2-558-3737, Fax: +82-2-558-5141
© 2010 Renesas Electronics Corporation. All rights
Colophon
© 2015 Renesas Electronics Corporation. All rights reserved.
Colophon 1.0
AUTOSAR MCAL R4.0.3
User’s Manual
Document Outline
