All of lore.kernel.org
 help / color / mirror / Atom feed
From: Andres Rodriguez <andresx7@gmail.com>
To: linux-kernel@vger.kernel.org
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
Subject: [PATCH 3/9] firmware: add kernel-doc for enum fw_opt
Date: Mon, 23 Apr 2018 16:11:59 -0400	[thread overview]
Message-ID: <20180423201205.20533-4-andresx7@gmail.com> (raw)
In-Reply-To: <20180423201205.20533-1-andresx7@gmail.com>

Some basic definitions for the FW_OPT_* values

v2: Documentation corrections from Luis.

Signed-off-by: Andres Rodriguez <andresx7@gmail.com>
---
 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 <generated/utsrelease.h>
 
+/**
+ * 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),
-- 
2.14.1


_______________________________________________
ath10k mailing list
ath10k@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/ath10k

WARNING: multiple messages have this Message-ID (diff)
From: Andres Rodriguez <andresx7@gmail.com>
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	[thread overview]
Message-ID: <20180423201205.20533-4-andresx7@gmail.com> (raw)
In-Reply-To: <20180423201205.20533-1-andresx7@gmail.com>

Some basic definitions for the FW_OPT_* values

v2: Documentation corrections from Luis.

Signed-off-by: Andres Rodriguez <andresx7@gmail.com>
---
 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 <generated/utsrelease.h>
 
+/**
+ * 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),
-- 
2.14.1

  parent reply	other threads:[~2018-04-23 20:12 UTC|newest]

Thread overview: 60+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-04-23 20:11 [PATCH 0/9] Loading optional firmware v4 Andres Rodriguez
2018-04-23 20:11 ` Andres Rodriguez
2018-04-23 20:11 ` [PATCH 1/9] firmware: some documentation fixes Andres Rodriguez
2018-04-23 20:11   ` Andres Rodriguez
2018-04-25 15:25   ` Greg KH
2018-04-25 15:25     ` Greg KH
2018-04-25 15:26     ` Greg KH
2018-04-25 15:26       ` Greg KH
2018-04-25 16:25       ` [PATCH 1/2] " Andres Rodriguez
2018-04-25 16:25         ` Andres Rodriguez
2018-04-25 16:25         ` [PATCH 2/2] usb: typec: fix formatting errors that cause build breakage Andres Rodriguez
2018-04-25 16:25           ` Andres Rodriguez
2018-04-25 16:35           ` Greg KH
2018-04-25 16:35             ` Greg KH
2018-04-25 16:36         ` [PATCH 1/2] firmware: some documentation fixes Greg KH
2018-04-25 16:36           ` Greg KH
2018-05-03 23:31   ` [PATCH 1/9] " Luis R. Rodriguez
2018-05-03 23:31     ` Luis R. Rodriguez
2018-04-23 20:11 ` [PATCH 2/9] firmware: wrap FW_OPT_* into an enum Andres Rodriguez
2018-04-23 20:11   ` Andres Rodriguez
2018-05-03 23:35   ` Luis R. Rodriguez
2018-05-03 23:35     ` Luis R. Rodriguez
2018-04-23 20:11 ` Andres Rodriguez [this message]
2018-04-23 20:11   ` [PATCH 3/9] firmware: add kernel-doc for enum fw_opt Andres Rodriguez
2018-05-03 23:36   ` Luis R. Rodriguez
2018-05-03 23:36     ` Luis R. Rodriguez
2018-04-23 20:12 ` [PATCH 4/9] firmware: use () to terminate kernel-doc function names Andres Rodriguez
2018-04-23 20:12   ` Andres Rodriguez
2018-05-03 23:37   ` Luis R. Rodriguez
2018-05-03 23:37     ` Luis R. Rodriguez
2018-04-23 20:12 ` [PATCH 5/9] firmware: add function to load firmware without warnings v5 Andres Rodriguez
2018-04-23 20:12   ` Andres Rodriguez
2018-05-03 23:40   ` Luis R. Rodriguez
2018-05-03 23:40     ` Luis R. Rodriguez
2018-05-04  0:00   ` Luis R. Rodriguez
2018-05-04  0:00     ` Luis R. Rodriguez
2018-04-23 20:12 ` [PATCH 6/9] firmware: print firmware name on fallback path Andres Rodriguez
2018-04-23 20:12   ` Andres Rodriguez
2018-05-03 23:42   ` Luis R. Rodriguez
2018-05-03 23:42     ` Luis R. Rodriguez
2018-05-05  2:57     ` Andres Rodriguez
2018-05-05  2:57       ` Andres Rodriguez
2018-05-08  0:20       ` Luis R. Rodriguez
2018-05-08  0:20         ` Luis R. Rodriguez
2018-05-12  8:03     ` Kalle Valo
2018-05-12  8:03       ` Kalle Valo
2018-05-12  9:06       ` Luis R. Rodriguez
2018-05-12  9:06         ` Luis R. Rodriguez
2018-04-23 20:12 ` [PATCH 7/9] firmware: use rename fw_sysfs_fallback to use the firmware_ prefix Andres Rodriguez
2018-04-23 20:12   ` Andres Rodriguez
2018-05-03 23:44   ` Luis R. Rodriguez
2018-05-03 23:44     ` Luis R. Rodriguez
2018-04-23 20:12 ` [PATCH 8/9] ath10k: use request_firmware_nowarn to load firmware Andres Rodriguez
2018-04-23 20:12   ` Andres Rodriguez
2018-04-23 20:12 ` [PATCH 9/9] ath10k: re-enable the firmware fallback mechanism for testmode Andres Rodriguez
2018-04-23 20:12   ` Andres Rodriguez
2018-04-24  5:29   ` Kalle Valo
2018-04-24  5:29     ` Kalle Valo
  -- strict thread matches above, loose matches on Subject: below --
2018-04-17 15:32 [PATCH 0/9] Loading optional firmware v3 Andres Rodriguez
2018-04-17 15:33 ` [PATCH 3/9] firmware: add kernel-doc for enum fw_opt Andres Rodriguez
2018-04-21 14:26   ` Luis R. Rodriguez

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180423201205.20533-4-andresx7@gmail.com \
    --to=andresx7@gmail.com \
    --cc=alexdeucher@gmail.com \
    --cc=arend.vanspriel@broadcom.com \
    --cc=ath10k@lists.infradead.org \
    --cc=christian.koenig@amd.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=hdegoede@redhat.com \
    --cc=kvalo@codeaurora.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-wireless@vger.kernel.org \
    --cc=mcgrof@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.