Data Dictionary


Overview

Change Log
Variable Dictionary
Calibration Dictionary
Global Constants
Template
Help


Sheet 1: Change Log

HystComp - Rev 24<- Global Program / Module Name


RevisionAuthorDateChange Description

Data Dictionary Type:Component
1.0JJW7-Nov-11Initial Creation



2M. Story21-Nov-11Updated to DD version 2 and made updates for FDD #SF-12 001



3M. Story29-Nov-11Fixed issues found from component complile



4OT3-Dec-11Update to Template 3.0



5xz0btk12-Dec-11Added {} around default value for t_HysCompCoulFricY_HwNm_u9p7 to allow proper file generation.
Updated template tab.




6OT22-Dec-11Updated template (FDD reference)



7OT9-Jan-12Updated Template (v3.1)



8M. Story13-Jan-12Removed HwNmPerMtrNm_Uls_M_f32



9OT18-Jan-12Fixed Syntax Errors



10OT18-Jan-12Updated Template (Graph Settings)



11JJW24-Jan-12Updated Module vars per design changes to match model



12OT3-Feb-12Fixed Inconsistencies



13OT13-Feb-12Fixed (more) Inconsistencies



14JWJ13-Jul-12Added Friction Offset input from Avgerage Friction Learn



15NRAR24-Jul-12Removed SlewRate Limit cal



16Selva26-Sep-12Fixed datatype error



17Selva5-Nov-12Fixed datatype error



18KJS28-Nov-12Updated dimensions for HysHwTrqBlndTblX and Y



19NRAR1-May-13Updated as per Anom 4987- change is in variable dictionary



22Jared26-Apr-13Update to FDD ver 007



23Jared28-May-13UTP Corrections of t2 table dimensions



24Jared4-Jun-13Update to FDD ver 008




















































































































































































Sheet 2: Variable Dictionary

HystComp - Rev 24

IOMDN
Variable Information

YN










Range











Software Variable NameStandard Reference NameFDD ReferenceDescription[I]nput [O]uput [M]oduleInternal [D]isplay [N]onVolatileMemory UsageOEM1X, 1Y, 1Z, 1I, 1BS 2X, 2Y, 2Z, 2I, 2BS etc Graph SettingsInitalization ValueMinMaxResolutionUnit Test Tolerance (+/-)UnitsTypeMemory Segment






Variables




















HwTrq_HwNm_f32Hw_TorqueSF12 HysteresisCompensationHandwheel torque measured inputIN
0-1010Single Precision Float
HwNmfloat32







DefeatHystService_Cnt_lgcDefeatHystServiceSF12 HysteresisCompensation
IN
0N/AN/ABoolean










BaseAssistCmd_MtrNm_f32BaseAssistCmdSF12 HysteresisCompensationAssist Torque based on HW TorqueIN
0-8.88.8Single Precision Float
MtrNmfloat32







VehSpd_Kph_f32Vehicle_SpeedSF12 HysteresisCompensationVehicle speed from serial communications busIN
00511Single Precision Float
kphfloat32







WIRCmdAmpBlnd_MtrNm_f32WIRCmdAmpBlndSF12 HysteresisCompensationWIR Command Amplitude for blended tuning functionalityIN
008Single Precision Float
MtrNmfloat32







AssistMechTempEst_DegC_f32Assist_Mech_Temp_EstSF12 HysteresisCompensationAssist mech temperature for compensation scaling functionalityIN
30-40150Single Precision Float
DegCfloat32







SrlComSvcDft_Cnt_T_b32Defeat_Hyst_ServiceSF12 HysteresisCompensationA service to turn this function offIN
006553632Bit
Cntuint32







FricOffset_HwNm_f32FricLrn_FricOffset_HwNmSF12 HysteresisCompensationDetected average friction changes from the baseline frictionIN
0-1010Single Precision Float
HwNmfloat32







