CORDET Framework - C2 Implementation
CrPsUserConstants.h File Reference

Header file to define all user-configurable constants and types for the IASW Application. More...

Go to the source code of this file.

Macros

#define CR_FW_MAX_PCKT_LENGTH   1000
 Maximum length of a packet expressed in number of bytes (see CrFwPacket.h). More...
 
#define TEST_MAX_APP   10
 Maximum number of target applications for On-Board-Connection Test.
 
#define HK_N_REP_DEF   5
 Number of Report Definitions in the Report Definition List (maximum number of housekeeping/diagnostic reports)
 
#define HK_MAX_SID   3
 Maximum value of a service 3 Structure Identifier (SID)
 
#define HK_COLLECT_PER   3
 Minimum collection period for service 3 reports.
 
#define HK_MAX_N_SIMPLE   3
 Maximum number of simply-commutated parameters in a housekeeping/diagnostic report.
 
#define HK_MAX_N_GR   3
 Maximum number of super-commutated groups in a house- keeping/diagnostic report.
 
#define HK_MAX_REP   3
 Maximum value of the repetition number of a super- commutated group in a housekeeping/diagnostic report.
 
#define HK_MAX_N_REP   3
 Maximum number of data items in a super-commutated groups in a housekeeping/diagnostic report.
 
#define HK_MAX_ID   3
 Maximum value of a data pool item identifier.
 
#define HK_N_SAMP_BUF   3
 Number of service 3 Sampling Buffers.
 
#define HK_N_DEBUG_VAR   3
 Number of debug variables.
 
#define HK_MAX_N_ITEMS   3
 
#define EVT_N_EID   5
 Number of event identifiers supported by the application.
 
#define EVT_EID   {1,2,3,4,5}
 Array of EVT_N_EID elements holding the event identifiers in ascending order.
 
#define EVT_EID_LEVEL   {1,2,3,4,1}
 Array of EVT N EID elements holding the severity level of the event identifiers.
 
#define LPT_N_BUF   5
 
#define LPT_UP_TIMEOUT   100
 
#define OUTFACTORY_FAIL   100
 Failure Codes for Service 5 (Event Report)
 
#define INLOADER_INV_DEST   101
 
#define PART_NMB_ERR   131
 
#define VER_FULL_RDL   201
 Outcome Failure Codes for Service 3 (Housekeeping)
 
#define VER_RDL_CONSTR   202
 
#define VER_SID_IN_USE   203
 
#define VER_DUPL_DI   204
 
#define VER_REP_CR_FD   205
 
#define VER_OUTLOADER_FD   206
 
#define VER_SID_START_FD   207
 
#define VER_S3S_START_FD   208
 
#define VER_ILL_SID   211
 Failure Codes of Service 3 (Housekeeping) for Service 1 (Request Verification)
 
#define VER_ENABLED_SID   212
 
#define VER_EID_START_FD   221
 Outcome Failure Codes for Service 5 (Event Report)
 
#define VER_ILL_EID   225
 Failure Codes of Service 5 (Event Report) for Service 1 (Request Verification)
 
#define LPT_FAILCODE_NO_FAIL   0
 
#define LPT_FAILCODE_TIME_OUT   1
 
#define EVT_DOWN_ABORT   131
 

Typedefs

typedef uint32_t One_Bit_t
 
typedef uint32_t Two_Bit_t
 
typedef uint32_t Three_Bit_t
 
typedef uint32_t Four_Bit_t
 
typedef uint32_t Eleven_Bit_t
 
typedef uint32_t FourTeen_Bit_t
 
typedef uint32_t ParameterId_t
 
typedef uint16_t CrPsApid_t
 Type used for the Application ID of a packet. More...
 
typedef uint32_t CrPsTimeOut_t
 Type used for the Timeout for packets.
 
typedef uint16_t CrPsDestSrc_t
 Type used for the Destination or Source of a packet. More...
 
typedef uint16_t CrPsSeqCtrl_t
 Type used for the Sequence Control of a packet. More...
 
typedef uint16_t CrPsFailCode_t
 Type used for the Failure Code of a packet. More...
 
typedef uint32_t CrPsFailData_t
 Type used for the Failure Data of a packet. More...
 
typedef uint32_t CrPsStepId_t
 Type used for the Step ID of a packet. More...
 
typedef uint16_t CrPsParamId_t
 Type used for the Parameter ID of a packet. More...
 
typedef uint8_t CrPsSid_t
 Type used for the Parameter Report Structure ID of a packet. More...
 
typedef uint32_t CrPsCollectInterval_t
 Type used for the Collection Interval of a packet. More...
 
typedef uint32_t CrPsPeriod_t
 
typedef uint32_t CrPsRepNum_t
 Type used for the Repetition Number of a packet. More...
 
typedef uint8_t CrPsStatus_t
 Type used for the Status of a packet. More...
 
