summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/rc
Commit message (Collapse)AuthorAgeFilesLines
* media: lirc-func.rst: new ioctl LIRC_GET_REC_TIMEOUT is not in a separate fileSean Young2018-05-141-1/+0
| | | | | | | | | | | This fixes the warning: Documentation/media/uapi/rc/lirc-func.rst:9: WARNING: toctree contains reference to nonexisting document 'media/uapi/rc/lirc-get-rec-timeout' The ioctl is documented in lirc-set-rec-timeout. Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
* Merge tag 'v4.17-rc4' into patchworkMauro Carvalho Chehab2018-05-101-1/+1
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Linux 4.17-rc4 * tag 'v4.17-rc4': (920 commits) Linux 4.17-rc4 KVM: x86: remove APIC Timer periodic/oneshot spikes genksyms: fix typo in parse.tab.{c,h} generation rules kbuild: replace hardcoded bison in cmd_bison_h with $(YACC) gcc-plugins: fix build condition of SANCOV plugin MAINTAINERS: Update Kbuild entry with a few paths Revert "usb: host: ehci: Use dma_pool_zalloc()" platform/x86: Kconfig: Fix dell-laptop dependency chain. platform/x86: asus-wireless: Fix NULL pointer dereference arm64: vgic-v2: Fix proxying of cpuif access KVM: arm/arm64: vgic_init: Cleanup reference to process_maintenance KVM: arm64: Fix order of vcpu_write_sys_reg() arguments MAINTAINERS & files: Canonize the e-mails I use at files media: imx-media-csi: Fix inconsistent IS_ERR and PTR_ERR tools: power/acpi, revert to LD = gcc bdi: Fix oops in wb_workfn() RDMA/cma: Do not query GID during QP state transition to RTR IB/mlx4: Fix integer overflow when calculating optimal MTT size IB/hfi1: Fix memory leak in exception path in get_irq_affinity() IB/{hfi1, rdmavt}: Fix memory leak in hfi1_alloc_devdata() upon failure ...
| * MAINTAINERS & files: Canonize the e-mails I use at filesMauro Carvalho Chehab2018-05-041-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | From now on, I'll start using my @kernel.org as my development e-mail. As such, let's remove the entries that point to the old mchehab@s-opensource.com at MAINTAINERS file. For the files written with a copyright with mchehab@s-opensource, let's keep Samsung on their names, using mchehab+samsung@kernel.org, in order to keep pointing to my employer, with sponsors the work. For the files written before I join Samsung (on July, 4 2013), let's just use mchehab@kernel.org. For bug reports, we can simply point to just kernel.org, as this will reach my mchehab+samsung inbox anyway. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Brian Warner <brian.warner@samsung.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
* | media: rc: add ioctl to get the current timeoutSean Young2018-04-202-5/+10
| | | | | | | | | | | | | | | | Since the kernel now modifies the timeout, make it possible to retrieve the current value. Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | media: rc: report receiver and transmitter type on device registerSean Young2018-04-201-1/+1
|/ | | | | | | | | On the raspberry pi, we might have two lirc devices; one for sending and one for receiving. This change makes it much more apparent which one is which. Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: rc: no need to announce major numberSean Young2018-02-271-1/+0
| | | | | | | | | | Since commit a60d64b15c20 ("media: lirc: lirc interface should not be a raw decoder"), the message in the documentation is incorrect as the module name is rc_core, not lirc_dev. Since the message is not useful, just make the message debug and remove it from the documentation. Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: lirc: lirc mode ioctls deal with current modeSean Young2018-01-232-18/+62
| | | | | | | | | The ioctl change the current mode or return the current mode; they do not tell you which modes are possible (use the lirc features ioctl for that). Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: lirc: lirc daemon fails to detect raw IR deviceSean Young2018-01-231-13/+11
| | | | | | | | | | | | | | | | | Since commit 9b6192589be7 ("media: lirc: implement scancode sending"), and commit de142c324106 ("media: lirc: implement reading scancode") the lirc features ioctl for raw IR devices advertises two modes for sending and receiving. The lirc daemon now fails to detect a raw IR device, both for transmit and receive. To fix this, do not advertise the scancode mode in the lirc features for raw IR devices (however do keep it for scancode devices). The mode can still be used via the LIRC_SET_{REC,SEND}_MODE ioctl. Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: lirc: when transmitting scancodes, block until transmit is doneSean Young2017-12-181-2/+2
| | | | | | | | | | | | | | | | | The semantics for lirc IR transmit with raw IR is that the write call should block until the IR is transmitted. Some drivers have no idea when this actually is (e.g. mceusb), so there is a wait. This is useful for userspace, as it might want to send a IR button press, a gap of a predefined number of milliseconds, and then send a repeat message. It turns out that for transmitting scancodes this feature is even more useful, as user space has no idea how long the IR is. So, maintain the existing semantics for IR scancode transmit. Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: RC docs: add enum rc_proto description at the docsMauro Carvalho Chehab2017-12-143-9/+16
| | | | | | | | This is part of the uAPI. Add it to the documentation again, and fix cross-references. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Sean Young <sean@mess.org>
* media: lirc: document LIRC_MODE_SCANCODESean Young2017-12-146-15/+92
| | | | | | | Lirc supports a new mode which requires documentation. Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: lirc: remove name from lirc_devSean Young2017-12-141-1/+1
| | | | | | | This is a duplicate of rcdev->driver_name. Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: lirc: remove LIRCCODE and LIRC_GET_LENGTHSean Young2017-12-146-70/+4
| | | | | | | | | LIRCCODE is a lirc mode where a driver produces driver-dependent codes for receive and transmit. No driver uses this any more. The LIRC_GET_LENGTH ioctl was used for this mode only. Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: docs: don't show ToC for each part on PDF outputMauro Carvalho Chehab2017-09-051-1/+3
| | | | | | | | | | The "Table of Contents" of a PDF file is generated only once, at the beginning fo the output. It doesn't produce it on each part. So, don't output this text on each part of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: rc-sysfs-nodes.rst: better use literalsMauro Carvalho Chehab2017-09-051-5/+5
| | | | | | | | | | | | A literal box provides a better visual when pdf and html output is generated for things like the output of a sysfs devnode. It alsod matches other conventions used within the media book. So, use it. While here, use literals for protocol names. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] lirc: document lirc modes betterSean Young2017-03-249-35/+82
| | | | | | | LIRC_MODE_MODE2 and LIRC_MODE_LIRCCODE were not covered at all. Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] rc: change wakeup_protocols to list all protocol variantsSean Young2017-01-301-6/+7
| | | | | | | | | | | | | | | | | | | | | | | | For IR wakeup, a driver has to program the hardware to wakeup at a specific IR sequence, so it makes no sense to allow multiple wakeup protocols to be selected. In the same manner the sysfs interface only allows one scancode to be provided. In addition, we need to know the specific variant of the protocol. In short, these changes are made to the wakeup_protocols sysfs entry: - list all the protocol variants rather than the protocol groups, e.g. "nec nec-x nec-32" rather than just "nec". - only allow one protocol variant to be selected rather than multiple - wakeup_filter can only be set once a protocol has been selected in wakeup_protocols. This is an API change, however the only user of this API is the img-ir, but the wakeup code was never merged to mainline, so it was never used. Signed-off-by: Sean Young <sean@mess.org> Cc: James Hogan <james.hogan@imgtec.com> Cc: Sifan Naeem <sifan.naeem@imgtec.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: fix two wrong :name: tagsMauro Carvalho Chehab2016-09-091-1/+1
| | | | | | | | | | | | | There's a typo there, causing 4 warnings: Documentation/media/uapi/rc/lirc-read.rst:26: WARNING: c:type reference target not found: name Documentation/media/uapi/rc/lirc-read.rst:26: WARNING: c:type reference target not found: lirc Documentation/media/uapi/v4l/func-poll.rst:25: WARNING: c:type reference target not found: name Documentation/media/uapi/v4l/func-poll.rst:25: WARNING: c:type reference target not found: v4l2 Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: Convert LIRC uAPI to use C function referencesMauro Carvalho Chehab2016-08-2217-64/+48
| | | | | | | | | | | Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. While here, improve the documentation to make them to look more like the rest of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-next: stop abusing on the cpp domainMauro Carvalho Chehab2016-08-2217-17/+17
| | | | | | | | Now that we have an override for the c domain that will do the right thing for the Kernel, stop abusing on the cpp domain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: add tabularcolumns to all tablesMauro Carvalho Chehab2016-08-221-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | LaTeX doesn't handle too well auto-width on tables, and ReST markup requires an special tag to give it the needed hints. As we're using A4 paper, we have 17cm of useful spaces. As most media tables have widths, let's use it to generate the needed via the following perl script: my ($line_size, $table_header, $has_cols) = (17.5, 0, 0); my $out; my $header = ""; my @widths = (); sub round { $_[0] > 0 ? int($_[0] + .5) : -int(-$_[0] + .5) } while (<>) { if (!$table_header) { $has_cols = 1 if (m/..\s+tabularcolumns::/); if (m/..\s+flat-table::/) { $table_header = 1; $header = $_; next; } $out .= $_; next; } $header .= $_; @widths = split(/ /, $1) if (m/:widths:\s+(.*)/); if (m/^\n$/) { if (!$has_cols && @widths) { my ($tot, $t, $i) = (0, 0, 0); foreach my $v(@widths) { $tot += $v; }; $out .= ".. tabularcolumns:: |"; for ($i = 0; $i < scalar @widths - 1; $i++) { my $v = $widths[$i]; my $w = round(10 * ($v * $line_size) / $tot) / 10; $out .= sprintf "p{%.1fcm}|", $w; $t += $w; } my $w = $line_size - $t; $out .= sprintf "p{%.1fcm}|\n\n", $w; } $out .= $header; $table_header = 0; $has_cols = 0; $header = ""; @widths = (); } } print $out; Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: better use the .. note:: tagMauro Carvalho Chehab2016-08-221-1/+3
| | | | | | | Change multi-line note tags to be more symetric, e. g. not starting the text together witht the tag. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: better organize the media booksMauro Carvalho Chehab2016-07-231-10/+7
| | | | | | | | | | | | | | | The uAPI book has 5 parts, but they lost numeration after conversion to rst. Manually number those parts, and make the main index with 1 depth, to only show the parts and the annexes. At each part, use :maxwidth: 5, in order to show a more complete index. While here, fix the cross-references between different books. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* Revert "[media] docs-rst: escape [] characters"Mauro Carvalho Chehab2016-07-131-21/+21
| | | | | | | | | | This patch touches on places where it shouldn't: image files and code examples. Also, it doesn't fix all array occurrences. So, let's revert it. This reverts commit ffbab694ede33c294e5864a5e0bf4d1474446a71.
* [media] docs-rst: escape [] charactersMauro Carvalho Chehab2016-07-121-21/+21
| | | | | | | Those characters are used for citations. Better to escape, to avoid them to be misinterpreted. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: reorganize LIRC ReST filesMauro Carvalho Chehab2016-07-126-12/+24
| | | | | | | Reorganize the LIRC rst files, using "-" instead of "_" on their names, and creating a separate chapter for syscalls. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: document LIRC set mode ioctlsMauro Carvalho Chehab2016-07-125-98/+50
| | | | | | | | | | Add LIRC_SET_[REC|SEND]_MODE ioctls to the corresponding GET functions, and put all LIRC modes altogether. As now everything is already documented on its own ioctl pages, get rid of lirc_ioctl.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: document LIRC_SET_WIDEBAND_RECEIVERMauro Carvalho Chehab2016-07-123-19/+57
| | | | | | | Put documentation for this ioctl on a separate page and improve it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: add documentation for LIRC_SET_MEASURE_CARRIER_MODEMauro Carvalho Chehab2016-07-123-9/+49
| | | | | | Place documentation for this ioctl on its own page. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: document LIRC_SET_REC_TIMEOUT_REPORTSMauro Carvalho Chehab2016-07-123-8/+50
| | | | | | Add a separate page for this ioctl and improve its documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: document LIRC_SET_REC_TIMEOUTMauro Carvalho Chehab2016-07-123-11/+53
| | | | | | Add a separate page for this ioctl and adds the cross-references. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: document LIRC_SET_TRANSMITTER_MASKMauro Carvalho Chehab2016-07-123-10/+54
| | | | | | | Add proper documentation for this ioctl, providing some additional information about its usage. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: document LIRC set carrier ioctlsMauro Carvalho Chehab2016-07-125-18/+143
| | | | | | | | Put each ioctl on its own page and improve documentation, adding cross-references for LIRC_SET_REC_CARRIER_RANGE and LIRC_SET_REC_CARRIER, with can be used together to set a carrier frequency range. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: document LIRC_GET_LENGTH ioctlMauro Carvalho Chehab2016-07-123-11/+46
| | | | | | Put documentation for this ioctl on its own page. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: document LIRC_GET_*_TIMEOUT ioctlsMauro Carvalho Chehab2016-07-123-13/+56
| | | | | | | | | Improve the documentation for those ioctls, adding them to a separate file, in order to look like the rest of the book, and to later allow to generate a man page for those ioctls. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: document LIRC_SET_SEND_DUTY_CYCLEMauro Carvalho Chehab2016-07-123-9/+50
| | | | | | Add a separate page for this ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: document LIRC_GET_REC_RESOLUTIONMauro Carvalho Chehab2016-07-123-10/+50
| | | | | | | | | Improve the documentation for this ioctl, adding it to a separate file, in order to look like the rest of the book, and to later allow to generate a man page for this ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: document ioctl LIRC_GET_REC_MODEMauro Carvalho Chehab2016-07-123-9/+60
| | | | | | | | Move the documentation of this ioctl from lirc_ioctl to its own file, and add a short description about the pulse mode used by IR RX. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: fix some lirc cross-referencesMauro Carvalho Chehab2016-07-124-7/+6
| | | | | | | | | Some references were broken. It was also mentioning LIRC_MODE_RAW, with it is not implemented on current LIRC drivers. So, fix the references. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: document ioctl LIRC_GET_SEND_MODEMauro Carvalho Chehab2016-07-113-9/+49
| | | | | | | | Move the documentation of this ioctl from lirc_ioctl to its own file, and add a short description about the pulse mode used by IR TX. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Fix LIRC_GET_FEATURES referencesMauro Carvalho Chehab2016-07-111-39/+56
| | | | | | | | The references pointed by LIRC_GET_FEATURES ioctl are broken. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: remove not used ioctls from documentationMauro Carvalho Chehab2016-07-112-74/+9
| | | | | | | As we removed those ioctls from the header file, do the same at the documentation side. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: add media/uapi/rc/lirc-header.rstMauro Carvalho Chehab2016-07-111-0/+10
| | | | | | | | | | changeset 68cd5e0bed99 ("[media] doc-rst: add LIRC header to the book") did everything but adding the lirc-reader.rst :-p My fault: I forgot to do a git add for this guy on such changeset. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Document ioctl LIRC_GET_FEATURESMauro Carvalho Chehab2016-07-113-8/+169
| | | | | | | | | The documentation for this ioctl was really crappy. Add a better documentation, using the lirc.4 man pages as a reference, plus what was written originally at the lirc-ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: improve display of notes and warningsMauro Carvalho Chehab2016-07-101-5/+7
| | | | | | | | | | There are several notes and warning mesages in the middle of the media docbook. Use the ReST tags for that, as it makes them visually better and hightlights them. While here, modify a few ones to make them clearer. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: do cross-references between header and the docMauro Carvalho Chehab2016-07-101-2/+7
| | | | | | | | | | Now that the LIRC header was added, we can cross-reference it and identify the documentation gaps. There are lots of stuff missing there, but at least now we can avoid the gap to increase. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: add LIRC header to the bookMauro Carvalho Chehab2016-07-101-0/+1
| | | | | | | Just like the other parts of the document, let's add the LIRC header, as it is part of the API. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: improve LIRC syscall documentationMauro Carvalho Chehab2016-07-103-46/+240
| | | | | | | | The lirc syscall documentation uses a very different and simplified way than the rest of the media book. make it closer. Still, there's just one page for all ioctls. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: rename some RC filesMauro Carvalho Chehab2016-07-105-4/+4
| | | | | | | | | Some files start with an upper letter. Also, they have big names. rename them. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc_rst: rename the media Sphinx suff to Documentation/mediaMauro Carvalho Chehab2016-07-0811-0/+1402
The name of the subsystem is "media", and not "linux_tv". Also, as we plan to add other stuff there in the future, let's rename also the media uAPI book to media_uapi, to make it clearer. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
OpenPOWER on IntegriCloud