Commit 586027ce authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

doc-rst: linux_tv: reformat all syscall pages 



The syscall pages are written to be used also as man-pages.

However, they don't match the format used by kernel-doc
generated pages from DocBook. Rewrite them to match it.

One side effect is that now all such pages at the book
will have the same format, reducing the format differences
between DVB and the other parts of the book.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 47d23e36

Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst

+22 −17
Original line number Diff line number Diff line
@@ -6,27 +6,19 @@ 
FE_DISHNETWORK_SEND_LEGACY_CMD

******************************



Description

-----------

NAME

====



WARNING: This is a very obscure legacy command, used only at stv0299

driver. Should not be used on newer drivers.



It provides a non-standard method for selecting Diseqc voltage on the

frontend, for Dish Network legacy switches.



As support for this ioctl were added in 2004, this means that such

dishes were already legacy in 2004.

FE_DISHNETWORK_SEND_LEGACY_CMD



Synopsis

--------

SYNOPSIS

========



.. c:function:: int  ioctl(int fd, int request = FE_DISHNETWORK_SEND_LEGACY_CMD, unsigned long cmd)



Arguments

----------





ARGUMENTS

=========



.. flat-table::

    :header-rows:  0
@@ -40,8 +32,21 @@ Arguments 
       -  sends the specified raw cmd to the dish via DISEqC.





Return Value

------------

DESCRIPTION

===========



WARNING: This is a very obscure legacy command, used only at stv0299

driver. Should not be used on newer drivers.



It provides a non-standard method for selecting Diseqc voltage on the

frontend, for Dish Network legacy switches.



As support for this ioctl were added in 2004, this means that such

dishes were already legacy in 2004.





RETURN VALUE

============



On success 0 is returned, on error -1 and the ``errno`` variable is set

appropriately. The generic error codes are described at the

Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst

+19 −14
Original line number Diff line number Diff line
@@ -6,24 +6,19 @@ 
FE_GET_EVENT

************



Description

-----------

NAME

====



This ioctl call returns a frontend event if available. If an event is

not available, the behavior depends on whether the device is in blocking

or non-blocking mode. In the latter case, the call fails immediately

with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until

an event becomes available.

FE_GET_EVENT



Synopsis

--------

SYNOPSIS

========



.. c:function:: int  ioctl(int fd, int request = QPSK_GET_EVENT, struct dvb_frontend_event *ev)



Arguments

----------





ARGUMENTS

=========



.. flat-table::

    :header-rows:  0
@@ -54,8 +49,18 @@ Arguments 
       -  if any, is to be stored.





Return Value

------------

DESCRIPTION

===========



This ioctl call returns a frontend event if available. If an event is

not available, the behavior depends on whether the device is in blocking

or non-blocking mode. In the latter case, the call fails immediately

with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until

an event becomes available.





RETURN VALUE

============



On success 0 is returned, on error -1 and the ``errno`` variable is set

appropriately. The generic error codes are described at the

Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst

+16 −11
Original line number Diff line number Diff line
@@ -6,21 +6,19 @@ 
FE_GET_FRONTEND

***************



Description

-----------

NAME

====



This ioctl call queries the currently effective frontend parameters. For

this command, read-only access to the device is sufficient.

FE_GET_FRONTEND



Synopsis

--------

SYNOPSIS

========



.. c:function:: int ioctl(int fd, int request = FE_GET_FRONTEND, struct dvb_frontend_parameters *p)



Arguments

----------





ARGUMENTS

=========



.. flat-table::

    :header-rows:  0
@@ -47,8 +45,15 @@ Arguments 
       -  Points to parameters for tuning operation.





Return Value

------------

DESCRIPTION

===========



This ioctl call queries the currently effective frontend parameters. For

this command, read-only access to the device is sufficient.





RETURN VALUE

============



On success 0 is returned, on error -1 and the ``errno`` variable is set

appropriately. The generic error codes are described at the

Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst

+17 −12
Original line number Diff line number Diff line
@@ -6,22 +6,19 @@ 
FE_READ_SIGNAL_STRENGTH

***********************



Description

-----------

NAME

====



This ioctl call returns the signal strength value for the signal

currently received by the front-end. For this command, read-only access

to the device is sufficient.

FE_READ_SIGNAL_STRENGTH



Synopsis

--------

SYNOPSIS

========



.. c:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength)



Arguments

----------





ARGUMENTS

=========



.. flat-table::

    :header-rows:  0
@@ -49,8 +46,16 @@ Arguments 
       -  The signal strength value is stored into \*strength.





Return Value

------------

DESCRIPTION

===========



This ioctl call returns the signal strength value for the signal

currently received by the front-end. For this command, read-only access

to the device is sufficient.





RETURN VALUE

============



On success 0 is returned, on error -1 and the ``errno`` variable is set

appropriately. The generic error codes are described at the

Documentation/linux_tv/media/dvb/FE_READ_SNR.rst

+17 −12
Original line number Diff line number Diff line
@@ -6,22 +6,19 @@ 
FE_READ_SNR

***********



Description

-----------

NAME

====



This ioctl call returns the signal-to-noise ratio for the signal

currently received by the front-end. For this command, read-only access

to the device is sufficient.

FE_READ_SNR



Synopsis

--------

SYNOPSIS

========



.. c:function:: int  ioctl(int fd, int request = FE_READ_SNR, int16_t *snr)



Arguments

----------





ARGUMENTS

=========



.. flat-table::

    :header-rows:  0
@@ -47,8 +44,16 @@ Arguments 
       -  The signal-to-noise ratio is stored into \*snr.





Return Value

------------

DESCRIPTION

===========



This ioctl call returns the signal-to-noise ratio for the signal

currently received by the front-end. For this command, read-only access

to the device is sufficient.





RETURN VALUE

============



On success 0 is returned, on error -1 and the ``errno`` variable is set

appropriately. The generic error codes are described at the