1059b1c5bSMauro Carvalho Chehab.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2f9b2e8aaSMauro Carvalho Chehab.. c:namespace:: DTV.dmx
354f38fcaSMauro Carvalho Chehab
454f38fcaSMauro Carvalho Chehab.. _DMX_GET_STC:
554f38fcaSMauro Carvalho Chehab
654f38fcaSMauro Carvalho Chehab===========
754f38fcaSMauro Carvalho ChehabDMX_GET_STC
854f38fcaSMauro Carvalho Chehab===========
954f38fcaSMauro Carvalho Chehab
1054f38fcaSMauro Carvalho ChehabName
1154f38fcaSMauro Carvalho Chehab----
1254f38fcaSMauro Carvalho Chehab
1354f38fcaSMauro Carvalho ChehabDMX_GET_STC
1454f38fcaSMauro Carvalho Chehab
1554f38fcaSMauro Carvalho ChehabSynopsis
1654f38fcaSMauro Carvalho Chehab--------
1754f38fcaSMauro Carvalho Chehab
18f9b2e8aaSMauro Carvalho Chehab.. c:macro:: DMX_GET_STC
19f9b2e8aaSMauro Carvalho Chehab
20f9b2e8aaSMauro Carvalho Chehab``int ioctl(int fd, DMX_GET_STC, struct dmx_stc *stc)``
2154f38fcaSMauro Carvalho Chehab
2254f38fcaSMauro Carvalho ChehabArguments
2354f38fcaSMauro Carvalho Chehab---------
2454f38fcaSMauro Carvalho Chehab
2554f38fcaSMauro Carvalho Chehab``fd``
26f9b2e8aaSMauro Carvalho Chehab    File descriptor returned by :c:func:`open()`.
2754f38fcaSMauro Carvalho Chehab
2854f38fcaSMauro Carvalho Chehab``stc``
2954f38fcaSMauro Carvalho Chehab    Pointer to :c:type:`dmx_stc` where the stc data is to be stored.
3054f38fcaSMauro Carvalho Chehab
3154f38fcaSMauro Carvalho ChehabDescription
3254f38fcaSMauro Carvalho Chehab-----------
3354f38fcaSMauro Carvalho Chehab
3454f38fcaSMauro Carvalho ChehabThis ioctl call returns the current value of the system time counter
3554f38fcaSMauro Carvalho Chehab(which is driven by a PES filter of type :c:type:`DMX_PES_PCR <dmx_ts_pes>`).
3654f38fcaSMauro Carvalho ChehabSome hardware supports more than one STC, so you must specify which one by
3754f38fcaSMauro Carvalho Chehabsetting the :c:type:`num <dmx_stc>` field of stc before the ioctl (range 0...n).
3854f38fcaSMauro Carvalho ChehabThe result is returned in form of a ratio with a 64 bit numerator
3954f38fcaSMauro Carvalho Chehaband a 32 bit denominator, so the real 90kHz STC value is
4054f38fcaSMauro Carvalho Chehab``stc->stc / stc->base``.
4154f38fcaSMauro Carvalho Chehab
4254f38fcaSMauro Carvalho ChehabReturn Value
4354f38fcaSMauro Carvalho Chehab------------
4454f38fcaSMauro Carvalho Chehab
4554f38fcaSMauro Carvalho ChehabOn success 0 is returned.
4654f38fcaSMauro Carvalho Chehab
4754f38fcaSMauro Carvalho ChehabOn error -1 is returned, and the ``errno`` variable is set
4854f38fcaSMauro Carvalho Chehabappropriately.
4954f38fcaSMauro Carvalho Chehab
5054f38fcaSMauro Carvalho Chehab.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
5154f38fcaSMauro Carvalho Chehab
5254f38fcaSMauro Carvalho Chehab.. flat-table::
5354f38fcaSMauro Carvalho Chehab    :header-rows:  0
5454f38fcaSMauro Carvalho Chehab    :stub-columns: 0
5554f38fcaSMauro Carvalho Chehab    :widths: 1 16
5654f38fcaSMauro Carvalho Chehab
5754f38fcaSMauro Carvalho Chehab    -  .. row 1
5854f38fcaSMauro Carvalho Chehab
5954f38fcaSMauro Carvalho Chehab       -  ``EINVAL``
6054f38fcaSMauro Carvalho Chehab
6154f38fcaSMauro Carvalho Chehab       -  Invalid stc number.
6254f38fcaSMauro Carvalho Chehab
6354f38fcaSMauro Carvalho ChehabThe generic error codes are described at the
6454f38fcaSMauro Carvalho Chehab:ref:`Generic Error Codes <gen-errors>` chapter.
65