From patchwork Mon Apr 23 20:11:59 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andres Rodriguez X-Patchwork-Id: 10358069 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 446DD60225 for ; Mon, 23 Apr 2018 20:13:51 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 349E528C29 for ; Mon, 23 Apr 2018 20:13:51 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 2962428C2D; Mon, 23 Apr 2018 20:13:51 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.9 required=2.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED, DKIM_SIGNED, DKIM_VALID, FREEMAIL_FROM, MAILING_LIST_MULTI autolearn=ham version=3.3.1 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id CD11828C29 for ; Mon, 23 Apr 2018 20:13:50 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:MIME-Version:Cc:List-Subscribe: List-Help:List-Post:List-Archive:List-Unsubscribe:List-Id:References: In-Reply-To:Message-Id:Date:Subject:To:From:Reply-To:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Owner; bh=Mv1wrCTpg4rZT30WEv4kw5vWK8eVhAx6MzFVJhteJLA=; b=mHDvRqf2PmbVv1Wb/XnIFOFlKA huac5kW/gwiyPhiXjRkD/O+mV+mGWIR4hBEg1Pl7eJWQFNgJGJB6Wxl2mZP+rJVJ7IKnhGa7rO4pC YZ8KXjdfd8PExh87kk8zHYrWWDMY0Fj4YvfGeWLyiO2k7OmAytigauRCMB87F5wwvXGPHnIXarSE5 RitWOM7tOzdfaLosmYSsnRzLriyMFSU0FCsZgwmVS74JnZ1VP0GwPynou1tVSVjWghSu0e0wedcA1 K+H8PnfspSCKPsf5iX1p0Qxyeo429rVRpwidpEX3+k+BgwpM7ey6nDc0ctCd6D/sr9/F8/MBR8xEi TVnE1/yw==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.90_1 #2 (Red Hat Linux)) id 1fAhqI-0005MK-LX; Mon, 23 Apr 2018 20:13:42 +0000 Received: from mail-it0-x244.google.com ([2607:f8b0:4001:c0b::244]) by bombadil.infradead.org with esmtps (Exim 4.90_1 #2 (Red Hat Linux)) id 1fAhp8-0004mt-5i for ath10k@lists.infradead.org; Mon, 23 Apr 2018 20:12:39 +0000 Received: by mail-it0-x244.google.com with SMTP id 186-v6so12310694itu.0 for ; Mon, 23 Apr 2018 13:12:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=vpDHO6j3TJdgX+FHVGSYaqDzVYqWU0JNJ8rAWoP2l5Q=; b=lDgZCBzNv9v7e/M6L7vEcXWjl3MvuNua3VA1X1qXKlDfOUs9GZJ8NMrB+ZuJ3IdumB CHMMbG7NU4B+dRfPR7ryCGcpBEoRd6SWqkpSqVwC4mFeSAB9mGANTEid6cDFI5UgVOL6 KbENHJqAnfuI2Jzjvj94bQ6l3rzCIOo0YnO8MFzJFgQUcf/e2N/rqyCfQgq8elhZUn70 gTUGbo42ZEzaNAm4bRBypvtw9wxZ6fSFVehdTBwDL/Z8my/QzwW2mdSzskqPbwWeXTJ3 5r9KsZt/jbURVwq/UNsRxMsdryP6wB1/zi4G6ut1gr948Rx1kmf1x09H7FYvHyOBO5ow qwzw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=vpDHO6j3TJdgX+FHVGSYaqDzVYqWU0JNJ8rAWoP2l5Q=; b=YCxqVVXNUaDtWtG31c2JNZ4tjuE2c6a/AQIV+dcl6wdH9PY3yNXUTx9Ww4jUvAzStF ZJ90Z9Nl+r6JnFK9Zrr2AAtDxrNqvWhBfoqFFXNKPT4gt2RD2vRebzBM3DcVnVmTNJHZ 6pk6TS7I8bQ2+XjILVCUwNVtjvgvQ+AJPS7FtMZjYZDMLizhNA3RzxewPU6gcnNn2pqK VRhgWQ77XUlst4vK7umv/QF7xoESCldp1WzJ7DRzfxIeWMWhdn4KVSIb620ltC6119r5 oR8gcBfmnb/o1LMYv4E93Sr+7qY0ABoDO0P6D8Bb7rWhFztnPRTU3yDp3ORu1a2Gma+r 7X8Q== X-Gm-Message-State: ALQs6tAJZ/3kOm0xKhvvLOarng/EIot2iB8DEee1BOomLEVsmlJyM33n gYeuCv2Dcl9qed2MeUX1Tmg= X-Google-Smtp-Source: AIpwx4/EWlWNQyC0e8S9YP2vsStGOSnVSa5XFtmB8c6MhDNNzqPr81CTrhuWKpYryn+LDBA4ZvvGpg== X-Received: by 2002:a24:9305:: with SMTP id y5-v6mr16660645itd.13.1524514338421; Mon, 23 Apr 2018 13:12:18 -0700 (PDT) Received: from localhost.localdomain (184-175-36-239.dsl.teksavvy.com. [184.175.36.239]) by smtp.gmail.com with ESMTPSA id k130-v6sm1632551itb.0.2018.04.23.13.12.16 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 23 Apr 2018 13:12:17 -0700 (PDT) From: Andres Rodriguez To: linux-kernel@vger.kernel.org Subject: [PATCH 3/9] firmware: add kernel-doc for enum fw_opt Date: Mon, 23 Apr 2018 16:11:59 -0400 Message-Id: <20180423201205.20533-4-andresx7@gmail.com> X-Mailer: git-send-email 2.14.1 In-Reply-To: <20180423201205.20533-1-andresx7@gmail.com> References: <20180423201205.20533-1-andresx7@gmail.com> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20180423_131230_461728_FCE95AD2 X-CRM114-Status: GOOD ( 11.29 ) X-BeenThere: ath10k@lists.infradead.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: arend.vanspriel@broadcom.com, gregkh@linuxfoundation.org, linux-wireless@vger.kernel.org, ath10k@lists.infradead.org, hdegoede@redhat.com, mcgrof@kernel.org, andresx7@gmail.com, alexdeucher@gmail.com, christian.koenig@amd.com, kvalo@codeaurora.org MIME-Version: 1.0 Sender: "ath10k" Errors-To: ath10k-bounces+patchwork-ath10k=patchwork.kernel.org@lists.infradead.org X-Virus-Scanned: ClamAV using ClamSMTP Some basic definitions for the FW_OPT_* values v2: Documentation corrections from Luis. Signed-off-by: Andres Rodriguez --- drivers/base/firmware_loader/firmware.h | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/drivers/base/firmware_loader/firmware.h b/drivers/base/firmware_loader/firmware.h index b252bfa82295..a405d400a925 100644 --- a/drivers/base/firmware_loader/firmware.h +++ b/drivers/base/firmware_loader/firmware.h @@ -11,6 +11,26 @@ #include +/** + * enum fw_opt - options to control firmware loading behaviour + * + * @FW_OPT_UEVENT: Enables the fallback mechanism to send a kobject uevent + * when the firmware is not found. Userspace is in charge + * to load the firmware using the sysfs loading facility. + * @FW_OPT_NOWAIT: Used to describe the firmware request is asynchronous. + * @FW_OPT_USERHELPER: Enable the fallback mechanism, in case the direct + * filesystem lookup fails at finding the firmware. + * For details refer to fw_sysfs_fallback(). + * @FW_OPT_NO_WARN: Quiet, avoid printing warning messages. + * @FW_OPT_NOCACHE: Disables firmware caching. Firmware caching is used to + * cache the firmware upon suspend, so that upon resume + * races against the firmware file lookup on storage is + * avoided. Used for calls where the file may be too + * big, or where the driver takes charge of its own firmware + * caching mechanism. + * @FW_OPT_NOFALLBACK: Disable the fallback mechanism. Takes precedence over + * &FW_OPT_UEVENT and &FW_OPT_USERHELPER. + */ enum fw_opt { FW_OPT_UEVENT = BIT(0), FW_OPT_NOWAIT = BIT(1),