drm/dp_mst: Mention max_payloads in proposed_vcpis/payloads docs

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

Signed-off-by: Lyude Paul <lyude@redhat.com>
Cc: Ville Syrjälä <ville.syrjala@linux.intel.com>
Reviewed-by: Ville Syrjälä <ville.syrjala@linux.intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20200122194321.14953-2-lyude@redhat.com

diff --git a/include/drm/drm_dp_mst_helper.h b/include/drm/drm_dp_mst_helper.h
index 5699493..7b9453b 100644 (file)
--- a/include/drm/drm_dp_mst_helper.h
+++ b/include/drm/drm_dp_mst_helper.h
@@ -624,11 +624,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;
        /**