Changes between Version 5 and Version 6 of spec/Icu


Ignore:
Timestamp:
Jan 9, 2015, 5:04:27 PM (9 years ago)
Author:
fujisft-shigihara
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • spec/Icu

    v5 v6  
    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
     11* API一覧
     12
     13  ||= API =||= ID[[BR]][Dec] =||= ID[[BR]][Hex] =||
     14  || [#Icu_Init Icu_Init]                                     ||  0|| 0x00||
     15  || [#Icu_DeInit Icu_DeInit]                                 ||  1|| 0x01||
     16  || [#Icu_SetMode Icu_SetMode]                               ||  2|| 0x02||
     17  || [#Icu_DisableWakeup Icu_DisableWakeup]                   ||  3|| 0x03||
     18  || [#Icu_EnableWakeup Icu_EnableWakeup]                     ||  4|| 0x04||
     19  || [#Icu_CheckWakeup Icu_CheckWakeup]                       || 21|| 0x15||
     20  || [#Icu_SetActivationCondition Icu_SetActivationCondition] ||  5|| 0x05||
     21  || [#Icu_DisableNotification Icu_DisableNotification]       ||  6|| 0x06||
     22  || [#Icu_EnableNotification Icu_EnableNotification]         ||  7|| 0x07||
     23  || [#Icu_GetInputState Icu_GetInputState]                   ||  8|| 0x08||
     24  || [#Icu_StartTimestamp Icu_StartTimestamp]                 ||  9|| 0x09||
     25  || [#Icu_StopTimestamp Icu_StopTimestamp]                   || 10|| 0x0A||
     26  || [#Icu_GetTimestampIndex Icu_GetTimestampIndex]           || 11|| 0x0B||
     27  || [#Icu_ResetEdgeCount Icu_ResetEdgeCount]                 || 12|| 0x0C||
     28  || [#Icu_EnableEdgeCount Icu_EnableEdgeCount]               || 13|| 0x0D||
     29  || [#Icu_EnableEdgeDetection Icu_EnableEdgeDetection]       || 22|| 0x16||
     30  || [#Icu_DisableEdgeDetection Icu_DisableEdgeDetection]     || 23|| 0x17||
     31  || [#Icu_DisableEdgeCount Icu_DisableEdgeCount]             || 14|| 0x0E||
     32  || [#Icu_GetEdgeNumbers Icu_GetEdgeNumbers]                 || 15|| 0x0F||
     33  || [#Icu_StartSignalMeasurement Icu_StartSignalMeasurement] || 19|| 0x13||
     34  || [#Icu_StopSignalMeasurement Icu_StopSignalMeasurement]   || 20|| 0x14||
     35  || [#Icu_GetTimeElapsed Icu_GetTimeElapsed]                 || 16|| 0x10||
     36  || [#Icu_GetDutyCycleValues Icu_GetDutyCycleValues]         || 17|| 0x11||
     37  || [#Icu_GetVersionInfo Icu_GetVersionInfo]                 || 18|| 0x12||
     38
     39* コンフィギュレーション一覧
     40  * [#IcuConfigSet IcuConfigSet]
     41    * [#IcuMaxChannel IcuMaxChannel]
     42    * [#IcuChannel IcuChannel]
     43      * [#IcuChannelId IcuChannelId]
     44      * [#IcuDefaultStartEdge IcuDefaultStartEdge]
     45      * [#IcuMeasurementMode IcuMeasurementMode]
     46      * [#IcuWakeupCapability IcuWakeupCapability]
     47      * [#IcuSignalEdgeDetection IcuSignalEdgeDetection]
     48        * [#IcuSignalNotification IcuSignalNotification]
     49      * [#IcuSignalMeasurement IcuSignalMeasurement]
     50        * [#IcuSignalMeasurementProperty IcuSignalMeasurementProperty]
     51      * [#IcuTimestampMeasurement IcuTimestampMeasurement]
     52        * [#IcuTimestampMeasurementProperty IcuTimestampMeasurementProperty]
     53        * [#IcuTimestampNotification IcuTimestampNotification]
     54      * [#IcuWakeup IcuWakeup]
     55        * [#IcuChannelWakeupInfo IcuChannelWakeupInfo]
     56  * [#IcuGeneral IcuGeneral]
     57    * [#IcuDevErrorDetect IcuDevErrorDetect]
     58    * [#IcuIndex IcuIndex]
     59    * [#IcuReportWakeupSource IcuReportWakeupSource]
     60  * [#IcuOptionalApis IcuOptionalApis]
     61    * [#IcuDeInitApi IcuDeInitApi]
     62    * [#IcuDisableWakeupApi IcuDisableWakeupApi]
     63    * [#IcuEdgeCountApi IcuEdgeCountApi]
     64    * [#IcuEdgeDetectApi IcuEdgeDetectApi]
     65    * [#IcuEnableWakeupApi IcuEnableWakeupApi]
     66    * [#IcuGetDutyCycleValuesApi IcuGetDutyCycleValuesApi]
     67    * [#IcuGetInputStateApi IcuGetInputStateApi]
     68    * [#IcuGetTimeElapsedApi IcuGetTimeElapsedApi]
     69    * [#IcuGetVersionInfoApi IcuGetVersionInfoApi]
     70    * [#IcuSetModeApi IcuSetModeApi]
     71    * [#IcuSignalMeasurementApi IcuSignalMeasurementApi]
     72    * [#IcuTimestampApi IcuTimestampApi]
     73    * [#IcuWakeupFunctionalityApi IcuWakeupFunctionalityApi]
     74
     75* エラーコード一覧
     76
     77  ||= エラーコード =||= Dec =||= Hex =||
     78  || ICU_E_PARAM_CONFIG          || 10|| 0x0A||
     79  || ICU_E_PARAM_CHANNEL         || 11|| 0x0B||
     80  || ICU_E_PARAM_ACTIVATION      || 12|| 0x0C||
     81  || ICU_E_PARAM_BUFFER_PTR      || 13|| 0x0D||
     82  || ICU_E_PARAM_BUFFER_SIZE     || 14|| 0x0E||
     83  || ICU_E_PARAM_MODE            || 15|| 0x0F||
     84  || ICU_E_UNINIT                || 20|| 0x14||
     85  || ICU_E_NOT_STARTED           || 21|| 0x15||
     86  || ICU_E_BUSY_OPERATION        || 22|| 0x16||
     87  || ICU_E_ALREADY_INITIALIZED   || 23|| 0x17||
     88  || ICU_E_PARAM_NOTIFY_INTERVAL || 24|| 0x18||
     89  || ICU_E_PARAM_VINFO           || 25|| 0x19||
     90
    1691----
    17 {{{#!comment
    18 [執筆開始時削除エリア]ここまで
    19 ※コメントごと削除してください
    20 }}}
    21 
    22 = 概要 =
     92
     93= API仕様 =
     94
     95== Icu_Init ==
     96{{{
     97void Icu_Init(const Icu_ConfigType* ConfigPtr)
     98}}}
     99
     100== Icu_DeInit ==
     101{{{
     102void Icu_DeInit(void)
     103}}}
     104
     105== Icu_SetMode ==
     106{{{
     107void Icu_SetMode(Icu_ModeType Mode)
     108}}}
     109
     110== Icu_DisableWakeup ==
     111{{{
     112void Icu_DisableWakeup(Icu_ChannelType Channel)
     113}}}
     114
     115== Icu_EnableWakeup ==
     116{{{
     117void Icu_EnableWakeup(Icu_ChannelType Channel)
     118}}}
     119
     120== Icu_CheckWakeup ==
     121{{{
     122void Icu_CheckWakeup(EcuM_WakeupSourceType WakeupSource)
     123}}}
     124
     125== Icu_SetActivationCondition ==
     126{{{
     127void Icu_SetActivationCondition(Icu_ChannelType Channel, Icu_ActivationType Activation)
     128}}}
     129
     130== Icu_DisableNotification ==
     131{{{
     132void Icu_DisableNotification(Icu_ChannelType Channel)
     133}}}
     134
     135== Icu_EnableNotification ==
     136{{{
     137void Icu_EnableNotification(Icu_ChannelType Channel)
     138}}}
     139
     140== Icu_GetInputState ==
     141{{{
     142Icu_InputStateType Icu_GetInputState(Icu_ChannelType Channel)
     143}}}
     144
     145== Icu_StartTimestamp ==
     146{{{
     147void Icu_StartTimestamp(Icu_ChannelType Channel, Icu_ValueType* BufferPtr, uint16 BufferSize, uint16 NotifyInterval)
     148}}}
     149
     150== Icu_StopTimestamp ==
     151{{{
     152void Icu_StopTimestamp(Icu_ChannelType Channel)
     153}}}
     154
     155== Icu_GetTimestampIndex ==
     156{{{
     157Icu_IndexType Icu_GetTimestampIndex(Icu_ChannelType Channel)
     158}}}
     159
     160== Icu_ResetEdgeCount ==
     161{{{
     162void Icu_ResetEdgeCount(Icu_ChannelType Channel)
     163}}}
     164
     165== Icu_EnableEdgeCount ==
     166{{{
     167void Icu_EnableEdgeCount(Icu_ChannelType Channel)
     168}}}
     169
     170== Icu_EnableEdgeDetection ==
     171{{{
     172void Icu_EnableEdgeDetection(Icu_ChannelType Channel)
     173}}}
     174
     175== Icu_DisableEdgeDetection ==
     176{{{
     177void Icu_DisableEdgeDetection(Icu_ChannelType Channel)
     178}}}
     179
     180== Icu_DisableEdgeCount ==
     181{{{
     182void Icu_DisableEdgeCount(Icu_ChannelType Channel)
     183}}}
     184
     185== Icu_GetEdgeNumbers ==
     186{{{
     187Icu_EdgeNumberType Icu_GetEdgeNumbers(Icu_ChannelType Channel)
     188}}}
     189
     190== Icu_StartSignalMeasurement ==
     191{{{
     192void Icu_StartSignalMeasurement(Icu_ChannelType Channel)
     193}}}
     194
     195== Icu_StopSignalMeasurement ==
     196{{{
     197void Icu_StopSignalMeasurement(Icu_ChannelType Channel)
     198}}}
     199
     200== Icu_GetTimeElapsed ==
     201{{{
     202Icu_ValueType Icu_GetTimeElapsed(Icu_ChannelType Channel)
     203}}}
     204
     205== Icu_GetDutyCycleValues ==
     206{{{
     207void Icu_GetDutyCycleValues(Icu_ChannelType Channel, Icu_DutyCycleType* DutyCycleValues)
     208}}}
     209
     210== Icu_GetVersionInfo ==
     211{{{
     212void Icu_GetVersionInfo(Std_VersionInfoType* versioninfo)
     213}}}
    23214
    24215----
    25216
    26 = API仕様 =
    27 
    28 ----
    29 
    30217= コンフィギュレーション仕様 =
     218
     219== IcuConfigSet ==
     220{{{
     221/AUTOSAR/EcucDefs/Icu/IcuConfigSet
     222}}}
     223* 型：Container
     224* 多重度：1
     225
     226== IcuMaxChannel ==
     227{{{
     228/AUTOSAR/EcucDefs/Icu/IcuConfigSet/IcuMaxChannel
     229}}}
     230* 型：IntegerParam
     231* 多重度：1
     232
     233== IcuChannel ==
     234{{{
     235/AUTOSAR/EcucDefs/Icu/IcuConfigSet/IcuChannel
     236}}}
     237* 型：Container
     238* 多重度：1..*
     239
     240== IcuChannelId ==
     241{{{
     242/AUTOSAR/EcucDefs/Icu/IcuConfigSet/IcuChannel/IcuChannelId
     243}}}
     244* 型：IntegerParam
     245* 多重度：1
     246
     247== IcuDefaultStartEdge ==
     248{{{
     249/AUTOSAR/EcucDefs/Icu/IcuConfigSet/IcuChannel/IcuDefaultStartEdge
     250}}}
     251* 型：EnumerationParam
     252* 多重度：1
     253
     254== IcuMeasurementMode ==
     255{{{
     256/AUTOSAR/EcucDefs/Icu/IcuConfigSet/IcuChannel/IcuMeasurementMode
     257}}}
     258* 型：EnumerationParam
     259* 多重度：1
     260
     261== IcuWakeupCapability ==
     262{{{
     263/AUTOSAR/EcucDefs/Icu/IcuConfigSet/IcuChannel/IcuWakeupCapability
     264}}}
     265* 型：BooleanParam
     266* 多重度：1
     267
     268== IcuSignalEdgeDetection ==
     269{{{
     270/AUTOSAR/EcucDefs/Icu/IcuConfigSet/IcuChannel/IcuSignalEdgeDetection
     271}}}
     272* 型：Container
     273* 多重度：0..1
     274
     275== IcuSignalNotification ==
     276{{{
     277/AUTOSAR/EcucDefs/Icu/IcuConfigSet/IcuChannel/IcuSignalEdgeDetection/IcuSignalNotification
     278}}}
     279* 型：FunctionName
     280* 多重度：0..1
     281
     282== IcuSignalMeasurement ==
     283{{{
     284/AUTOSAR/EcucDefs/Icu/IcuConfigSet/IcuChannel/IcuSignalMeasurement
     285}}}
     286* 型：Container
     287* 多重度：0..1
     288
     289== IcuSignalMeasurementProperty ==
     290{{{
     291/AUTOSAR/EcucDefs/Icu/IcuConfigSet/IcuChannel/IcuSignalMeasurement/IcuSignalMeasurementProperty
     292}}}
     293* 型：EnumerationParam
     294* 多重度：1
     295
     296== IcuTimestampMeasurement ==
     297{{{
     298/AUTOSAR/EcucDefs/Icu/IcuConfigSet/IcuChannel/IcuTimestampMeasurement
     299}}}
     300* 型：Container
     301* 多重度：0..1
     302
     303== IcuTimestampMeasurementProperty ==
     304{{{
     305/AUTOSAR/EcucDefs/Icu/IcuConfigSet/IcuChannel/IcuTimestampMeasurement/IcuTimestampMeasurementProperty
     306}}}
     307* 型：EnumerationParam
     308* 多重度：1
     309
     310== IcuTimestampNotification ==
     311{{{
     312/AUTOSAR/EcucDefs/Icu/IcuConfigSet/IcuChannel/IcuTimestampMeasurement/IcuTimestampNotification
     313}}}
     314* 型：FunctionName
     315* 多重度：0..1
     316
     317== IcuWakeup ==
     318{{{
     319/AUTOSAR/EcucDefs/Icu/IcuConfigSet/IcuChannel/IcuWakeup
     320}}}
     321* 型：Container
     322* 多重度：0..1
     323
     324== IcuChannelWakeupInfo ==
     325{{{
     326/AUTOSAR/EcucDefs/Icu/IcuConfigSet/IcuChannel/IcuWakeup/IcuChannelWakeupInfo
     327}}}
     328* 型：Reference
     329* 多重度：0..1
     330
     331== IcuGeneral ==
     332{{{
     333/AUTOSAR/EcucDefs/Icu/IcuGeneral
     334}}}
     335* 型：Container
     336* 多重度：1
     337
     338== IcuDevErrorDetect ==
     339{{{
     340/AUTOSAR/EcucDefs/Icu/IcuGeneral/IcuDevErrorDetect
     341}}}
     342* 型：BooleanParam
     343* 多重度：1
     344
     345== IcuIndex ==
     346{{{
     347/AUTOSAR/EcucDefs/Icu/IcuGeneral/IcuIndex
     348}}}
     349* 型：IntegerParam
     350* 多重度：1
     351
     352== IcuReportWakeupSource ==
     353{{{
     354/AUTOSAR/EcucDefs/Icu/IcuGeneral/IcuReportWakeupSource
     355}}}
     356* 型：BooleanParam
     357* 多重度：1
     358
     359== IcuOptionalApis ==
     360{{{
     361/AUTOSAR/EcucDefs/Icu/IcuOptionalApis
     362}}}
     363* 型：Container
     364* 多重度：1
     365
     366== IcuDeInitApi ==
     367{{{
     368/AUTOSAR/EcucDefs/Icu/IcuOptionalApis/IcuDeInitApi
     369}}}
     370* 型：BooleanParam
     371* 多重度：1
     372
     373== IcuDisableWakeupApi ==
     374{{{
     375/AUTOSAR/EcucDefs/Icu/IcuOptionalApis/IcuDisableWakeupApi
     376}}}
     377* 型：BooleanParam
     378* 多重度：1
     379
     380== IcuEdgeCountApi ==
     381{{{
     382/AUTOSAR/EcucDefs/Icu/IcuOptionalApis/IcuEdgeCountApi
     383}}}
     384* 型：BooleanParam
     385* 多重度：1
     386
     387== IcuEdgeDetectApi ==
     388{{{
     389/AUTOSAR/EcucDefs/Icu/IcuOptionalApis/IcuEdgeDetectApi
     390}}}
     391* 型：BooleanParam
     392* 多重度：1
     393
     394== IcuEnableWakeupApi ==
     395{{{
     396/AUTOSAR/EcucDefs/Icu/IcuOptionalApis/IcuEnableWakeupApi
     397}}}
     398* 型：BooleanParam
     399* 多重度：1
     400
     401== IcuGetDutyCycleValuesApi ==
     402{{{
     403/AUTOSAR/EcucDefs/Icu/IcuOptionalApis/IcuGetDutyCycleValuesApi
     404}}}
     405* 型：BooleanParam
     406* 多重度：1
     407
     408== IcuGetInputStateApi ==
     409{{{
     410/AUTOSAR/EcucDefs/Icu/IcuOptionalApis/IcuGetInputStateApi
     411}}}
     412* 型：BooleanParam
     413* 多重度：1
     414
     415== IcuGetTimeElapsedApi ==
     416{{{
     417/AUTOSAR/EcucDefs/Icu/IcuOptionalApis/IcuGetTimeElapsedApi
     418}}}
     419* 型：BooleanParam
     420* 多重度：1
     421
     422== IcuGetVersionInfoApi ==
     423{{{
     424/AUTOSAR/EcucDefs/Icu/IcuOptionalApis/IcuGetVersionInfoApi
     425}}}
     426* 型：BooleanParam
     427* 多重度：1
     428
     429== IcuSetModeApi ==
     430{{{
     431/AUTOSAR/EcucDefs/Icu/IcuOptionalApis/IcuSetModeApi
     432}}}
     433* 型：BooleanParam
     434* 多重度：1
     435
     436== IcuSignalMeasurementApi ==
     437{{{
     438/AUTOSAR/EcucDefs/Icu/IcuOptionalApis/IcuSignalMeasurementApi
     439}}}
     440* 型：BooleanParam
     441* 多重度：1
     442
     443== IcuTimestampApi ==
     444{{{
     445/AUTOSAR/EcucDefs/Icu/IcuOptionalApis/IcuTimestampApi
     446}}}
     447* 型：BooleanParam
     448* 多重度：1
     449
     450== IcuWakeupFunctionalityApi ==
     451{{{
     452/AUTOSAR/EcucDefs/Icu/IcuOptionalApis/IcuWakeupFunctionalityApi
     453}}}
     454* 型：BooleanParam
     455* 多重度：1