Skip to contentSkip to conversation

Document drm_mode_get_plane

PATCH Superseded Leandro Ribeiro 4 participants 10 messages Apr 22, 2021 – Apr 28, 2021

Subsystems (2)

v2 of 6 Superseded Latest is v6 →

lore
Share & tools
lore
#0 lore raw

v2 cover Document drm_mode_get_plane

This is a follow up of the patchset "Document how userspace should use plane format list and IN_FORMATS":

https://lists.freedesktop.org/archives/dri-devel/2021-April/302433.html

The first patch of the series ("drm/doc: document drm_mode_get_plane") is still useful, although the other commit of the series was incorrect. So I'm pushing the first commit again.

v2: possible_crtcs field is a bitmask, not a pointer. Suggested by Ville Syrjälä <[email protected]>

Leandro Ribeiro (1):
drm/doc: document drm_mode_get_plane

 include/uapi/drm/drm_mode.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

--
2.31.1

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

#1 lore raw

PATCH v2 1/1 drm/doc: document drm_mode_get_plane

Add a small description and document struct fields of drm_mode_get_plane.

---
 include/uapi/drm/drm_mode.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
include/uapi/drm/drm_mode.h +16 -0
index a5e76aa06ad5..3e85de928db9 100644
@@ -312,16 +312,32 @@ struct drm_mode_set_plane {
 	__u32 src_w;
 };
 
+/**
+ * struct drm_mode_get_plane - Get plane metadata.
+ *
+ * Userspace can perform a GETPLANE ioctl to retrieve information about a
+ * plane.
+ */
 struct drm_mode_get_plane {
+	/** @plane_id: Object ID of the plane. */
 	__u32 plane_id;
 
+	/** @crtc_id: Object ID of the current CRTC. */
 	__u32 crtc_id;
+	/** @fb_id: Object ID of the current fb. */
 	__u32 fb_id;
 
+	/** @possible_crtcs: Bitmask of CRTC's compatible with the plane. */
 	__u32 possible_crtcs;
+	/** @gamma_size: Size of the legacy gamma table. */
 	__u32 gamma_size;
 
+	/** @count_format_types: Number of formats. */
 	__u32 count_format_types;
+	/**
+	 * @format_type_ptr: Pointer to ``__u32`` array of formats that are
+	 * supported by the plane. These formats do not require modifiers.
+	 */
 	__u64 format_type_ptr;
 };
 

--
2.31.1

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

#2 lore raw

Re: [PATCH v2 1/1] drm/doc: document drm_mode_get_plane

Quoted 22 lines · On Thu, 22 Apr 2021 15:10:04 -0300 Leandro Ribeiro…

Add a small description and document struct fields of drm_mode_get_plane.

---
 include/uapi/drm/drm_mode.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
include/uapi/drm/drm_mode.h +6 -0
index a5e76aa06ad5..3e85de928db9 100644
@@ -312,16 +312,32 @@ struct drm_mode_set_plane {
 	__u32 src_w;
 };
 
+/**
+ * struct drm_mode_get_plane - Get plane metadata.
+ *
+ * Userspace can perform a GETPLANE ioctl to retrieve information about a
+ * plane.
+ */

