epacket_dummy APIs

epacket_dummy API More...

Data Structures
struct	epacket_dummy_frame

Macros
#define	EPACKET_DUMMY_FRAME_EXPECTED_SIZE   8

Functions
void	epacket_dummy_reset_callbacks (const struct device *dev)
	Reset registered epacket callbacks.
struct k_fifo *	epacket_dummmy_transmit_fifo_get (void)
	Get the FIFO that the dummy interface "sends" packets on.
struct k_sem *	epacket_dummy_rx_started_sem_get (void)
	Get the semaphore that is given each time reception starts.
void	epacket_dummy_set_gps_timestamp (uint32_t timestamp)
	Set the GPS timestamp used for received packets.
void	epacket_dummy_set_tx_failure (int error_code)
	If set to a non-zero value, treat all sends as errors.
void	epacket_dummy_set_max_packet (uint16_t packet_size)
	Set the maximum packet size for the interface.
void	epacket_dummy_set_interface_state (const struct device *dev, bool state)
	Set the interface state and run callbacks.
bool	epacket_dummy_receive_scheduled (void)
	Is receiving currently scheduled on the interface.
void	epacket_dummy_receive_api_override (bool func_exists, int rc)
	Override the behaviour of .receive_ctrl
void	epacket_dummy_receive_extra (const struct device *dev, const struct epacket_dummy_frame *header, const void *payload, size_t payload_len, const void *extra, size_t extra_len)
	Simulate the dummy interface receiving a packet.
static void	epacket_dummy_receive (const struct device *dev, const struct epacket_dummy_frame *header, const void *payload, size_t payload_len)
	Simulate the dummy interface receiving a packet.

Detailed Description

epacket_dummy API

Macro Definition Documentation

EPACKET_DUMMY_FRAME_EXPECTED_SIZE

#define EPACKET_DUMMY_FRAME_EXPECTED_SIZE   8

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_dummy.h>

Function Documentation

epacket_dummmy_transmit_fifo_get()

struct k_fifo * epacket_dummmy_transmit_fifo_get

(

void

)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_dummy.h>

Get the FIFO that the dummy interface "sends" packets on.

Returns

Pointer to the transmit FIFO

epacket_dummy_receive()

void epacket_dummy_receive ( const struct device * dev, const struct epacket_dummy_frame * header, const void * payload, size_t payload_len )

inlinestatic

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_dummy.h>

Simulate the dummy interface receiving a packet.

Parameters

dev	Dummy interface
header	Packet header
payload	Packet payload
payload_len	Length of payload

epacket_dummy_receive_api_override()

void epacket_dummy_receive_api_override	(	bool	func_exists,
		int	rc )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_dummy.h>

Override the behaviour of .receive_ctrl

Parameters

func_exists	True to populate function in API struct, false to remove
rc	Return code of .receive_ctrl

epacket_dummy_receive_extra()

void epacket_dummy_receive_extra	(	const struct device *	dev,
		const struct epacket_dummy_frame *	header,
		const void *	payload,
		size_t	payload_len,
		const void *	extra,
		size_t	extra_len )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_dummy.h>

Simulate the dummy interface receiving a packet.

Parameters

dev	Dummy interface
header	Packet header
payload	Packet payload
payload_len	Length of payload
extra	Extra payload
extra_len	Length of extra payload

epacket_dummy_receive_scheduled()

bool epacket_dummy_receive_scheduled

(

void

)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_dummy.h>

Is receiving currently scheduled on the interface.

Return values

true	Receiving has been enabled
false	Receiving has been disabled

epacket_dummy_reset_callbacks()

void epacket_dummy_reset_callbacks

(

const struct device *

dev

)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_dummy.h>

Reset registered epacket callbacks.

Parameters

dev	Dummy interface

epacket_dummy_rx_started_sem_get()

struct k_sem * epacket_dummy_rx_started_sem_get

(

void

)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_dummy.h>

Get the semaphore that is given each time reception starts.

Returns

Pointer to the semaphore

epacket_dummy_set_gps_timestamp()

void epacket_dummy_set_gps_timestamp

(

uint32_t

timestamp

)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_dummy.h>

Set the GPS timestamp used for received packets.

Parameters

timestamp

GPS timestamp to use

epacket_dummy_set_interface_state()

void epacket_dummy_set_interface_state	(	const struct device *	dev,
		bool	state )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_dummy.h>

Set the interface state and run callbacks.

Parameters

dev	Dummy interface
state	New interface state

epacket_dummy_set_max_packet()

void epacket_dummy_set_max_packet

(

uint16_t

packet_size

)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_dummy.h>

Set the maximum packet size for the interface.

Parameters

packet_size

New maximum packet size

epacket_dummy_set_tx_failure()

void epacket_dummy_set_tx_failure

(

int

error_code

)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_dummy.h>

If set to a non-zero value, treat all sends as errors.

Parameters

error_code

Error code to return.