From: Jammy Huang <jammy_huang@aspeedtech.com>
To: <eajames@linux.ibm.com>, <mchehab@kernel.org>, <joel@jms.id.au>,
<andrew@aj.id.au>, <hverkuil-cisco@xs4all.nl>,
<laurent.pinchart@ideasonboard.com>,
<xavier.roumegue@oss.nxp.com>, <ezequiel@vanguardiasur.com.ar>,
<stanimir.varbanov@linaro.org>, <nicolas.dufresne@collabora.com>,
<sakari.ailus@linux.intel.com>, <ming.qian@nxp.com>,
<andrzej.p@collabora.com>, <linux-media@vger.kernel.org>,
<openbmc@lists.ozlabs.org>,
<linux-arm-kernel@lists.infradead.org>,
<linux-aspeed@lists.ozlabs.org>, <linux-kernel@vger.kernel.org>
Subject: [PATCH v10 3/5] media: Documentation: aspeed-video: Add user documentation for the aspeed-video driver
Date: Tue, 25 Oct 2022 17:02:01 +0800 [thread overview]
Message-ID: <20221025090203.5623-4-jammy_huang@aspeedtech.com> (raw)
In-Reply-To: <20221025090203.5623-1-jammy_huang@aspeedtech.com>
Add user documentation for the aspeed-video driver.
Signed-off-by: Jammy Huang <jammy_huang@aspeedtech.com>
---
v10:
- new
---
.../media/drivers/aspeed-video.rst | 61 +++++++++++++++++++
.../userspace-api/media/drivers/index.rst | 1 +
2 files changed, 62 insertions(+)
create mode 100644 Documentation/userspace-api/media/drivers/aspeed-video.rst
diff --git a/Documentation/userspace-api/media/drivers/aspeed-video.rst b/Documentation/userspace-api/media/drivers/aspeed-video.rst
new file mode 100644
index 000000000000..798a2588b175
--- /dev/null
+++ b/Documentation/userspace-api/media/drivers/aspeed-video.rst
@@ -0,0 +1,61 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. include:: <isonum.txt>
+
+ASPEED video driver
+===================
+
+ASPEED Video Engine found on AST2400/2500/2600 SoC supports high performance
+video compressions with a wide range of video quality and compression ratio
+options. The adopted compressing algorithm is a modified JPEG algorithm.
+
+There are 2 types of compressions in this IP.
+
+* JPEG JFIF standard mode: for single frame and management compression
+* ASPEED proprietary mode: for multi-frame and differential compression.
+ Support 2-pass (high quality) video compression scheme (Patent pending by
+ ASPEED). Provide visually lossless video compression quality or to reduce
+ the network average loading under intranet KVM applications.
+
+More details on the ASPEED video hardware operations can be found in
+*chapter 6.2.16 KVM Video Driver* of SDK_User_Guide which available on
+AspeedTech-BMC/openbmc/releases.
+
+The ASPEED video driver implements the following driver-specific control:
+
+``V4L2_CID_ASPEED_HQ_MODE``
+-------------------------------
+ Enable/Disable ASPEED's High quality mode. This is a private control
+ that can be used to enable high quality for aspeed proprietary mode.
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+ :widths: 1 4
+
+ * - ``(0)``
+ - ASPEED HQ mode is disabled.
+ * - ``(1)``
+ - ASPEED HQ mode is enabled.
+
+``V4L2_CID_ASPEED_HQ_JPEG_QUALITY``
+-------------------------------
+ Define the quality of ASPEED's High quality mode. This is a private control
+ that can be used to decide compression quality if High quality mode enabled
+ . Higher the value, better the quality and bigger the size.
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+ :widths: 1 4
+
+ * - ``(1)``
+ - minimum
+ * - ``(12)``
+ - maximum
+ * - ``(1)``
+ - step
+ * - ``(1)``
+ - default
+
+**Copyright** |copy| 2022 ASPEED Technology Inc.
diff --git a/Documentation/userspace-api/media/drivers/index.rst b/Documentation/userspace-api/media/drivers/index.rst
index 32f82aed47d9..46a494e00b72 100644
--- a/Documentation/userspace-api/media/drivers/index.rst
+++ b/Documentation/userspace-api/media/drivers/index.rst
@@ -31,6 +31,7 @@ For more details see the file COPYING in the source distribution of Linux.
:maxdepth: 5
:numbered:
+ aspeed-video
ccs
cx2341x-uapi
dw100
--
2.25.1
next prev parent reply other threads:[~2022-10-25 9:04 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-10-25 9:01 [PATCH v10 0/5] add aspeed-jpeg support for aspeed-video Jammy Huang
2022-10-25 9:01 ` [PATCH v10 1/5] media: v4l: Add definition for the Aspeed JPEG format Jammy Huang
2022-10-25 9:02 ` [PATCH v10 2/5] media: v4l2-ctrls: Reserve controls for ASPEED Jammy Huang
2022-10-25 9:02 ` Jammy Huang [this message]
2022-10-25 13:18 ` [PATCH v10 3/5] media: Documentation: aspeed-video: Add user documentation for the aspeed-video driver Nicolas Dufresne
2022-10-26 2:42 ` Jammy Huang
2022-10-26 19:02 ` Nicolas Dufresne
2022-10-27 2:11 ` Jammy Huang
2022-10-25 9:02 ` [PATCH v10 4/5] media: aspeed: Support aspeed mode to reduce compressed data Jammy Huang
2022-10-25 9:02 ` [PATCH v10 5/5] media: aspeed: Extend debug message Jammy Huang
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=20221025090203.5623-4-jammy_huang@aspeedtech.com \
--to=jammy_huang@aspeedtech.com \
--cc=andrew@aj.id.au \
--cc=andrzej.p@collabora.com \
--cc=eajames@linux.ibm.com \
--cc=ezequiel@vanguardiasur.com.ar \
--cc=hverkuil-cisco@xs4all.nl \
--cc=joel@jms.id.au \
--cc=laurent.pinchart@ideasonboard.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-aspeed@lists.ozlabs.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=mchehab@kernel.org \
--cc=ming.qian@nxp.com \
--cc=nicolas.dufresne@collabora.com \
--cc=openbmc@lists.ozlabs.org \
--cc=sakari.ailus@linux.intel.com \
--cc=stanimir.varbanov@linaro.org \
--cc=xavier.roumegue@oss.nxp.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).