wifi: iwlwifi: mei: clarify iwl_mei_pldr_req() docs
authorJohannes Berg <johannes.berg@intel.com>
Tue, 18 Jun 2024 16:44:12 +0000 (19:44 +0300)
committerJohannes Berg <johannes.berg@intel.com>
Wed, 26 Jun 2024 08:28:50 +0000 (10:28 +0200)
commit3591e3b9a7cae0f412665f3f5f5f53a29a950d87
treea34f01760b55e53d87cc8e191a10bffefe1d6b59
parent67c638675dcdad588aeb71e67dde77b48a53a320
wifi: iwlwifi: mei: clarify iwl_mei_pldr_req() docs

This isn't related to whether or not "fw can be loaded",
but rather requesting that ME go into a state where doing
a product reset is safe. This is related to FW load only
in the specific case of where it's used today in iwlmvm,
notably when it's known that the firmware itself will (or
at least may) do a product reset during load.

Clarify the documentation.

I was tempted to rename things too, but on the ME side it
really is also called PLDR (which is a Windows term and
may not even match the complete behaviour since doing a
full product reset from the driver also requires calling
an ACPI method first.) So keep the name aligned with ME.

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: Miri Korenblit <miriam.rachel.korenblit@intel.com>
Link: https://patch.msgid.link/20240618194245.ca2c55121a04.I889cd47210367ca9110411472ee696b796a37ab5@changeid
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
drivers/net/wireless/intel/iwlwifi/mei/iwl-mei.h