ISR Pipe

ISR -> userspace pipe. More...

Detailed Description

ISR -> userspace pipe.

Modules
	Read timeouts with ISR pipe
	ISR -> userspace pipe with timeout.

Files
file	isrpipe.h
	isrpipe Interface

Data Structures
struct	isrpipe_t
	Context structure for isrpipe. More...

Macros
#define	ISRPIPE_INIT(buf)
	Static initializer for irspipe. More...

Functions
void	isrpipe_init (isrpipe_t *isrpipe, uint8_t *buf, size_t bufsize)
	Initialisation function for isrpipe. More...
int	isrpipe_write_one (isrpipe_t *isrpipe, uint8_t c)
	Put one byte into the isrpipe's buffer. More...
int	isrpipe_write (isrpipe_t *isrpipe, const uint8_t *buf, size_t n)
	Put number of bytes into the isrpipe's buffer. More...
int	isrpipe_read (isrpipe_t *isrpipe, uint8_t *buf, size_t count)
	Read data from isrpipe (blocking) More...

Macro Definition Documentation

ISRPIPE_INIT

#define ISRPIPE_INIT

(

buf

)

Value:

                            { .mutex = MUTEX_INIT_LOCKED, \
                            .tsrb = TSRB_INIT(buf) }

Static initializer for irspipe.

Note

The size of the buffer (sizeof(@p buf)) must be a power of two.

Parameters

[in]

buf

buffer to use as ringbuffer

Definition at line 48 of file isrpipe.h.

Function Documentation

isrpipe_init()

void isrpipe_init	(	isrpipe_t *	isrpipe,
		uint8_t *	buf,
		size_t	bufsize
	)

Initialisation function for isrpipe.

Note

The size of the buffer (bufsize) must be a power of two.

Parameters

[in]	isrpipe	isrpipe object to initialize
[in]	buf	buffer to use as ringbuffer
[in]	bufsize	size of buf

isrpipe_read()

int isrpipe_read	(	isrpipe_t *	isrpipe,
		uint8_t *	buf,
		size_t	count
	)

Read data from isrpipe (blocking)

Parameters

[in]	isrpipe	isrpipe object to operate on
[in]	buf	buffer to write to
[in]	count	number of bytes to read

Returns

number of bytes read

isrpipe_write()

int isrpipe_write	(	isrpipe_t *	isrpipe,
		const uint8_t *	buf,
		size_t	n
	)

Put number of bytes into the isrpipe's buffer.

Parameters

[in]	isrpipe	isrpipe object to operate on
[in]	buf	bytes to add to isrpipe buffer
[in]	n	number of bytes to add from buf to isrpipe's buffer

Returns

number of bytes that could be added

-1 if buffer was full

isrpipe_write_one()

int isrpipe_write_one	(	isrpipe_t *	isrpipe,
		uint8_t	c
	)

Put one byte into the isrpipe's buffer.

Parameters

[in]	isrpipe	isrpipe object to operate on
[in]	c	byte to add to isrpipe buffer

Returns

0 if byte could be added

-1 if buffer was full