Changes between Version 6 and Version 7 of spec/LinNm


Ignore:
Timestamp:
Aug 17, 2020, 10:24:40 PM (4 years ago)
Author:
fujisft-shigihara
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • spec/LinNm

    v6 v7  
    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] =||= R4.2.2 =||
     14  || [#LinNm_Init LinNm_Init]                                             ||   0|| 0x00||  ○  ||
     15  || [#LinNm_PassiveStartUp LinNm_PassiveStartUp]                         ||   1|| 0x01||  ○  ||
     16  || [#LinNm_NetworkRequest LinNm_NetworkRequest]                         ||   2|| 0x02||  ○  ||
     17  || [#LinNm_NetworkRelease LinNm_NetworkRelease]                         ||   3|| 0x03||  ○  ||
     18  || [#LinNm_GetVersionInfo LinNm_GetVersionInfo]                         || 241|| 0xF1||  ○  ||
     19  || [#LinNm_RequestBusSynchronization LinNm_RequestBusSynchronization]   || 192|| 0xC0||  ○  ||
     20  || [#LinNm_CheckRemoteSleepIndication LinNm_CheckRemoteSleepIndication] || 208|| 0xD0||  ○  ||
     21  || [#LinNm_SetSleepReadyBit LinNm_SetSleepReadyBit]                     ||  16|| 0x10||  ○  ||
     22  || [#LinNm_DisableCommunication LinNm_DisableCommunication]             ||   4|| 0x04||  ○  ||
     23  || [#LinNm_EnableCommunication LinNm_EnableCommunication]               ||   5|| 0x05||  ○  ||
     24  || [#LinNm_SetUserData LinNm_SetUserData]                               ||   6|| 0x06||  ○  ||
     25  || [#LinNm_GetUserData LinNm_GetUserData]                               ||   7|| 0x07||  ○  ||
     26  || [#LinNm_GetPduData LinNm_GetPduData]                                 ||   8|| 0x08||  ○  ||
     27  || [#LinNm_RepeatMessageRequest LinNm_RepeatMessageRequest]             ||   9|| 0x09||  ○  ||
     28  || [#LinNm_GetNodeIdentifier LinNm_GetNodeIdentifier]                   ||  10|| 0x0A||  ○  ||
     29  || [#LinNm_GetLocalNodeIdentifier LinNm_GetLocalNodeIdentifier]         ||  11|| 0x0B||  ○  ||
     30  || [#LinNm_GetState LinNm_GetState]                                     ||  14|| 0x0E||  ○  ||
     31  || [#LinNm_Transmit LinNm_Transmit]                                     ||  15|| 0x0F||  ○  ||
     32  || [#LinNm_TxConfirmation LinNm_TxConfirmation]                         ||  64|| 0x40||  ○  ||
     33  || [#LinNm_MainFunction LinNm_MainFunction]                             ||  17|| 0x11||  ○  ||
     34
     35* コンフィギュレーション一覧(R4.2.2)
     36  * [#LinNmGlobalConfig LinNmGlobalConfig] (○)
     37    * [#LinNmBusSynchronizationEnabled LinNmBusSynchronizationEnabled] (○)
     38    * [#LinNmComControlEnabled LinNmComControlEnabled] (○)
     39    * [#LinNmComUserDataSupport LinNmComUserDataSupport] (○)
     40    * [#LinNmCoordinatorSyncSupport LinNmCoordinatorSyncSupport] (○)
     41    * [#LinNmDevErrorDetect LinNmDevErrorDetect] (○)
     42    * [#LinNmMainFunctionPeriod LinNmMainFunctionPeriod] (○)
     43    * [#LinNmNodeDetectionEnabled LinNmNodeDetectionEnabled] (○)
     44    * [#LinNmNodeIdEnabled LinNmNodeIdEnabled] (○)
     45    * [#LinNmPassiveModeEnabled LinNmPassiveModeEnabled] (○)
     46    * [#LinNmRemoteSleepIndicationEnabled LinNmRemoteSleepIndicationEnabled] (○)
     47    * [#LinNmStateChangeIndEnabled LinNmStateChangeIndEnabled] (○)
     48    * [#LinNmSynchronizationPointEnabled LinNmSynchronizationPointEnabled] (○)
     49    * [#LinNmUserDataEnabled LinNmUserDataEnabled] (○)
     50    * [#LinNmVersionInfoApi LinNmVersionInfoApi] (○)
     51    * [#LinNmChannelConfig LinNmChannelConfig] (○)
     52      * [#LinNmTimeoutTime LinNmTimeoutTime] (○)
     53      * [#LinNmComMNetworkHandleRef LinNmComMNetworkHandleRef] (○)
     54
     55* エラーコード一覧
     56
     57  ||= エラーコード =||= Dec =||= Hex =||= R4.2.2 =||
     58  || LINNM_E_NO_INIT         ||  1|| 0x01||  ○  ||
     59  || LINNM_E_INVALID_CHANNEL ||  2|| 0x02||  ○  ||
     60  || LINNM_E_PARAM_POINTER   || 18|| 0x12||  ○  ||
     61  || LINNM_E_INIT_FAILED     || 19|| 0x13||  ○  ||
     62
    1563----
    16 {{{#!comment
    17 [執筆開始時削除エリア]ここまで
    18 ※コメントごと削除してください
    19 }}}
    20 
    21 = 概要 =
     64
     65= API仕様 =
     66
     67== LinNm_Init ==
     68{{{
     69void LinNm_Init(const LinNm_ConfigType* ConfigPtr)
     70}}}
     71
     72== LinNm_PassiveStartUp ==
     73{{{
     74Std_ReturnType LinNm_PassiveStartUp(NetworkHandleType nmChannelHandle)
     75}}}
     76
     77== LinNm_NetworkRequest ==
     78{{{
     79Std_ReturnType LinNm_NetworkRequest(NetworkHandleType nmChannelHandle)
     80}}}
     81
     82== LinNm_NetworkRelease ==
     83{{{
     84Std_ReturnType LinNm_NetworkRelease(NetworkHandleType nmChannelHandle)
     85}}}
     86
     87== LinNm_GetVersionInfo ==
     88{{{
     89void LinNm_GetVersionInfo(Std_VersionInfoType* versioninfo)
     90}}}
     91
     92== LinNm_RequestBusSynchronization ==
     93{{{
     94Std_ReturnType LinNm_RequestBusSynchronization(NetworkHandleType nmChannelHandle)
     95}}}
     96
     97== LinNm_CheckRemoteSleepIndication ==
     98{{{
     99Std_ReturnType LinNm_CheckRemoteSleepIndication(NetworkHandleType nmChannelHandle, boolean* nmRemoteSleepIndPtr)
     100}}}
     101
     102== LinNm_SetSleepReadyBit ==
     103{{{
     104Std_ReturnType LinNm_SetSleepReadyBit(NetworkHandleType nmChannelHandle, boolean nmSleepReadyBit)
     105}}}
     106
     107== LinNm_DisableCommunication ==
     108{{{
     109Std_ReturnType LinNm_DisableCommunication(NetworkHandleType NetworkHandle)
     110}}}
     111
     112== LinNm_EnableCommunication ==
     113{{{
     114Std_ReturnType LinNm_EnableCommunication(NetworkHandleType NetworkHandle)
     115}}}
     116
     117== LinNm_SetUserData ==
     118{{{
     119Std_ReturnType LinNm_SetUserData(NetworkHandleType NetworkHandle, const uint8* nmUserDataPtr)
     120}}}
     121
     122== LinNm_GetUserData ==
     123{{{
     124Std_ReturnType LinNm_GetUserData(NetworkHandleType NetworkHandle, uint8* nmUserDataPtr)
     125}}}
     126
     127== LinNm_GetPduData ==
     128{{{
     129Std_ReturnType LinNm_GetPduData(NetworkHandleType NetworkHandle, uint8* nmPduData)
     130}}}
     131
     132== LinNm_RepeatMessageRequest ==
     133{{{
     134Std_ReturnType LinNm_RepeatMessageRequest(NetworkHandleType NetworkHandle)
     135}}}
     136
     137== LinNm_GetNodeIdentifier ==
     138{{{
     139Std_ReturnType LinNm_GetNodeIdentifier(NetworkHandleType NetworkHandle, uint8* nmNodeIdPtr)
     140}}}
     141
     142== LinNm_GetLocalNodeIdentifier ==
     143{{{
     144Std_ReturnType LinNm_GetLocalNodeIdentifier(NetworkHandleType NetworkHandle, uint8* nmNodeIdPtr)
     145}}}
     146
     147== LinNm_GetState ==
     148{{{
     149Std_ReturnType LinNm_GetState(NetworkHandleType nmNetworkHandle, Nm_StateType* nmStatePtr, Nm_ModeType* nmModePtr)
     150}}}
     151
     152== LinNm_Transmit ==
     153{{{
     154Std_ReturnType LinNm_Transmit(PduIdType LinTxPduId, const PduInfoType* PduInfoPtr)
     155}}}
     156
     157== LinNm_TxConfirmation ==
     158{{{
     159void LinNm_TxConfirmation(PduIdType TxPduId)
     160}}}
     161
     162== LinNm_MainFunction ==
     163{{{
     164void LinNm_MainFunction(void)
     165}}}
    22166
    23167----
    24168
    25 = API仕様 =
    26 
    27 ----
    28 
    29169= コンフィギュレーション仕様 =
     170
     171== LinNmGlobalConfig ==
     172{{{
     173/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig
     174}}}
     175* 型：Container
     176* 多重度：1
     177
     178== LinNmBusSynchronizationEnabled ==
     179{{{
     180/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmBusSynchronizationEnabled
     181}}}
     182* 型：BooleanParam
     183* 多重度：1
     184
     185== LinNmComControlEnabled ==
     186{{{
     187/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmComControlEnabled
     188}}}
     189* 型：BooleanParam
     190* 多重度：1
     191
     192== LinNmComUserDataSupport ==
     193{{{
     194/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmComUserDataSupport
     195}}}
     196* 型：BooleanParam
     197* 多重度：0..1
     198
     199== LinNmCoordinatorSyncSupport ==
     200{{{
     201/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmCoordinatorSyncSupport
     202}}}
     203* 型：BooleanParam
     204* 多重度：1
     205
     206== LinNmDevErrorDetect ==
     207{{{
     208/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmDevErrorDetect
     209}}}
     210* 型：BooleanParam
     211* 多重度：1
     212
     213== LinNmMainFunctionPeriod ==
     214{{{
     215/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmMainFunctionPeriod
     216}}}
     217* 型：FloatParam
     218* 多重度：1
     219* 上限値：0.255
     220* 下限値：0
     221
     222== LinNmNodeDetectionEnabled ==
     223{{{
     224/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmNodeDetectionEnabled
     225}}}
     226* 型：BooleanParam
     227* 多重度：1
     228
     229== LinNmNodeIdEnabled ==
     230{{{
     231/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmNodeIdEnabled
     232}}}
     233* 型：BooleanParam
     234* 多重度：1
     235
     236== LinNmPassiveModeEnabled ==
     237{{{
     238/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmPassiveModeEnabled
     239}}}
     240* 型：BooleanParam
     241* 多重度：1
     242
     243== LinNmRemoteSleepIndicationEnabled ==
     244{{{
     245/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmRemoteSleepIndicationEnabled
     246}}}
     247* 型：BooleanParam
     248* 多重度：1
     249
     250== LinNmStateChangeIndEnabled ==
     251{{{
     252/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmStateChangeIndEnabled
     253}}}
     254* 型：BooleanParam
     255* 多重度：1
     256
     257== LinNmSynchronizationPointEnabled ==
     258{{{
     259/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmSynchronizationPointEnabled
     260}}}
     261* 型：BooleanParam
     262* 多重度：1
     263* デフォルト値：false
     264
     265== LinNmUserDataEnabled ==
     266{{{
     267/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmUserDataEnabled
     268}}}
     269* 型：BooleanParam
     270* 多重度：1
     271
     272== LinNmVersionInfoApi ==
     273{{{
     274/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmVersionInfoApi
     275}}}
     276* 型：BooleanParam
     277* 多重度：1
     278
     279== LinNmChannelConfig ==
     280{{{
     281/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmChannelConfig
     282}}}
     283* 型：Container
     284* 多重度：1..*
     285
     286== LinNmTimeoutTime ==
     287{{{
     288/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmChannelConfig/LinNmTimeoutTime
     289}}}
     290* 型：FloatParam
     291* 多重度：1
     292* 上限値：65.535
     293* 下限値：0
     294
     295== LinNmComMNetworkHandleRef ==
     296{{{
     297/AUTOSAR/EcucDefs/LinNm/LinNmGlobalConfig/LinNmChannelConfig/LinNmComMNetworkHandleRef
     298}}}
     299* 型：Reference
     300* 多重度：1
     301* 参照先：{{{/AUTOSAR/EcucDefs/ComM/ComMConfigSet/ComMChannel}}}