From patchwork Wed Nov 9 15:44:43 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ramesh Shanmugasundaram X-Patchwork-Id: 37995 X-Patchwork-Delegate: hverkuil@xs4all.nl Received: from mail.tu-berlin.de ([130.149.7.33]) by www.linuxtv.org with esmtp (Exim 4.84_2) (envelope-from ) id 1c4VCl-00016K-Th; Wed, 09 Nov 2016 15:54:27 +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-6) with esmtp id 1c4VCj-0003LB-53; Wed, 09 Nov 2016 16:54:27 +0100 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S933202AbcKIPyV (ORCPT + 1 other); Wed, 9 Nov 2016 10:54:21 -0500 Received: from relmlor4.renesas.com ([210.160.252.174]:28545 "EHLO relmlie3.idc.renesas.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1751203AbcKIPyM (ORCPT ); Wed, 9 Nov 2016 10:54:12 -0500 Received: from unknown (HELO relmlir1.idc.renesas.com) ([10.200.68.151]) by relmlie3.idc.renesas.com with ESMTP; 10 Nov 2016 00:53:58 +0900 Received: from relmlac3.idc.renesas.com (relmlac3.idc.renesas.com [10.200.69.23]) by relmlir1.idc.renesas.com (Postfix) with ESMTP id D6BC545281; Thu, 10 Nov 2016 00:53:58 +0900 (JST) Received: by relmlac3.idc.renesas.com (Postfix, from userid 0) id BAA6518070; Thu, 10 Nov 2016 00:53:58 +0900 (JST) Received: from relmlac3.idc.renesas.com (localhost [127.0.0.1]) by relmlac3.idc.renesas.com (Postfix) with ESMTP id B417F1806F; Thu, 10 Nov 2016 00:53:58 +0900 (JST) Received: from relmlii2.idc.renesas.com [10.200.68.66] by relmlac3.idc.renesas.com with ESMTP id AAP03105; Thu, 10 Nov 2016 00:53:58 +0900 X-IronPort-AV: E=Sophos;i="5.31,614,1473087600"; d="scan'208";a="225514881" Received: from unknown (HELO localhost.localdomain) ([172.29.43.62]) by relmlii2.idc.renesas.com with ESMTP; 10 Nov 2016 00:53:55 +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+renesas@glider.be, linux-media@vger.kernel.org, devicetree@vger.kernel.org, linux-renesas-soc@vger.kernel.org, Ramesh Shanmugasundaram Subject: [PATCH 4/5] doc_rst: media: New SDR formats SC16, SC18 & SC20 Date: Wed, 9 Nov 2016 15:44:43 +0000 Message-Id: <1478706284-59134-5-git-send-email-ramesh.shanmugasundaram@bp.renesas.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1478706284-59134-1-git-send-email-ramesh.shanmugasundaram@bp.renesas.com> References: <1478706284-59134-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.11.9.154517 X-PMX-Spam: Gauge=IIIIIIII, Probability=8%, Report=' MULTIPLE_RCPTS 0.1, HTML_00_01 0.05, HTML_00_10 0.05, BODY_SIZE_6000_6999 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 | 80 ++++++++++++++++++++++ .../media/uapi/v4l/pixfmt-sdr-scu18be.rst | 80 ++++++++++++++++++++++ .../media/uapi/v4l/pixfmt-sdr-scu20be.rst | 80 ++++++++++++++++++++++ Documentation/media/uapi/v4l/sdr-formats.rst | 3 + 4 files changed, 243 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..7525378 --- /dev/null +++ b/Documentation/media/uapi/v4l/pixfmt-sdr-scu16be.rst @@ -0,0 +1,80 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. _V4L2-SDR-FMT-SCU16BE: + +****************************** +V4L2_SDR_FMT_SCU16BE ('SC16') +****************************** + +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 stored in +32 bit space. The remaining unused bits within the 32 bit space will be +padded with 0. I value starts first and Q value starts at an offset +equalling half of the buffer size (i.e.) offset = buffersize/2. Out of +the 16 bits, bit 15:2 (14 bit) is data and bit 1:0 (2 bit) can be any +value. + +**Byte Order.** +Each cell is one byte. + +.. flat-table:: + :header-rows: 1 + :stub-columns: 0 + + * - Offset: + + - Byte B0 + + - Byte B1 + + - Byte B2 + + - Byte B3 + + * - start + 0: + + - I'\ :sub:`0[13:6]` + + - I'\ :sub:`0[5:0]; B1[1:0]=pad` + + - pad + + - pad + + * - start + 4: + + - I'\ :sub:`1[13:6]` + + - I'\ :sub:`1[5:0]; B1[1:0]=pad` + + - pad + + - pad + + * - ... + + * - start + offset: + + - Q'\ :sub:`0[13:6]` + + - Q'\ :sub:`0[5:0]; B1[1:0]=pad` + + - pad + + - pad + + * - start + offset + 4: + + - Q'\ :sub:`1[13:6]` + + - Q'\ :sub:`1[5:0]; B1[1:0]=pad` + + - pad + + - pad 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..0ce714d --- /dev/null +++ b/Documentation/media/uapi/v4l/pixfmt-sdr-scu18be.rst @@ -0,0 +1,80 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. _V4L2-SDR-FMT-SCU18BE: + +****************************** +V4L2_SDR_FMT_SCU18BE ('SC18') +****************************** + +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 stored in +32 bit space. The remaining unused bits within the 32 bit space will be +padded with 0. I value starts first and Q value starts at an offset +equalling half of the buffer size (i.e.) offset = buffersize/2. Out of +the 18 bits, bit 17:2 (16 bit) is data and bit 1:0 (2 bit) can be any +value. + +**Byte Order.** +Each cell is one byte. + +.. flat-table:: + :header-rows: 1 + :stub-columns: 0 + + * - Offset: + + - Byte B0 + + - Byte B1 + + - Byte B2 + + - Byte B3 + + * - start + 0: + + - I'\ :sub:`0[17:10]` + + - I'\ :sub:`0[9:2]` + + - I'\ :sub:`0[1:0]; B2[5:0]=pad` + + - pad + + * - start + 4: + + - I'\ :sub:`1[17:10]` + + - I'\ :sub:`1[9:2]` + + - I'\ :sub:`1[1:0]; B2[5:0]=pad` + + - pad + + * - ... + + * - start + offset: + + - Q'\ :sub:`0[17:10]` + + - Q'\ :sub:`0[9:2]` + + - Q'\ :sub:`0[1:0]; B2[5:0]=pad` + + - pad + + * - start + offset + 4: + + - Q'\ :sub:`1[17:10]` + + - Q'\ :sub:`1[9:2]` + + - Q'\ :sub:`1[1:0]; B2[5:0]=pad` + + - pad 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..ff2fe51 --- /dev/null +++ b/Documentation/media/uapi/v4l/pixfmt-sdr-scu20be.rst @@ -0,0 +1,80 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. _V4L2-SDR-FMT-SCU20BE: + +****************************** +V4L2_SDR_FMT_SCU20BE ('SC20') +****************************** + +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 stored in +32 bit space. The remaining unused bits within the 32 bit space will be +padded with 0. I value starts first and Q value starts at an offset +equalling half of the buffer size (i.e.) offset = buffersize/2. Out of +the 20 bits, bit 19:2 (18 bit) is data and bit 1:0 (2 bit) can be any +value. + +**Byte Order.** +Each cell is one byte. + +.. flat-table:: + :header-rows: 1 + :stub-columns: 0 + + * - Offset: + + - Byte B0 + + - Byte B1 + + - Byte B2 + + - Byte B3 + + * - start + 0: + + - I'\ :sub:`0[19:12]` + + - I'\ :sub:`0[11:4]` + + - I'\ :sub:`0[3:0]; B2[3:0]=pad` + + - pad + + * - start + 4: + + - I'\ :sub:`1[19:12]` + + - I'\ :sub:`1[11:4]` + + - I'\ :sub:`1[3:0]; B2[3:0]=pad` + + - pad + + * - ... + + * - start + offset: + + - Q'\ :sub:`0[19:12]` + + - Q'\ :sub:`0[11:4]` + + - Q'\ :sub:`0[3:0]; B2[3:0]=pad` + + - pad + + * - start + offset + 4: + + - Q'\ :sub:`1[19:12]` + + - Q'\ :sub:`1[11:4]` + + - Q'\ :sub:`1[3:0]; B2[3:0]=pad` + + - pad 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