HysteresisComp_MtrNm_f32Hysteresis_CompSF12 HysteresisCompensationAssist modifier provided to Stability Compensation functionON
0-1010Single Precision Float4.89E-04MtrNmfloat32







AssistCmdLPFiltSV_HwNm_M_strAssistCmdLPFiltSVSF12 HysteresisCompensation
MN
{0,0}

Single Precision Float{SV: 7.81E-03, K: 1.52E-05}HwNmLPF32KSV







HwTrqLPFiltSV_HwNm_M_strHwTrqLPFiltSVSF12 HysteresisCompensation
MN
{0,0}

Single Precision Float{SV: 7.81E-03, K: 1.52E-05}HwNmLPF32KSV







RawHystCompLPFiltSV_HwNm_M_strRawHystCompLPFiltSVSF12 HysteresisCompensation
MN
{0,0}

Single Precision Float{SV: 7.81E-03, K: 1.52E-05}HwNmLPF32KSV







HwTrqLastUsed_HwNm_M_f32HwTrqLastUsedSF12 HysteresisCompensation
MN
0-1010Single Precision Float7.81E-03HwNmfloat32







Fraction_Uls_M_f32HysComp_FractionSF12 HysteresisCompensation
MN
0-11Single Precision Float7.81E-03Ulsfloat32







RawCalc_HwNm_M_f32HysComp_RawCalcSF12 HysteresisCompensation
MN
0-1515Single Precision Float7.81E-03HwNmfloat32







RiseX_HwNm_M_f32N/ASF12 HysteresisCompensation
MN
0-11Single Precision Float7.81E-03HwNmfloat32







AstCmdLastUsed_HwNm_M_s8p7N/ASF12 HysteresisCompensation
MN
0-2552550.00781257.81E-03HwNms8p7_T







CompAvail_HwNm_D_f32HysComp_CompAvailSF12 HysteresisCompensation
DN
0-1515Single Precision Float7.81E-03HwNmfloat32







HwTrqFilt_HwNm_D_f32HysComp_HwTrqFiltSF12 HysteresisCompensation
DN
0-1010Single Precision Float7.81E-03HwNmfloat32







CoulFric_HwNm_D_f32HysComp_CoulFricSF12 HysteresisCompensation
DN
0-1010Single Precision Float7.81E-03HwNmfloat32







PosAvail_HwNm_D_f32HysComp_PosAvailSF12 HysteresisCompensation
DN
0-1010Single Precision Float7.81E-03HwNmfloat32







NegAvail_HwNm_D_f32HysComp_NegAvailSF12 HysteresisCompensation
DN
0-1010Single Precision Float7.81E-03HwNmfloat32







EffCompTrq_HwNm_D_f32HysComp_EffCompTrqSF12 HysteresisCompensation
DN
0-1010Single Precision Float7.81E-03HwNmfloat32







AssistCmdFilt_HwNm_D_s8p7HysComp_ AssistCmdFiltSF12 HysteresisCompensation
DN
0-1281270.00781257.81E-03HwNms8p7_T
























































































































































































Sheet 3: Calibration Dictionary

HystComp - Rev 24


N
Calibration InformationAchieved in Software Design



Y








Range





P
Software Calibration NameStandard Reference NameFDD ReferenceDescriptionTuning SetOEM1X, 1Y, 1Z, 1I, 1BS 2X, 2Y, 2Z, 2I, 2BS etc Graph SettingsDefault ValueMinMaxUnitsTypeMemory Segment



Calibrations















k_HysCmpLPAstLPFKn_Hz_f32HysComp_k_AsstLPFKn_HzSF12 HysteresisCompensationLP filter cutoff frequency (of assist)YN
50150Hzfloat32




k_HysCmpHwTrqLPFKn_Hz_f32HysComp_k_HwTrqLPFKn_HzSF12 HysteresisCompensationLP filter cutoff frequency (of hw torque)YN
50150Hzfloat32




