rp2 --- RP2040 固有の機能

rp2 モジュールには、Raspberry Pi Pico で使用される RP2040 に固有の関数とクラスが含まれています。

詳細については RP2040 Python データシート を、サンプルコードについては pico-micropython-examples を参照してください。

PIO 関連の関数

rp2 モジュールには、PIO プログラムをアセンブルするための関数が含まれています。

PIO プログラムの実行については、rp2.StateMachine を参照してください。

rp2.asm_pio(*, out_init: 'int | tuple[int, ...] | None' = None, set_init: 'int | tuple[int, ...] | None' = None, sideset_init: 'int | tuple[int, ...] | None' = None, side_pindir: bool = False, in_shiftdir: int = PIO.SHIFT_LEFT, out_shiftdir: int = PIO.SHIFT_LEFT, autopush: bool = False, autopull: bool = False, push_thresh: int = 32, pull_thresh: int = 32, fifo_join: int = PIO.JOIN_NONE) → Callable

PIO プログラムをアセンブルします。

以下のパラメータは、GPIO ピンの初期状態を PIO.IN_LOW、PIO.IN_HIGH、PIO.OUT_LOW、PIO.OUT_HIGH のいずれかとして制御します。プログラムが複数のピンを使用する場合は、タプルを指定します。例えば out_init=(PIO.OUT_LOW, PIO.OUT_LOW) のようにします。

• out_init は out() 命令で使用されるピンを設定します。

• set_init は set() 命令で使用されるピンを設定します。最大で 5 つまで指定できます。

• sideset_init は .side() 修飾子で使用されるピンを設定します。最大で 5 つまで指定できます。

• side_pindir を True に設定すると、.side() 修飾子がピンの値（False のデフォルト時）ではなく、ピンの方向を制御するために使用されるように設定されます。

以下のパラメータはデフォルトで使用されますが、StateMachine.init() で上書きできます。

• in_shiftdir は ISR がシフトするデフォルトの方向で、PIO.SHIFT_LEFT または PIO.SHIFT_RIGHT のいずれかです。

• out_shiftdir は OSR がシフトするデフォルトの方向で、PIO.SHIFT_LEFT または PIO.SHIFT_RIGHT のいずれかです。

• push_thresh は、自動プッシュまたは条件付き再プッシュがトリガーされる前のしきい値（ビット単位）です。

• pull_thresh は、自動プルまたは条件付き再プルがトリガーされる前のしきい値（ビット単位）です。

残りのパラメータは次のとおりです。

• autopush は自動プッシュを有効にするかどうかを設定します。

• autopull は自動プルを有効にするかどうかを設定します。

• fifo_join は、4 ワードの TX FIFO と RX FIFO を一方向のみの単一の 8 ワード FIFO に結合するかどうかを設定します。オプションは PIO.JOIN_NONE、PIO.JOIN_RX、PIO.JOIN_TX です。

rp2.asm_pio_encode(instr: str, sideset_count: int, sideset_opt: bool = False) → int

単一の PIO 命令をアセンブルします。通常は代わりに asm_pio() を使用するとよいでしょう。

>>> rp2.asm_pio_encode("set(0, 1)", 0)
57345

rp2.bootsel_button() → int

QSPI_SS ピンを一時的に入力にしてその値を読み取り、Low の場合は 1、High の場合は 0 を返します。BOOTSEL ボタンを備えた一般的な RP2040 ボードでは、戻り値 1 はボタンが押されていることを示します。

この関数は外部フラッシュメモリへのアクセスを一時的に無効にするため、フラッシュからコードを実行しようとするのを防ぐために、割り込みおよびもう一方のコアも一時的に無効にします。

class rp2.PIOASMError

この例外は、PIO プログラムのアセンブル中にエラーが発生した場合に asm_pio() または asm_pio_encode() から送出されます。

PIO アセンブリ言語の命令

PIO ステートマシンは、9 つのコア PIO マシン命令を持つカスタムアセンブリ言語でプログラムされます。MicroPython では、PIO アセンブリルーチンはデコレータ @rp2.asm_pio() を付けた Python 関数として記述され、Python の構文を使用します。これらのルーチンは標準的な Python の変数や算術演算に加えて、PIO 命令をエンコードしアセンブラに指示する以下のカスタム関数をサポートします。詳細については RP2040 データシートの 3.4 節を参照してください。

wrap_target()

プログラムのラップ後に実行が継続する位置を指定します。デフォルトでは PIO ルーチンの先頭になります。

wrap()

