-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11267 from cladmi/pr/isrpipe/separate_read_timeout
isrpipe: split isrpipe_read_timeout to isolate xtimer dependency
- Loading branch information
Showing
9 changed files
with
158 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
/* | ||
* 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_read_timeout Read timeouts with ISR pipe | ||
* @ingroup isr_pipe | ||
* @brief ISR -> userspace pipe with timeout | ||
* | ||
* @{ | ||
* @file | ||
* @brief isrpipe read timeout Interface | ||
* | ||
* @author Kaspar Schleiser <kaspar@schleiser.de> | ||
* | ||
*/ | ||
|
||
#ifndef ISRPIPE_READ_TIMEOUT_H | ||
#define ISRPIPE_READ_TIMEOUT_H | ||
|
||
#include "isrpipe.h" | ||
|
||
#ifdef __cplusplus | ||
extern "C" { | ||
#endif | ||
|
||
/** | ||
* @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 microseconds | ||
* | ||
* @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 microseconds | ||
* | ||
* @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_READ_TIMEOUT_H */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
MODULE = isrpipe_read_timeout | ||
|
||
include $(RIOTBASE)/Makefile.base |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
/* | ||
* 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. | ||
*/ | ||
|
||
/** | ||
* @ingroup isr_pipe_read_timeout | ||
* @{ | ||
* @file | ||
* @brief ISR -> userspace pipe with timeout implementation | ||
* | ||
* @author Kaspar Schleiser <kaspar@schleiser.de> | ||
* | ||
* @} | ||
*/ | ||
|
||
#include <errno.h> | ||
|
||
#include "isrpipe/read_timeout.h" | ||
#include "xtimer.h" | ||
|
||
typedef struct { | ||
mutex_t *mutex; | ||
int flag; | ||
} _isrpipe_timeout_t; | ||
|
||
static void _cb(void *arg) | ||
{ | ||
_isrpipe_timeout_t *_timeout = (_isrpipe_timeout_t *) arg; | ||
|
||
_timeout->flag = 1; | ||
mutex_unlock(_timeout->mutex); | ||
} | ||
|
||
int isrpipe_read_timeout(isrpipe_t *isrpipe, char *buffer, size_t count, uint32_t timeout) | ||
{ | ||
int res; | ||
|
||
_isrpipe_timeout_t _timeout = { .mutex = &isrpipe->mutex, .flag = 0 }; | ||
|
||
xtimer_t timer = { .callback = _cb, .arg = &_timeout }; | ||
|
||
xtimer_set(&timer, timeout); | ||
while (!(res = tsrb_get(&isrpipe->tsrb, buffer, count))) { | ||
mutex_lock(&isrpipe->mutex); | ||
if (_timeout.flag) { | ||
res = -ETIMEDOUT; | ||
break; | ||
} | ||
} | ||
|
||
xtimer_remove(&timer); | ||
return res; | ||
} | ||
|
||
|
||
int isrpipe_read_all_timeout(isrpipe_t *isrpipe, char *buffer, size_t count, uint32_t timeout) | ||
{ | ||
char *pos = buffer; | ||
|
||
while (count) { | ||
int res = isrpipe_read_timeout(isrpipe, pos, count, timeout); | ||
if (res >= 0) { | ||
count -= res; | ||
pos += res; | ||
} | ||
else { | ||
return res; | ||
} | ||
} | ||
|
||
return pos - buffer; | ||
} |