isrpipe.h
3.05 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/*
* Copyright (C) 2016 Kaspar Schleiser <kaspar@schleiser.de>
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup isr_pipe ISR Pipe
* @ingroup sys
* @brief ISR -> userspace pipe
*
* @{
* @file
* @brief isrpipe Interface
*
* @author Kaspar Schleiser <kaspar@schleiser.de>
*
*/
#ifndef ISRPIPE_H
#define ISRPIPE_H
#include <stdint.h>
#include "mutex.h"
#include "tsrb.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Context structure for isrpipe
*/
typedef struct {
mutex_t mutex; /**< isrpipe mutex */
tsrb_t tsrb; /**< isrpipe thread safe ringbuffer */
} isrpipe_t;
/**
* @brief Static initializer for irspipe
*/
#define ISRPIPE_INIT(tsrb_buf) { .mutex = MUTEX_INIT, .tsrb = TSRB_INIT(tsrb_buf) }
/**
* @brief Initialisation function for isrpipe
*
* @param[in] isrpipe isrpipe object to initialize
* @param[in] buf buffer to use as ringbuffer (must be power of two sized!)
* @param[in] bufsize size of @p buf
*/
void isrpipe_init(isrpipe_t *isrpipe, char *buf, size_t bufsize);
/**
* @brief Put one character into the isrpipe's buffer
*
* @param[in] isrpipe isrpipe object to initialize
* @param[in] c character to add to isrpipe buffer
*
* @returns 0 if character could be added
* @returns -1 if buffer was full
*/
int isrpipe_write_one(isrpipe_t *isrpipe, char c);
/**
* @brief Read data from isrpipe (blocking)
*
* @param[in] isrpipe isrpipe object to operate on
* @param[in] buf buffer to write to
* @param[in] count number of bytes to read
*
* @returns number of bytes read
*/
int isrpipe_read(isrpipe_t *isrpipe, char *buf, size_t count);
/**
* @brief Read data from isrpipe (with timeout, blocking)
*
* Currently, the timeout parameter is applied on every underlying read, which
* might be *per single byte*.
*
* @note This function might return less than @p count bytes
*
* @param[in] isrpipe isrpipe object to operate on
* @param[in] buf buffer to write to
* @param[in] count number of bytes to read
* @param[in] timeout timeout in ms
*
* @returns number of bytes read
* @returns -ETIMEDOUT on timeout
*/
int isrpipe_read_timeout(isrpipe_t *isrpipe, char *buf, size_t count, uint32_t timeout);
/**
* @brief Read data from isrpipe (with timeout, blocking, wait until all read)
*
* This function is like @ref isrpipe_read_timeout, but will only return on
* timeout or when @p count bytes have been received.
*
* @param[in] isrpipe isrpipe object to operate on
* @param[in] buf buffer to write to
* @param[in] count number of bytes to read
* @param[in] timeout timeout in ms
*
* @returns number of bytes read
* @returns -ETIMEDOUT on timeout
*/
int isrpipe_read_all_timeout(isrpipe_t *isrpipe, char *buf, size_t count, uint32_t timeout);
#ifdef __cplusplus
}
#endif
/** @} */
#endif /* ISRPIPE_H */