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: 10358075 X-Patchwork-Delegate: kvalo@adurom.com 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 3EE7060209 for ; Mon, 23 Apr 2018 20:14:03 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 30B8328C29 for ; Mon, 23 Apr 2018 20:14:03 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 24CE528C3C; Mon, 23 Apr 2018 20:14:03 +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=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, FREEMAIL_FROM, MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI autolearn=unavailable version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 88E9628C2C for ; Mon, 23 Apr 2018 20:14:02 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932514AbeDWUMY (ORCPT ); Mon, 23 Apr 2018 16:12:24 -0400 Received: from mail-it0-f65.google.com ([209.85.214.65]:38432 "EHLO mail-it0-f65.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932306AbeDWUMT (ORCPT ); Mon, 23 Apr 2018 16:12:19 -0400 Received: by mail-it0-f65.google.com with SMTP id 19-v6so12314136itw.3; 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=O7MIloKnJZ/GDTBIh6U8Emg+CKtr40ngYkVQGIfYi+dSLvjKhMqnJwOM7uZCbQq+6Z TsRDnJQeBLjopxtALceNSUnVbz+8vjzo9Hi/UUbsaygHxjQEZwl/Z7c7PuNTJHS5QL87 G4ADsq8Xxa+hbD7lFMnr2WuGelH4LZMJReRquI3cgC/QGSu7IYwMT9TIWV2jMGKJA8UL 4GAcn6D+ZN8uJLGdePuf15eBF4AYH500OWQ/7txikebk0zmwkPSSkXDoY4IXjGPs01zC LEIsNRSpqYejvxsso0jUHsgwlfHKWLbZAZ5rMpwGyLLIwuAZwjInZSSdgBY7B287boaT zzWg== X-Gm-Message-State: ALQs6tDEPZWp/zl+7L5HYzKw9IHyxS3MxwCFa/mCQT71lVioTIj07pcp WvygXDO8K2zANq2LFD2+3ro0OIsXA+A= 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 Cc: andresx7@gmail.com, gregkh@linuxfoundation.org, mcgrof@kernel.org, alexdeucher@gmail.com, christian.koenig@amd.com, kvalo@codeaurora.org, arend.vanspriel@broadcom.com, linux-wireless@vger.kernel.org, ath10k@lists.infradead.org, hdegoede@redhat.com 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> Sender: linux-wireless-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-wireless@vger.kernel.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),