楽しくやろう。

Raspberry Pi向けMicroPythonに実装中のPWMクラスのAPIについて、先日「どうするか検討中です」と書いたばかりですが、まさにこのタイミングでPWMクラスの仕様案が、開発者のD.P.Georgeさんから提示がありました。

docs/machine: Specify new class machine.PWM. by dpgeorge · Pull Request #4237 · micropython/micropython

概要

まだ「案」の段階ではありますが、内容はこんな感じです。

(1) 周波数は整数（freq）で指定、デューティ比は%で指定。デューティ比は%の値を16bit整数（duty_u16）で表現（65535=100%、0=0%）
(2) あるいはパルス全体の区間（period）とHighとなる区間（duty_ticks）をそれぞれ整数（tick）で表現。その場合は、tickを周波数に換算するパラメータ（tick_hz）も指定

例として、周波数1KHz、デューティ比25％にするには

p = PWM(freq=1000, duty_u16=16384)

となります。duty_u16の値は、デューティ比に0xffffUを乗じた値です。

また、同じ指定を

p = PWM(tick_hz=960000, duty_ticks=240, period=960)

とすることもできます。
この場合は、period=960が波ひとつ分で、tick_hzをperiodで割ると1000になりますので、周波数は1000Hzです。
peirodおよびduty_ticksは常にtick_hzと共に使う必要があります（でないと周波数が計算できない）。

タイマーとPWMの結びつけ

AVRやSTM32等のマイコンではPWMはタイマーの使い方の一種となっていますが、これを考慮してPWM生成に用いるタイマーオブジェクトをコンストラクタに与えることが可能です。
コンストラクタの仕様は

PWM.init(dest, \*, freq, period, tick_hz, duty_ticks, duty_u16, block)

となっており、destがPinオブジェクト、blockがタイマーオブジェクトを指定する部分になります。

Raspberry Piの場合はタイマーを指定することはできませんので、blockは必要ありませんが。

クロック関連のパラメータ

クロック関連の指定はPWMクラスでは行えません。tick_hzはクロックを指定していると読めなくもないですが、Georgeさんの想定ではtick_hzはハードウェアに対する設定ではなく、PWMインスタンス内でperiodを時間に換算するためのパラメータだということです。

従って、Raspberry Piではクロック源やプリスケーラはPWMクラスではなく外部で行うほうが、他のプラットフォームとの整合性は高そうです。

作成途中のPWMクラスは、この仕様に沿って書き直してみる予定です。

Raspberry Pi Zero WのPWMの後にローパスフィルターを付けて、DA変換でオーディオ帯域の信号を出力してみました。
これはGPIOピンに以下のようなRCからなるLPFを付加するもので、機能的にはZero以外のRaspberry Piのオーディオジャックと同等（実際には、これ以外にバッファICとカップリングコンデンサが付きます）です。
フィルタのカットオフ周波数は15KHzくらいです。

Raspberry Pi Zeroにはオーディオジャックが無いので、このような回路が必要になります。Zero以外のRaspberry Piでは以下のような回路がもともと搭載されています。

DA変換は、出力したいアナログ量をPWMのデューティ比として指定するだけです。
アナログ量はどんどん変化していきますので、dataを都度設定するのではなく、FIFOバッファを使ってあらかじめデータを用意しておきます。

先日作成したMicroPython版のPWMドライバに、以下のようなメソッドを追加しました。

アドレス0x2020c018に値を書き込むと、FIFOバッファにその値が追加されます。
バッファが満杯になると0x2020c004のbit 0が1になりますので、0になるまで待ちます。
なお、FIFOバッファは2つのPWMで共通になっており、1つしかありません。
2つのPWMをオーディオの左右チャンネルとして使う場合、同じ値を2度書き込めばモノラル出力が得られることになります。

波形データとして鋸波、矩形波、三角波を作成してGPIO18に出力してみました。
プログラムは以下のとおりです。（PWMクラス等は省略しています）

各波形は64サンプルで構成しています。
PWMのクロックは9.6MHz（19.2MHzを1/2に分周）、rangeは256としています。
従ってPWMの搬送波は9600KHz/256 = 37.5KHzで、これがDAのサンプリング周波数になります。
ローパスフィルタは15KHzなので、ぎりぎりカットできる周波数です。

波形データは64サンプルなので、出力される周波数は37500 / 64 = 約586Hzとなります。
サンプルの値の最大値はrange-1ですので、サンプルの値は0～255、つまり量子化ビット数は8bitとなります。
プログラムでは、3つの波形を1000回（1000/586 = 約1.7秒）再生することを繰り返しています。

以下は、出力結果をオシロで見たものです。



何とか波形になっていますが、そこそこの品質の音を出力するには、range=量子化ビット数を10bitは欲しいところですし、サンプリングレートも32KHz以上は欲しいところです。
そうすると最低でも32MHzの制御クロックとなりますから、OSCをクロック源にするのでは不足で、その約10倍の周波数を持つHDMIクロックあたりが適当かもしれません。

Raspberry PiのハードウェアPWMを制御するクラスをMicroPythonで書いたものが動作しましたので、次はこのクラスをCで再度実装し、MicroPythonのネイティブクラスにしました。

ロジックはほぼそのまま使用していますが、MicroPython版との差分としては

・freq()メソッドを省略（もともとハードウェアの仕様として、PWMのインスタンスごとに周波数の設定を変更できないため）
・duty()とdata()が実質的に同じなのでduty()を省略
・定数DEFAULT_RANGEは省略（rangeの値自体はrange()で取得可能）
・rangeとdataをインスタンス生成時に指定可能とする
・インスタンス生成時にデフォルトでdata=480（デューティ比50%）とする

としました。また、PWMクラスはmachineモジュール内に入れました。

・クロック周波数のデフォルトは960KHzとする（クロック源をOSC（19.2MHz）とし、プリスケーラを20に設定）
・インスタンス生成時にデフォルトでrange=960とする（周波数1KHzとなります）

は変わっていません。

新規に追加したファイルがこちら、既存のファイルに対する修正がこちらになります。
ロジックを事前に検証済みでしたので、基本的なところは一発で動作しました。
しかしインスタンス生成やプリントアウトのコードが増えているとはいえ、MicroPythonで書くのと比べるとだいぶ行数が多いです。

使い方の例としては以下のようになります。

実行すると前々回と同様に1KHzでデューティ比が連続的に変化する波形を生成します。
Raspberry Pi Zeroでは音声出力ジャックはありませんが、GPIO18に圧電ブザーを接続すれば音が鳴ります。

現時点の積み残し項目は

・FIFOサポート
・クロックの変更

で、これらはいずれもインスタンス単体ではなく、PWM全体に対するパラメータ設定になりますので、別途実装しようと思います。
他の言語だとPWMクラスのクラスメソッドにするのが適切なような気がしますが、何だかPythonってクラスメソッドの影が薄い（言語仕様上は存在しますが）ような気がするので、どうするか検討中です。