Difference between revisions of "PWM"

From ArmadeusWiki
Jump to: navigation, search
(Usage)
(Usage)
 
(61 intermediate revisions by 6 users not shown)
Line 1: Line 1:
On this page, you will find usefull informations to configure and use the Pulse Width Modulation (PWM) capabilities of your APF9328 board.
+
On this page, you will find usefull informations to configure and use the Pulse Width Modulation (PWM) capabilities of your APF boards.
  
Your is capable of driving 2 PWM signals:
+
The i.MX processors are able to drive 2 types of PWM signals:
* one is linked to the LCD controller and allow to control LCD backlight, see LCD page for more informations
+
* one that is linked to the LCD controller and allows controlling the [[BackLight | LCD backlight]] (fixed frequency)
* the other can be used to generate PWM signals in several mode:
+
* the other can be used to generate a PWM signal in several mode:
* audio playback
+
** audio playback
* real PWM
+
** real PWM
  
== Configuration ==
+
==Hardware==
First be sure to have the PWM Linux driver activated:
+
PWM pin detail for each APF boards can be found [[Hardware|here]] (under 'BaseBoards' section).
$ make linux-menuconfig
+
On [[APF28Dev]] for example, PWM4 is on connector J10 at pin 26.
  
[[Image:PWMconfig.png]]
+
== Linux driver installation ==
 +
i.MX PWM driver is installed by default in standard Armadeus rootfs.
 +
{{Note|On [[APF51Dev]], as PWM outputs/pins are multiplexed and used as user LED and button by default, you may have to define APF51DEV_USE_LED_AS_PWM or APF51DEV_USE_SWITCH_AS_PWM in Linux sources (''arch/arm/mach-mx5/apf51dev-baseboard.c''), rebuild and reflash the Linux kernel.}}
  
