Merge branches 'pm-sleep' and 'pm-cpufreq'
[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
5929cb17 18.. cpp:function:: int ioctl( int fd, int request = DMX_GET_STC, struct dmx_stc *stc)
47d23e36 19
47d23e36 20
15e7d615 21Arguments
586027ce 22---------
47d23e36
MCC
23
24.. flat-table::
25 :header-rows: 0
26 :stub-columns: 0
27
28
29 - .. row 1
30
31 - int fd
32
33 - File descriptor returned by a previous call to open().
34
35 - .. row 2
36
37 - int request
38
39 - Equals DMX_GET_STC for this command.
40
41 - .. row 3
42
43 - struct dmx_stc \*stc
44
45 - Pointer to the location where the stc is to be stored.
46
47
15e7d615 48Description
586027ce
MCC
49-----------
50
51This ioctl call returns the current value of the system time counter
52(which is driven by a PES filter of type DMX_PES_PCR). Some hardware
53supports more than one STC, so you must specify which one by setting the
54num field of stc before the ioctl (range 0...n). The result is returned
55in form of a ratio with a 64 bit numerator and a 32 bit denominator, so
56the real 90kHz STC value is stc->stc / stc->base .
57
58
15e7d615 59Return Value
47d23e36
MCC
60------------
61
62On success 0 is returned, on error -1 and the ``errno`` variable is set
63appropriately. The generic error codes are described at the
64:ref:`Generic Error Codes <gen-errors>` chapter.
65
66
67
68.. flat-table::
69 :header-rows: 0
70 :stub-columns: 0
71
72
73 - .. row 1
74
75 - ``EINVAL``
76
77 - Invalid stc number.
This page took 0.066736 seconds and 5 git commands to generate.