From 1d174e7573a2b847b3372dc88e1f14ac0d413caa Mon Sep 17 00:00:00 2001 From: Hans Verkuil Date: Sun, 16 Jul 2017 05:18:50 -0300 Subject: [PATCH] media: pulse8-cec.rst: add documentation for the pulse8-cec driver Document the persistent_config module option. Signed-off-by: Hans Verkuil Signed-off-by: Mauro Carvalho Chehab --- Documentation/media/cec-drivers/index.rst | 32 ++++++++++++++++++++++++++ Documentation/media/cec-drivers/pulse8-cec.rst | 11 +++++++++ Documentation/media/index.rst | 1 + MAINTAINERS | 1 + 4 files changed, 45 insertions(+) create mode 100644 Documentation/media/cec-drivers/index.rst create mode 100644 Documentation/media/cec-drivers/pulse8-cec.rst diff --git a/Documentation/media/cec-drivers/index.rst b/Documentation/media/cec-drivers/index.rst new file mode 100644 index 000000000000..1c817aa10bb6 --- /dev/null +++ b/Documentation/media/cec-drivers/index.rst @@ -0,0 +1,32 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. include:: + +.. _cec-drivers: + +################################# +CEC driver-specific documentation +################################# + +**Copyright** |copy| 2017 : LinuxTV Developers + +This documentation is free software; you can redistribute it and/or modify it +under the terms of the GNU General Public License as published by the Free +Software Foundation version 2 of the License. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +more details. + +For more details see the file COPYING in the source distribution of Linux. + +.. class:: toc-title + + Table of Contents + +.. toctree:: + :maxdepth: 5 + :numbered: + + pulse8-cec diff --git a/Documentation/media/cec-drivers/pulse8-cec.rst b/Documentation/media/cec-drivers/pulse8-cec.rst new file mode 100644 index 000000000000..99551c6a9bc5 --- /dev/null +++ b/Documentation/media/cec-drivers/pulse8-cec.rst @@ -0,0 +1,11 @@ +Pulse-Eight CEC Adapter driver +============================== + +The pulse8-cec driver implements the following module option: + +``persistent_config`` +--------------------- + +By default this is off, but when set to 1 the driver will store the current +settings to the device's internal eeprom and restore it the next time the +device is connected to the USB port. diff --git a/Documentation/media/index.rst b/Documentation/media/index.rst index 7f8f0af620ce..7d2907d4f8d7 100644 --- a/Documentation/media/index.rst +++ b/Documentation/media/index.rst @@ -10,6 +10,7 @@ Contents: media_kapi dvb-drivers/index v4l-drivers/index + cec-drivers/index .. only:: subproject diff --git a/MAINTAINERS b/MAINTAINERS index 205d3977ac46..a02115191b46 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -10700,6 +10700,7 @@ L: linux-media@vger.kernel.org T: git git://linuxtv.org/media_tree.git S: Maintained F: drivers/media/usb/pulse8-cec/* +F: Documentation/media/cec-drivers/pulse8-cec.rst PVRUSB2 VIDEO4LINUX DRIVER M: Mike Isely -- 2.11.0