typedef uint32_t CrPsParamValueU4_t
 Type used for Parameter Values of unsigned 32bit Integers. More...
 
typedef uint32_t CrPsValueU4_t
 
typedef uint16_t CrPsEid_t
 Type used for Event Id of a Packet.
 
typedef uint32_t CrPsAux_t
 Type used for the Auxiliary Data of a packet. More...
 
typedef uint32_t CrPsAddr_t
 
typedef uint8_t CrPsFlag_t
 
typedef uint16_t CrPsNumberU2_t
 
typedef uint16_t CrPsRepetition_t
 
typedef uint32_t CrPsNumberU4_t
 
typedef uint16_t CrPsGroup_t
 
typedef uint32_t CrPsTid_t
 
typedef uint32_t CrPsSize_t
 
typedef uint32_t CrPsFailReason_t
 
typedef uint16_t CrPsPart_t
 
typedef uint32_t CrPsRid_t
 

Enumerations

enum  CrPsRepErrCode_t { crInloaderAccFail = 2, crInloaderInvDest = 3, crOutfactoryFail = 4 }
 Identifier for the errors reported through the error reporting interface of CrFwRepErr.h. More...
 

Detailed Description

Header file to define all user-configurable constants and types for the IASW Application.

The content of this file is taken over unchanged from the framework-provided default with the exception of the following items:

  • The value of the application identifier (20 for the IASW).
  • The maximum value of the service type, sub-type and discriminant attributes
Authors
V. Cechticky and A. Pasetti
Author
Christian Reimers chris.nosp@m.tian.nosp@m..reim.nosp@m.ers@.nosp@m.univi.nosp@m.e.ac.nosp@m..at
Markus Rockenbauer marku.nosp@m.s.ro.nosp@m.ckenb.nosp@m.auer.nosp@m.@univ.nosp@m.ie.a.nosp@m.c.at

last modification: 22.01.2018

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Definition in file CrPsUserConstants.h.

Macro Definition Documentation

#define CR_FW_MAX_PCKT_LENGTH   1000

Maximum length of a packet expressed in number of bytes (see CrFwPacket.h).

The value of this constant must be smaller than the range of the CrFwPcktLength_t integer type.The maximum size in number of bytes of a packet

Definition at line 156 of file CrPsUserConstants.h.

Typedef Documentation

typedef uint16_t CrPsApid_t

Type used for the Application ID of a packet.

Definition at line 46 of file CrPsUserConstants.h.

typedef uint32_t CrPsAux_t

Type used for the Auxiliary Data of a packet.

Definition at line 94 of file CrPsUserConstants.h.

typedef uint32_t CrPsCollectInterval_t

Type used for the Collection Interval of a packet.

Definition at line 73 of file CrPsUserConstants.h.

typedef uint16_t CrPsDestSrc_t

Type used for the Destination or Source of a packet.

Definition at line 52 of file CrPsUserConstants.h.

typedef uint16_t CrPsFailCode_t

Type used for the Failure Code of a packet.

Definition at line 58 of file CrPsUserConstants.h.

typedef uint32_t CrPsFailData_t

Type used for the Failure Data of a packet.

Definition at line 61 of file CrPsUserConstants.h.

typedef uint16_t CrPsParamId_t

Type used for the Parameter ID of a packet.

Definition at line 67 of file CrPsUserConstants.h.

typedef uint32_t CrPsParamValueU4_t

Type used for Parameter Values of unsigned 32bit Integers.

Definition at line 85 of file CrPsUserConstants.h.

typedef uint32_t CrPsRepNum_t

Type used for the Repetition Number of a packet.

Definition at line 79 of file CrPsUserConstants.h.

typedef uint16_t CrPsSeqCtrl_t

Type used for the Sequence Control of a packet.

Definition at line 55 of file CrPsUserConstants.h.

typedef uint8_t CrPsSid_t

Type used for the Parameter Report Structure ID of a packet.

Definition at line 70 of file CrPsUserConstants.h.

typedef uint8_t CrPsStatus_t

Type used for the Status of a packet.

Definition at line 82 of file CrPsUserConstants.h.

typedef uint32_t CrPsStepId_t

Type used for the Step ID of a packet.

Definition at line 64 of file CrPsUserConstants.h.

Enumeration Type Documentation

Identifier for the errors reported through the error reporting interface of CrFwRepErr.h.

When a framework component encounters a non-nominal situation during its normal operation, it reports it as an error using the services defined by the CrFwRepErr.h interface. Each error situation is characterized by an error code. This enumerated type defines all the error codes.

Enumerator
crInloaderAccFail 

The Inloader acceptance of a component failed (see CrPsRepErr.h)

crInloaderInvDest 

The Inloader detects an invalid destination (see CrPsRepErr.h)

crOutfactoryFail 

The Outfactory failed to make the component (see CrPsRepErr.h)

Definition at line 138 of file CrPsUserConstants.h.

P&P Software GmbH, Copyright 2012-2013, All Rights Reserved