From patchwork Fri Oct 28 02:35:52 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jammy Huang X-Patchwork-Id: 12055 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:6687:0:0:0:0:0 with SMTP id l7csp577489wru; Thu, 27 Oct 2022 19:42:22 -0700 (PDT) X-Google-Smtp-Source: AMsMyM7j511ckVFxvYInXfuyCz2jxVZ0R+oTYaGuMFYOSsG16k6qoMdiaxpvshanUp18GVYhD/5l X-Received: by 2002:a17:907:7f05:b0:78d:e869:f2fe with SMTP id qf5-20020a1709077f0500b0078de869f2femr43183460ejc.684.1666924942607; Thu, 27 Oct 2022 19:42:22 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1666924942; cv=none; d=google.com; s=arc-20160816; b=jNC8yj9pKdScmOdsjjJw9ywenuEs/d2abbOcqGJgtbSx4WIcOcfE7wcwRqUSPqfmK0 fHwsx7LaT3LbhE4fLTYc7EmEGzuFMXkaWOhUJRtIdFiF0Q0ll5fTtFDsQJ13fyzny34z kyq6/gLi3k3ZNx2iaH6X0k7Cd7hehRbGHZ+2j51LEWXok3ExQSVJK3AbDyhhQ+IDefoS RadLkyt7S+GQk5cqgmIe3fzFhsSmkCX4jNelfzz6dcRJF8t1sZjqAtRYPF1USDlUAcZI Ttvhh10psdzikFi9DNxjGYHhHCMW0t5NB7Gr9/BH+SokIwBkca6xeCYLWIGISFXOsciN EOSQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:to:from; bh=t86nvk8LArScB0PLTiIUtVjyRvAWkXgvwA5QLQIkN5M=; b=uSpcxL+3uWPon+oq6EDnKVj5JOgLM0fBG2Vs875Rhr3uZWkTiGdCC/4nUENgD1tQ6M gouo385Gw8KCQ9LArOaXIhH2dfHdume6CnpU9LEhglX8BF1WF/lguyrc/6q7rMLsjD/z vXpeijeI/oc7ZVtGCosZImSoHNu9Ses0L9Zh3+JVuVCwXWI8GQF2BAXh1zpMHLHBFx0m 5qPgV2C+mscx0O67sux3r9EIU7eReAYjAdfDrU4jjTjdKM3x3Xxv44RAfRhDeKpE+wE9 /m+OUOLpecyUkDxB+SNHEHDzDrHIm3rpbD+EfZ9xP1RwvEV0/OydKJIAhyU1qvnbGFaa Se4w== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id p8-20020a170906498800b007ad69eba328si2780809eju.539.2022.10.27.19.41.59; Thu, 27 Oct 2022 19:42:22 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S236276AbiJ1Cig (ORCPT + 99 others); Thu, 27 Oct 2022 22:38:36 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57208 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S236430AbiJ1Ch7 (ORCPT ); Thu, 27 Oct 2022 22:37:59 -0400 Received: from twspam01.aspeedtech.com (twspam01.aspeedtech.com [211.20.114.71]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BBF394A830; Thu, 27 Oct 2022 19:37:55 -0700 (PDT) Received: from mail.aspeedtech.com ([192.168.0.24]) by twspam01.aspeedtech.com with ESMTP id 29S2D5KF054600; Fri, 28 Oct 2022 10:13:06 +0800 (GMT-8) (envelope-from jammy_huang@aspeedtech.com) Received: from JammyHuang-PC.aspeed.com (192.168.2.115) by TWMBX02.aspeed.com (192.168.0.24) with Microsoft SMTP Server (TLS) id 15.0.1497.2; Fri, 28 Oct 2022 10:35:59 +0800 From: Jammy Huang To: , , , , , , , , , , , , , , , , , Subject: [PATCH v11 3/5] media: Documentation: aspeed-video: Add user documentation for the aspeed-video driver Date: Fri, 28 Oct 2022 10:35:52 +0800 Message-ID: <20221028023554.928-4-jammy_huang@aspeedtech.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20221028023554.928-1-jammy_huang@aspeedtech.com> References: <20221028023554.928-1-jammy_huang@aspeedtech.com> MIME-Version: 1.0 X-Originating-IP: [192.168.2.115] X-ClientProxiedBy: TWMBX02.aspeed.com (192.168.0.24) To TWMBX02.aspeed.com (192.168.0.24) X-DNSRBL: X-MAIL: twspam01.aspeedtech.com 29S2D5KF054600 X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,SPF_HELO_NONE, SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1747897488538130579?= X-GMAIL-MSGID: =?utf-8?q?1747897488538130579?= Add user documentation for the aspeed-video driver. Signed-off-by: Jammy Huang --- v11: - update the way to change format v10: - new --- .../media/drivers/aspeed-video.rst | 61 +++++++++++++++++++ .../userspace-api/media/drivers/index.rst | 1 + 2 files changed, 66 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..e5656a8d990e --- /dev/null +++ b/Documentation/userspace-api/media/drivers/aspeed-video.rst @@ -0,0 +1,65 @@ +.. SPDX-License-Identifier: GPL-2.0 + +.. include:: + +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. + +VIDIOC_S_FMT can be used to choose which format you want. V4L2_PIX_FMT_JPEG +stands for JPEG JFIF standard mode; V4L2_PIX_FMT_AJPG stands for ASPEED +proprietary mode. + +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