ComStack_Types.h File Reference

This file is the AUTOSAR communication stack type header file. More...

#include "Std_Types.h"

Go to the source code of this file.

Data Structures
struct	PduInfoType
	This variables shall be used to store the basic information about a PDU. More...
struct	RetryInfoType
	Variables of this type shall be used to store the information about Tp buffer handling. More...

Typedefs
typedef uint8	PduIdType
	This type is used within the entire AUTOSAR Com Stack except for bus drivers.
typedef uint32	PduLengthType
	This type shall be used within the entire AUTOSAR Com Stack except for bus drivers.
typedef uint8	PNCHandleType
	Used to store the identifier of a partial network cluster.
typedef uint8	NetworkHandleType
	This variables shall be used to store the identifier of a communication channel.
typedef uint16	CbkHandleIdType
	Used for the handle Ids of Com and LdCom user callbacks. Tags: atp.Status=draft.

Enumerations
enum	TPParameterType { TP_STMIN = 0x00 , TP_BS = 0x01 , TP_BC = 0x02 }
	Specify the parameter to which the value has to be changed (BS or STmin). More...
enum	BufReq_ReturnType { BUFREQ_OK = 0x00 , BUFREQ_E_NOT_OK = 0x01 , BUFREQ_E_BUSY = 0x02 , BUFREQ_E_OVFL = 0x03 }
	Variables of this type shall be used to store the result of a buffer request. More...
enum	TpDataStateType { TP_DATACONF = 0x00 , TP_DATARETRY = 0x01 , TP_CONFPENDING = 0x02 }
	Variables of this type shall be used to store the state of TP buffer. More...

Detailed Description

This file is the AUTOSAR communication stack type header file.

It contains all types that are used across several modules of the communication stack of the basic software and all types of all basic software modules that are platform and compiler independent. This file contains definitions of variables, structs an enums for the use of ComStack.

Typedef Documentation

CbkHandleIdType

typedef uint16 CbkHandleIdType

Used for the handle Ids of Com and LdCom user callbacks. Tags: atp.Status=draft.

Requirement

SWS_COMTYPE_91001 DRAFT

NetworkHandleType

typedef uint8 NetworkHandleType

This variables shall be used to store the identifier of a communication channel.

Requirement

SWS_COMTYPE_00038

PduIdType

typedef uint8 PduIdType

This type is used within the entire AUTOSAR Com Stack except for bus drivers.

Variables of this type serve as a unique identifier of a PDU within a software module or a set thereof, and also for interaction of two software modules where the PduId of the corresponding target module is being used for referencing. The size of this global type depends on the maximum number of PDUs used within one software module. This parameter shall be generated by the generator tool depending on the value configured in EcuC virtual layer.

Requirement

SWS_COMTYPE_00005, SWS_Comtype_00006, SWS_Comtype_00007, SWS_Comtype_00014

PduLengthType

typedef uint32 PduLengthType

This type shall be used within the entire AUTOSAR Com Stack except for bus drivers.

Variables of this type serve as length information of a PDU. The length information is provided in number of bytes. The maximum length of a Pdu, is the length of the largest (possibly segmented) PDU to be sent by the ECU. This parameter shall be generated by the generator tool depending on the value configured in EcuC virtual layer.

Requirement

SWS_COMTYPE_00008, SWS_Comtype_00010, SWS_Comtype_00017

PNCHandleType

typedef uint8 PNCHandleType

Used to store the identifier of a partial network cluster.

Requirement

SWS_COMTYPE_00036

Enumeration Type Documentation

BufReq_ReturnType

enum BufReq_ReturnType

Variables of this type shall be used to store the result of a buffer request.

Requirement

SWS_COMTYPE_00012

Enumerator
BUFREQ_OK	Buffer request accomplished successful.
BUFREQ_E_NOT_OK	Buffer request not successful. Buffer cannot be accessed.
BUFREQ_E_BUSY	Temporarily no buffer available.
BUFREQ_E_OVFL	No Buffer of the required length can be provided.

TpDataStateType

enum TpDataStateType

Variables of this type shall be used to store the state of TP buffer.

Requirement

SWS_COMTYPE_00027

Enumerator
TP_DATACONF	Indicates that all data that have been copied so far, are confirmed
TP_DATARETRY	Indicates that this API call shall copy already copied data.
TP_CONFPENDING	Indicates that the previously copied data must remain in the TP.

TPParameterType

enum TPParameterType

Specify the parameter to which the value has to be changed (BS or STmin).

Requirement

SWS_COMTYPE_00031

Enumerator
TP_STMIN	Separation Time
TP_BS	Block Size
TP_BC	The Bandwidth cntrl parameter used in FlexRay transport protocol module.