aboutsummaryrefslogtreecommitdiff
path: root/Documentation/driver-api/media
AgeCommit message (Collapse)AuthorFilesLines
2022-04-24media: Documentation: add documentation about subdev stateTomi Valkeinen1-0/+69
Add documentation about centrally managed subdev state. Signed-off-by: Tomi Valkeinen <[email protected]> Reviewed-by: Jacopo Mondi <[email protected]> Reviewed-by: Hans Verkuil <[email protected]> Reviewed-by: Laurent Pinchart <[email protected]> Signed-off-by: Sakari Ailus <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2022-04-24media: cec: add optional adap_configured callbackHans Verkuil1-1/+12
This new optional callback is called when the adapter is fully configured or fully unconfigured. Some drivers may have to take action when this happens. Signed-off-by: Hans Verkuil <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2022-03-18media: platform: rename omap3isp/ to ti/omap3isp/Mauro Carvalho Chehab1-1/+1
As the end goal is to have platform drivers split by vendor, rename omap3isp/ to ti/omap3isp/. Reviewed-by: Laurent Pinchart <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2022-03-18media: platform: rename davinci/ to ti/davinci/Mauro Carvalho Chehab1-10/+10
As the end goal is to have platform drivers split by vendor, rename davinci/ to ti/davinci/. Reviewed-by: Laurent Pinchart <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2022-03-18media: platform: rename exynos4-is/ to samsung/exynos4-is/Mauro Carvalho Chehab1-7/+7
As the end goal is to have platform drivers split by vendor, rename exynos4-is/ to samsung/exynos4-is/. Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-11-15media: drivers/index.rst: add missing rkisp1 entryHans Verkuil1-0/+1
The Documentation/driver-api/media/drivers/rkisp1.rst file wasn't referenced in the index.rst file, so it was never included. Add it. Signed-off-by: Hans Verkuil <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-10-08media: remove myself from dvb media maintainersSean Young1-1/+1
I have not been able to give dvb the attention it needs, and now I have even less time. Of course I will continue to maintain rc-core (infrared). Unfortunately this means that dvb will have maintainance issues. Signed-off-by: Sean Young <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-09-30media: rockchip: rkisp1: add support for v12 isp variantsHeiko Stuebner1-0/+43
The rkisp1 evolved over soc generations and the rk3326/px30 introduced the so called v12 - probably meaning v1.2. Add the new register definitions. Signed-off-by: Heiko Stuebner <[email protected]> Reviewed-by: Dafna Hirschfeld <[email protected]> Signed-off-by: Hans Verkuil <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-09-30media: v4l: async: Rename async nf functions, clean up long linesSakari Ailus1-7/+7
Rename V4L2 async notifier functions, replacing "notifier" with "nf" and removing "_subdev" at the end of the function names adding subdevs as you can only add subdevs to a notifier. Also wrap and otherwise clean up long lines. Signed-off-by: Sakari Ailus <[email protected]> Reviewed-by: Jacopo Mondi <[email protected]> Reviewed-by: Rui Miguel Silva <[email protected]> (imx7) Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-08-04media: Documentation: v4l: Rework LP-11 documentation, add callbacksSakari Ailus1-12/+28
Rework LP-11 and LP-111 mode documentation to make it more understandable and useful. This involves adding pre_streamon and post_streamon callbacks that make it possible to explicitly transition the transmitter to either mode. Signed-off-by: Sakari Ailus <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-08-04media: Documentation: media: Fix v4l2-async kerneldoc syntaxSakari Ailus1-4/+4
Fix kerneldoc syntax in v4l2-async. The references were not produced correctly. Signed-off-by: Sakari Ailus <[email protected]> Reviewed-by: Jacopo Mondi <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-08-04media: Documentation: media: Improve camera sensor documentationSakari Ailus4-123/+135
Modernise the documentation to make it more precise and update the use of pixel rate control and various other changes. In particular: - Use non-proportional font for file names, properties as well as controls. - The unit of the HBLANK control is pixels, not lines. - The unit of PIXEL_RATE control is pixels per second, not Hz. - Merge common requirements for CSI-2 and parallel busses. - Include all DT properties needed for assigned clocks. - Fix referencing the link rate control. - SMIA driver's new name is CCS driver. - The PIXEL_RATE control denotes pixel rate on the pixel array on camera sensors. Do not suggest it is used to tell the maximum pixel rate on the bus anymore. - Improve ReST syntax (plain struct and function names). - Remove the suggestion to use s_power() in receiver drivers. - Make MIPI website URL use HTTPS, add Wikipedia links to BT.601 and BT.656. Fixes: e4cf8c58af75 ("media: Documentation: media: Document how to write camera sensor drivers") Signed-off-by: Sakari Ailus <[email protected]> Reviewed-by: Jacopo Mondi <[email protected]> Reviewed-by: Andrey Konovalov <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-07-22media: media/cec-core.rst: update adap_enable docHans Verkuil1-3/+6
The description of adap_enable was out-of-date. Improve it so that it corresponds to what really happens. Signed-off-by: Hans Verkuil <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-06-16media: driver-api: drivers: avoid using ReST :doc:`foo` markupMauro Carvalho Chehab1-1/+1
The :doc:`foo` tag is auto-generated via automarkup.py. So, use the filename at the sources, instead of :doc:`foo`. Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-06-16media: docs: */media/index.rst: don't use ReST doc:`foo`Mauro Carvalho Chehab1-4/+6
The :doc:`foo` tag is auto-generated via automarkup.py. So, use the filename at the sources, instead of :doc:`foo`. Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-06-02docs: driver-api: media: zoran: replace SOFT HYPHEN characterMauro Carvalho Chehab1-1/+1
Replace the occurences of the following character: - U+00ad ('­'): SOFT HYPHEN as ASCII HYPHEN is preferred over SOFT HYPHEN At least with some fonts, a SOFT HYPHEN is displayed as a blank space. Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-06-02media: Documentation: ccs: Fix the op_pll_multiplier addressBernhard Wimmer2-3/+4
According to the CCS spec the op_pll_multiplier address is 0x030e, not 0x031e. Signed-off-by: Bernhard Wimmer <[email protected]> Signed-off-by: Sakari Ailus <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-04-06media: v4l: fwnode: Rename v4l2_async_register_subdev_sensor_commonSakari Ailus1-1/+1
Rename v4l2_async_register_subdev_sensor_common as v4l2_async_register_subdev_sensor. This is a part of the effort to make the long names present in V4L2 fwnode and async frameworks shorter. Signed-off-by: Sakari Ailus <[email protected]> Reviewed-by: Ezequiel Garcia <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-03-23media: camera-sensor.rst: fix c:function build warningMauro Carvalho Chehab1-3/+1
The :c:function: tag evaluation depends on Sphinx version 2 or 3. Use a syntax that should work with both versions. Link: https://lore.kernel.org/linux-media/e4214991b7d59c0d7aa4e6e48833dc1809c47d47.1616484262.git.mchehab+huawei@kernel.org Fixes: c0e3bcb25390 ("media: camera-sensor.rst: fix a doc build warning") Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-03-22media: camera-sensor.rst: fix a doc build warningMauro Carvalho Chehab1-0/+1
Documentation/driver-api/media/camera-sensor.rst:123: WARNING: Inline literal start-string without end-string. There's a missing blank line over there. Link: https://lore.kernel.org/linux-media/c326774ad841b905c3b2925e5f8f509d29fb4c6f.1599656828.git.mchehab+huawei@kernel.org Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-03-22media: add a subsystem profile documentationMauro Carvalho Chehab2-0/+208
Document the basic policies of the media subsystem profile. Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-03-11media: v4l2-subdev.rst: typo fixTomi Valkeinen1-1/+1
Fix a typo in the text. Signed-off-by: Tomi Valkeinen <[email protected]> Signed-off-by: Hans Verkuil <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-02-06media: Remove the legacy v4l2-clk APIEzequiel Garcia2-32/+0
The V4L2 temporary clock helper API, was introduced in late 2012 and, as mentioned in the documentation, meant to be replaced by the generic clock API, once the generic clock framework became available on all relevant architectures. The generic clock API is a well-established API (since a few years now). The last few media capture drivers and sensors using v4l2-clk have been converted to the generic clock framework. We can now remove the v4l2-clk API. Signed-off-by: Ezequiel Garcia <[email protected]> Acked-by: Petr Cvek <[email protected]> Signed-off-by: Sakari Ailus <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-02-06media: Clarify v4l2-async subdevice addition APIEzequiel Garcia1-9/+39
Now that most users of v4l2_async_notifier_add_subdev have been converted, let's fix the documentation so it's more clear how the v4l2-async API should be used. Document functions that drivers should use, and their purpose. Signed-off-by: Ezequiel Garcia <[email protected]> Reviewed-by: Laurent Pinchart <[email protected]> Signed-off-by: Sakari Ailus <[email protected]> Reviewed-by: Helen Koike <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-01-27media: hdmi: cec: replace broken link to HDMI specsivan tkachenko1-1/+1
Current link died, according to Wayback Machine, back in 2017. And the website is completely down since 2019. Moreover, there was a custom cover on that PDF, i.e. it was modified. According to HDMI licence agreement (LA), HDMI specification and technical information are supposed to be hosted on www.hdmi.org exclusively, and not redistributed by third-parties. Sure, there are still many more or less reliable "mirrors" out there with a direct download straight from a search engine's page. However, for example, from FPGA4fun[1] website it was removed "per HDMI LA request". Unfortunately, the official download page is protected by email CAPTCHA, but that seems to be the only legit way to obtain a copy. [1] https://www.fpga4fun.com/HDMI.html Signed-off-by: ivan tkachenko <[email protected]> Signed-off-by: Hans Verkuil <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-01-26media: Documentation: media: Fix recently introduced build warning in subdev ↵Sakari Ailus1-1/+1
docs A reference to the sub-device pad ops was not follwed by a whitespace, resulting in a warning during documentation build. Fix it. Reported-by: Stephen Rothwell <[email protected]> Fixes: 25c8d9a7689e ("media: Documentation: v4l: Document that link_validate op is valid for sink only") Signed-off-by: Sakari Ailus <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-01-12media: Documentation: Include CCS PLL calculator to CCS driver documentationSakari Ailus1-0/+13
Include existing CCS PLL calculator kerneldoc documentation to the documentation build. Signed-off-by: Sakari Ailus <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-01-12media: Documentation: media: Document clock handling in camera sensor driversSakari Ailus1-1/+19
Document pratices of handling clocks in camera sensor drivers on both DT and ACPI. Signed-off-by: Sakari Ailus <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-01-12media: Documentation: media: Update pixel rate formula for C-PHYSakari Ailus1-1/+3
Update the formula to calculate the pixel rate on the link for C-PHY. Signed-off-by: Sakari Ailus <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-01-12media: Documentation: v4l: Document that link_validate op is valid for sink onlySakari Ailus1-5/+6
The link_validate pad op will only be called on sink pads. Document this. Signed-off-by: Sakari Ailus <[email protected]> Reviewed-by: Jacopo Mondi <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-01-12media: Documentation: v4l: Remove reference to video opsSakari Ailus1-4/+0
We no longer have format related callbacks in video ops. Remove the reference to them. Signed-off-by: Sakari Ailus <[email protected]> Reviewed-by: Jacopo Mondi <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-12-03media: Documentation: ccs: Reorder SPDX and copyright notice linesSakari Ailus1-1/+1
Move the SPDX tag to the top, placing the copyright notice after that. This aligns the file with existing practices. Signed-off-by: Sakari Ailus <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-12-03media: Documentation: ccs: Rename ccs-regs.txt as ccs-regs.ascSakari Ailus3-4/+4
As documentation used to be in .txt files before converting to ReST, rename ccs-regs.txt to avoid it being taken as documentation that pre-dates ReST conversion and so target for further conversion to ReST. Signed-off-by: Sakari Ailus <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-12-02media: Documentation: ccs: Add CCS driver documentationSakari Ailus2-0/+83
Document the MIPI CCS driver and the C register definition generator. Signed-off-by: Sakari Ailus <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-12-02media: ccs: Add the generator for CCS register definitions and limitsSakari Ailus2-0/+1474
Add register definitions of the MIPI CCS 1.1 standard. The CCS driver makes extended use of device's capability registers that are dependent on CCS version. This involves having an in-memory data structure for limit and capability information, creating that data structure and accessing it. The register definitions as well as the definitions of this data structure are generated from a text file using a Perl script. Add the generator script to make it easy to update the generated files. Signed-off-by: Sakari Ailus <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-12-01Merge tag 'v5.10-rc6' into patchworkMauro Carvalho Chehab1-16/+104
Linux 5.10-rc6 * tag 'v5.10-rc6': (1815 commits) Linux 5.10-rc6 sock: set sk_err to ee_errno on dequeue from errq mptcp: fix NULL ptr dereference on bad MPJ net: openvswitch: fix TTL decrement action netlink message format perf probe: Change function definition check due to broken DWARF perf probe: Fix to die_entrypc() returns error correctly perf stat: Use proper cpu for shadow stats perf record: Synthesize cgroup events only if needed perf diff: Fix error return value in __cmd_diff() perf tools: Update copy of libbpf's hashmap.c x86/mce: Do not overwrite no_way_out if mce_end() fails kvm: x86/mmu: Fix get_mmio_spte() on CPUs supporting 5-level PT KVM: x86: Fix split-irqchip vs interrupt injection window request KVM: x86: handle !lapic_in_kernel case in kvm_cpu_*_extint usb: typec: stusb160x: fix power-opmode property with typec-power-opmode printk: finalize records with trailing newlines can: af_can: can_rx_unregister(): remove WARN() statement from list operation sanity check can: m_can: m_can_dev_setup(): add support for bosch mcan version 3.3.0 can: m_can: fix nominal bitiming tseg2 min for version >= 3.1 can: m_can: m_can_open(): remove IRQF_TRIGGER_FALLING from request_threaded_irq()'s flags ...
2020-11-27media: Documentation/driver-api: media/dtv-frontend: drop doubled wordRandy Dunlap1-3/+3
Drop the doubled word "errors". Signed-off-by: Randy Dunlap <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-27media: Documentation/driver-api: media/v4l2-dev: drop doubled wordRandy Dunlap1-1/+1
Drop the doubled word "device". Signed-off-by: Randy Dunlap <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-27media: Documentation/driver-api: media/v4l2-controls: drop doubled wordsRandy Dunlap1-2/+2
Drop the doubled words "type" and "the". Signed-off-by: Randy Dunlap <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-27media: Documentation/driver-api: media/cec-core: drop doubled wordRandy Dunlap1-1/+1
Drop the doubled word "the". Signed-off-by: Randy Dunlap <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-26media: vidtv.rst: add kernel-doc markupsMauro Carvalho Chehab1-0/+27
Fix existing issues at the kernel-doc markups and add them to the vidtv.rst file. Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-26media: vidtv.rst: update vidtv documentationMauro Carvalho Chehab1-13/+72
Update the vidtv documentation with the relevant changes after the last patches. Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-26media: vidtv: psi: Implement an Event Information Table (EIT)Daniel W. S. Almeida1-3/+5
Implement an Event Information Table (EIT) as per EN 300 468 5.2.4. The EIT provides information in chronological order regarding the events contained within each service. For now only present event information is supported. [[email protected]: removed an extra blank line] Signed-off-by: Daniel W. S. Almeida <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-26media: vidtv: psi: add a Network Information Table (NIT)Daniel W. S. Almeida1-3/+3
Add a Network Information Table (NIT) as specified in ETSI EN 300 468. This table conveys information relating to the physical organization of the multiplexes carried via a given network and the characteristics of the network itself. It is conveyed in the output of vidtv as packets with TS PID of 0x0010 [[email protected]: removed an extra blank line] Signed-off-by: Daniel W. S. Almeida <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-16media: Documentation: v4l: Document required controls on camera sensorsSakari Ailus1-0/+13
Raw camera sensors connected to parallel or CSI-2 busses need to implement V4L2_CID_LINK_FREQ control so receiver drivers can configure the hardware accordingly. Document this. Also say V4L2_CID_PIXEL_RATE is recommended for such hardware. Signed-off-by: Sakari Ailus <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-16media: Documentation: v4l: Fix languageSakari Ailus1-4/+3
Remove extra "is" from sentence explaining V4L2_CID_PIXEL_RATE may be used to tell the pixel rate used by a transmitter driver. Also call V4L2_CID_PIXEL_RATE a control. Signed-off-by: Sakari Ailus <[email protected]> Reviewed-by: Laurent Pinchart <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-16media: cec-core.rst/cec-ioc-g-mode.rst: fix typos in monitor-all descriptionHans Verkuil1-1/+1
cec-core.rst was missing 'are', and cec-ioc-g-mode.rst was missing a comma. In both cases this made the description of the Monitor All functionality hard to read. Signed-off-by: Hans Verkuil <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-10-15docs: get rid of :c:type explicit declarations for structsMauro Carvalho Chehab8-36/+36
The :c:type:`foo` only works properly with structs before Sphinx 3.x. On Sphinx 3.x, structs should now be declared using the .. c:struct, and referenced via :c:struct tag. As we now have the automarkup.py macro, that automatically convert: struct foo into cross-references, let's get rid of that, solving several warnings when building docs with Sphinx 3.x. Reviewed-by: André Almeida <[email protected]> # blk-mq.rst Reviewed-by: Takashi Iwai <[email protected]> # sound Reviewed-by: Mike Rapoport <[email protected]> Reviewed-by: Greg Kroah-Hartman <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-10-15media: cec-core.rst: don't use c:type for structsMauro Carvalho Chehab1-1/+1
The new C domain code on Sphinx 3 doesn't allow anymore to use c:type:: for structs. Now that cdomain.py has backward support, let's use c:struct:: instead. Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-10-04media: zoran.rst: place it at the right place this timeMauro Carvalho Chehab1-0/+0
I was too quick moving zoran.rst... it ends that the original patch didn't do the right thing and forgot to update the files that references it. Fix it. Fixes: 6b90346919d4 ("media: zoran: move documentation file to the right place") Signed-off-by: Mauro Carvalho Chehab <[email protected]>