$ make
+
{{Note|On [[APF6Dev]], as PWM outputs is by default used for LCD's backlight control, you may have to modify APF6Dev device tree in Linux sources (''arch/arm/boot/dts/imx6qdl-apf6dev.dtsi''), rebuild and reflash the imx6q-apf6dev.dtb file.}}
 
+
== Installation ==
+
Either copy generated module target/linux/modules/pwm/pwm.ko to your system with TFTP or NFS or reflash the generated rootfs
+
  
 
== Usage ==
 
== Usage ==
Load the module:
+
* Load the driver ([[APF9328]], [[APF27]], [[APF51]]):
# /lib/modules/2.6.18.1/extra/pwm/pwm.ko
+
<pre class="apf">
 +
# modprobe imx-pwm
 +
i.MX PWM driver v0.81
 +
imx-pwm imx-pwm.0: initialized
 +
</pre>
 +
* On [[APF28]] with 2.6.35 kernel and on [[APF6]] & [[OPOS6UL]], the PWM driver is builtin so no need to load it before use.
 +
* For the one who plan to use sound, ''/dev/pwm0'' device file should be automatically created.
  
Now you have access to /sys/class/pwm/ functionnalities:
+
=== PWM Mode ===
* to activate PWM:
+
 
# echo 1 > /sys/class/pwm/pwm0/active
+
{{Note|The PWM has a resolution of 1uS}}
* to de-activate PWM:
+
 
# echo 0 > /sys/class/pwm/pwm0/active
+
After driver loading, you have access to ''/sys/class/pwm/...'' functionalities:
 +
 
 +
{| border="1" cellpadding="10" cellspacing="0" summary="PWM usage depending on kernel version" class="wikitable"
 +
|- style="background:#efefef;" align="center"
 +
! 2.6 kernels || 3.x+ kernels
 +
|-----
 +
 
 +
|<pre class="apf">
 +
export PWM=pwm0    (on APF9328/APF27/APF51)
 +
export PWM=pwm4    (on APF28Dev)
 +
</pre>
 
* to change frequency (for example 500 Hz):
 
* to change frequency (for example 500 Hz):
  # echo 500 > /sys/class/pwm/pwm0/frequency
+
<pre class="apf">
* to change period (for example 100us):
+
  # echo 500 > /sys/class/pwm/$PWM/frequency
  # echo 100 > /sys/class/pwm/pwm0/period
+
</pre>
 +
* if you prefer working with periods (for example 100us):
 +
<pre class="apf">
 +
  # echo 100 > /sys/class/pwm/$PWM/period
 +
</pre>
 
* to change duty cycle (for example 50.0%)
 
* to change duty cycle (for example 50.0%)
  # echo 500 > /sys/class/pwm/pwm0/duty
+
<pre class="apf">
 +
  # echo 500 > /sys/class/pwm/$PWM/duty
 +
</pre>
 +
* to activate PWM:
 +
<pre class="apf">
 +
# echo 1 > /sys/class/pwm/$PWM/active
 +
</pre>
 +
* to de-activate PWM:
 +
<pre class="apf">
 +
# echo 0 > /sys/class/pwm/$PWM/active
 +
</pre>
  
Audio playback mode is not fully functionnal/tested yet. Ask JulienB if you really need it...
+
||<pre class="apf">
 +
export PWM_CHIP=pwmchip2    (on APF6Dev)
 +
export PWM_CHIP=pwmchip0    (on APF9328Dev/APF27Dev/APF51Dev/APF28Dev/OPOS6UL)
 +
 
 +
export PWM=0    (on APF9328Dev/APF27Dev/APF51Dev/APF6Dev/OPOS6UL)
 +
export PWM=4    (on APF28Dev)
 +
</pre>
 +
* declare the PWM we will use:
 +
<pre class="apf">
 +
# echo ${PWM} > /sys/class/pwm/${PWM_CHIP}/export
 +
</pre>
 +
* to have a 100uS period:
 +
<pre class="apf">
 +
# echo 100000 > /sys/class/pwm/${PWM_CHIP}/pwm${PWM}/period
 +
</pre>
 +
* to change duty cycle (for example 50% = 50us of 100us period)
 +
<pre class="apf">
 +
# echo 50000 > /sys/class/pwm/${PWM_CHIP}/pwm${PWM}/duty_cycle
 +
</pre>
 +
* to activate PWM:
 +
<pre class="apf">
 +
# echo 1 > /sys/class/pwm/${PWM_CHIP}/pwm${PWM}/enable
 +
</pre>
 +
* to de-activate PWM:
 +
<pre class="apf">
 +
# echo 0 > /sys/class/pwm/${PWM_CHIP}/pwm${PWM}/enable
 +
</pre>
 +
 
 +
|}
 +
 
 +
==== Bash test script (2.6 kernels) ====
 +
* A Bash test script is available given below. Just enter the desired frequency and duty cycle.
 +
<source lang="Bash">
 +
#!/bin/sh
 +
#
 +
# script to command imx pwm
 +
# usage : pwm_imx frequency duty
 +
#
 +
 
 +
if [ $# -lt 2 ]
 +
then
 +
echo "Provide two arguments to this script !"
 +
echo "pwm_imx frequency dutycycle"
 +
exit 1
 +
fi
 +
 
 +
SYS_DIR="/sys/class/pwm/pwm0/"
 +
FREQUENCY=$1
 +
DUTY=$2
 +
 
 +
DUTY=`(echo $DUTY | awk '{ print $1*10}')`
 +
 
 +
if [ ! -d "$SYS_DIR" ]; then
 +
echo "Can't find /sys/ interface for PWM"
 +
exit 1
 +
fi
 +
 
 +
echo "Starting PWM"
 +
echo 1 > $SYS_DIR/active
 +
 
 +
#SET FREQUENCY
 +
echo $FREQUENCY > $SYS_DIR/frequency
 +
echo "Setting PWM to $FREQUENCY Hz"
 +
 
 +
#SET DUTY CYCLE
 +
echo $DUTY > $SYS_DIR/duty
 +
echo "Setting DUTY to $2 %"
 +
 
 +
exit 0
 +
 
 +
</source>
 +
 
 +
* Other test script may be found in ''target/test/test_pwm.sh'' of your armadeus BSP
 +
 
 +
=== Audio Mode ===
 +
Audio playback mode is working since v0.5 of PWM driver (thanks to [[User:SebastienR|SebastienR]]).
 +
You can play 8, 16 & 32 KHz 8bit linear RAW sound. It's recommended to play 8kHz one, as they are using less CPU resources.
 +
To convert a sound to the right format we recommend to use SoX (on Linux).
 +
For example:
 +
[host]$ sox /usr/share/sounds/KDE_Chimes_1.ogg -r 8192 -b -u -c 1 Chimes.raw
 +
-r -> sampling rate
 +
-b -> byte/8bit signal
 +
-u -> linear /not compressed
 +
-c 1 -> Mono / 1 channel
 +
 
 +
Then you can test it using ''target/linux/modules/pwm/test/testplaymode'', which can be compiled that way:
 +
<pre class="host">
 +
$ make shell_env
 +
$ . armadeus_env.sh
 +
$ export PATH=$PATH:$ARMADEUS_TOOLCHAIN_PATH
 +
$ make -C target/linux/modules/pwm/test/
 +
$ cp target/linux/modules/pwm/test/testplaymode /tftpboot/
 +
$ cp target/linux/modules/pwm/test/KDE_Startup_2.raw /tftpboot/
 +
</pre>
 +
on target do:
 +
<pre class="apf">
 +
# testplaymode
 +
</pre>
 +
or
 +
<pre class="apf">
 +
# testplaymode KDE_Startup_2.raw
 +
</pre>
 +
 
 +
==Going further==
 +
If you need more than one PWM at a time, you can use the APF's FPGA with [[MotionSystem|the following project]].
  
 
== Links ==
 
== Links ==
*  
+
* [http://sox.sourceforge.net/Docs/FAQ SoX, sound format converter]
*
+
* http://en.wikipedia.org/wiki/Pulse-width_modulation
 +
 
 +
[[Category:Linux_drivers]]
 +
[[Category:ExternalDeviceControl]]

Latest revision as of 12:30, 10 February 2022

On this page, you will find usefull informations to configure and use the Pulse Width Modulation (PWM) capabilities of your APF boards.

The i.MX processors are able to drive 2 types of PWM signals:

  • one that is linked to the LCD controller and allows controlling the LCD backlight (fixed frequency)
  • the other can be used to generate a PWM signal in several mode:
    • audio playback
    • real PWM

Hardware

PWM pin detail for each APF boards can be found here (under 'BaseBoards' section). On APF28Dev for example, PWM4 is on connector J10 at pin 26.

Linux driver installation

i.MX PWM driver is installed by default in standard Armadeus rootfs.

Note Note: On APF51Dev, as PWM outputs/pins are multiplexed and used as user LED and button by default, you may have to define APF51DEV_USE_LED_AS_PWM or APF51DEV_USE_SWITCH_AS_PWM in Linux sources (arch/arm/mach-mx5/apf51dev-baseboard.c), rebuild and reflash the Linux kernel.


Note Note: On APF6Dev, as PWM outputs is by default used for LCD's backlight control, you may have to modify APF6Dev device tree in Linux sources (arch/arm/boot/dts/imx6qdl-apf6dev.dtsi), rebuild and reflash the imx6q-apf6dev.dtb file.


Usage

# modprobe imx-pwm
i.MX PWM driver v0.81
imx-pwm imx-pwm.0: initialized
  • On APF28 with 2.6.35 kernel and on APF6 & OPOS6UL, the PWM driver is builtin so no need to load it before use.
  • For the one who plan to use sound, /dev/pwm0 device file should be automatically created.

PWM Mode

Note Note: The PWM has a resolution of 1uS


After driver loading, you have access to /sys/class/pwm/... functionalities:

2.6 kernels 3.x+ kernels
export PWM=pwm0    (on APF9328/APF27/APF51)
export PWM=pwm4    (on APF28Dev)
  • to change frequency (for example 500 Hz):
 # echo 500 > /sys/class/pwm/$PWM/frequency
  • if you prefer working with periods (for example 100us):
 # echo 100 > /sys/class/pwm/$PWM/period
  • to change duty cycle (for example 50.0%)
 # echo 500 > /sys/class/pwm/$PWM/duty
  • to activate PWM:
 # echo 1 > /sys/class/pwm/$PWM/active
  • to de-activate PWM:
 # echo 0 > /sys/class/pwm/$PWM/active
export PWM_CHIP=pwmchip2    (on APF6Dev)
export PWM_CHIP=pwmchip0    (on APF9328Dev/APF27Dev/APF51Dev/APF28Dev/OPOS6UL)

export PWM=0    (on APF9328Dev/APF27Dev/APF51Dev/APF6Dev/OPOS6UL)
export PWM=4    (on APF28Dev)
  • declare the PWM we will use:
 # echo ${PWM} > /sys/class/pwm/${PWM_CHIP}/export
  • to have a 100uS period:
 # echo 100000 > /sys/class/pwm/${PWM_CHIP}/pwm${PWM}/period
  • to change duty cycle (for example 50% = 50us of 100us period)
 # echo 50000 > /sys/class/pwm/${PWM_CHIP}/pwm${PWM}/duty_cycle
  • to activate PWM:
 # echo 1 > /sys/class/pwm/${PWM_CHIP}/pwm${PWM}/enable
  • to de-activate PWM:
 # echo 0 > /sys/class/pwm/${PWM_CHIP}/pwm${PWM}/enable

Bash test script (2.6 kernels)

  • A Bash test script is available given below. Just enter the desired frequency and duty cycle.
#!/bin/sh
#
# script to command imx pwm 
# usage : pwm_imx frequency duty 
#

if [ $# -lt 2 ] 
then
echo "Provide two arguments to this script !"
echo "pwm_imx frequency dutycycle"
exit 1
fi

SYS_DIR="/sys/class/pwm/pwm0/"
FREQUENCY=$1
DUTY=$2

DUTY=`(echo $DUTY | awk '{ print $1*10}')`

if [ ! -d "$SYS_DIR" ]; then
echo "Can't find /sys/ interface for PWM"
exit 1
fi

echo "Starting PWM"
echo 1 > $SYS_DIR/active

#SET FREQUENCY
echo $FREQUENCY > $SYS_DIR/frequency
echo "Setting PWM to $FREQUENCY Hz"

#SET DUTY CYCLE
echo $DUTY > $SYS_DIR/duty
echo "Setting DUTY to $2 %"

exit 0
  • Other test script may be found in target/test/test_pwm.sh of your armadeus BSP

Audio Mode

Audio playback mode is working since v0.5 of PWM driver (thanks to SebastienR). You can play 8, 16 & 32 KHz 8bit linear RAW sound. It's recommended to play 8kHz one, as they are using less CPU resources. To convert a sound to the right format we recommend to use SoX (on Linux). For example:

[host]$ sox /usr/share/sounds/KDE_Chimes_1.ogg -r 8192 -b -u -c 1 Chimes.raw
-r -> sampling rate
-b -> byte/8bit signal
-u -> linear /not compressed
-c 1 -> Mono / 1 channel

Then you can test it using target/linux/modules/pwm/test/testplaymode, which can be compiled that way:

 $ make shell_env
 $ . armadeus_env.sh
 $ export PATH=$PATH:$ARMADEUS_TOOLCHAIN_PATH
 $ make -C target/linux/modules/pwm/test/
 $ cp target/linux/modules/pwm/test/testplaymode /tftpboot/
 $ cp target/linux/modules/pwm/test/KDE_Startup_2.raw /tftpboot/

on target do:

 # testplaymode

or

 # testplaymode KDE_Startup_2.raw

Going further

If you need more than one PWM at a time, you can use the APF's FPGA with the following project.

Links