[PATCH v2 2/2] drm/dp_mst: Mention max_payloads in proposed_vcpis/payloads docs

From: Lyude Paul
Date: Wed Jan 22 2020 - 14:43:49 EST


Mention that the size of these two structs is determined by
max_payloads. Suggested by Ville SyrjÃlÃ.

Signed-off-by: Lyude Paul <lyude@xxxxxxxxxx>
Cc: Ville SyrjÃlà <ville.syrjala@xxxxxxxxxxxxxxx>
---
include/drm/drm_dp_mst_helper.h | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/include/drm/drm_dp_mst_helper.h b/include/drm/drm_dp_mst_helper.h
index bcb39da9adb4..5483f888712a 100644
--- a/include/drm/drm_dp_mst_helper.h
+++ b/include/drm/drm_dp_mst_helper.h
@@ -635,11 +635,13 @@ struct drm_dp_mst_topology_mgr {
struct mutex payload_lock;
/**
* @proposed_vcpis: Array of pointers for the new VCPI allocation. The
- * VCPI structure itself is &drm_dp_mst_port.vcpi.
+ * VCPI structure itself is &drm_dp_mst_port.vcpi, and the size of
+ * this array is determined by @max_payloads.
*/
struct drm_dp_vcpi **proposed_vcpis;
/**
- * @payloads: Array of payloads.
+ * @payloads: Array of payloads. The size of this array is determined
+ * by @max_payloads.
*/
struct drm_dp_payload *payloads;
/**
--
2.24.1