Difference between revisions of "Unit PWM"

From Ultibo.org
Jump to: navigation, search
 
(16 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
----
 
----
  
 +
'''Ultibo PWM Interface unit'''
  
 
Pulse Width Modulation (PWM) is a technique of encoding a pulsed signal so as to control the ratio of on to off by switching the signal between on and off at a very high rate.  
 
Pulse Width Modulation (PWM) is a technique of encoding a pulsed signal so as to control the ratio of on to off by switching the signal between on and off at a very high rate.  
Line 17: Line 18:
 
----
 
----
  
−
''To be documented''
+
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''PWM specific constants''' <code> PWM_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>PWM_NAME_PREFIX = 'PWM';</code>
 +
| Name prefix for PWM Devices
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''PWM device type''' <code> PWM_TYPE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>PWM_TYPE_NONE = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>PWM_TYPE_MAX = 0;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''PWM device state''' <code> PWM_STATE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>PWM_STATE_DISABLED = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>PWM_STATE_ENABLED = 1;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''PWM device flag''' <code> PWM_FLAG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>PWM_FLAG_NONE = $00000000;</code>
 +
| &nbsp;
 +
|-
 +
| <code>PWM_FLAG_GPIO = $00000001;</code>
 +
| Device supports Get/Set GPIO
 +
|-
 +
| <code>PWM_FLAG_MODE = $00000002;</code>
 +
| Device supports Get/Set Mode
 +
|-
 +
| <code>PWM_FLAG_RANGE = $00000004;</code>
 +
| Device supports Get/Set Range
 +
|-
 +
| <code>PWM_FLAG_FREQUENCY = $00000008;</code>
 +
| Device supports Get/Set Frequency
 +
|-
 +
| <code>PWM_FLAG_POLARITY = $00000010;</code>
 +
| Device supports Get/Set Polarity
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''PWM mode value''' <code> PWM_MODE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>PWM_MODE_MARKSPACE = 0;</code>
 +
| Standard PWM Mark/Space mode
 +
|-
 +
| <code>PWM_MODE_BALANCED = 1;</code>
 +
| Balanced mode (Device specific)
 +
|-
 +
| <code>PWM_MODE_SERIALIZED = 2;</code>
 +
| Serialized mode (Device specific)
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>PWM_MODE_MAX = 2;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''PWM polarity value''' <code> PWM_POLARITY_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>PWM_POLARITY_NORMAL = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>PWM_POLARITY_INVERSE = 1;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>PWM_POLARITY_MAX = 1;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''PWM logging''' <code> PWM_LOG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>PWM_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG;</code>
 +
| PWM debugging messages
 +
|-
 +
| <code>PWM_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code>
 +
| PWM informational messages, such as a device being attached or detached
 +
|-
 +
| <code>PWM_LOG_LEVEL_WARN = LOG_LEVEL_WARN;</code>
 +
| PWM warning messages
 +
|-
 +
| <code>PWM_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code>
 +
| PWM error messages
 +
|-
 +
| <code>PWM_LOG_LEVEL_NONE = LOG_LEVEL_NONE;</code>
 +
| No PWM messages
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
 
=== Type definitions ===
 
=== Type definitions ===
 
----
 
----
  
−
''To be documented''
+
 
 +
'''PWM properties'''
 +
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PPWMProperties = ^TPWMProperties;</code>
 +
 
 +
<code>TPWMProperties = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>Flags:LongWord;</code>
 +
| Device flags (eg PWM_FLAG_MODE)
 +
|-
 +
| <code>GPIO:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Mode:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Range:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Frequency:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Polarity:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>DutyNS:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>PeriodNS:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MinPeriod:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''PWM enumeration callback'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMEnumerate = function(PWM:PPWMDevice; Data:Pointer):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM notification callback'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMNotification = function(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device start'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMDeviceStart = function(PWM:PPWMDevice):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device stop'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMDeviceStop = function(PWM:PPWMDevice):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device write'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMDeviceWrite = function(PWM:PPWMDevice; Value:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device get GPIO'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMDeviceGetGPIO = function(PWM:PPWMDevice):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device set GPIO'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMDeviceSetGPIO = function(PWM:PPWMDevice; GPIO:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device get mode'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMDeviceGetMode = function(PWM:PPWMDevice):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device set mode'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMDeviceSetMode = function(PWM:PPWMDevice; Mode:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device get range'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMDeviceGetRange = function(PWM:PPWMDevice):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device set range'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMDeviceSetRange = function(PWM:PPWMDevice; Range:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device get frequency'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMDeviceGetFrequency = function(PWM:PPWMDevice):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device set frequency'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMDeviceSetFrequency = function(PWM:PPWMDevice; Frequency:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device get polarity'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMDeviceGetPolarity = function(PWM:PPWMDevice):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device set polarity'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMDeviceSetPolarity = function(PWM:PPWMDevice; Polarity:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device configure'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMDeviceConfigure = function(PWM:PPWMDevice; DutyNS,PeriodNS:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device get properties'''
 +
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TPWMDeviceGetProperties = function(PWM:PPWMDevice; Properties:PPWMProperties):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''PWM device'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PPWMDevice = ^TPWMDevice;</code>
 +
 
 +
<code>TPWMDevice = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|''Device Properties''
 +
|-
 +
| <code>Device:TDevice;</code>
 +
| The Device entry for this PWM
 +
|-
 +
|colspan="2"|''PWM Properties''
 +
|-
 +
| <code>PWMId:LongWord;</code>
 +
| Unique Id of this PWM in the PWM table
 +
|-
 +
| <code>PWMState:LongWord;</code>
 +
| PWM state (eg PWM_STATE_ENABLED)
 +
|-
 +
| <code>DeviceStart:TPWMDeviceStart;</code>
 +
| A Device specific DeviceStart method implementing the standard PWM device interface (Mandatory)
 +
|-
 +
| <code>DeviceStop:TPWMDeviceStop;</code>
 +
| A Device specific DeviceStop method implementing the standard PWM device interface (Mandatory)
 +
|-
 +
| <code>DeviceWrite:TPWMDeviceWrite;</code>
 +
| A Device specific DeviceWrite method implementing the standard PWM device interface (Mandatory)
 +
|-
 +
| <code>DeviceGetGPIO:TPWMDeviceGetGPIO;</code>
 +
| A Device specific DeviceGetGPIO method implementing the standard PWM device interface (Or nil if the operation is not supported)
 +
|-
 +
| <code>DeviceSetGPIO:TPWMDeviceSetGPIO;</code>
 +
| A Device specific DeviceSetGPIO method implementing the standard PWM device interface (Or nil if the operation is not supported)
 +
|-
 +
| <code>DeviceGetMode:TPWMDeviceGetMode;</code>
 +
| A Device specific DeviceGetMode method implementing the standard PWM device interface (Or nil if the operation is not supported)
 +
|-
 +
| <code>DeviceSetMode:TPWMDeviceSetMode;</code>
 +
| A Device specific DeviceSetMode method implementing the standard PWM device interface (Or nil if the operation is not supported)
 +
|-
 +
| <code>DeviceGetRange:TPWMDeviceGetRange;</code>
 +
| A Device specific DeviceGetRange method implementing the standard PWM device interface (Or nil if the operation is not supported)
 +
|-
 +
| <code>DeviceSetRange:TPWMDeviceSetRange;</code>
 +
| A Device specific DeviceSetRange method implementing the standard PWM device interface (Or nil if the operation is not supported)
 +
|-
 +
| <code>DeviceGetFrequency:TPWMDeviceGetFrequency;</code>
 +
| A Device specific DeviceGetFrequency method implementing the standard PWM device interface (Or nil if the operation is not supported)
 +
|-
 +
| <code>DeviceSetFrequency:TPWMDeviceSetFrequency;</code>
 +
| A Device specific DeviceSetFrequency method implementing the standard PWM device interface (Or nil if the operation is not supported)
 +
|-
 +
| <code>DeviceGetPolarity:TPWMDeviceGetPolarity;</code>
 +
| A Device specific DeviceGetPolarity method implementing the standard PWM device interface (Or nil if the operation is not supported)
 +
|-
 +
| <code>DeviceSetPolarity:TPWMDeviceSetPolarity;</code>
 +
| A Device specific DeviceSetPolarity method implementing the standard PWM device interface (Or nil if the operation is not supported)
 +
|-
 +
| <code>DeviceConfigure:TPWMDeviceConfigure;</code>
 +
| A Device specific DeviceConfigure method implementing the standard PWM device interface (Mandatory)
 +
|-
 +
| <code>DeviceGetProperties:TPWMDeviceGetProperties;</code>
 +
| A Device specific DeviceGetProperties method implementing the standard PWM device interface (Or nil if the default method is suitable)
 +
|-
 +
|colspan="2"|''Statistics Properties''
 +
|-
 +
| <code>GetCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>SetCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>WriteCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>ConfigCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''Driver Properties''
 +
|-
 +
| <code>Lock:TMutexHandle;</code>
 +
| Device lock
 +
|-
 +
| <code>GPIO:LongWord;</code>
 +
| GPIO Pin
 +
|-
 +
| <code>Mode:LongWord;</code>
 +
| Device Mode
 +
|-
 +
| <code>Range:LongWord;</code>
 +
| Device Range
 +
|-
 +
| <code>Frequency:LongWord;</code>
 +
| Clock Frequency
 +
|-
 +
| <code>Polarity:LongWord;</code>
 +
| Output Polarity
 +
|-
 +
| <code>DutyNS:LongWord;</code>
 +
| Duty Nanoseconds
 +
|-
 +
| <code>PeriodNS:LongWord;</code>
 +
| Period Nanonseconds
 +
|-
 +
| <code>Properties:TPWMProperties;</code>
 +
| Device properties
 +
|-
 +
|colspan="2"|''Internal Properties''
 +
|-
 +
| <code>Prev:PPWMDevice;</code>
 +
| Previous entry in PWM table
 +
|-
 +
| <code>Next:PPWMDevice;</code>
 +
| Next entry in PWM table
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
 
=== Public variables ===
 
=== Public variables ===
 
----
 
----
  
−
''To be documented''
+
 
 +
'''PWM logging'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>PWM_DEFAULT_LOG_LEVEL:LongWord = PWM_LOG_LEVEL_DEBUG;</code>
 +
| style="width: 40%;"|Minimum level for PWM messages. Only messages with level greater than or equal to this will be printed.
 +
|-
 +
|}
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>PWM_LOG_ENABLED:Boolean;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
<br />
  
 
=== Function declarations ===
 
=== Function declarations ===
Line 41: Line 501:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Called only during system startup
 
| Called only during system startup
 
|-
 
|-
Line 56: Line 516:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''PWM'''
+
! PWM
 
| The PWM device to start
 
| The PWM device to start
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 71: Line 531:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''PWM'''
+
! PWM
 
| The PWM device to stop
 
| The PWM device to stop
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 86: Line 546:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''PWM'''
+
! PWM
 
| The PWM device to write to
 
| The PWM device to write to
 
|-
 
|-
−
! '''Value'''
+
! Value
 
| The value to write
 
| The value to write
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| The exact meaning of value may depend on the device and other configured options, in many cases the value will represent the "on" time of each pulse with regard to the duty cycle of the waveform output by the device
+
| The exact meaning of value may depend on the device and other configured options, in many cases the value will represent the "on" time of each pulse with regard to the duty cycle of the waveform output by the device.
 
|-
 
|-
 
|}
 
