amdgpu/pm: Clarify documentation of error handling in send_smc_mesg
authorDarren Powell <darren.powell@amd.com>
Wed, 6 Apr 2022 02:17:08 +0000 (22:17 -0400)
committerAlex Deucher <alexander.deucher@amd.com>
Tue, 19 Apr 2022 17:58:32 +0000 (13:58 -0400)
commitf24044bd9b16a059e5773170fbfa1badc536d657
tree1b8ef57a6083f44b43d485dd390a7e5fe3355b9e
parenteea5c7b3390c6e006ba4cbd906447dd8cea8cfbf
amdgpu/pm: Clarify documentation of error handling in send_smc_mesg

Clarify the smu_cmn_send_smc_msg_with_param documentation to mention two
cases exist where messages are silently dropped with no error returned.
These cases occur in unusual situations where either:
 1. the message type is not allowed to a virtual GPU, or
 2. a PCI recovery is underway and the HW is not yet in sync with the SW

For more details see
 commit 4ea5081c82c4 ("drm/amd/powerplay: enable SMC message filter")
 commit bf36b52e781d ("drm/amdgpu: Avoid accessing HW when suspending SW state")

(v2)
  Reworked with suggestions from Luben & Paul

(v3)
  Updated wording as per Luben's feedback
  Corrected error stating all messages denied on virtual GPU
  (each GPU has mask of which messages are allowed)

Signed-off-by: Darren Powell <darren.powell@amd.com>
Reviewed-by: Luben Tuikov <luben.tuikov@amd.com>
Signed-off-by: Alex Deucher <alexander.deucher@amd.com>
drivers/gpu/drm/amd/pm/swsmu/smu_cmn.c