Changes between Version 18 and Version 19 of spec/CanIf

Timestamp:

Dec 9, 2022, 11:56:58 AM (17 months ago)

Author:

fujisft-kaji

Comment:

--

spec/CanIf

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