include/uapi/drm/drm_mode.h struct drm_mode_set_plane { · line 330

Quoted 10 lines
include/uapi/drm/drm_mode.h +4 -0
 struct drm_mode_get_plane {
+	/** @plane_id: Object ID of the plane. */
 	__u32 plane_id;
 
+	/** @crtc_id: Object ID of the current CRTC. */
 	__u32 crtc_id;
+	/** @fb_id: Object ID of the current fb. */
 	__u32 fb_id;
 
+	/** @possible_crtcs: Bitmask of CRTC's compatible with the plane. */

This should probably explain what the bits in the mask correspond to. As in, which CRTC does bit 0 refer to, and so on.

include/uapi/drm/drm_mode.h struct drm_mode_set_plane { · line 332

Quoted 2 lines
include/uapi/drm/drm_mode.h +1 -0
 	__u32 possible_crtcs;
+	/** @gamma_size: Size of the legacy gamma table. */

What are the units? Entries? Bytes?

include/uapi/drm/drm_mode.h struct drm_mode_set_plane { · line 339

Quoted 7 lines
include/uapi/drm/drm_mode.h +4 -0
 	__u32 gamma_size;
 
+	/** @count_format_types: Number of formats. */
 	__u32 count_format_types;
+	/**
+	 * @format_type_ptr: Pointer to ``__u32`` array of formats that are
+	 * supported by the plane. These formats do not require modifiers.

I wonder if the "do not require modifiers" is again going too far in making a difference between this list and IN_FORMATS?

include/uapi/drm/drm_mode.h struct drm_mode_set_plane { · line 342

Quoted 3 lines
include/uapi/drm/drm_mode.h +1 -0
+	 */
 	__u64 format_type_ptr;
 };

Other than those, looks like a significant improvement to me.

Thanks,
pq

Quoted 8 lines
include/uapi/drm/drm_mode.h +0 -1
--

2.31.1

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

#3 lore raw

Re: [PATCH v2 1/1] drm/doc: document drm_mode_get_plane

Quoted 34 lines · Pekka Paalanen
Quoted 31 lines · On Thu, 22 Apr 2021 15:10:04 -0300 Leandro Ribeiro…

Add a small description and document struct fields of drm_mode_get_plane.

---
 include/uapi/drm/drm_mode.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
include/uapi/drm/drm_mode.h +9 -0
index a5e76aa06ad5..3e85de928db9 100644
@@ -312,16 +312,32 @@ struct drm_mode_set_plane {
 	__u32 src_w;
 };
 
+/**
+ * struct drm_mode_get_plane - Get plane metadata.
+ *
+ * Userspace can perform a GETPLANE ioctl to retrieve information about a
+ * plane.
+ */
 struct drm_mode_get_plane {
+	/** @plane_id: Object ID of the plane. */
 	__u32 plane_id;
 
+	/** @crtc_id: Object ID of the current CRTC. */
 	__u32 crtc_id;
+	/** @fb_id: Object ID of the current fb. */
 	__u32 fb_id;
 
Quoted 5 lines

include/uapi/drm/drm_mode.h struct drm_mode_set_plane { · line 330

Quoted 1 line
include/uapi/drm/drm_mode.h +1 -0
+	/** @possible_crtcs: Bitmask of CRTC's compatible with the plane. */

This should probably explain what the bits in the mask correspond to. As in, which CRTC does bit 0 refer to, and so on.

What about:

"possible_crtcs: Bitmask of CRTC's compatible with the plane. CRTC's are created and they receive an index, which corresponds to their position in the bitmask. CRTC with index 0 will be in bit 0, and so on."

Quoted 5 lines

include/uapi/drm/drm_mode.h struct drm_mode_set_plane { · line 332

Quoted 2 lines
include/uapi/drm/drm_mode.h +1 -0
 	__u32 possible_crtcs;
+	/** @gamma_size: Size of the legacy gamma table. */

What are the units? Entries? Bytes?

The number of entries. I'll update to "gamma_size: Number of entries of the legacy gamma lookup table" in the next version.

Quoted 11 lines

include/uapi/drm/drm_mode.h struct drm_mode_set_plane { · line 339

Quoted 7 lines
include/uapi/drm/drm_mode.h +4 -0
 	__u32 gamma_size;
 
+	/** @count_format_types: Number of formats. */
 	__u32 count_format_types;
+	/**
+	 * @format_type_ptr: Pointer to ``__u32`` array of formats that are
+	 * supported by the plane. These formats do not require modifiers.

I wonder if the "do not require modifiers" is again going too far in making a difference between this list and IN_FORMATS?

Yes that's true, I'll drop this phrase.

Quoted 7 lines

include/uapi/drm/drm_mode.h struct drm_mode_set_plane { · line 342

Quoted 3 lines
include/uapi/drm/drm_mode.h +1 -0
+	 */
 	__u64 format_type_ptr;
 };

Other than those, looks like a significant improvement to me.

Quoted 12 lines

Thanks,
pq

Quoted 8 lines
include/uapi/drm/drm_mode.h +0 -1
--

2.31.1

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

#4 lore raw

Re: [PATCH v2 1/1] drm/doc: document drm_mode_get_plane

Quoted 41 lines · On Fri, 23 Apr 2021 18:30:33 -0300 Leandro Ribeiro…
Quoted 34 lines · Pekka Paalanen
Quoted 31 lines · On Thu, 22 Apr 2021 15:10:04 -0300 Leandro Ribeiro…

Add a small description and document struct fields of drm_mode_get_plane.

---
 include/uapi/drm/drm_mode.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
include/uapi/drm/drm_mode.h +9 -0
index a5e76aa06ad5..3e85de928db9 100644
@@ -312,16 +312,32 @@ struct drm_mode_set_plane {
 	__u32 src_w;
 };
 
+/**
+ * struct drm_mode_get_plane - Get plane metadata.
+ *
+ * Userspace can perform a GETPLANE ioctl to retrieve information about a
+ * plane.
+ */
 struct drm_mode_get_plane {
+	/** @plane_id: Object ID of the plane. */
 	__u32 plane_id;
 
+	/** @crtc_id: Object ID of the current CRTC. */
 	__u32 crtc_id;
+	/** @fb_id: Object ID of the current fb. */
 	__u32 fb_id;
 
Quoted 5 lines

include/uapi/drm/drm_mode.h struct drm_mode_set_plane { · line 330

Quoted 1 line
include/uapi/drm/drm_mode.h +1 -0
+	/** @possible_crtcs: Bitmask of CRTC's compatible with the plane. */  

This should probably explain what the bits in the mask correspond to. As in, which CRTC does bit 0 refer to, and so on.

Quoted 5 lines

What about:

"possible_crtcs: Bitmask of CRTC's compatible with the plane. CRTC's are created and they receive an index, which corresponds to their position in the bitmask. CRTC with index 0 will be in bit 0, and so on."

This would still need to explain where can I find this index.

Quoted 8 lines
Quoted 5 lines

include/uapi/drm/drm_mode.h struct drm_mode_set_plane { · line 332

Quoted 2 lines
include/uapi/drm/drm_mode.h +1 -0
 	__u32 possible_crtcs;
+	/** @gamma_size: Size of the legacy gamma table. */  

What are the units? Entries? Bytes?

The number of entries. I'll update to "gamma_size: Number of entries of the legacy gamma lookup table" in the next version.

Sounds good!

Thanks,
pq

Quoted 12 lines
Quoted 11 lines

include/uapi/drm/drm_mode.h struct drm_mode_set_plane { · line 339

Quoted 7 lines
include/uapi/drm/drm_mode.h +4 -0
 	__u32 gamma_size;
 
+	/** @count_format_types: Number of formats. */
 	__u32 count_format_types;
+	/**
+	 * @format_type_ptr: Pointer to ``__u32`` array of formats that are
+	 * supported by the plane. These formats do not require modifiers.  

I wonder if the "do not require modifiers" is again going too far in making a difference between this list and IN_FORMATS?

Quoted 21 lines

Yes that's true, I'll drop this phrase.

Quoted 19 lines

include/uapi/drm/drm_mode.h struct drm_mode_set_plane { · line 342

Quoted 3 lines
include/uapi/drm/drm_mode.h +1 -0
+	 */
 	__u64 format_type_ptr;
 };  

Other than those, looks like a significant improvement to me.

Thanks,
pq

Quoted 8 lines
include/uapi/drm/drm_mode.h +0 -1
--

2.31.1

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

#5 lore raw

Re: [PATCH v2 1/1] drm/doc: document drm_mode_get_plane

Quoted 10 lines · Pekka Paalanen
Quoted 8 lines
Quoted 2 lines

This should probably explain what the bits in the mask correspond to. As in, which CRTC does bit 0 refer to, and so on.

What about:

"possible_crtcs: Bitmask of CRTC's compatible with the plane. CRTC's are created and they receive an index, which corresponds to their position in the bitmask. CRTC with index 0 will be in bit 0, and so on."

This would still need to explain where can I find this index.

This closed merge request had some docs about possible CRTCs:

https://gitlab.freedesktop.org/mesa/drm/-/merge_requests/102
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

#6 lore raw

Re: [PATCH v2 1/1] drm/doc: document drm_mode_get_plane

Quoted 5 lines · Simon Ser
Quoted 3 lines · Pekka Paalanen
Quoted 3 lines
Quoted 2 lines

This should probably explain what the bits in the mask correspond to. As in, which CRTC does bit 0 refer to, and so on.

Quoted 8 lines
Quoted 7 lines
Quoted 5 lines

What about:

"possible_crtcs: Bitmask of CRTC's compatible with the plane. CRTC's are created and they receive an index, which corresponds to their position in the bitmask. CRTC with index 0 will be in bit 0, and so on."

This would still need to explain where can I find this index.

What do you mean?

Quoted 4 lines

This closed merge request had some docs about possible CRTCs:

https://gitlab.freedesktop.org/mesa/drm/-/merge_requests/102

I'm afraid I don't know exactly what you expect to be documented here that is still missing. Could you please elaborate?

Thanks a lot!
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

#7 lore raw

Re: [PATCH v2 1/1] drm/doc: document drm_mode_get_plane

Quoted 17 lines · On Mon, 26 Apr 2021 14:30:53 -0300 Leandro Ribeiro…
Quoted 5 lines · Simon Ser
Quoted 3 lines · Pekka Paalanen
Quoted 3 lines
Quoted 2 lines

This should probably explain what the bits in the mask correspond to. As in, which CRTC does bit 0 refer to, and so on.

Quoted 8 lines
Quoted 7 lines
Quoted 5 lines

What about:

"possible_crtcs: Bitmask of CRTC's compatible with the plane. CRTC's are created and they receive an index, which corresponds to their position in the bitmask. CRTC with index 0 will be in bit 0, and so on."

This would still need to explain where can I find this index.

What do you mean?

Quoted 8 lines
Quoted 4 lines

This closed merge request had some docs about possible CRTCs:

https://gitlab.freedesktop.org/mesa/drm/-/merge_requests/102

I'm afraid I don't know exactly what you expect to be documented here that is still missing. Could you please elaborate?

Thanks a lot!

The documentation you add is talking about "CRTC index". What defines a CRTC object's index? How do I determine what index a CRTC object has?

The answer is, AFAIK, that the index is never stored explicitly anywhere. You have to get the DRM resources structure, which has an array for CRTC IDs. The index is the index to that array, IIRC. So if one does not already know this, it is going to be really hard to figure out what the "index" is. It might even be confused with the object ID, which it is not but the ID might by complete accident be less than 32 so it would look ok at first glance.

If the index is already explained somewhere else, a reference to that documentation would be enough.

Thanks,
pq

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

#8 lore raw

Re: [PATCH v2 1/1] drm/doc: document drm_mode_get_plane

Quoted 40 lines · Pekka Paalanen
Quoted 17 lines · On Mon, 26 Apr 2021 14:30:53 -0300 Leandro Ribeiro…
Quoted 5 lines · Simon Ser
Quoted 3 lines · Pekka Paalanen
Quoted 3 lines
Quoted 2 lines

This should probably explain what the bits in the mask correspond to. As in, which CRTC does bit 0 refer to, and so on.

Quoted 8 lines
Quoted 7 lines
Quoted 5 lines

What about:

"possible_crtcs: Bitmask of CRTC's compatible with the plane. CRTC's are created and they receive an index, which corresponds to their position in the bitmask. CRTC with index 0 will be in bit 0, and so on."

This would still need to explain where can I find this index.

What do you mean?

Quoted 8 lines
Quoted 4 lines

This closed merge request had some docs about possible CRTCs:

https://gitlab.freedesktop.org/mesa/drm/-/merge_requests/102

I'm afraid I don't know exactly what you expect to be documented here that is still missing. Could you please elaborate?

Thanks a lot!

The documentation you add is talking about "CRTC index". What defines a CRTC object's index? How do I determine what index a CRTC object has?

The answer is, AFAIK, that the index is never stored explicitly anywhere. You have to get the DRM resources structure, which has an array for CRTC IDs. The index is the index to that array, IIRC. So if one does not already know this, it is going to be really hard to figure out what the "index" is. It might even be confused with the object ID, which it is not but the ID might by complete accident be less than 32 so it would look ok at first glance.

Quoted 2 lines

If the index is already explained somewhere else, a reference to that documentation would be enough.

I think if we do this we should have a DOC: section in the drm_mode.h uapi header which explains how the index is computed, and then we reference that everywhere. Because otherwise there's going to be a _lot_ of duplication of this all over. Kernel-internally we solve this by just referencing drm_foo_index() family of functions, but for the uapi there's really nothing, so needs text.

-Daniel

Signature · 7 lines
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
#9 lore raw

Re: [PATCH v2 1/1] drm/doc: document drm_mode_get_plane

Quoted 44 lines · Daniel Vetter
Quoted 40 lines · Pekka Paalanen
Quoted 17 lines · On Mon, 26 Apr 2021 14:30:53 -0300 Leandro Ribeiro…
Quoted 5 lines · Simon Ser
Quoted 3 lines · Pekka Paalanen
Quoted 3 lines
Quoted 2 lines

This should probably explain what the bits in the mask correspond to. As in, which CRTC does bit 0 refer to, and so on.

Quoted 8 lines
Quoted 7 lines
Quoted 5 lines

What about:

"possible_crtcs: Bitmask of CRTC's compatible with the plane. CRTC's are created and they receive an index, which corresponds to their position in the bitmask. CRTC with index 0 will be in bit 0, and so on."

This would still need to explain where can I find this index.

What do you mean?

Quoted 8 lines
Quoted 4 lines

This closed merge request had some docs about possible CRTCs:

https://gitlab.freedesktop.org/mesa/drm/-/merge_requests/102

I'm afraid I don't know exactly what you expect to be documented here that is still missing. Could you please elaborate?

Thanks a lot!

The documentation you add is talking about "CRTC index". What defines a CRTC object's index? How do I determine what index a CRTC object has?

The answer is, AFAIK, that the index is never stored explicitly anywhere. You have to get the DRM resources structure, which has an array for CRTC IDs. The index is the index to that array, IIRC. So if one does not already know this, it is going to be really hard to figure out what the "index" is. It might even be confused with the object ID, which it is not but the ID might by complete accident be less than 32 so it would look ok at first glance.

Quoted 2 lines

If the index is already explained somewhere else, a reference to that documentation would be enough.

Quoted 9 lines

I think if we do this we should have a DOC: section in the drm_mode.h uapi header which explains how the index is computed, and then we reference that everywhere. Because otherwise there's going to be a _lot_ of duplication of this all over. Kernel-internally we solve this by just referencing drm_foo_index() family of functions, but for the uapi there's really nothing, so needs text.

-Daniel

Ok, I've sent a v3 with a small section to document how to get the index of a CRTC object from userspace perspective. But I could only find two comments that would benefit from it (at least in "Userland interfaces" page).

Thanks!
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel