BBBのPWMSSモジュールの使い方

概要

BeagleBone Blackに搭載されているAM335xのPWMSS(Pulse-Width Modulation Subsystem)を使用する方法について説明する。
kernel 4.19.94-ti-r42を前提とする。
AM335xには、3個のPWMSSが搭載されている。PWMSSはモードによって以下の機能を提供する。クロックは100MHzとなっており、DMTimerよりも高速な処理が必要な場合に用いることが出来る。

• eHRPWM
  PWM信号の生成。タイマーは16bitで、出力A/Bの2本。他のPWMSSと同期を取ることも可能。
• eCAP
  時間計測、所定周波数の発生。タイマーは32bitで、入出力は1本。 タイマーのラップアラウンド時に信号を発生させることでPWMを発生する事も可能。
• eQEP
  2Phaseロータリーエンコーダー(基準位置信号対応可)のデコード、ポジション、速度検出。

それぞれの機能で入出力ピンが異なっており、それらがマルチプレクサを介してヘッダーに出ている為、機能ごとに分けて説明する。
機会があれば追々調べて行こうと思うが、差し当たり当方で使いたかったeCAP機能について調べた結果を以下に示す。
詳細についてはTexas Instruments提供のAM335x and AMIC110 Sitara Processors Technical Reference Manualを参照の事。

設定方法

ubootの設定

BBBの場合、ピンヘッダに入出力ピンが出ており、dtbの設定で割り当てを何通りか変更できるため、どのピンを使用するかを予め検討しておく必要がある。
dtbファイルで必要な入出力ピンを有効にしておく。あるいは、一時的にであれば、universal capeをenableにしておき、config-pinコマンドでtimerに割り当てる事でも設定可能(だとおもう)。
以下に、関連するMux設定の抜粋を示す。詳細はBBBのリッファレンスマニュアルを参照の事。

eHPWM

P9.42は2つのGPIOで共有されているので、使用しない方はハイインピーダンス状態としておく必要がある。

eCAP

P9.28はデフォルトでHDMIの音声出力に割り当てられているのでHDMIをdisableにしておく必要がある。
P9.42は2つのGPIOで共有されているので、使用しない方はハイインピーダンス状態としておく必要がある。

eCAP1は内部でJ1のUART0_TXに接続されており、cape managerでこのピンは設定を変更する機能が提供されていない為使用できない。従って、BBBで利用できるのはeCAP0とeCAP2の2つとなる。

以下のdtsファイルを作成した。

/dts-v1/;
/plugin/;
  
/ {
    compatible = "ti,beaglebone", "ti,beaglebone-black";
  
    /* identification */
    part-number = "BB-eCAP";
    version = "00A0";
  
    exclusive-use =
        "P9.42",
        "P9.28",
        "eCAP0_in_PWM0_out",
        "eCAP2_in_PWM2_out";

    fragment@0 {
        target = <&am33xx_pinmux>;
        __overlay__ {
            ecap0_gpio: pinmux_ecap0_pins {
                pinctrl-single,pins = <
                    0x164 0x28  /* (IN|PU_DIS|MODE0)=(0 01 000) eCAP0_in_PWM0_out P9.42 */
                >;
            };
            ecap2_gpio: pinmux_ecap2_pins {
                pinctrl-single,pins = <
                    0x19C 0x2c  /* (IN|PU_DIS|MODE4)=(0 01 100) eCAP2_in_PWM2_out_mux1 P9.28 */
                >;
            };
            gpio3_gpio: pinmux_gpio3_pins {
                pinctrl-single,pins = <
                    0x1A0 0x2f  /* (IN|PU_DIS|MODE7)=(1 01 111) gpio3[18], set Hi-Z P9.42 */
                >;
            };
        };
    };

  
    fragment@1 {
        target = <&ocp>;
        __overlay__ {
            bb_ecap0 {
                compatible      = "bb-ecap";
                pwms            = <&ecap0 0 0 1>;
                pwm-names       = "ECAP0";
                pinctrl-names   = "default";
                pinctrl-0       = <&ecap0_gpio>;
                enabled         = <1>;
                duty            = <0>;
                status          = "okay";
            };
            bb_ecap2 {
                compatible      = "bb-ecap";
                pwms            = <&ecap2 0 0 1>;
                pwm-names       = "ECAP2";
                pinctrl-names   = "default";
                pinctrl-0       = <&ecap2_gpio>;
                enabled         = <1>;
                duty            = <0>;
                status          = "okay";
            };
            bb_ecap0_gpio_helper: ecap0_gpio_helper {
                compatible      = "bone-pinmux-helper";
                pinctrl-names   = "default";
                pinctrl-0       = <&ecap0_gpio>;
                status          = "okay";
            };
            bb_ecap2_gpio_helper: ecap2_gpio_helper {
                compatible      = "bone-pinmux-helper";
                pinctrl-names   = "default";
                pinctrl-0       = <&ecap2_gpio>;
                status          = "okay";
            };
            bb_gpio3_gpio_helper: gpio3_gpio_helper {
                compatible      = "bone-pinmux-helper";
                pinctrl-names   = "default";
                pinctrl-0       = <&gpio3_gpio>;
                status          = "okay";
            };
        };
    };
  
    fragment@2 {
        target = <&pruss>;
        __overlay__ {
            status          = "okay";
        };
    };
};

