Changes between Version 4 and Version 5 of spec/CanTrcv


Ignore:
Timestamp:
Oct 23, 2014, 1:51:54 PM (10 years ago)
Author:
fujisft-shigihara
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • spec/CanTrcv

    v4 v5  
    77[[BR]]
    88
    9 {{{#!comment
    10 [執筆開始時削除エリア]ここから
    11 ※コメントごと削除してください
    12 }}}
    13 * '''本項目は、まだ執筆されていません'''
    14 * '''執筆して頂ける方は、本注意書きを削除の上、執筆をお願いします(詳しくは本Wikiのソースコードをご参照ください)'''
    15 * '''質問事項等がございましたら、[http://dev.toppers.jp/trac/ap/wiki/ Wikiトップページ]にあります[http://dev.toppers.jp/trac/ap/wiki/WikiStart#%E5%95%8F%E3%81%84%E5%90%88%E3%82%8F%E3%81%9B%E5%85%88 問い合わせ先]までお願いします'''
     9= 概要 =
     10
     11* API一覧
     12
     13  ||= API =||= ID[[BR]][Dec] =||= ID[[BR]][Hex] =||
     14  || [#CanTrcv_Init CanTrcv_Init]                                       ||  0|| 0x00||
     15  || [#CanTrcv_SetOpMode CanTrcv_SetOpMode]                             ||  1|| 0x01||
     16  || [#CanTrcv_GetOpMode CanTrcv_GetOpMode]                             ||  2|| 0x02||
     17  || [#CanTrcv_GetBusWuReason CanTrcv_GetBusWuReason]                   ||  3|| 0x03||
     18  || [#CanTrcv_GetVersionInfo CanTrcv_GetVersionInfo]                   ||  4|| 0x04||
     19  || [#CanTrcv_SetWakeupMode CanTrcv_SetWakeupMode]                     ||  5|| 0x05||
     20  || [#CanTrcv_GetTrcvSystemData CanTrcv_GetTrcvSystemData]             ||  9|| 0x09||
     21  || [#CanTrcv_ClearTrcvWufFlag CanTrcv_ClearTrcvWufFlag]               || 10|| 0x0A||
     22  || [#CanTrcv_ReadTrcvTimeoutFlag CanTrcv_ReadTrcvTimeoutFlag]         || 11|| 0x0B||
     23  || [#CanTrcv_ClearTrcvTimeoutFlag CanTrcv_ClearTrcvTimeoutFlag]       || 12|| 0x0C||
     24  || [#CanTrcv_ReadTrcvSilenceFlag CanTrcv_ReadTrcvSilenceFlag]         || 13|| 0x0D||
     25  || [#CanTrcv_CheckWakeup CanTrcv_CheckWakeup]                         ||  7|| 0x07||
     26  || [#CanTrcv_SetPNActivationState CanTrcv_SetPNActivationState]       || 15|| 0x0F||
     27  || [#CanTrcv_CheckWakeFlag CanTrcv_CheckWakeFlag]                     || 14|| 0x0E||
     28  || [#CanTrcv_MainFunction CanTrcv_MainFunction]                       ||  6|| 0x06||
     29  || [#CanTrcv_MainFunctionDiagnostics CanTrcv_MainFunctionDiagnostics] ||  8|| 0x08||
     30
     31* コンフィギュレーション一覧
     32  * [#CanTrcvConfigSet CanTrcvConfigSet]
     33    * [#CanTrcvSPICommRetries CanTrcvSPICommRetries]
     34    * [#CanTrcvSPICommTimeout CanTrcvSPICommTimeout]
     35    * [#CanTrcvChannel CanTrcvChannel]
     36      * [#CanTrcvChannelId CanTrcvChannelId]
     37      * [#CanTrcvChannelUsed CanTrcvChannelUsed]
     38      * [#CanTrcvControlsPowerSupply CanTrcvControlsPowerSupply]
     39      * [#CanTrcvHwPnSupport CanTrcvHwPnSupport]
     40      * [#CanTrcvInitState CanTrcvInitState]
     41      * [#CanTrcvMaxBaudrate CanTrcvMaxBaudrate]
     42      * [#CanTrcvWakeupByBusUsed CanTrcvWakeupByBusUsed]
     43      * [#CanTrcvWakeupSourceRef CanTrcvWakeupSourceRef]
     44      * [#CanTrcvAccess CanTrcvAccess]
     45        * [#CanTrcvDioAccess CanTrcvDioAccess]
     46          * [#CanTrcvDioChannelAccess CanTrcvDioChannelAccess]
     47            * [#CanTrcvHardwareInterfaceName CanTrcvHardwareInterfaceName]
     48            * [#CanTrcvDioSymNameRef CanTrcvDioSymNameRef]
     49        * [#CanTrcvSpiSequence CanTrcvSpiSequence]
     50          * [#CanTrcvSpiAccessSynchronous CanTrcvSpiAccessSynchronous]
     51          * [#CanTrcvSpiSequenceName CanTrcvSpiSequenceName]
     52      * [#CanTrcvPartialNetwork CanTrcvPartialNetwork]
     53        * [#CanTrcvBaudRate CanTrcvBaudRate]
     54        * [#CanTrcvBusErrFlag CanTrcvBusErrFlag]
     55        * [#CanTrcvPnCanIdIsExtended CanTrcvPnCanIdIsExtended]
     56        * [#CanTrcvPnEnabled CanTrcvPnEnabled]
     57        * [#CanTrcvPnFrameCanId CanTrcvPnFrameCanId]
     58        * [#CanTrcvPnFrameCanIdMask CanTrcvPnFrameCanIdMask]
     59        * [#CanTrcvPnFrameDlc CanTrcvPnFrameDlc]
     60        * [#CanTrcvPowerOnFlag CanTrcvPowerOnFlag]
     61        * [#CanTrcvPnFrameDataMaskSpec CanTrcvPnFrameDataMaskSpec]
     62          * [#CanTrcvPnFrameDataMask CanTrcvPnFrameDataMask]
     63          * [#CanTrcvPnFrameDataMaskIndex CanTrcvPnFrameDataMaskIndex]
     64  * [#CanTrcvGeneral CanTrcvGeneral]
     65    * [#CanTrcvDevErrorDetect CanTrcvDevErrorDetect]
     66    * [#CanTrcvGetVersionInfo CanTrcvGetVersionInfo]
     67    * [#CanTrcvSPICommRetries CanTrcvSPICommRetries]
     68    * [#CanTrcvSPICommTimeout CanTrcvSPICommTimeout]
     69    * [#CanTrcvWaitCount CanTrcvWaitCount]
     70    * [#CanTrcvWakeUpSupport CanTrcvWakeUpSupport]
     71
     72* エラーコード一覧
     73
     74  ||= エラーコード =||= Dec =||= Hex =||
     75  || CANTRCV_E_INVALID_TRANSCEIVER    ||  1|| 0x01||
     76  || CANTRCV_E_PARAM_POINTER          ||  2|| 0x02||
     77  || CANTRCV_E_UNINIT                 || 11|| 0x0B||
     78  || CANTRCV_E_TRCV_NOT_STANDBY       || 21|| 0x15||
     79  || CANTRCV_E_TRCV_NOT_NORMAL        || 22|| 0x16||
     80  || CANTRCV_E_PARAM_TRCV_WAKEUP_MODE || 23|| 0x17||
     81  || CANTRCV_E_PARAM_TRCV_OPMODE      || 24|| 0x18||
     82  || CANTRCV_E_BAUDRATE_NOT_SUPPORTED || 25|| 0x19||
     83  || CANTRCV_E_NO_TRCV_CONTROL        || 26|| 0x1A||
     84
    1685----
    17 {{{#!comment
    18 [執筆開始時削除エリア]ここまで
    19 ※コメントごと削除してください
    20 }}}
    21 
    22 = 概要 =
     86
     87= API仕様 =
     88
     89== !CanTrcv_Init ==
     90{{{
     91void CanTrcv_Init(const CanTrcv_ConfigType* ConfigPtr)
     92}}}
     93
     94== !CanTrcv_SetOpMode ==
     95{{{
     96Std_ReturnType CanTrcv_SetOpMode(uint8 Transceiver, CanTrcv_TrcvModeType OpMode)
     97}}}
     98
     99== !CanTrcv_GetOpMode ==
     100{{{
     101Std_ReturnType CanTrcv_GetOpMode(uint8 Transceiver, CanTrcv_TrcvModeType* OpMode)
     102}}}
     103
     104== !CanTrcv_GetBusWuReason ==
     105{{{
     106Std_ReturnType CanTrcv_GetBusWuReason(uint8 Transceiver, CanTrcv_TrcvWakeupReasonType* reason)
     107}}}
     108
     109== !CanTrcv_GetVersionInfo ==
     110{{{
     111void CanTrcv_GetVersionInfo(Std_VersionInfoType* versioninfo)
     112}}}
     113
     114== !CanTrcv_SetWakeupMode ==
     115{{{
     116Std_ReturnType CanTrcv_SetWakeupMode(uint8 Transceiver, CanTrcv_TrcvWakeupModeType TrcvWakeupMode )
     117}}}
     118
     119== !CanTrcv_GetTrcvSystemData ==
     120{{{
     121Std_ReturnType CanTrcv_GetTrcvSystemData(uint8 Transceiver, const uint32* TrcvSysData)
     122}}}
     123
     124== !CanTrcv_ClearTrcvWufFlag ==
     125{{{
     126Std_ReturnType CanTrcv_ClearTrcvWufFlag(uint8 Transceiver)
     127}}}
     128
     129== !CanTrcv_ReadTrcvTimeoutFlag ==
     130{{{
     131Std_ReturnType CanTrcv_ReadTrcvTimeoutFlag(uint8 Transceiver, CanTrcv_TrcvFlagStateType* FlagState)
     132}}}
     133
     134== !CanTrcv_ClearTrcvTimeoutFlag ==
     135{{{
     136Std_ReturnType CanTrcv_ClearTrcvTimeoutFlag(uint8 Transceiver)
     137}}}
     138
     139== !CanTrcv_ReadTrcvSilenceFlag ==
     140{{{
     141Std_ReturnType CanTrcv_ReadTrcvSilenceFlag(uint8 Transceiver, CanTrcv_TrcvFlagStateType* FlagState)
     142}}}
     143
     144== !CanTrcv_CheckWakeup ==
     145{{{
     146Std_ReturnType CanTrcv_CheckWakeup(uint8 Transceiver)
     147}}}
     148
     149== !CanTrcv_SetPNActivationState ==
     150{{{
     151Std_ReturnType CanTrcv_SetPNActivationState(CanTrcv_PNActivationType ActivationState)
     152}}}
     153
     154== !CanTrcv_CheckWakeFlag ==
     155{{{
     156Std_ReturnType CanTrcv_CheckWakeFlag(uint8 Transceiver)
     157}}}
     158
     159== !CanTrcv_MainFunction ==
     160{{{
     161void CanTrcv_MainFunction(void)
     162}}}
     163
     164== !CanTrcv_MainFunctionDiagnostics ==
     165{{{
     166void CanTrcv_MainFunctionDiagnostics(void)
     167}}}
    23168
    24169----
    25170
    26 = API仕様 =
    27 
    28 ----
    29 
    30171= コンフィギュレーション仕様 =
     172
     173== !CanTrcvConfigSet ==
     174{{{
     175/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet
     176}}}
     177* 型：Container
     178* 多重度：1
     179
     180== CanTrcvSPICommRetries ==
     181{{{
     182/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvSPICommRetries
     183}}}
     184* 型：!IntegerParam
     185* 多重度：1
     186
     187== CanTrcvSPICommTimeout ==
     188{{{
     189/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvSPICommTimeout
     190}}}
     191* 型：!IntegerParam
     192* 多重度：1
     193
     194== !CanTrcvChannel ==
     195{{{
     196/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel
     197}}}
     198* 型：Container
     199* 多重度：1..*
     200
     201== !CanTrcvChannelId ==
     202{{{
     203/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvChannelId
     204}}}
     205* 型：!IntegerParam
     206* 多重度：1
     207
     208== !CanTrcvChannelUsed ==
     209{{{
     210/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvChannelUsed
     211}}}
     212* 型：!BooleanParam
     213* 多重度：1
     214
     215== !CanTrcvControlsPowerSupply ==
     216{{{
     217/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvControlsPowerSupply
     218}}}
     219* 型：!BooleanParam
     220* 多重度：1
     221
     222== !CanTrcvHwPnSupport ==
     223{{{
     224/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvHwPnSupport
     225}}}
     226* 型：!BooleanParam
     227* 多重度：1
     228
     229== !CanTrcvInitState ==
     230{{{
     231/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvInitState
     232}}}
     233* 型：!EnumerationParam
     234* 多重度：1
     235
     236== !CanTrcvMaxBaudrate ==
     237{{{
     238/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvMaxBaudrate
     239}}}
     240* 型：!IntegerParam
     241* 多重度：1
     242
     243== !CanTrcvWakeupByBusUsed ==
     244{{{
     245/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvWakeupByBusUsed
     246}}}
     247* 型：!BooleanParam
     248* 多重度：0..1
     249
     250== !CanTrcvWakeupSourceRef ==
     251{{{
     252/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvWakeupSourceRef
     253}}}
     254* 型：Reference
     255* 多重度：0..1
     256
     257== !CanTrcvAccess ==
     258{{{
     259/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvAccess
     260}}}
     261* 型：Container
     262* 多重度：1
     263
     264== !CanTrcvDioAccess ==
     265{{{
     266/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvAccess/CanTrcvDioAccess
     267}}}
     268* 型：Container
     269* 多重度：0..1
     270
     271== !CanTrcvDioChannelAccess ==
     272{{{
     273/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvAccess/CanTrcvDioAccess/CanTrcvDioChannelAccess
     274}}}
     275* 型：Container
     276* 多重度：1..*
     277
     278== !CanTrcvHardwareInterfaceName ==
     279{{{
     280/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvAccess/CanTrcvDioAccess/CanTrcvDioChannelAccess/CanTrcvHardwareInterfaceName
     281}}}
     282* 型：!StringParam
     283* 多重度：1
     284
     285== !CanTrcvDioSymNameRef ==
     286{{{
     287/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvAccess/CanTrcvDioAccess/CanTrcvDioChannelAccess/CanTrcvDioSymNameRef
     288}}}
     289* 型：Reference
     290* 多重度：1
     291
     292== !CanTrcvSpiSequence ==
     293{{{
     294/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvAccess/CanTrcvSpiSequence
     295}}}
     296* 型：Container
     297* 多重度：0..*
     298
     299== !CanTrcvSpiAccessSynchronous ==
     300{{{
     301/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvAccess/CanTrcvSpiSequence/CanTrcvSpiAccessSynchronous
     302}}}
     303* 型：!BooleanParam
     304* 多重度：0..1
     305
     306== !CanTrcvSpiSequenceName ==
     307{{{
     308/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvAccess/CanTrcvSpiSequence/CanTrcvSpiSequenceName
     309}}}
     310* 型：Reference
     311* 多重度：0..*
     312
     313== !CanTrcvPartialNetwork ==
     314{{{
     315/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvPartialNetwork
     316}}}
     317* 型：Container
     318* 多重度：0..1
     319
     320== !CanTrcvBaudRate ==
     321{{{
     322/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvPartialNetwork/CanTrcvBaudRate
     323}}}
     324* 型：!IntegerParam
     325* 多重度：1
     326
     327== !CanTrcvBusErrFlag ==
     328{{{
     329/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvPartialNetwork/CanTrcvBusErrFlag
     330}}}
     331* 型：!BooleanParam
     332* 多重度：1
     333
     334== !CanTrcvPnCanIdIsExtended ==
     335{{{
     336/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvPartialNetwork/CanTrcvPnCanIdIsExtended
     337}}}
     338* 型：!BooleanParam
     339* 多重度：1
     340
     341== !CanTrcvPnEnabled ==
     342{{{
     343/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvPartialNetwork/CanTrcvPnEnabled
     344}}}
     345* 型：!BooleanParam
     346* 多重度：1
     347
     348== !CanTrcvPnFrameCanId ==
     349{{{
     350/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvPartialNetwork/CanTrcvPnFrameCanId
     351}}}
     352* 型：!IntegerParam
     353* 多重度：1
     354
     355== !CanTrcvPnFrameCanIdMask ==
     356{{{
     357/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvPartialNetwork/CanTrcvPnFrameCanIdMask
     358}}}
     359* 型：!IntegerParam
     360* 多重度：1
     361
     362== !CanTrcvPnFrameDlc ==
     363{{{
     364/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvPartialNetwork/CanTrcvPnFrameDlc
     365}}}
     366* 型：!IntegerParam
     367* 多重度：1
     368
     369== !CanTrcvPowerOnFlag ==
     370{{{
     371/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvPartialNetwork/CanTrcvPowerOnFlag
     372}}}
     373* 型：!BooleanParam
     374* 多重度：1
     375
     376== !CanTrcvPnFrameDataMaskSpec ==
     377{{{
     378/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvPartialNetwork/CanTrcvPnFrameDataMaskSpec
     379}}}
     380* 型：Container
     381* 多重度：0..8
     382
     383== !CanTrcvPnFrameDataMask ==
     384{{{
     385/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvPartialNetwork/CanTrcvPnFrameDataMaskSpec/CanTrcvPnFrameDataMask
     386}}}
     387* 型：!IntegerParam
     388* 多重度：1
     389
     390== !CanTrcvPnFrameDataMaskIndex ==
     391{{{
     392/AUTOSAR/EcucDefs/CanTrcv/CanTrcvConfigSet/CanTrcvChannel/CanTrcvPartialNetwork/CanTrcvPnFrameDataMaskSpec/CanTrcvPnFrameDataMaskIndex
     393}}}
     394* 型：!IntegerParam
     395* 多重度：1
     396
     397== !CanTrcvGeneral ==
     398{{{
     399/AUTOSAR/EcucDefs/CanTrcv/CanTrcvGeneral
     400}}}
     401* 型：Container
     402* 多重度：1
     403
     404== !CanTrcvDevErrorDetect ==
     405{{{
     406/AUTOSAR/EcucDefs/CanTrcv/CanTrcvGeneral/CanTrcvDevErrorDetect
     407}}}
     408* 型：!BooleanParam
     409* 多重度：1
     410
     411== !CanTrcvGetVersionInfo ==
     412{{{
     413/AUTOSAR/EcucDefs/CanTrcv/CanTrcvGeneral/CanTrcvGetVersionInfo
     414}}}
     415* 型：!BooleanParam
     416* 多重度：1
     417
     418== CanTrcvSPICommRetries ==
     419{{{
     420/AUTOSAR/EcucDefs/CanTrcv/CanTrcvGeneral/CanTrcvSPICommRetries
     421}}}
     422* 型：!IntegerParam
     423* 多重度：1
     424
     425== CanTrcvSPICommTimeout ==
     426{{{
     427/AUTOSAR/EcucDefs/CanTrcv/CanTrcvGeneral/CanTrcvSPICommTimeout
     428}}}
     429* 型：!IntegerParam
     430* 多重度：1
     431
     432== !CanTrcvWaitCount ==
     433{{{
     434/AUTOSAR/EcucDefs/CanTrcv/CanTrcvGeneral/CanTrcvWaitCount
     435}}}
     436* 型：!IntegerParam
     437* 多重度：1
     438
     439== !CanTrcvWakeUpSupport ==
     440{{{
     441/AUTOSAR/EcucDefs/CanTrcv/CanTrcvGeneral/CanTrcvWakeUpSupport
     442}}}
     443* 型：!EnumerationParam
     444* 多重度：1
     445