Raspberry Pi Pico PIO Driver APIs

Raspberry Pi Pico PIO driver APIs. More...

Files
file	pio_rpi_pico.h
	Header file for Raspberry Pi Pico PIO driver.

Macros
#define	RPI_PICO_PIO_DEFINE_PROGRAM(name, wrap_target, wrap, ...)
	Utility macro to define a PIO program.
#define	RPI_PICO_PIO_GET_WRAP_TARGET(name)   name ## _wrap_target
	Utility macro to get the wrap target of a program.
#define	RPI_PICO_PIO_GET_WRAP(name)   name ## _wrap
	Utility macro to get the wrap source of a program.
#define	RPI_PICO_PIO_GET_PROGRAM(name)   &name ## _program
	Utility macro to get a pointer to a PIO program.
#define	DT_RPI_PICO_PIO_PIN_BY_NAME(node_id, p_name, p_idx, g_name, g_idx)
	Get a pin number from a pinctrl / group name and index.
#define	DT_INST_RPI_PICO_PIO_PIN_BY_NAME(inst, p_name, p_idx, g_name, g_idx)    DT_RPI_PICO_PIO_PIN_BY_NAME(DT_DRV_INST(inst), p_name, p_idx, g_name, g_idx)
	Get a pin number from a pinctrl / group name and index.
#define	DT_INST_PIO_PIN_BY_NAME(inst, name)    DT_PIO_PIN_BY_NAME(DT_DRV_INST(inst), name)
	Get the pin number of a pin by its name.

Functions
PIO	pio_rpi_pico_get_pio (const struct device *dev)
	Get PIO object.
int	pio_rpi_pico_allocate_sm (const struct device *dev, size_t *sm)
	Allocate a state machine.

Detailed Description

Raspberry Pi Pico PIO driver APIs.

Macro Definition Documentation

DT_INST_PIO_PIN_BY_NAME

#define DT_INST_PIO_PIN_BY_NAME	(		inst,
			name
	)		DT_PIO_PIN_BY_NAME(DT_DRV_INST(inst), name)

#include <include/zephyr/drivers/misc/pio_rpi_pico/pio_rpi_pico.h>

Get the pin number of a pin by its name.

Parameters

inst	instance number
name	name of the pin (e.g. tx, rx, sck).

DT_INST_RPI_PICO_PIO_PIN_BY_NAME

#define DT_INST_RPI_PICO_PIO_PIN_BY_NAME	(		inst,
			p_name,
			p_idx,
			g_name,
			g_idx
	)		DT_RPI_PICO_PIO_PIN_BY_NAME(DT_DRV_INST(inst), p_name, p_idx, g_name, g_idx)

#include <include/zephyr/drivers/misc/pio_rpi_pico/pio_rpi_pico.h>

Get a pin number from a pinctrl / group name and index.

Parameters

inst	instance number
p_name	pinctrl name
p_idx	pinctrl index
g_name	group name
g_idx	group index

Returns

pin number

See also

DT_RPI_PICO_PIO_PIN_BY_NAME

DT_RPI_PICO_PIO_PIN_BY_NAME

#define DT_RPI_PICO_PIO_PIN_BY_NAME	(		node_id,
			p_name,
			p_idx,
			g_name,
			g_idx
	)

#include <include/zephyr/drivers/misc/pio_rpi_pico/pio_rpi_pico.h>

Value:

        RP2_GET_PIN_NUM(DT_PROP_BY_IDX(                                                         \
                DT_CHILD(DT_PINCTRL_BY_NAME(node_id, p_name, p_idx), g_name), pinmux, g_idx))

Get a pin number from a pinctrl / group name and index.

Example devicetree fragment(s):

pinctrl {
   pio_child_default: pio_child_default {
           tx_gpio {
                   pinmux = <PIO0_P0>, <PIO0_P2>;
           };
 
           rx_gpio {
                   pinmux = <PIO0_P1>;
                   input-enable;
           };
   };
};

pio {
   status = "okay";
   c: child {
           pinctrl-0 = <&pio_child_default>;
           pinctrl-names = "default";
   };
};

Example usage:

DT_RPI_PICO_PIO_PIN_BY_NAME(node, default, 0, tx_gpio, 0) // 0
DT_RPI_PICO_PIO_PIN_BY_NAME(node, default, 0, tx_gpio, 1) // 2
DT_RPI_PICO_PIO_PIN_BY_NAME(node, default, 0, rx_gpio, 0) // 1

Parameters

node_id	node identifier
p_name	pinctrl name
p_idx	pinctrl index
g_name	group name
g_idx	group index

Returns

pin number

RPI_PICO_PIO_DEFINE_PROGRAM

#define RPI_PICO_PIO_DEFINE_PROGRAM	(		name,
			wrap_target,
			wrap,
			...
	)

#include <include/zephyr/drivers/misc/pio_rpi_pico/pio_rpi_pico.h>

Value:

        static const uint32_t name ## _wrap_target = wrap_target;       \
        static const uint32_t name ## _wrap = wrap;                     \
        static const uint16_t name ## _program_instructions[] = {       \
                __VA_ARGS__                                             \
        };                                                              \
        static const struct pio_program name ## _program = {            \
                .instructions = name ## _program_instructions,          \
                .length = ARRAY_SIZE(name ## _program_instructions),    \
                .origin = -1,                                           \
        }

Utility macro to define a PIO program.

The program is a list of 16 bit instructions, generated by the pioasm tool.

Parameters

name	Name of the program.
wrap_target	Wrap target as specified by the PIO program.
wrap	Wrap source as specified by the PIO program.
...	Comma separated list of PIO instructions.

RPI_PICO_PIO_GET_PROGRAM

#define RPI_PICO_PIO_GET_PROGRAM

(

name

)

&name ## _program

#include <include/zephyr/drivers/misc/pio_rpi_pico/pio_rpi_pico.h>

Utility macro to get a pointer to a PIO program.

Parameters

name	Name of the program.

RPI_PICO_PIO_GET_WRAP

#define RPI_PICO_PIO_GET_WRAP

(

name

)

name ## _wrap

#include <include/zephyr/drivers/misc/pio_rpi_pico/pio_rpi_pico.h>

Utility macro to get the wrap source of a program.

Parameters

name	Name of the program.

RPI_PICO_PIO_GET_WRAP_TARGET

#define RPI_PICO_PIO_GET_WRAP_TARGET

(

name

)

name ## _wrap_target

#include <include/zephyr/drivers/misc/pio_rpi_pico/pio_rpi_pico.h>

Utility macro to get the wrap target of a program.

Parameters

name	Name of the program.

Function Documentation

pio_rpi_pico_allocate_sm()

int pio_rpi_pico_allocate_sm	(	const struct device *	dev,
		size_t *	sm
	)

#include <include/zephyr/drivers/misc/pio_rpi_pico/pio_rpi_pico.h>

Allocate a state machine.

Parameters

dev	Pointer to device structure for rpi_pio device instance
sm	Pointer to store allocated state machine

Return values

0	on success
-EBUSY	if no state machines were available

pio_rpi_pico_get_pio()

PIO pio_rpi_pico_get_pio

(

const struct device *

dev

)

#include <include/zephyr/drivers/misc/pio_rpi_pico/pio_rpi_pico.h>

Get PIO object.

Parameters

dev	Pointer to device structure for rpi_pio device instance

Returns

PIO object