k_HysFinalOutLPFKn_Hz_f32HysComp_k_FinalOutLPFKn_HzSF12 HysteresisCompensationLP filter cutoff frequency (of output)YN
50150Hzfloat32




k_HysRevGain_InvHwNm_f32HysComp_k_RevGain_InvHwNmSF12 HysteresisCompensationMagnifies delta handwheel torque during directional changes. Provides a tuning method affecting transition feel. Transition “rise” is tuned via tables above. The “fall” is tuned by this one gain value.YN
60.115InvHwNmfloat32




k_LpFricIpLim_HwNm_u9p7HysComp_k_AsstInputLim_HwNmSF12 HysteresisCompensationUpper limit of incoming Assist magnitudeYN
1000255HwNmu9p7_T




t2_HysHwTrqBlndTblX_HwNm_u4p12[12][8]HysComp_t2_HwTorqBlendX_HwNmSF12 HysteresisCompensation2-point table of assist valuesYN8X{{0,0.2,0.4,0.6,1,1.4,2,10},{0,0.2,0.4,0.6,1,1.4,2,10},{0,0.2,0.4,0.6,1,1.4,2,10},{0,0.2,0.4,0.6,1,1.4,2,10},{0,0.2,0.4,0.6,1,1.4,2,10},{0,0.2,0.4,0.6,1,1.4,2,10},{0,0.2,0.4,0.6,1,1.4,2,10},{0,0.2,0.4,0.6,1,1.4,2,10},{0,0.2,0.4,0.6,1,1.4,2,10},{0,0.2,0.4,0.6,1,1.4,2,10},{0,0.2,0.4,0.6,1,1.4,2,10},{0,0.2,0.4,0.6,1,1.4,2,10}}010HwNmu4p12_T




t2_HysHwTrqBlndTblY_Uls_u4p12[12][8]HysComp_t2_HwTorqBlendY_UlsSF12 HysteresisCompensation2-point table for scaling output of this function to zero according to the X-values aboveYN8Y{{1,1,1,1,1,1,1,1},{1,1,1,1,1,1,1,1},{1,1,1,1,1,1,1,1},{1,1,1,1,1,1,1,1},{1,1,1,1,1,1,1,1},{1,1,1,1,1,1,1,1},{1,1,1,1,1,1,1,1},{1,1,1,1,1,1,1,1},{1,1,1,1,1,1,1,1},{1,1,1,1,1,1,1,1},{1,1,1,1,1,1,1,1},{1,1,1,1,1,1,1,1}}01Ulsu4p12_T




t_HysRiseTblX_HwNm_u2p14[6]HysComp_t_RiseX_HwNmSF12 HysteresisCompensationTable of handwheel torque values that track a driver’s transition toward or away from corneringYN1X0, 0.094773206, 0.128210527, 0.154492771, 0.181721481, 0.201HwNmu2p14_T




t_HysRiseTblY_Uls_u2p14[6]HysComp_t_RiseY_UlsSF12 HysteresisCompensationTable of scale factors representing the fraction of available compensation to actually applyYN1Y0, 0.6015625, 0.797, 0.912, 0.981, 101Ulsu2p14_T




t_CmnVehSpd_Kph_u9p7[12]Cmn_t_VehSpd_Kph_u9p7SF00 Common CalibrationsVehicle speed 1D table for boundary lookupYN2Z, 3Z{0, 5, 15, 30, 60, 80, 100, 120, 150, 180, 200, 220}0511Kphu9p7_T




t_EffLossTblY_Uls_u4p12[12]HysComp_t_EffLossY_UlsSF12 HysteresisCompensationTable of load-dependent efficiency loss at various vehicle speedsYN3Y0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 001Ulsu4p12_T




t_EffOffTblY_HwNm_u9p7[12]HysComp_t_EffOffY_HwNmSF12 HysteresisCompensationTable that offsets the efficiency loss values aboveYN2Y0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0015HwNmu9p7_T