|}
Line 107: Line 567:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''PWM'''
+
! PWM
 
| The PWM device to get the GPIO pin from
 
| The PWM device to get the GPIO pin from
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The current GPIO pin or GPIO_PIN_UNKNOWN on failure
 
| The current GPIO pin or GPIO_PIN_UNKNOWN on failure
 
|-
 
|-
Line 122: Line 582:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''PWM'''
+
! PWM
 
| The PWM device to set the GPIO pin for
 
| The PWM device to set the GPIO pin for
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO pin to set (eg GPIO_PIN_12)
 
| The GPIO pin to set (eg GPIO_PIN_12)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 140: Line 600:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''PWM'''
+
! PWM
 
| The PWM device to get the mode from
 
| The PWM device to get the mode from
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The current mode or a default value of PWM_MODE_MARKSPACE
 
| The current mode or a default value of PWM_MODE_MARKSPACE
 
|-
 
|-
Line 155: Line 615:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''PWM'''
+
! PWM
 
| The PWM device to set the mode for
 
| The PWM device to set the mode for
 
|-
 
|-
−
! '''Mode'''
+
! Mode
 
| The mode value to set (eg PWM_MODE_MARKSPACE)
 
| The mode value to set (eg PWM_MODE_MARKSPACE)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 173: Line 633:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''PWM'''
+
! PWM
 
| The PWM device to get the range from
 
| The PWM device to get the range from
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The current range or 0 on failure
 
| The current range or 0 on failure
 
|-
 
|-
Line 188: Line 648:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''PWM'''
+
! PWM
 
