diff options
| author |   Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-22 13:58:09 -0300 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-23 08:04:21 -0300 |
| commit | 7a23c2574d0c7cf3d2ddbf967e3fc32531037a16 (patch) | |
| tree | a2e48bf37b16f95bebcc37ee7ac448539bcf92db /drivers/media/dvb-core | |
| parent | [media] v4l2-ctrls.h: fully document the header file (diff) | |
| download | linux-dev-7a23c2574d0c7cf3d2ddbf967e3fc32531037a16.tar.xz linux-dev-7a23c2574d0c7cf3d2ddbf967e3fc32531037a16.zip | |
[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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'drivers/media/dvb-core')
| -rw-r--r-- | drivers/media/dvb-core/dvb_ringbuffer.h | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/drivers/media/dvb-core/dvb_ringbuffer.h b/drivers/media/dvb-core/dvb_ringbuffer.h index 3ebc2d34b4a2..8af642399f1e 100644 --- a/drivers/media/dvb-core/dvb_ringbuffer.h +++ b/drivers/media/dvb-core/dvb_ringbuffer.h @@ -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. - * 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. * @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, * @len: Size of destination buffer. * * 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, - int offset, u8 __user *buf, size_t len); +extern ssize_t dvb_ringbuffer_pkt_read_user(struct dvb_ringbuffer *rbuf, + size_t idx, + int offset, u8 __user *buf, + size_t len); /** * dvb_ringbuffer_pkt_read - Read from a packet in the ringbuffer. |