k_CmnSysTrqRatio_HwNmpMtrNm_f32Cmn_k_SysTrqRatio_HwNmpMtrNmSF00 Common CalibrationsRatio between handwheel and motor, with consideration given to load-dependent losses. Generally set as TrqRatio = KinRatio * Efficiency.YN
201100MtrDegpHwDegfloat32




k_HysOutLIm_HwNm_f32HysComp_k_OutLim_HwNmSF12 HysteresisCompensationFunction output saturation limitYN
16020HwNmfloat32




t_HysCompCoulFricY_HwNm_u9p7[2][12]HysComp_t_CoulFricY_HwNmSF12 HysteresisCompensation2-dimensional table of coulomb friction values. Uses speed table above for x-values. Index 0 = friction values when operating with WIR inactive. Index 1 = tuning for WIR activeYN4Y{{0,0},{0,0},{0,0},{0,0},{0,0},{0,0},{0,0},{0,0},{0,0},{0,0},{0,0},{0,0}}015HwNmu9p7_T




t_HysCompCoulFricTempScaleX_DegC_s14p1[8]HysComp_t_CoulFricTempScaleX_degCSF12 HysteresisCompensationTable of temperature values for scaling sub-function outputYN6X-40, -30, -20, -10, 0, 25, 50, 80-40150DegCs14p1_T




t_HysCompCoulFricTempScaleY_HwNm_u9p7[8]HysComp_t_CoulFricTempScaleY_UlsSF12 HysteresisCompensationTable of scale factors over temperatureYN6Y1, 1, 1, 1, 1, 1, 1, 1010HwNmu9p7_T




t_HysCompHysSatY_HwNm_u9p7[12]HysComp_t_HysSatY_HwNmSF12 HysteresisCompensationTable of saturation values for the total available hysteresis compensationYN7Y15, 15, 15, 15, 15, 15, 15, 15, 15, 15, 15, 15015HwNmu9p7_T




t_HysCompCoulFricWIRBlendX_MtrNm_u8p8[6]HysComp_t_CoulFricWIRBlendX_MtrNmSF12 HysteresisCompensationTable of WIR function command values to blend between CoulFricY tuningsYN5X0, 0.2, 0.4, 0.6, 0.8, 108MtrNmu8p8_T




t_HysCompCoulFricWIRBlendY_Uls_u2p14[6]HysComp_t_CoulFricWIRBlendY_UlsSF12 HysteresisCompensationTable of scale values to blend between CoulFricY tuningsYN5Y0, 0, 0, 0, 0, 001Ulsu2p14_T




t_HysCompNegHysCompX_MtrNm_u8p8[8]HysComp_t_NegHysCompX_MtrNmSF12 HysteresisCompensationTable of WIR command amplitude values for generating negative hysteresis compensationYN10X0, 0.1, 0.2, 0.4, 0.6, 0.8, 0.9, 108MtrNmu8p8_T




t_HysCompNegHysCompY_HwNm_u9p7[8]HysComp_t_NegHysCompY_HwNmSF12 HysteresisCompensationTable of values to subtract from available compensation, sometimes making the sub-function’s output negative.YN10Y0,0,0,0,0 ,0,0,0015HwNmu9p7_T




t_HysCompNegHysBlendX_HwNm_u9p7[5]HysComp_t_NegHysCompBlendX_HwNmSF12 HysteresisCompensationTable of assist values to blend out the negative compensation factor aboveYN9X0, 1, 2, 3, 40255HwNmu9p7_T




t_HysCompNegHysBlendY_Uls_u2p14[5]HysComp_t_NegHysCompBlendY_UlsSF12 HysteresisCompensationTable of scale values to blend out the negative compensation factor aboveYN9Y1, 1, 1, 1, 101Ulsu2p14_T





Sheet 4: Global Constants

HystComp - Rev 24








































































Variable Information (Global Variables Only)

Achieved in Software DesignUsed in Module List