| The PWM device to set the clock rate for
 
| The PWM device to set the clock rate for
 
|-
 
|-
−
! '''Range'''
+
! Range
 
| The range value to set
 
| The range value to set
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| The exact meaning of range may depend on the device and other configured options, in many cases the range will represent the period of one full cycle of the waveform output by the device
+
| The exact meaning of range may depend on the device and other configured options, in many cases the range will represent the period of one full cycle of the waveform output by the device.
 
|-
 
|-
 
|}
 
|}
Line 209: Line 669:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''PWM'''
+
! PWM
 
| The PWM device to get the clock frequency from
 
| The PWM device to get the clock frequency from
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The clock frequency in Hz or 0 on failure
 
| The clock frequency in Hz or 0 on failure
 
|-
 
|-
Line 224: Line 684:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''PWM'''
+
! PWM
 
| The PWM device to set the clock frequency for
 
| The PWM device to set the clock frequency for
 
|-
 
|-
−
! '''Frequency'''
+
! Frequency
 
| The clock frequency to set in Hz
 
| The clock frequency to set in Hz
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 242: Line 702:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''PWM'''
+
! PWM
 
| The PWM device to get the polarity from
 
| The PWM device to get the polarity from
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The current polarity or a default value of PWM_POLARITY_NORMAL
 
| The current polarity or a default value of PWM_POLARITY_NORMAL
 
|-
 
|-
Line 257: Line 717:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''PWM'''
+
! PWM
 
