Changes between Version 4 and Version 5 of spec/Can


Ignore:
Timestamp:
Oct 12, 2014, 4:59:34 PM (10 years ago)
Author:
fujisft-shigihara
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • spec/Can

    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* COMスタックのMCALで、CANプロトコルを扱う
     11
     12* API一覧
     13
     14  ||= API =||= ID[[BR]][Dec] =||= ID[[BR]][Hex] =||
     15  || [#Can_Init Can_Init]                                               ||  0|| 0x00||
     16  || [#Can_GetVersionInfo Can_GetVersionInfo]                           ||  7|| 0x07||
     17  || [#Can_CheckBaudrate Can_CheckBaudrate]                             || 14|| 0x0E||
     18  || [#Can_ChangeBaudrate Can_ChangeBaudrate]                           || 13|| 0x0D||
     19  || [#Can_SetControllerMode Can_SetControllerMode]                     ||  3|| 0x03||
     20  || [#Can_DisableControllerInterrupts Can_DisableControllerInterrupts] ||  4|| 0x04||
     21  || [#Can_EnableControllerInterrupts Can_EnableControllerInterrupts]   ||  5|| 0x05||
     22  || [#Can_CheckWakeup Can_CheckWakeup]                                 || 11|| 0x0B||
     23  || [#Can_Write Can_Write]                                             ||  6|| 0x06||
     24  || [#Can_MainFunction_Write Can_MainFunction_Write]                   ||  1|| 0x01||
     25  || [#Can_MainFunction_Read Can_MainFunction_Read]                     ||  8|| 0x08||
     26  || [#Can_MainFunction_BusOff Can_MainFunction_BusOff]                 ||  9|| 0x09||
     27  || [#Can_MainFunction_Wakeup Can_MainFunction_Wakeup]                 || 10|| 0x0A||
     28  || [#Can_MainFunction_Mode Can_MainFunction_Mode]                     || 12|| 0x0C||
     29
     30* コンフィギュレーション一覧
     31  * [#CanGeneral CanGeneral]
     32    * [#CanChangeBaudrateApi CanChangeBaudrateApi]
     33    * [#CanDevErrorDetection CanDevErrorDetection]
     34    * [#CanHardwareCancellation CanHardwareCancellation]
     35    * [#CanIdenticalIdCancellation CanIdenticalIdCancellation]
     36    * [#CanIndex CanIndex]
     37    * [#CanLPduReceiveCalloutFunction CanLPduReceiveCalloutFunction]
     38    * [#CanMainFunctionBusoffPeriod CanMainFunctionBusoffPeriod]
     39    * [#CanMainFunctionModePeriod CanMainFunctionModePeriod]
     40    * [#CanMainFunctionWakeupPeriod CanMainFunctionWakeupPeriod]
     41    * [#CanMultiplexedTransmission CanMultiplexedTransmission]
     42    * [#CanTimeoutDuration CanTimeoutDuration]
     43    * [#CanVersionInfoApi CanVersionInfoApi]
     44    * [#CanCounterRef CanCounterRef]
     45    * [#CanSupportTTCANRef CanSupportTTCANRef]
     46    * [#CanMainFunctionRWPeriods CanMainFunctionRWPeriods]
     47      * [#CanMainFunctionReadPeriod CanMainFunctionReadPeriod]
     48      * [#CanMainFunctionWritePeriod CanMainFunctionWritePeriod]
     49  * [#CanConfigSet CanConfigSet]
     50    * [#CanController CanController]
     51      * [#CanBusoffProcessing CanBusoffProcessing]
     52      * [#CanControllerActivation CanControllerActivation]
     53      * [#CanControllerBaseAddress CanControllerBaseAddress]
     54      * [#CanControllerId CanControllerId]
     55      * [#CanRxProcessing CanRxProcessing]
     56      * [#CanTxProcessing CanTxProcessing]
     57      * [#CanWakeupProcessing CanWakeupProcessing]
     58      * [#CanWakeupSupport CanWakeupSupport]
     59      * [#CanControllerDefaultBaudrate CanControllerDefaultBaudrate]
     60      * [#CanCpuClockRef CanCpuClockRef]
     61      * [#CanWakeupSourceRef CanWakeupSourceRef]
     62      * [#CanControllerBaudrateConfig CanControllerBaudrateConfig]
     63        * [#CanControllerBaudRate CanControllerBaudRate]
     64        * [#CanControllerPropSeg CanControllerPropSeg]
     65        * [#CanControllerSeg1 CanControllerSeg1]
     66        * [#CanControllerSeg2 CanControllerSeg2]
     67        * [#CanControllerSyncJumpWidth CanControllerSyncJumpWidth]
     68      * [#CanFilterMask CanFilterMask]
     69        * [#CanFilterMaskValue CanFilterMaskValue]
     70      * [#CanTTController CanTTController]
     71    * [#CanHardwareObject CanHardwareObject]
     72      * [#CanHandleType CanHandleType]
     73      * [#CanIdType CanIdType]
     74      * [#CanIdValue CanIdValue]
     75      * [#CanObjectId CanObjectId]
     76      * [#CanObjectType CanObjectType]
     77      * [#CanControllerRef CanControllerRef]
     78      * [#CanFilterMaskRef CanFilterMaskRef]
     79      * [#CanMainFunctionRWPeriodRef CanMainFunctionRWPeriodRef]
     80      * [#CanTTHardwareObjectTrigger CanTTHardwareObjectTrigger]
     81
    1682----
    17 {{{#!comment
    18 [執筆開始時削除エリア]ここまで
    19 ※コメントごと削除してください
    20 }}}
    21 
    22 = 概要 =
     83
     84= API仕様 =
     85
     86== Can_Init ==
     87{{{
     88void Can_Init(const Can_ConfigType* Config)
     89}}}
     90
     91== Can_GetVersionInfo ==
     92{{{
     93void Can_GetVersionInfo(Std_VersionInfoType* versioninfo)
     94}}}
     95
     96== Can_CheckBaudrate ==
     97{{{
     98Std_ReturnType Can_CheckBaudrate(uint8 Controller, const uint16 Baudrate)
     99}}}
     100
     101== Can_ChangeBaudrate ==
     102{{{
     103Std_ReturnType Can_ChangeBaudrate(uint8 Controller, const uint16 Baudrate)
     104}}}
     105
     106== Can_SetControllerMode ==
     107{{{
     108Can_ReturnType Can_SetControllerMode(uint8 Controller, Can_StateTransitionType Transition)
     109}}}
     110
     111== Can_DisableControllerInterrupts ==
     112{{{
     113void Can_DisableControllerInterrupts(uint8 Controller)
     114}}}
     115
     116== Can_EnableControllerInterrupts ==
     117{{{
     118void Can_EnableControllerInterrupts(uint8 Controller)
     119}}}
     120
     121== Can_CheckWakeup ==
     122{{{
     123Can_ReturnType Can_CheckWakeup(uint8 Controller)
     124}}}
     125
     126== Can_Write ==
     127{{{
     128Can_ReturnType Can_Write(Can_HwHandleType Hth, const Can_PduType* PduInfo)
     129}}}
     130
     131== Can_MainFunction_Write ==
     132{{{
     133void Can_MainFunction_Write(void)
     134}}}
     135
     136== Can_MainFunction_Read ==
     137{{{
     138void Can_MainFunction_Read(void)
     139}}}
     140
     141== Can_MainFunction_BusOff ==
     142{{{
     143void Can_MainFunction_BusOff(void)
     144}}}
     145
     146== Can_MainFunction_Wakeup ==
     147{{{
     148void Can_MainFunction_Wakeup(void)
     149}}}
     150
     151== Can_MainFunction_Mode ==
     152{{{
     153void Can_MainFunction_Mode(void)
     154}}}
    23155
    24156----
    25157
    26 = API仕様 =
    27 
    28 ----
    29 
    30158= コンフィギュレーション仕様 =
     159
     160== !CanGeneral ==
     161{{{
     162/AUTOSAR/EcucDefs/Can/CanGeneral
     163}}}
     164* 型：Container
     165* 多重度：1
     166
     167== !CanChangeBaudrateApi ==
     168{{{
     169/AUTOSAR/EcucDefs/Can/CanGeneral/CanChangeBaudrateApi
     170}}}
     171* 型：!BooleanParam
     172* 多重度：1
     173
     174== !CanDevErrorDetection ==
     175{{{
     176/AUTOSAR/EcucDefs/Can/CanGeneral/CanDevErrorDetection
     177}}}
     178* 型：!BooleanParam
     179* 多重度：1
     180
     181== !CanHardwareCancellation ==
     182{{{
     183/AUTOSAR/EcucDefs/Can/CanGeneral/CanHardwareCancellation
     184}}}
     185* 型：!BooleanParam
     186* 多重度：1
     187
     188== !CanIdenticalIdCancellation ==
     189{{{
     190/AUTOSAR/EcucDefs/Can/CanGeneral/CanIdenticalIdCancellation
     191}}}
     192* 型：!BooleanParam
     193* 多重度：1
     194
     195== !CanIndex ==
     196{{{
     197/AUTOSAR/EcucDefs/Can/CanGeneral/CanIndex
     198}}}
     199* 型：!IntegerParam
     200* 多重度：1
     201
     202== CanLPduReceiveCalloutFunction ==
     203{{{
     204/AUTOSAR/EcucDefs/Can/CanGeneral/CanLPduReceiveCalloutFunction
     205}}}
     206* 型：!FunctionName
     207* 多重度：0..1
     208
     209== !CanMainFunctionBusoffPeriod ==
     210{{{
     211/AUTOSAR/EcucDefs/Can/CanGeneral/CanMainFunctionBusoffPeriod
     212}}}
     213* 型：!FloatParam
     214* 多重度：0..1
     215
     216== !CanMainFunctionModePeriod ==
     217{{{
     218/AUTOSAR/EcucDefs/Can/CanGeneral/CanMainFunctionModePeriod
     219}}}
     220* 型：!FloatParam
     221* 多重度：1
     222
     223== !CanMainFunctionWakeupPeriod ==
     224{{{
     225/AUTOSAR/EcucDefs/Can/CanGeneral/CanMainFunctionWakeupPeriod
     226}}}
     227* 型：!FloatParam
     228* 多重度：0..1
     229
     230== !CanMultiplexedTransmission ==
     231{{{
     232/AUTOSAR/EcucDefs/Can/CanGeneral/CanMultiplexedTransmission
     233}}}
     234* 型：!BooleanParam
     235* 多重度：1
     236
     237== !CanTimeoutDuration ==
     238{{{
     239/AUTOSAR/EcucDefs/Can/CanGeneral/CanTimeoutDuration
     240}}}
     241* 型：!FloatParam
     242* 多重度：1
     243
     244== !CanVersionInfoApi ==
     245{{{
     246/AUTOSAR/EcucDefs/Can/CanGeneral/CanVersionInfoApi
     247}}}
     248* 型：!BooleanParam
     249* 多重度：1
     250
     251== !CanCounterRef ==
     252{{{
     253/AUTOSAR/EcucDefs/Can/CanGeneral/CanCounterRef
     254}}}
     255* 型：Reference
     256* 多重度：1
     257
     258== CanSupportTTCANRef ==
     259{{{
     260/AUTOSAR/EcucDefs/Can/CanGeneral/CanSupportTTCANRef
     261}}}
     262* 型：Reference
     263* 多重度：1
     264
     265== CanMainFunctionRWPeriods ==
     266{{{
     267/AUTOSAR/EcucDefs/Can/CanGeneral/CanMainFunctionRWPeriods
     268}}}
     269* 型：Container
     270* 多重度：1
     271
     272== !CanMainFunctionReadPeriod ==
     273{{{
     274/AUTOSAR/EcucDefs/Can/CanGeneral/CanMainFunctionRWPeriods/CanMainFunctionReadPeriod
     275}}}
     276* 型：!FloatParam
     277* 多重度：0..*
     278
     279== !CanMainFunctionWritePeriod ==
     280{{{
     281/AUTOSAR/EcucDefs/Can/CanGeneral/CanMainFunctionRWPeriods/CanMainFunctionWritePeriod
     282}}}
     283* 型：!FloatParam
     284* 多重度：0..*
     285
     286== !CanConfigSet ==
     287{{{
     288/AUTOSAR/EcucDefs/Can/CanConfigSet
     289}}}
     290* 型：Container
     291* 多重度：1
     292
     293== !CanController ==
     294{{{
     295/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController
     296}}}
     297* 型：Container
     298* 多重度：1..*
     299
     300== !CanBusoffProcessing ==
     301{{{
     302/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanBusoffProcessing
     303}}}
     304* 型：!EnumerationParam
     305* 多重度：1
     306
     307== !CanControllerActivation ==
     308{{{
     309/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanControllerActivation
     310}}}
     311* 型：!BooleanParam
     312* 多重度：1
     313
     314== !CanControllerBaseAddress ==
     315{{{
     316/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanControllerBaseAddress
     317}}}
     318* 型：!IntegerParam
     319* 多重度：1
     320
     321== !CanControllerId ==
     322{{{
     323/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanControllerId
     324}}}
     325* 型：!IntegerParam
     326* 多重度：1
     327
     328== !CanRxProcessing ==
     329{{{
     330/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanRxProcessing
     331}}}
     332* 型：!EnumerationParam
     333* 多重度：1
     334
     335== !CanTxProcessing ==
     336{{{
     337/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanTxProcessing
     338}}}
     339* 型：!EnumerationParam
     340* 多重度：1
     341
     342== !CanWakeupProcessing ==
     343{{{
     344/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanWakeupProcessing
     345}}}
     346* 型：!EnumerationParam
     347* 多重度：1
     348
     349== !CanWakeupSupport ==
     350{{{
     351/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanWakeupSupport
     352}}}
     353* 型：!BooleanParam
     354* 多重度：1
     355
     356== !CanControllerDefaultBaudrate ==
     357{{{
     358/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanControllerDefaultBaudrate
     359}}}
     360* 型：Reference
     361* 多重度：1
     362
     363== !CanCpuClockRef ==
     364{{{
     365/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanCpuClockRef
     366}}}
     367* 型：Reference
     368* 多重度：1
     369
     370== !CanWakeupSourceRef ==
     371{{{
     372/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanWakeupSourceRef
     373}}}
     374* 型：Reference
     375* 多重度：0..1
     376
     377== !CanControllerBaudrateConfig ==
     378{{{
     379/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanControllerBaudrateConfig
     380}}}
     381* 型：Container
     382* 多重度：1..*
     383
     384== !CanControllerBaudRate ==
     385{{{
     386/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanControllerBaudrateConfig/CanControllerBaudRate
     387}}}
     388* 型：!IntegerParam
     389* 多重度：1
     390
     391== !CanControllerPropSeg ==
     392{{{
     393/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanControllerBaudrateConfig/CanControllerPropSeg
     394}}}
     395* 型：!IntegerParam
     396* 多重度：1
     397
     398== !CanControllerSeg1 ==
     399{{{
     400/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanControllerBaudrateConfig/CanControllerSeg1
     401}}}
     402* 型：!IntegerParam
     403* 多重度：1
     404
     405== !CanControllerSeg2 ==
     406{{{
     407/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanControllerBaudrateConfig/CanControllerSeg2
     408}}}
     409* 型：!IntegerParam
     410* 多重度：1
     411
     412== !CanControllerSyncJumpWidth ==
     413{{{
     414/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanControllerBaudrateConfig/CanControllerSyncJumpWidth
     415}}}
     416* 型：!IntegerParam
     417* 多重度：1
     418
     419== !CanFilterMask ==
     420{{{
     421/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanFilterMask
     422}}}
     423* 型：Container
     424* 多重度：0..*
     425
     426== !CanFilterMaskValue ==
     427{{{
     428/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanFilterMask/CanFilterMaskValue
     429}}}
     430* 型：!IntegerParam
     431* 多重度：1
     432
     433== CanTTController ==
     434{{{
     435/AUTOSAR/EcucDefs/Can/CanConfigSet/CanController/CanTTController
     436}}}
     437* 型：Container
     438* 多重度：0..1
     439* 本コンテナに所属するパラメータ仕様は、[wiki:spec_TTCANDriver TTCAN Driver]の仕様書に規定されている
     440
     441== !CanHardwareObject ==
     442{{{
     443/AUTOSAR/EcucDefs/Can/CanConfigSet/CanHardwareObject
     444}}}
     445* 型：Container
     446* 多重度：1..*
     447
     448== !CanHandleType ==
     449{{{
     450/AUTOSAR/EcucDefs/Can/CanConfigSet/CanHardwareObject/CanHandleType
     451}}}
     452* 型：!EnumerationParam
     453* 多重度：1
     454
     455== !CanIdType ==
     456{{{
     457/AUTOSAR/EcucDefs/Can/CanConfigSet/CanHardwareObject/CanIdType
     458}}}
     459* 型：!EnumerationParam
     460* 多重度：1
     461
     462== !CanIdValue ==
     463{{{
     464/AUTOSAR/EcucDefs/Can/CanConfigSet/CanHardwareObject/CanIdValue
     465}}}
     466* 型：!IntegerParam
     467* 多重度：1
     468
     469== !CanObjectId ==
     470{{{
     471/AUTOSAR/EcucDefs/Can/CanConfigSet/CanHardwareObject/CanObjectId
     472}}}
     473* 型：!IntegerParam
     474* 多重度：1
     475
     476== !CanObjectType ==
     477{{{
     478/AUTOSAR/EcucDefs/Can/CanConfigSet/CanHardwareObject/CanObjectType
     479}}}
     480* 型：!EnumerationParam
     481* 多重度：1
     482
     483== !CanControllerRef ==
     484{{{
     485/AUTOSAR/EcucDefs/Can/CanConfigSet/CanHardwareObject/CanControllerRef
     486}}}
     487* 型：Reference
     488* 多重度：1
     489
     490== !CanFilterMaskRef ==
     491{{{
     492/AUTOSAR/EcucDefs/Can/CanConfigSet/CanHardwareObject/CanFilterMaskRef
     493}}}
     494* 型：Reference
     495* 多重度：0..1
     496
     497== CanMainFunctionRWPeriodRef ==
     498{{{
     499/AUTOSAR/EcucDefs/Can/CanConfigSet/CanHardwareObject/CanMainFunctionRWPeriodRef
     500}}}
     501* 型：Reference
     502* 多重度：0..1
     503
     504== CanTTHardwareObjectTrigger ==
     505{{{
     506/AUTOSAR/EcucDefs/Can/CanConfigSet/CanHardwareObject/CanTTHardwareObjectTrigger
     507}}}
     508* 型：Container
     509* 多重度：0..*
     510* 本コンテナに所属するパラメータ仕様は、[wiki:spec_TTCANDriver TTCAN Driver]の仕様書に規定されている
     511