Layer 2Layer 3Layer 4Layer 5
Constant NameDescriptionUintsTypeEngineering ValueADCADC DiagnosticsData Memory VerificationDC Link Power ControlDSP Computational IntegrityDSP SPI driverEvent Manager DriverExternal Memory DriverFlash Programming ExecGPIOIllegal OpCode HandlerInterrupt HandlerMotor Current DriverMotor Driver DiagnosticsMotor Position DriverPhase Feedback CapturePowerdown ControlPrimary Shutdown ControlProgram FlowProgram Memory DiagnosticPWM Duty CycleRedundant Memory CheckRedundant Rapid ShutdownSchedulerStack MonitorState Dependent Task ListSystem Boot & StartupSystem ControlTemperature Sensor DiagnosticUnused Interrupt HandlerUtilization MonitorWatchdog DirverSmithBattery VoltageBattery Voltage DiagnosticsDiagnostic CTC ManagerDiagnostic ManagerDiagnostics Application ServicesEOL TorqueTestFlash Boot LoaderFlight RecorderHandwheel PositionHandwheel TorqueMotor Control Output ConversionMotor Position DiagnosticsMotor Position InitializationMotor VelocityMotor Velocity TachometerSerial Communications I/OSerial Communications ServicesStates and ModesTuning SelectVehicle Power ModeVehicle SpeedController PolarityCurrent EstimationHandwheel VelocityInverse Motor ModelMotor Temperature EstimationMotor Torque LimitOutput Reasonableness DianosticParameter EstimationQuadrant and rate DetectionActive Pull CompensationAssistDampingDuty CycleKinematic Integrity DiagnosticLong Term Vehicle Speed DiagnosticMax Assist LimitReturnState Output ControlTorque Output























































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































Sheet 5: Template

2.2aData File:












Header:extern <TYPE><TAB><NAME>;









Source:#pragma DATA_SECTION(<ROOTNAME>, "<SEGMENT>");
<TYPE> <NAME>;










EOL Constants:












Header:extern <TYPE><TAB><NAME>;









Source:#pragma DATA_SECTION(<ROOTNAME>, "<SEGMENT>");
<TYPE> <NAME>;










Global (Embedded) Constants:












Header:#define <NAME><COL40><VALUE>









A2L Name












Measurement:rte_<SWC>_<NAME>









Calibration Constants:












Tuning ID:



















Tuning:NIndex Range:










Header:extern CONST(<AUTOSAR_TYPE>, CAL_CONST) <NAME>;









Source:#pragma DATA_SECTION(<ROOTNAME>, ".<SEGMENT>");
CONST(<AUTOSAR_TYPE>, CAL_CONST) <NAME> = <VALUE>;










eCal:<NAME>























Tuning:YIndex Range:










Header:extern CONST(<AUTOSAR_TYPE>, CAL_CONST) <NAME>;









Source:#pragma DATA_SECTION(<ROOTNAME>, ".<SEGMENT>");
CONST(<AUTOSAR_TYPE>, CAL_CONST) <NAME> = <VALUE>;










eCal:<NAME>























Tuning:PIndex Range:










Header:extern CONST(<AUTOSAR_TYPE>, CAL_CONST) <NAME>;









Source:#pragma DATA_SECTION(<ROOTNAME>, ".<SEGMENT>");
CONST(<AUTOSAR_TYPE>, CAL_CONST) <NAME> = <VALUE>;










eCal:<NAME>
















Sheet 6: Help

Short cutMacroSescription
Ctrl-qClearDataDictFilterWill clear all autofilters on the Global Data Dictionary




DFD_CreateCreates a Series of Data Flow Worksheet Pages from the information in the data dictionary. If Data Flow Worksheet pages already exist, they will be deleted first.

DFD_DeleteWill clear all Data Flow Diagram pages from the Data Dictionary. This will make the file smaller for archiving.

DFD_PrintFormate and prepares to print the Data Flow Worksheet pages.
Last modified October 12, 2025: Initial commit (0347a62)