Raspberry Pi Pico mailbox

Interfaces for Raspberry Pi Pico SIO FIFO mailbox. More...

Files
file	mbox_rpi_pico.h
	Header file for Raspberry Pi Pico mailbox.

Functions
static bool	rpi_pico_mbox_write_ready (sio_hw_t *const sio_block)
	Check if FIFO is writeable.
static bool	rpi_pico_mbox_read_valid (sio_hw_t *const sio_block)
	Check if FIFO is readable.
static void	rpi_pico_mbox_drain (sio_hw_t *const sio_block)
	Discard pending messages in FIFO.
static void	rpi_pico_mbox_write (sio_hw_t *const sio_block, uint32_t value)
	Check if FIFO is writeable.
static uint32_t	rpi_pico_mbox_read (sio_hw_t *const sio_block)
	Check if FIFO is readable.

Detailed Description

Interfaces for Raspberry Pi Pico SIO FIFO mailbox.

Function Documentation

rpi_pico_mbox_drain()

void rpi_pico_mbox_drain ( sio_hw_t *const sio_block )

inlinestatic

#include <mbox_rpi_pico.h>

Discard pending messages in FIFO.

Parameters

sio_block

pointer to sio struct

rpi_pico_mbox_read()

uint32_t rpi_pico_mbox_read ( sio_hw_t *const sio_block )

inlinestatic

#include <mbox_rpi_pico.h>

Check if FIFO is readable.

Parameters

sio_block

pointer to sio struct

Return values

value

received from the FIFO

rpi_pico_mbox_read_valid()

bool rpi_pico_mbox_read_valid ( sio_hw_t *const sio_block )

inlinestatic

#include <mbox_rpi_pico.h>

Check if FIFO is readable.

Parameters

sio_block

pointer to sio struct

Return values

true	if the read FIFO has data available
false	otherwise

rpi_pico_mbox_write()

void rpi_pico_mbox_write ( sio_hw_t *const sio_block, uint32_t value )

inlinestatic

#include <mbox_rpi_pico.h>

Check if FIFO is writeable.

Parameters

sio_block	pointer to sio struct
value	to be pushed

rpi_pico_mbox_write_ready()

bool rpi_pico_mbox_write_ready ( sio_hw_t *const sio_block )

inlinestatic

#include <mbox_rpi_pico.h>

Check if FIFO is writeable.

Parameters

sio_block

pointer to sio struct

Return values

true	if the write FIFO isn't full
false	if there is no space to write to FIFO.