DEENESPTFRRUARHIKOZHNL

COM Based Transformer (ComXf)

ModulComXf (COM Based Transformer)
BSW-Modul-ID175
Standard-Header#include "ComXf.h"
SWS-SpezifikationAUTOSAR_CP_SWS_COMBasedTransformer.pdf, AUTOSAR_SWS_COMBasedTransformer.pdf
Umfang34 Records · 10 Snippets
ClusterKommunikationsdienste (COM)

COM Based Transformer (ComXf)

AUTOSAR Classic Communication Services-Modul COM Based Transformer (ComXf, Spezifikation: AUTOSAR_CP_SWS_COMBasedTransformer.pdf, AUTOSAR_SWS_COMBasedTransformer.pdf).

Funktionen — Übersicht

Typen — Übersicht

Anforderungen — Übersicht

Funktionen & Typen — Detailansicht

fonction ComXf_<transformerId> [SWS_ComXf_00007] 📄 PDF

uint8 ComXf_<transformerId>(uint8* buffer, uint32* bufferLength, <paramtype> dataElement);

This function transforms a Sender/Receiver communication using the serialization of COM Based Transformer. It takes the data element as input and outputs a uint8 array containing the serialized data.

fonction ComXf_Inv_<transformerId> [SWS_ComXf_00010] 📄 PDF

uint8 ComXf_Inv_<transformerId>(const uint8* buffer, uint32 bufferLength, <type>* dataElement);

This function deserializes a Sender/Receiver communication using the deserialization of COM Based Transformer. It takes the uint8 array containing the serialized data as input and outputs the original data element which will be passed to the Rte.

fonction ComXf_Init [SWS_ComXf_00026] 📄 PDF

void ComXf_Init(const ComXf_ConfigType* config);

This service initializes the transformer for the further processing.

type ComXf_ConfigType [SWS_ComXf_00030] 📄 PDF

This is the type of the data structure containing the initialization data for the transformer.

requirement SWS_ComXf_00003 [SWS_ComXf_00003] 📄 PDF

The COM Based transformer shall only be used as the top- most transformer (first) in a transformer chain.

requirement SWS_ComXf_00004 [SWS_ComXf_00004] 📄 PDF

The COM Based transformer defined in this document shall be used as a transformer if • the attribute protocol of the TransformationTechnology is set to COM- Based • and the attribute version of the TransformationTechnology is set to 1.0.0 • and the attribute transformerClass of the TransformationTechnology is set to serializer

requirement SWS_ComXf_00005 [SWS_ComXf_00005] 📄 PDF

The serialization is based on the Ecu configuration of the COM module and • the Software Components PortPrototype , • the dataElement list defined by the respective SenderReceiverInterface , • the SenderReceiverToSignalGroupMapping , • and the ISignalToIPduMapping for the SystemSignalGroup .

requirement SWS_ComXf_00006 [SWS_ComXf_00006] 📄 PDF

The COM Based Transformer shall only provide functions for transformers where the TransformationTechnology is referenced as the first ref- erence in the list of ordered references transformerChain from a DataTransfor- mation to a TransformationTechnology .

requirement SWS_ComXf_00008 [SWS_ComXf_00008] 📄 PDF

The function specified in [SWS_ComXf_00007] shall exist for the first reference in the list of ordered references transformerChain from a DataTransformation to a TransformationTechnology if the DataTransfor- mation is referenced by an ISignalGroup in the role comBasedSignalGroup- Transformation where the ISignalGroup references a SystemSignalGroup which is referenced by SenderReceiverToSignalGroupMapping .

requirement SWS_ComXf_00009 [SWS_ComXf_00009] 📄 PDF

The function specified in [SWS_ComXf_00007] shall serial- ize complex data elements of Sender/Receiver communication into a linear byte array representation using the COM Based Transformation.

requirement SWS_ComXf_00011 [SWS_ComXf_00011] 📄 PDF

The function specified in [SWS_ComXf_00010] shall exist for the first reference in the list of ordered references transformerChain from a DataTransformation to a TransformationTechnology if the DataTransfor- mation is referenced by an ISignalGroup in the role comBasedSignalGroup- Transformation where the ISignalGroup references a SystemSignalGroup which is referenced by SenderReceiverToSignalGroupMapping .

