Changes between Version 6 and Version 7 of spec/LinSM

Timestamp:

Aug 17, 2020, 10:25:53 PM (4 years ago)

Author:

fujisft-shigihara

Comment:

--

spec/LinSM

@@ -7 +7 @@
 [[BR]]
 
-{{{#!comment
-[執筆開始時削除エリア]ここから
-※コメントごと削除してください
-}}}
-* '''本項目は、まだ執筆されていません'''
-* '''要望等ございましたら、[wiki: Wikiトップページ]にあります[wiki:#本サイトに関して 問い合わせ先]までお願いします'''
+= 概要 =
+
+* API一覧
+
+  ||= API =||= ID[[BR]][Dec] =||= ID[[BR]][Hex] =||= R4.2.2 =||
+  || [#LinSM_Init LinSM_Init]                                               ||  1|| 0x01||  ○  ||
+  || [#LinSM_ScheduleRequest LinSM_ScheduleRequest]                         || 16|| 0x10||  ○  ||
+  || [#LinSM_GetVersionInfo LinSM_GetVersionInfo]                           ||  2|| 0x02||  ○  ||
+  || [#LinSM_GetCurrentComMode LinSM_GetCurrentComMode]                     || 17|| 0x11||  ○  ||
+  || [#LinSM_RequestComMode LinSM_RequestComMode]                           || 18|| 0x12||  ○  ||
+  || [#LinSM_MainFunction LinSM_MainFunction]                               || 48|| 0x30||  ○  ||
+  || [#LinSM_ScheduleRequestConfirmation LinSM_ScheduleRequestConfirmation] || 32|| 0x20||  ○  ||
+  || [#LinSM_GotoSleepConfirmation LinSM_GotoSleepConfirmation]             || 34|| 0x22||  ○  ||
+  || [#LinSM_WakeupConfirmation LinSM_WakeupConfirmation]                   || 33|| 0x21||  ○  ||
+
+* コンフィギュレーション一覧(R4.2.2)
+  * [#LinSMConfigSet LinSMConfigSet] (○)
+    * [#LinSMModeRequestRepetitionMax LinSMModeRequestRepetitionMax] (○)
+    * [#LinSMChannel LinSMChannel] (○)
+      * [#LinSMConfirmationTimeout LinSMConfirmationTimeout] (○)
+      * [#LinSMTransceiverPassiveMode LinSMTransceiverPassiveMode] (○)
+      * [#LinSMComMNetworkHandleRef LinSMComMNetworkHandleRef] (○)
+      * [#LinSMSchedule LinSMSchedule] (○)
+        * [#LinSMScheduleIndex LinSMScheduleIndex] (○)
+        * [#LinSMScheduleIndexRef LinSMScheduleIndexRef] (○)
+  * [#LinSMGeneral LinSMGeneral] (○)
+    * [#LinSMDevErrorDetect LinSMDevErrorDetect] (○)
+    * [#LinSMMainProcessingPeriod LinSMMainProcessingPeriod] (○)
+    * [#LinSMVersionInfoApi LinSMVersionInfoApi] (○)
+
+* エラーコード一覧
+
+  ||= エラーコード =||= Dec =||= Hex =||= R4.2.2 =||
+  || LINSM_E_UNINIT               ||  0|| 0x00||  ○  ||
+  || LINSM_E_NONEXISTENT_NETWORK  || 32|| 0x20||  ○  ||
+  || LINSM_E_PARAMETER            || 48|| 0x30||  ○  ||
+  || LINSM_E_PARAM_POINTER        || 64|| 0x40||  ○  ||
+  || LINSM_E_CONFIRMATION_TIMEOUT || 80|| 0x50||  ○  ||
+  || LINSM_E_INIT_FAILED          || 96|| 0x60||  ○  ||
+  || E_NOT_OK                     || --||   --||  ○  ||
+
 ----
-{{{#!comment
-[執筆開始時削除エリア]ここまで
-※コメントごと削除してください
-}}}
-
-= 概要 =
+
+= API仕様 =
+
+== LinSM_Init ==
+{{{
+void LinSM_Init(const LinSM_ConfigType* ConfigPtr)
+}}}
+
+== LinSM_ScheduleRequest ==
+{{{
+Std_ReturnType LinSM_ScheduleRequest(NetworkHandleType network, LinIf_SchHandleType schedule)
+}}}
+
+== LinSM_GetVersionInfo ==
+{{{
+void LinSM_GetVersionInfo(Std_VersionInfoType* versioninfo)
+}}}
+
+== LinSM_GetCurrentComMode ==
+{{{
+Std_ReturnType LinSM_GetCurrentComMode(NetworkHandleType network, ComM_ModeType* mode)
+}}}
+
+== LinSM_RequestComMode ==
+{{{
+Std_ReturnType LinSM_RequestComMode(NetworkHandleType network, ComM_ModeType mode)
+}}}
+
+== LinSM_MainFunction ==
+{{{
+void LinSM_MainFunction(void)
+}}}
+
+== LinSM_ScheduleRequestConfirmation ==
+{{{
+void LinSM_ScheduleRequestConfirmation(NetworkHandleType network, LinIf_SchHandleType schedule)
+}}}
+
+== LinSM_GotoSleepConfirmation ==
+{{{
+void LinSM_GotoSleepConfirmation(NetworkHandleType network, boolean success)
+}}}
+
+== LinSM_WakeupConfirmation ==
+{{{
+void LinSM_WakeupConfirmation(NetworkHandleType network, boolean success)
+}}}
 
 ----
 
-= API仕様 =
-
-----
-
 = コンフィギュレーション仕様 =
+
+== LinSMConfigSet ==
+{{{
+/AUTOSAR/EcucDefs/LinSM/LinSMConfigSet
+}}}
+* 型：Container
+* 多重度：1
+
+== LinSMModeRequestRepetitionMax ==
+{{{
+/AUTOSAR/EcucDefs/LinSM/LinSMConfigSet/LinSMModeRequestRepetitionMax
+}}}
+* 型：IntegerParam
+* 多重度：1
+* 上限値：255
+* 下限値：0
+
+== LinSMChannel ==
+{{{
+/AUTOSAR/EcucDefs/LinSM/LinSMConfigSet/LinSMChannel
+}}}
+* 型：Container
+* 多重度：1..*
+
+== LinSMConfirmationTimeout ==
+{{{
+/AUTOSAR/EcucDefs/LinSM/LinSMConfigSet/LinSMChannel/LinSMConfirmationTimeout
+}}}
+* 型：FloatParam
+* 多重度：1
+* 上限値：Inf
+* 下限値：0
+
+== LinSMTransceiverPassiveMode ==
+{{{
+/AUTOSAR/EcucDefs/LinSM/LinSMConfigSet/LinSMChannel/LinSMTransceiverPassiveMode
+}}}
+* 型：BooleanParam
+* 多重度：0..1
+
+== LinSMComMNetworkHandleRef ==
+{{{
+/AUTOSAR/EcucDefs/LinSM/LinSMConfigSet/LinSMChannel/LinSMComMNetworkHandleRef
+}}}
+* 型：Reference
+* 多重度：1
+* 参照先：{{{/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel}}}
+
+== LinSMSchedule ==
+{{{
+/AUTOSAR/EcucDefs/LinSM/LinSMConfigSet/LinSMChannel/LinSMSchedule
+}}}
+* 型：Container
+* 多重度：1..*
+
+== LinSMScheduleIndex ==
+{{{
+/AUTOSAR/EcucDefs/LinSM/LinSMConfigSet/LinSMChannel/LinSMSchedule/LinSMScheduleIndex
+}}}
+* 型：IntegerParam
+* 多重度：1
+* 上限値：255
+* 下限値：0
+
+== LinSMScheduleIndexRef ==
+{{{
+/AUTOSAR/EcucDefs/LinSM/LinSMConfigSet/LinSMChannel/LinSMSchedule/LinSMScheduleIndexRef
+}}}
+* 型：Reference
+* 多重度：1
+* 参照先：{{{/AUTOSAR/EcucDefs/LinIf/LinIfGlobalConfig/LinIfChannel/LinIfScheduleTable}}}
+
+== LinSMGeneral ==
+{{{
+/AUTOSAR/EcucDefs/LinSM/LinSMGeneral
+}}}
+* 型：Container
+* 多重度：1
+
+== LinSMDevErrorDetect ==
+{{{
+/AUTOSAR/EcucDefs/LinSM/LinSMGeneral/LinSMDevErrorDetect
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== LinSMMainProcessingPeriod ==
+{{{
+/AUTOSAR/EcucDefs/LinSM/LinSMGeneral/LinSMMainProcessingPeriod
+}}}
+* 型：FloatParam
+* 多重度：1
+* 上限値：Inf
+* 下限値：0
+
+== LinSMVersionInfoApi ==
+{{{
+/AUTOSAR/EcucDefs/LinSM/LinSMGeneral/LinSMVersionInfoApi
+}}}
+* 型：BooleanParam
+* 多重度：1