プログラムが終了してラップする位置を指定します。このディレクティブを使用しない場合は、PIO ルーチンの末尾に自動的に追加されます。ラップは実行サイクルを消費しません。

label(label)

現在の位置に label という名前のラベルを定義します。label は文字列または整数にできます。

word(instr, label=None)

アセンブル出力に任意の 16 ビットワードを挿入します。

• instr: 16 ビットの値

• label: 指定された場合、ラベルを参照し、そのラベルの値と instr の論理和を取ります

jmp(...)

この命令には 2 つの形式があります。

jmp(label)

• label: 無条件にジャンプする先のラベル

jmp(cond, label)

• cond: チェックする条件で、次のいずれか:

  • not_x、not_y: レジスタがゼロの場合に真

  • x_dec、y_dec: レジスタが非ゼロの場合に真で、ポストデクリメントを行う

  • x_not_y: X が Y と等しくない場合に真

  • pin: 入力ピンがセットされている場合に真

  • not_osre: OSR が空でない（しきい値に達していない）場合に真

• label: 条件が真の場合にジャンプする先のラベル

wait(polarity, src, index)

ピンまたは IRQ ラインが High/Low になるのを待ってブロックします。

• polarity: 0 または 1 で、Low と High のどちらの値を待つか

• src: 次のいずれか: gpio（絶対的なピン）、pin（StateMachine の in_base 引数に対する相対的なピン）、irq

• index: 0～31、src のインデックス

in_(src, bit_count)

src から ISR へデータをシフトインします。

• src: 次のいずれか: pins、x、y、null、isr、osr

• bit_count: シフトインするビット数（1～32）

out(dest, bit_count)

OSR から dest へデータをシフトアウトします。

• dest: 次のいずれか: pins、x、y、pindirs、pc、isr、exec

• bit_count: シフトアウトするビット数（1～32）

push(...)

ISR を RX FIFO にプッシュし、その後 ISR をゼロにクリアします。この命令は次の形式を取ります。

• push()

• push(block)

• push(noblock)

• push(iffull)

• push(iffull, block)

• push(iffull, noblock)

block を使用すると、RX FIFO が満杯の場合に命令はストールします。デフォルトはブロックします。iffull を使用すると、入力シフトカウントがしきい値に達した場合にのみプッシュします。

pull(...)

TX FIFO から OSR へプルします。この命令は次の形式を取ります。

• pull()

• pull(block)

• pull(noblock)

• pull(ifempty)

• pull(ifempty, block)

• pull(ifempty, noblock)

block を使用すると、TX FIFO が空の場合に命令はストールします。デフォルトはブロックします。ifempty を使用すると、出力シフトカウントがしきい値に達した場合にのみプルします。

mov(dest, src)

src の値を dest に移動します。

• dest: 次のいずれか: pins、x、y、exec、pc、isr、osr

• src: 次のいずれか: pins、x、y、null、status、isr、osr。この引数は invert() または reverse() でラップすることでオプションとして変更できます（ただし両方を同時には使えません）。

irq(...)

IRQ フラグをセットまたはクリアします。この命令には 2 つの形式があります。

irq(index)

• index: 0～7、または rel(0) から rel(7)

irq(mode, index)

• mode: 次のいずれか: block、clear

• index: 0～7、または rel(0) から rel(7)

block を使用すると、フラグが別のエンティティによってクリアされるまで命令はストールします。clear を使用すると、フラグはセットされる代わりにクリアされます。相対的な IRQ インデックスは、ステートマシン ID を IRQ インデックスにモジュロ 4 加算で加えます。IRQ 0～3 はプロセッサから参照可能で、4～7 はステートマシン内部のものです。

set(dest, data)

dest に値 data をセットします。

• dest: pins、x、y、pindirs

• data: 値（0～31）

nop()

これは mov(y, y) にアセンブルされる擬似命令で、副作用はありません。

.side(value)

これは任意の命令に適用できる修飾子で、side-set ピンの値を制御するために使用されます。

• value: side-set ピンに出力する値（ビット）

.delay(value)

これは任意の命令に適用できる修飾子で、命令の実行後に何サイクル遅延させるかを指定します。

• value: 遅延させるサイクル数、0～31（side-set ピンを使用する場合は最大値が減少します）

[value]

これは修飾子であり、.delay(value) と同等です。

クラス

• class DMA -- RP2040 の DMA コントローラへのアクセス
• class Flash -- 内蔵フラッシュストレージへのアクセス
• class PIO -- 高度な PIO の使用
• class StateMachine -- RP2040 のプログラマブル I/O インターフェースへのアクセス