Changes between Version 2 and Version 3 of spec/Mka

Timestamp:

Oct 19, 2023, 9:51:15 AM (7 months ago)

Author:

fujisft-kaji

Comment:

--

spec/Mka

@@ -7 +7 @@
 [[BR]]
 
-{{{#!comment
-[執筆開始時削除エリア]ここから
-※コメントごと削除してください
-}}}
-* '''本項目は、まだ執筆されていません'''
-* '''要望等ございましたら、[wiki: Wikiトップページ]にあります[wiki:#本サイトに関して 問い合わせ先]までお願いします'''
-----
-{{{#!comment
-[執筆開始時削除エリア]ここまで
-※コメントごと削除してください
-}}}
-
 = 概要 =
+
 * API一覧
+
+  ||= API =||= ID[[BR]][Dec] =||= ID[[BR]][Hex] =||= R22-11 =||
+  || [#Mka_Init Mka_Init]                                                       ||   1|| 0x01||  ○  ||
+  || [#Mka_GetVersionInfo Mka_GetVersionInfo]                                   ||   2|| 0x02||  ○  ||
+  || [#Mka_SetCknStatus Mka_SetCknStatus]                                       ||   3|| 0x03||  ○  ||
+  || [#Mka_GetCknStatus Mka_GetCknStatus]                                       ||   4|| 0x04||  ○  ||
+  || [#Mka_SetEnable Mka_SetEnable]                                             ||   8|| 0x08||  ○  ||
+  || [#Mka_GetEnable Mka_GetEnable]                                             ||   5|| 0x05||  ○  ||
+  || [#Mka_GetPaeStatus Mka_GetPaeStatus]                                       ||   6|| 0x06||  ○  ||
+  || [#Mka_SetPaePermissiveMode Mka_SetPaePermissiveMode]                       ||   9|| 0x09||  ○  ||
+  || [#Mka_StartPae Mka_StartPae]                                               ||  16|| 0x10||  ○  ||
+  || [#Mka_GetMacSecStatistics Mka_GetMacSecStatistics]                         ||   7|| 0x07||  ○  ||
+  || [#Mka_LinkStateChange Mka_LinkStateChange]                                 ||  29|| 0x1D||  ○  ||
+  || [#Mka_GetMacSecStatisticsNotification Mka_GetMacSecStatisticsNotification] ||  30|| 0x1E||  ○  ||
+  || [#Mka_RxIndication Mka_RxIndication]                                       ||  31|| 0x1F||  ○  ||
+  || [#Mka_TxConfirmation Mka_TxConfirmation]                                   ||  32|| 0x20||  ○  ||
+  || [#Mka_MacSecUpdateSecYNotification Mka_MacSecUpdateSecYNotification]       ||  33|| 0x21||  ○  ||
+  || [#Mka_MacSecAddTxSaNotification Mka_MacSecAddTxSaNotification]             ||  34|| 0x22||  ○  ||
+  || [#Mka_MacSecAddRxSaNotification Mka_MacSecAddRxSaNotification]             ||  35|| 0x23||  ○  ||
+  || [#Mka_MainFunction Mka_MainFunction]                                       ||  36|| 0x24||  ○  ||
+
 * コンフィギュレーション一覧 (R22-11)
   * [#MkaCryptoAlgoConfig MkaCryptoAlgoConfig] (○)
@@ -76 +86 @@
     * [#MkaSwitchPortRef MkaSwitchPortRef] (○)
 
+* エラーコード一覧
+  * "--"は[wiki:spec/Dem Dem]により決定される
+
+  ||= エラーコード =||= Dec =||= Hex =||= R22-11 =||
+  || MKA_E_CFG_NULL_PTR             ||  1|| 0x01||  ○  ||
+  || MKA_E_INVALID_PARAMETER        ||  4|| 0x04||  ○  ||
+  || MKA_E_PARAM_POINTER            ||  5|| 0x05||  ○  ||
+  || MKA_E_UNINIT                   ||  6|| 0x06||  ○  ||
+  || MKA_E_TIMEOUT_INSTANCE         || --||   --||  ○  ||
+  || MKA_E_KEY_NOT_PRESENT_INSTANCE || --||   --||  ○  ||
+  || MKA_E_KEY_MISMATCH_INSTANCE    || --||   --||  ○  ||
+  || MKA_E_ALGO_MISMATCH_INSTANCE   || --||   --||  ○  ||
+
 ----
 
 = API仕様 =
+
+== Mka_Init ==
+{{{
+Std_ReturnType Mka_Init (const Mka_ConfigType* ConfigPtr)
+}}}
+
+== Mka_GetVersionInfo ==
+{{{
+Std_ReturnType Mka_GetVersionInfo (Std_VersionInfoType* VersionInfoPtr)
+}}}
+
+== Mka_SetCknStatus ==
+{{{
+Std_ReturnType Mka_SetCknStatus (uint8 MkaPaeIdx, boolean Enable, const uint8* Ckn, uint8 CknLength)
+}}}
+
+== Mka_GetCknStatus ==
+{{{
+Std_ReturnType Mka_GetCknStatus (uint8 MkaPaeIdx, const uint8* Ckn, uint8 CknLength, boolean* EnablePtr)
+}}}
+
+== Mka_SetEnable ==
+{{{
+Std_ReturnType Mka_SetEnable (uint8 MkaPaeIdx, boolean Enable)
+}}}
+
+== Mka_GetEnable ==
+{{{
+Std_ReturnType Mka_GetEnable (uint8 MkaPaeIdx, boolean* EnablePtr)
+}}}
+
+== Mka_GetPaeStatus ==
+{{{
+Std_ReturnType Mka_GetPaeStatus (uint8 MkaPaeIdx, Mka_PaeStatusType* PaeStatusPtr)
+}}}
+
+== Mka_SetPaePermissiveMode ==
+{{{
+Std_ReturnType Mka_SetPaePermissiveMode (uint8 MkaPaeIdx, Mka_PermisiveModeType PermisiveMode)
+}}}
+
+== Mka_StartPae ==
+{{{
+Std_ReturnType Mka_StartPae (uint8 MkaPaeIdx)
+}}}
+
+== Mka_GetMacSecStatistics ==
+{{{
+Std_ReturnType Mka_GetMacSecStatistics (uint8 MkaPaeIdx, const uint8* Ckn, uint8 CknLength)
+}}}
+
+== Mka_LinkStateChange ==
+{{{
+Std_ReturnType Mka_LinkStateChange (uint8 MkaPaeIdx, EthTrcv_LinkStateType TransceiverLinkState)
+}}}
+
+== Mka_GetMacSecStatisticsNotification ==
+{{{
+void Mka_GetMacSecStatisticsNotification (uint8 MkaPaeIdx, const Mka_Stats_SecYType* MacSecStatsPtr)
+}}}
+
+== Mka_RxIndication ==
+{{{
+void Mka_RxIndication (uint8 CtrlIdx, Eth_FrameType FrameType, boolean IsBroadcast, const uint8* PhysAddrPtr, const uint8* DataPtr, uint16 LenByte)
+}}}
+
+== Mka_TxConfirmation ==
+{{{
+void Mka_TxConfirmation (uint8 CtrlIdx, Eth_BufIdxType BufIdx, Std_ReturnType Result)
+}}}
+
+== Mka_MacSecUpdateSecYNotification ==
+{{{
+void Mka_MacSecUpdateSecYNotification (uint8 MkaPaeIdx)
+}}}
+
+== Mka_MacSecAddTxSaNotification ==
+{{{
+void Mka_MacSecAddTxSaNotification (uint8 MkaPaeIdx)
+}}}
+
+== Mka_MacSecAddRxSaNotification ==
+{{{
+void Mka_MacSecAddRxSaNotification (uint8 MkaPaeIdx)
+}}}
+
+== Mka_MainFunction ==
+{{{
+void Mka_MainFunction (void)
+}}}
 
 ----