From patchwork Thu Mar 5 12:51:58 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tanu Kaskinen X-Patchwork-Id: 5945731 Return-Path: X-Original-To: patchwork-alsa-devel@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork1.web.kernel.org (Postfix) with ESMTP id 4C6BF9F380 for ; Thu, 5 Mar 2015 12:53:10 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 8DD26201BC for ; Thu, 5 Mar 2015 12:53:09 +0000 (UTC) Received: from alsa0.perex.cz (alsa0.perex.cz [77.48.224.243]) by mail.kernel.org (Postfix) with ESMTP id 217C220381 for ; Thu, 5 Mar 2015 12:53:08 +0000 (UTC) Received: by alsa0.perex.cz (Postfix, from userid 1000) id 8DFA12657B1; Thu, 5 Mar 2015 13:53:05 +0100 (CET) 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, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 Received: from alsa0.perex.cz (localhost [IPv6:::1]) by alsa0.perex.cz (Postfix) with ESMTP id D2C622657D8; Thu, 5 Mar 2015 13:52:15 +0100 (CET) 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 6B2F5260439; Thu, 5 Mar 2015 13:52:13 +0100 (CET) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by alsa0.perex.cz (Postfix) with ESMTP id 70A89265475 for ; Thu, 5 Mar 2015 13:52:05 +0100 (CET) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga101.fm.intel.com with ESMTP; 05 Mar 2015 04:52:05 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.11,346,1422950400"; d="scan'208";a="694343526" Received: from tkkaskin-mobl3.tm.intel.com ([10.237.50.55]) by orsmga002.jf.intel.com with ESMTP; 05 Mar 2015 04:52:03 -0800 From: Tanu Kaskinen To: alsa-devel@alsa-project.org Date: Thu, 5 Mar 2015 14:51:58 +0200 Message-Id: <1425559918-23075-3-git-send-email-tanu.kaskinen@linux.intel.com> X-Mailer: git-send-email 1.9.3 In-Reply-To: <1425559918-23075-1-git-send-email-tanu.kaskinen@linux.intel.com> References: <1425559918-23075-1-git-send-email-tanu.kaskinen@linux.intel.com> Cc: tiwai@suse.de, liam.r.girdwood@linux.intel.com, han.lu@intel.com Subject: [alsa-devel] [PATCH v2 2/2] ucm: improve jack configuration documentation 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 Signed-off-by: Tanu Kaskinen --- include/use-case.h | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/include/use-case.h b/include/use-case.h index d309522..e3308b1 100644 --- a/include/use-case.h +++ b/include/use-case.h @@ -301,12 +301,24 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr, * - name of capture mixer * - CaptureMixerID * - mixer capture ID - * - JackDev - * - jack device name - * - JackControl - * - jack control name - * - JackHWMute - * - indicate if the HW mutes a device on jack insertion or not. + * - JackControl, JackDev, JackHWMute + * - Jack information for a device. The jack status can be reported via + * a kcontrol and/or via an input device. **JackControl** is the + * kcontrol name of the jack, and **JackDev** is the input device id of + * the jack (if the full input device path is /dev/input/by-id/foo, the + * JackDev value should be "foo"). UCM configuration files should + * contain both JackControl and JackDev when possible, because + * applications are likely to support only one or the other. + * + * If **JackHWMute** is set, it indicates that when the jack is plugged + * in, the hardware automatically mutes some other device. The + * JackHWMute value is the name of the muted device. Note that + * JackHWMute should be used only when the hardware enforces the + * automatic muting. If the hardware doesn't enforce any muting, it may + * still be tempting to set JackHWMute to trick upper software layers to + * e.g. automatically mute speakers when headphones are plugged in, but + * that's application policy configuration that doesn't belong to UCM + * configuration files. */ int snd_use_case_get(snd_use_case_mgr_t *uc_mgr, const char *identifier,