Changes between Version 4 and Version 5 of spec/CanSM

Timestamp:

Oct 24, 2014, 5:23:51 PM (10 years ago)

Author:

fujisft-shigihara

Comment:

--

spec/CanSM

@@ -7 +7 @@
 [[BR]]
 
-{{{#!comment
-[執筆開始時削除エリア]ここから
-※コメントごと削除してください
-}}}
-* '''本項目は、まだ執筆されていません'''
-* '''執筆して頂ける方は、本注意書きを削除の上、執筆をお願いします(詳しくは本Wikiのソースコードをご参照ください)'''
-* '''質問事項等がございましたら、[http://dev.toppers.jp/trac/ap/wiki/ Wikiトップページ]にあります[http://dev.toppers.jp/trac/ap/wiki/WikiStart#%E5%95%8F%E3%81%84%E5%90%88%E3%82%8F%E3%81%9B%E5%85%88 問い合わせ先]までお願いします'''
+= 概要 =
+
+* API一覧
+
+  ||= API =||= ID[[BR]][Dec] =||= ID[[BR]][Hex] =||
+  || [#CanSM_Init CanSM_Init]                                                             ||  0|| 0x00||
+  || [#CanSM_GetVersionInfo CanSM_GetVersionInfo]                                         ||  1|| 0x01||
+  || [#CanSM_RequestComMode CanSM_RequestComMode]                                         ||  2|| 0x02||
+  || [#CanSM_GetCurrentComMode CanSM_GetCurrentComMode]                                   ||  3|| 0x03||
+  || [#CanSM_CheckBaudrate CanSM_CheckBaudrate]                                           || 12|| 0x0C||
+  || [#CanSM_ChangeBaudrate CanSM_ChangeBaudrate]                                         || 14|| 0x0E||
+  || [#CanSM_ControllerBusOff CanSM_ControllerBusOff]                                     ||  4|| 0x04||
+  || [#CanSM_ControllerModeIndication CanSM_ControllerModeIndication]                     ||  7|| 0x07||
+  || [#CanSM_TransceiverModeIndication CanSM_TransceiverModeIndication]                   ||  9|| 0x09||
+  || [#CanSM_TxTimeoutException CanSM_TxTimeoutException]                                 || 11|| 0x0B||
+  || [#CanSM_ClearTrcvWufFlagIndication CanSM_ClearTrcvWufFlagIndication]                 ||  8|| 0x08||
+  || [#CanSM_CheckTransceiverWakeFlagIndication CanSM_CheckTransceiverWakeFlagIndication] || 10|| 0x0A||
+  || [#CanSM_ConfirmPnAvailability CanSM_ConfirmPnAvailability]                           ||  6|| 0x06||
+  || [#CanSM_MainFunction CanSM_MainFunction]                                             ||  5|| 0x05||
+
+* コンフィギュレーション一覧
+  * [#CanSMConfiguration CanSMConfiguration]
+    * [#CanSMModeRequestRepetitionMax CanSMModeRequestRepetitionMax]
+    * [#CanSMModeRequestRepetitionTime CanSMModeRequestRepetitionTime]
+    * [#CanSMManagerNetwork CanSMManagerNetwork]
+      * [#CanSMBorCounterL1ToL2 CanSMBorCounterL1ToL2]
+      * [#CanSMBorTimeL1 CanSMBorTimeL1]
+      * [#CanSMBorTimeL2 CanSMBorTimeL2]
+      * [#CanSMBorTimeTxEnsured CanSMBorTimeTxEnsured]
+      * [#CanSMBorTxConfirmationPolling CanSMBorTxConfirmationPolling]
+      * [#CanSMComMNetworkHandleRef CanSMComMNetworkHandleRef]
+      * [#CanSMTransceiverId CanSMTransceiverId]
+      * [#CanSMController CanSMController]
+        * [#CanSMControllerId CanSMControllerId]
+      * [#CanSMDemEventParameterRefs CanSMDemEventParameterRefs]
+        * [#CANSM_E_BUS_OFF CANSM_E_BUS_OFF]
+  * [#CanSMGeneral CanSMGeneral]
+    * [#CanSMDevErrorDetect CanSMDevErrorDetect]
+    * [#CanSMMainFunctionTimePeriod CanSMMainFunctionTimePeriod]
+    * [#CanSMVersionInfoApi CanSMVersionInfoApi]
+    * [#CanSmChangeBaudrateApi CanSmChangeBaudrateApi]
+
+* エラーコード一覧
+  * "--"は[wiki:spec_DiagnosticEventManager Dem]により決定される
+
+  ||= エラーコード =||= Dec =||= Hex =||
+  || CANSM_E_UNINIT                 ||  1|| 0x01||
+  || CANSM_E_PARAM_POINTER          ||  2|| 0x02||
+  || CANSM_E_INVALID_NETWORK_HANDLE ||  3|| 0x03||
+  || CANSM_E_PARAM_CONTROLLER       ||  4|| 0x04||
+  || CANSM_E_PARAM_TRANSCEIVER      ||  5|| 0x05||
+  || CANSM_E_BUSOFF_RECOVERY_ACTIVE ||  6|| 0x06||
+  || CANSM_E_WAIT_MODE_INDICATION   ||  7|| 0x07||
+  || CANSM_E_INVALID_COMM_REQUEST   ||  8|| 0x08||
+  || CANSM_E_PARAM_INVALID_BAUDRATE ||  9|| 0x09||
+  || CANSM_E_MODE_REQUEST_TIMEOUT   || 10|| 0x0A||
+  || CANSM_E_BUS_OFF                || --||   --||
+
 ----
-{{{#!comment
-[執筆開始時削除エリア]ここまで
-※コメントごと削除してください
-}}}
-
-= 概要 =
+
+= API仕様 =
+
+== CanSM_Init ==
+{{{
+void CanSM_Init(const CanSM_ConfigType* ConfigPtr)
+}}}
+
+== CanSM_GetVersionInfo ==
+{{{
+void CanSM_GetVersionInfo(Std_VersionInfoType* VersionInfo)
+}}}
+
+== CanSM_RequestComMode ==
+{{{
+Std_ReturnType CanSM_RequestComMode(NetworkHandleType network, ComM_ModeType ComM_Mode)
+}}}
+
+== CanSM_GetCurrentComMode ==
+{{{
+Std_ReturnType CanSM_GetCurrentComMode(NetworkHandleType network, ComM_ModeType* ComM_ModePtr)
+}}}
+
+== CanSM_CheckBaudrate ==
+{{{
+Std_ReturnType CanSM_CheckBaudrate(NetworkHandleType network, const uint16 Baudrate)
+}}}
+
+== CanSM_ChangeBaudrate ==
+{{{
+Std_ReturnType CanSM_ChangeBaudrate(NetworkHandleType network, const uint16 Baudrate)
+}}}
+
+== CanSM_ControllerBusOff ==
+{{{
+void CanSM_ControllerBusOff(uint8 ControllerId)
+}}}
+
+== CanSM_ControllerModeIndication ==
+{{{
+void CanSM_ControllerModeIndication(uint8 ControllerId, CanIf_ControllerModeType ControllerMode)
+}}}
+
+== CanSM_TransceiverModeIndication ==
+{{{
+void CanSM_TransceiverModeIndication(uint8 TransceiverId, CanTrcv_TrcvModeType TransceiverMode)
+}}}
+
+== CanSM_TxTimeoutException ==
+{{{
+void CanSM_TxTimeoutException(NetworkHandleType Channel)
+}}}
+
+== CanSM_ClearTrcvWufFlagIndication ==
+{{{
+void CanSM_ClearTrcvWufFlagIndication(uint8 Transceiver)
+}}}
+
+== CanSM_CheckTransceiverWakeFlagIndication ==
+{{{
+void CanSM_CheckTransceiverWakeFlagIndication(uint8 Transceiver)
+}}}
+
+== CanSM_ConfirmPnAvailability ==
+{{{
+void CanSM_ConfirmPnAvailability(uint8 TransceiverId)
+}}}
+
+== CanSM_MainFunction ==
+{{{
+void CanSM_MainFunction(void)
+}}}
 
 ----
 
-= API仕様 =
-
-----
-
 = コンフィギュレーション仕様 =
+
+== CanSMConfiguration ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMConfiguration
+}}}
+* 型：Container
+* 多重度：1
+
+== CanSMModeRequestRepetitionMax ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMConfiguration/CanSMModeRequestRepetitionMax
+}}}
+* 型：!IntegerParam
+* 多重度：1
+
+== CanSMModeRequestRepetitionTime ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMConfiguration/CanSMModeRequestRepetitionTime
+}}}
+* 型：!FloatParam
+* 多重度：1
+
+== CanSMManagerNetwork ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMConfiguration/CanSMManagerNetwork
+}}}
+* 型：Container
+* 多重度：1..*
+
+== CanSMBorCounterL1ToL2 ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMConfiguration/CanSMManagerNetwork/CanSMBorCounterL1ToL2
+}}}
+* 型：!IntegerParam
+* 多重度：1
+
+== CanSMBorTimeL1 ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMConfiguration/CanSMManagerNetwork/CanSMBorTimeL1
+}}}
+* 型：!FloatParam
+* 多重度：1
+
+== CanSMBorTimeL2 ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMConfiguration/CanSMManagerNetwork/CanSMBorTimeL2
+}}}
+* 型：!FloatParam
+* 多重度：1
+
+== CanSMBorTimeTxEnsured ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMConfiguration/CanSMManagerNetwork/CanSMBorTimeTxEnsured
+}}}
+* 型：!FloatParam
+* 多重度：1
+
+== CanSMBorTxConfirmationPolling ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMConfiguration/CanSMManagerNetwork/CanSMBorTxConfirmationPolling
+}}}
+* 型：!BooleanParam
+* 多重度：1
+
+== CanSMComMNetworkHandleRef ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMConfiguration/CanSMManagerNetwork/CanSMComMNetworkHandleRef
+}}}
+* 型：Reference
+* 多重度：1
+
+== CanSMTransceiverId ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMConfiguration/CanSMManagerNetwork/CanSMTransceiverId
+}}}
+* 型：Reference
+* 多重度：0..1
+
+== CanSMController ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMConfiguration/CanSMManagerNetwork/CanSMController
+}}}
+* 型：Container
+* 多重度：1..*
+
+== CanSMControllerId ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMConfiguration/CanSMManagerNetwork/CanSMController/CanSMControllerId
+}}}
+* 型：Reference
+* 多重度：1
+
+== CanSMDemEventParameterRefs ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMConfiguration/CanSMManagerNetwork/CanSMDemEventParameterRefs
+}}}
+* 型：Container
+* 多重度：0..1
+
+== CANSM_E_BUS_OFF ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMConfiguration/CanSMManagerNetwork/CanSMDemEventParameterRefs/CANSM_E_BUS_OFF
+}}}
+* 型：Reference
+* 多重度：0..1
+
+== CanSMGeneral ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMGeneral
+}}}
+* 型：Container
+* 多重度：1
+
+== CanSMDevErrorDetect ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMGeneral/CanSMDevErrorDetect
+}}}
+* 型：!BooleanParam
+* 多重度：1
+
+== CanSMMainFunctionTimePeriod ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMGeneral/CanSMMainFunctionTimePeriod
+}}}
+* 型：!FloatParam
+* 多重度：1
+
+== CanSMVersionInfoApi ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMGeneral/CanSMVersionInfoApi
+}}}
+* 型：!BooleanParam
+* 多重度：1
+
+== !CanSmChangeBaudrateApi ==
+{{{
+/AUTOSAR/EcucDefs/CanSM/CanSMGeneral/CanSmChangeBaudrateApi
+}}}
+* 型：!BooleanParam
+* 多重度：1
+