Changes between Version 5 and Version 6 of spec/Fee

Timestamp:

Jan 23, 2015, 2:24:43 PM (9 years ago)

Author:

fujisft-shigihara

Comment:

--

spec/Fee

@@ -7 +7 @@
 [[BR]]
 
-{{{#!comment
-[執筆開始時削除エリア]ここから
-※コメントごと削除してください
-}}}
-* '''本項目は、まだ執筆されていません'''
-* '''執筆して頂ける方は、本注意書きを削除の上、執筆をお願いします(詳しくは本Wikiのソースコードをご参照ください)'''
-* '''質問事項等がございましたら、[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 問い合わせ先]までお願いします'''
+= 概要 =
+
+* API一覧
+
+  ||= API =||= ID[[BR]][Dec] =||= ID[[BR]][Hex] =||
+  || [#Fee_Init Fee_Init]                                 ||  0|| 0x00||
+  || [#Fee_SetMode Fee_SetMode]                           ||  1|| 0x01||
+  || [#Fee_Read Fee_Read]                                 ||  2|| 0x02||
+  || [#Fee_Write Fee_Write]                               ||  3|| 0x03||
+  || [#Fee_Cancel Fee_Cancel]                             ||  4|| 0x04||
+  || [#Fee_GetStatus Fee_GetStatus]                       ||  5|| 0x05||
+  || [#Fee_GetJobResult Fee_GetJobResult]                 ||  6|| 0x06||
+  || [#Fee_InvalidateBlock Fee_InvalidateBlock]           ||  7|| 0x07||
+  || [#Fee_GetVersionInfo Fee_GetVersionInfo]             ||  8|| 0x08||
+  || [#Fee_EraseImmediateBlock Fee_EraseImmediateBlock]   ||  9|| 0x09||
+  || [#Fee_JobEndNotification Fee_JobEndNotification]     || 16|| 0x10||
+  || [#Fee_JobErrorNotification Fee_JobErrorNotification] || 17|| 0x11||
+  || [#Fee_MainFunction Fee_MainFunction]                 || 18|| 0x12||
+
+* コンフィギュレーション一覧
+  * [#FeeBlockConfiguration FeeBlockConfiguration]
+    * [#FeeBlockNumber FeeBlockNumber]
+    * [#FeeBlockSize FeeBlockSize]
+    * [#FeeImmediateData FeeImmediateData]
+    * [#FeeNumberOfWriteCycles FeeNumberOfWriteCycles]
+    * [#FeeDeviceIndex FeeDeviceIndex]
+  * [#FeeGeneral FeeGeneral]
+    * [#FeeDevErrorDetect FeeDevErrorDetect]
+    * [#FeeIndex FeeIndex]
+    * [#FeeNvmJobEndNotification FeeNvmJobEndNotification]
+    * [#FeeNvmJobErrorNotification FeeNvmJobErrorNotification]
+    * [#FeePollingMode FeePollingMode]
+    * [#FeeSetModeSupported FeeSetModeSupported]
+    * [#FeeVersionInfoApi FeeVersionInfoApi]
+    * [#FeeVirtualPageSize FeeVirtualPageSize]
+  * [#FeePublishedInformation FeePublishedInformation]
+    * [#FeeBlockOverhead FeeBlockOverhead]
+    * [#FeeMaximumBlockingTime FeeMaximumBlockingTime]
+    * [#FeePageOverhead FeePageOverhead]
+
+* エラーコード一覧
+
+  ||= エラーコード =||= Dec =||= Hex =||
+  || FEE_E_UNINIT            ||  1|| 0x01||
+  || FEE_E_INVALID_BLOCK_NO  ||  2|| 0x02||
+  || FEE_E_INVALID_BLOCK_OFS ||  3|| 0x03||
+  || FEE_E_INVALID_DATA_PTR  ||  4|| 0x04||
+  || FEE_E_INVALID_BLOCK_LEN ||  5|| 0x05||
+  || FEE_E_BUSY              ||  6|| 0x06||
+  || FEE_E_BUSY_INTERNAL     ||  7|| 0x07||
+  || FEE_E_INVALID_CANCEL    ||  8|| 0x08||
+
 ----
-{{{#!comment
-[執筆開始時削除エリア]ここまで
-※コメントごと削除してください
-}}}
-
-= 概要 =
+
+= API仕様 =
+
+== Fee_Init ==
+{{{
+void Fee_Init(void)
+}}}
+
+== Fee_SetMode ==
+{{{
+void Fee_SetMode(MemIf_ModeType Mode)
+}}}
+
+== Fee_Read ==
+{{{
+Std_ReturnType Fee_Read(uint16 BlockNumber, uint16 BlockOffset, uint8* DataBufferPtr, uint16 Length)
+}}}
+
+== Fee_Write ==
+{{{
+Std_ReturnType Fee_Write(uint16 BlockNumber, uint8* DataBufferPtr)
+}}}
+
+== Fee_Cancel ==
+{{{
+void Fee_Cancel(void)
+}}}
+
+== Fee_GetStatus ==
+{{{
+MemIf_StatusType Fee_GetStatus(void)
+}}}
+
+== Fee_GetJobResult ==
+{{{
+MemIf_JobResultType Fee_GetJobResult(void)
+}}}
+
+== Fee_InvalidateBlock ==
+{{{
+Std_ReturnType Fee_InvalidateBlock(uint16 BlockNumber)
+}}}
+
+== Fee_GetVersionInfo ==
+{{{
+void Fee_GetVersionInfo(Std_VersionInfoType* VersionInfoPtr)
+}}}
+
+== Fee_EraseImmediateBlock ==
+{{{
+Std_ReturnType Fee_EraseImmediateBlock(uint16 BlockNumber)
+}}}
+
+== Fee_JobEndNotification ==
+{{{
+void Fee_JobEndNotification(void)
+}}}
+
+== Fee_JobErrorNotification ==
+{{{
+void Fee_JobErrorNotification(void)
+}}}
+
+== Fee_MainFunction ==
+{{{
+void Fee_MainFunction(void)
+}}}
 
 ----
 
-= API仕様 =
-
-----
-
 = コンフィギュレーション仕様 =
+
+== FeeBlockConfiguration ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeeBlockConfiguration
+}}}
+* 型：Container
+* 多重度：1..*
+
+== FeeBlockNumber ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeeBlockConfiguration/FeeBlockNumber
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== FeeBlockSize ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeeBlockConfiguration/FeeBlockSize
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== FeeImmediateData ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeeBlockConfiguration/FeeImmediateData
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== FeeNumberOfWriteCycles ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeeBlockConfiguration/FeeNumberOfWriteCycles
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== FeeDeviceIndex ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeeBlockConfiguration/FeeDeviceIndex
+}}}
+* 型：Reference
+* 多重度：1
+
+== FeeGeneral ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeeGeneral
+}}}
+* 型：Container
+* 多重度：1
+
+== FeeDevErrorDetect ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeeGeneral/FeeDevErrorDetect
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== FeeIndex ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeeGeneral/FeeIndex
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== FeeNvmJobEndNotification ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeeGeneral/FeeNvmJobEndNotification
+}}}
+* 型：FunctionName
+* 多重度：0..1
+
+== FeeNvmJobErrorNotification ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeeGeneral/FeeNvmJobErrorNotification
+}}}
+* 型：FunctionName
+* 多重度：0..1
+
+== FeePollingMode ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeeGeneral/FeePollingMode
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== FeeSetModeSupported ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeeGeneral/FeeSetModeSupported
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== FeeVersionInfoApi ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeeGeneral/FeeVersionInfoApi
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== FeeVirtualPageSize ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeeGeneral/FeeVirtualPageSize
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== FeePublishedInformation ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeePublishedInformation
+}}}
+* 型：Container
+* 多重度：1
+
+== FeeBlockOverhead ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeePublishedInformation/FeeBlockOverhead
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== FeeMaximumBlockingTime ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeePublishedInformation/FeeMaximumBlockingTime
+}}}
+* 型：FloatParam
+* 多重度：1
+
+== FeePageOverhead ==
+{{{
+/AUTOSAR/EcucDefs/Fee/FeePublishedInformation/FeePageOverhead
+}}}
+* 型：IntegerParam
+* 多重度：1