Merge remote-tracking branch 'mfd/for-mfd-next'
[deliverable/linux.git] / Documentation / media / uapi / dvb / dmx-get-stc.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _DMX_GET_STC:
4
586027ce 5===========
47d23e36
MCC
6DMX_GET_STC
7===========
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12DMX_GET_STC
47d23e36 13
15e7d615
MCC
14
15Synopsis
47d23e36
MCC
16--------
17
cf8076c3
MCC
18.. c:function:: int ioctl( int fd, DMX_GET_STC, struct dmx_stc *stc)
19 :name: DMX_GET_STC
47d23e36 20
15e7d615 21Arguments
586027ce 22---------
47d23e36 23
cf8076c3
MCC
24``fd``
25 File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
47d23e36 26
cf8076c3
MCC
27``stc``
28 Pointer to the location where the stc is to be stored.
47d23e36
MCC
29
30
15e7d615 31Description
586027ce
MCC
32-----------
33
34This ioctl call returns the current value of the system time counter
35(which is driven by a PES filter of type DMX_PES_PCR). Some hardware
36supports more than one STC, so you must specify which one by setting the
37num field of stc before the ioctl (range 0...n). The result is returned
38in form of a ratio with a 64 bit numerator and a 32 bit denominator, so
39the real 90kHz STC value is stc->stc / stc->base .
40
41
15e7d615 42Return Value
47d23e36
MCC
43------------
44
45On success 0 is returned, on error -1 and the ``errno`` variable is set
46appropriately. The generic error codes are described at the
47:ref:`Generic Error Codes <gen-errors>` chapter.
48
47d23e36
MCC
49.. flat-table::
50 :header-rows: 0
51 :stub-columns: 0
52
53
54 - .. row 1
55
56 - ``EINVAL``
57
58 - Invalid stc number.
This page took 0.045354 seconds and 5 git commands to generate.