Changes between Version 5 and Version 6 of spec/Adc


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

--

Legend:

Unmodified
Added
Removed
Modified

  • spec/Adc

    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  || [#Adc_Init Adc_Init]                                         ||  0|| 0x00||
     15  || [#Adc_SetupResultBuffer Adc_SetupResultBuffer]               || 12|| 0x0C||
     16  || [#Adc_DeInit Adc_DeInit]                                     ||  1|| 0x01||
     17  || [#Adc_StartGroupConversion Adc_StartGroupConversion]         ||  2|| 0x02||
     18  || [#Adc_StopGroupConversion Adc_StopGroupConversion]           ||  3|| 0x03||
     19  || [#Adc_ReadGroup Adc_ReadGroup]                               ||  4|| 0x04||
     20  || [#Adc_EnableHardwareTrigger Adc_EnableHardwareTrigger]       ||  5|| 0x05||
     21  || [#Adc_DisableHardwareTrigger Adc_DisableHardwareTrigger]     ||  6|| 0x06||
     22  || [#Adc_EnableGroupNotification Adc_EnableGroupNotification]   ||  7|| 0x07||
     23  || [#Adc_DisableGroupNotification Adc_DisableGroupNotification] ||  8|| 0x08||
     24  || [#Adc_GetGroupStatus Adc_GetGroupStatus]                     ||  9|| 0x09||
     25  || [#Adc_GetStreamLastPointer Adc_GetStreamLastPointer]         || 11|| 0x0B||
     26  || [#Adc_GetVersionInfo Adc_GetVersionInfo]                     || 10|| 0x0A||
     27
     28* コンフィギュレーション一覧
     29  * [#AdcConfigSet AdcConfigSet]
     30    * [#AdcHwUnit AdcHwUnit]
     31      * [#AdcClockSource AdcClockSource]
     32      * [#AdcHwUnitId AdcHwUnitId]
     33      * [#AdcPrescale AdcPrescale]
     34      * [#AdcChannel AdcChannel]
     35        * [#AdcChannelConvTime AdcChannelConvTime]
     36        * [#AdcChannelHighLimit AdcChannelHighLimit]
     37        * [#AdcChannelId AdcChannelId]
     38        * [#AdcChannelLimitCheck AdcChannelLimitCheck]
     39        * [#AdcChannelLowLimit AdcChannelLowLimit]
     40        * [#AdcChannelRangeSelect AdcChannelRangeSelect]
     41        * [#AdcChannelRefVoltsrcHigh AdcChannelRefVoltsrcHigh]
     42        * [#AdcChannelRefVoltsrcLow AdcChannelRefVoltsrcLow]
     43        * [#AdcChannelResolution AdcChannelResolution]
     44        * [#AdcChannelSampTime AdcChannelSampTime]
     45      * [#AdcGroup AdcGroup]
     46        * [#AdcGroupAccessMode AdcGroupAccessMode]
     47        * [#AdcGroupConversionMode AdcGroupConversionMode]
     48        * [#AdcGroupId AdcGroupId]
     49        * [#AdcGroupPriority AdcGroupPriority]
     50        * [#AdcGroupReplacement AdcGroupReplacement]
     51        * [#AdcGroupTriggSrc AdcGroupTriggSrc]
     52        * [#AdcHwTrigSignal AdcHwTrigSignal]
     53        * [#AdcHwTrigTimer AdcHwTrigTimer]
     54        * [#AdcNotification AdcNotification]
     55        * [#AdcStreamingBufferMode AdcStreamingBufferMode]
     56        * [#AdcStreamingNumSamples AdcStreamingNumSamples]
     57        * [#AdcGroupDefinition AdcGroupDefinition]
     58  * [#AdcGeneral AdcGeneral]
     59    * [#AdcDeInitApi AdcDeInitApi]
     60    * [#AdcDevErrorDetect AdcDevErrorDetect]
     61    * [#AdcEnableLimitCheck AdcEnableLimitCheck]
     62    * [#AdcEnableQueuing AdcEnableQueuing]
     63    * [#AdcEnableStartStopGroupApi AdcEnableStartStopGroupApi]
     64    * [#AdcGrpNotifCapability AdcGrpNotifCapability]
     65    * [#AdcHwTriggerApi AdcHwTriggerApi]
     66    * [#AdcPriorityImplementation AdcPriorityImplementation]
     67    * [#AdcReadGroupApi AdcReadGroupApi]
     68    * [#AdcResultAlignment AdcResultAlignment]
     69    * [#AdcVersionInfoApi AdcVersionInfoApi]
     70  * [#AdcPublishedInformation AdcPublishedInformation]
     71    * [#AdcChannelValueSigned AdcChannelValueSigned]
     72    * [#AdcGroupFirstChannelFixed AdcGroupFirstChannelFixed]
     73    * [#AdcMaxChannelResolution AdcMaxChannelResolution]
     74
     75* エラーコード一覧
     76
     77  ||= エラーコード =||= Dec =||= Hex =||
     78  || ADC_E_UNINIT              || 10|| 0x0A||
     79  || ADC_E_BUSY                || 11|| 0x0B||
     80  || ADC_E_IDLE                || 12|| 0x0C||
     81  || ADC_E_ALREADY_INITIALIZED || 13|| 0x0D||
     82  || ADC_E_PARAM_CONFIG        || 14|| 0x0E||
     83  || ADC_E_PARAM_POINTER       || 20|| 0x14||
     84  || ADC_E_PARAM_GROUP         || 21|| 0x15||
     85  || ADC_E_WRONG_CONV_MODE     || 22|| 0x16||
     86  || ADC_E_WRONG_TRIGG_SRC     || 23|| 0x17||
     87  || ADC_E_NOTIF_CAPABILITY    || 24|| 0x18||
     88  || ADC_E_BUFFER_UNINIT       || 25|| 0x19||
     89
    1690----
    17 {{{#!comment
    18 [執筆開始時削除エリア]ここまで
    19 ※コメントごと削除してください
    20 }}}
    21 
    22 = 概要 =
     91
     92= API仕様 =
     93
     94== Adc_Init ==
     95{{{
     96void Adc_Init(const Adc_ConfigType* ConfigPtr)
     97}}}
     98
     99== Adc_SetupResultBuffer ==
     100{{{
     101Std_ReturnType Adc_SetupResultBuffer(Adc_GroupType Group, Adc_ValueGroupType* DataBufferPtr
     102)
     103}}}
     104
     105== Adc_DeInit ==
     106{{{
     107void Adc_DeInit(void)
     108}}}
     109
     110== Adc_StartGroupConversion ==
     111{{{
     112void Adc_StartGroupConversion(Adc_GroupType Group)
     113}}}
     114
     115== Adc_StopGroupConversion ==
     116{{{
     117void Adc_StopGroupConversion(Adc_GroupType Group)
     118}}}
     119
     120== Adc_ReadGroup ==
     121{{{
     122Std_ReturnType Adc_ReadGroup(Adc_GroupType Group, Adc_ValueGroupType* DataBufferPtr)
     123}}}
     124
     125== Adc_EnableHardwareTrigger ==
     126{{{
     127void Adc_EnableHardwareTrigger(Adc_GroupType Group)
     128}}}
     129
     130== Adc_DisableHardwareTrigger ==
     131{{{
     132void Adc_DisableHardwareTrigger(Adc_GroupType Group)
     133}}}
     134
     135== Adc_EnableGroupNotification ==
     136{{{
     137void Adc_EnableGroupNotification(Adc_GroupType Group)
     138}}}
     139
     140== Adc_DisableGroupNotification ==
     141{{{
     142void Adc_DisableGroupNotification(Adc_GroupType Group)
     143}}}
     144
     145== Adc_GetGroupStatus ==
     146{{{
     147Adc_StatusType Adc_GetGroupStatus(Adc_GroupType Group)
     148}}}
     149
     150== Adc_GetStreamLastPointer ==
     151{{{
     152Adc_StreamNumSampleType Adc_GetStreamLastPointer(Adc_GroupType Group, Adc_ValueGroupType** PtrToSamplePtr)
     153}}}
     154
     155== Adc_GetVersionInfo ==
     156{{{
     157void Adc_GetVersionInfo(Std_VersionInfoType* versioninfo)
     158}}}
    23159
    24160----
    25161
    26 = API仕様 =
    27 
    28 ----
    29 
    30162= コンフィギュレーション仕様 =
     163
     164== AdcConfigSet ==
     165{{{
     166/AUTOSAR/EcucDefs/Adc/AdcConfigSet
     167}}}
     168* 型：Container
     169* 多重度：1
     170
     171== AdcHwUnit ==
     172{{{
     173/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit
     174}}}
     175* 型：Container
     176* 多重度：1..*
     177
     178== AdcClockSource ==
     179{{{
     180/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcClockSource
     181}}}
     182* 型：EnumerationParam
     183* 多重度：0..1
     184
     185== AdcHwUnitId ==
     186{{{
     187/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcHwUnitId
     188}}}
     189* 型：EnumerationParam
     190* 多重度：1
     191
     192== AdcPrescale ==
     193{{{
     194/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcPrescale
     195}}}
     196* 型：IntegerParam
     197* 多重度：0..1
     198
     199== AdcChannel ==
     200{{{
     201/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcChannel
     202}}}
     203* 型：Container
     204* 多重度：1..*
     205
     206== AdcChannelConvTime ==
     207{{{
     208/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcChannel/AdcChannelConvTime
     209}}}
     210* 型：IntegerParam
     211* 多重度：0..1
     212
     213== AdcChannelHighLimit ==
     214{{{
     215/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcChannel/AdcChannelHighLimit
     216}}}
     217* 型：IntegerParam
     218* 多重度：0..1
     219
     220== AdcChannelId ==
     221{{{
     222/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcChannel/AdcChannelId
     223}}}
     224* 型：IntegerParam
     225* 多重度：1
     226
     227== AdcChannelLimitCheck ==
     228{{{
     229/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcChannel/AdcChannelLimitCheck
     230}}}
     231* 型：BooleanParam
     232* 多重度：0..1
     233
     234== AdcChannelLowLimit ==
     235{{{
     236/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcChannel/AdcChannelLowLimit
     237}}}
     238* 型：IntegerParam
     239* 多重度：0..1
     240
     241== AdcChannelRangeSelect ==
     242{{{
     243/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcChannel/AdcChannelRangeSelect
     244}}}
     245* 型：EnumerationParam
     246* 多重度：0..1
     247
     248== AdcChannelRefVoltsrcHigh ==
     249{{{
     250/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcChannel/AdcChannelRefVoltsrcHigh
     251}}}
     252* 型：EnumerationParam
     253* 多重度：0..1
     254
     255== AdcChannelRefVoltsrcLow ==
     256{{{
     257/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcChannel/AdcChannelRefVoltsrcLow
     258}}}
     259* 型：EnumerationParam
     260* 多重度：0..1
     261
     262== AdcChannelResolution ==
     263{{{
     264/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcChannel/AdcChannelResolution
     265}}}
     266* 型：IntegerParam
     267* 多重度：0..1
     268
     269== AdcChannelSampTime ==
     270{{{
     271/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcChannel/AdcChannelSampTime
     272}}}
     273* 型：IntegerParam
     274* 多重度：0..1
     275
     276== AdcGroup ==
     277{{{
     278/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcGroup
     279}}}
     280* 型：Container
     281* 多重度：1..*
     282
     283== AdcGroupAccessMode ==
     284{{{
     285/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcGroup/AdcGroupAccessMode
     286}}}
     287* 型：EnumerationParam
     288* 多重度：1
     289
     290== AdcGroupConversionMode ==
     291{{{
     292/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcGroup/AdcGroupConversionMode
     293}}}
     294* 型：EnumerationParam
     295* 多重度：1
     296
     297== AdcGroupId ==
     298{{{
     299/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcGroup/AdcGroupId
     300}}}
     301* 型：IntegerParam
     302* 多重度：1
     303
     304== AdcGroupPriority ==
     305{{{
     306/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcGroup/AdcGroupPriority
     307}}}
     308* 型：IntegerParam
     309* 多重度：0..1
     310
     311== AdcGroupReplacement ==
     312{{{
     313/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcGroup/AdcGroupReplacement
     314}}}
     315* 型：EnumerationParam
     316* 多重度：0..1
     317
     318== AdcGroupTriggSrc ==
     319{{{
     320/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcGroup/AdcGroupTriggSrc
     321}}}
     322* 型：EnumerationParam
     323* 多重度：1
     324
     325== AdcHwTrigSignal ==
     326{{{
     327/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcGroup/AdcHwTrigSignal
     328}}}
     329* 型：EnumerationParam
     330* 多重度：0..1
     331
     332== AdcHwTrigTimer ==
     333{{{
     334/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcGroup/AdcHwTrigTimer
     335}}}
     336* 型：IntegerParam
     337* 多重度：0..1
     338
     339== AdcNotification ==
     340{{{
     341/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcGroup/AdcNotification
     342}}}
     343* 型：FunctionName
     344* 多重度：0..1
     345
     346== AdcStreamingBufferMode ==
     347{{{
     348/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcGroup/AdcStreamingBufferMode
     349}}}
     350* 型：EnumerationParam
     351* 多重度：1
     352
     353== AdcStreamingNumSamples ==
     354{{{
     355/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcGroup/AdcStreamingNumSamples
     356}}}
     357* 型：IntegerParam
     358* 多重度：1
     359
     360== AdcGroupDefinition ==
     361{{{
     362/AUTOSAR/EcucDefs/Adc/AdcConfigSet/AdcHwUnit/AdcGroup/AdcGroupDefinition
     363}}}
     364* 型：Reference
     365* 多重度：1..*
     366
     367== AdcGeneral ==
     368{{{
     369/AUTOSAR/EcucDefs/Adc/AdcGeneral
     370}}}
     371* 型：Container
     372* 多重度：1
     373
     374== AdcDeInitApi ==
     375{{{
     376/AUTOSAR/EcucDefs/Adc/AdcGeneral/AdcDeInitApi
     377}}}
     378* 型：BooleanParam
     379* 多重度：1
     380
     381== AdcDevErrorDetect ==
     382{{{
     383/AUTOSAR/EcucDefs/Adc/AdcGeneral/AdcDevErrorDetect
     384}}}
     385* 型：BooleanParam
     386* 多重度：1
     387
     388== AdcEnableLimitCheck ==
     389{{{
     390/AUTOSAR/EcucDefs/Adc/AdcGeneral/AdcEnableLimitCheck
     391}}}
     392* 型：BooleanParam
     393* 多重度：1
     394
     395== AdcEnableQueuing ==
     396{{{
     397/AUTOSAR/EcucDefs/Adc/AdcGeneral/AdcEnableQueuing
     398}}}
     399* 型：BooleanParam
     400* 多重度：1
     401
     402== AdcEnableStartStopGroupApi ==
     403{{{
     404/AUTOSAR/EcucDefs/Adc/AdcGeneral/AdcEnableStartStopGroupApi
     405}}}
     406* 型：BooleanParam
     407* 多重度：1
     408
     409== AdcGrpNotifCapability ==
     410{{{
     411/AUTOSAR/EcucDefs/Adc/AdcGeneral/AdcGrpNotifCapability
     412}}}
     413* 型：BooleanParam
     414* 多重度：1
     415
     416== AdcHwTriggerApi ==
     417{{{
     418/AUTOSAR/EcucDefs/Adc/AdcGeneral/AdcHwTriggerApi
     419}}}
     420* 型：BooleanParam
     421* 多重度：1
     422
     423== AdcPriorityImplementation ==
     424{{{
     425/AUTOSAR/EcucDefs/Adc/AdcGeneral/AdcPriorityImplementation
     426}}}
     427* 型：EnumerationParam
     428* 多重度：1
     429
     430== AdcReadGroupApi ==
     431{{{
     432/AUTOSAR/EcucDefs/Adc/AdcGeneral/AdcReadGroupApi
     433}}}
     434* 型：BooleanParam
     435* 多重度：1
     436
     437== AdcResultAlignment ==
     438{{{
     439/AUTOSAR/EcucDefs/Adc/AdcGeneral/AdcResultAlignment
     440}}}
     441* 型：EnumerationParam
     442* 多重度：1
     443
     444== AdcVersionInfoApi ==
     445{{{
     446/AUTOSAR/EcucDefs/Adc/AdcGeneral/AdcVersionInfoApi
     447}}}
     448* 型：BooleanParam
     449* 多重度：1
     450
     451== AdcPublishedInformation ==
     452{{{
     453/AUTOSAR/EcucDefs/Adc/AdcPublishedInformation
     454}}}
     455* 型：Container
     456* 多重度：1
     457
     458== AdcChannelValueSigned ==
     459{{{
     460/AUTOSAR/EcucDefs/Adc/AdcPublishedInformation/AdcChannelValueSigned
     461}}}
     462* 型：BooleanParam
     463* 多重度：1
     464
     465== AdcGroupFirstChannelFixed ==
     466{{{
     467/AUTOSAR/EcucDefs/Adc/AdcPublishedInformation/AdcGroupFirstChannelFixed
     468}}}
     469* 型：BooleanParam
     470* 多重度：1
     471
     472== AdcMaxChannelResolution ==
     473{{{
     474/AUTOSAR/EcucDefs/Adc/AdcPublishedInformation/AdcMaxChannelResolution
     475}}}
     476* 型：IntegerParam
     477* 多重度：1