Commit 7a23c257 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

[media] dvb_ringbuffer.h: some documentation improvements

Better document a note on this header.

While here, better format dvb_ringbuffer_pkt_read_user()
to adjust it to CodingStyle.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 8ec4bee7
...@@ -150,9 +150,6 @@ extern ssize_t dvb_ringbuffer_pkt_write(struct dvb_ringbuffer *rbuf, u8* buf, ...@@ -150,9 +150,6 @@ extern ssize_t dvb_ringbuffer_pkt_write(struct dvb_ringbuffer *rbuf, u8* buf,
/** /**
* dvb_ringbuffer_pkt_read_user - Read from a packet in the ringbuffer. * dvb_ringbuffer_pkt_read_user - Read from a packet in the ringbuffer.
* Note: unlike dvb_ringbuffer_read(), this does NOT update the read pointer
* in the ringbuffer. You must use dvb_ringbuffer_pkt_dispose() to mark a
* packet as no longer required.
* *
* @rbuf: Ringbuffer concerned. * @rbuf: Ringbuffer concerned.
* @idx: Packet index as returned by dvb_ringbuffer_pkt_next(). * @idx: Packet index as returned by dvb_ringbuffer_pkt_next().
...@@ -161,9 +158,17 @@ extern ssize_t dvb_ringbuffer_pkt_write(struct dvb_ringbuffer *rbuf, u8* buf, ...@@ -161,9 +158,17 @@ extern ssize_t dvb_ringbuffer_pkt_write(struct dvb_ringbuffer *rbuf, u8* buf,
* @len: Size of destination buffer. * @len: Size of destination buffer.
* *
* returns Number of bytes read, or -EFAULT. * returns Number of bytes read, or -EFAULT.
*
* .. note::
*
* unlike dvb_ringbuffer_read(), this does **NOT** update the read pointer
* in the ringbuffer. You must use dvb_ringbuffer_pkt_dispose() to mark a
* packet as no longer required.
*/ */
extern ssize_t dvb_ringbuffer_pkt_read_user(struct dvb_ringbuffer *rbuf, size_t idx, extern ssize_t dvb_ringbuffer_pkt_read_user(struct dvb_ringbuffer *rbuf,
int offset, u8 __user *buf, size_t len); size_t idx,
int offset, u8 __user *buf,
size_t len);
/** /**
* dvb_ringbuffer_pkt_read - Read from a packet in the ringbuffer. * dvb_ringbuffer_pkt_read - Read from a packet in the ringbuffer.
......
Markdown is supported
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