diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-08-29 08:39:32 -0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-09-09 09:21:50 -0300 |
commit | b6df512a9f9580abc07cd1963ced91b5a87619ed (patch) | |
tree | ac6cff5f172d4587640c4482aaadc9287b4ca76f /drivers/media/dvb-core/dvb_ringbuffer.h | |
parent | ff54c19d8e8fcfd9f660bf849b0e92f8c69cc0c2 (diff) |
[media] dtv-core.rst: move DTV ringbuffer notes to kAPI doc
Instead of keeping those notes at the file on a non-structured
way, move them to dtv-core.rst, using the proper ReST tags.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'drivers/media/dvb-core/dvb_ringbuffer.h')
-rw-r--r-- | drivers/media/dvb-core/dvb_ringbuffer.h | 28 |
1 files changed, 0 insertions, 28 deletions
diff --git a/drivers/media/dvb-core/dvb_ringbuffer.h b/drivers/media/dvb-core/dvb_ringbuffer.h index 8209eb4db2aa..f64bd86fe5fd 100644 --- a/drivers/media/dvb-core/dvb_ringbuffer.h +++ b/drivers/media/dvb-core/dvb_ringbuffer.h @@ -66,34 +66,6 @@ extern void dvb_ringbuffer_init(struct dvb_ringbuffer *rbuf, void *data, * * @rbuf: pointer to struct dvb_ringbuffer */ -/* - * Notes: - * ------ - * (1) For performance reasons read and write routines don't check buffer sizes - * and/or number of bytes free/available. This has to be done before these - * routines are called. For example: - * - * *** write @buflen: bytes *** - * free = dvb_ringbuffer_free(rbuf); - * if (free >= buflen) - * count = dvb_ringbuffer_write(rbuf, buffer, buflen); - * else - * ... - * - * *** read min. 1000, max. @bufsize: bytes *** - * avail = dvb_ringbuffer_avail(rbuf); - * if (avail >= 1000) - * count = dvb_ringbuffer_read(rbuf, buffer, min(avail, bufsize)); - * else - * ... - * - * (2) If there is exactly one reader and one writer, there is no need - * to lock read or write operations. - * Two or more readers must be locked against each other. - * Flushing the buffer counts as a read operation. - * Resetting the buffer counts as a read and write operation. - * Two or more writers must be locked against each other. - */ extern int dvb_ringbuffer_empty(struct dvb_ringbuffer *rbuf); /** |