Changes between Version 4 and Version 5 of spec/ComM


Ignore:
Timestamp:
Oct 27, 2014, 9:54:22 AM (10 years ago)
Author:
fujisft-shigihara
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • spec/ComM

    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* API一覧
     11
     12  ||= API =||= ID[[BR]][Dec] =||= ID[[BR]][Hex] =||
     13  || [#ComM_Init ComM_Init]                                            ||  1|| 0x01||
     14  || [#ComM_DeInit ComM_DeInit]                                        ||  2|| 0x02||
     15  || [#ComM_GetState ComM_GetState]                                    || 52|| 0x34||
     16  || [#ComM_GetStatus ComM_GetStatus]                                  ||  3|| 0x03||
     17  || [#ComM_GetInhibitionStatus ComM_GetInhibitionStatus]              ||  4|| 0x04||
     18  || [#ComM_RequestComMode ComM_RequestComMode]                        ||  5|| 0x05||
     19  || [#ComM_GetMaxComMode ComM_GetMaxComMode]                          ||  6|| 0x06||
     20  || [#ComM_GetRequestedComMode ComM_GetRequestedComMode]              ||  7|| 0x07||
     21  || [#ComM_GetCurrentComMode ComM_GetCurrentComMode]                  ||  8|| 0x08||
     22  || [#ComM_PreventWakeUp ComM_PreventWakeUp]                          ||  9|| 0x09||
     23  || [#ComM_LimitChannelToNoComMode ComM_LimitChannelToNoComMode]      || 11|| 0x0B||
     24  || [#ComM_LimitECUToNoComMode ComM_LimitECUToNoComMode]              || 12|| 0x0C||
     25  || [#ComM_ReadInhibitCounter ComM_ReadInhibitCounter]                || 13|| 0x0D||
     26  || [#ComM_ResetInhibitCounter ComM_ResetInhibitCounter]              || 14|| 0x0E||
     27  || [#ComM_SetECUGroupClassification ComM_SetECUGroupClassification]  || 15|| 0x0F||
     28  || [#ComM_GetVersionInfo ComM_GetVersionInfo]                        || 16|| 0x10||
     29  || [#ComM_Nm_NetworkStartIndication ComM_Nm_NetworkStartIndication]  || 21|| 0x15||
     30  || [#ComM_Nm_NetworkMode ComM_Nm_NetworkMode]                        || 24|| 0x18||
     31  || [#ComM_Nm_PrepareBusSleepMode ComM_Nm_PrepareBusSleepMode]        || 25|| 0x19||
     32  || [#ComM_Nm_BusSleepMode ComM_Nm_BusSleepMode]                      || 26|| 0x1A||
     33  || [#ComM_Nm_RestartIndication ComM_Nm_RestartIndication]            || 27|| 0x1B||
     34  || [#ComM_DCM_ActiveDiagnostic ComM_DCM_ActiveDiagnostic]            || 31|| 0x1F||
     35  || [#ComM_DCM_InactiveDiagnostic ComM_DCM_InactiveDiagnostic]        || 32|| 0x20||
     36  || [#ComM_EcuM_WakeUpIndication ComM_EcuM_WakeUpIndication]          || 42|| 0x2A||
     37  || [#ComM_CommunicationAllowed ComM_CommunicationAllowed]            || 53|| 0x35||
     38  || [#ComM_BusSM_ModeIndication ComM_BusSM_ModeIndication]            || 51|| 0x33||
     39  || [#ComM_MainFunction_Channel_Id ComM_MainFunction_<Channel_Id>]    || 96|| 0x60||
     40
     41* コンフィギュレーション一覧
     42  * [#ComMConfigSet ComMConfigSet]
     43    * [#ComMPncEnabled ComMPncEnabled]
     44    * [#ComMChannel ComMChannel]
     45      * [#ComMBusType ComMBusType]
     46      * [#ComMChannelId ComMChannelId]
     47      * [#ComMFullCommRequestNotificationEnabled ComMFullCommRequestNotificationEnabled]
     48      * [#ComMGlobalNvmBlockDescriptor ComMGlobalNvmBlockDescriptor]
     49      * [#ComMMainFunctionPeriod ComMMainFunctionPeriod]
     50      * [#ComMNoCom ComMNoCom]
     51      * [#ComMNoWakeup ComMNoWakeup]
     52      * [#ComMPncGatewayType ComMPncGatewayType]
     53      * [#ComMNetworkManagement ComMNetworkManagement]
     54        * [#ComMNmLightTimeout ComMNmLightTimeout]
     55        * [#ComMNmVariant ComMNmVariant]
     56        * [#ComMPncNmRequest ComMPncNmRequest]
     57      * [#ComMUserPerChannel ComMUserPerChannel]
     58        * [#ComMUserChannel ComMUserChannel]
     59    * [#ComMPnc ComMPnc]
     60      * [#ComMPncId ComMPncId]
     61      * [#ComMChannelPerPnc ComMChannelPerPnc]
     62      * [#ComMUserPerPnc ComMUserPerPnc]
     63      * [#ComMPncComSignal ComMPncComSignal]
     64        * [#ComMPncComSignalDirection ComMPncComSignalDirection]
     65        * [#ComMPncComSignalKind ComMPncComSignalKind]
     66        * [#ComMPncComSignalChannelRef ComMPncComSignalChannelRef]
     67        * [#ComMPncComSignalRef ComMPncComSignalRef]
     68    * [#ComMUser ComMUser]
     69      * [#ComMUserIdentifier ComMUserIdentifier]
     70      * [#ComMUserEcucPartitionRef ComMUserEcucPartitionRef]
     71  * [#ComMGeneral ComMGeneral]
     72    * [#ComMDevErrorDetect ComMDevErrorDetect]
     73    * [#ComMDirectUserMapping ComMDirectUserMapping]
     74    * [#ComMEcuGroupClassification ComMEcuGroupClassification]
     75    * [#ComMModeLimitationEnabled ComMModeLimitationEnabled]
     76    * [#ComMPncGatewayEnabled ComMPncGatewayEnabled]
     77    * [#ComMPncPrepareSleepTimer ComMPncPrepareSleepTimer]
     78    * [#ComMPncSupport ComMPncSupport]
     79    * [#ComMSynchronousWakeUp ComMSynchronousWakeUp]
     80    * [#ComMTMinFullComModeDuration ComMTMinFullComModeDuration]
     81    * [#ComMVersionInfoApi ComMVersionInfoApi]
     82    * [#ComMWakeupInhibitionEnabled ComMWakeupInhibitionEnabled]
     83    * [#ComMGlobalNvMBlockDescriptor ComMGlobalNvMBlockDescriptor]
     84
     85* エラーコード一覧
     86
     87  ||= エラーコード =||= Dec =||= Hex =||
     88  || COMM_E_NOT_INITED       ||  1|| 0x01||
     89  || COMM_E_WRONG_PARAMETERS ||  2|| 0x02||
     90
    1691----
    17 {{{#!comment
    18 [執筆開始時削除エリア]ここまで
    19 ※コメントごと削除してください
    20 }}}
    21 
    22 = 概要 =
     92
     93= API仕様 =
     94
     95== ComM_Init ==
     96{{{
     97void ComM_Init(void)
     98}}}
     99
     100== ComM_DeInit ==
     101{{{
     102void ComM_DeInit(void)
     103}}}
     104
     105== ComM_GetState ==
     106{{{
     107Std_ReturnType ComM_GetState(NetworkHandleType Channel, ComM_StateType* State)
     108}}}
     109
     110== ComM_GetStatus ==
     111{{{
     112Std_ReturnType ComM_GetStatus(ComM_InitStatusType* Status)
     113}}}
     114
     115== ComM_GetInhibitionStatus ==
     116{{{
     117Std_ReturnType ComM_GetInhibitionStatus(NetworkHandleType Channel, ComM_InhibitionStatusType* Status)
     118}}}
     119
     120== ComM_RequestComMode ==
     121{{{
     122Std_ReturnType ComM_RequestComMode(ComM_UserHandleType User, ComM_ModeType ComMode)
     123}}}
     124
     125== ComM_GetMaxComMode ==
     126{{{
     127Std_ReturnType ComM_GetMaxComMode(ComM_UserHandleType User, ComM_ModeType* ComMode)
     128}}}
     129
     130== ComM_GetRequestedComMode ==
     131{{{
     132Std_ReturnType ComM_GetRequestedComMode(ComM_UserHandleType User, ComM_ModeType* ComMode)
     133}}}
     134
     135== ComM_GetCurrentComMode ==
     136{{{
     137Std_ReturnType ComM_GetCurrentComMode(ComM_UserHandleType User, ComM_ModeType* ComMode)
     138}}}
     139
     140== ComM_PreventWakeUp ==
     141{{{
     142Std_ReturnType ComM_PreventWakeUp(NetworkHandleType Channel, boolean Status)
     143}}}
     144
     145== ComM_LimitChannelToNoComMode ==
     146{{{
     147Std_ReturnType ComM_LimitChannelToNoComMode(NetworkHandleType Channel, boolean Status)
     148}}}
     149
     150== ComM_LimitECUToNoComMode ==
     151{{{
     152Std_ReturnType ComM_LimitECUToNoComMode(boolean Status)
     153}}}
     154
     155== ComM_ReadInhibitCounter ==
     156{{{
     157Std_ReturnType ComM_ReadInhibitCounter(uint16* CounterValue)
     158}}}
     159
     160== ComM_ResetInhibitCounter ==
     161{{{
     162Std_ReturnType ComM_ResetInhibitCounter(void)
     163}}}
     164
     165== ComM_SetECUGroupClassification ==
     166{{{
     167Std_ReturnType ComM_SetECUGroupClassification(ComM_InhibitionStatusType Status)
     168}}}
     169
     170== ComM_GetVersionInfo ==
     171{{{
     172void ComM_GetVersionInfo(Std_VersionInfoType* Versioninfo)
     173}}}
     174
     175== ComM_Nm_NetworkStartIndication ==
     176{{{
     177void ComM_Nm_NetworkStartIndication(NetworkHandleType Channel)
     178}}}
     179
     180== ComM_Nm_NetworkMode ==
     181{{{
     182void ComM_Nm_NetworkMode(NetworkHandleType Channel)
     183}}}
     184
     185== ComM_Nm_PrepareBusSleepMode ==
     186{{{
     187void ComM_Nm_PrepareBusSleepMode(NetworkHandleType Channel)
     188}}}
     189
     190== ComM_Nm_BusSleepMode ==
     191{{{
     192void ComM_Nm_BusSleepMode(NetworkHandleType Channel)
     193}}}
     194
     195== ComM_Nm_RestartIndication ==
     196{{{
     197void ComM_Nm_RestartIndication(NetworkHandleType Channel)
     198}}}
     199
     200== ComM_DCM_ActiveDiagnostic ==
     201{{{
     202void ComM_DCM_ActiveDiagnostic(NetworkHandleType Channel)
     203}}}
     204
     205== ComM_DCM_InactiveDiagnostic ==
     206{{{
     207void ComM_DCM_InactiveDiagnostic(NetworkHandleType Channel)
     208}}}
     209
     210== ComM_EcuM_WakeUpIndication ==
     211{{{
     212void ComM_EcuM_WakeUpIndication(NetworkHandleType Channel)
     213}}}
     214
     215== ComM_CommunicationAllowed ==
     216{{{
     217void ComM_CommunicationAllowed(NetworkHandleType Channel, boolean Allowed)
     218}}}
     219
     220== ComM_BusSM_ModeIndication ==
     221{{{
     222void ComM_BusSM_ModeIndication(NetworkHandleType Channel, ComM_ModeType* ComMode)
     223}}}
     224
     225== ComM_MainFunction_<Channel_Id> ==
     226{{{
     227void ComM_MainFunction_<Channel_Id>(void)
     228}}}
    23229
    24230----
    25231
    26 = API仕様 =
    27 
    28 ----
    29 
    30232= コンフィギュレーション仕様 =
     233
     234== ComMConfigSet ==
     235{{{
     236/AUTOSAR/EcucDefs/ComM/ComMConfigSet
     237}}}
     238* 型：Container
     239* 多重度：1
     240
     241== ComMPncEnabled ==
     242{{{
     243/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMPncEnabled
     244}}}
     245* 型：!BooleanParam
     246* 多重度：0..1
     247
     248== ComMChannel ==
     249{{{
     250/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel
     251}}}
     252* 型：Container
     253* 多重度：1..*
     254
     255== ComMBusType ==
     256{{{
     257/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel/ComMBusType
     258}}}
     259* 型：!EnumerationParam
     260* 多重度：1
     261
     262== ComMChannelId ==
     263{{{
     264/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel/ComMChannelId
     265}}}
     266* 型：!IntegerParam
     267* 多重度：1
     268
     269== ComMFullCommRequestNotificationEnabled ==
     270{{{
     271/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel/ComMFullCommRequestNotificationEnabled
     272}}}
     273* 型：!BooleanParam
     274* 多重度：1
     275
     276== ComMGlobalNvmBlockDescriptor ==
     277{{{
     278/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel/ComMGlobalNvmBlockDescriptor
     279}}}
     280* 型：!BooleanParam
     281* 多重度：1
     282
     283== ComMMainFunctionPeriod ==
     284{{{
     285/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel/ComMMainFunctionPeriod
     286}}}
     287* 型：!FloatParam
     288* 多重度：1
     289
     290== ComMNoCom ==
     291{{{
     292/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel/ComMNoCom
     293}}}
     294* 型：!BooleanParam
     295* 多重度：1
     296
     297== ComMNoWakeup ==
     298{{{
     299/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel/ComMNoWakeup
     300}}}
     301* 型：!BooleanParam
     302* 多重度：1
     303
     304== ComMPncGatewayType ==
     305{{{
     306/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel/ComMPncGatewayType
     307}}}
     308* 型：!EnumerationParam
     309* 多重度：0..1
     310
     311== ComMNetworkManagement ==
     312{{{
     313/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel/ComMNetworkManagement
     314}}}
     315* 型：Container
     316* 多重度：1
     317
     318== ComMNmLightTimeout ==
     319{{{
     320/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel/ComMNetworkManagement/ComMNmLightTimeout
     321}}}
     322* 型：!FloatParam
     323* 多重度：0..1
     324
     325== ComMNmVariant ==
     326{{{
     327/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel/ComMNetworkManagement/ComMNmVariant
     328}}}
     329* 型：!EnumerationParam
     330* 多重度：1
     331
     332== ComMPncNmRequest ==
     333{{{
     334/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel/ComMNetworkManagement/ComMPncNmRequest
     335}}}
     336* 型：!BooleanParam
     337* 多重度：1
     338
     339== ComMUserPerChannel ==
     340{{{
     341/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel/ComMUserPerChannel
     342}}}
     343* 型：Container
     344* 多重度：0..*
     345
     346== ComMUserChannel ==
     347{{{
     348/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel/ComMUserPerChannel/ComMUserChannel
     349}}}
     350* 型：Reference
     351* 多重度：1
     352
     353== ComMPnc ==
     354{{{
     355/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMPnc
     356}}}
     357* 型：Container
     358* 多重度：0..*
     359
     360== ComMPncId ==
     361{{{
     362/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMPnc/ComMPncId
     363}}}
     364* 型：!IntegerParam
     365* 多重度：1
     366
     367== ComMChannelPerPnc ==
     368{{{
     369/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMPnc/ComMChannelPerPnc
     370}}}
     371* 型：Reference
     372* 多重度：1..*
     373
     374== ComMUserPerPnc ==
     375{{{
     376/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMPnc/ComMUserPerPnc
     377}}}
     378* 型：Reference
     379* 多重度：0..*
     380
     381== ComMPncComSignal ==
     382{{{
     383/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMPnc/ComMPncComSignal
     384}}}
     385* 型：Container
     386* 多重度：0..*
     387
     388== ComMPncComSignalDirection ==
     389{{{
     390/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMPnc/ComMPncComSignal/ComMPncComSignalDirection
     391}}}
     392* 型：!EnumerationParam
     393* 多重度：1
     394
     395== ComMPncComSignalKind ==
     396{{{
     397/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMPnc/ComMPncComSignal/ComMPncComSignalKind
     398}}}
     399* 型：!EnumerationParam
     400* 多重度：1
     401
     402== ComMPncComSignalChannelRef ==
     403{{{
     404/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMPnc/ComMPncComSignal/ComMPncComSignalChannelRef
     405}}}
     406* 型：Reference
     407* 多重度：0..1
     408
     409== ComMPncComSignalRef ==
     410{{{
     411/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMPnc/ComMPncComSignal/ComMPncComSignalRef
     412}}}
     413* 型：Reference
     414* 多重度：1
     415
     416== ComMUser ==
     417{{{
     418/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMUser
     419}}}
     420* 型：Container
     421* 多重度：1..*
     422
     423== ComMUserIdentifier ==
     424{{{
     425/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMUser/ComMUserIdentifier
     426}}}
     427* 型：!IntegerParam
     428* 多重度：1
     429
     430== ComMUserEcucPartitionRef ==
     431{{{
     432/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMUser/ComMUserEcucPartitionRef
     433}}}
     434* 型：Reference
     435* 多重度：0..1
     436
     437== ComMGeneral ==
     438{{{
     439/AUTOSAR/EcucDefs/ComM/ComMGeneral
     440}}}
     441* 型：Container
     442* 多重度：1
     443
     444== ComMDevErrorDetect ==
     445{{{
     446/AUTOSAR/EcucDefs/ComM/ComMGeneral/ComMDevErrorDetect
     447}}}
     448* 型：!BooleanParam
     449* 多重度：1
     450
     451== ComMDirectUserMapping ==
     452{{{
     453/AUTOSAR/EcucDefs/ComM/ComMGeneral/ComMDirectUserMapping
     454}}}
     455* 型：!BooleanParam
     456* 多重度：0..1
     457
     458== ComMEcuGroupClassification ==
     459{{{
     460/AUTOSAR/EcucDefs/ComM/ComMGeneral/ComMEcuGroupClassification
     461}}}
     462* 型：!IntegerParam
     463* 多重度：1
     464
     465== ComMModeLimitationEnabled ==
     466{{{
     467/AUTOSAR/EcucDefs/ComM/ComMGeneral/ComMModeLimitationEnabled
     468}}}
     469* 型：!BooleanParam
     470* 多重度：1
     471
     472== ComMPncGatewayEnabled ==
     473{{{
     474/AUTOSAR/EcucDefs/ComM/ComMGeneral/ComMPncGatewayEnabled
     475}}}
     476* 型：!BooleanParam
     477* 多重度：0..1
     478
     479== ComMPncPrepareSleepTimer ==
     480{{{
     481/AUTOSAR/EcucDefs/ComM/ComMGeneral/ComMPncPrepareSleepTimer
     482}}}
     483* 型：!FloatParam
     484* 多重度：0..1
     485
     486== ComMPncSupport ==
     487{{{
     488/AUTOSAR/EcucDefs/ComM/ComMGeneral/ComMPncSupport
     489}}}
     490* 型：!BooleanParam
     491* 多重度：1
     492
     493== ComMSynchronousWakeUp ==
     494{{{
     495/AUTOSAR/EcucDefs/ComM/ComMGeneral/ComMSynchronousWakeUp
     496}}}
     497* 型：!BooleanParam
     498* 多重度：1
     499
     500== ComMTMinFullComModeDuration ==
     501{{{
     502/AUTOSAR/EcucDefs/ComM/ComMGeneral/ComMTMinFullComModeDuration
     503}}}
     504* 型：!FloatParam
     505* 多重度：1
     506
     507== ComMVersionInfoApi ==
     508{{{
     509/AUTOSAR/EcucDefs/ComM/ComMGeneral/ComMVersionInfoApi
     510}}}
     511* 型：!BooleanParam
     512* 多重度：1
     513
     514== ComMWakeupInhibitionEnabled ==
     515{{{
     516/AUTOSAR/EcucDefs/ComM/ComMGeneral/ComMWakeupInhibitionEnabled
     517}}}
     518* 型：!BooleanParam
     519* 多重度：1
     520
     521== ComMGlobalNvMBlockDescriptor ==
     522{{{
     523/AUTOSAR/EcucDefs/ComM/ComMGeneral/ComMGlobalNvMBlockDescriptor
     524}}}
     525* 型：Reference
     526* 多重度：0..1
     527