From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from alsa0.perex.cz (alsa0.perex.cz [77.48.224.243]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 69AF5CD54A7 for ; Tue, 19 Sep 2023 08:13:37 +0000 (UTC) Received: from alsa1.perex.cz (alsa1.perex.cz [207.180.221.201]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by alsa0.perex.cz (Postfix) with ESMTPS id 3CC0FDEB; Tue, 19 Sep 2023 10:12:45 +0200 (CEST) DKIM-Filter: OpenDKIM Filter v2.11.0 alsa0.perex.cz 3CC0FDEB DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=alsa-project.org; s=default; t=1695111215; bh=aAB7EWzY2r/C5lofEJED/cdUSaQBss5UJWUsHxyWURE=; h=From:To:Cc:Subject:Date:List-Id:List-Archive:List-Help:List-Owner: List-Post:List-Subscribe:List-Unsubscribe:From; b=u6EJrsSSXbG7jsn/+40qLThc1A6WT3dLME8tHNLlXrpEF5QKAa2dLDZ+BQd8jQvE4 6JaLc5+jkAUs2AzlYNWBjk4SosxPPAwvMCFK/JbDLaTd4gIaH7Z8yJr38Wt57A/QBK Kl1BNEqFRXnyIW/YjHaF35GO1emRF5XLlkDTn6B8= Received: by alsa1.perex.cz (Postfix, from userid 50401) id 9BEF8F805C1; Tue, 19 Sep 2023 10:11:12 +0200 (CEST) Received: from mailman-core.alsa-project.org (mailman-core.alsa-project.org [10.254.200.10]) by alsa1.perex.cz (Postfix) with ESMTP id 13D07F805B4; Tue, 19 Sep 2023 10:11:12 +0200 (CEST) Received: by alsa1.perex.cz (Postfix, from userid 50401) id 1C329F8025A; Mon, 18 Sep 2023 20:11:40 +0200 (CEST) Received: from mail-wm1-x32f.google.com (mail-wm1-x32f.google.com [IPv6:2a00:1450:4864:20::32f]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by alsa1.perex.cz (Postfix) with ESMTPS id DE412F80124 for ; Mon, 18 Sep 2023 20:11:37 +0200 (CEST) DKIM-Filter: OpenDKIM Filter v2.11.0 alsa1.perex.cz DE412F80124 Authentication-Results: alsa1.perex.cz; dkim=pass (2048-bit key, unprotected) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20230601 header.b=HTpaYHlc Received: by mail-wm1-x32f.google.com with SMTP id 5b1f17b1804b1-4047ef37f55so6931865e9.1 for ; Mon, 18 Sep 2023 11:11:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1695060695; x=1695665495; darn=alsa-project.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=izrjrMGBpPCkr9U7qebqVQKKiL2jpXVFSYUNkSOXrnU=; b=HTpaYHlcZPHcTWPBD2YCA9Fj39ujCoRT7TokE67PdODG/c32Ig/3QyCTbMHjevlNaG 52Bsrf92SaoNKA4fqJ/5evnHb8jMrsU9DV/5o/yFtj57utT/MSZr68mYVpW8Dyjt7juT LHR9qDaAUYmXTF5LjWTIghHLsY46wZzc9L0StACDNCUnGJ6nXv8DXJNy4NiQxpmNWJwa Q+7U7rl1po4PKyqRfb8TqQzojh1ZQF1AWLOrWnFwzNMkPVoguh78BbtaHhg4A+U+uceb VudS+gowA0CiHTD1EVBef8ZyNHVa/v/f7RczenLCtK/M9P/Ym1ahckjGiM5sYyeZsVxL ySiw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1695060695; x=1695665495; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=izrjrMGBpPCkr9U7qebqVQKKiL2jpXVFSYUNkSOXrnU=; b=uUCUZrWjUYnu+/qJKzUhFuVOQTgaZNXausgsBUWG5h1Sb3Be3F4Tl0IkK+W6MSdwBl gQBUXWN7RMJc+lbt0jPq3fuw9nORfk42IdenX01zRSu/Rn+caQPwHrgTUqUo8xd3K+MM xxHvZ/20K7IgSOwZzES7UM5qBqQuFynNjHi3gp5/6wnXnpnXiGb+XlUXO0JiPOe98dpS zHENmNGpwZuglKxcwP+f9O9jn2r37YaapvzETPV0DVTQOCVvcQ9HGBzYBClIEDnhH6ZU g/iS7wcX5yE1AKl9HUF7MZEzXZUHigfNR/TmzbDksiiEeZob0LYIfGHQmRX6IUSexo3l MSBA== X-Gm-Message-State: AOJu0Yz0I+NGmhBgCWc7E5ykv/MpACPlevZu7qr7islisFsHNMJ/lkKE nDXs6PUDb8xdC9tEBfVmQgM= X-Google-Smtp-Source: AGHT+IGxry8HqUFfp+mriNzQZYSAuA7iVv+R4bRVLZRESku9GPhySmAjsW/GgUOjpmfdqn9K9ePakw== X-Received: by 2002:a7b:cd91:0:b0:3fe:d46a:ef4b with SMTP id y17-20020a7bcd91000000b003fed46aef4bmr8516093wmj.1.1695060695056; Mon, 18 Sep 2023 11:11:35 -0700 (PDT) Received: from ivan-B550MH.domain.name ([178.160.241.68]) by smtp.gmail.com with ESMTPSA id x20-20020a05600c2a5400b003fe601a7d46sm15865769wme.45.2023.09.18.11.11.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 18 Sep 2023 11:11:34 -0700 (PDT) From: Ivan Orlov To: perex@perex.cz, tiwai@suse.com, corbet@lwn.net Cc: Ivan Orlov , alsa-devel@alsa-project.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, gregkh@linuxfoundation.org Subject: [PATCH v2 1/2] ALSA: docs: Add Marian M2 driver documentation Date: Mon, 18 Sep 2023 22:10:43 +0400 Message-Id: <20230918181044.7257-1-ivan.orlov0322@gmail.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-MailFrom: ivan.orlov0322@gmail.com X-Mailman-Rule-Hits: nonmember-moderation X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-alsa-devel.alsa-project.org-0; header-match-alsa-devel.alsa-project.org-1 Message-ID-Hash: DVASIBZRQMZ34BOSNMRD7H6A6AJ5SG2I X-Message-ID-Hash: DVASIBZRQMZ34BOSNMRD7H6A6AJ5SG2I X-Mailman-Approved-At: Tue, 19 Sep 2023 08:10:57 +0000 X-Mailman-Version: 3.3.8 Precedence: list List-Id: "Alsa-devel mailing list for ALSA developers - http://www.alsa-project.org" Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Add documentation for the new MARIAN Seraph M2 sound card. It covers current development status, available controls of the card and information about the integrated loopback. Signed-off-by: Ivan Orlov --- V1 -> V2: - Remove redundant documentation fix from the next patch in the series Documentation/sound/cards/index.rst | 1 + Documentation/sound/cards/marian-m2.rst | 104 ++++++++++++++++++++++++ 2 files changed, 105 insertions(+) create mode 100644 Documentation/sound/cards/marian-m2.rst diff --git a/Documentation/sound/cards/index.rst b/Documentation/sound/cards/index.rst index e68bbb13c384..e873592d8d00 100644 --- a/Documentation/sound/cards/index.rst +++ b/Documentation/sound/cards/index.rst @@ -19,3 +19,4 @@ Card-Specific Information serial-u16550 img-spdif-in pcmtest + marian-m2 diff --git a/Documentation/sound/cards/marian-m2.rst b/Documentation/sound/cards/marian-m2.rst new file mode 100644 index 000000000000..bf12445e20d7 --- /dev/null +++ b/Documentation/sound/cards/marian-m2.rst @@ -0,0 +1,104 @@ +.. SPDX-License-Identifier: GPL-2.0 + +======================= +MARIAN Seraph M2 Driver +======================= + +Sep 18, 2023 + +Ivan Orlov + +STATE OF DEVELOPMENT +==================== + +This driver is based on the driver written by Florian Faber in 2012, which seemed to work fine. +However, the initial code contained multiple issues, which had to be solved before sending the +driver upstream. + +The vendor lost the full documentation, so what we have here was recovered from drafts and found +after experiments with the card. + +What seems to be working fine: +- Playback and capture for all supported rates +- Integrated loopback (with some exceptions, see below) + +MEMORY MODEL +============ + +The hardware requires one huge contiguous DMA space to be allocated. After allocation, the bus address of +this buffer should be written to the hardware register. + +We can split this space into two parts: the first one contains samples for capture, another one contains +play samples: + +CAPTURE_CH_0, CAPTURE_CH_1, ..., CAPTURE_CH_127 | PLAY_CH_0, PLAY_CH_1, ..., PLAY_CH_127 + +The card supports the non-interleaved access mode only, so samples for each channel lay together: + +C0, C0, ..., C0, C1, C1, ..., C1, ..., C127 | C0, C0, ..., C0, C1, C1, ..., C1, ..., C127 + +The count of samples per each channel buffer needs to be set explicitly, so the address of the first +byte of the playback data depends on this value. The playback buffer starts where the capture buffer ends. +It makes the arbitrary period count/buffer size feature impossible to implement, and the driver supports only +2 periods per buffer. + +Controls +======== + +Input 1 Sync + 0 - No signal, 1 - valid MADI signal found, 2 - Synced with MADI signal +Input 2 Sync + 0 - No signal, 1 - valid MADI signal found, 2 - Synced with MADI signal + +Input 1 Channel Mode + 0 - 56 channels, 1 - 64 channels +Input 2 Channel Mode + 0 - 56 channels, 1 - 64 channels + +Input 1 Frame Mode + 0 - 48 kHz, 1 - 96 kHz +Input 2 Frame Mode + 0 - 48 kHz, 1 - 96 kHz + +Input 1 Frequency + Measured frequency on Input 1 +Input 2 Frequency + Measured frequency on Input 2 + +Output 1 Channel Mode + 0 - 56 channels, 1 - 64 channels +Output 2 Channel Mode + 0 - 56 channels, 1 - 64 channels + +Output 1 Frame Mode + 0 - 48 kHz, 1 - 96 kHz +Output 2 Frame Mode + 0 - 48 kHz, 1 - 96 kHz + +Clock Source + Internal/Sync Bus, Input Port 1, Input Port 2 + +Speed mode + VCO clock range (slow/fast) + +DCO Frequency (Hz) + +DCO Frequency (ms) + +DCO Detune + Range: -200...200 + +Loopback + Enable/Disable integrated loopback + + +Loopback +======== + +The card contains integrated loopback. When it is enabled, it sets the hardware’s DAW-in memory pointer +to the hardware’s DAW-out memory. So, what you play is what you record. + +You can enable the integrated loopback using the corresponding control. + +The loopback seems to work well on lower rates (like 28000). However, when the rate goes higher, I observe +multiple mistakes in recorded byte ordering. -- 2.34.1