Changes between Version 4 and Version 5 of spec/Xcp


Ignore:
Timestamp:
Jan 8, 2015, 6:17:40 PM (9 years ago)
Author:
fujisft-shigihara
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • spec/Xcp

    v4 v5  
    77[[BR]]
    88
    9 {{{#!comment
    10 [執筆開始時削除エリア]ここから
    11 ※コメントごと削除してください
    12 }}}
    13 * '''本項目は、まだ執筆されていません'''
    14 * '''執筆して頂ける方は、本注意書きを削除の上、執筆をお願いします(詳しくは本Wikiのソースコードをご参照ください)'''
    15 * '''質問事項等がございましたら、[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 問い合わせ先]までお願いします'''
     9= 概要 =
     10* API一覧
     11
     12  ||= API =||= ID[[BR]][Dec] =||= ID[[BR]][Hex] =||
     13  || [#Xcp_Init Xcp_Init]                                   ||  0|| 0x00||
     14  || [#Xcp_GetVersionInfo Xcp_GetVersionInfo]               ||  1|| 0x01||
     15  || [#Xcp_moduleRxIndication Xcp_<module>RxIndication]     ||  3|| 0x03||
     16  || [#Xcp_moduleTxConfirmation Xcp_<module>TxConfirmation] ||  2|| 0x02||
     17  || [#Xcp_LoTriggerTransmit Xcp_<Lo>TriggerTransmit]       || 65|| 0x41||
     18  || [#Xcp_SetTransmissionMode Xcp_SetTransmissionMode]     ||  5|| 0x05||
     19  || [#Xcp_MainFunction Xcp_MainFunction]                   ||  4|| 0x04||
     20
     21* コンフィギュレーション一覧
     22  * [#XcpConfig XcpConfig]
     23    * [#XcpDaqList XcpDaqList]
     24      * [#XcpDaqListNumber XcpDaqListNumber]
     25      * [#XcpDaqListType XcpDaqListType]
     26      * [#XcpMaxOdt XcpMaxOdt]
     27      * [#XcpMaxOdtEntries XcpMaxOdtEntries]
     28      * [#XcpDto XcpDto]
     29        * [#XcpDtoPid XcpDtoPid]
     30        * [#XcpDto2PduMapping XcpDto2PduMapping]
     31      * [#XcpOdt XcpOdt]
     32        * [#XcpOdtEntryMaxSize XcpOdtEntryMaxSize]
     33        * [#XcpOdtNumber XcpOdtNumber]
     34        * [#XcpOdt2DtoMapping XcpOdt2DtoMapping]
     35        * [#XcpOdtEntry XcpOdtEntry]
     36          * [#XcpOdtEntryAddress XcpOdtEntryAddress]
     37          * [#XcpOdtEntryLength XcpOdtEntryLength]
     38          * [#XcpOdtEntryNumber XcpOdtEntryNumber]
     39    * [#XcpDemEventParameterRefs XcpDemEventParameterRefs]
     40      * [#XCP_E_INIT_FAILED XCP_E_INIT_FAILED]
     41    * [#XcpEventChannel XcpEventChannel]
     42      * [#XcpEventChannelConsistency XcpEventChannelConsistency]
     43      * [#XcpEventChannelMaxDaqList XcpEventChannelMaxDaqList]
     44      * [#XcpEventChannelNumber XcpEventChannelNumber]
     45      * [#XcpEventChannelPriority XcpEventChannelPriority]
     46      * [#XcpEventChannelTimeCycle XcpEventChannelTimeCycle]
     47      * [#XcpEventChannelTimeUnit XcpEventChannelTimeUnit]
     48      * [#XcpEventChannelType XcpEventChannelType]
     49      * [#XcpEventChannelTriggeredDaqListRef XcpEventChannelTriggeredDaqListRef]
     50    * [#XcpPdu XcpPdu]
     51      * [#XcpRxPdu XcpRxPdu]
     52        * [#XcpRxPduId XcpRxPduId]
     53        * [#XcpRxPduRef XcpRxPduRef]
     54      * [#XcpTxPdu XcpTxPdu]
     55        * [#XcpTxPduId XcpTxPduId]
     56        * [#XcpTxPduRef XcpTxPduRef]
     57  * [#XcpGeneral XcpGeneral]
     58    * [#XcpDaqConfigType XcpDaqConfigType]
     59    * [#XcpDaqCount XcpDaqCount]
     60    * [#XcpDevErrorDetect XcpDevErrorDetect]
     61    * [#XcpIdentificationFieldType XcpIdentificationFieldType]
     62    * [#XcpMainFunctionPeriod XcpMainFunctionPeriod]
     63    * [#XcpMaxCto XcpMaxCto]
     64    * [#XcpMaxDto XcpMaxDto]
     65    * [#XcpMaxEventChannel XcpMaxEventChannel]
     66    * [#XcpMinDaq XcpMinDaq]
     67    * [#XcpOdtCount XcpOdtCount]
     68    * [#XcpOdtEntriesCount XcpOdtEntriesCount]
     69    * [#XcpOdtEntrySizeDaq XcpOdtEntrySizeDaq]
     70    * [#XcpOdtEntrySizeStim XcpOdtEntrySizeStim]
     71    * [#XcpOnCanEnabled XcpOnCanEnabled]
     72    * [#XcpOnCddEnabled XcpOnCddEnabled]
     73    * [#XcpOnEthernetEnabled XcpOnEthernetEnabled]
     74    * [#XcpOnFlexRayEnabled XcpOnFlexRayEnabled]
     75    * [#XcpPrescalerSupported XcpPrescalerSupported]
     76    * [#XcpSuppressTxSupport XcpSuppressTxSupport]
     77    * [#XcpTimestampTicks XcpTimestampTicks]
     78    * [#XcpTimestampType XcpTimestampType]
     79    * [#XcpTimestampUnit XcpTimestampUnit]
     80    * [#XcpVersionInfoApi XcpVersionInfoApi]
     81    * [#XcpCounterRef XcpCounterRef]
     82
     83* エラーコード一覧
     84  * "--"は[wiki:spec_DiagnosticEventManager Dem]により決定される
     85
     86  ||= エラーコード =||= Dec =||= Hex =||
     87  || XCP_E_INV_POINTER     ||  1|| 0x01||
     88  || XCP_E_NOT_INITIALIZED ||  2|| 0x02||
     89  || XCP_E_INVALID_PDUID   ||  3|| 0x03||
     90  || XCP_E_INIT_FAILED     || --||   --||
     91  || XCP_E_NULL_POINTER    || 18|| 0x12||
     92
    1693----
    17 {{{#!comment
    18 [執筆開始時削除エリア]ここまで
    19 ※コメントごと削除してください
    20 }}}
    21 
    22 = 概要 =
     94
     95= API仕様 =
     96
     97== Xcp_Init ==
     98{{{
     99void Xcp_Init(const Xcp_ConfigType* Xcp_ConfigPtr)
     100}}}
     101
     102== Xcp_GetVersionInfo ==
     103{{{
     104void Xcp_GetVersionInfo(Std_VersionInfoType* versioninfo)
     105}}}
     106
     107== Xcp_moduleRxIndication ==
     108{{{
     109void Xcp_<module>RxIndication(PduIdType XcpRxPduId, PduInfoType* XcpRxPduPtr)
     110}}}
     111
     112== Xcp_moduleTxConfirmation ==
     113{{{
     114void Xcp_<module>TxConfirmation(PduIdType XcpTxPduId)
     115}}}
     116
     117== Xcp_LoTriggerTransmit ==
     118{{{
     119Std_ReturnType Xcp_<Lo>TriggerTransmit(PduIdType TxPduId, PduInfoType* PduInfoPtr)
     120}}}
     121
     122== Xcp_SetTransmissionMode ==
     123{{{
     124void Xcp_SetTransmissionMode(NetworkHandleType Channel, Xcp_TransmissionModeType Mode)
     125}}}
     126
     127== Xcp_MainFunction ==
     128{{{
     129void Xcp_MainFunction(void)
     130}}}
    23131
    24132----
    25133
    26 = API仕様 =
    27 
    28 ----
    29 
    30134= コンフィギュレーション仕様 =
     135
     136== XcpConfig ==
     137{{{
     138/AUTOSAR/EcucDefs/Xcp/XcpConfig
     139}}}
     140* 型：Container
     141* 多重度：1
     142
     143== XcpDaqList ==
     144{{{
     145/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList
     146}}}
     147* 型：Container
     148* 多重度：1..*
     149
     150== XcpDaqListNumber ==
     151{{{
     152/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList/XcpDaqListNumber
     153}}}
     154* 型：IntegerParam
     155* 多重度：1
     156
     157== XcpDaqListType ==
     158{{{
     159/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList/XcpDaqListType
     160}}}
     161* 型：EnumerationParam
     162* 多重度：1
     163
     164== XcpMaxOdt ==
     165{{{
     166/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList/XcpMaxOdt
     167}}}
     168* 型：IntegerParam
     169* 多重度：1
     170
     171== XcpMaxOdtEntries ==
     172{{{
     173/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList/XcpMaxOdtEntries
     174}}}
     175* 型：IntegerParam
     176* 多重度：1
     177
     178== XcpDto ==
     179{{{
     180/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList/XcpDto
     181}}}
     182* 型：Container
     183* 多重度：0..*
     184
     185== XcpDtoPid ==
     186{{{
     187/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList/XcpDto/XcpDtoPid
     188}}}
     189* 型：IntegerParam
     190* 多重度：1
     191
     192== XcpDto2PduMapping ==
     193{{{
     194/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList/XcpDto/XcpDto2PduMapping
     195}}}
     196* 型：Reference
     197* 多重度：1
     198
     199== XcpOdt ==
     200{{{
     201/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList/XcpOdt
     202}}}
     203* 型：Container
     204* 多重度：1..*
     205
     206== XcpOdtEntryMaxSize ==
     207{{{
     208/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList/XcpOdt/XcpOdtEntryMaxSize
     209}}}
     210* 型：IntegerParam
     211* 多重度：1
     212
     213== XcpOdtNumber ==
     214{{{
     215/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList/XcpOdt/XcpOdtNumber
     216}}}
     217* 型：IntegerParam
     218* 多重度：1
     219
     220== XcpOdt2DtoMapping ==
     221{{{
     222/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList/XcpOdt/XcpOdt2DtoMapping
     223}}}
     224* 型：Reference
     225* 多重度：1
     226
     227== XcpOdtEntry ==
     228{{{
     229/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList/XcpOdt/XcpOdtEntry
     230}}}
     231* 型：Container
     232* 多重度：1..*
     233
     234== XcpOdtEntryAddress ==
     235{{{
     236/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList/XcpOdt/XcpOdtEntry/XcpOdtEntryAddress
     237}}}
     238* 型：LinkerSymbol
     239* 多重度：1
     240
     241== XcpOdtEntryLength ==
     242{{{
     243/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList/XcpOdt/XcpOdtEntry/XcpOdtEntryLength
     244}}}
     245* 型：IntegerParam
     246* 多重度：1
     247
     248== XcpOdtEntryNumber ==
     249{{{
     250/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDaqList/XcpOdt/XcpOdtEntry/XcpOdtEntryNumber
     251}}}
     252* 型：IntegerParam
     253* 多重度：1
     254
     255== XcpDemEventParameterRefs ==
     256{{{
     257/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDemEventParameterRefs
     258}}}
     259* 型：Container
     260* 多重度：0..1
     261
     262== XCP_E_INIT_FAILED ==
     263{{{
     264/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpDemEventParameterRefs/XCP_E_INIT_FAILED
     265}}}
     266* 型：Reference
     267* 多重度：0..1
     268
     269== XcpEventChannel ==
     270{{{
     271/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpEventChannel
     272}}}
     273* 型：Container
     274* 多重度：1..*
     275
     276== XcpEventChannelConsistency ==
     277{{{
     278/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpEventChannel/XcpEventChannelConsistency
     279}}}
     280* 型：EnumerationParam
     281* 多重度：1
     282
     283== XcpEventChannelMaxDaqList ==
     284{{{
     285/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpEventChannel/XcpEventChannelMaxDaqList
     286}}}
     287* 型：IntegerParam
     288* 多重度：1
     289
     290== XcpEventChannelNumber ==
     291{{{
     292/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpEventChannel/XcpEventChannelNumber
     293}}}
     294* 型：IntegerParam
     295* 多重度：1
     296
     297== XcpEventChannelPriority ==
     298{{{
     299/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpEventChannel/XcpEventChannelPriority
     300}}}
     301* 型：IntegerParam
     302* 多重度：1
     303
     304== XcpEventChannelTimeCycle ==
     305{{{
     306/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpEventChannel/XcpEventChannelTimeCycle
     307}}}
     308* 型：IntegerParam
     309* 多重度：1
     310
     311== XcpEventChannelTimeUnit ==
     312{{{
     313/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpEventChannel/XcpEventChannelTimeUnit
     314}}}
     315* 型：EnumerationParam
     316* 多重度：0..1
     317
     318== XcpEventChannelType ==
     319{{{
     320/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpEventChannel/XcpEventChannelType
     321}}}
     322* 型：EnumerationParam
     323* 多重度：1
     324
     325== XcpEventChannelTriggeredDaqListRef ==
     326{{{
     327/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpEventChannel/XcpEventChannelTriggeredDaqListRef
     328}}}
     329* 型：Reference
     330* 多重度：1..*
     331
     332== XcpPdu ==
     333{{{
     334/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpPdu
     335}}}
     336* 型：Container
     337* 多重度：1..*
     338
     339== XcpRxPdu ==
     340{{{
     341/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpPdu/XcpRxPdu
     342}}}
     343* 型：Container
     344* 多重度：0..1
     345
     346== XcpRxPduId ==
     347{{{
     348/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpPdu/XcpRxPdu/XcpRxPduId
     349}}}
     350* 型：IntegerParam
     351* 多重度：1
     352
     353== XcpRxPduRef ==
     354{{{
     355/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpPdu/XcpRxPdu/XcpRxPduRef
     356}}}
     357* 型：Reference
     358* 多重度：1
     359
     360== XcpTxPdu ==
     361{{{
     362/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpPdu/XcpTxPdu
     363}}}
     364* 型：Container
     365* 多重度：0..1
     366
     367== XcpTxPduId ==
     368{{{
     369/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpPdu/XcpTxPdu/XcpTxPduId
     370}}}
     371* 型：IntegerParam
     372* 多重度：1
     373
     374== XcpTxPduRef ==
     375{{{
     376/AUTOSAR/EcucDefs/Xcp/XcpConfig/XcpPdu/XcpTxPdu/XcpTxPduRef
     377}}}
     378* 型：Reference
     379* 多重度：1
     380
     381== XcpGeneral ==
     382{{{
     383/AUTOSAR/EcucDefs/Xcp/XcpGeneral
     384}}}
     385* 型：Container
     386* 多重度：1
     387
     388== XcpDaqConfigType ==
     389{{{
     390/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpDaqConfigType
     391}}}
     392* 型：EnumerationParam
     393* 多重度：1
     394
     395== XcpDaqCount ==
     396{{{
     397/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpDaqCount
     398}}}
     399* 型：IntegerParam
     400* 多重度：1
     401
     402== XcpDevErrorDetect ==
     403{{{
     404/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpDevErrorDetect
     405}}}
     406* 型：BooleanParam
     407* 多重度：1
     408
     409== XcpIdentificationFieldType ==
     410{{{
     411/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpIdentificationFieldType
     412}}}
     413* 型：EnumerationParam
     414* 多重度：1
     415
     416== XcpMainFunctionPeriod ==
     417{{{
     418/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpMainFunctionPeriod
     419}}}
     420* 型：FloatParam
     421* 多重度：1
     422
     423== XcpMaxCto ==
     424{{{
     425/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpMaxCto
     426}}}
     427* 型：IntegerParam
     428* 多重度：1
     429
     430== XcpMaxDto ==
     431{{{
     432/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpMaxDto
     433}}}
     434* 型：IntegerParam
     435* 多重度：1
     436
     437== XcpMaxEventChannel ==
     438{{{
     439/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpMaxEventChannel
     440}}}
     441* 型：IntegerParam
     442* 多重度：1
     443
     444== XcpMinDaq ==
     445{{{
     446/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpMinDaq
     447}}}
     448* 型：IntegerParam
     449* 多重度：1
     450
     451== XcpOdtCount ==
     452{{{
     453/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpOdtCount
     454}}}
     455* 型：IntegerParam
     456* 多重度：1
     457
     458== XcpOdtEntriesCount ==
     459{{{
     460/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpOdtEntriesCount
     461}}}
     462* 型：IntegerParam
     463* 多重度：1
     464
     465== XcpOdtEntrySizeDaq ==
     466{{{
     467/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpOdtEntrySizeDaq
     468}}}
     469* 型：IntegerParam
     470* 多重度：1
     471
     472== XcpOdtEntrySizeStim ==
     473{{{
     474/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpOdtEntrySizeStim
     475}}}
     476* 型：IntegerParam
     477* 多重度：1
     478
     479== XcpOnCanEnabled ==
     480{{{
     481/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpOnCanEnabled
     482}}}
     483* 型：BooleanParam
     484* 多重度：1
     485
     486== XcpOnCddEnabled ==
     487{{{
     488/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpOnCddEnabled
     489}}}
     490* 型：BooleanParam
     491* 多重度：1
     492
     493== XcpOnEthernetEnabled ==
     494{{{
     495/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpOnEthernetEnabled
     496}}}
     497* 型：BooleanParam
     498* 多重度：1
     499
     500== XcpOnFlexRayEnabled ==
     501{{{
     502/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpOnFlexRayEnabled
     503}}}
     504* 型：BooleanParam
     505* 多重度：1
     506
     507== XcpPrescalerSupported ==
     508{{{
     509/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpPrescalerSupported
     510}}}
     511* 型：BooleanParam
     512* 多重度：1
     513
     514== XcpSuppressTxSupport ==
     515{{{
     516/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpSuppressTxSupport
     517}}}
     518* 型：BooleanParam
     519* 多重度：1
     520
     521== XcpTimestampTicks ==
     522{{{
     523/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpTimestampTicks
     524}}}
     525* 型：IntegerParam
     526* 多重度：1
     527
     528== XcpTimestampType ==
     529{{{
     530/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpTimestampType
     531}}}
     532* 型：EnumerationParam
     533* 多重度：1
     534
     535== XcpTimestampUnit ==
     536{{{
     537/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpTimestampUnit
     538}}}
     539* 型：EnumerationParam
     540* 多重度：1
     541
     542== XcpVersionInfoApi ==
     543{{{
     544/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpVersionInfoApi
     545}}}
     546* 型：BooleanParam
     547* 多重度：1
     548
     549== XcpCounterRef ==
     550{{{
     551/AUTOSAR/EcucDefs/Xcp/XcpGeneral/XcpCounterRef
     552}}}
     553* 型：Reference
     554* 多重度：1