Changes between Version 4 and Version 5 of spec/Nm


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

--

Legend:

Unmodified
Added
Removed
Modified

  • spec/Nm

    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  || [#Nm_Init Nm_Init]                                                   ||  0|| 0x00||
     14  || [#Nm_PassiveStartUp Nm_PassiveStartUp]                               ||  1|| 0x01||
     15  || [#Nm_NetworkRequest Nm_NetworkRequest]                               ||  2|| 0x02||
     16  || [#Nm_NetworkRelease Nm_NetworkRelease]                               ||  3|| 0x03||
     17  || [#Nm_DisableCommunication Nm_DisableCommunication]                   ||  4|| 0x04||
     18  || [#Nm_EnableCommunication Nm_EnableCommunication]                     ||  5|| 0x05||
     19  || [#Nm_SetUserData Nm_SetUserData]                                     ||  6|| 0x06||
     20  || [#Nm_GetUserData Nm_GetUserData]                                     ||  7|| 0x07||
     21  || [#Nm_GetPduData Nm_GetPduData]                                       ||  8|| 0x08||
     22  || [#Nm_RepeatMessageRequest Nm_RepeatMessageRequest]                   ||  9|| 0x09||
     23  || [#Nm_GetNodeIdentifier Nm_GetNodeIdentifier]                         || 10|| 0x0A||
     24  || [#Nm_GetLocalNodeIdentifier Nm_GetLocalNodeIdentifier]               || 11|| 0x0B||
     25  || [#Nm_CheckRemoteSleepIndication Nm_CheckRemoteSleepIndication]       || 13|| 0x0D||
     26  || [#Nm_GetState Nm_GetState]                                           || 14|| 0x0E||
     27  || [#Nm_GetVersionInfo Nm_GetVersionInfo]                               || 15|| 0x0F||
     28  || [#Nm_NetworkStartIndication Nm_NetworkStartIndication]               || 17|| 0x11||
     29  || [#Nm_NetworkMode Nm_NetworkMode]                                     || 18|| 0x12||
     30  || [#Nm_BusSleepMode Nm_BusSleepMode]                                   || 20|| 0x14||
     31  || [#Nm_PrepareBusSleepMode Nm_PrepareBusSleepMode]                     || 19|| 0x13||
     32  || [#Nm_RemoteSleepIndication Nm_RemoteSleepIndication]                 || 23|| 0x17||
     33  || [#Nm_RemoteSleepCancellation Nm_RemoteSleepCancellation]             || 24|| 0x18||
     34  || [#Nm_SynchronizationPoint Nm_SynchronizationPoint]                   || 25|| 0x19||
     35  || [#Nm_PduRxIndication Nm_PduRxIndication]                             || 21|| 0x15||
     36  || [#Nm_StateChangeNotification Nm_StateChangeNotification]             || 22|| 0x16||
     37  || [#Nm_RepeatMessageIndication Nm_RepeatMessageIndication]             || 26|| 0x1A||
     38  || [#Nm_TxTimeoutException Nm_TxTimeoutException]                       || 27|| 0x1B||
     39  || [#Nm_CarWakeUpIndication Nm_CarWakeUpIndication]                     || 29|| 0x1D||
     40  || [#Nm_CoordReadyToSleepIndication Nm_CoordReadyToSleepIndication]     || 30|| 0x1E||
     41  || [#Nm_MainFunction Nm_MainFunction]                                   || 16|| 0x10||
     42
     43* コンフィギュレーション一覧
     44  * [#NmChannelConfig NmChannelConfig]
     45    * [#NmActiveCoordinator NmActiveCoordinator]
     46    * [#NmChannelId NmChannelId]
     47    * [#NmChannelSleepMaster NmChannelSleepMaster]
     48    * [#NmCoordClusterIndex NmCoordClusterIndex]
     49    * [#NmPassiveModeEnabled NmPassiveModeEnabled]
     50    * [#NmShutdownDelayTimer NmShutdownDelayTimer]
     51    * [#NmStateReportEnabled NmStateReportEnabled]
     52    * [#NmSynchronizingNetwork NmSynchronizingNetwork]
     53    * [#NmComMChannelRef NmComMChannelRef]
     54    * [#NmStateReportSignalRef NmStateReportSignalRef]
     55    * [#NmBusType NmBusType]
     56      * [#NmGenericBusNmConfig NmGenericBusNmConfig]
     57        * [#NmGenericBusNmPrefix NmGenericBusNmPrefix]
     58      * [#NmStandardBusNmConfig NmStandardBusNmConfig]
     59        * [#NmStandardBusType NmStandardBusType]
     60  * [#NmGlobalConfig NmGlobalConfig]
     61    * [#NmGlobalConstants NmGlobalConstants]
     62      * [#NmNumberOfChannels NmNumberOfChannels]
     63    * [#NmGlobalFeatures NmGlobalFeatures]
     64      * [#NmBusSynchronizationEnabled NmBusSynchronizationEnabled]
     65      * [#NmCarWakeUpCallback NmCarWakeUpCallback]
     66      * [#NmCarWakeUpRxEnabled NmCarWakeUpRxEnabled]
     67      * [#NmComControlEnabled NmComControlEnabled]
     68      * [#NmComUserDataSupport NmComUserDataSupport]
     69      * [#NmCoordinatorSupportEnabled NmCoordinatorSupportEnabled]
     70      * [#NmGlobalCoordinatorTime NmGlobalCoordinatorTime]
     71      * [#NmNodeDetectionEnabled NmNodeDetectionEnabled]
     72      * [#NmNodeIdEnabled NmNodeIdEnabled]
     73      * [#NmPduRxIndicationEnabled NmPduRxIndicationEnabled]
     74      * [#NmRemoteSleepIndEnabled NmRemoteSleepIndEnabled]
     75      * [#NmRepeatMsgIndEnabled NmRepeatMsgIndEnabled]
     76      * [#NmStateChangeIndEnabled NmStateChangeIndEnabled]
     77      * [#NmUserDataEnabled NmUserDataEnabled]
     78    * [#NmGlobalProperties NmGlobalProperties]
     79      * [#NmCycletimeMainFunction NmCycletimeMainFunction]
     80      * [#NmDevErrorDetect NmDevErrorDetect]
     81      * [#NmVersionInfoApi NmVersionInfoApi]
     82
     83* エラーコード一覧
     84
     85  ||= エラーコード =||= Dec =||= Hex =||
     86  || NM_E_UNINIT        ||  0|| 0x00||
     87  || NM_E_HANDLE_UNDEF  ||  1|| 0x01||
     88  || NM_E_PARAM_POINTER ||  2|| 0x02||
     89
    1690----
    17 {{{#!comment
    18 [執筆開始時削除エリア]ここまで
    19 ※コメントごと削除してください
    20 }}}
    21 
    22 = 概要 =
     91
     92= API仕様 =
     93
     94== Nm_Init ==
     95{{{
     96void Nm_Init(void)
     97}}}
     98
     99== Nm_PassiveStartUp ==
     100{{{
     101Std_ReturnType Nm_PassiveStartUp(const NetworkHandleType NetworkHandle)
     102}}}
     103
     104== Nm_NetworkRequest ==
     105{{{
     106Std_ReturnType Nm_NetworkRequest(const NetworkHandleType NetworkHandle)
     107}}}
     108
     109== Nm_NetworkRelease ==
     110{{{
     111Std_ReturnType Nm_NetworkRelease(const NetworkHandleType NetworkHandle)
     112}}}
     113
     114== Nm_DisableCommunication ==
     115{{{
     116Std_ReturnType Nm_DisableCommunication(const NetworkHandleType NetworkHandle)
     117}}}
     118
     119== Nm_EnableCommunication ==
     120{{{
     121Std_ReturnType Nm_EnableCommunication(const NetworkHandleType NetworkHandle)
     122}}}
     123
     124== Nm_SetUserData ==
     125{{{
     126Std_ReturnType Nm_SetUserData(const NetworkHandleType NetworkHandle, const uint8 * const nmUserDataPtr)
     127}}}
     128
     129== Nm_GetUserData ==
     130{{{
     131Std_ReturnType Nm_GetUserData(const NetworkHandleType NetworkHandle, uint8 * const nmUserDataPtr)
     132}}}
     133
     134== Nm_GetPduData ==
     135{{{
     136Std_ReturnType Nm_GetPduData(const NetworkHandleType NetworkHandle, uint8 * const nmPduData)
     137}}}
     138
     139== Nm_RepeatMessageRequest ==
     140{{{
     141Std_ReturnType Nm_RepeatMessageRequest(const NetworkHandleType NetworkHandle)
     142}}}
     143
     144== Nm_GetNodeIdentifier ==
     145{{{
     146Std_ReturnType Nm_GetNodeIdentifier(const NetworkHandleType NetworkHandle, uint8 * const nmNodeIdPtr)
     147}}}
     148
     149== Nm_GetLocalNodeIdentifier ==
     150{{{
     151Std_ReturnType Nm_GetLocalNodeIdentifier(const NetworkHandleType NetworkHandle, uint8 * const nmNodeIdPtr)
     152}}}
     153
     154== Nm_CheckRemoteSleepIndication ==
     155{{{
     156Std_ReturnType Nm_CheckRemoteSleepIndication(const NetworkHandleType nmNetworkHandle, boolean * const nmRemoteSleepIndPtr)
     157}}}
     158
     159== Nm_GetState ==
     160{{{
     161Std_ReturnType Nm_GetState(const NetworkHandleType nmNetworkHandle, Nm_StateType* const nmStatePtr, Nm_ModeType* const nmModePtr)
     162}}}
     163
     164== Nm_GetVersionInfo ==
     165{{{
     166void Nm_GetVersionInfo(Std_VersionInfoType* nmVerInfoPtr)
     167}}}
     168
     169== Nm_NetworkStartIndication ==
     170{{{
     171void Nm_NetworkStartIndication(const NetworkHandleType nmNetworkHandle)
     172}}}
     173
     174== Nm_NetworkMode ==
     175{{{
     176void Nm_NetworkMode(const NetworkHandleType nmNetworkHandle)
     177}}}
     178
     179== Nm_BusSleepMode ==
     180{{{
     181void Nm_BusSleepMode(const NetworkHandleType nmNetworkHandle)
     182}}}
     183
     184== Nm_PrepareBusSleepMode ==
     185{{{
     186void Nm_PrepareBusSleepMode(const NetworkHandleType nmNetworkHandle)
     187}}}
     188
     189== Nm_RemoteSleepIndication ==
     190{{{
     191void Nm_RemoteSleepIndication(const NetworkHandleType nmNetworkHandle)
     192}}}
     193
     194== Nm_RemoteSleepCancellation ==
     195{{{
     196void Nm_RemoteSleepCancellation(const NetworkHandleType nmNetworkHandle)
     197}}}
     198
     199== Nm_SynchronizationPoint ==
     200{{{
     201void Nm_SynchronizationPoint(const NetworkHandleType nmNetworkHandle)
     202}}}
     203
     204== Nm_PduRxIndication ==
     205{{{
     206void Nm_PduRxIndication(const NetworkHandleType nmNetworkHandle)
     207}}}
     208
     209== Nm_StateChangeNotification ==
     210{{{
     211void Nm_StateChangeNotification(const NetworkHandleType nmNetworkHandle, const Nm_StateType nmPreviousState, const Nm_StateType nmCurrentState)
     212}}}
     213
     214== Nm_RepeatMessageIndication ==
     215{{{
     216void Nm_RepeatMessageIndication(const NetworkHandleType nmNetworkHandle)
     217}}}
     218
     219== Nm_TxTimeoutException ==
     220{{{
     221void Nm_TxTimeoutException(const NetworkHandleType nmNetworkHandle)
     222}}}
     223
     224== Nm_CarWakeUpIndication ==
     225{{{
     226void Nm_CarWakeUpIndication(const NetworkHandleType nmChannelHandle)
     227}}}
     228
     229== Nm_CoordReadyToSleepIndication ==
     230{{{
     231void Nm_CoordReadyToSleepIndication(const NetworkHandleType nmChannelHandle)
     232}}}
     233
     234== Nm_MainFunction ==
     235{{{
     236void Nm_MainFunction(void)
     237}}}
    23238
    24239----
    25240
    26 = API仕様 =
    27 
    28 ----
    29 
    30241= コンフィギュレーション仕様 =
     242
     243== !NmChannelConfig ==
     244{{{
     245/AUTOSAR/EcucDefs/Nm/NmChannelConfig
     246}}}
     247* 型：Container
     248* 多重度：1..*
     249
     250== !NmActiveCoordinator ==
     251{{{
     252/AUTOSAR/EcucDefs/Nm/NmChannelConfig/NmActiveCoordinator
     253}}}
     254* 型：!BooleanParam
     255* 多重度：0..1
     256
     257== !NmChannelId ==
     258{{{
     259/AUTOSAR/EcucDefs/Nm/NmChannelConfig/NmChannelId
     260}}}
     261* 型：!IntegerParam
     262* 多重度：1
     263
     264== !NmChannelSleepMaster ==
     265{{{
     266/AUTOSAR/EcucDefs/Nm/NmChannelConfig/NmChannelSleepMaster
     267}}}
     268* 型：!BooleanParam
     269* 多重度：1
     270
     271== !NmCoordClusterIndex ==
     272{{{
     273/AUTOSAR/EcucDefs/Nm/NmChannelConfig/NmCoordClusterIndex
     274}}}
     275* 型：!IntegerParam
     276* 多重度：0..1
     277
     278== !NmPassiveModeEnabled ==
     279{{{
     280/AUTOSAR/EcucDefs/Nm/NmChannelConfig/NmPassiveModeEnabled
     281}}}
     282* 型：!BooleanParam
     283* 多重度：1
     284
     285== !NmShutdownDelayTimer ==
     286{{{
     287/AUTOSAR/EcucDefs/Nm/NmChannelConfig/NmShutdownDelayTimer
     288}}}
     289* 型：!FloatParam
     290* 多重度：1
     291
     292== !NmStateReportEnabled ==
     293{{{
     294/AUTOSAR/EcucDefs/Nm/NmChannelConfig/NmStateReportEnabled
     295}}}
     296* 型：!BooleanParam
     297* 多重度：1
     298
     299== !NmSynchronizingNetwork ==
     300{{{
     301/AUTOSAR/EcucDefs/Nm/NmChannelConfig/NmSynchronizingNetwork
     302}}}
     303* 型：!BooleanParam
     304* 多重度：1
     305
     306== NmComMChannelRef ==
     307{{{
     308/AUTOSAR/EcucDefs/Nm/NmChannelConfig/NmComMChannelRef
     309}}}
     310* 型：Reference
     311* 多重度：1
     312
     313== !NmStateReportSignalRef ==
     314{{{
     315/AUTOSAR/EcucDefs/Nm/NmChannelConfig/NmStateReportSignalRef
     316}}}
     317* 型：Reference
     318* 多重度：0..1
     319
     320== !NmBusType ==
     321{{{
     322/AUTOSAR/EcucDefs/Nm/NmChannelConfig/NmBusType
     323}}}
     324* 型：Container
     325* 多重度：1
     326
     327== !NmGenericBusNmConfig ==
     328{{{
     329/AUTOSAR/EcucDefs/Nm/NmChannelConfig/NmBusType/NmGenericBusNmConfig
     330}}}
     331* 型：Container
     332* 多重度：1
     333
     334== !NmGenericBusNmPrefix ==
     335{{{
     336/AUTOSAR/EcucDefs/Nm/NmChannelConfig/NmBusType/NmGenericBusNmConfig/NmGenericBusNmPrefix
     337}}}
     338* 型：!StringParam
     339* 多重度：1
     340
     341== !NmStandardBusNmConfig ==
     342{{{
     343/AUTOSAR/EcucDefs/Nm/NmChannelConfig/NmBusType/NmStandardBusNmConfig
     344}}}
     345* 型：Container
     346* 多重度：1
     347
     348== !NmStandardBusType ==
     349{{{
     350/AUTOSAR/EcucDefs/Nm/NmChannelConfig/NmBusType/NmStandardBusNmConfig/NmStandardBusType
     351}}}
     352* 型：!EnumerationParam
     353* 多重度：1
     354
     355== !NmGlobalConfig ==
     356{{{
     357/AUTOSAR/EcucDefs/Nm/NmGlobalConfig
     358}}}
     359* 型：Container
     360* 多重度：1
     361
     362== !NmGlobalConstants ==
     363{{{
     364/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalConstants
     365}}}
     366* 型：Container
     367* 多重度：1
     368
     369== !NmNumberOfChannels ==
     370{{{
     371/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalConstants/NmNumberOfChannels
     372}}}
     373* 型：!IntegerParam
     374* 多重度：1
     375
     376== !NmGlobalFeatures ==
     377{{{
     378/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalFeatures
     379}}}
     380* 型：Container
     381* 多重度：1
     382
     383== !NmBusSynchronizationEnabled ==
     384{{{
     385/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalFeatures/NmBusSynchronizationEnabled
     386}}}
     387* 型：!BooleanParam
     388* 多重度：1
     389
     390== !NmCarWakeUpCallback ==
     391{{{
     392/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalFeatures/NmCarWakeUpCallback
     393}}}
     394* 型：!FunctionName
     395* 多重度：0..1
     396
     397== !NmCarWakeUpRxEnabled ==
     398{{{
     399/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalFeatures/NmCarWakeUpRxEnabled
     400}}}
     401* 型：!BooleanParam
     402* 多重度：1
     403
     404== !NmComControlEnabled ==
     405{{{
     406/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalFeatures/NmComControlEnabled
     407}}}
     408* 型：!BooleanParam
     409* 多重度：1
     410
     411== !NmComUserDataSupport ==
     412{{{
     413/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalFeatures/NmComUserDataSupport
     414}}}
     415* 型：!BooleanParam
     416* 多重度：1
     417
     418== !NmCoordinatorSupportEnabled ==
     419{{{
     420/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalFeatures/NmCoordinatorSupportEnabled
     421}}}
     422* 型：!BooleanParam
     423* 多重度：1
     424
     425== !NmGlobalCoordinatorTime ==
     426{{{
     427/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalFeatures/NmGlobalCoordinatorTime
     428}}}
     429* 型：!FloatParam
     430* 多重度：0..1
     431
     432== !NmNodeDetectionEnabled ==
     433{{{
     434/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalFeatures/NmNodeDetectionEnabled
     435}}}
     436* 型：!BooleanParam
     437* 多重度：1
     438
     439== !NmNodeIdEnabled ==
     440{{{
     441/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalFeatures/NmNodeIdEnabled
     442}}}
     443* 型：!BooleanParam
     444* 多重度：1
     445
     446== !NmPduRxIndicationEnabled ==
     447{{{
     448/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalFeatures/NmPduRxIndicationEnabled
     449}}}
     450* 型：!BooleanParam
     451* 多重度：1
     452
     453== !NmRemoteSleepIndEnabled ==
     454{{{
     455/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalFeatures/NmRemoteSleepIndEnabled
     456}}}
     457* 型：!BooleanParam
     458* 多重度：1
     459
     460== !NmRepeatMsgIndEnabled ==
     461{{{
     462/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalFeatures/NmRepeatMsgIndEnabled
     463}}}
     464* 型：!BooleanParam
     465* 多重度：1
     466
     467== !NmStateChangeIndEnabled ==
     468{{{
     469/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalFeatures/NmStateChangeIndEnabled
     470}}}
     471* 型：!BooleanParam
     472* 多重度：1
     473
     474== !NmUserDataEnabled ==
     475{{{
     476/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalFeatures/NmUserDataEnabled
     477}}}
     478* 型：!BooleanParam
     479* 多重度：1
     480
     481== !NmGlobalProperties ==
     482{{{
     483/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalProperties
     484}}}
     485* 型：Container
     486* 多重度：1
     487
     488== !NmCycletimeMainFunction ==
     489{{{
     490/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalProperties/NmCycletimeMainFunction
     491}}}
     492* 型：!FloatParam
     493* 多重度：1
     494
     495== !NmDevErrorDetect ==
     496{{{
     497/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalProperties/NmDevErrorDetect
     498}}}
     499* 型：!BooleanParam
     500* 多重度：1
     501
     502== !NmVersionInfoApi ==
     503{{{
     504/AUTOSAR/EcucDefs/Nm/NmGlobalConfig/NmGlobalProperties/NmVersionInfoApi
     505}}}
     506* 型：!BooleanParam
     507* 多重度：1
     508