@web-font-path: "roboto-debian.css";
v2.2.0 (RP2040)
Loading...
Searching...
No Matches
pio_instructions.h
/*
* Copyright (c) 2020 Raspberry Pi (Trading) Ltd.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
#ifndef _HARDWARE_PIO_INSTRUCTIONS_H
#define _HARDWARE_PIO_INSTRUCTIONS_H
#include "pico.h"
// PICO_CONFIG: PARAM_ASSERTIONS_ENABLED_PIO_INSTRUCTIONS, Enable/disable assertions in the PIO instructions, type=bool, default=0, group=pio_instructions
#ifndef PARAM_ASSERTIONS_ENABLED_PIO_INSTRUCTIONS
#define PARAM_ASSERTIONS_ENABLED_PIO_INSTRUCTIONS 0
#endif
#ifdef __cplusplus
extern "C" {
#endif
enum pio_instr_bits {
pio_instr_bits_jmp = 0x0000,
pio_instr_bits_wait = 0x2000,
pio_instr_bits_in = 0x4000,
pio_instr_bits_out = 0x6000,
pio_instr_bits_push = 0x8000,
pio_instr_bits_pull = 0x8080,
pio_instr_bits_mov = 0xa000,
pio_instr_bits_irq = 0xc000,
pio_instr_bits_set = 0xe000,
};
#ifndef NDEBUG
#define _PIO_INVALID_IN_SRC 0x08u
#define _PIO_INVALID_OUT_DEST 0x10u
#define _PIO_INVALID_SET_DEST 0x20u
#define _PIO_INVALID_MOV_SRC 0x40u
#define _PIO_INVALID_MOV_DEST 0x80u
#else
#define _PIO_INVALID_IN_SRC 0u
#define _PIO_INVALID_OUT_DEST 0u
#define _PIO_INVALID_SET_DEST 0u
#define _PIO_INVALID_MOV_SRC 0u
#define _PIO_INVALID_MOV_DEST 0u
#endif
enum pio_src_dest {
pio_pins = 0u,
pio_x = 1u,
pio_y = 2u,
pio_null = 3u | _PIO_INVALID_SET_DEST | _PIO_INVALID_MOV_DEST,
pio_pindirs = 4u | _PIO_INVALID_IN_SRC | _PIO_INVALID_MOV_SRC | _PIO_INVALID_MOV_DEST,
pio_exec_mov = 4u | _PIO_INVALID_IN_SRC | _PIO_INVALID_OUT_DEST | _PIO_INVALID_SET_DEST | _PIO_INVALID_MOV_SRC,
pio_status = 5u | _PIO_INVALID_IN_SRC | _PIO_INVALID_OUT_DEST | _PIO_INVALID_SET_DEST | _PIO_INVALID_MOV_DEST,
pio_pc = 5u | _PIO_INVALID_IN_SRC | _PIO_INVALID_SET_DEST | _PIO_INVALID_MOV_SRC,
pio_isr = 6u | _PIO_INVALID_SET_DEST,
pio_osr = 7u | _PIO_INVALID_OUT_DEST | _PIO_INVALID_SET_DEST,
pio_exec_out = 7u | _PIO_INVALID_IN_SRC | _PIO_INVALID_SET_DEST | _PIO_INVALID_MOV_SRC | _PIO_INVALID_MOV_DEST,
};
static inline uint _pio_major_instr_bits(uint instr) {
return instr & 0xe000u;
}
static inline uint _pio_arg1(uint instr) {
return (instr >> 5) & 0x7u;
}
static inline uint _pio_encode_instr_and_args(enum pio_instr_bits instr_bits, uint arg1, uint arg2) {
valid_params_if(PIO_INSTRUCTIONS, arg1 <= 0x7);
#if PARAM_ASSERTIONS_ENABLED(PIO_INSTRUCTIONS)
uint32_t major = _pio_major_instr_bits(instr_bits);
if (major == pio_instr_bits_in || major == pio_instr_bits_out) {
assert(arg2 && arg2 <= 32);
} else {
assert(arg2 <= 31);
}
#endif
return instr_bits | (arg1 << 5u) | (arg2 & 0x1fu);
}
static inline uint _pio_encode_instr_and_src_dest(enum pio_instr_bits instr_bits, enum pio_src_dest dest, uint value) {
return _pio_encode_instr_and_args(instr_bits, dest & 7u, value);
}
static inline uint pio_encode_delay(uint cycles) {
// note that the maximum cycles will be smaller if sideset_bit_count > 0
valid_params_if(PIO_INSTRUCTIONS, cycles <= 0x1f);
return cycles << 8u;
}
static inline uint pio_encode_sideset(uint sideset_bit_count, uint value) {
valid_params_if(PIO_INSTRUCTIONS, sideset_bit_count >= 1 && sideset_bit_count <= 5);
valid_params_if(PIO_INSTRUCTIONS, value <= ((1u << sideset_bit_count) - 1));
return value << (13u - sideset_bit_count);
}
static inline uint pio_encode_sideset_opt(uint sideset_bit_count, uint value) {
valid_params_if(PIO_INSTRUCTIONS, sideset_bit_count >= 0 && sideset_bit_count <= 4);
valid_params_if(PIO_INSTRUCTIONS, value <= ((1u << sideset_bit_count) - 1));
return 0x1000u | value << (12u - sideset_bit_count);
}
static inline uint pio_encode_jmp(uint addr) {
return _pio_encode_instr_and_args(pio_instr_bits_jmp, 0, addr);
}
static inline uint pio_encode_jmp_not_x(uint addr) {
return _pio_encode_instr_and_args(pio_instr_bits_jmp, 1, addr);
}
static inline uint pio_encode_jmp_x_dec(uint addr) {
return _pio_encode_instr_and_args(pio_instr_bits_jmp, 2, addr);
}
static inline uint pio_encode_jmp_not_y(uint addr) {
return _pio_encode_instr_and_args(pio_instr_bits_jmp, 3, addr);
}
static inline uint pio_encode_jmp_y_dec(uint addr) {
return _pio_encode_instr_and_args(pio_instr_bits_jmp, 4, addr);
}
static inline uint pio_encode_jmp_x_ne_y(uint addr) {
return _pio_encode_instr_and_args(pio_instr_bits_jmp, 5, addr);
}
static inline uint pio_encode_jmp_pin(uint addr) {
return _pio_encode_instr_and_args(pio_instr_bits_jmp, 6, addr);
}
static inline uint pio_encode_jmp_not_osre(uint addr) {
return _pio_encode_instr_and_args(pio_instr_bits_jmp, 7, addr);
}
static inline uint _pio_encode_irq(bool relative, uint irq) {
valid_params_if(PIO_INSTRUCTIONS, irq <= 7);
return (relative ? 0x10u : 0x0u) | irq;
}
static inline uint pio_encode_wait_gpio(bool polarity, uint gpio) {
return _pio_encode_instr_and_args(pio_instr_bits_wait, 0u | (polarity ? 4u : 0u), gpio);
}
static inline uint pio_encode_wait_pin(bool polarity, uint pin) {
return _pio_encode_instr_and_args(pio_instr_bits_wait, 1u | (polarity ? 4u : 0u), pin);
}
static inline uint pio_encode_wait_irq(bool polarity, bool relative, uint irq) {
valid_params_if(PIO_INSTRUCTIONS, irq <= 7);
return _pio_encode_instr_and_args(pio_instr_bits_wait, 2u | (polarity ? 4u : 0u), _pio_encode_irq(relative, irq));
}
static inline uint pio_encode_in(enum pio_src_dest src, uint count) {
valid_params_if(PIO_INSTRUCTIONS, !(src & _PIO_INVALID_IN_SRC));
return _pio_encode_instr_and_src_dest(pio_instr_bits_in, src, count);
}
static inline uint pio_encode_out(enum pio_src_dest dest, uint count) {
valid_params_if(PIO_INSTRUCTIONS, !(dest & _PIO_INVALID_OUT_DEST));
return _pio_encode_instr_and_src_dest(pio_instr_bits_out, dest, count);
}
static inline uint pio_encode_push(bool if_full, bool block) {
return _pio_encode_instr_and_args(pio_instr_bits_push, (if_full ? 2u : 0u) | (block ? 1u : 0u), 0);
}
static inline uint pio_encode_pull(bool if_empty, bool block) {
return _pio_encode_instr_and_args(pio_instr_bits_pull, (if_empty ? 2u : 0u) | (block ? 1u : 0u), 0);
}
static inline uint pio_encode_mov(enum pio_src_dest dest, enum pio_src_dest src) {
valid_params_if(PIO_INSTRUCTIONS, !(dest & _PIO_INVALID_MOV_DEST));
valid_params_if(PIO_INSTRUCTIONS, !(src & _PIO_INVALID_MOV_SRC));
return _pio_encode_instr_and_src_dest(pio_instr_bits_mov, dest, src & 7u);
}
static inline uint pio_encode_mov_not(enum pio_src_dest dest, enum pio_src_dest src) {
valid_params_if(PIO_INSTRUCTIONS, !(dest & _PIO_INVALID_MOV_DEST));
valid_params_if(PIO_INSTRUCTIONS, !(src & _PIO_INVALID_MOV_SRC));
return _pio_encode_instr_and_src_dest(pio_instr_bits_mov, dest, (1u << 3u) | (src & 7u));
}
static inline uint pio_encode_mov_reverse(enum pio_src_dest dest, enum pio_src_dest src) {
valid_params_if(PIO_INSTRUCTIONS, !(dest & _PIO_INVALID_MOV_DEST));
valid_params_if(PIO_INSTRUCTIONS, !(src & _PIO_INVALID_MOV_SRC));
return _pio_encode_instr_and_src_dest(pio_instr_bits_mov, dest, (2u << 3u) | (src & 7u));
}
static inline uint pio_encode_irq_set(bool relative, uint irq) {
return _pio_encode_instr_and_args(pio_instr_bits_irq, 0, _pio_encode_irq(relative, irq));
}
static inline uint pio_encode_irq_wait(bool relative, uint irq) {
return _pio_encode_instr_and_args(pio_instr_bits_irq, 1, _pio_encode_irq(relative, irq));
}
static inline uint pio_encode_irq_clear(bool relative, uint irq) {
return _pio_encode_instr_and_args(pio_instr_bits_irq, 2, _pio_encode_irq(relative, irq));
}
static inline uint pio_encode_set(enum pio_src_dest dest, uint value) {
valid_params_if(PIO_INSTRUCTIONS, !(dest & _PIO_INVALID_SET_DEST));
return _pio_encode_instr_and_src_dest(pio_instr_bits_set, dest, value);
}
static inline uint pio_encode_nop(void) {
return pio_encode_mov(pio_y, pio_y);
}
#ifdef __cplusplus
}
#endif
#endif
pio_encode_jmp
static uint pio_encode_jmp(uint addr)
Encode an unconditional JMP instruction.
Definition pio_instructions.h:165
pio_encode_delay
static uint pio_encode_delay(uint cycles)
Encode just the delay slot bits of an instruction.
Definition pio_instructions.h:114
pio_encode_irq_set
static uint pio_encode_irq_set(bool relative, uint irq)
Encode a IRQ SET instruction.
Definition pio_instructions.h:429
pio_encode_wait_irq
static uint pio_encode_wait_irq(bool polarity, bool relative, uint irq)
Encode a WAIT for IRQ instruction.
Definition pio_instructions.h:308
pio_encode_push
static uint pio_encode_push(bool if_full, bool block)
Encode a PUSH instruction.
Definition pio_instructions.h:353
pio_encode_wait_gpio
static uint pio_encode_wait_gpio(bool polarity, uint gpio)
Encode a WAIT for GPIO pin instruction.
Definition pio_instructions.h:279
pio_encode_sideset_opt
static uint pio_encode_sideset_opt(uint sideset_bit_count, uint value)
Encode just the side set bits of an instruction (in optional -opt side set mode).
Definition pio_instructions.h:150
pio_src_dest
pio_src_dest
Enumeration of values to pass for source/destination args for instruction encoding functions.
Definition pio_instructions.h:64
pio_encode_irq_clear
static uint pio_encode_irq_clear(bool relative, uint irq)
Encode a IRQ CLEAR instruction.
Definition pio_instructions.h:457
pio_encode_mov_not
static uint pio_encode_mov_not(enum pio_src_dest dest, enum pio_src_dest src)
Encode a MOV instruction with bit invert.
Definition pio_instructions.h:397
pio_encode_jmp_not_x
static uint pio_encode_jmp_not_x(uint addr)
Encode a conditional JMP if scratch X zero instruction.
Definition pio_instructions.h:178
pio_encode_pull
static uint pio_encode_pull(bool if_empty, bool block)
Encode a PULL instruction.
Definition pio_instructions.h:367
pio_encode_out
static uint pio_encode_out(enum pio_src_dest dest, uint count)
Encode an OUT instruction.
Definition pio_instructions.h:338
pio_encode_jmp_y_dec
static uint pio_encode_jmp_y_dec(uint addr)
Encode a conditional JMP if scratch Y non-zero (and post-decrement Y) instruction.
Definition pio_instructions.h:217
pio_encode_jmp_x_ne_y
static uint pio_encode_jmp_x_ne_y(uint addr)
Encode a conditional JMP if scratch X not equal scratch Y instruction.
Definition pio_instructions.h:230
pio_encode_nop
static uint pio_encode_nop(void)
Encode a NOP instruction.
Definition pio_instructions.h:484
pio_encode_in
static uint pio_encode_in(enum pio_src_dest src, uint count)
Encode an IN instruction.
Definition pio_instructions.h:323
pio_encode_jmp_pin
static uint pio_encode_jmp_pin(uint addr)
Encode a conditional JMP if input pin high instruction.
Definition pio_instructions.h:243
pio_encode_sideset
static uint pio_encode_sideset(uint sideset_bit_count, uint value)
Encode just the side set bits of an instruction (in non optional side set mode).
Definition pio_instructions.h:132
pio_encode_mov_reverse
static uint pio_encode_mov_reverse(enum pio_src_dest dest, enum pio_src_dest src)
Encode a MOV instruction with bit reverse.
Definition pio_instructions.h:413
pio_encode_jmp_x_dec
static uint pio_encode_jmp_x_dec(uint addr)
Encode a conditional JMP if scratch X non-zero (and post-decrement X) instruction.
Definition pio_instructions.h:191
pio_encode_jmp_not_y
static uint pio_encode_jmp_not_y(uint addr)
Encode a conditional JMP if scratch Y zero instruction.
Definition pio_instructions.h:204
pio_encode_mov
static uint pio_encode_mov(enum pio_src_dest dest, enum pio_src_dest src)
Encode a MOV instruction.
Definition pio_instructions.h:381
pio_encode_set
static uint pio_encode_set(enum pio_src_dest dest, uint value)
Encode a SET instruction.
Definition pio_instructions.h:471
pio_encode_irq_wait
static uint pio_encode_irq_wait(bool relative, uint irq)
Encode a IRQ WAIT instruction.
Definition pio_instructions.h:443
pio_encode_jmp_not_osre
static uint pio_encode_jmp_not_osre(uint addr)
Encode a conditional JMP if output shift register not empty instruction.
Definition pio_instructions.h:256
pio_encode_wait_pin
static uint pio_encode_wait_pin(bool polarity, uint pin)
Encode a WAIT for pin instruction.
Definition pio_instructions.h:293
pico.h