| The PWM device to set the polarity for
 
| The PWM device to set the polarity for
 
|-
 
|-
−
! '''Polarity'''
+
! Polarity
 
| The polarity value to set (eg PWM_POLARITY_NORMAL)
 
| The polarity value to set (eg PWM_POLARITY_NORMAL)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 275: Line 735:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''PWM'''
+
! PWM
 
| The PWM device to set the configuration for
 
| The PWM device to set the configuration for
 
|-
 
|-
−
! '''DutyNS'''
+
! DutyNS
 
| The "on" time part of the cycle (Nanoseconds)
 
| The "on" time part of the cycle (Nanoseconds)
 
|-
 
|-
−
! '''PeriodNS'''
+
! PeriodNS
 
| The duration of one full cycle (Nanoseconds)
 
| The duration of one full cycle (Nanoseconds)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 291: Line 751:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function PWMDeviceProperties(PWM:PPWMDevice; Properties:PPWMProperties):LongWord;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function PWMDeviceProperties(PWM:PPWMDevice; Properties:PPWMProperties):LongWord; inline;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the properties for the specified PWM device</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the properties for the specified PWM device</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''PWM'''
+
! PWM
 
| The PWM device to get properties from
 
| The PWM device to get properties from
 
|-
 
|-
−
! '''Properties'''
+
! Properties
 
| Pointer to a TPWMProperties structure to fill in
 
| Pointer to a TPWMProperties structure to fill in
 
|-
 
|-
−
! '''Return'''
+
! Return
 +
| ERROR_SUCCESS if completed or another error code on failure
 +
|-
 +
! Note
 +
| Replaced by PWMDeviceGetProperties for consistency
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function PWMDeviceGetProperties(PWM:PPWMDevice; Properties:PPWMProperties):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the properties for the specified PWM device</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! PWM
 +
| The PWM device to get properties from
 +
|-
 +
! Properties
 +
| Pointer to a TPWMProperties structure to fill in
 +
|-
 +
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 314: Line 795:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| Pointer to new PWM entry or nil if PWM could not be created
 
| Pointer to new PWM entry or nil if PWM could not be created
 
|-
 
|-
Line 326: Line 807:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Size'''
+
! Size
 
| Size in bytes to allocate for new PWM (Including the PWM entry)
 
| Size in bytes to allocate for new PWM (Including the PWM entry)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| Pointer to new PWM entry or nil if PWM could not be created
 
| Pointer to new PWM entry or nil if PWM could not be created
 
|-
 
|-
Line 341: Line 822:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 353: Line 834:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 365: Line 846:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 377: Line 858:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 389: Line 870:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 401: Line 882:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 413: Line 894:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 425: Line 906:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 440: Line 921:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 452: Line 933:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 464: Line 945:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 476: Line 957:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Value'''
+
! Value
 
| The value to write
 
| The value to write
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| The exact meaning of value may depend on the device and other configured options, in many cases the value will represent the "on" time of each pulse with regard to the duty cycle of the waveform output by the device
+
| The exact meaning of value may depend on the device and other configured options, in many cases the value will represent the "on" time of each pulse with regard to the duty cycle of the waveform output by the device.
 
|-
 
|-
 
|}
 
|}
Line 494: Line 975:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Mode'''
+
! Mode
 
| The mode value to set (eg PWM_MODE_MARKSPACE)
 
| The mode value to set (eg PWM_MODE_MARKSPACE)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 509: Line 990:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Range'''
+
! Range
 
| The range value to set
 
| The range value to set
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| The exact meaning of range may depend on the device and other configured options, in many cases the range will represent the period of one full cycle of the waveform output by the device
+
| The exact meaning of range may depend on the device and other configured options, in many cases the range will represent the period of one full cycle of the waveform output by the device.
 
|-
 
|-
 
|}
 
|}
Line 527: Line 1,008:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Frequency'''
+
! Frequency
 
| The frequency to set in Hz
 
| The frequency to set in Hz
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 542: Line 1,023:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''DutyNS'''
+
! DutyNS
 
| The "on" time part of the cycle (Nanoseconds)
 
| The "on" time part of the cycle (Nanoseconds)
 
|-
 
|-
−
! '''PeriodNS'''
+
! PeriodNS
 
| The duration of one full cycle (Nanoseconds)
 