一時的にであれば、config-pinコマンドで次のように設定すればよい模様。
PRUから操作する場合はpru_ecapにする必要があるかも。
GPIO3_18については、この場合どういう設定になるのかよくわからないが、GPIOはデフォルトでinputになっているので、特に弄っていなければ、問題はないだろう。
P9.28には、pwmとpwm2という選択肢があるが、pwm2にしないと動作しなかった。どういった違いがあるのかは調べていない。

root@beaglebone:/sys/class/pwm/pwm-6:0# config-pin -l P9.28

Available modes for P9_28 are: default gpio gpio_pu gpio_pd gpio_input spi_cs pwm pwm2 pruout pruin

root@beaglebone:/sys/class/gpio/gpio7# config-pin P9.28 pwm2

Current mode for P9_28 is:     pwm2

root@beaglebone:/sys/class/pwm/pwm-6:0# config-pin -l P9.42

Available modes for P9_42 are: default gpio gpio_pu gpio_pd gpio_input spi_cs spi_sclk uart pwm pru_ecap

root@beaglebone:/sys/class/gpio/gpio7# config-pin P9.42 pwm

Current mode for P9_42 is:     pwm

さしあたり、この設定でPWMの出力が出来るかテストする。
eCAP0, eCAP2がどのデバイスツリーに紐づけられているのか、kernel versionによって異なっていたりして明確な資料が見つからないが、 実機を調べると、メモリアドレスとリンク先のデバイス名が一致している模様。
つまり、pwm-0:0がeCAP0、pwm-6:0がeCAP2ということのようだ。
周期はnsec指定、duty cycleは1/10000%で指定する。

この結果右図のような出力が得られた。eCAP0とeCAP2の開始時期は同期していないので毎回ズレるが、レジスタで同期機能を設定すれば同期させることもできるだろう。

root@beaglebone:/sys/class/pwm# ls -l
total 0
lrwxrwxrwx 1 root root 0 Jan 17 13:31 pwm-0:0 -> ../../devices/platform/ocp/48300000.epwmss/48300100.ecap/pwm/pwmchip0/pwm-0:0
lrwxrwxrwx 1 root root 0 Jan 17 13:31 pwm-1:0 -> ../../devices/platform/ocp/48300000.epwmss/48300200.pwm/pwm/pwmchip1/pwm-1:0
lrwxrwxrwx 1 root root 0 Jan 17 13:31 pwm-1:1 -> ../../devices/platform/ocp/48300000.epwmss/48300200.pwm/pwm/pwmchip1/pwm-1:1
lrwxrwxrwx 1 root root 0 Jan 17 13:31 pwm-3:0 -> ../../devices/platform/ocp/48302000.epwmss/48302100.ecap/pwm/pwmchip3/pwm-3:0
lrwxrwxrwx 1 root root 0 Jan 17 13:31 pwm-4:0 -> ../../devices/platform/ocp/48302000.epwmss/48302200.pwm/pwm/pwmchip4/pwm-4:0
lrwxrwxrwx 1 root root 0 Jan 17 13:31 pwm-4:1 -> ../../devices/platform/ocp/48302000.epwmss/48302200.pwm/pwm/pwmchip4/pwm-4:1
lrwxrwxrwx 1 root root 0 Jan 17 13:31 pwm-6:0 -> ../../devices/platform/ocp/48304000.epwmss/48304100.ecap/pwm/pwmchip6/pwm-6:0
lrwxrwxrwx 1 root root 0 Jan 17 13:31 pwm-7:0 -> ../../devices/platform/ocp/48304000.epwmss/48304200.pwm/pwm/pwmchip7/pwm-7:0
lrwxrwxrwx 1 root root 0 Jan 17 13:31 pwm-7:1 -> ../../devices/platform/ocp/48304000.epwmss/48304200.pwm/pwm/pwmchip7/pwm-7:1
lrwxrwxrwx 1 root root 0 Jan 17 13:31 pwmchip0 -> ../../devices/platform/ocp/48300000.epwmss/48300100.ecap/pwm/pwmchip0
lrwxrwxrwx 1 root root 0 Jan 17 13:31 pwmchip1 -> ../../devices/platform/ocp/48300000.epwmss/48300200.pwm/pwm/pwmchip1
lrwxrwxrwx 1 root root 0 Jan 17 13:31 pwmchip3 -> ../../devices/platform/ocp/48302000.epwmss/48302100.ecap/pwm/pwmchip3
lrwxrwxrwx 1 root root 0 Jan 17 13:31 pwmchip4 -> ../../devices/platform/ocp/48302000.epwmss/48302200.pwm/pwm/pwmchip4
lrwxrwxrwx 1 root root 0 Jan 17 13:31 pwmchip6 -> ../../devices/platform/ocp/48304000.epwmss/48304100.ecap/pwm/pwmchip6
lrwxrwxrwx 1 root root 0 Jan 17 13:31 pwmchip7 -> ../../devices/platform/ocp/48304000.epwmss/48304200.pwm/pwm/pwmchip7

