All of lore.kernel.org
 help / color / mirror / Atom feed
From: Devarsh Thakkar <devarsht@ti.com>
To: <mchehab@kernel.org>, <robh@kernel.org>,
	<krzysztof.kozlowski+dt@linaro.org>, <conor+dt@kernel.org>,
	<hverkuil-cisco@xs4all.nl>, <linux-media@vger.kernel.org>,
	<linux-kernel@vger.kernel.org>, <benjamin.gaignard@collabora.com>,
	<sebastian.fricke@collabora.com>
Cc: <laurent.pinchart@ideasonboard.com>, <praneeth@ti.com>,
	<nm@ti.com>, <vigneshr@ti.com>, <a-bhatia1@ti.com>,
	<j-luthra@ti.com>, <b-brnich@ti.com>, <detheridge@ti.com>,
	<p-mantena@ti.com>, <vijayp@ti.com>, <devarsht@ti.com>,
	<andrzej.p@collabora.com>, <nicolas@ndufresne.ca>
Subject: [PATCH v12 04/13] media: Documentation: Document v4l2-jpeg helper functions
Date: Tue, 4 Jun 2024 16:18:55 +0530	[thread overview]
Message-ID: <20240604104855.2249658-1-devarsht@ti.com> (raw)
In-Reply-To: <20240604104001.2235082-1-devarsht@ti.com>

Enable documentation for v4l2-jpeg header relate helper functions which are
useful for parsing jpeg files while decoding or creating jpeg headers while
encoding.

Signed-off-by: Devarsh Thakkar <devarsht@ti.com>
---
V2->V12: No change (patch introduced in v12)
---
 Documentation/driver-api/media/v4l2-core.rst |  1 +
 Documentation/driver-api/media/v4l2-jpeg.rst | 10 ++++++++++
 2 files changed, 11 insertions(+)
 create mode 100644 Documentation/driver-api/media/v4l2-jpeg.rst

diff --git a/Documentation/driver-api/media/v4l2-core.rst b/Documentation/driver-api/media/v4l2-core.rst
index 58cba831ade5..ad987c34ad2a 100644
--- a/Documentation/driver-api/media/v4l2-core.rst
+++ b/Documentation/driver-api/media/v4l2-core.rst
@@ -26,3 +26,4 @@ Video4Linux devices
     v4l2-tuner
     v4l2-common
     v4l2-tveeprom
+    v4l2-jpeg
diff --git a/Documentation/driver-api/media/v4l2-jpeg.rst b/Documentation/driver-api/media/v4l2-jpeg.rst
new file mode 100644
index 000000000000..af3bc52f865b
--- /dev/null
+++ b/Documentation/driver-api/media/v4l2-jpeg.rst
@@ -0,0 +1,10 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+V4L2 JPEG header related functions and data structures
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. kernel-doc:: include/media/v4l2-jpeg.h
+   :internal:
+
+.. kernel-doc:: drivers/media/v4l2-core/v4l2-jpeg.c
+   :export:
-- 
2.39.1


  parent reply	other threads:[~2024-06-04 10:49 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-06-04 10:40 [PATCH v12 00/13] Add V4L2 M2M Driver for E5010 JPEG Encoder Devarsh Thakkar
2024-06-04 10:40 ` Devarsh Thakkar
2024-06-04 10:43 ` [PATCH v12 01/13] media: dt-bindings: Add Imagination " Devarsh Thakkar
2024-06-04 10:47 ` [PATCH v12 02/13] media: imagination: Add E5010 JPEG Encoder driver Devarsh Thakkar
2024-06-06 15:42   ` Sebastian Fricke
2024-06-07 13:42     ` Devarsh Thakkar
2024-06-04 10:48 ` [PATCH v12 03/13] media: v4l2-jpeg: Export reference quantization and huffman tables Devarsh Thakkar
2024-06-04 10:48 ` Devarsh Thakkar [this message]
2024-06-04 10:50 ` [PATCH v12 05/13] media: imagination: Use exported tables from v4l2-jpeg core Devarsh Thakkar
2024-06-04 10:50   ` Devarsh Thakkar
2024-06-04 10:50 ` [PATCH v12 06/13] media: verisilicon : Use exported tables from v4l2-jpeg for hantro codec Devarsh Thakkar
2024-06-04 10:50   ` Devarsh Thakkar
2024-06-04 10:51 ` [PATCH v12 07/13] math.h: Add macros for rounding to closest value Devarsh Thakkar
2024-06-04 10:51 ` [PATCH v12 08/13] math.h: Use kernel-doc syntax for divison macros Devarsh Thakkar
2024-06-04 10:52 ` [PATCH v12 09/13] Documentation: core-api: Add math.h macros and functions Devarsh Thakkar
2024-06-04 10:52 ` [PATCH v12 10/13] lib: add basic KUnit test for lib/math Devarsh Thakkar
2024-06-04 10:53 ` [PATCH v12 11/13] lib: math_kunit: Add tests for new macros related to rounding to nearest value Devarsh Thakkar
2024-06-04 10:53 ` [PATCH v12 12/13] media: imagination: Round to closest multiple for cropping region Devarsh Thakkar
2024-06-06 11:44   ` Sebastian Fricke
2024-06-06 13:31     ` Devarsh Thakkar
2024-06-06 14:10     ` Andy Shevchenko
2024-06-04 10:54 ` [PATCH v12 13/13] gpu: ipu-v3: Use generic macro for rounding closest to specified value Devarsh Thakkar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240604104855.2249658-1-devarsht@ti.com \
    --to=devarsht@ti.com \
    --cc=a-bhatia1@ti.com \
    --cc=andrzej.p@collabora.com \
    --cc=b-brnich@ti.com \
    --cc=benjamin.gaignard@collabora.com \
    --cc=conor+dt@kernel.org \
    --cc=detheridge@ti.com \
    --cc=hverkuil-cisco@xs4all.nl \
    --cc=j-luthra@ti.com \
    --cc=krzysztof.kozlowski+dt@linaro.org \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=nicolas@ndufresne.ca \
    --cc=nm@ti.com \
    --cc=p-mantena@ti.com \
    --cc=praneeth@ti.com \
    --cc=robh@kernel.org \
    --cc=sebastian.fricke@collabora.com \
    --cc=vigneshr@ti.com \
    --cc=vijayp@ti.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.