requirement SWS_ComXf_00012 [SWS_ComXf_00012] 📄 PDF

The function specified in [SWS_ComXf_00010] shall deserial- ize a linear byte array to primitive or complex data elements of Sender/Receiver com- munication using the COM Based Transformation.

requirement SWS_ComXf_00013 [SWS_ComXf_00013] 📄 PDF

To allow migration, the deserialization shall be able to accept larger array representations and ignore dataElements appended at the end of a previ- ously known parameter list.

requirement SWS_ComXf_00015 [SWS_ComXf_00015] 📄 PDF

The COM Based Transformer shall support all basic data types that are supported by the COM module in [SWS_Com_00675] except for UINT8_DYN .

requirement SWS_ComXf_00016 [SWS_ComXf_00016] 📄 PDF

The COM Based Transformer shall handle each dataEle- ment of the SenderReceiverInterface individually.

requirement SWS_ComXf_00017 [SWS_ComXf_00017] 📄 PDF

The COM Based Transformer does not support Client-Server communication.

requirement SWS_ComXf_00018 [SWS_ComXf_00018] 📄 PDF

The COM Based Transformer only supports composite data types (i.e. Signal Groups from COM).

requirement SWS_ComXf_00020 [SWS_ComXf_00020] 📄 PDF

The COM Based Transformer shall place the serialized data element into the data buffer at the bit position according to the configuration of the ISignalGroup in Com.

requirement SWS_ComXf_00021 [SWS_ComXf_00021] 📄 PDF

The COM Based Transformer shall handle each dataEle- ment of the SenderReceiverInterface like defined for the COM module [4] when the COM API Com_SendSignal (rep. Com_ReceiveSignal ) is called for a shadow signal.

requirement SWS_ComXf_00022 [SWS_ComXf_00022] 📄 PDF

The COM Based Transformer only supports signal groups which are byte aligned.

requirement SWS_ComXf_00023 [SWS_ComXf_00023] 📄 PDF

The COM Based Transformer shall support signal group where all group signals are mapped successively (possibly with gaps where positions in the signal group layout have no corresponding signal defined) to the IPdu.

requirement SWS_ComXf_00025 [SWS_ComXf_00025] 📄 PDF

The apiServicePrefix of the COM Based Transformer's EcuC shall be set to ComXf .

requirement SWS_ComXf_00028 [SWS_ComXf_00028] 📄 PDF

Type of error Related error code Error value Error code if any other API service, except Get VersionInfo, is called before the transformer module was initialized with Init or after a call to De Init. <MIP>_E_UNINIT 0x01 Type of error Related error code Error value Error code if an invalid configuration set was selected <MIP>_E_INIT_FAILED 0x02 API service called with wrong parameter <MIP>_E_PARAM 0x03 API service called with invalid pointer <MIP>_E_PARAM_POINTER 0x04

requirement SWS_ComXf_00031 [SWS_ComXf_00031] 📄 PDF

The COM Based Transformer is configured based on the COM module configuration [4].

requirement SWS_ComXf_00032 [SWS_ComXf_00032] 📄 PDF

The COM Based Transformer does not support external trig- ger communication.

requirement SWS_ComXf_00033 [SWS_ComXf_00033] 📄 PDF

The vendor specific module definition of the COM Based Transformer - based on the Xfrm configuration [2] - may be extended by the vendor to support the close interaction with the Com module [4].

requirement SWS_ComXf_00034 [SWS_ComXf_00034] 📄 PDF

The COM Based Transformer shall be configured to be post- Build when the configuration of the Com module [4] is postBuild for the respective ComSignalGroup s.

requirement SWS_ComXf_00035 [SWS_ComXf_00035] 📄 PDF

If ComXf_Inv_<transformerId> specified in [SWS_ComXf_00010] is called with buffer equal to NULL_PTR and buffer- Length equal to 0 , then the output buffer buffer shall not be changed and ComXf_Inv_<transformerId> shall return with E_NO_DATA .

requirement SWS_ComXf_00036 [SWS_ComXf_00036] 📄 PDF

If the signal layout of the signal group array representation contains gaps, those gaps shall be set during transmission to the value defined by the ComTxIPduUnusedAreasDefault of the respective ComTxIPdu that this signal group is mapped to.