root@beaglebone:/sys/class/pwm/pwm-0:0# ls
capture  device  duty_cycle  enable  period  polarity  power  subsystem  uevent
root@beaglebone:/sys/class/pwm/pwm-0:0# echo 1000000 > period
root@beaglebone:/sys/class/pwm/pwm-0:0# echo 1 > enable
root@beaglebone:/sys/class/pwm/pwm-0:0# echo 25000 > duty_cycle
root@beaglebone:/sys/class/pwm/prm-0:0# cd ../pwm-6\:0
root@beaglebone:/sys/class/pwm/pwm-6:0# echo 1000000 > period
root@beaglebone:/sys/class/pwm/pwm-6:0# echo 500000 > duty_cycle
root@beaglebone:/sys/class/pwm/pwm-6:0# echo 1 > enable

eQEP

P9.41, P9.42は2つのGPIOで共有されているので、使用しない方はハイインピーダンス状態としておく必要がある。

PWMSS moduleのenable

PWMSS moduleはデフォルトでdisableになっているので、CM_PER registerのCM_PER_EPWMSSx_CLKCTRLレジスタで有効に設定する必要がある。
この設定を行わないと、PWMSS関連レジスタへのアクセスもBus errorになる。

以下のレジスタは基本的に触る必要は無い。

eCAP Functionの動作

さらに、CaptureモードとAPWMモードがある。
入出力はモードによって決まる。

Capture modeでは入力信号はプリスケーラーで分周した後、立ち上がり、立下りの何れか、若しくは双方を対象にTSCTRレジスタの値がCAP1-CAP4まで順次保存される。
TSCTRレジスタはクロック若しくは同期信号によるフリーランカウンタで、オーバーフロー時はCTR_OVFがセットされる。
計測が完了した際、割込みを発生させることが出来る。CAPxレジスタの時刻を比較する事で、周期若しくは周波数を計算できる。

使用例

続いて代表的な使用例について見ていく。
簡単なライブラリを作ったので、レジスタのmmapとオフセット計算はライブラリに任せることにする。main関数のみ解説するので、詳細はソースを見てほしい。

PWMの出力(eHPWM)

任意周波数/デューティー比の出力(eCAP)

ECCTL1レジスタは次のような設定となる。

• FREE_SOFT = 0(TSCTR counter stops immediately on emulation suspend)
• PRESCALE = 0(Disable)
• CAPLDEN = 0(Disable)
• CTRRST4 = 0(Disable)
• CAP4POL = 0(Rising edge)
• CTRRST3 = 0(Disable)
• CAP3POL = 0(Rising edge)
• CTRRST2 = 0(Disable)
• CAP2POL = 0(Rising edge)
• CTRRST1 = 0(Disable)
• CA14POL = 0(Rising edge)

ECCTL1レジスタは次のような設定となる。

• APWMPOL = 0(Active high)
• CAP_APWM = 1(PWM mode)
• SWSYNC = 0
• SYSCO_SEL = 0(pass through)
• SYNCI_EN = 0(Disable sync-in)
• TSCTRSTOP = 1(Running)
• RE-ARM = 0
• STOP_WRAP = 0
• CONT_ONESHT = 0

周期とデューティー比はCAP1, CAP2で指定する。
Cycle=CAP1[10^-8 sec], Duty retio=CAP2/CAP1

#include 
#include 
#include 