| The duration of one full cycle (Nanoseconds)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 558: Line 1,039:
  
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function PWMGetCount:LongWord; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function PWMGetCount:LongWord;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current PWM count</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current PWM count</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 570: Line 1,051:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function PWMDeviceGetDefault:PPWMDevice; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function PWMDeviceGetDefault:PPWMDevice;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default PWM device</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default PWM device</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 587: Line 1,068:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 599: Line 1,080:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function PWMTypeToString(PWMType:LongWord):String;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a PWM type value to a string</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function PWMStateToString(PWMState:LongWord):String;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a PWM state value to a string</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function PWMModeToString(PWMMode:LongWord):String;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a PWM mode value to a string</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function PWMPolarityToString(PWMPolarity:LongWord):String;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a PWM polarity value to a string</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 
|-
 
|-
 
|}
 
|}
Line 611: Line 1,140:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 623: Line 1,152:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">procedure PWMLogWarn(PWM:PPWMDevice; const AText:String); inline;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 
|-
 
|-
 
|}
 
|}
Line 635: Line 1,176:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 647: Line 1,188:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
 
</div></div>
 
</div></div>
 
<br />
 
<br />
−
 
  
 
Return to [[Unit_Reference|Unit Reference]]
 
Return to [[Unit_Reference|Unit Reference]]

Latest revision as of 03:37, 15 December 2022

Return to Unit Reference


Description

Ultibo PWM Interface unit

Pulse Width Modulation (PWM) is a technique of encoding a pulsed signal so as to control the ratio of on to off by switching the signal between on and off at a very high rate.

This on and off switching allows control of the average power supplied to the load and therefore gives fine grained control of things such as motor speeds, lamp dimming and heating elements.

PWM is also used in many low power applications as well such as controlling servo motors and can even by used for audio applications such as class D amplifiers.

This unit deals with the usage of PWM for control applications (for audio applications see the Audio unit) and provides methods to control the state, frequency, duty cycle, range and mode of PWM host controllers. Not all devices support all of these concepts so this API includes a properties function to allow obtaining information about a PWM device and its capabilities.

Constants


PWM specific constants PWM_*
PWM_NAME_PREFIX = 'PWM'; Name prefix for PWM Devices


PWM device type PWM_TYPE_*
PWM_TYPE_NONE = 0;  
 
PWM_TYPE_MAX = 0;  


PWM device state PWM_STATE_*
PWM_STATE_DISABLED = 0;  
PWM_STATE_ENABLED = 1;  


PWM device flag PWM_FLAG_*
PWM_FLAG_NONE = $00000000;  
PWM_FLAG_GPIO = $00000001; Device supports Get/Set GPIO
PWM_FLAG_MODE = $00000002; Device supports Get/Set Mode
PWM_FLAG_RANGE = $00000004; Device supports Get/Set Range
PWM_FLAG_FREQUENCY = $00000008; Device supports Get/Set Frequency
PWM_FLAG_POLARITY = $00000010; Device supports Get/Set Polarity


PWM mode value PWM_MODE_*
PWM_MODE_MARKSPACE = 0; Standard PWM Mark/Space mode
PWM_MODE_BALANCED = 1; Balanced mode (Device specific)
PWM_MODE_SERIALIZED = 2; Serialized mode (Device specific)
 
PWM_MODE_MAX = 2;  


PWM polarity value PWM_POLARITY_*
PWM_POLARITY_NORMAL = 0;  
PWM_POLARITY_INVERSE = 1;  
 
PWM_POLARITY_MAX = 1;  


PWM logging PWM_LOG_*
PWM_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG; PWM debugging messages
PWM_LOG_LEVEL_INFO = LOG_LEVEL_INFO; PWM informational messages, such as a device being attached or detached
PWM_LOG_LEVEL_WARN = LOG_LEVEL_WARN; PWM warning messages
PWM_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR; PWM error messages
PWM_LOG_LEVEL_NONE = LOG_LEVEL_NONE; No PWM messages


Type definitions


PWM properties

PPWMProperties = ^TPWMProperties;

TPWMProperties = record

Flags:LongWord; Device flags (eg PWM_FLAG_MODE)
GPIO:LongWord;  
Mode:LongWord;  
Range:LongWord;  
Frequency:LongWord;  
Polarity:LongWord;  
DutyNS:LongWord;  
PeriodNS:LongWord;  
MinPeriod:LongWord;  

PWM enumeration callback

TPWMEnumerate = function(PWM:PPWMDevice; Data:Pointer):LongWord;

PWM notification callback

