diff options
Diffstat (limited to 'os/kernel/include/streams.h')
| -rw-r--r-- | os/kernel/include/streams.h | 52 |
1 files changed, 27 insertions, 25 deletions
diff --git a/os/kernel/include/streams.h b/os/kernel/include/streams.h index 624f4fd95..b4f7f4901 100644 --- a/os/kernel/include/streams.h +++ b/os/kernel/include/streams.h @@ -18,8 +18,11 @@ */
/**
- * @file streams.h
- * @brief Data streams.
+ * @file streams.h
+ * @brief Data streams.
+ * @details This header defines abstract interfaces useful to access generic
+ * data streams in a standardized way.
+ *
* @addtogroup data_streams
* @{
*/
@@ -28,7 +31,7 @@ #define _STREAMS_H_
/**
- * @brief BaseSequentialStream specific methods.
+ * @brief BaseSequentialStream specific methods.
*/
#define _base_sequental_stream_methods \
/* Stream write buffer method.*/ \
@@ -37,55 +40,54 @@ size_t (*read)(void *instance, uint8_t *bp, size_t n);
/**
- * @brief @p BaseSequentialStream specific data.
- * @note It is empty because @p BaseSequentialStream is only an interface
- * without implementation.
+ * @brief @p BaseSequentialStream specific data.
+ * @note It is empty because @p BaseSequentialStream is only an interface
+ * without implementation.
*/
#define _base_sequental_stream_data
/**
- * @brief @p BaseSequentialStream virtual methods table.
+ * @brief @p BaseSequentialStream virtual methods table.
*/
struct BaseSequentialStreamVMT {
_base_sequental_stream_methods
};
/**
- * @brief Base stream class.
+ * @brief Base stream class.
* @details This class represents a generic blocking unbuffered sequential
* data stream.
*/
typedef struct {
- /**
- * Virtual Methods Table.
- */
+ /** @brief Virtual Methods Table.*/
const struct BaseSequentialStreamVMT *vmt;
_base_sequental_stream_data
} BaseSequentialStream;
/**
- * @brief Sequential Stream write.
+ * @brief Sequential Stream write.
* @details The function writes data from a buffer to a stream.
*
- * @param[in] ip pointer to a @p BaseSequentialStream or derived class
- * @param[in] bp pointer to the data buffer
- * @param[in] n the maximum amount of data to be transferred
- * @return The number of bytes transferred. The return value can be less
- * than the specified number of bytes if the stream reaches a
- * physical end of file and cannot be extended.
+ * @param[in] ip pointer to a @p BaseSequentialStream or derived class
+ * @param[in] bp pointer to the data buffer
+ * @param[in] n the maximum amount of data to be transferred
+ * @return The number of bytes transferred. The return value can
+ * be less than the specified number of bytes if the
+ * stream reaches a physical end of file and cannot be
+ * extended.
*/
#define chSequentialStreamWrite(ip, bp, n) ((ip)->vmt->write(ip, bp, n))
/**
- * @brief Sequential Stream read.
+ * @brief Sequential Stream read.
* @details The function reads data from a stream into a buffer.
*
- * @param[in] ip pointer to a @p BaseSequentialStream or derived class
- * @param[out] bp pointer to the data buffer
- * @param[in] n the maximum amount of data to be transferred
- * @return The number of bytes transferred. The return value can be less
- * than the specified number of bytes if the stream reaches the end
- * of the available data.
+ * @param[in] ip pointer to a @p BaseSequentialStream or derived class
+ * @param[out] bp pointer to the data buffer
+ * @param[in] n the maximum amount of data to be transferred
+ * @return The number of bytes transferred. The return value can
+ * be less than the specified number of bytes if the
+ * stream reaches the end of the available data.
*/
#define chSequentialStreamRead(ip, bp, n) ((ip)->vmt->read(ip, bp, n))
|