Changes between Version 1 and Version 2 of spec/SomeIpXf

Timestamp:

Dec 14, 2022, 5:32:34 PM (17 months ago)

Author:

fujisft-kaji

Comment:

--

spec/SomeIpXf

@@ -7 +7 @@
 [[BR]]
 
-{{{#!comment
-[執筆開始時削除エリア]ここから
-※コメントごと削除してください
-}}}
-* '''本項目は、まだ執筆されていません'''
-* '''要望等ございましたら、[wiki: Wikiトップページ]にあります[wiki:#本サイトに関して 問い合わせ先]までお願いします'''
-----
-{{{#!comment
-[執筆開始時削除エリア]ここまで
-※コメントごと削除してください
-}}}
+= 概要 =
 
-= 概要 =
+* API一覧
+
+  ||= API =||= ID[[BR]][Dec] =||= ID[[BR]][Hex] =||= R21-11 =||
+  || [#SomeIpXf_ExtractProtocolHeaderFields SomeIpXf_ExtractProtocolHeaderFields] ||   5|| 0x05||  ○  ||
+  || [#SomeIpXf_transformerId SomeIpXf_<transformerId>]                           ||   3|| 0x03||  ○  ||
+  || [#SomeIpXf_Inv_transformerId SomeIpXf_Inv_<transformerId>]                   ||   4|| 0x04||  ○  ||
+  || [#SomeIpXf_Init SomeIpXf_Init]                                               ||   1|| 0x01||  ○  ||
+  || [#SomeIpXf_DeInit SomeIpXf_DeInit]                                           ||   2|| 0x02||  ○  ||
+  || [#SomeIpXf_GetVersionInfo SomeIpXf_GetVersionInfo]                           ||   0|| 0x00||  ○  ||
+
+* コンフィギュレーション一覧
+  * なし
+
+* エラーコード一覧
+
+  ||= エラーコード =||= Dec =||= Hex =||= R21-11 =||
+  || SOMEIPXF_E_UNINIT        ||  1|| 0x01||  ○  ||
+  || SOMEIPXF_E_INIT_FAILED   ||  2|| 0x02||  ○  ||
+  || SOMEIPXF_E_PARAM         ||  3|| 0x03||  ○  ||
+  || SOMEIPXF_E_PARAM_POINTER ||  4|| 0x04||  ○  ||
 
 ----
@@ -25 +34 @@
 = API仕様 =
 
-----
+== SomeIpXf_ExtractProtocolHeaderFields ==
+{{{
+Std_ReturnType SomeIpXf_ExtractProtocolHeaderFields (const uint8* buffer, uint32 bufferLength, Std_MessageTypeType* messageType, Std_MessageResultType* messageResult)
+}}}
 
-= コンフィギュレーション仕様 =
+== SomeIpXf_<transformerId> ==
+{{{
+uint8 SomeIpXf_<transformerId> (uint8* buffer, uint32* bufferLength, <paramtype> dataElement)
+uint8 SomeIpXf_<transformerId> (const Rte_Cs_TransactionHandleType* TransactionHandle, uint8* buffer, uint32* bufferLength, [Std_ReturnType returnValue], <paramtype> data_1, ... <paramtype> data_n)
+uint8 SomeIpXf_<transformerId> (uint8* buffer, uint32* bufferLength)
+}}}
+
+== SomeIpXf_Inv_<transformerId> ==
+{{{
+uint8 SomeIpXf_Inv_<transformerId> (const uint8* buffer, uint32 bufferLength, <type>* dataElement)
+uint8 SomeIpXf_Inv_<transformerId> (Rte_Cs_TransactionHandleType* TransactionHandle, const uint8* buffer, uint32 bufferLength, [Std_ReturnType* returnValue], [<paramtype> data])
+uint8 SomeIpXf_Inv_<transformerId> (const uint8* buffer, uint32 bufferLength)
+}}}
+
+== SomeIpXf_Init ==
+{{{
+void SomeIpXf_Init (const SomeIpXf_ConfigType* config)
+}}}
+
+== SomeIpXf_DeInit ==
+{{{
+void SomeIpXf_DeInit (void)
+}}}
+
+== SomeIpXf_GetVersionInfo ==
+{{{
+void SomeIpXf_GetVersionInfo (Std_VersionInfoType* VersionInfo)
+}}}
+