diff options
Diffstat (limited to 'drivers/media/dvb-core/dvb_ringbuffer.h')
-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, | |||
150 | 150 | ||
151 | /** | 151 | /** |
152 | * dvb_ringbuffer_pkt_read_user - Read from a packet in the ringbuffer. | 152 | * dvb_ringbuffer_pkt_read_user - Read from a packet in the ringbuffer. |
153 | * Note: unlike dvb_ringbuffer_read(), this does NOT update the read pointer | ||
154 | * in the ringbuffer. You must use dvb_ringbuffer_pkt_dispose() to mark a | ||
155 | * packet as no longer required. | ||
156 | * | 153 | * |
157 | * @rbuf: Ringbuffer concerned. | 154 | * @rbuf: Ringbuffer concerned. |
158 | * @idx: Packet index as returned by dvb_ringbuffer_pkt_next(). | 155 | * @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 | * @len: Size of destination buffer. | 158 | * @len: Size of destination buffer. |
162 | * | 159 | * |
163 | * returns Number of bytes read, or -EFAULT. | 160 | * returns Number of bytes read, or -EFAULT. |
161 | * | ||
162 | * .. note:: | ||
163 | * | ||
164 | * unlike dvb_ringbuffer_read(), this does **NOT** update the read pointer | ||
165 | * in the ringbuffer. You must use dvb_ringbuffer_pkt_dispose() to mark a | ||
166 | * packet as no longer required. | ||
164 | */ | 167 | */ |
165 | extern ssize_t dvb_ringbuffer_pkt_read_user(struct dvb_ringbuffer *rbuf, size_t idx, | 168 | extern ssize_t dvb_ringbuffer_pkt_read_user(struct dvb_ringbuffer *rbuf, |
166 | int offset, u8 __user *buf, size_t len); | 169 | size_t idx, |
170 | int offset, u8 __user *buf, | ||
171 | size_t len); | ||
167 | 172 | ||
168 | /** | 173 | /** |
169 | * dvb_ringbuffer_pkt_read - Read from a packet in the ringbuffer. | 174 | * dvb_ringbuffer_pkt_read - Read from a packet in the ringbuffer. |