Changes between Version 1 and Version 2 of spec/MemAcc


Ignore:
Timestamp:
Dec 6, 2022, 2:23:29 PM (17 months ago)
Author:
fujisft-kaji
Comment:

R21-11反映

Legend:

Unmodified
Added
Removed
Modified

  • spec/MemAcc

    v1 v2  
    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] =||= R21-11 =||
     14  || [#MemAcc_Init MemAcc_Init]                                         ||  1|| 0x01||  ○  ||
     15  || [#MemAcc_DeInit MemAcc_DeInit]                                     ||  1|| 0x01||  ○  ||
     16  || [#MemAcc_GetVersionInfo MemAcc_GetVersionInfo]                     ||  2|| 0x02||  ○  ||
     17  || [#MemAcc_GetJobResult MemAcc_GetJobResult]                         ||  5|| 0x05||  ○  ||
     18  || [#MemAcc_GetJobStatus MemAcc_GetJobStatus]                         ||  5|| 0x05||  ○  ||
     19  || [#MemAcc_GetMemoryInfo MemAcc_GetMemoryInfo]                       ||  6|| 0x06||  ○  ||
     20  || [#MemAcc_GetProcessedLength MemAcc_GetProcessedLength]             ||  7|| 0x07||  ○  ||
     21  || [#MemAcc_GetJobInfo MemAcc_GetJobInfo]                             ||  8|| 0x08||  ○  ||
     22  || [#MemAcc_ActivateMem MemAcc_ActivateMem]                           || 20|| 0x14||  ○  ||
     23  || [#MemAcc_DeactivateMem MemAcc_DeactivateMem]                       || 21|| 0x15||  ○  ||
     24  || [#MemAcc_Cancel MemAcc_Cancel]                                     ||  4|| 0x04||  ○  ||
     25  || [#MemAcc_Read MemAcc_Read]                                         ||  9|| 0x09||  ○  ||
     26  || [#MemAcc_Write MemAcc_Write]                                       || 10|| 0x0A||  ○  ||
     27  || [#MemAcc_Erase MemAcc_Erase]                                       || 11|| 0x0B||  ○  ||
     28  || [#MemAcc_Compare MemAcc_Compare]                                   || 12|| 0x0C||  ○  ||
     29  || [#MemAcc_BlankCheck MemAcc_BlankCheck]                             || 13|| 0x0D||  ○  ||
     30  || [#MemAcc_HwSpecificService MemAcc_HwSpecificService]               || 14|| 0x0E||  ○  ||
     31  || [#MemAcc_RequestLock MemAcc_RequestLock]                           || 17|| 0x11||  ○  ||
     32  || [#MemAcc_ReleaseLock MemAcc_ReleaseLock]                           || 18|| 0x12||  ○  ||
     33  || [#MemAcc_MainFunction MemAcc_MainFunction]                         ||  3|| 0x03||  ○  ||
     34  || [#AddressAreaJobEndNotification <AddressAreaJobEndNotification>]   || 15|| 0x0F||  ○  ||
     35  || [#ApplicationLockNotification <ApplicationLockNotification>]       || 20|| 0x14||  ○  ||
     36
     37* コンフィギュレーション一覧 (R21-11)
     38  * [#MemAccAddressAreaConfiguration MemAccAddressAreaConfiguration] (○)
     39    * [#MemAccAddressAreaId MemAccAddressAreaId] (○)
     40    * [#MemAccAddressAreaPriority MemAccAddressAreaPriority] (○)
     41    * [#MemAccBufferAlignmentValue MemAccBufferAlignmentValue] (○)
     42    * [#MemAccJobEndNotificationName MemAccJobEndNotificationName] (○)
     43    * [#MemAccSubAddressAreaConfiguration MemAccSubAddressAreaConfiguration] (○)
     44      * [#MemAccLogicalStartAddress MemAccLogicalStartAddress] (○)
     45      * [#MemAccMemInvocation MemAccMemInvocation] (○)
     46      * [#MemAccMemNamePrefix MemAccMemNamePrefix] (○)
     47      * [#MemAccNumberOfEraseRetries MemAccNumberOfEraseRetries] (○)
     48      * [#MemAccNumberOfSectors MemAccNumberOfSectors] (○)
     49      * [#MemAccNumberOfWriteRetries MemAccNumberOfWriteRetries] (○)
     50      * [#MemAccSectorBatchRef MemAccSectorBatchRef] (○)
     51      * [#MemAccSectorOffset MemAccSectorOffset] (○)
     52      * [#MemAccUseEraseBurst MemAccUseEraseBurst] (○)
     53      * [#MemAccUseReadBurst MemAccUseReadBurst] (○)
     54      * [#MemAccUseWriteBurst MemAccUseWriteBurst] (○)
     55  * [#MemAccGeneral MemAccGeneral] (○)
     56    * [#MemAcc64BitSupport MemAcc64BitSupport] (○)
     57    * [#MemAccCompareApi MemAccCompareApi] (○)
     58    * [#MemAccDevErrorDetect MemAccDevErrorDetect] (○)
     59    * [#MemAccMainFunctionPeriod MemAccMainFunctionPeriod] (○)
     60    * [#MemAccUseMemFuncPtrTable MemAccUseMemFuncPtrTable] (○)
     61
     62* エラーコード一覧
     63
     64  ||= エラーコード =||= Dec =||= Hex =||= R21-11 =||
     65  || MEMACC_E_UNINIT                ||  1|| 0x01||  ○  ||
     66  || MEMACC_E_PARAM_POINTER         ||  2|| 0x02||  ○  ||
     67  || MEMACC_E_PARAM_ADDRESS_AREA_ID ||  3|| 0x03||  ○  ||
     68  || MEMACC_E_PARAM_ADDRESS_LENGTH  ||  4|| 0x04||  ○  ||
     69  || MEMACC_E_PARAM_HW_ID           ||  5|| 0x05||  ○  ||
     70  || MEMACC_E_BUSY                  ||  6|| 0x06||  ○  ||
     71  || MEMACC_E_MEM_INIT_FAILED       ||  7|| 0x07||  ○  ||
     72
    1573----
    16 {{{#!comment
    17 [執筆開始時削除エリア]ここまで
    18 ※コメントごと削除してください
    19 }}}
    20 
    21 = 概要 =
     74
     75= API仕様 =
     76
     77== MemAcc_Init ==
     78{{{
     79void MemAcc_Init (const MemAcc_ConfigType* configPtr)
     80}}}
     81
     82== MemAcc_DeInit ==
     83{{{
     84void MemAcc_DeInit (void)
     85}}}
     86
     87== MemAcc_GetVersionInfo ==
     88{{{
     89void MemAcc_GetVersionInfo (Std_VersionInfoType* versionInfoPtr)
     90}}}
     91
     92== MemAcc_GetJobResult ==
     93{{{
     94MemAcc_JobResultType MemAcc_GetJobResult (MemAcc_AddressAreaIdType addressAreaId)
     95}}}
     96
     97== MemAcc_GetJobStatus ==
     98{{{
     99MemAcc_JobStatusType MemAcc_GetJobStatus (MemAcc_AddressAreaIdType addressAreaId)
     100}}}
     101
     102== MemAcc_GetMemoryInfo ==
     103{{{
     104Std_ReturnType MemAcc_GetMemoryInfo (MemAcc_AddressAreaIdType addressAreaId, MemAcc_AddressType address, MemAcc_MemoryInfoType* memoryInfoPtr)
     105}}}
     106
     107== MemAcc_GetProcessedLength ==
     108{{{
     109MemAcc_LengthType MemAcc_GetProcessedLength (MemAcc_AddressAreaIdType addressAreaId)
     110}}}
     111
     112== MemAcc_GetJobInfo ==
     113{{{
     114void MemAcc_GetJobInfo (MemAcc_AddressAreaIdType addressAreaId, MemAcc_JobInfoType* jobInfoPtr)
     115}}}
     116
     117== MemAcc_ActivateMem ==
     118{{{
     119Std_ReturnType MemAcc_ActivateMem (MemAcc_AddressType headerAddress, MemAcc_HwIdType hwId)
     120}}}
     121
     122== MemAcc_DeactivateMem ==
     123{{{
     124Std_ReturnType MemAcc_DeactivateMem (MemAcc_HwIdType hwId, MemAcc_AddressType headerAddress)
     125}}}
     126
     127== MemAcc_Cancel ==
     128{{{
     129void MemAcc_Cancel (MemAcc_AddressAreaIdType addressAreaId)
     130}}}
     131
     132== MemAcc_Read ==
     133{{{
     134Std_ReturnType MemAcc_Read (MemAcc_AddressAreaIdType addressAreaId, MemAcc_AddressType sourceAddress, MemAcc_DataType* destinationDataPtr, MemAcc_LengthType length)
     135}}}
     136
     137== MemAcc_Write ==
     138{{{
     139Std_ReturnType MemAcc_Write (MemAcc_AddressAreaIdType addressAreaId, MemAcc_AddressType targetAddress, const MemAcc_DataType* sourceDataPtr, MemAcc_LengthType length)
     140}}}
     141
     142== MemAcc_Erase ==
     143{{{
     144Std_ReturnType MemAcc_Erase (MemAcc_AddressAreaIdType addressAreaId, MemAcc_AddressType targetAddress, MemAcc_LengthType length)
     145}}}
     146
     147== MemAcc_Compare ==
     148{{{
     149Std_ReturnType MemAcc_Compare (MemAcc_AddressAreaIdType addressAreaId, MemAcc_AddressType sourceAddress, const MemAcc_DataType* dataPtr, MemAcc_LengthType length)
     150}}}
     151
     152== MemAcc_BlankCheck ==
     153{{{
     154Std_ReturnType MemAcc_BlankCheck (MemAcc_AddressAreaIdType addressAreaId, MemAcc_AddressType targetAddress, MemAcc_LengthType length)
     155}}}
     156
     157== MemAcc_HwSpecificService ==
     158{{{
     159Std_ReturnType MemAcc_HwSpecificService (MemAcc_AddressAreaIdType addressAreaId, MemAcc_HwIdType hwId, MemAcc_MemHwServiceIdType hwServiceId, MemAcc_DataType* dataPtr, MemAcc_LengthType* lengthPtr)
     160}}}
     161
     162== MemAcc_RequestLock ==
     163{{{
     164Std_ReturnType MemAcc_RequestLock (MemAcc_AddressAreaIdType addressAreaId, MemAcc_AddressType address, MemAcc_AddressType length, void* lockNotificationFctPtr)
     165}}}
     166
     167== MemAcc_ReleaseLock ==
     168{{{
     169Std_ReturnType MemAcc_ReleaseLock (MemAcc_AddressAreaIdType addressAreaId, MemAcc_AddressType address, MemAcc_LengthType length)
     170}}}
     171
     172== MemAcc_MainFunction ==
     173{{{
     174void MemAcc_MainFunction (void)
     175}}}
     176
     177== <AddressAreaJobEndNotification> ==
     178{{{
     179void <AddressAreaJobEndNotification> (MemAcc_AddressAreaIdType addressAreaId, MemAcc_JobResultType jobResult)
     180}}}
     181
     182== <ApplicationLockNotification> ==
     183{{{
     184void <ApplicationLockNotification> (void)
     185}}}
    22186
    23187----
    24188
    25 = API仕様 =
    26 
    27 ----
    28 
    29189= コンフィギュレーション仕様 =
     190
     191== MemAccAddressAreaConfiguration ==
     192{{{
     193/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration
     194}}}
     195* 対象リビジョン: R21-11
     196* SWSタグ: ECUC_MemAcc_00010
     197* タイプ: PARAM-CONF-CONTAINER
     198* 多重度: 1..65535
     199
     200== MemAccAddressAreaId ==
     201{{{
     202/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccAddressAreaId
     203}}}
     204* 対象リビジョン: R21-11
     205* SWSタグ: ECUC_MemAcc_00011
     206* タイプ: INTEGER-PARAM
     207* 多重度: 1
     208* 上限値: 65535
     209* 下限値: 0
     210* デフォルト値: 0
     211
     212== MemAccAddressAreaPriority ==
     213{{{
     214/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccAddressAreaPriority
     215}}}
     216* 対象リビジョン: R21-11
     217* SWSタグ: ECUC_MemAcc_00012
     218* タイプ: INTEGER-PARAM
     219* 多重度: 1
     220* 上限値: 65535
     221* 下限値: 0
     222* デフォルト値: 0
     223
     224== MemAccBufferAlignmentValue ==
     225{{{
     226/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccBufferAlignmentValue
     227}}}
     228* 対象リビジョン: R21-11
     229* SWSタグ: ECUC_MemAcc_00025
     230* タイプ: INTEGER-PARAM
     231* 多重度: 1
     232* 上限値: 255
     233* 下限値: 0
     234
     235== MemAccJobEndNotificationName ==
     236{{{
     237/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccJobEndNotificationName
     238}}}
     239* 対象リビジョン: R21-11
     240* SWSタグ: ECUC_MemAcc_00027
     241* タイプ: FUNCTION-NAME
     242* 多重度: 1
     243
     244== MemAccSubAddressAreaConfiguration ==
     245{{{
     246/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccSubAddressAreaConfiguration
     247}}}
     248* 対象リビジョン: R21-11
     249* SWSタグ: ECUC_MemAcc_00013
     250* タイプ: PARAM-CONF-CONTAINER
     251* 多重度: 1..65536
     252
     253== MemAccLogicalStartAddress ==
     254{{{
     255/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccSubAddressAreaConfiguration/MemAccLogicalStartAddress
     256}}}
     257* 対象リビジョン: R21-11
     258* SWSタグ: ECUC_MemAcc_00015
     259* タイプ: INTEGER-PARAM
     260* 多重度: 1
     261* 上限値: 18446744073709551615
     262* 下限値: 0
     263* デフォルト値: 0
     264
     265== MemAccMemInvocation ==
     266{{{
     267/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccSubAddressAreaConfiguration/MemAccMemInvocation
     268}}}
     269* 対象リビジョン: R21-11
     270* SWSタグ: ECUC_MemAcc_00026
     271* タイプ: ENUMERATION-PARAM
     272* 多重度: 1
     273* 選択肢:
     274  * DIRECT_STATIC
     275  * INDIRECT_DYNAMIC
     276  * INDIRECT_STATIC
     277* デフォルト値: DIRECT_STATIC
     278
     279== MemAccMemNamePrefix ==
     280{{{
     281/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccSubAddressAreaConfiguration/MemAccMemNamePrefix
     282}}}
     283* 対象リビジョン: R21-11
     284* SWSタグ: ECUC_MemAcc_00017
     285* タイプ: STRING-PARAM
     286* 多重度: 1
     287
     288== MemAccNumberOfEraseRetries ==
     289{{{
     290/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccSubAddressAreaConfiguration/MemAccNumberOfEraseRetries
     291}}}
     292* 対象リビジョン: R21-11
     293* SWSタグ: ECUC_MemAcc_00021
     294* タイプ: INTEGER-PARAM
     295* 多重度: 0..1
     296* 上限値: 255
     297* 下限値: 0
     298* デフォルト値: 0
     299
     300== MemAccNumberOfSectors ==
     301{{{
     302/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccSubAddressAreaConfiguration/MemAccNumberOfSectors
     303}}}
     304* 対象リビジョン: R21-11
     305* SWSタグ: ECUC_MemAcc_00014
     306* タイプ: INTEGER-PARAM
     307* 多重度: 1
     308* 上限値: 4294967295
     309* 下限値: 1
     310* デフォルト値: 1
     311
     312== MemAccNumberOfWriteRetries ==
     313{{{
     314/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccSubAddressAreaConfiguration/MemAccNumberOfWriteRetries
     315}}}
     316* 対象リビジョン: R21-11
     317* SWSタグ: ECUC_MemAcc_00020
     318* タイプ: INTEGER-PARAM
     319* 多重度: 0..1
     320* 上限値: 255
     321* 下限値: 0
     322* デフォルト値: 0
     323
     324== MemAccSectorBatchRef ==
     325{{{
     326/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccSubAddressAreaConfiguration/MemAccSectorBatchRef
     327}}}
     328* 対象リビジョン: R21-11
     329* SWSタグ: ECUC_MemAcc_00023
     330* タイプ: REFERENCE
     331* 多重度: 1
     332* 参照先: [wiki:spec/Mem#MemSectorBatch /AUTOSAR/EcucDefs/Mem/MemInstance/MemSectorBatch]
     333
     334== MemAccSectorOffset ==
     335{{{
     336/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccSubAddressAreaConfiguration/MemAccSectorOffset
     337}}}
     338* 対象リビジョン: R21-11
     339* SWSタグ: ECUC_MemAcc_00016
     340* タイプ: INTEGER-PARAM
     341* 多重度: 1
     342* 上限値: 4294967295
     343* 下限値: 0
     344* デフォルト値: 0
     345
     346== MemAccUseEraseBurst ==
     347{{{
     348/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccSubAddressAreaConfiguration/MemAccUseEraseBurst
     349}}}
     350* 対象リビジョン: R21-11
     351* SWSタグ: ECUC_MemAcc_00018
     352* タイプ: BOOLEAN-PARAM
     353* 多重度: 1
     354* デフォルト値: false
     355
     356== MemAccUseReadBurst ==
     357{{{
     358/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccSubAddressAreaConfiguration/MemAccUseReadBurst
     359}}}
     360* 対象リビジョン: R21-11
     361* SWSタグ: ECUC_MemAcc_00022
     362* タイプ: BOOLEAN-PARAM
     363* 多重度: 1
     364* デフォルト値: false
     365
     366== MemAccUseWriteBurst ==
     367{{{
     368/AUTOSAR/EcucDefs/MemAcc/MemAccAddressAreaConfiguration/MemAccSubAddressAreaConfiguration/MemAccUseWriteBurst
     369}}}
     370* 対象リビジョン: R21-11
     371* SWSタグ: ECUC_MemAcc_00019
     372* タイプ: BOOLEAN-PARAM
     373* 多重度: 1
     374* デフォルト値: false
     375
     376== MemAccGeneral ==
     377{{{
     378/AUTOSAR/EcucDefs/MemAcc/MemAccGeneral
     379}}}
     380* 対象リビジョン: R21-11
     381* SWSタグ: ECUC_MemAcc_00002
     382* タイプ: PARAM-CONF-CONTAINER
     383* 多重度: 1
     384
     385== MemAcc64BitSupport ==
     386{{{
     387/AUTOSAR/EcucDefs/MemAcc/MemAccGeneral/MemAcc64BitSupport
     388}}}
     389* 対象リビジョン: R21-11
     390* SWSタグ: ECUC_MemAcc_00024
     391* タイプ: BOOLEAN-PARAM
     392* 多重度: 1
     393* デフォルト値: false
     394
     395== MemAccCompareApi ==
     396{{{
     397/AUTOSAR/EcucDefs/MemAcc/MemAccGeneral/MemAccCompareApi
     398}}}
     399* 対象リビジョン: R21-11
     400* SWSタグ: ECUC_MemAcc_00006
     401* タイプ: BOOLEAN-PARAM
     402* 多重度: 1
     403* デフォルト値: false
     404
     405== MemAccDevErrorDetect ==
     406{{{
     407/AUTOSAR/EcucDefs/MemAcc/MemAccGeneral/MemAccDevErrorDetect
     408}}}
     409* 対象リビジョン: R21-11
     410* SWSタグ: ECUC_MemAcc_00005
     411* タイプ: BOOLEAN-PARAM
     412* 多重度: 1
     413
     414== MemAccMainFunctionPeriod ==
     415{{{
     416/AUTOSAR/EcucDefs/MemAcc/MemAccGeneral/MemAccMainFunctionPeriod
     417}}}
     418* 対象リビジョン: R21-11
     419* SWSタグ: ECUC_MemAcc_00004
     420* タイプ: FLOAT-PARAM
     421* 多重度: 1
     422* 上限値: 1
     423* 下限値: 1E-4
     424* デフォルト値: 0.005
     425
     426== MemAccUseMemFuncPtrTable ==
     427{{{
     428/AUTOSAR/EcucDefs/MemAcc/MemAccGeneral/MemAccUseMemFuncPtrTable
     429}}}
     430* 対象リビジョン: R21-11
     431* SWSタグ: ECUC_MemAcc_00007
     432* タイプ: BOOLEAN-PARAM
     433* 多重度: 1
     434* デフォルト値: true