Changes between Version 5 and Version 6 of spec/Spi


Ignore:
Timestamp:
Jan 9, 2015, 4:47:14 PM (9 years ago)
Author:
fujisft-shigihara
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • spec/Spi

    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  || [#Spi_Init Spi_Init]                                   ||  0|| 0x00||
     15  || [#Spi_DeInit Spi_DeInit]                               ||  1|| 0x01||
     16  || [#Spi_WriteIB Spi_WriteIB]                             ||  2|| 0x02||
     17  || [#Spi_AsyncTransmit Spi_AsyncTransmit]                 ||  3|| 0x03||
     18  || [#Spi_ReadIB Spi_ReadIB]                               ||  4|| 0x04||
     19  || [#Spi_SetupEB Spi_SetupEB]                             ||  5|| 0x05||
     20  || [#Spi_GetStatus Spi_GetStatus]                         ||  6|| 0x06||
     21  || [#Spi_GetJobResult Spi_GetJobResult]                   ||  7|| 0x07||
     22  || [#Spi_GetSequenceResult Spi_GetSequenceResult]         ||  8|| 0x08||
     23  || [#Spi_GetVersionInfo Spi_GetVersionInfo]               ||  9|| 0x09||
     24  || [#Spi_SyncTransmit Spi_SyncTransmit]                   || 10|| 0x0A||
     25  || [#Spi_GetHWUnitStatus Spi_GetHWUnitStatus]             || 11|| 0x0B||
     26  || [#Spi_Cancel Spi_Cancel]                               || 12|| 0x0C||
     27  || [#Spi_SetAsyncMode Spi_SetAsyncMode]                   || 13|| 0x0D||
     28  || [#Spi_MainFunction_Handling Spi_MainFunction_Handling] || 16|| 0x10||
     29
     30* コンフィギュレーション一覧
     31  * [#SpiDriver SpiDriver]
     32    * [#SpiMaxChannel SpiMaxChannel]
     33    * [#SpiMaxJob SpiMaxJob]
     34    * [#SpiMaxSequence SpiMaxSequence]
     35    * [#SpiChannel SpiChannel]
     36      * [#SpiChannelId SpiChannelId]
     37      * [#SpiChannelType SpiChannelType]
     38      * [#SpiDataWidth SpiDataWidth]
     39      * [#SpiDefaultData SpiDefaultData]
     40      * [#SpiEbMaxLength SpiEbMaxLength]
     41      * [#SpiIbNBuffers SpiIbNBuffers]
     42      * [#SpiTransferStart SpiTransferStart]
     43    * [#SpiDemEventParameterRefs SpiDemEventParameterRefs]
     44      * [#SPI_E_HARDWARE_ERROR SPI_E_HARDWARE_ERROR]
     45    * [#SpiExternalDevice SpiExternalDevice]
     46      * [#SpiBaudrate SpiBaudrate]
     47      * [#SpiCsIdentifier SpiCsIdentifier]
     48      * [#SpiCsPolarity SpiCsPolarity]
     49      * [#SpiCsSelection SpiCsSelection]
     50      * [#SpiDataShiftEdge SpiDataShiftEdge]
     51      * [#SpiEnableCs SpiEnableCs]
     52      * [#SpiHwUnit SpiHwUnit]
     53      * [#SpiShiftClockIdleLevel SpiShiftClockIdleLevel]
     54      * [#SpiTimeClk2Cs SpiTimeClk2Cs]
     55    * [#SpiJob SpiJob]
     56      * [#SpiHwUnitSynchronous SpiHwUnitSynchronous]
     57      * [#SpiJobEndNotification SpiJobEndNotification]
     58      * [#SpiJobId SpiJobId]
     59      * [#SpiJobPriority SpiJobPriority]
     60      * [#SpiDeviceAssignment SpiDeviceAssignment]
     61      * [#SpiChannelList SpiChannelList]
     62        * [#SpiChannelIndex SpiChannelIndex]
     63        * [#SpiChannelAssignment SpiChannelAssignment]
     64    * [#SpiSequence SpiSequence]
     65      * [#SpiInterruptibleSequence SpiInterruptibleSequence]
     66      * [#SpiSeqEndNotification SpiSeqEndNotification]
     67      * [#SpiSequenceId SpiSequenceId]
     68      * [#SpiJobAssignment SpiJobAssignment]
     69  * [#SpiGeneral SpiGeneral]
     70    * [#SpiCancelApi SpiCancelApi]
     71    * [#SpiChannelBuffersAllowed SpiChannelBuffersAllowed]
     72    * [#SpiDevErrorDetect SpiDevErrorDetect]
     73    * [#SpiHwStatusApi SpiHwStatusApi]
     74    * [#SpiInterruptibleSeqAllowed SpiInterruptibleSeqAllowed]
     75    * [#SpiLevelDelivered SpiLevelDelivered]
     76    * [#SpiSupportConcurrentSyncTransmit SpiSupportConcurrentSyncTransmit]
     77    * [#SpiVersionInfoApi SpiVersionInfoApi]
     78  * [#SpiPublishedInformation SpiPublishedInformation]
     79    * [#SpiMaxHwUnit SpiMaxHwUnit]
     80
     81* エラーコード一覧
     82  * "--"は[wiki:spec_DiagnosticEventManager Dem]により決定される
     83
     84  ||= エラーコード =||= Dec =||= Hex =||
     85  || SPI_E_PARAM_CHANNEL       || 10|| 0x0A||
     86  || SPI_E_PARAM_JOB           || 11|| 0x0B||
     87  || SPI_E_PARAM_SEQ           || 12|| 0x0C||
     88  || SPI_E_PARAM_LENGTH        || 13|| 0x0D||
     89  || SPI_E_PARAM_UNIT          || 14|| 0x0E||
     90  || SPI_E_PARAM_POINTER       || 16|| 0x10||
     91  || SPI_E_UNINIT              || 26|| 0x1A||
     92  || SPI_E_SEQ_PENDING         || 42|| 0x2A||
     93  || SPI_E_SEQ_IN_PROCESS      || 58|| 0x3A||
     94  || SPI_E_ALREADY_INITIALIZED || 74|| 0x4A||
     95  || SPI_E_HARDWARE_ERROR      || --||   --||
     96
    1697----
    17 {{{#!comment
    18 [執筆開始時削除エリア]ここまで
    19 ※コメントごと削除してください
    20 }}}
    21 
    22 = 概要 =
     98
     99= API仕様 =
     100
     101== Spi_Init ==
     102{{{
     103void Spi_Init(const Spi_ConfigType* ConfigPtr)
     104}}}
     105
     106== Spi_DeInit ==
     107{{{
     108Std_ReturnType Spi_DeInit(void)
     109}}}
     110
     111== Spi_WriteIB ==
     112{{{
     113Std_ReturnType Spi_WriteIB(Spi_ChannelType Channel, const Spi_DataType* DataBufferPtr)
     114}}}
     115
     116== Spi_AsyncTransmit ==
     117{{{
     118Std_ReturnType Spi_AsyncTransmit(Spi_SequenceType Sequence)
     119}}}
     120
     121== Spi_ReadIB ==
     122{{{
     123Std_ReturnType Spi_ReadIB(Spi_ChannelType Channel, Spi_DataType* DataBufferPointer)
     124}}}
     125
     126== Spi_SetupEB ==
     127{{{
     128Std_ReturnType Spi_SetupEB(Spi_ChannelType Channel, const Spi_DataType* SrcDataBufferPtr, Spi_DataType* DesDataBufferPtr, Spi_NumberOfDataType Length)
     129}}}
     130
     131== Spi_GetStatus ==
     132{{{
     133Spi_StatusType Spi_GetStatus(void)
     134}}}
     135
     136== Spi_GetJobResult ==
     137{{{
     138Spi_JobResultType Spi_GetJobResult(Spi_JobType Job)
     139}}}
     140
     141== Spi_GetSequenceResult ==
     142{{{
     143Spi_SeqResultType Spi_GetSequenceResult(Spi_SequenceType Sequence)
     144}}}
     145
     146== Spi_GetVersionInfo ==
     147{{{
     148void Spi_GetVersionInfo(Std_VersionInfoType* versioninfo)
     149}}}
     150
     151== Spi_SyncTransmit ==
     152{{{
     153Std_ReturnType Spi_SyncTransmit(Spi_SequenceType Sequence)
     154}}}
     155
     156== Spi_GetHWUnitStatus ==
     157{{{
     158Spi_StatusType Spi_GetHWUnitStatus(Spi_HWUnitType HWUnit)
     159}}}
     160
     161== Spi_Cancel ==
     162{{{
     163void Spi_Cancel(Spi_SequenceType Sequence)
     164}}}
     165
     166== Spi_SetAsyncMode ==
     167{{{
     168Std_ReturnType Spi_SetAsyncMode(Spi_AsyncModeType Mode)
     169}}}
     170
     171== Spi_MainFunction_Handling ==
     172{{{
     173void Spi_MainFunction_Handling(void)
     174}}}
    23175
    24176----
    25177
    26 = API仕様 =
    27 
    28 ----
    29 
    30178= コンフィギュレーション仕様 =
     179
     180== SpiDriver ==
     181{{{
     182/AUTOSAR/EcucDefs/Spi/SpiDriver
     183}}}
     184* 型：Container
     185* 多重度：1
     186
     187== SpiMaxChannel ==
     188{{{
     189/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiMaxChannel
     190}}}
     191* 型：IntegerParam
     192* 多重度：0..1
     193
     194== SpiMaxJob ==
     195{{{
     196/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiMaxJob
     197}}}
     198* 型：IntegerParam
     199* 多重度：0..1
     200
     201== SpiMaxSequence ==
     202{{{
     203/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiMaxSequence
     204}}}
     205* 型：IntegerParam
     206* 多重度：0..1
     207
     208== SpiChannel ==
     209{{{
     210/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiChannel
     211}}}
     212* 型：Container
     213* 多重度：1..*
     214
     215== SpiChannelId ==
     216{{{
     217/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiChannel/SpiChannelId
     218}}}
     219* 型：IntegerParam
     220* 多重度：1
     221
     222== SpiChannelType ==
     223{{{
     224/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiChannel/SpiChannelType
     225}}}
     226* 型：EnumerationParam
     227* 多重度：1
     228
     229== SpiDataWidth ==
     230{{{
     231/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiChannel/SpiDataWidth
     232}}}
     233* 型：IntegerParam
     234* 多重度：1
     235
     236== SpiDefaultData ==
     237{{{
     238/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiChannel/SpiDefaultData
     239}}}
     240* 型：IntegerParam
     241* 多重度：0..1
     242
     243== SpiEbMaxLength ==
     244{{{
     245/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiChannel/SpiEbMaxLength
     246}}}
     247* 型：IntegerParam
     248* 多重度：1
     249
     250== SpiIbNBuffers ==
     251{{{
     252/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiChannel/SpiIbNBuffers
     253}}}
     254* 型：IntegerParam
     255* 多重度：1
     256
     257== SpiTransferStart ==
     258{{{
     259/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiChannel/SpiTransferStart
     260}}}
     261* 型：EnumerationParam
     262* 多重度：1
     263
     264== SpiDemEventParameterRefs ==
     265{{{
     266/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiDemEventParameterRefs
     267}}}
     268* 型：Container
     269* 多重度：0..1
     270
     271== SPI_E_HARDWARE_ERROR ==
     272{{{
     273/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiDemEventParameterRefs/SPI_E_HARDWARE_ERROR
     274}}}
     275* 型：Reference
     276* 多重度：0..1
     277
     278== SpiExternalDevice ==
     279{{{
     280/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiExternalDevice
     281}}}
     282* 型：Container
     283* 多重度：1..*
     284
     285== SpiBaudrate ==
     286{{{
     287/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiExternalDevice/SpiBaudrate
     288}}}
     289* 型：FloatParam
     290* 多重度：1
     291
     292== SpiCsIdentifier ==
     293{{{
     294/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiExternalDevice/SpiCsIdentifier
     295}}}
     296* 型：StringParam
     297* 多重度：1
     298
     299== SpiCsPolarity ==
     300{{{
     301/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiExternalDevice/SpiCsPolarity
     302}}}
     303* 型：EnumerationParam
     304* 多重度：1
     305
     306== SpiCsSelection ==
     307{{{
     308/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiExternalDevice/SpiCsSelection
     309}}}
     310* 型：EnumerationParam
     311* 多重度：0..1
     312
     313== SpiDataShiftEdge ==
     314{{{
     315/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiExternalDevice/SpiDataShiftEdge
     316}}}
     317* 型：EnumerationParam
     318* 多重度：1
     319
     320== SpiEnableCs ==
     321{{{
     322/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiExternalDevice/SpiEnableCs
     323}}}
     324* 型：BooleanParam
     325* 多重度：1
     326
     327== SpiHwUnit ==
     328{{{
     329/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiExternalDevice/SpiHwUnit
     330}}}
     331* 型：EnumerationParam
     332* 多重度：1
     333
     334== SpiShiftClockIdleLevel ==
     335{{{
     336/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiExternalDevice/SpiShiftClockIdleLevel
     337}}}
     338* 型：EnumerationParam
     339* 多重度：1
     340
     341== SpiTimeClk2Cs ==
     342{{{
     343/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiExternalDevice/SpiTimeClk2Cs
     344}}}
     345* 型：FloatParam
     346* 多重度：1
     347
     348== SpiJob ==
     349{{{
     350/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiJob
     351}}}
     352* 型：Container
     353* 多重度：1..*
     354
     355== SpiHwUnitSynchronous ==
     356{{{
     357/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiJob/SpiHwUnitSynchronous
     358}}}
     359* 型：EnumerationParam
     360* 多重度：0..1
     361
     362== SpiJobEndNotification ==
     363{{{
     364/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiJob/SpiJobEndNotification
     365}}}
     366* 型：FunctionName
     367* 多重度：0..1
     368
     369== SpiJobId ==
     370{{{
     371/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiJob/SpiJobId
     372}}}
     373* 型：IntegerParam
     374* 多重度：1
     375
     376== SpiJobPriority ==
     377{{{
     378/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiJob/SpiJobPriority
     379}}}
     380* 型：IntegerParam
     381* 多重度：1
     382
     383== SpiDeviceAssignment ==
     384{{{
     385/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiJob/SpiDeviceAssignment
     386}}}
     387* 型：Reference
     388* 多重度：1
     389
     390== SpiChannelList ==
     391{{{
     392/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiJob/SpiChannelList
     393}}}
     394* 型：Container
     395* 多重度：1..*
     396
     397== SpiChannelIndex ==
     398{{{
     399/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiJob/SpiChannelList/SpiChannelIndex
     400}}}
     401* 型：IntegerParam
     402* 多重度：1
     403
     404== SpiChannelAssignment ==
     405{{{
     406/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiJob/SpiChannelList/SpiChannelAssignment
     407}}}
     408* 型：Reference
     409* 多重度：1
     410
     411== SpiSequence ==
     412{{{
     413/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiSequence
     414}}}
     415* 型：Container
     416* 多重度：1..*
     417
     418== SpiInterruptibleSequence ==
     419{{{
     420/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiSequence/SpiInterruptibleSequence
     421}}}
     422* 型：BooleanParam
     423* 多重度：1
     424
     425== SpiSeqEndNotification ==
     426{{{
     427/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiSequence/SpiSeqEndNotification
     428}}}
     429* 型：FunctionName
     430* 多重度：0..1
     431
     432== SpiSequenceId ==
     433{{{
     434/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiSequence/SpiSequenceId
     435}}}
     436* 型：IntegerParam
     437* 多重度：1
     438
     439== SpiJobAssignment ==
     440{{{
     441/AUTOSAR/EcucDefs/Spi/SpiDriver/SpiSequence/SpiJobAssignment
     442}}}
     443* 型：Reference
     444* 多重度：1..*
     445
     446== SpiGeneral ==
     447{{{
     448/AUTOSAR/EcucDefs/Spi/SpiGeneral
     449}}}
     450* 型：Container
     451* 多重度：1
     452
     453== SpiCancelApi ==
     454{{{
     455/AUTOSAR/EcucDefs/Spi/SpiGeneral/SpiCancelApi
     456}}}
     457* 型：BooleanParam
     458* 多重度：1
     459
     460== SpiChannelBuffersAllowed ==
     461{{{
     462/AUTOSAR/EcucDefs/Spi/SpiGeneral/SpiChannelBuffersAllowed
     463}}}
     464* 型：IntegerParam
     465* 多重度：1
     466
     467== SpiDevErrorDetect ==
     468{{{
     469/AUTOSAR/EcucDefs/Spi/SpiGeneral/SpiDevErrorDetect
     470}}}
     471* 型：BooleanParam
     472* 多重度：1
     473
     474== SpiHwStatusApi ==
     475{{{
     476/AUTOSAR/EcucDefs/Spi/SpiGeneral/SpiHwStatusApi
     477}}}
     478* 型：BooleanParam
     479* 多重度：1
     480
     481== SpiInterruptibleSeqAllowed ==
     482{{{
     483/AUTOSAR/EcucDefs/Spi/SpiGeneral/SpiInterruptibleSeqAllowed
     484}}}
     485* 型：BooleanParam
     486* 多重度：1
     487
     488== SpiLevelDelivered ==
     489{{{
     490/AUTOSAR/EcucDefs/Spi/SpiGeneral/SpiLevelDelivered
     491}}}
     492* 型：IntegerParam
     493* 多重度：1
     494
     495== SpiSupportConcurrentSyncTransmit ==
     496{{{
     497/AUTOSAR/EcucDefs/Spi/SpiGeneral/SpiSupportConcurrentSyncTransmit
     498}}}
     499* 型：BooleanParam
     500* 多重度：1
     501
     502== SpiVersionInfoApi ==
     503{{{
     504/AUTOSAR/EcucDefs/Spi/SpiGeneral/SpiVersionInfoApi
     505}}}
     506* 型：BooleanParam
     507* 多重度：1
     508
     509== SpiPublishedInformation ==
     510{{{
     511/AUTOSAR/EcucDefs/Spi/SpiPublishedInformation
     512}}}
     513* 型：Container
     514* 多重度：1
     515
     516== SpiMaxHwUnit ==
     517{{{
     518/AUTOSAR/EcucDefs/Spi/SpiPublishedInformation/SpiMaxHwUnit
     519}}}
     520* 型：IntegerParam
     521* 多重度：1