From patchwork Tue Apr 21 08:05:45 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Jie, Yang" X-Patchwork-Id: 6246111 Return-Path: X-Original-To: patchwork-alsa-devel@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork2.web.kernel.org (Postfix) with ESMTP id DFE10BF4A6 for ; Tue, 21 Apr 2015 08:06:51 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 1CE4D20416 for ; Tue, 21 Apr 2015 08:06:51 +0000 (UTC) Received: from alsa0.perex.cz (alsa0.perex.cz [77.48.224.243]) by mail.kernel.org (Postfix) with ESMTP id DCFF520295 for ; Tue, 21 Apr 2015 08:06:49 +0000 (UTC) Received: by alsa0.perex.cz (Postfix, from userid 1000) id 1A62F265E3C; Tue, 21 Apr 2015 10:06:49 +0200 (CEST) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,NO_DNS_FOR_FROM, UNPARSEABLE_RELAY autolearn=no version=3.3.1 Received: from alsa0.perex.cz (localhost [IPv6:::1]) by alsa0.perex.cz (Postfix) with ESMTP id 16B4C2660CF; Tue, 21 Apr 2015 10:03:23 +0200 (CEST) X-Original-To: alsa-devel@alsa-project.org Delivered-To: alsa-devel@alsa-project.org Received: by alsa0.perex.cz (Postfix, from userid 1000) id D2D26265E3C; Tue, 21 Apr 2015 10:03:21 +0200 (CEST) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by alsa0.perex.cz (Postfix) with ESMTP id 40DA8265E28 for ; Tue, 21 Apr 2015 10:02:42 +0200 (CEST) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga101.fm.intel.com with ESMTP; 21 Apr 2015 01:02:41 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.11,614,1422950400"; d="scan'208";a="716760823" Received: from keyon-u1310.sh.intel.com ([10.239.13.15]) by orsmga002.jf.intel.com with ESMTP; 21 Apr 2015 01:02:40 -0700 From: Jie Yang To: tiwai@suse.de Date: Tue, 21 Apr 2015 16:05:45 +0800 Message-Id: <1429603545-21063-8-git-send-email-yang.jie@intel.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1429603545-21063-1-git-send-email-yang.jie@intel.com> References: <1429603545-21063-1-git-send-email-yang.jie@intel.com> Cc: alsa-devel@alsa-project.org, broonie@kernel.org, liam.r.girdwood@intel.com Subject: [alsa-devel] [PATCH v7 7/7] ALSA: Docs: Add documentation for Jack kcontrols X-BeenThere: alsa-devel@alsa-project.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Alsa-devel mailing list for ALSA developers - http://www.alsa-project.org" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: alsa-devel-bounces@alsa-project.org Sender: alsa-devel-bounces@alsa-project.org X-Virus-Scanned: ClamAV using ClamSMTP Add documentation describing Jack embedded kcontrols, and how to use it on HD-Audio and ASoC case. Signed-off-by: Jie Yang --- Documentation/sound/alsa/Jack-Controls.txt | 48 ++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 Documentation/sound/alsa/Jack-Controls.txt diff --git a/Documentation/sound/alsa/Jack-Controls.txt b/Documentation/sound/alsa/Jack-Controls.txt new file mode 100644 index 0000000..9e93947 --- /dev/null +++ b/Documentation/sound/alsa/Jack-Controls.txt @@ -0,0 +1,48 @@ +Why we need kcontrols for Jack? +=============================== + +ALSA using kcontrols to export controlling(switch, volume, Mux, ...) to +user space, e.g. pulseaudio can switch off headphone and switch on +speaker when no heaphone is pluged in. + +For each physical jack, there may be dynamic pluged in/out status which +upper layer may be interested in. Currently the ALSA jack core registers +only input devices for each jack registered. These jack input devices +are not readable by userspace devices that run as non root. + +So we create embeded kcontrols for each jack, report jack event via +these kcontrols, userspace switch them to ack on these event, to +implement what they are wanna to. + +Combining with ucm machanism, userpace can do fantasic controlling as +they want to. + +Jack and kcontrols +================== + +Each jack will have a kcontrol list, we can create a kcontrol and attach +it to the jack, at jack creating stage. Also, we can add kcontrol to an +exist jack, at anytime when you are happy. + +Those kcontrols will be freed automatically when the Jack is freed. + +How to create kcontrol embedded jack? +===================================== + +To be compatible with previous HD-Audio jack and ASoC jack, we modify +snd_jack_new() with adding two params: + + - @phantom_jack: for phantom jack, only create needed kctl, won't create + real jack device. + - @jjack_kctl: create kctl if non-NULL pointer passed in, and provide + it to the caller. also add it to the non-phantom jack kctl list. + +For HDA jack, we can use phantom_jack = true for phantom jack creating, +and the jack kctl pointer will be filled with the new created kcontrol. + +For ASoC jack, usually, we create kcontrols after jack is created, with +calling snd_hda_jack_add_kctl() for each jack pins. And, the pin name +will be assigned to the corresponding kcontrol name. So, to make +userspace understand and recognize it, please assign proper name for +each jack pin. +