requirement SWS_ComXf_00037 [SWS_ComXf_00037] 📄 PDF

Buffer reservation for further transformers The COM Based Transformer shall consider the header and/or trailer ISignal s defined in the ISignalGroup which are processed by further transformers.

requirement SWS_ComXf_NA_00999 [SWS_ComXf_NA_00999] 📄 PDF

doesn’t use a complete Software Component Description (VFB View) the "legacy" policy can be chosen. initValue ValueSpecification 0..1 aggr Optional definition of a ISignal’s initValue in case the System Description doesn’t use a complete Software Component Description (VFB View). This supports the inclusion of legacy system signals. This value can be used to configure the Signal’s "Init Value". If a full DataMapping exist for the SystemSignal this information may be available from a configured Sender ComSpec and ReceiverComSpec. In this case the initvalues in SenderComSpec and/or ReceiverComSpec override this optional value specification. Further restrictions apply from the RTE specification. ▽

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/CP_MOD_ComXf
Status
unspecified
Version
AUTOSAR/AP/record/CP_MOD_ComXf@rel:R20-11#b634d576
Content hash
b634d576
Source
https://www.autosar.org/fileadmin/standards/R20-11/CP/AUTOSAR_SWS_COMBasedTransformer.pdf#nameddest=SWS_ComXf_00007

Initialisation et état

ComXf_DeInit fonction

This service deinitializes the transformer.

void ComXf_DeInit(void);

This service returns the version information of the called transformer module.

void ComXf_GetVersionInfo(Std_VersionInfoType* VersionInfo);
ComXf_Init fonction

This service initializes the transformer for the further processing.

void ComXf_Init(const ComXf_ConfigType* config);

Services

This function deserializes a Sender/Receiver communication using the deserialization of COM Based Transformer. It takes the uint8 array containing the serialized data as input and outputs the original data element which will be passed to the Rte.

uint8 ComXf_Inv_<transformerId>(const uint8* buffer, uint32 bufferLength, <type>* dataElement);

This function transforms a Sender/Receiver communication using the serialization of COM Based Transformer. It takes the data element as input and outputs a uint8 array containing the serialized data.

uint8 ComXf_<transformerId>(uint8* buffer, uint32* bufferLength, <paramtype> dataElement);

Types

This is the type of the data structure containing the initialization data for the transformer.

Exigences

SWS_ComXf_00003 requirement

The COM Based transformer shall only be used as the top- most transformer (first) in a transformer chain.

SWS_ComXf_00004 requirement

The COM Based transformer defined in this document shall be used as a transformer if • the attribute protocol of the TransformationTechnology is set to COM- Based • and the attribute version of the TransformationTechnology is set to 1.0.0 • and the attribute transformerClass of the TransformationTechnology is set to serializer

SWS_ComXf_00005 requirement

The serialization is based on the Ecu configuration of the COM module and • the Software Components PortPrototype , • the dataElement list defined by the respective SenderReceiverInterface , • the SenderReceiverToSignalGroupMapping , • and the ISignalToIPduMapping for the SystemSignalGroup .

SWS_ComXf_00006 requirement

The COM Based Transformer shall only provide functions for transformers where the TransformationTechnology is referenced as the first ref- erence in the list of ordered references transformerChain from a DataTransfor- mation to a TransformationTechnology .

SWS_ComXf_00008 requirement

The function specified in [SWS_ComXf_00007] shall exist for the first reference in the list of ordered references transformerChain from a DataTransformation to a TransformationTechnology if the DataTransfor- mation is referenced by an ISignalGroup in the role comBasedSignalGroup- Transformation where the ISignalGroup references a SystemSignalGroup which is referenced by SenderReceiverToSignalGroupMapping .

SWS_ComXf_00009 requirement

The function specified in [SWS_ComXf_00007] shall serial- ize complex data elements of Sender/Receiver communication into a linear byte array representation using the COM Based Transformation.

SWS_ComXf_00011 requirement

The function specified in [SWS_ComXf_00010] shall exist for the first reference in the list of ordered references transformerChain from a DataTransformation to a TransformationTechnology if the DataTransfor- mation is referenced by an ISignalGroup in the role comBasedSignalGroup- Transformation where the ISignalGroup references a SystemSignalGroup which is referenced by SenderReceiverToSignalGroupMapping .

