Verified Commit 7b8e4ae4 authored by Rahix's avatar Rahix
Browse files

docs: Document EBUSY on stream API functions



Signed-off-by: Rahix's avatarRahix <rahix@rahix.de>
parent cebdade6
......@@ -92,6 +92,7 @@ API(API_LEDS_SET, void epic_leds_set(int led, uint8_t r, uint8_t g, uint8_t b));
* - ``-ENODEV``: Sensor is not currently available.
* - ``-EBADF``: The given sensor descriptor is unknown.
* - ``-EINVAL``: ``count`` is not a multiple of the sensor's sample size.
* - ``-EBUSY``: The descriptor table lock could not be acquired.
*
* **Example**:
*
......
......@@ -60,6 +60,7 @@ struct stream_info {
*
* - ``-EINVAL``: Out of range sensor descriptor.
* - ``-EACCES``: Stream already registered.
* - ``-EBUSY``: The descriptor lock could not be acquired.
*/
int stream_register(int sd, struct stream_info *stream);
......@@ -74,6 +75,7 @@ int stream_register(int sd, struct stream_info *stream);
*
* - ``-EINVAL``: Out of range sensor descriptor.
* - ``-EACCES``: Stream ``stream`` was not registered for ``sd``.
* - ``-EBUSY``: The descriptor lock could not be acquired.
*/
int stream_deregister(int sd, struct stream_info *stream);
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment