mirror of
https://github.com/Telecominfraproject/OpenCellular.git
synced 2025-12-28 02:35:28 +00:00
271bc1eae6
These interfaces will be used by USART, USB and I2C stream drivers to provide a uniform interface for console mux'ing code. Signed-off-by: Anton Staaf <robotboy@chromium.org> BRANCH=None BUG=None TEST=make buildall -j Change-Id: If8938512c29708f7b8c28f6ca1c707aa6b5c1708 Reviewed-on: https://chromium-review.googlesource.com/216001 Reviewed-by: Randall Spangler <rspangler@chromium.org> Commit-Queue: Anton Staaf <robotboy@chromium.org> Tested-by: Anton Staaf <robotboy@chromium.org>
55 lines
1.6 KiB
C
55 lines
1.6 KiB
C
/* Copyright (c) 2014 The Chromium OS Authors. All rights reserved.
|
|
* Use of this source code is governed by a BSD-style license that can be
|
|
* found in the LICENSE file.
|
|
*/
|
|
#ifndef INCLUDE_IN_STREAM_H
|
|
#define INCLUDE_IN_STREAM_H
|
|
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
|
|
struct in_stream;
|
|
|
|
struct in_stream_ops {
|
|
/*
|
|
* Read at most count characters from the input stream into the user
|
|
* buffer provided. Return the number of characters actually read
|
|
* into the buffer.
|
|
*/
|
|
size_t (*read)(struct in_stream const *stream,
|
|
uint8_t *buffer,
|
|
size_t count);
|
|
};
|
|
|
|
struct in_stream {
|
|
/*
|
|
* Ready will be called by the stream every time new characters are
|
|
* added to the stream. This may be called from an interrupt context
|
|
* so work done by the ready callback should be minimal. Likely this
|
|
* callback will be used to call task_wake, or some similar signaling
|
|
* mechanism.
|
|
*
|
|
* This callback is part of the user configuration of a stream, and not
|
|
* a stream manipulation function (in_stream_ops). That means that
|
|
* each stream can be configured with its own ready callback.
|
|
*
|
|
* If no callback functionality is required ready can be specified as
|
|
* NULL.
|
|
*/
|
|
void (*ready)(struct in_stream const *stream);
|
|
|
|
struct in_stream_ops const *ops;
|
|
};
|
|
|
|
/*
|
|
* Helper functions that call the associated stream operation and pass it the
|
|
* given stream. These help prevent mistakes where one stream is passed to
|
|
* another stream's functions.
|
|
*/
|
|
size_t in_stream_read(struct in_stream const *stream,
|
|
uint8_t *buffer,
|
|
size_t count);
|
|
void in_stream_ready(struct in_stream const *stream);
|
|
|
|
#endif /* INCLUDE_IN_STREAM_H */
|