Changes between Version 5 and Version 6 of spec/Eth

Timestamp:

Jan 9, 2015, 4:38:47 PM (9 years ago)

Author:

fujisft-shigihara

Comment:

--

spec/Eth

@@ -7 +7 @@
 [[BR]]
 
-{{{#!comment
-[執筆開始時削除エリア]ここから
-※コメントごと削除してください
-}}}
-* '''本項目は、まだ執筆されていません'''
-* '''執筆して頂ける方は、本注意書きを削除の上、執筆をお願いします(詳しくは本Wikiのソースコードをご参照ください)'''
-* '''質問事項等がございましたら、[http://dev.toppers.jp/trac_user/ap/wiki/ Wikiトップページ]にあります[http://dev.toppers.jp/trac_user/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] =||
+  || [#Eth_Init Eth_Init]                             ||  1|| 0x01||
+  || [#Eth_ControllerInit Eth_ControllerInit]         ||  2|| 0x02||
+  || [#Eth_SetControllerMode Eth_SetControllerMode]   ||  3|| 0x03||
+  || [#Eth_GetControllerMode Eth_GetControllerMode]   ||  4|| 0x04||
+  || [#Eth_GetPhysAddr Eth_GetPhysAddr]               ||  8|| 0x08||
+  || [#Eth_WriteMii Eth_WriteMii]                     ||  5|| 0x05||
+  || [#Eth_ReadMii Eth_ReadMii]                       ||  6|| 0x06||
+  || [#Eth_GetCounterState Eth_GetCounterState]       ||  7|| 0x07||
+  || [#Eth_ProvideTxBuffer Eth_ProvideTxBuffer]       ||  9|| 0x09||
+  || [#Eth_Transmit Eth_Transmit]                     || 10|| 0x0A||
+  || [#Eth_Receive Eth_Receive]                       || 11|| 0x0B||
+  || [#Eth_TxConfirmation Eth_TxConfirmation]         || 12|| 0x0C||
+  || [#Eth_GetVersionInfo Eth_GetVersionInfo]         || 13|| 0x0D||
+  || [#Eth_RxIrqHdlr_CtrlIdx Eth_RxIrqHdlr_<CtrlIdx>] || 16|| 0x10||
+  || [#Eth_TxIrqHdlr_CtrlIdx Eth_TxIrqHdlr_<CtrlIdx>] || 17|| 0x11||
+
+* コンフィギュレーション一覧
+  * [#EthConfigSet EthConfigSet]
+    * [#EthCtrlConfig EthCtrlConfig]
+      * [#EthCtrlEnableMii EthCtrlEnableMii]
+      * [#EthCtrlEnableRxInterrupt EthCtrlEnableRxInterrupt]
+      * [#EthCtrlEnableTxInterrupt EthCtrlEnableTxInterrupt]
+      * [#EthCtrlIdx EthCtrlIdx]
+      * [#EthCtrlRxBufLenByte EthCtrlRxBufLenByte]
+      * [#EthCtrlTxBufLenByte EthCtrlTxBufLenByte]
+      * [#EthRxBufTotal EthRxBufTotal]
+      * [#EthTxBufTotal EthTxBufTotal]
+      * [#EthDemEventParameterRefs EthDemEventParameterRefs]
+        * [#ETH_E_ACCESS ETH_E_ACCESS]
+  * [#EthGeneral EthGeneral]
+    * [#EthDevErrorDetect EthDevErrorDetect]
+    * [#EthIndex EthIndex]
+    * [#EthMaxCtrlsSupported EthMaxCtrlsSupported]
+    * [#EthVersionInfoApi EthVersionInfoApi]
+    * [#EthVersionInfoApiMacro EthVersionInfoApiMacro]
+
+* エラーコード一覧
+  * "--"は[wiki:spec_DiagnosticEventManager Dem]により決定される
+
+  ||= エラーコード =||= Dec =||= Hex =||
+  || ETH_E_INV_CTRL_IDX    ||  1|| 0x01||
+  || ETH_E_NOT_INITIALIZED ||  2|| 0x02||
+  || ETH_E_INV_POINTER     ||  3|| 0x03||
+  || ETH_E_INV_PARAM       ||  4|| 0x04||
+  || ETH_E_INV_CONFIG      ||  5|| 0x05||
+  || ETH_E_INV_MODE        ||  6|| 0x06||
+  || ETH_E_ACCESS          || --||   --||
+
 ----
-{{{#!comment
-[執筆開始時削除エリア]ここまで
-※コメントごと削除してください
-}}}
-
-= 概要 =
+
+= API仕様 =
+
+== Eth_Init ==
+{{{
+void Eth_Init(const Eth_ConfigType* CfgPtr)
+}}}
+
+== Eth_ControllerInit ==
+{{{
+Std_ReturnType Eth_ControllerInit(uint8 CtrlIdx, uint8 CfgIdx)
+}}}
+
+== Eth_SetControllerMode ==
+{{{
+Std_ReturnType Eth_SetControllerMode(uint8 CtrlIdx, Eth_ModeType CtrlMode)
+}}}
+
+== Eth_GetControllerMode ==
+{{{
+Std_ReturnType Eth_GetControllerMode(uint8 CtrlIdx, Eth_ModeType* CtrlModePtr)
+}}}
+
+== Eth_GetPhysAddr ==
+{{{
+void Eth_GetPhysAddr(uint8 CtrlIdx, uint8* PhysAddrPtr)
+}}}
+
+== Eth_WriteMii ==
+{{{
+void Eth_WriteMii(uint8 CtrlIdx, uint8 TrcvIdx, uint8 RegIdx, uint16 RegVal)
+}}}
+
+== Eth_ReadMii ==
+{{{
+void Eth_ReadMii(uint8 CtrlIdx, uint8 TrcvIdx, uint8 RegIdx, uint16* RegValPtr)
+}}}
+
+== Eth_GetCounterState ==
+{{{
+void Eth_GetCounterState(uint8 CtrlIdx, uint16 CtrOffs, uint32* CtrValPtr)
+}}}
+
+== Eth_ProvideTxBuffer ==
+{{{
+BufReq_ReturnType Eth_ProvideTxBuffer(uint8 CtrlIdx, uint8* BufIdxPtr, Eth_DataType** BufPtr, uint16* LenBytePtr)
+}}}
+
+== Eth_Transmit ==
+{{{
+Std_ReturnType Eth_Transmit(uint8 CtrlIdx, uint8 BufIdx, Eth_FrameType FrameType, boolean TxConfirmation, uint16 LenByte, uint8* PhysAddrPtr)
+}}}
+
+== Eth_Receive ==
+{{{
+void Eth_Receive(uint8 CtrlIdx)
+}}}
+
+== Eth_TxConfirmation ==
+{{{
+void Eth_TxConfirmation(uint8 CtrlIdx)
+}}}
+
+== Eth_GetVersionInfo ==
+{{{
+void Eth_GetVersionInfo(Std_VersionInfoType* VersionInfoPtr)
+}}}
+
+== Eth_RxIrqHdlr_<CtrlIdx> ==
+{{{
+void Eth_RxIrqHdlr_<CtrlIdx>(void)
+}}}
+
+== Eth_TxIrqHdlr_<CtrlIdx> ==
+{{{
+void Eth_TxIrqHdlr_<CtrlIdx>(void)
+}}}
 
 ----
 
-= API仕様 =
-
-----
-
 = コンフィギュレーション仕様 =
+
+== EthConfigSet ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthConfigSet
+}}}
+* 型：Container
+* 多重度：1
+
+== EthCtrlConfig ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthConfigSet/EthCtrlConfig
+}}}
+* 型：Container
+* 多重度：1..*
+
+== EthCtrlEnableMii ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthConfigSet/EthCtrlConfig/EthCtrlEnableMii
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== EthCtrlEnableRxInterrupt ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthConfigSet/EthCtrlConfig/EthCtrlEnableRxInterrupt
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== EthCtrlEnableTxInterrupt ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthConfigSet/EthCtrlConfig/EthCtrlEnableTxInterrupt
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== EthCtrlIdx ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthConfigSet/EthCtrlConfig/EthCtrlIdx
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== EthCtrlRxBufLenByte ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthConfigSet/EthCtrlConfig/EthCtrlRxBufLenByte
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== EthCtrlTxBufLenByte ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthConfigSet/EthCtrlConfig/EthCtrlTxBufLenByte
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== EthRxBufTotal ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthConfigSet/EthCtrlConfig/EthRxBufTotal
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== EthTxBufTotal ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthConfigSet/EthCtrlConfig/EthTxBufTotal
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== EthDemEventParameterRefs ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthConfigSet/EthCtrlConfig/EthDemEventParameterRefs
+}}}
+* 型：Container
+* 多重度：0..1
+
+== ETH_E_ACCESS ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthConfigSet/EthCtrlConfig/EthDemEventParameterRefs/ETH_E_ACCESS
+}}}
+* 型：Reference
+* 多重度：0..1
+
+== EthGeneral ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthGeneral
+}}}
+* 型：Container
+* 多重度：1
+
+== EthDevErrorDetect ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthGeneral/EthDevErrorDetect
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== EthIndex ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthGeneral/EthIndex
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== EthMaxCtrlsSupported ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthGeneral/EthMaxCtrlsSupported
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== EthVersionInfoApi ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthGeneral/EthVersionInfoApi
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== EthVersionInfoApiMacro ==
+{{{
+/AUTOSAR/EcucDefs/Eth/EthGeneral/EthVersionInfoApiMacro
+}}}
+* 型：BooleanParam
+* 多重度：1