Changes between Version 17 and Version 18 of spec/CanIf

Timestamp:

Dec 9, 2022, 10:32:33 AM (18 months ago)

Author:

fujisft-kaji

Comment:

API仕様の補足説明の記載位置を修正

spec/CanIf

@@ -256 +256 @@
 Std_ReturnType CanIf_SetControllerMode(uint8 ControllerId, CanIf_ControllerModeType ControllerMode)
 }}}
-
-* R21-11
-{{{
-Std_ReturnType CanIf_SetControllerMode (uint8 ControllerId, Can_ControllerStateType ControllerMode)
-}}}
 * 引数ControllerIdで指定したCANコントローラの動作モードを、引数ControllerModeで指定した状態に遷移する
 * CanIf_ControllerModeTypeは以下のENUM型となる
@@ -271 +266 @@
   * これにより、CanIfモジュール内でハードウェア上の動作モードを管理できる
 
+* R21-11
+{{{
+Std_ReturnType CanIf_SetControllerMode (uint8 ControllerId, Can_ControllerStateType ControllerMode)
+}}}
+
 == CanIf_GetControllerMode ==
 * R4.0.3 / R4.2.2
@@ -276 +276 @@
 Std_ReturnType CanIf_GetControllerMode(uint8 ControllerId, CanIf_ControllerModeType* ControllerModePtr)
 }}}
-
-* R21-11
-{{{
-Std_ReturnType CanIf_GetControllerMode (uint8 ControllerId, Can_ControllerStateType* ControllerModePtr)
-}}}
 * 引数ControllerIdで指定したCANコントローラの現在の動作モードを、引数ControllerModePtrで指定した領域に取得する
 * CanIfモジュール内で管理している動作モードを返す
 
+* R21-11
+{{{
+Std_ReturnType CanIf_GetControllerMode (uint8 ControllerId, Can_ControllerStateType* ControllerModePtr)
+}}}
+
 == CanIf_GetControllerErrorState ==
 {{{
@@ -294 +294 @@
 Std_ReturnType CanIf_Transmit(PduIdType CanIfTxSduId, const PduInfoType* CanIfTxInfoPtr)
 }}}
-
-* R21-11
-{{{
-Std_ReturnType CanIf_Transmit (PduIdType TxPduId, const PduInfoType* PduInfoPtr)
-}}}
 * 引数CanTxPduIdで与えたI-PDUに対して、引数CanIfTxInfoPtrで指定したデータを送信する
 * 送信条件が揃っている場合、[wiki:spec/Can#Can_Write CanモジュールのCan_Write]を呼び出すことにより、実際にCANバスへデータが送信される
+
+* R21-11
+{{{
+Std_ReturnType CanIf_Transmit (PduIdType TxPduId, const PduInfoType* PduInfoPtr)
+}}}
 
 == CanIf_CancelTransmit ==
@@ -475 +475 @@
 void CanIf_RxIndication(Can_HwHandleType Hrh, Can_IdType CanId, uint8 CanDlc, uint8 *CanSduPtr)
 }}}
-
-* R4.2.2 / R21-11
-{{{
-void CanIf_RxIndication (const Can_HwType* Mailbox, const PduInfoType* PduInfoPtr)
-}}}
 * 上位レイヤへ引数Hrhで指定したハードウェアオブジェクトに対する受信通知を行う
   * 引数CanSduPtrで受け取ったデータを上位レイヤへ渡す
 * CanId、CanDlcには、CANバスから受信した情報が渡されるが、主にコンフィギュレーション時に設定しな内容と相違がないかチェックするのに使用される
 * [wiki:spec/Can Canモジュール]において、CANバスから受信通知を受け取った場合に呼び出される
+
+* R4.2.2 / R21-11
+{{{
+void CanIf_RxIndication (const Can_HwType* Mailbox, const PduInfoType* PduInfoPtr)
+}}}
 
 == CanIf_CancelTxConfirmation ==