Changes between Version 1 and Version 2 of spec/CryIf

Timestamp:

Dec 8, 2022, 5:01:10 PM (17 months ago)

Author:

fujisft-kaji

Comment:

R21-11反映

spec/CryIf

@@ -7 +7 @@
 [[BR]]
 
-{{{#!comment
-[執筆開始時削除エリア]ここから
-※コメントごと削除してください
-}}}
-* '''本項目は、まだ執筆されていません'''
-* '''要望等ございましたら、[wiki: Wikiトップページ]にあります[wiki:#本サイトに関して 問い合わせ先]までお願いします'''
+= 概要 =
+
+* API一覧
+
+  ||= API =||= ID[[BR]][Dec] =||= ID[[BR]][Hex] =||= R21-11 =||
+  || [#CryIf_Init CryIf_Init]                                   ||  0|| 0x00||  ○  ||
+  || [#CryIf_GetVersionInfo CryIf_GetVersionInfo]               ||  1|| 0x01||  ○  ||
+  || [#CryIf_ProcessJob CryIf_ProcessJob]                       ||  3|| 0x03||  ○  ||
+  || [#CryIf_CancelJob CryIf_CancelJob]                         || 14|| 0x0e||  ○  ||
+  || [#CryIf_KeyElementSet CryIf_KeyElementSet]                 ||  4|| 0x04||  ○  ||
+  || [#CryIf_KeySetValid CryIf_KeySetValid]                     ||  5|| 0x05||  ○  ||
+  || [#CryIf_KeySetInvalid CryIf_KeySetInvalid]                 || 20|| 0x14||  ○  ||
+  || [#CryIf_KeyGetStatus CryIf_KeyGetStatus]                   || 19|| 0x13||  ○  ||
+  || [#CryIf_KeyElementGet CryIf_KeyElementGet]                 ||  6|| 0x06||  ○  ||
+  || [#CryIf_KeyElementCopy CryIf_KeyElementCopy]               || 15|| 0x0f||  ○  ||
+  || [#CryIf_KeyElementCopyPartial CryIf_KeyElementCopyPartial] || 18|| 0x12||  ○  ||
+  || [#CryIf_KeyCopy CryIf_KeyCopy]                             || 16|| 0x10||  ○  ||
+  || [#CryIf_RandomSeed CryIf_RandomSeed]                       ||  7|| 0x07||  ○  ||
+  || [#CryIf_KeyGenerate CryIf_KeyGenerate]                     ||  8|| 0x08||  ○  ||
+  || [#CryIf_KeyDerive CryIf_KeyDerive]                         ||  9|| 0x09||  ○  ||
+  || [#CryIf_KeyExchangeCalcPubVal CryIf_KeyExchangeCalcPubVal] || 10|| 0x0a||  ○  ||
+  || [#CryIf_KeyExchangeCalcSecret CryIf_KeyExchangeCalcSecret] || 11|| 0x0b||  ○  ||
+  || [#CryIf_CallbackNotification CryIf_CallbackNotification]   || 13|| 0x0d||  ○  ||
+
+* コンフィギュレーション一覧 (R21-11)
+  * [#CryIfChannel CryIfChannel] (○)
+    * [#CryIfChannelId CryIfChannelId] (○)
+    * [#CryIfDriverObjectRef CryIfDriverObjectRef] (○)
+  * [#CryIfGeneral CryIfGeneral] (○)
+    * [#CryIfDevErrorDetect CryIfDevErrorDetect] (○)
+    * [#CryIfVersionInfoApi CryIfVersionInfoApi] (○)
+  * [#CryIfKey CryIfKey] (○)
+    * [#CryIfKeyId CryIfKeyId] (○)
+    * [#CryIfKeyRef CryIfKeyRef] (○)
+
+* エラーコード一覧
+
+  ||= エラーコード =||= Dec =||= Hex =||= R21-11 =||
+  || CRYIF_E_UNINIT            ||  0|| 0x00||  ○  ||
+  || CRYIF_E_INIT_FAILED       ||  1|| 0x01||  ○  ||
+  || CRYIF_E_PARAM_POINTER     ||  2|| 0x02||  ○  ||
+  || CRYIF_E_PARAM_HANDLE      ||  3|| 0x03||  ○  ||
+  || CRYIF_E_PARAM_VALUE       ||  4|| 0x04||  ○  ||
+  || CRYIF_E_KEY_SIZE_MISMATCH ||  5|| 0x05||  ○  ||
+
 ----
-{{{#!comment
-[執筆開始時削除エリア]ここまで
-※コメントごと削除してください
-}}}
-
-= 概要 =
+
+= API仕様 =
+
+== CryIf_Init ==
+{{{
+void CryIf_Init (const CryIf_ConfigType* configPtr)
+}}}
+
+== CryIf_GetVersionInfo ==
+{{{
+void CryIf_GetVersionInfo (Std_VersionInfoType* versioninfo)
+}}}
+
+== CryIf_ProcessJob ==
+{{{
+Std_ReturnType CryIf_ProcessJob (uint32 channelId, Crypto_JobType* job)
+}}}
+
+== CryIf_CancelJob ==
+{{{
+Std_ReturnType CryIf_CancelJob (uint32 channelId, Crypto_JobType* job)
+}}}
+
+== CryIf_KeyElementSet ==
+{{{
+Std_ReturnType CryIf_KeyElementSet (uint32 cryIfKeyId, uint32 keyElementId, const uint8* keyPtr, uint32 keyLength)
+}}}
+
+== CryIf_KeySetValid ==
+{{{
+Std_ReturnType CryIf_KeySetValid (uint32 cryIfKeyId)
+}}}
+
+== CryIf_KeySetInvalid ==
+{{{
+Std_ReturnType CryIf_KeySetInvalid (uint32 cryIfKeyId)
+}}}
+
+== CryIf_KeyGetStatus ==
+{{{
+Std_ReturnType CryIf_KeyGetStatus (uint32 cryIfKeyId, Crypto_KeyStatusType* keyStatusPtr)
+}}}
+
+== CryIf_KeyElementGet ==
+{{{
+Std_ReturnType CryIf_KeyElementGet (uint32 cryIfKeyId, uint32 keyElementId, uint8* resultPtr, uint32* resultLengthPtr)
+}}}
+
+== CryIf_KeyElementCopy ==
+{{{
+Std_ReturnType CryIf_KeyElementCopy (uint32 cryIfKeyId, uint32 keyElementId, uint32 targetCryIfKeyId, uint32 targetKeyElementId)
+}}}
+
+== CryIf_KeyElementCopyPartial ==
+{{{
+Std_ReturnType CryIf_KeyElementCopyPartial (uint32 cryIfKeyId, uint32 keyElementId, uint32 keyElementSourceOffset, uint32 keyElementTargetOffset, uint32 keyElementCopyLength, uint32 targetCryIfKeyId, uint32 targetKeyElementId)
+}}}
+
+== CryIf_KeyCopy ==
+{{{
+Std_ReturnType CryIf_KeyCopy (uint32 cryIfKeyId, uint32 targetCryIfKeyId)
+}}}
+
+== CryIf_RandomSeed ==
+{{{
+Std_ReturnType CryIf_RandomSeed (uint32 cryIfKeyId, const uint8* seedPtr, uint32 seedLength)
+}}}
+
+== CryIf_KeyGenerate ==
+{{{
+Std_ReturnType CryIf_KeyGenerate (uint32 cryIfKeyId)
+}}}
+
+== CryIf_KeyDerive ==
+{{{
+Std_ReturnType CryIf_KeyDerive (uint32 cryIfKeyId, uint32 targetCryIfKeyId)
+}}}
+
+== CryIf_KeyExchangeCalcPubVal ==
+{{{
+Std_ReturnType CryIf_KeyExchangeCalcPubVal (uint32 cryIfKeyId, uint8* publicValuePtr, uint32* publicValueLengthPtr)
+}}}
+
+== CryIf_KeyExchangeCalcSecret ==
+{{{
+Std_ReturnType CryIf_KeyExchangeCalcSecret (uint32 cryIfKeyId, const uint8* partnerPublicValuePtr, uint32 partnerPublicValueLength)
+}}}
+
+== CryIf_CallbackNotification ==
+{{{
+void CryIf_CallbackNotification (Crypto_JobType* job, Crypto_ResultType result)
+}}}
 
 ----
 
-= API仕様 =
-
-----
-
 = コンフィギュレーション仕様 =
+
+== CryIfChannel ==
+{{{
+/AUTOSAR/EcucDefs/CryIf/CryIfChannel
+}}}
+* 対象リビジョン: R21-11
+* SWSタグ: ECUC_CryIf_00002
+* タイプ: PARAM-CONF-CONTAINER
+* 多重度: 0..*
+
+== CryIfChannelId ==
+{{{
+/AUTOSAR/EcucDefs/CryIf/CryIfChannel/CryIfChannelId
+}}}
+* 対象リビジョン: R21-11
+* SWSタグ: ECUC_CryIf_00004
+* タイプ: INTEGER-PARAM
+* 多重度: 1
+* 上限値: 4294967295
+* 下限値: 0
+
+== CryIfDriverObjectRef ==
+{{{
+/AUTOSAR/EcucDefs/CryIf/CryIfChannel/CryIfDriverObjectRef
+}}}
+* 対象リビジョン: R21-11
+* SWSタグ: ECUC_CryIf_00005
+* タイプ: REFERENCE
+* 多重度: 1
+* 参照先: [wiki:spec/Crypto#CryptoDriverObject /AUTOSAR/EcucDefs/Crypto/CryptoDriverObjects/CryptoDriverObject]
+
+== CryIfGeneral ==
+{{{
+/AUTOSAR/EcucDefs/CryIf/CryIfGeneral
+}}}
+* 対象リビジョン: R21-11
+* SWSタグ: ECUC_CryIf_00009
+* タイプ: PARAM-CONF-CONTAINER
+* 多重度: 1
+
+== CryIfDevErrorDetect ==
+{{{
+/AUTOSAR/EcucDefs/CryIf/CryIfGeneral/CryIfDevErrorDetect
+}}}
+* 対象リビジョン: R21-11
+* SWSタグ: ECUC_CryIf_00010
+* タイプ: BOOLEAN-PARAM
+* 多重度: 1
+* デフォルト値: false
+
+== CryIfVersionInfoApi ==
+{{{
+/AUTOSAR/EcucDefs/CryIf/CryIfGeneral/CryIfVersionInfoApi
+}}}
+* 対象リビジョン: R21-11
+* SWSタグ: ECUC_CryIf_00011
+* タイプ: BOOLEAN-PARAM
+* 多重度: 1
+* デフォルト値: false
+
+== CryIfKey ==
+{{{
+/AUTOSAR/EcucDefs/CryIf/CryIfKey
+}}}
+* 対象リビジョン: R21-11
+* SWSタグ: ECUC_CryIf_00003
+* タイプ: PARAM-CONF-CONTAINER
+* 多重度: 0..*
+
+== CryIfKeyId ==
+{{{
+/AUTOSAR/EcucDefs/CryIf/CryIfKey/CryIfKeyId
+}}}
+* 対象リビジョン: R21-11
+* SWSタグ: ECUC_CryIf_00007
+* タイプ: INTEGER-PARAM
+* 多重度: 1
+* 上限値: 4294967295
+* 下限値: 0
+
+== CryIfKeyRef ==
+{{{
+/AUTOSAR/EcucDefs/CryIf/CryIfKey/CryIfKeyRef
+}}}
+* 対象リビジョン: R21-11
+* SWSタグ: ECUC_CryIf_00008
+* タイプ: REFERENCE
+* 多重度: 1
+* 参照先: [wiki:spec/Crypto#CryptoKey /AUTOSAR/EcucDefs/Crypto/CryptoKeys/CryptoKey]
+