TPWMNotification = function(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;

PWM device start

TPWMDeviceStart = function(PWM:PPWMDevice):LongWord;

PWM device stop

TPWMDeviceStop = function(PWM:PPWMDevice):LongWord;

PWM device write

TPWMDeviceWrite = function(PWM:PPWMDevice; Value:LongWord):LongWord;

PWM device get GPIO

TPWMDeviceGetGPIO = function(PWM:PPWMDevice):LongWord;

PWM device set GPIO

TPWMDeviceSetGPIO = function(PWM:PPWMDevice; GPIO:LongWord):LongWord;

PWM device get mode

TPWMDeviceGetMode = function(PWM:PPWMDevice):LongWord;

PWM device set mode

TPWMDeviceSetMode = function(PWM:PPWMDevice; Mode:LongWord):LongWord;

PWM device get range

TPWMDeviceGetRange = function(PWM:PPWMDevice):LongWord;

PWM device set range

TPWMDeviceSetRange = function(PWM:PPWMDevice; Range:LongWord):LongWord;

PWM device get frequency

TPWMDeviceGetFrequency = function(PWM:PPWMDevice):LongWord;

PWM device set frequency

TPWMDeviceSetFrequency = function(PWM:PPWMDevice; Frequency:LongWord):LongWord;

PWM device get polarity

TPWMDeviceGetPolarity = function(PWM:PPWMDevice):LongWord;

PWM device set polarity

TPWMDeviceSetPolarity = function(PWM:PPWMDevice; Polarity:LongWord):LongWord;

PWM device configure

TPWMDeviceConfigure = function(PWM:PPWMDevice; DutyNS,PeriodNS:LongWord):LongWord;

PWM device get properties

TPWMDeviceGetProperties = function(PWM:PPWMDevice; Properties:PPWMProperties):LongWord;

PWM device

PPWMDevice = ^TPWMDevice;

TPWMDevice = record

Device Properties
Device:TDevice; The Device entry for this PWM
PWM Properties
PWMId:LongWord; Unique Id of this PWM in the PWM table
PWMState:LongWord; PWM state (eg PWM_STATE_ENABLED)
DeviceStart:TPWMDeviceStart; A Device specific DeviceStart method implementing the standard PWM device interface (Mandatory)
DeviceStop:TPWMDeviceStop; A Device specific DeviceStop method implementing the standard PWM device interface (Mandatory)
DeviceWrite:TPWMDeviceWrite; A Device specific DeviceWrite method implementing the standard PWM device interface (Mandatory)
DeviceGetGPIO:TPWMDeviceGetGPIO; A Device specific DeviceGetGPIO method implementing the standard PWM device interface (Or nil if the operation is not supported)
DeviceSetGPIO:TPWMDeviceSetGPIO; A Device specific DeviceSetGPIO method implementing the standard PWM device interface (Or nil if the operation is not supported)
DeviceGetMode:TPWMDeviceGetMode; A Device specific DeviceGetMode method implementing the standard PWM device interface (Or nil if the operation is not supported)
DeviceSetMode:TPWMDeviceSetMode; A Device specific DeviceSetMode method implementing the standard PWM device interface (Or nil if the operation is not supported)
DeviceGetRange:TPWMDeviceGetRange; A Device specific DeviceGetRange method implementing the standard PWM device interface (Or nil if the operation is not supported)
DeviceSetRange:TPWMDeviceSetRange; A Device specific DeviceSetRange method implementing the standard PWM device interface (Or nil if the operation is not supported)
DeviceGetFrequency:TPWMDeviceGetFrequency; A Device specific DeviceGetFrequency method implementing the standard PWM device interface (Or nil if the operation is not supported)
DeviceSetFrequency:TPWMDeviceSetFrequency; A Device specific DeviceSetFrequency method implementing the standard PWM device interface (Or nil if the operation is not supported)
DeviceGetPolarity:TPWMDeviceGetPolarity; A Device specific DeviceGetPolarity method implementing the standard PWM device interface (Or nil if the operation is not supported)
DeviceSetPolarity:TPWMDeviceSetPolarity; A Device specific DeviceSetPolarity method implementing the standard PWM device interface (Or nil if the operation is not supported)
DeviceConfigure:TPWMDeviceConfigure; A Device specific DeviceConfigure method implementing the standard PWM device interface (Mandatory)
DeviceGetProperties:TPWMDeviceGetProperties; A Device specific DeviceGetProperties method implementing the standard PWM device interface (Or nil if the default method is suitable)
Statistics Properties
GetCount:LongWord;  
SetCount:LongWord;  
WriteCount:LongWord;  
ConfigCount:LongWord;  
Driver Properties
Lock:TMutexHandle; Device lock
GPIO:LongWord; GPIO Pin
Mode:LongWord; Device Mode
Range:LongWord; Device Range
Frequency:LongWord; Clock Frequency
Polarity:LongWord; Output Polarity
DutyNS:LongWord; Duty Nanoseconds
PeriodNS:LongWord; Period Nanonseconds
Properties:TPWMProperties; Device properties
Internal Properties
Prev:PPWMDevice; Previous entry in PWM table
Next:PPWMDevice; Next entry in PWM table


Public variables


PWM logging

PWM_DEFAULT_LOG_LEVEL:LongWord = PWM_LOG_LEVEL_DEBUG; Minimum level for PWM messages. Only messages with level greater than or equal to this will be printed.
PWM_LOG_ENABLED:Boolean;


Function declarations


Initialization functions 

procedure PWMInit;
Description: Initialize the PWM unit and PWM device table
Note Called only during system startup


PWM functions 

function PWMDeviceStart(PWM:PPWMDevice):LongWord;
Description: Start the specified PWM device
PWM The PWM device to start
Return ERROR_SUCCESS if completed or another error code on failure 


function PWMDeviceStop(PWM:PPWMDevice):LongWord;
Description: Stop the specified PWM device
PWM The PWM device to stop
Return ERROR_SUCCESS if completed or another error code on failure 


function PWMDeviceWrite(PWM:PPWMDevice; Value:LongWord):LongWord;
Description: Write a value to the specified PWM device
PWM The PWM device to write to
Value The value to write
Return ERROR_SUCCESS if completed or another error code on failure
Note The exact meaning of value may depend on the device and other configured options, in many cases the value will represent the "on" time of each pulse with regard to the duty cycle of the waveform output by the device. 


function PWMDeviceGetGPIO(PWM:PPWMDevice):LongWord;
Description: Get the GPIO pin used by the specified PWM device
PWM The PWM device to get the GPIO pin from
Return The current GPIO pin or GPIO_PIN_UNKNOWN on failure 


function PWMDeviceSetGPIO(PWM:PPWMDevice; GPIO:LongWord):LongWord;
Description: Set the GPIO pin used by the specified PWM device
PWM The PWM device to set the GPIO pin for
GPIO The GPIO pin to set (eg GPIO_PIN_12)
Return ERROR_SUCCESS if completed or another error code on failure 


function PWMDeviceGetMode(PWM:PPWMDevice):LongWord;
Description: Get the current mode of the specified PWM device
PWM The PWM device to get the mode from
Return The current mode or a default value of PWM_MODE_MARKSPACE 


function PWMDeviceSetMode(PWM:PPWMDevice; Mode:LongWord):LongWord;
Description: Set the current mode for the specified PWM device
PWM The PWM device to set the mode for
Mode The mode value to set (eg PWM_MODE_MARKSPACE)
Return ERROR_SUCCESS if completed or another error code on failure 


function PWMDeviceGetRange(PWM:PPWMDevice):LongWord;
Description: Get the current range of the specified PWM device
PWM The PWM device to get the range from
Return The current range or 0 on failure 


function PWMDeviceSetRange(PWM:PPWMDevice; Range:LongWord):LongWord;
Description: Set the current range for the specified PWM device
PWM The PWM device to set the clock rate for
Range The range value to set
Return ERROR_SUCCESS if completed or another error code on failure
Note The exact meaning of range may depend on the device and other configured options, in many cases the range will represent the period of one full cycle of the waveform output by the device. 


function PWMDeviceGetFrequency(PWM:PPWMDevice):LongWord;
Description: Get the clock frequency of the specified PWM device
PWM The PWM device to get the clock frequency from
Return The clock frequency in Hz or 0 on failure 


function PWMDeviceSetFrequency(PWM:PPWMDevice; Frequency:LongWord):LongWord;
Description: Set the clock frequency for the specified PWM device
PWM The PWM device to set the clock frequency for
Frequency The clock frequency to set in Hz
Return ERROR_SUCCESS if completed or another error code on failure 


function PWMDeviceGetPolarity(PWM:PPWMDevice):LongWord;
Description: Get the current polarity of the specified PWM device
PWM The PWM device to get the polarity from
Return The current polarity or a default value of PWM_POLARITY_NORMAL 


function PWMDeviceSetPolarity(PWM:PPWMDevice; Polarity:LongWord):LongWord;
Description: Set the current polarity for the specified PWM device
PWM The PWM device to set the polarity for
Polarity The polarity value to set (eg PWM_POLARITY_NORMAL)
Return ERROR_SUCCESS if completed or another error code on failure 


function PWMDeviceConfigure(PWM:PPWMDevice; DutyNS,PeriodNS:LongWord):LongWord;
Description: Set the configuration of the specified PWM device
PWM The PWM device to set the configuration for
DutyNS The "on" time part of the cycle (Nanoseconds)
PeriodNS The duration of one full cycle (Nanoseconds)
Return ERROR_SUCCESS if completed or another error code on failure 


function PWMDeviceProperties(PWM:PPWMDevice; Properties:PPWMProperties):LongWord; inline;
Description: Get the properties for the specified PWM device
PWM The PWM device to get properties from
Properties Pointer to a TPWMProperties structure to fill in
Return ERROR_SUCCESS if completed or another error code on failure
Note Replaced by PWMDeviceGetProperties for consistency 


function PWMDeviceGetProperties(PWM:PPWMDevice; Properties:PPWMProperties):LongWord;
Description: Get the properties for the specified PWM device
PWM The PWM device to get properties from
Properties Pointer to a TPWMProperties structure to fill in
Return ERROR_SUCCESS if completed or another error code on failure 


function PWMDeviceCreate:PPWMDevice;
Description: Create a new PWM entry
Return Pointer to new PWM entry or nil if PWM could not be created 


function PWMDeviceCreateEx(Size:LongWord):PPWMDevice;
Description: Create a new PWM entry
Size Size in bytes to allocate for new PWM (Including the PWM entry)
Return Pointer to new PWM entry or nil if PWM could not be created 


function PWMDeviceDestroy(PWM:PPWMDevice):LongWord;
Description: Destroy an existing PWM entry
Note None documented 


function PWMDeviceRegister(PWM:PPWMDevice):LongWord;
Description: Register a new PWM in the PWM table
Note None documented 


function PWMDeviceDeregister(PWM:PPWMDevice):LongWord;
Description: Deregister a PWM from the PWM table
Note None documented 


function PWMDeviceFind(PWMId:LongWord):PPWMDevice;
Description: To be documented
Note None documented 


function PWMDeviceFindByName(const Name:String):PPWMDevice; inline;
Description: To be documented
Note None documented 


function PWMDeviceFindByDescription(const Description:String):PPWMDevice; inline;
Description: To be documented
Note None documented 


function PWMDeviceEnumerate(Callback:TPWMEnumerate; Data:Pointer):LongWord;
Description: To be documented
Note None documented 


function PWMDeviceNotification(PWM:PPWMDevice; Callback:TPWMNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented
Note None documented


RTL PWM functions 

function SysPWMAvailable:Boolean;
Description: Check if a PWM device is available
Note None documented 


function SysPWMStart:LongWord;
Description: Start the default PWM device
Return ERROR_SUCCESS if completed or another error code on failure 


function SysPWMStop:LongWord;
Description: Stop the default PWM device
Return ERROR_SUCCESS if completed or another error code on failure 


function SysPWMWrite(Value:LongWord):LongWord;
Description: Write a value to the default PWM device
Value The value to write
Return ERROR_SUCCESS if completed or another error code on failure
Note The exact meaning of value may depend on the device and other configured options, in many cases the value will represent the "on" time of each pulse with regard to the duty cycle of the waveform output by the device. 


function SysPWMSetMode(Mode:LongWord):LongWord;
Description: Set the mode for the default PWM device
Mode The mode value to set (eg PWM_MODE_MARKSPACE)
Return ERROR_SUCCESS if completed or another error code on failure 


function SysPWMSetRange(Range:LongWord):LongWord;
Description: Set the range for the default PWM device
Range The range value to set
Return ERROR_SUCCESS if completed or another error code on failure
Note The exact meaning of range may depend on the device and other configured options, in many cases the range will represent the period of one full cycle of the waveform output by the device. 


function SysPWMSetFrequency(Frequency:LongWord):LongWord;
Description: Set the clock frequency for the default PWM device
Frequency The frequency to set in Hz
Return ERROR_SUCCESS if completed or another error code on failure 


function SysPWMConfigure(DutyNS,PeriodNS:LongWord):LongWord;
Description: Set the configuration of the default PWM device
DutyNS The "on" time part of the cycle (Nanoseconds)
PeriodNS The duration of one full cycle (Nanoseconds)
Return ERROR_SUCCESS if completed or another error code on failure


PWM helper functions 

function PWMGetCount:LongWord;
Description: Get the current PWM count
Note None documented 


function PWMDeviceGetDefault:PPWMDevice;
Description: Get the current default PWM device
Note None documented 


function PWMDeviceSetDefault(PWM:PPWMDevice):LongWord;
Description: Set the current default PWM device
Note None documented 


function PWMDeviceCheck(PWM:PPWMDevice):PPWMDevice;
Description: Check if the supplied PWM is in the PWM table
Note None documented 


function PWMTypeToString(PWMType:LongWord):String;
Description: Convert a PWM type value to a string
Note None documented 


function PWMStateToString(PWMState:LongWord):String;
Description: Convert a PWM state value to a string
Note None documented 


function PWMModeToString(PWMMode:LongWord):String;
Description: Convert a PWM mode value to a string
Note None documented 


function PWMPolarityToString(PWMPolarity:LongWord):String;
Description: Convert a PWM polarity value to a string
Note None documented 


procedure PWMLog(Level:LongWord; PWM:PPWMDevice; const AText:String);
Description: To be documented
Note None documented 


procedure PWMLogInfo(PWM:PPWMDevice; const AText:String); inline;
Description: To be documented
Note None documented 


procedure PWMLogWarn(PWM:PPWMDevice; const AText:String); inline;
Description: To be documented
Note None documented 


procedure PWMLogError(PWM:PPWMDevice; const AText:String); inline;
Description: To be documented
Note None documented 


procedure PWMLogDebug(PWM:PPWMDevice; const AText:String); inline;
Description: To be documented
Note None documented


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_PWM&oldid=5693"