mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
d9049dad87
The API of `tsrb` was changed because of confusing type situations. This API change takes this API change of changing `char` to `uint8_t` up a level. Since `isrpipe` most often is used together with `periph_uart` this change even is beneficial, as `periph_uart` also uses `uint8_t` instead of `char`.
70 lines
1.9 KiB
C
70 lines
1.9 KiB
C
/*
|
|
* 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, uint8_t *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, uint8_t *buf, size_t count, uint32_t timeout);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
/** @} */
|
|
#endif /* ISRPIPE_READ_TIMEOUT_H */
|