SWS_ComXf_00012 requirement

The function specified in [SWS_ComXf_00010] shall deserial- ize a linear byte array to primitive or complex data elements of Sender/Receiver com- munication using the COM Based Transformation.

SWS_ComXf_00013 requirement

To allow migration, the deserialization shall be able to accept larger array representations and ignore dataElements appended at the end of a previ- ously known parameter list.

SWS_ComXf_00015 requirement

The COM Based Transformer shall support all basic data types that are supported by the COM module in [SWS_Com_00675] except for UINT8_DYN .

SWS_ComXf_00016 requirement

The COM Based Transformer shall handle each dataEle- ment of the SenderReceiverInterface individually.

SWS_ComXf_00017 requirement

The COM Based Transformer does not support Client-Server communication.

SWS_ComXf_00018 requirement

The COM Based Transformer only supports composite data types (i.e. Signal Groups from COM).

SWS_ComXf_00019 requirement

The COM Based Transformer only supports fix sized data types.

SWS_ComXf_00020 requirement

The COM Based Transformer shall place the serialized data element into the data buffer at the bit position according to the configuration of the ISignalGroup in Com.

SWS_ComXf_00021 requirement

The COM Based Transformer shall handle each dataEle- ment of the SenderReceiverInterface like defined for the COM module [4] when the COM API Com_SendSignal (rep. Com_ReceiveSignal ) is called for a shadow signal.

SWS_ComXf_00022 requirement

The COM Based Transformer only supports signal groups which are byte aligned.

SWS_ComXf_00023 requirement

The COM Based Transformer shall support signal group where all group signals are mapped successively (possibly with gaps where positions in the signal group layout have no corresponding signal defined) to the IPdu.

SWS_ComXf_00025 requirement

The apiServicePrefix of the COM Based Transformer's EcuC shall be set to ComXf .

SWS_ComXf_00028 requirement

Type of error Related error code Error value Error code if any other API service, except Get VersionInfo, is called before the transformer module was initialized with Init or after a call to De Init. <MIP>_E_UNINIT 0x01 Type of error Related error code Error value Error code if an invalid configuration set was selected <MIP>_E_INIT_FAILED 0x02 API service called with wrong parameter <MIP>_E_PARAM 0x03 API service called with invalid pointer <MIP>_E_PARAM_POINTER 0x04

SWS_ComXf_00031 requirement

The COM Based Transformer is configured based on the COM module configuration [4].

SWS_ComXf_00032 requirement

The COM Based Transformer does not support external trig- ger communication.

SWS_ComXf_00033 requirement

The vendor specific module definition of the COM Based Transformer - based on the Xfrm configuration [2] - may be extended by the vendor to support the close interaction with the Com module [4].

SWS_ComXf_00034 requirement

The COM Based Transformer shall be configured to be post- Build when the configuration of the Com module [4] is postBuild for the respective ComSignalGroup s.

SWS_ComXf_00035 requirement

If ComXf_Inv_<transformerId> specified in [SWS_ComXf_00010] is called with buffer equal to NULL_PTR and buffer- Length equal to 0 , then the output buffer buffer shall not be changed and ComXf_Inv_<transformerId> shall return with E_NO_DATA .

SWS_ComXf_00036 requirement

If the signal layout of the signal group array representation contains gaps, those gaps shall be set during transmission to the value defined by the ComTxIPduUnusedAreasDefault of the respective ComTxIPdu that this signal group is mapped to.

SWS_ComXf_00037 requirement

Buffer reservation for further transformers The COM Based Transformer shall consider the header and/or trailer ISignal s defined in the ISignalGroup which are processed by further transformers.

SWS_ComXf_NA_00999 requirement

doesn’t use a complete Software Component Description (VFB View) the "legacy" policy can be chosen. initValue ValueSpecification 0..1 aggr Optional definition of a ISignal’s initValue in case the System Description doesn’t use a complete Software Component Description (VFB View). This supports the inclusion of legacy system signals. This value can be used to configure the Signal’s "Init Value". If a full DataMapping exist for the SystemSignal this information may be available from a configured Sender ComSpec and ReceiverComSpec. In this case the initvalues in SenderComSpec and/or ReceiverComSpec override this optional value specification. Further restrictions apply from the RTE specification. ▽