int main(void){
    if(bbb_pwmss_init()){
        fprintf(stderr, "Can not initialize pwmss lib\n");
        return(1);
    }
    ecap_reg *ECAP = (ecap_reg *)(PWMSS[0]+eCAP_off);

    // Set ECCTL1
    ECAP->ECCTL1 = (uint16_t)0;                         // Set 0x48300128 to 0x0
    // Set ECCTL2
    ECAP->ECCTL2 = (uint16_t)(F_CAP_APWM|F_TSCTRRUN);   // Set 0x4830012A to 0x110
    // Set interrupt
    ECAP->ECEINT = (uint16_t)(F_CNTOVF|F_CEVT2);
    // Clear curent status
    ECAP->ECCLR = (uint16_t)0xffff;

    // period = 1msec, duty = 25%
    ECAP->CAP1 = 100000;
    ECAP->CAP2 = 25000;

    bbb_pwmss_free();
    return(0);
}

時間測定/周期測定(eCAP)

Capture modeに設定し、入力信号でTCCTRの値をキャプチャさせる。
シングルキャプチャモードで、TCCTRの値をCAP1, CAP2にキャプチャしこの差が周期となる。
CAP2のキャプチャが完了で、TCCTRのリセットを行い、測定値を読み込んだ後、プログラムで割込みフラグをリセットしRE-ARMで次の測定を開始させる。

TCRRがオーバーフローした際は0に戻るので、この場合は入力信号の周期が長すぎて計測不可であることを示す。

クロック周波数が100MHzでカウンタが32bitあるので、0-1MHz程度まで1%程度の精度で計測する事が可能だ。

ECCTL1レジスタは次のような設定となる。

• FREE_SOFT = 0(TSCTR counter stops immediately on emulation suspend)
• PRESCALE = 0(Disable)
• CAPLDEN = 1(Enable)
• CTRRST4 = 0(Disable)
• CAP4POL = 0(Rising edge)
• CTRRST3 = 0(Disable)
• CAP3POL = 0(Rising edge)
• CTRRST2 = 1(Enable)
• CAP2POL = 0(Rising edge)
• CTRRST1 = 0(Disable)
• CA14POL = 0(Rising edge)

ECCTL1レジスタは次のような設定となる。

• APWMPOL = 0
• CAP_APWM = 0(capture mode)
• SWSYNC = 0
• SYSCO_SEL = 0(pass through)
• SYNCI_EN = 0(Disable sync-in)
• TSCTRSTOP = 1
• RE-ARM = 0
• STOP_WRAP = 1(Stop after Capture Event2)
• CONT_ONESHT = 1(one-shot mode)

割り込みは使っても使わなくても、ステータスフラグをチェックすれば実装は可能だが、INTフラグを利用した方がプログラムが簡潔に書ける と感じたので、以下のように設定した。割り込みと言っても、INTフラグがセットされるだけでプログラムやOSに割り込みが欠けられるわけでは無い。 PRUや他のペリフェラルと連携させる場合、HW割り込みが有効なケースはあるかもしれない。

• CMPEQ = 0
• PRDEQ = 0
• CNTOVF = 0
• CEVT4 = 0
• CEVT3 = 0
• CEVT2 = 0
• CEVT1 = 0

#include <stdint.h>
#include <stdio.h>
#include <pwmss.h>

int main(void){
    if(bbb_pwmss_init()){
        fprintf(stderr, "Can not initialize pwmss lib\n");
        return(1);
    }
    ecap_reg *ECAP = (ecap_reg *)(PWMSS[0]+eCAP_off);

    // Set ECCTL1
    ECAP->ECCTL1 = (uint16_t)(F_CAPLDEN|F_CTRRST2);                              // Set 0x48300128 to 0x108
    // Set ECCTL2
    ECAP->ECCTL2 = (uint16_t)(F_TSCTRRUN|F_STOP_WRAP2|F_CONT_ONESHT|F_REARM);    // Set 0x4830012A to 0x13
    // Set interrupt
    ECAP->ECEINT = (uint16_t)(F_CNTOVF|F_CEVT2);
    // Clear curent status
    ECAP->ECCLR = (uint16_t)0xffff;

    while(1){
        if(ECAP->ECFLG & F_INT){
            if(ECAP->ECFLG & F_CNTOVF){ // counter over flow
                printf("0 Hz\n");
            }
            else{
                printf("%.2f Hz\n", (float)AM335x_PWMSS_CLK/(ECAP->CAP2 - ECAP->CAP1));
            }
            ECAP->ECCLR = (uint16_t)0xffff;
            ECAP->ECCTL2 |= (uint16_t)F_REARM;
        }
    }

    // not reach
    bbb_pwmss_free();
    return(0);
}

直交符号のデコード

ソースファイル