Changes between Version 2 and Version 3 of spec/CanXL

Timestamp:

Oct 18, 2023, 4:32:20 PM (7 months ago)

Author:

fujisft-kaji

Comment:

--

spec/CanXL

@@ -7 +7 @@
 [[BR]]
 
-{{{#!comment
-[執筆開始時削除エリア]ここから
-※コメントごと削除してください
-}}}
-* '''本項目は、まだ執筆されていません'''
-* '''要望等ございましたら、[wiki: Wikiトップページ]にあります[wiki:#本サイトに関して 問い合わせ先]までお願いします'''
-----
-{{{#!comment
-[執筆開始時削除エリア]ここまで
-※コメントごと削除してください
-}}}
-
 = 概要 =
+
 * API一覧
+
+  ||= API =||= ID[[BR]][Dec] =||= ID[[BR]][Hex] =||= R22-11 =||
+  || [#CanXL_EnableEgressTimeStamp CanXL_EnableEgressTimeStamp]     ||  23|| 0x17||  ○  ||
+  || [#CanXL_GetControllerMode CanXL_GetControllerMode]             ||   4|| 0x04||  ○  ||
+  || [#CanXL_GetCounterValues CanXL_GetCounterValues]               ||  20|| 0x14||  ○  ||
+  || [#CanXL_GetCurrentTime CanXL_GetCurrentTime]                   ||  22|| 0x16||  ○  ||
+  || [#CanXL_GetEgressTimeStamp CanXL_GetEgressTimeStamp]           ||  24|| 0x18||  ○  ||
+  || [#CanXL_GetIngressTimeStamp CanXL_GetIngressTimeStamp]         ||  25|| 0x19||  ○  ||
+  || [#CanXL_GetPhysAddr CanXL_GetPhysAddr]                         ||   8|| 0x08||  ○  ||
+  || [#CanXL_GetRxStats CanXL_GetRxStats]                           ||  21|| 0x15||  ○  ||
+  || [#CanXL_GetTxErrorCounterValues CanXL_GetTxErrorCounterValues] ||  29|| 0x1D||  ○  ||
+  || [#CanXL_GetTxStats CanXL_GetTxStats]                           ||  28|| 0x1C||  ○  ||
+  || [#CanXL_ProvideTxBuffer CanXL_ProvideTxBuffer]                 ||   9|| 0x09||  ○  ||
+  || [#CanXL_Receive CanXL_Receive]                                 ||  11|| 0x0B||  ○  ||
+  || [#CanXL_SetControllerMode CanXL_SetControllerMode]             ||   3|| 0x03||  ○  ||
+  || [#CanXL_SetPhysAddr CanXL_SetPhysAddr]                         ||  19|| 0x13||  ○  ||
+  || [#CanXL_Transmit CanXL_Transmit]                               ||  10|| 0x0A||  ○  ||
+  || [#CanXL_TxConfirmation CanXL_TxConfirmation]                   ||  12|| 0x0C||  ○  ||
+  || [#CanXL_UpdatePhysAddrFilter CanXL_UpdatePhysAddrFilter]       ||  18|| 0x12||  ○  ||
+  || [#CanXL_Write CanXL_Write]                                     ||  16|| 0x10||  ○  ||
+
 * コンフィギュレーション一覧 (R22-11)  ※Canモジュールに含まれる
   * [#CanConfigSet CanConfigSet] (○)
@@ -144 +154 @@
       * [#CanXLEthGlobalTimeSupport CanXLEthGlobalTimeSupport] (○)
 
+* エラーコード一覧
+
+  ||= エラーコード =||= Dec =||= Hex =||= R22-11 =||
+  || CANXL_E_PARAM_POINTER     ||  1|| 0x01||  ○  ||
+  || CANXL_E_PARAM_HANDLE      ||  2|| 0x02||  ○  ||
+  || CANXL_E_PARAM_DATA_LENGTH ||  3|| 0x03||  ○  ||
+  || CANXL_E_PARAM_CONTROLLER  ||  4|| 0x04||  ○  ||
+  || CANXL_E_UNINIT            ||  5|| 0x05||  ○  ||
+  || CANXL_E_INV_PARAM         || 16|| 0x10||  ○  ||
+  || CANXL_E_INV_MODE          || 17|| 0x11||  ○  ||
+  || CANXL_E_INV_DATA          || 18|| 0x12||  ○  ||
+
 ----
 
 = API仕様 =
+
+== CanXL_EnableEgressTimeStamp ==
+{{{
+void CanXL_EnableEgressTimeStamp (uint8 CtrlIdx, Eth_BufIdxType BufIdx)
+}}}
+
+== CanXL_GetControllerMode ==
+{{{
+Std_ReturnType CanXL_GetControllerMode (uint8 CtrlIdx, Eth_ModeType* CtrlModePtr)
+}}}
+
+== CanXL_GetCounterValues ==
+{{{
+Std_ReturnType CanXL_GetCounterValues (uint8 CtrlIdx, Eth_CounterType* CounterPtr)
+}}}
+
+== CanXL_GetCurrentTime ==
+{{{
+Std_ReturnType CanXL_GetCurrentTime (uint8 CtrlIdx, Eth_TimeStampQualType* timeQualPtr, Eth_TimeStampType* timeStampPtr)
+}}}
+
+== CanXL_GetEgressTimeStamp ==
+{{{
+Std_ReturnType CanXL_GetEgressTimeStamp (uint8 CtrlIdx, Eth_BufIdxType BufIdx, Eth_TimeStampQualType* timeQualPtr, Eth_TimeStampType* timeStampPtr)
+}}}
+
+== CanXL_GetIngressTimeStamp ==
+{{{
+Std_ReturnType CanXL_GetIngressTimeStamp (uint8 CtrlIdx, const Eth_DataType* DataPtr, Eth_TimeStampQualType* timeQualPtr, Eth_TimeStampType* timeStampPtr)
+}}}
+
+== CanXL_GetPhysAddr ==
+{{{
+void CanXL_GetPhysAddr (uint8 CtrlIdx, uint8* PhysAddrPtr)
+}}}
+
+== CanXL_GetRxStats ==
+{{{
+Std_ReturnType CanXL_GetRxStats (uint8 CtrlIdx, Eth_RxStatsType* RxStats)
+}}}
+
+== CanXL_GetTxErrorCounterValues ==
+{{{
+Std_ReturnType CanXL_GetTxErrorCounterValues (uint8 CtrlIdx, Eth_TxErrorCounterValuesType* TxErrorCounterValues)
+}}}
+
+== CanXL_GetTxStats ==
+{{{
+Std_ReturnType CanXL_GetTxStats (uint8 CtrlIdx, Eth_TxStatsType* TxStats)
+}}}
+
+== CanXL_ProvideTxBuffer ==
+{{{
+BufReq_ReturnType CanXL_ProvideTxBuffer (uint8 CtrlIdx, uint8 Priority, Eth_BufIdxType* BufIdxPtr, uint8** BufPtr, uint16* LenBytePtr)
+}}}
+
+== CanXL_Receive ==
+{{{
+void CanXL_Receive (uint8 CtrlIdx, uint8 QueueIdx, Eth_RxStatusType* RxStatusPtr)
+}}}
+
+== CanXL_SetControllerMode ==
+{{{
+Std_ReturnType CanXL_SetControllerMode (uint8 CtrlIdx, Eth_ModeType CtrlMode)
+}}}
+
+== CanXL_SetPhysAddr ==
+{{{
+void CanXL_SetPhysAddr (uint8 CtrlIdx, const uint8* PhysAddrPtr)
+}}}
+
+== CanXL_Transmit ==
+{{{
+Std_ReturnType CanXL_Transmit (uint8 CtrlIdx, Eth_BufIdxType BufIdx, Eth_FrameType FrameType , boolean TxConfirmation, uint16 LenByte, const uint8* PhysAddrPtr)
+}}}
+
+== CanXL_TxConfirmation ==
+{{{
+void CanXL_TxConfirmation (uint8 CtrlIdx)
+}}}
+
+== CanXL_UpdatePhysAddrFilter ==
+{{{
+Std_ReturnType CanXL_UpdatePhysAddrFilter (uint8 CtrlIdx, const uint8* PhysAddrPtr, Eth_FilterActionType Action)
+}}}
+
+== CanXL_Write ==
+{{{
+Std_ReturnType CanXL_Write (Can_HwHandleType Hth, const CanXL_PduType* PduInfo)
+}}}
 
 ----