Changes between Version 5 and Version 6 of spec/Pwm

Timestamp:

Jan 9, 2015, 5:06:53 PM (9 years ago)

Author:

fujisft-shigihara

Comment:

--

spec/Pwm

@@ -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] =||
+  || [#Pwm_Init Pwm_Init]                               ||  0|| 0x00||
+  || [#Pwm_DeInit Pwm_DeInit]                           ||  1|| 0x01||
+  || [#Pwm_SetDutyCycle Pwm_SetDutyCycle]               ||  2|| 0x02||
+  || [#Pwm_SetPeriodAndDuty Pwm_SetPeriodAndDuty]       ||  3|| 0x03||
+  || [#Pwm_SetOutputToIdle Pwm_SetOutputToIdle]         ||  4|| 0x04||
+  || [#Pwm_GetOutputState Pwm_GetOutputState]           ||  5|| 0x05||
+  || [#Pwm_DisableNotification Pwm_DisableNotification] ||  6|| 0x06||
+  || [#Pwm_EnableNotification Pwm_EnableNotification]   ||  7|| 0x07||
+  || [#Pwm_GetVersionInfo Pwm_GetVersionInfo]           ||  8|| 0x08||
+
+* コンフィギュレーション一覧
+  * [#PwmChannelConfigSet PwmChannelConfigSet]
+    * [#PwmChannel PwmChannel]
+      * [#PwmChannelClass PwmChannelClass]
+      * [#PwmChannelId PwmChannelId]
+      * [#PwmDutycycleDefault PwmDutycycleDefault]
+      * [#PwmIdleState PwmIdleState]
+      * [#PwmNotification PwmNotification]
+      * [#PwmPeriodDefault PwmPeriodDefault]
+      * [#PwmPolarity PwmPolarity]
+  * [#PwmConfigurationOfOptApiServices PwmConfigurationOfOptApiServices]
+    * [#PwmDeInitApi PwmDeInitApi]
+    * [#PwmGetOutputState PwmGetOutputState]
+    * [#PwmSetDutyCycle PwmSetDutyCycle]
+    * [#PwmSetOutputToIdle PwmSetOutputToIdle]
+    * [#PwmSetPeriodAndDuty PwmSetPeriodAndDuty]
+    * [#PwmVersionInfoApi PwmVersionInfoApi]
+  * [#PwmGeneral PwmGeneral]
+    * [#PwmDevErorDetect PwmDevErorDetect]
+    * [#PwmDutycycleUpdatedEndperiod PwmDutycycleUpdatedEndperiod]
+    * [#PwmIndex PwmIndex]
+    * [#PwmNotificationSupported PwmNotificationSupported]
+    * [#PwmPeriodUpdatedEndperiod PwmPeriodUpdatedEndperiod]
+
+* エラーコード一覧
+
+  ||= エラーコード =||= Dec =||= Hex =||
+  || PWM_E_PARAM_CONFIG        || 16|| 0x10||
+  || PWM_E_UNINIT              || 17|| 0x11||
+  || PWM_E_PARAM_CHANNEL       || 18|| 0x12||
+  || PWM_E_PERIOD_UNCHANGEABLE || 19|| 0x13||
+  || PWM_E_ALREADY_INITIALIZED || 20|| 0x14||
+  || PWM_E_PARAM_POINTER       || 21|| 0x15||
+
 ----
-{{{#!comment
-[執筆開始時削除エリア]ここまで
-※コメントごと削除してください
-}}}
-
-= 概要 =
+
+= API仕様 =
+
+== Pwm_Init ==
+{{{
+void Pwm_Init(const Pwm_ConfigType* ConfigPtr)
+}}}
+
+== Pwm_DeInit ==
+{{{
+void Pwm_DeInit(void)
+}}}
+
+== Pwm_SetDutyCycle ==
+{{{
+void Pwm_SetDutyCycle(Pwm_ChannelType ChannelNumber, uint16 DutyCycle)
+}}}
+
+== Pwm_SetPeriodAndDuty ==
+{{{
+void Pwm_SetPeriodAndDuty(Pwm_ChannelType ChannelNumber, Pwm_PeriodType Period, uint16 DutyCycle)
+}}}
+
+== Pwm_SetOutputToIdle ==
+{{{
+void Pwm_SetOutputToIdle(Pwm_ChannelType ChannelNumber)
+}}}
+
+== Pwm_GetOutputState ==
+{{{
+Pwm_OutputStateType Pwm_GetOutputState(Pwm_ChannelType ChannelNumber 
+)
+}}}
+
+== Pwm_DisableNotification ==
+{{{
+void Pwm_DisableNotification(Pwm_ChannelType ChannelNumber)
+}}}
+
+== Pwm_EnableNotification ==
+{{{
+void Pwm_EnableNotification(Pwm_ChannelType ChannelNumber, Pwm_EdgeNotificationType Notification)
+}}}
+
+== Pwm_GetVersionInfo ==
+{{{
+void Pwm_GetVersionInfo(Std_VersionInfoType* versioninfo)
+}}}
 
 ----
 
-= API仕様 =
-
-----
-
 = コンフィギュレーション仕様 =
+
+== PwmChannelConfigSet ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmChannelConfigSet
+}}}
+* 型：Container
+* 多重度：1
+
+== PwmChannel ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmChannelConfigSet/PwmChannel
+}}}
+* 型：Container
+* 多重度：1..*
+
+== PwmChannelClass ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmChannelConfigSet/PwmChannel/PwmChannelClass
+}}}
+* 型：EnumerationParam
+* 多重度：0..1
+
+== PwmChannelId ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmChannelConfigSet/PwmChannel/PwmChannelId
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== PwmDutycycleDefault ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmChannelConfigSet/PwmChannel/PwmDutycycleDefault
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== PwmIdleState ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmChannelConfigSet/PwmChannel/PwmIdleState
+}}}
+* 型：EnumerationParam
+* 多重度：1
+
+== PwmNotification ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmChannelConfigSet/PwmChannel/PwmNotification
+}}}
+* 型：FunctionName
+* 多重度：0..1
+
+== PwmPeriodDefault ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmChannelConfigSet/PwmChannel/PwmPeriodDefault
+}}}
+* 型：FloatParam
+* 多重度：1
+
+== PwmPolarity ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmChannelConfigSet/PwmChannel/PwmPolarity
+}}}
+* 型：EnumerationParam
+* 多重度：1
+
+== PwmConfigurationOfOptApiServices ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmConfigurationOfOptApiServices
+}}}
+* 型：Container
+* 多重度：1
+
+== PwmDeInitApi ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmConfigurationOfOptApiServices/PwmDeInitApi
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== PwmGetOutputState ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmConfigurationOfOptApiServices/PwmGetOutputState
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== PwmSetDutyCycle ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmConfigurationOfOptApiServices/PwmSetDutyCycle
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== PwmSetOutputToIdle ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmConfigurationOfOptApiServices/PwmSetOutputToIdle
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== PwmSetPeriodAndDuty ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmConfigurationOfOptApiServices/PwmSetPeriodAndDuty
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== PwmVersionInfoApi ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmConfigurationOfOptApiServices/PwmVersionInfoApi
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== PwmGeneral ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmGeneral
+}}}
+* 型：Container
+* 多重度：1
+
+== PwmDevErorDetect ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmGeneral/PwmDevErorDetect
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== PwmDutycycleUpdatedEndperiod ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmGeneral/PwmDutycycleUpdatedEndperiod
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== PwmIndex ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmGeneral/PwmIndex
+}}}
+* 型：IntegerParam
+* 多重度：1
+
+== PwmNotificationSupported ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmGeneral/PwmNotificationSupported
+}}}
+* 型：BooleanParam
+* 多重度：1
+
+== PwmPeriodUpdatedEndperiod ==
+{{{
+/AUTOSAR/EcucDefs/Pwm/PwmGeneral/PwmPeriodUpdatedEndperiod
+}}}
+* 型：BooleanParam
+* 多重度：1