~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/Documentation/userspace-api/media/dvb/dmx-fread.rst

Version: ~ [ linux-6.12-rc7 ] ~ [ linux-6.11.7 ] ~ [ linux-6.10.14 ] ~ [ linux-6.9.12 ] ~ [ linux-6.8.12 ] ~ [ linux-6.7.12 ] ~ [ linux-6.6.60 ] ~ [ linux-6.5.13 ] ~ [ linux-6.4.16 ] ~ [ linux-6.3.13 ] ~ [ linux-6.2.16 ] ~ [ linux-6.1.116 ] ~ [ linux-6.0.19 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.171 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.229 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.285 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.323 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.336 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.337 ] ~ [ linux-4.4.302 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.12 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
  2 .. c:namespace:: DTV.dmx
  3 
  4 .. _dmx_fread:
  5 
  6 =======================
  7 Digital TV demux read()
  8 =======================
  9 
 10 Name
 11 ----
 12 
 13 Digital TV demux read()
 14 
 15 Synopsis
 16 --------
 17 
 18 .. c:function:: size_t read(int fd, void *buf, size_t count)
 19 
 20 Arguments
 21 ---------
 22 
 23 ``fd``
 24   File descriptor returned by a previous call to :c:func:`open()`.
 25 
 26  ``buf``
 27    Buffer to be filled
 28 
 29 ``count``
 30    Max number of bytes to read
 31 
 32 Description
 33 -----------
 34 
 35 This system call returns filtered data, which might be section or Packetized
 36 Elementary Stream (PES) data. The filtered data is transferred from
 37 the driver's internal circular buffer to ``buf``. The maximum amount of data
 38 to be transferred is implied by count.
 39 
 40 .. note::
 41 
 42    if a section filter created with
 43    :c:type:`DMX_CHECK_CRC <dmx_sct_filter_params>` flag set,
 44    data that fails on CRC check will be silently ignored.
 45 
 46 Return Value
 47 ------------
 48 
 49 On success 0 is returned.
 50 
 51 On error -1 is returned, and the ``errno`` variable is set
 52 appropriately.
 53 
 54 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
 55 
 56 .. flat-table::
 57     :header-rows:  0
 58     :stub-columns: 0
 59     :widths: 1 16
 60 
 61     -  -  ``EWOULDBLOCK``
 62        -  No data to return and ``O_NONBLOCK`` was specified.
 63 
 64     -  -  ``EOVERFLOW``
 65        -  The filtered data was not read from the buffer in due time,
 66           resulting in non-read data being lost. The buffer is flushed.
 67 
 68     -  -  ``ETIMEDOUT``
 69        -  The section was not loaded within the stated timeout period.
 70           See ioctl :ref:`DMX_SET_FILTER` for how to set a timeout.
 71 
 72     -  -  ``EFAULT``
 73        -  The driver failed to write to the callers buffer due to an
 74           invalid \*buf pointer.
 75 
 76 The generic error codes are described at the
 77 :ref:`Generic Error Codes <gen-errors>` chapter.

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

sflogo.php