Changes between Version 1 and Version 2 of spec/WEth


Ignore:
Timestamp:
Dec 9, 2022, 5:18:30 PM (17 months ago)
Author:
fujisft-kaji
Comment:

R21-11反映

Legend:

Unmodified
Added
Removed
Modified

  • spec/WEth

    v1 v2  
    77[[BR]]
    88
    9 {{{#!comment
    10 [執筆開始時削除エリア]ここから
    11 ※コメントごと削除してください
    12 }}}
    13 * '''本項目は、まだ執筆されていません'''
    14 * '''要望等ございましたら、[wiki: Wikiトップページ]にあります[wiki:#本サイトに関して 問い合わせ先]までお願いします'''
     9= 概要 =
     10
     11* API一覧
     12
     13  ||= API =||= ID[[BR]][Dec] =||= ID[[BR]][Hex] =||= R21-11 =||
     14  || [#WEth_Init WEth_Init]                                                 ||   1|| 0x01||  ○  ||
     15  || [#WEth_SetControllerMode WEth_SetControllerMode]                       ||   3|| 0x03||  ○  ||
     16  || [#WEth_GetControllerMode WEth_GetControllerMode]                       ||   4|| 0x04||  ○  ||
     17  || [#WEth_GetPhysAddr WEth_GetPhysAddr]                                   ||   8|| 0x08||  ○  ||
     18  || [#WEth_SetPhysAddr WEth_SetPhysAddr]                                   ||  19|| 0x13||  ○  ||
     19  || [#WEth_UpdatePhysAddrFilter WEth_UpdatePhysAddrFilter]                 ||  18|| 0x12||  ○  ||
     20  || [#WEth_ProvideTxBuffer WEth_ProvideTxBuffer]                           ||   9|| 0x09||  ○  ||
     21  || [#WEth_Transmit WEth_Transmit]                                         ||  20|| 0x14||  ○  ||
     22  || [#WEth_TxConfirmation WEth_TxConfirmation]                             ||   2|| 0x02||  ○  ||
     23  || [#WEth_Receive WEth_Receive]                                           ||   5|| 0x05||  ○  ||
     24  || [#WEth_GetWEtherStats32 WEth_GetWEtherStats32]                         ||  21|| 0x15||  ○  ||
     25  || [#WEth_GetWEtherStats64 WEth_GetWEtherStats64]                         || 224|| 0xE0||  ○  ||
     26  || [#WEth_WriteTrcvRegs WEth_WriteTrcvRegs]                               ||  48|| 0x30||  ○  ||
     27  || [#WEth_ReadTrcvRegs WEth_ReadTrcvRegs]                                 ||  49|| 0x31||  ○  ||
     28  || [#WEth_GetBufWRxParams WEth_GetBufWRxParams]                           ||  52|| 0x34||  ○  ||
     29  || [#WEth_GetBufWTxParams WEth_GetBufWTxParams]                           ||  53|| 0x35||  ○  ||
     30  || [#WEth_SetBufWTxParams WEth_SetBufWTxParams]                           ||  54|| 0x36||  ○  ||
     31  || [#WEth_GetVersionInfo WEth_GetVersionInfo]                             ||  13|| 0x0D||  ○  ||
     32  || [#WEth_TriggerPriorityQueueTransmit WEth_TriggerPriorityQueueTransmit] ||  55|| 0x37||  ○  ||
     33  || [#WEth_MainFunction WEth_MainFunction]                                 ||  10|| 0x0A||  ○  ||
     34
     35* コンフィギュレーション一覧 (R4.3.1/R4.4.0/R19-11/R20-11/R21-11)
     36  * [#WEthConfigSet WEthConfigSet] (○/○/○/○/○)
     37    * [#WEthCtrlConfig WEthCtrlConfig] (○/○/○/○/○)
     38      * [#WEthCtrlEcucPartitionRef WEthCtrlEcucPartitionRef] (-/○/○/○/○)
     39      * [#WEthCtrlId WEthCtrlId] (○/○/○/○/○)
     40      * [#WEthCtrlPhyAddress WEthCtrlPhyAddress] (○/○/○/○/○)
     41      * [#WEthCtrlRxBufLenByte WEthCtrlRxBufLenByte] (○/○/○/○/○)
     42      * [#WEthCtrlTxBufLenByte WEthCtrlTxBufLenByte] (○/○/○/○/○)
     43      * [#WEthDemEventParameterRefs WEthDemEventParameterRefs] (○/○/○/○/○)
     44        * [#WETH_E_ACCESS WETH_E_ACCESS] (○/○/○/○/○)
     45      * [#WEthRxBufTotal WEthRxBufTotal] (○/○/○/○/○)
     46      * [#WEthTxBufTotal WEthTxBufTotal] (○/○/○/○/○)
     47  * [#WEthGeneral WEthGeneral] (○/○/○/○/○)
     48    * [#WEthDevErrorDetect WEthDevErrorDetect] (○/○/○/○/○)
     49    * [#WEthEcucPartitionRef WEthEcucPartitionRef] (-/○/○/○/○)
     50    * [#WEthGetWEtherStatsApi WEthGetWEtherStatsApi] (○/○/○/○/○)
     51    * [#WEthIndex WEthIndex] (○/○/○/○/○)
     52    * [#WEthMainFunctionPeriod WEthMainFunctionPeriod] (○/○/○/○/○)
     53    * [#WEthUpdatePhysAddrFilter WEthUpdatePhysAddrFilter] (○/○/○/○/○)
     54    * [#WEthVersionInfoApi WEthVersionInfoApi] (○/○/○/○/○)
     55
     56* エラーコード一覧
     57  * "--"は[wiki:spec/Dem Dem]により決定される
     58
     59  ||= エラーコード =||= Dec =||= Hex =||= R21-11 =||
     60  || WETH_E_INV_CTRL_ID   ||  1|| 0x01||  ○  ||
     61  || WETH_E_UNINIT        ||  2|| 0x02||  ○  ||
     62  || WETH_E_PARAM_POINTER ||  3|| 0x03||  ○  ||
     63  || WETH_E_ACCESS        || --||   --||  ○  ||
     64
    1565----
    16 {{{#!comment
    17 [執筆開始時削除エリア]ここまで
    18 ※コメントごと削除してください
    19 }}}
    20 
    21 = 概要 =
     66
     67= API仕様 =
     68
     69== WEth_Init ==
     70{{{
     71void WEth_Init (const WEth_ConfigType* CfgPtr)
     72}}}
     73
     74== WEth_SetControllerMode ==
     75{{{
     76Std_ReturnType WEth_SetControllerMode (uint8 CtrlId, Eth_ModeType CtrlMode)
     77}}}
     78
     79== WEth_GetControllerMode ==
     80{{{
     81Std_ReturnType WEth_GetControllerMode (uint8 CtrlId, Eth_ModeType* CtrlModePtr)
     82}}}
     83
     84== WEth_GetPhysAddr ==
     85{{{
     86void WEth_GetPhysAddr (uint8 CtrlId, uint8* PhysAddrPtr)
     87}}}
     88
     89== WEth_SetPhysAddr ==
     90{{{
     91void WEth_SetPhysAddr (uint8 CtrlId, const uint8* PhysAddrPtr)
     92}}}
     93
     94== WEth_UpdatePhysAddrFilter ==
     95{{{
     96Std_ReturnType WEth_UpdatePhysAddrFilter (uint8 CtrlId, const uint8* PhysAddrPtr, const uint8* PhysMaskPtr, Eth_FilterActionType Action)
     97}}}
     98
     99== WEth_ProvideTxBuffer ==
     100{{{
     101BufReq_ReturnType WEth_ProvideTxBuffer (uint8 CtrlId, uint8 Priority, Eth_BufIdxType* BufIdPtr, uint8** BufPtr, uint16* LenBytePtr)
     102}}}
     103
     104== WEth_Transmit ==
     105{{{
     106Std_ReturnType WEth_Transmit (uint8 CtrlId, Eth_BufIdxType BufId, Eth_FrameType FrameType, boolean TxConfirmation, uint16 LenByte, const uint8* PhysAddrPtr)
     107}}}
     108
     109== WEth_TxConfirmation ==
     110{{{
     111void WEth_TxConfirmation (uint8 CtrlId)
     112}}}
     113
     114== WEth_Receive ==
     115{{{
     116void WEth_Receive (uint8 CtrlId, Eth_RxStatusType* RxStatusPtr)
     117}}}
     118
     119== WEth_GetWEtherStats32 ==
     120{{{
     121Std_ReturnType WEth_GetWEtherStats32 (uint8 CtrlId, uint32* WEtherStats)
     122}}}
     123
     124== WEth_GetWEtherStats64 ==
     125{{{
     126Std_ReturnType WEth_GetWEtherStats64 (uint8 CtrlId, uint64* WEtherStats)
     127}}}
     128
     129== WEth_WriteTrcvRegs ==
     130{{{
     131Std_ReturnType WEth_WriteTrcvRegs (uint8 CtrlId, uint8 TrcvId, uint8 RadioId, const uint32* RegIds, const uint32* RegVals, uint8 NumRegs)
     132}}}
     133
     134== WEth_ReadTrcvRegs ==
     135{{{
     136Std_ReturnType WEth_ReadTrcvRegs (uint8 CtrlId, uint8 TrcvId, uint8 RadioId, const uint32* RegIds, uint32* RegValsPtr, uint8 NumRegs)
     137}}}
     138
     139== WEth_GetBufWRxParams ==
     140{{{
     141Std_ReturnType WEth_GetBufWRxParams (uint8 CtrlId, const WEth_BufWRxParamIdType* RxParamIds, uint32* ParamValues, uint8 NumParams)
     142}}}
     143
     144== WEth_GetBufWTxParams ==
     145{{{
     146Std_ReturnType WEth_GetBufWTxParams (uint8 CtrlId, const WEth_BufWTxParamIdType* TxParamIds, uint32* ParamValues, uint8 NumParams)
     147}}}
     148
     149== WEth_SetBufWTxParams ==
     150{{{
     151Std_ReturnType WEth_SetBufWTxParams (uint8 CtrlId, Eth_BufIdxType BufId, const WEth_BufWTxParamIdType* TxParamIds, const uint32* ParamValues, uint8 NumParams)
     152}}}
     153
     154== WEth_GetVersionInfo ==
     155{{{
     156void WEth_GetVersionInfo (Std_VersionInfoType* VersionInfoPtr)
     157}}}
     158
     159== WEth_TriggerPriorityQueueTransmit ==
     160{{{
     161Std_ReturnType WEth_TriggerPriorityQueueTransmit (uint8 CtrlId, uint8 PriorityQueue, uint8 MaxTxPower)
     162}}}
     163
     164== WEth_MainFunction ==
     165{{{
     166void WEth_MainFunction (void)
     167}}}
    22168
    23169----
    24 
    25 = API仕様 =
    26 
    27 ----
    28 
    29170= コンフィギュレーション仕様 =
     171
     172== WEthConfigSet ==
     173{{{
     174/AUTOSAR/EcucDefs/WEth/WEthConfigSet
     175}}}
     176* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     177* SWSタグ: ECUC_WEth_00015
     178* タイプ: PARAM-CONF-CONTAINER
     179* 多重度: 1
     180
     181== WEthCtrlConfig ==
     182{{{
     183/AUTOSAR/EcucDefs/WEth/WEthConfigSet/WEthCtrlConfig
     184}}}
     185* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     186* SWSタグ: ECUC_WEth_00006
     187* タイプ: PARAM-CONF-CONTAINER
     188* 多重度: 1..*
     189
     190== WEthCtrlEcucPartitionRef ==
     191{{{
     192/AUTOSAR/EcucDefs/WEth/WEthConfigSet/WEthCtrlConfig/WEthCtrlEcucPartitionRef
     193}}}
     194* 対象リビジョン: R4.4.0/R19-11/R20-11/R21-11
     195* SWSタグ: ECUC_WEth_00039
     196* タイプ: REFERENCE
     197* 多重度: 0..1
     198* 参照先: [wiki:spec/EcuC#EcucPartition /AUTOSAR/EcucDefs/EcuC/EcucPartitionCollection/EcucPartition]
     199
     200== WEthCtrlId ==
     201{{{
     202/AUTOSAR/EcucDefs/WEth/WEthConfigSet/WEthCtrlConfig/WEthCtrlId
     203}}}
     204* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     205* SWSタグ: ECUC_WEth_00007
     206* タイプ: INTEGER-PARAM
     207* 多重度: 1
     208* 上限値: 255
     209* 下限値: 0
     210
     211== WEthCtrlPhyAddress ==
     212{{{
     213/AUTOSAR/EcucDefs/WEth/WEthConfigSet/WEthCtrlConfig/WEthCtrlPhyAddress
     214}}}
     215* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     216* SWSタグ: ECUC_WEth_00020
     217* タイプ: STRING-PARAM
     218* 多重度: 0..1
     219
     220== WEthCtrlRxBufLenByte ==
     221{{{
     222/AUTOSAR/EcucDefs/WEth/WEthConfigSet/WEthCtrlConfig/WEthCtrlRxBufLenByte
     223}}}
     224* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     225* SWSタグ: ECUC_WEth_00008
     226* タイプ: INTEGER-PARAM
     227* 多重度: 1
     228* 上限値: 1522
     229* 下限値: 0
     230
     231== WEthCtrlTxBufLenByte ==
     232{{{
     233/AUTOSAR/EcucDefs/WEth/WEthConfigSet/WEthCtrlConfig/WEthCtrlTxBufLenByte
     234}}}
     235* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     236* SWSタグ: ECUC_WEth_00009
     237* タイプ: INTEGER-PARAM
     238* 多重度: 1
     239* 上限値: 1522
     240* 下限値: 0
     241
     242== WEthDemEventParameterRefs ==
     243{{{
     244/AUTOSAR/EcucDefs/WEth/WEthConfigSet/WEthCtrlConfig/WEthDemEventParameterRefs
     245}}}
     246* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     247* SWSタグ: ECUC_WEth_00016
     248* タイプ: PARAM-CONF-CONTAINER
     249* 多重度: 0..1
     250
     251== WETH_E_ACCESS ==
     252{{{
     253/AUTOSAR/EcucDefs/WEth/WEthConfigSet/WEthCtrlConfig/WEthDemEventParameterRefs/WETH_E_ACCESS
     254}}}
     255* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     256* SWSタグ: ECUC_WEth_00017
     257* タイプ:
     258  * R4.3.1: SYMBOLIC-NAME-REFERENCE
     259  * R4.4.0/R19-11/R20-11/R21-11: REFERENCE
     260* 多重度: 0..1
     261* 参照先: [wiki:spec/Dem#DemEventParameter /AUTOSAR/EcucDefs/Dem/DemConfigSet/DemEventParameter]
     262
     263== WEthRxBufTotal ==
     264{{{
     265/AUTOSAR/EcucDefs/WEth/WEthConfigSet/WEthCtrlConfig/WEthRxBufTotal
     266}}}
     267* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     268* SWSタグ: ECUC_WEth_00013
     269* タイプ: INTEGER-PARAM
     270* 多重度: 1
     271* 上限値: 255
     272* 下限値: 0
     273
     274== WEthTxBufTotal ==
     275{{{
     276/AUTOSAR/EcucDefs/WEth/WEthConfigSet/WEthCtrlConfig/WEthTxBufTotal
     277}}}
     278* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     279* SWSタグ: ECUC_WEth_00014
     280* タイプ: INTEGER-PARAM
     281* 多重度: 1
     282* 上限値: 255
     283* 下限値: 0
     284
     285== WEthGeneral ==
     286{{{
     287/AUTOSAR/EcucDefs/WEth/WEthGeneral
     288}}}
     289* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     290* SWSタグ: ECUC_WEth_00001
     291* タイプ: PARAM-CONF-CONTAINER
     292* 多重度: 1
     293
     294== WEthDevErrorDetect ==
     295{{{
     296/AUTOSAR/EcucDefs/WEth/WEthGeneral/WEthDevErrorDetect
     297}}}
     298* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     299* SWSタグ: ECUC_WEth_00003
     300* タイプ: BOOLEAN-PARAM
     301* 多重度: 1
     302* デフォルト値: false
     303
     304== WEthEcucPartitionRef ==
     305{{{
     306/AUTOSAR/EcucDefs/WEth/WEthGeneral/WEthEcucPartitionRef
     307}}}
     308* 対象リビジョン: R4.4.0/R19-11/R20-11/R21-11
     309* SWSタグ: ECUC_WEth_00038
     310* タイプ: REFERENCE
     311* 多重度: 0..*
     312* 参照先: [wiki:spec/EcuC#EcucPartition /AUTOSAR/EcucDefs/EcuC/EcucPartitionCollection/EcucPartition]
     313
     314== WEthGetWEtherStatsApi ==
     315{{{
     316/AUTOSAR/EcucDefs/WEth/WEthGeneral/WEthGetWEtherStatsApi
     317}}}
     318* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     319* SWSタグ: ECUC_WEth_00036
     320* タイプ: BOOLEAN-PARAM
     321* 多重度: 1
     322
     323== WEthIndex ==
     324{{{
     325/AUTOSAR/EcucDefs/WEth/WEthGeneral/WEthIndex
     326}}}
     327* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     328* SWSタグ: ECUC_WEth_00018
     329* タイプ: INTEGER-PARAM
     330* 多重度: 1
     331* 上限値: 255
     332* 下限値: 0
     333
     334== WEthMainFunctionPeriod ==
     335{{{
     336/AUTOSAR/EcucDefs/WEth/WEthGeneral/WEthMainFunctionPeriod
     337}}}
     338* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     339* SWSタグ: ECUC_WEth_00022
     340* タイプ: FLOAT-PARAM
     341* 多重度: 1
     342* 上限値: INF
     343* 下限値: 0
     344
     345== WEthUpdatePhysAddrFilter ==
     346{{{
     347/AUTOSAR/EcucDefs/WEth/WEthGeneral/WEthUpdatePhysAddrFilter
     348}}}
     349* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     350* SWSタグ: ECUC_WEth_00019
     351* タイプ: BOOLEAN-PARAM
     352* 多重度: 1
     353* デフォルト値: false
     354
     355== WEthVersionInfoApi ==
     356{{{
     357/AUTOSAR/EcucDefs/WEth/WEthGeneral/WEthVersionInfoApi
     358}}}
     359* 対象リビジョン: R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     360* SWSタグ: ECUC_WEth_00004
     361* タイプ: BOOLEAN-PARAM
     362* 多重度: 1
     363* デフォルト値: false
     364