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 X-Spam-Level: X-Spam-Status: No, score=-3.7 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id BF70CC433DF for ; Thu, 14 May 2020 09:07:45 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id A755920675 for ; Thu, 14 May 2020 09:07:45 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726116AbgENJHo (ORCPT ); Thu, 14 May 2020 05:07:44 -0400 Received: from lgeamrelo11.lge.com ([156.147.23.51]:41672 "EHLO lgeamrelo11.lge.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725878AbgENJHo (ORCPT ); Thu, 14 May 2020 05:07:44 -0400 Received: from unknown (HELO lgemrelse6q.lge.com) (156.147.1.121) by 156.147.23.51 with ESMTP; 14 May 2020 18:07:42 +0900 X-Original-SENDERIP: 156.147.1.121 X-Original-MAILFROM: changjoon.lee@lge.com Received: from unknown (HELO MacBookPro.local.net) (10.157.161.30) by 156.147.1.121 with ESMTP; 14 May 2020 18:07:42 +0900 X-Original-SENDERIP: 10.157.161.30 X-Original-MAILFROM: changjoon.lee@lge.com From: changjoon.lee@lge.com To: tiwai@suse.de Cc: alsa-devel@alsa-project.org, linux@endlessm.com, linux-kernel@vger.kernel.org, ChangJoon Lee Subject: [PATCH 0/1] Documentation update Date: Thu, 14 May 2020 18:07:15 +0900 Message-Id: <20200514090716.39413-1-changjoon.lee@lge.com> X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org From: ChangJoon Lee Hi, ALSA Teams, This is documentation update purpose patch. This patch does NOT alter any of operations. This patch allows an application engineer to understand why they received negative return such as -EIO, -EBADFD, -ENOSYS, -ESTRPIPE and etc which are not fully documented on documentation site. This patch also exposes Expected Status of PCM based on bad_pcm_state() with P_STATE to help engineer to understand API behavior to the documentation site. TODO : We may need improve consistency of return value especially for snd_pcm_hw_params_current(). It returns -EBADFD when PCM is not setup while other API returns -EIO in this case. src/pcm/pcm.c | 57 ++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 54 insertions(+), 3 deletions(-) -- 2.26.2