CORDET Framework - C2 Implementation
|
Header file to define all user-configurable constants and types for the Slave 1 Application of the CORDET Demo. More...
Go to the source code of this file.
Macros | |
#define | CR_FW_MAX_NOF_PCKTS 12 |
The maximum number of packets which can be created with the default packet implementation. More... | |
#define | CR_FW_HOST_APP_ID 2 |
The identifier of the Slave 1 Application of the CORDET Demo. | |
#define | CR_FW_NBITS_APP_ID 4 |
The number of bits reserved for the application identifier in a command or report identifier. | |
#define | CR_FW_MAX_SERV_TYPE 64 |
Maximum value of the service type attribute of InReports and InCommands for the Master Application. | |
#define | CR_FW_MAX_SERV_SUBTYPE 4 |
Maximum value of the service sub-type attribute of InReports and InCommands for the Master Application. | |
#define | CR_FW_MAX_DISCRIMINANT 1 |
Maximum value of the discriminant attribute of InReports and InCommands for the Master Application. | |
Typedefs | |
typedef unsigned short | CrFwInstanceId_t |
Type used for instance identifiers. More... | |
typedef unsigned short int | CrFwTypeId_t |
Type used for the identifier of a component type. More... | |
typedef unsigned char | CrFwOutcome_t |
Type used for the outcome of a check (see CrFwCmpData ). More... | |
typedef unsigned int | CrFwSeqCnt_t |
Type used for the sequence counter of commands or reports. More... | |
typedef float | CrFwTime_t |
Type used for the application time. More... | |
typedef unsigned int | CrFwTimeStamp_t |
Type used for the time stamp of a command or report. More... | |
typedef unsigned int | CrFwTimeCyc_t |
Type used for the number of elapsed cycles. More... | |
typedef unsigned char | CrFwServType_t |
Type used for the service type of a command or report. More... | |
typedef unsigned char | CrFwServSubType_t |
Type used for the command or report sub-type. More... | |
typedef unsigned char | CrFwGroup_t |
Type used for the destination or source group of a packet. More... | |
typedef unsigned char | CrFwDestSrc_t |
Type used for the command or report destination and source. More... | |
typedef unsigned short | CrFwDiscriminant_t |
Type used for the discriminant of a command or report. More... | |
typedef unsigned short | CrFwTrackingIndex_t |
Type for the index used to track the state of a component. More... | |
typedef unsigned short | CrFwCmdRepKindIndex_t |
Type for the index of a command or report kind. More... | |
typedef unsigned int | CrFwCmdRepKindKey_t |
Type for the component kind key in CrFwInFactory.c and CrFwOutFactory.c . More... | |
typedef unsigned char | CrFwOutFactoryPoolIndex_t |
Type for the index in the pool of pre-allocated OutComponents in the OutFactory (see CrFwOutFactory.h ). | |
typedef unsigned char | CrFwInFactoryPoolIndex_t |
Type for the index in the pool of pre-allocated incoming components in the InFactory (see CrFwInFactory.h ). | |
typedef unsigned char | CrFwCounterU1_t |
Type used for unsigned integers with a "short" range. More... | |
typedef signed char | CrFwCounterS1_t |
Type used for signed integers with a "short" range. More... | |
typedef unsigned short | CrFwCounterU2_t |
Type used for unsigned integers with a "medium" range. More... | |
typedef unsigned short int | CrFwPcktLength_t |
Type for the packet length. More... | |
Header file to define all user-configurable constants and types for the Slave 1 Application of the CORDET Demo.
The content of this file is taken over unchanged from the framework-provided default with the exception of the following items:
This file is part of the CORDET Framework.
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/.
For information on alternative licensing, please contact P&P Software GmbH.
Definition in file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
#define CR_FW_MAX_NOF_PCKTS 12 |
The maximum number of packets which can be created with the default packet implementation.
The value of this constant must not exceed the range of the CrFwCounterU2_t
type.
Definition at line 214 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned short CrFwCmdRepKindIndex_t |
Type for the index of a command or report kind.
Definition at line 72 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned int CrFwCmdRepKindKey_t |
Type for the component kind key in CrFwInFactory.c
and CrFwOutFactory.c
.
Definition at line 75 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef signed char CrFwCounterS1_t |
Type used for signed integers with a "short" range.
Definition at line 93 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned char CrFwCounterU1_t |
Type used for unsigned integers with a "short" range.
Definition at line 90 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned short CrFwCounterU2_t |
Type used for unsigned integers with a "medium" range.
Definition at line 96 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned char CrFwDestSrc_t |
Type used for the command or report destination and source.
Definition at line 63 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned short CrFwDiscriminant_t |
Type used for the discriminant of a command or report.
Definition at line 66 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned char CrFwGroup_t |
Type used for the destination or source group of a packet.
Definition at line 60 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned short CrFwInstanceId_t |
Type used for instance identifiers.
Definition at line 31 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned char CrFwOutcome_t |
Type used for the outcome of a check (see CrFwCmpData
).
Definition at line 37 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned short int CrFwPcktLength_t |
Type for the packet length.
Definition at line 99 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned int CrFwSeqCnt_t |
Type used for the sequence counter of commands or reports.
Definition at line 40 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned char CrFwServSubType_t |
Type used for the command or report sub-type.
Definition at line 57 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned char CrFwServType_t |
Type used for the service type of a command or report.
Definition at line 54 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef float CrFwTime_t |
Type used for the application time.
Definition at line 43 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned int CrFwTimeCyc_t |
Type used for the number of elapsed cycles.
Many applications operate on a cyclical basis and this type is used for the number of elapsed execution cycles.
Definition at line 51 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned int CrFwTimeStamp_t |
Type used for the time stamp of a command or report.
Definition at line 46 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned short CrFwTrackingIndex_t |
Type for the index used to track the state of a component.
Definition at line 69 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
typedef unsigned short int CrFwTypeId_t |
Type used for the identifier of a component type.
Definition at line 34 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
enum CrFwAppErrCode_t |
Application error code for the framework components.
An application error is declared when a framework function has been called by the application code with an illegal parameter values or in an illegal context and execution of the function with the illegal values would cause an internal framework data structure to be corrupted.
Nominally, the application error code should be equal to: crNoAppErr
. If the application error code has a different value, then an application error has been encountered. If multiple errors have been encountered, the application error code reflects the most recent error.
Enumerator | |
---|---|
crNoAppErr |
No application errors have been detected. |
crNotOutStream |
An OutStream function was called on an object which is not an OutStream. |
crOutStreamIllId |
A framework function has been called with an illegal OutStream identifier. |
crOutStreamUndefDest |
A framework function has been called with a destination attribute which is not associated to any OutStream. |
crInStreamUndefDest |
A framework function has been called with a source attribute which is not associated to any InStream. |
crPcktAllocationFail |
A packet allocation request has failed (see |
crPcktRelErr |
A packet release request has encountered an error (see |
crNotInStream |
An InStream function was called on an object which is not an InStream. |
crInStreamIllId |
A framework function has been called with an illegal InStream identifier. |
crNotOutCmp |
An OutComponent function was called on an object which is not an OutComponent. |
crOutCmpAllocationFail |
An OutComponent allocation request has failed (see |
crOutCmpRelErr |
An OutComponent release request has encountered an error (see |
crIllServType |
A framework function was called with an illegal service type. |
crIllServSubType |
A framework function was called with an illegal service sub-type. |
crIllDiscriminant |
A framework function was called with an illegal discriminant. |
crIllOutCmpType |
A framework function was called with an illegal type/sub-type pair for an OutComponent. |
crIllOutCmpKind |
A framework function was called with an illegal type/sub-type/discriminant triplet for an OutComponent. |
crOutManagerIllId |
A framework function has been called with an illegal OutManager identifier. |
crIllInCmdKind |
A framework function was called with an illegal type/sub-type/discriminant triplet for an InCommand. |
crInCmdAllocationFail |
Allocation request for a packet for an InCommand has failed (see |
crIllInRepKind |
A framework function was called with an illegal type/sub-type/discriminant triplet for an InReport. |
crInRepAllocationFail |
Allocation request for an InReport has failed (see |
crInRepRelErr |
An InReport release request has encountered an error (see |
crInCmdRelErr |
An InCommand release request has encountered an error (see |
crInManagerIllId |
A framework function has been called with an illegal InManager identifier. |
crNoAppErr |
No application errors have been detected. |
crNotOutStream |
An OutStream function was called on an object which is not an OutStream. |
crOutStreamIllId |
A framework function has been called with an illegal OutStream identifier. |
crOutStreamUndefDest |
A framework function has been called with a destination attribute which is not associated to any OutStream. |
crInStreamUndefDest |
A framework function has been called with a source attribute which is not associated to any InStream. |
crPcktAllocationFail |
A packet allocation request has failed (see |
crPcktRelErr |
A packet release request has encountered an error (see |
crNotInStream |
An InStream function was called on an object which is not an InStream. |
crInStreamIllId |
A framework function has been called with an illegal InStream identifier. |
crNotOutCmp |
An OutComponent function was called on an object which is not an OutComponent. |
crOutCmpAllocationFail |
An OutComponent allocation request has failed (see |
crOutCmpRelErr |
An OutComponent release request has encountered an error (see |
crIllServType |
A framework function was called with an illegal service type. |
crIllServSubType |
A framework function was called with an illegal service sub-type. |
crIllDiscriminant |
A framework function was called with an illegal discriminant. |
crIllOutCmpType |
A framework function was called with an illegal type/sub-type pair for an OutComponent. |
crIllOutCmpKind |
A framework function was called with an illegal type/sub-type/discriminant triplet for an OutComponent. |
crOutManagerIllId |
A framework function has been called with an illegal OutManager identifier. |
crIllInCmdKind |
A framework function was called with an illegal type/sub-type/discriminant triplet for an InCommand. |
crInCmdAllocationFail |
Allocation request for a packet for an InCommand has failed (see |
crIllInRepKind |
A framework function was called with an illegal type/sub-type/discriminant triplet for an InReport. |
crInRepAllocationFail |
Allocation request for an InReport has failed (see |
crInRepRelErr |
An InReport release request has encountered an error (see |
crInCmdRelErr |
An InCommand release request has encountered an error (see |
crInManagerIllId |
A framework function has been called with an illegal InManager identifier. |
crNoAppErr |
No application errors have been detected. |
crNotOutStream |
An OutStream function was called on an object which is not an OutStream. |
crOutStreamIllId |
A framework function has been called with an illegal OutStream identifier. |
crOutStreamUndefDest |
A framework function has been called with a destination attribute which is not associated to any OutStream. |
crInStreamUndefDest |
A framework function has been called with a source attribute which is not associated to any InStream. |
crPcktAllocationFail |
A packet allocation request has failed (see |
crPcktRelErr |
A packet release request has encountered an error (see |
crNotInStream |
An InStream function was called on an object which is not an InStream. |
crInStreamIllId |
A framework function has been called with an illegal InStream identifier. |
crNotOutCmp |
An OutComponent function was called on an object which is not an OutComponent. |
crOutCmpAllocationFail |
An OutComponent allocation request has failed (see |
crOutCmpRelErr |
An OutComponent release request has encountered an error (see |
crIllServType |
A framework function was called with an illegal service type. |
crIllServSubType |
A framework function was called with an illegal service sub-type. |
crIllDiscriminant |
A framework function was called with an illegal discriminant. |
crIllOutCmpType |
A framework function was called with an illegal type/sub-type pair for an OutComponent. |
crIllOutCmpKind |
A framework function was called with an illegal type/sub-type/discriminant triplet for an OutComponent. |
crOutManagerIllId |
A framework function has been called with an illegal OutManager identifier. |
crIllInCmdKind |
A framework function was called with an illegal type/sub-type/discriminant triplet for an InCommand. |
crInCmdAllocationFail |
Allocation request for a packet for an InCommand has failed (see |
crIllInRepKind |
A framework function was called with an illegal type/sub-type/discriminant triplet for an InReport. |
crInRepAllocationFail |
Allocation request for an InReport has failed (see |
crInRepRelErr |
An InReport release request has encountered an error (see |
crInCmdRelErr |
An InCommand release request has encountered an error (see |
crInManagerIllId |
A framework function has been called with an illegal InManager identifier. |
crNoAppErr |
No application errors have been detected. |
crNotOutStream |
An OutStream function was called on an object which is not an OutStream. |
crOutStreamIllId |
A framework function has been called with an illegal OutStream identifier. |
crOutStreamUndefDest |
A framework function has been called with a destination attribute which is not associated to any OutStream. |
crInStreamUndefDest |
A framework function has been called with a source attribute which is not associated to any InStream. |
crPcktAllocationFail |
A packet allocation request has failed (see |
crPcktRelErr |
A packet release request has encountered an error (see |
crNotInStream |
An InStream function was called on an object which is not an InStream. |
crInStreamIllId |
A framework function has been called with an illegal InStream identifier. |
crNotOutCmp |
An OutComponent function was called on an object which is not an OutComponent. |
crOutCmpAllocationFail |
An OutComponent allocation request has failed (see |
crOutCmpRelErr |
An OutComponent release request has encountered an error (see |
crIllServType |
A framework function was called with an illegal service type. |
crIllServSubType |
A framework function was called with an illegal service sub-type. |
crIllDiscriminant |
A framework function was called with an illegal discriminant. |
crIllOutCmpType |
A framework function was called with an illegal type/sub-type pair for an OutComponent. |
crIllOutCmpKind |
A framework function was called with an illegal type/sub-type/discriminant triplet for an OutComponent. |
crOutManagerIllId |
A framework function has been called with an illegal OutManager identifier. |
crIllInCmdKind |
A framework function was called with an illegal type/sub-type/discriminant triplet for an InCommand. |
crInCmdAllocationFail |
Allocation request for a packet for an InCommand has failed (see |
crIllInRepKind |
A framework function was called with an illegal type/sub-type/discriminant triplet for an InReport. |
crInRepAllocationFail |
Allocation request for an InReport has failed (see |
crInRepRelErr |
An InReport release request has encountered an error (see |
crInCmdRelErr |
An InCommand release request has encountered an error (see |
crInManagerIllId |
A framework function has been called with an illegal InManager identifier. |
Definition at line 151 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.
enum CrFwRepErrCode_t |
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 | |
---|---|
crOutStreamPQFull |
The packet queue of an OutStream is full (see |
crInStreamPQFull |
The packet queue of an InStream is full (see |
crInStreamSCErr |
An InStream has encountered a sequence counter error (see |
crOutCmpSendPcktInvDest |
An OutComponent has an invalid destination (see |
crOutManagerPoclFull |
The Pending OutComponent List (POCL) of an OutManager is full (see |
crInManagerPcrlFull |
The Pending Command/Report List (PCRL) of an InManager is full (see |
crInLoaderInvDest |
The InLoader has retrieved a packet with an invalid destination (see |
crInLoaderAccFail |
An InReport or InCommand has failed its acceptance check. |
crOutStreamIllGroup |
An OutComponent has an illegal group. |
crInStreamIllGroup |
An incoming command or report has an illegal group. |
crOutStreamNoMorePckt |
An OutStream cannot buffer an out-going packet because no more packets are available (see |
crInLoaderCreFail |
An InReport could not be created due to insufficient resources or illegal type/sub-type/discriminant. |
crInLoaderLdFail |
An InReport could not be loaded in its InManager. |
crOutStreamPQFull |
The packet queue of an OutStream is full (see |
crInStreamPQFull |
The packet queue of an InStream is full (see |
crInStreamSCErr |
An InStream has encountered a sequence counter error (see |
crOutCmpSendPcktInvDest |
An OutComponent has an invalid destination (see |
crOutManagerPoclFull |
The Pending OutComponent List (POCL) of an OutManager is full (see |
crInManagerPcrlFull |
The Pending Command/Report List (PCRL) of an InManager is full (see |
crInLoaderInvDest |
The InLoader has retrieved a packet with an invalid destination (see |
crInLoaderAccFail |
An InReport or InCommand has failed its acceptance check. |
crOutStreamIllGroup |
An OutComponent has an illegal group. |
crInStreamIllGroup |
An incoming command or report has an illegal group. |
crOutStreamNoMorePckt |
An OutStream cannot buffer an out-going packet because no more packets are available (see |
crInLoaderCreFail |
An InReport could not be created due to insufficient resources or illegal type/sub-type/discriminant. |
crInLoaderLdFail |
An InReport could not be loaded in its InManager. |
crOutStreamPQFull |
The packet queue of an OutStream is full (see |
crInStreamPQFull |
The packet queue of an InStream is full (see |
crInStreamSCErr |
An InStream has encountered a sequence counter error (see |
crOutCmpSendPcktInvDest |
An OutComponent has an invalid destination (see |
crOutManagerPoclFull |
The Pending OutComponent List (POCL) of an OutManager is full (see |
crInManagerPcrlFull |
The Pending Command/Report List (PCRL) of an InManager is full (see |
crInLoaderInvDest |
The InLoader has retrieved a packet with an invalid destination (see |
crInLoaderAccFail |
An InReport or InCommand has failed its acceptance check. |
crOutStreamIllGroup |
An OutComponent has an illegal group. |
crInStreamIllGroup |
An incoming command or report has an illegal group. |
crOutStreamNoMorePckt |
An OutStream cannot buffer an out-going packet because no more packets are available (see |
crInLoaderCreFail |
An InReport could not be created due to insufficient resources or illegal type/sub-type/discriminant. |
crInLoaderLdFail |
An InReport could not be loaded in its InManager. |
crOutStreamPQFull |
The packet queue of an OutStream is full (see |
crInStreamPQFull |
The packet queue of an InStream is full (see |
crInStreamSCErr |
An InStream has encountered a sequence counter error (see |
crOutCmpSendPcktInvDest |
An OutComponent has an invalid destination (see |
crOutManagerPoclFull |
The Pending OutComponent List (POCL) of an OutManager is full (see |
crInManagerPcrlFull |
The Pending Command/Report List (PCRL) of an InManager is full (see |
crInLoaderInvDest |
The InLoader has retrieved a packet with an invalid destination (see |
crInLoaderAccFail |
An InReport has failed its validity check. |
crOutStreamIllGroup |
An OutComponent has an illegal group. |
crInStreamIllGroup |
An incoming command or report has an illegal group. |
crOutStreamNoMorePckt |
An OutStream cannot buffer an out-going packet because no more packets are available (see |
crInLoaderCreFail |
An InReport could not be created due to insufficient resources or illegal type/sub-type/discriminant. |
crInLoaderLdFail |
An InReport could not be loaded in its InManager. |
Definition at line 109 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwUserConstants.h.