Changes between Version 6 and Version 7 of spec/EthSM

Timestamp:

Dec 9, 2022, 2:29:26 PM (17 months ago)

Author:

fujisft-kaji

Comment:

R21-11反映

spec/EthSM

@@ -7 +7 @@
 [[BR]]
 
-{{{#!comment
-[執筆開始時削除エリア]ここから
-※コメントごと削除してください
-}}}
-* '''本項目は、まだ執筆されていません'''
-* '''要望等ございましたら、[wiki: Wikiトップページ]にあります[wiki:#本サイトに関して 問い合わせ先]までお願いします'''
+= 概要 =
+
+* API一覧
+
+  ||= API =||= ID[[BR]][Dec] =||= ID[[BR]][Hex] =||= R21-11 =||
+  || [#EthSM_Init EthSM_Init]                               ||  7|| 0x07||  ○  ||
+  || [#EthSM_GetVersionInfo EthSM_GetVersionInfo]           ||  2|| 0x02||  ○  ||
+  || [#EthSM_RequestComMode EthSM_RequestComMode]           ||  5|| 0x05||  ○  ||
+  || [#EthSM_GetCurrentComMode EthSM_GetCurrentComMode]     ||  4|| 0x04||  ○  ||
+  || [#EthSM_CtrlModeIndication EthSM_CtrlModeIndication]   ||  9|| 0x09||  ○  ||
+  || [#EthSM_TrcvLinkStateChg EthSM_TrcvLinkStateChg]       ||  6|| 0x06||  ○  ||
+  || [#EthSM_TcpIpModeIndication EthSM_TcpIpModeIndication] ||  8|| 0x08||  ○  ||
+  || [#EthSM_SleepIndication EthSM_SleepIndication]         || 10|| 0xa||   ○  ||
+  || [#EthSM_MainFunction EthSM_MainFunction]               ||  1|| 0x01||  ○  ||
+
+* コンフィギュレーション一覧 (R4.1.3/R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11)
+  * [#EthSMGeneral EthSMGeneral] (○/○/○/○/○/○/○)
+    * [#EthSMDevErrorDetect EthSMDevErrorDetect] (○/○/○/○/○/○/○)
+    * [#EthSMDummyMode EthSMDummyMode] (○/○/○/○/○/○/○)
+    * [#EthSMMainFunctionPeriod EthSMMainFunctionPeriod] (○/○/○/○/○/○/○)
+    * [#EthSMVersionInfoApi EthSMVersionInfoApi] (○/○/○/○/○/○/○)
+  * [#EthSMNetwork EthSMNetwork] (○/○/○/○/○/○/○)
+    * [#EthSMComMNetworkHandleRef EthSMComMNetworkHandleRef] (○/○/○/○/○/○/○)
+    * [#EthSMConfirmationTimeout EthSMConfirmationTimeout] (○/-/-/-/-/-/-)
+    * [#EthSMDemEventParameterRefs EthSMDemEventParameterRefs] (○/○/○/○/○/○/○)
+      * [#ETHSM_E_LINK_DOWN ETHSM_E_LINK_DOWN] (○/○/○/○/○/○/○)
+    * [#EthSMEthIfControllerRef EthSMEthIfControllerRef] (○/○/○/○/○/○/○)
+    * [#EthSMForwardSilentCommunicationEnabled EthSMForwardSilentCommunicationEnabled] (-/-/-/-/-/-/○)
+    * [#EthSMWakeupSleepOnDatalineEnabled EthSMWakeupSleepOnDatalineEnabled] (-/-/-/-/-/○/○)
+
+* エラーコード一覧
+  * "--"は[wiki:spec/Dem Dem]により決定される
+
+  ||= エラーコード =||= Dec =||= Hex =||= R21-11 =||
+  || ETHSM_E_INVALID_NETWORK_MODE   ||  1|| 0x01||  ○  ||
+  || ETHSM_E_UNINIT                 ||  2|| 0x02||  ○  ||
+  || ETHSM_E_PARAM_POINTER          ||  3|| 0x03||  ○  ||
+  || ETHSM_E_INVALID_NETWORK_HANDLE ||  4|| 0x04||  ○  ||
+  || ETHSM_E_INVALID_TCP_IP_MODE    ||  5|| 0x05||  ○  ||
+  || ETHSM_E_PARAM_CONTROLLER       ||  7|| 0x07||  ○  ||
+  || ETHSM_E_LINK_DOWN              || --||   --||  ○  ||
+
 ----
-{{{#!comment
-[執筆開始時削除エリア]ここまで
-※コメントごと削除してください
-}}}
-
-= 概要 =
+
+= API仕様 =
+
+== EthSM_Init ==
+{{{
+void EthSM_Init (void)
+}}}
+
+== EthSM_GetVersionInfo ==
+{{{
+void EthSM_GetVersionInfo (Std_VersionInfoType* versioninfo)
+}}}
+
+== EthSM_RequestComMode ==
+{{{
+Std_ReturnType EthSM_RequestComMode (NetworkHandleType NetworkHandle, ComM_ModeType ComM_Mode)
+}}}
+
+== EthSM_GetCurrentComMode ==
+{{{
+Std_ReturnType EthSM_GetCurrentComMode (NetworkHandleType NetworkHandle, ComM_ModeType* ComM_ModePtr)
+}}}
+
+== EthSM_CtrlModeIndication ==
+{{{
+void EthSM_CtrlModeIndication (uint8 CtrlIdx, Eth_ModeType CtrlMode)
+}}}
+
+== EthSM_TrcvLinkStateChg ==
+{{{
+void EthSM_TrcvLinkStateChg (uint8 CtrlIdx, EthTrcv_LinkStateType TransceiverLinkState)
+}}}
+
+== EthSM_TcpIpModeIndication ==
+{{{
+void EthSM_TcpIpModeIndication (uint8 CtrlIdx, TcpIp_StateType TcpIpState)
+}}}
+
+== EthSM_SleepIndication ==
+{{{
+void EthSM_SleepIndication (uint8 Ctrl_Idx)
+}}}
+
+== EthSM_MainFunction ==
+{{{
+void EthSM_MainFunction (void)
+}}}
 
 ----
 
-= API仕様 =
-
-----
-
 = コンフィギュレーション仕様 =
+
+== EthSMGeneral ==
+{{{
+/AUTOSAR/EcucDefs/EthSM/EthSMGeneral
+}}}
+* 対象リビジョン: R4.1.3/R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
+* SWSタグ: ECUC_EthSM_00063
+* タイプ: PARAM-CONF-CONTAINER
+* 多重度: 1
+
+== EthSMDevErrorDetect ==
+{{{
+/AUTOSAR/EcucDefs/EthSM/EthSMGeneral/EthSMDevErrorDetect
+}}}
+* 対象リビジョン: R4.1.3/R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
+* SWSタグ: ECUC_EthSM_00065
+* タイプ: BOOLEAN-PARAM
+* 多重度: 1
+* デフォルト値:
+  * R4.3.1/R4.4.0/R19-11/R20-11/R21-11: false
+
+== EthSMDummyMode ==
+{{{
+/AUTOSAR/EcucDefs/EthSM/EthSMGeneral/EthSMDummyMode
+}}}
+* 対象リビジョン: R4.1.3/R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
+* SWSタグ: ECUC_EthSM_00079
+* タイプ: BOOLEAN-PARAM
+* 多重度: 1
+
+== EthSMMainFunctionPeriod ==
+{{{
+/AUTOSAR/EcucDefs/EthSM/EthSMGeneral/EthSMMainFunctionPeriod
+}}}
+* 対象リビジョン: R4.1.3/R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
+* SWSタグ: ECUC_EthSM_00066
+* タイプ: FLOAT-PARAM
+* 多重度: 1
+* 上限値:
+  * R4.1.3/R4.2.2: 1
+  * R4.3.1/R4.4.0/R19-11/R20-11/R21-11: INF
+* 下限値:
+  * R4.1.3/R4.2.2: 0.005
+  * R4.3.1/R4.4.0/R19-11/R20-11/R21-11: 0
+
+== EthSMVersionInfoApi ==
+{{{
+/AUTOSAR/EcucDefs/EthSM/EthSMGeneral/EthSMVersionInfoApi
+}}}
+* 対象リビジョン: R4.1.3/R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
+* SWSタグ: ECUC_EthSM_00092
+* タイプ: BOOLEAN-PARAM
+* 多重度: 1
+* デフォルト値:
+  * R4.3.1/R4.4.0/R19-11/R20-11/R21-11: false
+
+== EthSMNetwork ==
+{{{
+/AUTOSAR/EcucDefs/EthSM/EthSMNetwork
+}}}
+* 対象リビジョン: R4.1.3/R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
+* SWSタグ: ECUC_EthSM_00067
+* タイプ: PARAM-CONF-CONTAINER
+* 多重度: 1..*
+
+== EthSMComMNetworkHandleRef ==
+{{{
+/AUTOSAR/EcucDefs/EthSM/EthSMNetwork/EthSMComMNetworkHandleRef
+}}}
+* 対象リビジョン: R4.1.3/R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
+* SWSタグ: ECUC_EthSM_00068
+* タイプ:
+  * R4.1.3/R4.2.2/R4.3.1: SYMBOLIC-NAME-REFERENCE
+  * R4.4.0/R19-11/R20-11/R21-11: REFERENCE
+* 多重度: 1
+* 参照先: [wiki:spec/ComM#ComMChannel /AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel]
+
+== EthSMConfirmationTimeout ==
+{{{
+/AUTOSAR/EcucDefs/EthSM/EthSMNetwork/EthSMConfirmationTimeout
+}}}
+* 対象リビジョン: R4.1.3
+* タイプ: FLOAT-PARAM
+* 多重度: 0..1
+* 上限値: INF
+* 下限値: 0
+
+== EthSMDemEventParameterRefs ==
+{{{
+/AUTOSAR/EcucDefs/EthSM/EthSMNetwork/EthSMDemEventParameterRefs
+}}}
+* 対象リビジョン: R4.1.3/R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
+* SWSタグ: ECUC_EthSM_00106
+* タイプ: PARAM-CONF-CONTAINER
+* 多重度: 0..1
+
+== ETHSM_E_LINK_DOWN ==
+{{{
+/AUTOSAR/EcucDefs/EthSM/EthSMNetwork/EthSMDemEventParameterRefs/ETHSM_E_LINK_DOWN
+}}}
+* 対象リビジョン: R4.1.3/R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
+* SWSタグ: ECUC_EthSM_00107
+* タイプ:
+  * R4.1.3/R4.2.2/R4.3.1: SYMBOLIC-NAME-REFERENCE
+  * R4.4.0/R19-11/R20-11/R21-11: REFERENCE
+* 多重度: 0..1
+* 参照先: [wiki:spec/Dem#DemEventParameter /AUTOSAR/EcucDefs/Dem/DemConfigSet/DemEventParameter]
+
+== EthSMEthIfControllerRef ==
+{{{
+/AUTOSAR/EcucDefs/EthSM/EthSMNetwork/EthSMEthIfControllerRef
+}}}
+* 対象リビジョン: R4.1.3/R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
+* SWSタグ: ECUC_EthSM_00105
+* タイプ:
+  * R4.1.3/R4.2.2/R4.3.1: SYMBOLIC-NAME-REFERENCE
+  * R4.4.0/R19-11/R20-11/R21-11: REFERENCE
+* 多重度: 1
+* 参照先: [wiki:spec/EthIf#EthIfController /AUTOSAR/EcucDefs/EthIf/EthIfConfigSet/EthIfController]
+
+== EthSMForwardSilentCommunicationEnabled ==
+{{{
+/AUTOSAR/EcucDefs/EthSM/EthSMNetwork/EthSMForwardSilentCommunicationEnabled
+}}}
+* 対象リビジョン: R21-11
+* SWSタグ: ECUC_EthSM_00110
+* タイプ: BOOLEAN-PARAM
+* 多重度: 1
+* デフォルト値: false
+
+== EthSMWakeupSleepOnDatalineEnabled ==
+{{{
+/AUTOSAR/EcucDefs/EthSM/EthSMNetwork/EthSMWakeupSleepOnDatalineEnabled
+}}}
+* 対象リビジョン: R20-11/R21-11
+* SWSタグ: ECUC_EthSM_00109
+* タイプ: BOOLEAN-PARAM
+* 多重度: 1
+* デフォルト値: false