From patchwork Wed Oct 12 14:10:29 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ramesh Shanmugasundaram X-Patchwork-Id: 37441 Received: from mail.tu-berlin.de ([130.149.7.33]) by www.linuxtv.org with esmtp (Exim 4.84_2) (envelope-from ) id 1buKTx-0000MN-Nl; Wed, 12 Oct 2016 14:26:09 +0000 X-tubIT-Incoming-IP: 209.132.180.67 Received: from vger.kernel.org ([209.132.180.67]) by mail.tu-berlin.de (exim-4.84_2/mailfrontend-7) with esmtp id 1buKTv-0002K2-1N; Wed, 12 Oct 2016 16:26:09 +0200 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S933270AbcJLO0F (ORCPT + 1 other); Wed, 12 Oct 2016 10:26:05 -0400 Received: from relmlor3.renesas.com ([210.160.252.173]:47882 "EHLO relmlie2.idc.renesas.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S932983AbcJLO0E (ORCPT ); Wed, 12 Oct 2016 10:26:04 -0400 Received: from unknown (HELO relmlir3.idc.renesas.com) ([10.200.68.153]) by relmlie2.idc.renesas.com with ESMTP; 12 Oct 2016 23:19:05 +0900 Received: from relmlac1.idc.renesas.com (relmlac1.idc.renesas.com [10.200.69.21]) by relmlir3.idc.renesas.com (Postfix) with ESMTP id 7E9145D63E; Wed, 12 Oct 2016 23:19:05 +0900 (JST) Received: by relmlac1.idc.renesas.com (Postfix, from userid 0) id 79DD380030; Wed, 12 Oct 2016 23:19:05 +0900 (JST) Received: from relmlac1.idc.renesas.com (localhost [127.0.0.1]) by relmlac1.idc.renesas.com (Postfix) with ESMTP id 75FD98002F; Wed, 12 Oct 2016 23:19:05 +0900 (JST) Received: from relmlii2.idc.renesas.com [10.200.68.66] by relmlac1.idc.renesas.com with ESMTP id ZAF16115; Wed, 12 Oct 2016 23:19:05 +0900 X-IronPort-AV: E=Sophos;i="5.22,559,1449500400"; d="scan'208";a="222682515" Received: from unknown (HELO localhost.localdomain) ([172.29.43.62]) by relmlii2.idc.renesas.com with ESMTP; 12 Oct 2016 23:19:02 +0900 From: Ramesh Shanmugasundaram To: robh+dt@kernel.org, mark.rutland@arm.com, mchehab@kernel.org, hverkuil@xs4all.nl, sakari.ailus@linux.intel.com, crope@iki.fi Cc: chris.paterson2@renesas.com, laurent.pinchart@ideasonboard.com, geert@linux-m68k.org, linux-media@vger.kernel.org, devicetree@vger.kernel.org, linux-renesas-soc@vger.kernel.org, Ramesh Shanmugasundaram Subject: [RFC 5/5] doc_rst: media: New SDR formats SC16, SC18 & SC20 Date: Wed, 12 Oct 2016 15:10:29 +0100 Message-Id: <1476281429-27603-6-git-send-email-ramesh.shanmugasundaram@bp.renesas.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1476281429-27603-1-git-send-email-ramesh.shanmugasundaram@bp.renesas.com> References: <1476281429-27603-1-git-send-email-ramesh.shanmugasundaram@bp.renesas.com> Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org X-PMX-Version: 6.0.0.2142326, Antispam-Engine: 2.7.2.2107409, Antispam-Data: 2016.10.12.141517 X-PMX-Spam: Gauge=IIIIIIII, Probability=8%, Report=' MULTIPLE_RCPTS 0.1, HTML_00_01 0.05, HTML_00_10 0.05, BODY_SIZE_5000_5999 0, BODY_SIZE_7000_LESS 0, IN_REP_TO 0, LEGITIMATE_NEGATE 0, LEGITIMATE_SIGNS 0, MSG_THREAD 0, MULTIPLE_REAL_RCPTS 0, NO_URI_HTTPS 0, REFERENCES 0, SINGLE_URI_IN_BODY 0, URI_ENDS_IN_HTML 0, __ANY_URI 0, __CC_NAME 0, __CC_NAME_DIFF_FROM_ACC 0, __CC_REAL_NAMES 0, __CP_URI_IN_BODY 0, __FRAUD_COMMON 0, __FRAUD_REFNUM 0, __FROM_DOMAIN_IN_ANY_CC2 0, __FROM_DOMAIN_IN_RCPT 0, __HAS_CC_HDR 0, __HAS_FROM 0, __HAS_MSGID 0, __HAS_X_MAILER 0, __HAS_X_MAILING_LIST 0, __IN_REP_TO 0, __MIME_TEXT_ONLY 0, __MIME_TEXT_P 0, __MIME_TEXT_P1 0, __MULTIPLE_RCPTS_CC_X2 0, __MULTIPLE_RCPTS_TO_X5 0, __REFERENCES 0, __SANE_MSGID 0, __SINGLE_URI_TEXT 0, __SUBJ_ALPHA_END 0, __TO_MALFORMED_2 0, __TO_NO_NAME 0, __URI_IN_BODY 0, __URI_NO_WWW 0, __URI_NS , __URI_WITH_PATH 0' This patch adds documentation for the three new SDR formats V4L2_SDR_FMT_SCU16BE V4L2_SDR_FMT_SCU18BE V4L2_SDR_FMT_SCU20BE Signed-off-by: Ramesh Shanmugasundaram --- .../media/uapi/v4l/pixfmt-sdr-scu16be.rst | 44 ++++++++++++++++++++ .../media/uapi/v4l/pixfmt-sdr-scu18be.rst | 48 ++++++++++++++++++++++ .../media/uapi/v4l/pixfmt-sdr-scu20be.rst | 48 ++++++++++++++++++++++ Documentation/media/uapi/v4l/sdr-formats.rst | 3 ++ 4 files changed, 143 insertions(+) create mode 100644 Documentation/media/uapi/v4l/pixfmt-sdr-scu16be.rst create mode 100644 Documentation/media/uapi/v4l/pixfmt-sdr-scu18be.rst create mode 100644 Documentation/media/uapi/v4l/pixfmt-sdr-scu20be.rst diff --git a/Documentation/media/uapi/v4l/pixfmt-sdr-scu16be.rst b/Documentation/media/uapi/v4l/pixfmt-sdr-scu16be.rst new file mode 100644 index 0000000..d6c2123 --- /dev/null +++ b/Documentation/media/uapi/v4l/pixfmt-sdr-scu16be.rst @@ -0,0 +1,44 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. _V4L2-SDR-FMT-SCU16BE: + +****************************** +V4L2_SDR_FMT_SCU16BE ('SCU16') +****************************** + +Sliced complex unsigned 16-bit big endian IQ sample + + +Description +=========== + +This format contains a sequence of complex number samples. Each complex +number consist of two parts called In-phase and Quadrature (IQ). Both I +and Q are represented as a 16 bit unsigned big endian number. I value +starts first and Q value starts at an offset equalling half of the buffer +size. 14 bit data is stored in 16 bit space with unused stuffed bits +padded with 0. + +**Byte Order.** +Each cell is one byte. + + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + - .. row 1 + + - start + 0: + + - I'\ :sub:`0[D13:D6]` + + - I'\ :sub:`0[D5:D0]` + + - .. row 2 + + - start + buffer_size/2: + + - Q'\ :sub:`0[D13:D6]` + + - Q'\ :sub:`0[D5:D0]` diff --git a/Documentation/media/uapi/v4l/pixfmt-sdr-scu18be.rst b/Documentation/media/uapi/v4l/pixfmt-sdr-scu18be.rst new file mode 100644 index 0000000..e6e0aff --- /dev/null +++ b/Documentation/media/uapi/v4l/pixfmt-sdr-scu18be.rst @@ -0,0 +1,48 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. _V4L2-SDR-FMT-SCU18BE: + +****************************** +V4L2_SDR_FMT_SCU18BE ('SCU18') +****************************** + +Sliced complex unsigned 18-bit big endian IQ sample + + +Description +=========== + +This format contains a sequence of complex number samples. Each complex +number consist of two parts called In-phase and Quadrature (IQ). Both I +and Q are represented as a 18 bit unsigned big endian number. I value +starts first and Q value starts at an offset equalling half of the buffer +size. 16 bit data is stored in 18 bit space with unused stuffed bits +padded with 0. + +**Byte Order.** +Each cell is one byte. + + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + - .. row 1 + + - start + 0: + + - I'\ :sub:`0[D17:D10]` + + - I'\ :sub:`0[D9:D2]` + + - I'\ :sub:`0[D1:D0]` + + - .. row 2 + + - start + buffer_size/2: + + - Q'\ :sub:`0[D17:D10]` + + - Q'\ :sub:`0[D9:D2]` + + - Q'\ :sub:`0[D1:D0]` diff --git a/Documentation/media/uapi/v4l/pixfmt-sdr-scu20be.rst b/Documentation/media/uapi/v4l/pixfmt-sdr-scu20be.rst new file mode 100644 index 0000000..374e0a3 --- /dev/null +++ b/Documentation/media/uapi/v4l/pixfmt-sdr-scu20be.rst @@ -0,0 +1,48 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. _V4L2-SDR-FMT-SCU20BE: + +****************************** +V4L2_SDR_FMT_SCU20BE ('SCU20') +****************************** + +Sliced complex unsigned 20-bit big endian IQ sample + + +Description +=========== + +This format contains a sequence of complex number samples. Each complex +number consist of two parts called In-phase and Quadrature (IQ). Both I +and Q are represented as a 20 bit unsigned big endian number. I value +starts first and Q value starts at an offset equalling half of the buffer +size. 18 bit data is stored in 20 bit space with unused stuffed bits +padded with 0. + +**Byte Order.** +Each cell is one byte. + + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + - .. row 1 + + - start + 0: + + - I'\ :sub:`0[D19:D12]` + + - I'\ :sub:`0[D11:D4]` + + - I'\ :sub:`0[D3:D0]` + + - .. row 2 + + - start + buffer_size/2: + + - Q'\ :sub:`0[D19:D12]` + + - Q'\ :sub:`0[D11:D4]` + + - Q'\ :sub:`0[D3:D0]` diff --git a/Documentation/media/uapi/v4l/sdr-formats.rst b/Documentation/media/uapi/v4l/sdr-formats.rst index f863c08..4c01cf9 100644 --- a/Documentation/media/uapi/v4l/sdr-formats.rst +++ b/Documentation/media/uapi/v4l/sdr-formats.rst @@ -17,3 +17,6 @@ These formats are used for :ref:`SDR ` interface only. pixfmt-sdr-cs08 pixfmt-sdr-cs14le pixfmt-sdr-ru12le + pixfmt-sdr-scu16be + pixfmt-sdr-scu18be + pixfmt-sdr-scu20be