Some drivers support hardware that have optimizations for solid fill
planes. This series aims to expose these capabilities to userspace as
some compositors have a solid fill flag (ex. SOLID_COLOR in the Android
hardware composer HAL) that can be set by apps like the Android Gears
app.
In order to expose this capability to userspace, this series will:
- Introduce solid_fill and pixel_source properties to allow userspace to
toggle between FB and solid fill sources
- Loosen NULL FB checks within the DRM atomic commit callstack to allow
for NULL FB when solid fill is enabled.
- Add NULL FB checks in methods where FB was previously assumed to be
non-NULL
- Have MSM DPU driver use drm_plane_state.solid_fill instead of
dpu_plane_state.color_fill
Note: The solid fill planes feature depends on both the solid_fill *and*
pixel_source properties.
To use this feature, userspace can set the solid_fill property to a blob
containing the appropriate version number and solid fill color (in
RGB323232 format) and and setting the pixel_source property to
DRM_PLANE_PIXEL_SOURCE_COLOR. This will disable memory fetch and the
resulting plane will display the color specified by the solid_fill blob.
Currently, there's only one version of the solid_fill blob property.
However if other drivers want to support a similar feature, but require
more than just the solid fill color, they can extend this feature by
creating additional versions of the drm_solid_fill struct.
This 2 property approach was chosen because passing in a special 1x1 FB
with the necessary color information would have unecessary overhead that
does not reflect the behavior of the solid fill feature. In addition,
assigning the solid fill blob to FB_ID would require loosening some core
drm_property checks that might cause unwanted side effects elsewhere.
---
Changes in v4:
- Rebased onto latest kernel
- Reworded cover letter for clarity (Dmitry)
- Reworded commit messages for clarity
- Split existing changes into smaller commits
- Added pixel_source enum property (Dmitry, Pekka, Ville)
- Updated drm-kms comment docs with pixel_source and solid_fill
properties (Dmitry)
- Inlined drm_atomic_convert_solid_fill_info() (Dmitry)
- Passed in plane state alpha value to _dpu_plane_color_fill_pipe()
- Link to v3: https://lore.kernel.org/r/[email protected]
Changes in v3:
- Fixed some logic errors in atomic checks (Dmitry)
- Introduced drm_plane_has_visible_data() and drm_atomic_check_fb() helper
methods (Dmitry)
- Fixed typo in drm_solid_fill struct documentation
- Created drm_plane_has_visible_data() helper and corrected CRTC and FB
NULL-check logic (Dmitry)
- Merged `if (fb)` blocks in drm_atomic_plane_check() and abstracted
them into helper method (Dmitry)
- Inverted `if (solid_fill_enabled) else if (fb)` check order (Dmitry)
- Fixed indentation (Dmitry)
Changes in v2:
- Dropped SOLID_FILL_FORMAT property (Simon)
- Switched to implementing solid_fill property as a blob (Simon, Dmitry)
- Added drm_solid_fill and drm_solid_fill_info structs (Simon)
- Changed to checks for if solid_fill_blob is set (Dmitry)
- Abstracted (plane_state && !solid_fill_blob) checks to helper method
(Dmitry)
- Removed DPU_PLANE_COLOR_FILL_FLAG
- Fixed whitespace and indentation issues (Dmitry)
- Changed to checks for if solid_fill_blob is set (Dmitry)
- Abstracted (plane_state && !solid_fill_blob) checks to helper method
(Dmitry)
- Fixed dropped 'const' warning
- Added helper to convert color fill to BGR888 (Rob)
- Fixed indentation issue (Dmitry)
- Added support for solid fill on planes of varying sizes
---
Jessica Zhang (7):
drm: Introduce solid fill DRM plane property
drm: Introduce pixel_source DRM plane property
drm/atomic: Move framebuffer checks to helper
drm/atomic: Loosen FB atomic checks
drm/msm/dpu: Add solid fill and pixel source properties
drm/msm/dpu: Allow NULL FBs in atomic commit
drm/msm/dpu: Use DRM solid_fill property
drivers/gpu/drm/drm_atomic.c | 142 +++++++++++++++++-------------
drivers/gpu/drm/drm_atomic_helper.c | 34 ++++---
drivers/gpu/drm/drm_atomic_state_helper.c | 10 +++
drivers/gpu/drm/drm_atomic_uapi.c | 59 +++++++++++++
drivers/gpu/drm/drm_blend.c | 114 ++++++++++++++++++++++++
drivers/gpu/drm/drm_plane.c | 8 +-
drivers/gpu/drm/msm/disp/dpu1/dpu_crtc.c | 9 +-
drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c | 68 +++++++++-----
include/drm/drm_atomic_helper.h | 4 +-
include/drm/drm_blend.h | 3 +
include/drm/drm_plane.h | 92 +++++++++++++++++++
11 files changed, 437 insertions(+), 106 deletions(-)
---
base-commit: a0364260213c96f6817f7e85cdce293cb743460f
change-id: 20230404-solid-fill-05016175db36
Best regards,
--
Jessica Zhang <[email protected]>
Document and add support for solid_fill property to drm_plane. In
addition, add support for setting and getting the values for solid_fill.
To enable solid fill planes, userspace must assign a property blob to
the "solid_fill" plane property containing the following information:
struct drm_solid_fill_info {
u8 version;
u32 r, g, b;
};
Signed-off-by: Jessica Zhang <[email protected]>
---
drivers/gpu/drm/drm_atomic_state_helper.c | 9 +++++
drivers/gpu/drm/drm_atomic_uapi.c | 55 +++++++++++++++++++++++++++++++
drivers/gpu/drm/drm_blend.c | 33 +++++++++++++++++++
include/drm/drm_blend.h | 1 +
include/drm/drm_plane.h | 43 ++++++++++++++++++++++++
5 files changed, 141 insertions(+)
diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c b/drivers/gpu/drm/drm_atomic_state_helper.c
index 784e63d70a42..fe14be2bd2b2 100644
--- a/drivers/gpu/drm/drm_atomic_state_helper.c
+++ b/drivers/gpu/drm/drm_atomic_state_helper.c
@@ -253,6 +253,11 @@ void __drm_atomic_helper_plane_state_reset(struct drm_plane_state *plane_state,
plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
+ if (plane_state->solid_fill_blob) {
+ drm_property_blob_put(plane_state->solid_fill_blob);
+ plane_state->solid_fill_blob = NULL;
+ }
+
if (plane->color_encoding_property) {
if (!drm_object_property_get_default_value(&plane->base,
plane->color_encoding_property,
@@ -335,6 +340,9 @@ void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
if (state->fb)
drm_framebuffer_get(state->fb);
+ if (state->solid_fill_blob)
+ drm_property_blob_get(state->solid_fill_blob);
+
state->fence = NULL;
state->commit = NULL;
state->fb_damage_clips = NULL;
@@ -384,6 +392,7 @@ void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state)
drm_crtc_commit_put(state->commit);
drm_property_blob_put(state->fb_damage_clips);
+ drm_property_blob_put(state->solid_fill_blob);
}
EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
diff --git a/drivers/gpu/drm/drm_atomic_uapi.c b/drivers/gpu/drm/drm_atomic_uapi.c
index d867e7f9f2cd..a28b4ee79444 100644
--- a/drivers/gpu/drm/drm_atomic_uapi.c
+++ b/drivers/gpu/drm/drm_atomic_uapi.c
@@ -316,6 +316,51 @@ drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
}
EXPORT_SYMBOL(drm_atomic_set_crtc_for_connector);
+static int drm_atomic_set_solid_fill_prop(struct drm_plane_state *state,
+ struct drm_property_blob *blob)
+{
+ int ret = 0;
+ int blob_version;
+
+ if (blob == state->solid_fill_blob)
+ return 0;
+
+ drm_property_blob_put(state->solid_fill_blob);
+ state->solid_fill_blob = NULL;
+
+ memset(&state->solid_fill, 0, sizeof(state->solid_fill));
+
+ if (blob) {
+ struct drm_solid_fill_info *user_info = (struct drm_solid_fill_info *)blob->data;
+
+ if (blob->length != sizeof(struct drm_solid_fill_info)) {
+ drm_dbg_atomic(state->plane->dev,
+ "[PLANE:%d:%s] bad solid fill blob length: %zu\n",
+ state->plane->base.id, state->plane->name,
+ blob->length);
+ return -EINVAL;
+ }
+
+ blob_version = user_info->version;
+
+ /* Add more versions if necessary */
+ if (blob_version == 1) {
+ state->solid_fill.r = user_info->r;
+ state->solid_fill.g = user_info->g;
+ state->solid_fill.b = user_info->b;
+ } else {
+ drm_dbg_atomic(state->plane->dev,
+ "[PLANE:%d:%s] failed to set solid fill (ret=%d)\n",
+ state->plane->base.id, state->plane->name,
+ ret);
+ return -EINVAL;
+ }
+ state->solid_fill_blob = drm_property_blob_get(blob);
+ }
+
+ return ret;
+}
+
static void set_out_fence_for_crtc(struct drm_atomic_state *state,
struct drm_crtc *crtc, s32 __user *fence_ptr)
{
@@ -544,6 +589,13 @@ static int drm_atomic_plane_set_property(struct drm_plane *plane,
state->src_w = val;
} else if (property == config->prop_src_h) {
state->src_h = val;
+ } else if (property == plane->solid_fill_property) {
+ struct drm_property_blob *solid_fill = drm_property_lookup_blob(dev, val);
+
+ ret = drm_atomic_set_solid_fill_prop(state, solid_fill);
+ drm_property_blob_put(solid_fill);
+
+ return ret;
} else if (property == plane->alpha_property) {
state->alpha = val;
} else if (property == plane->blend_mode_property) {
@@ -616,6 +668,9 @@ drm_atomic_plane_get_property(struct drm_plane *plane,
*val = state->src_w;
} else if (property == config->prop_src_h) {
*val = state->src_h;
+ } else if (property == plane->solid_fill_property) {
+ *val = state->solid_fill_blob ?
+ state->solid_fill_blob->base.id : 0;
} else if (property == plane->alpha_property) {
*val = state->alpha;
} else if (property == plane->blend_mode_property) {
diff --git a/drivers/gpu/drm/drm_blend.c b/drivers/gpu/drm/drm_blend.c
index 6e74de833466..38c3c5d6453a 100644
--- a/drivers/gpu/drm/drm_blend.c
+++ b/drivers/gpu/drm/drm_blend.c
@@ -185,6 +185,10 @@
* plane does not expose the "alpha" property, then this is
* assumed to be 1.0
*
+ * solid_fill:
+ * solid_fill is set up with drm_plane_create_solid_fill_property(). It
+ * contains pixel data that drivers can use to fill a plane.
+ *
* Note that all the property extensions described here apply either to the
* plane or the CRTC (e.g. for the background color, which currently is not
* exposed and assumed to be black).
@@ -615,3 +619,32 @@ int drm_plane_create_blend_mode_property(struct drm_plane *plane,
return 0;
}
EXPORT_SYMBOL(drm_plane_create_blend_mode_property);
+
+/**
+ * drm_plane_create_solid_fill_property - create a new solid_fill property
+ * @plane: drm plane
+ *
+ * This creates a new property that holds pixel data for solid fill planes. This
+ * property is exposed to userspace as a property blob called "solid_fill".
+ *
+ * For information on what the blob contains, see `drm_solid_fill_info`.
+ *
+ * Returns:
+ * Zero on success, negative errno on failure.
+ */
+int drm_plane_create_solid_fill_property(struct drm_plane *plane)
+{
+ struct drm_property *prop;
+
+ prop = drm_property_create(plane->dev,
+ DRM_MODE_PROP_ATOMIC | DRM_MODE_PROP_BLOB,
+ "solid_fill", 0);
+ if (!prop)
+ return -ENOMEM;
+
+ drm_object_attach_property(&plane->base, prop, 0);
+ plane->solid_fill_property = prop;
+
+ return 0;
+}
+EXPORT_SYMBOL(drm_plane_create_solid_fill_property);
diff --git a/include/drm/drm_blend.h b/include/drm/drm_blend.h
index 88bdfec3bd88..0338a860b9c8 100644
--- a/include/drm/drm_blend.h
+++ b/include/drm/drm_blend.h
@@ -58,4 +58,5 @@ int drm_atomic_normalize_zpos(struct drm_device *dev,
struct drm_atomic_state *state);
int drm_plane_create_blend_mode_property(struct drm_plane *plane,
unsigned int supported_modes);
+int drm_plane_create_solid_fill_property(struct drm_plane *plane);
#endif
diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
index 51291983ea44..f6ab313cb83e 100644
--- a/include/drm/drm_plane.h
+++ b/include/drm/drm_plane.h
@@ -40,6 +40,25 @@ enum drm_scaling_filter {
DRM_SCALING_FILTER_NEAREST_NEIGHBOR,
};
+/**
+ * struct drm_solid_fill_info - User info for solid fill planes
+ */
+struct drm_solid_fill_info {
+ __u8 version;
+ __u32 r, g, b;
+};
+
+/**
+ * struct solid_fill_property - RGB values for solid fill plane
+ *
+ * Note: This is the V1 for this feature
+ */
+struct drm_solid_fill {
+ uint32_t r;
+ uint32_t g;
+ uint32_t b;
+};
+
/**
* struct drm_plane_state - mutable plane state
*
@@ -116,6 +135,23 @@ struct drm_plane_state {
/** @src_h: height of visible portion of plane (in 16.16) */
uint32_t src_h, src_w;
+ /**
+ * @solid_fill_blob:
+ *
+ * Blob containing relevant information for a solid fill plane
+ * including pixel format and data. See
+ * drm_plane_create_solid_fill_property() for more details.
+ */
+ struct drm_property_blob *solid_fill_blob;
+
+ /**
+ * @solid_fill:
+ *
+ * Pixel data for solid fill planes. See
+ * drm_plane_create_solid_fill_property() for more details.
+ */
+ struct drm_solid_fill solid_fill;
+
/**
* @alpha:
* Opacity of the plane with 0 as completely transparent and 0xffff as
@@ -699,6 +735,13 @@ struct drm_plane {
*/
struct drm_plane_state *state;
+ /*
+ * @solid_fill_property:
+ * Optional solid_fill property for this plane. See
+ * drm_plane_create_solid_fill_property().
+ */
+ struct drm_property *solid_fill_property;
+
/**
* @alpha_property:
* Optional alpha property for this plane. See
--
2.41.0
Add solid_fill and pixel_source properties to DPU plane
Signed-off-by: Jessica Zhang <[email protected]>
---
drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c | 2 ++
1 file changed, 2 insertions(+)
diff --git a/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c b/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c
index c2aaaded07ed..5f0984ce62b1 100644
--- a/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c
+++ b/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c
@@ -1429,6 +1429,8 @@ struct drm_plane *dpu_plane_init(struct drm_device *dev,
DPU_ERROR("failed to install zpos property, rc = %d\n", ret);
drm_plane_create_alpha_property(plane);
+ drm_plane_create_solid_fill_property(plane);
+ drm_plane_create_pixel_source_property(plane, BIT(DRM_PLANE_PIXEL_SOURCE_COLOR));
drm_plane_create_blend_mode_property(plane,
BIT(DRM_MODE_BLEND_PIXEL_NONE) |
BIT(DRM_MODE_BLEND_PREMULTI) |
--
2.41.0
Add support for pixel_source property to drm_plane and related
documentation.
This enum property will allow user to specify a pixel source for the
plane. Possible pixel sources will be defined in the
drm_plane_pixel_source enum.
The current possible pixel sources are DRM_PLANE_PIXEL_SOURCE_FB and
DRM_PLANE_PIXEL_SOURCE_COLOR. The default value is *_SOURCE_FB.
Signed-off-by: Jessica Zhang <[email protected]>
---
drivers/gpu/drm/drm_atomic_state_helper.c | 1 +
drivers/gpu/drm/drm_atomic_uapi.c | 4 ++
drivers/gpu/drm/drm_blend.c | 81 +++++++++++++++++++++++++++++++
include/drm/drm_blend.h | 2 +
include/drm/drm_plane.h | 21 ++++++++
5 files changed, 109 insertions(+)
diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c b/drivers/gpu/drm/drm_atomic_state_helper.c
index fe14be2bd2b2..86fb876efbe6 100644
--- a/drivers/gpu/drm/drm_atomic_state_helper.c
+++ b/drivers/gpu/drm/drm_atomic_state_helper.c
@@ -252,6 +252,7 @@ void __drm_atomic_helper_plane_state_reset(struct drm_plane_state *plane_state,
plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
+ plane_state->pixel_source = DRM_PLANE_PIXEL_SOURCE_FB;
if (plane_state->solid_fill_blob) {
drm_property_blob_put(plane_state->solid_fill_blob);
diff --git a/drivers/gpu/drm/drm_atomic_uapi.c b/drivers/gpu/drm/drm_atomic_uapi.c
index a28b4ee79444..6e59c21af66b 100644
--- a/drivers/gpu/drm/drm_atomic_uapi.c
+++ b/drivers/gpu/drm/drm_atomic_uapi.c
@@ -596,6 +596,8 @@ static int drm_atomic_plane_set_property(struct drm_plane *plane,
drm_property_blob_put(solid_fill);
return ret;
+ } else if (property == plane->pixel_source_property) {
+ state->pixel_source = val;
} else if (property == plane->alpha_property) {
state->alpha = val;
} else if (property == plane->blend_mode_property) {
@@ -671,6 +673,8 @@ drm_atomic_plane_get_property(struct drm_plane *plane,
} else if (property == plane->solid_fill_property) {
*val = state->solid_fill_blob ?
state->solid_fill_blob->base.id : 0;
+ } else if (property == plane->pixel_source_property) {
+ *val = state->pixel_source;
} else if (property == plane->alpha_property) {
*val = state->alpha;
} else if (property == plane->blend_mode_property) {
diff --git a/drivers/gpu/drm/drm_blend.c b/drivers/gpu/drm/drm_blend.c
index 38c3c5d6453a..8c100a957ee2 100644
--- a/drivers/gpu/drm/drm_blend.c
+++ b/drivers/gpu/drm/drm_blend.c
@@ -189,6 +189,18 @@
* solid_fill is set up with drm_plane_create_solid_fill_property(). It
* contains pixel data that drivers can use to fill a plane.
*
+ * pixel_source:
+ * pixel_source is set up with drm_plane_create_pixel_source_property().
+ * It is used to toggle the source of pixel data for the plane.
+ *
+ * Possible values:
+ *
+ * "FB":
+ * Framebuffer source
+ *
+ * "COLOR":
+ * solid_fill source
+ *
* Note that all the property extensions described here apply either to the
* plane or the CRTC (e.g. for the background color, which currently is not
* exposed and assumed to be black).
@@ -648,3 +660,72 @@ int drm_plane_create_solid_fill_property(struct drm_plane *plane)
return 0;
}
EXPORT_SYMBOL(drm_plane_create_solid_fill_property);
+
+/**
+ * drm_plane_create_pixel_source_property - create a new pixel source property
+ * @plane: drm plane
+ * @supported_sources: bitmask of supported pixel_sources for the driver (NOT
+ * including DRM_PLANE_PIXEL_SOURCE_FB, as it will be supported
+ * by default).
+ *
+ * This creates a new property describing the current source of pixel data for the
+ * plane.
+ *
+ * The property is exposed to userspace as an enumeration property called
+ * "pixel_source" and has the following enumeration values:
+ *
+ * "FB":
+ * Framebuffer pixel source
+ *
+ * "COLOR":
+ * Solid fill color pixel source
+ *
+ * Returns:
+ * Zero on success, negative errno on failure.
+ */
+int drm_plane_create_pixel_source_property(struct drm_plane *plane,
+ unsigned int supported_sources)
+{
+ struct drm_device *dev = plane->dev;
+ struct drm_property *prop;
+ const struct drm_prop_enum_list enum_list[] = {
+ { DRM_PLANE_PIXEL_SOURCE_FB, "FB" },
+ { DRM_PLANE_PIXEL_SOURCE_COLOR, "COLOR" },
+ };
+ unsigned int valid_source_mask = BIT(DRM_PLANE_PIXEL_SOURCE_FB) |
+ BIT(DRM_PLANE_PIXEL_SOURCE_COLOR);
+ int i;
+
+ /* FB is supported by default */
+ supported_sources |= BIT(DRM_PLANE_PIXEL_SOURCE_FB);
+
+ if (WARN_ON(supported_sources & ~valid_source_mask))
+ return -EINVAL;
+
+ prop = drm_property_create(dev, DRM_MODE_PROP_ENUM, "pixel_source",
+ hweight32(supported_sources));
+
+ if (!prop)
+ return -ENOMEM;
+
+ for (i = 0; i < ARRAY_SIZE(enum_list); i++) {
+ int ret;
+
+ if (!(BIT(enum_list[i].type) & supported_sources))
+ continue;
+
+ ret = drm_property_add_enum(prop, enum_list[i].type, enum_list[i].name);
+
+ if (ret) {
+ drm_property_destroy(dev, prop);
+
+ return ret;
+ }
+ }
+
+ drm_object_attach_property(&plane->base, prop, DRM_PLANE_PIXEL_SOURCE_FB);
+ plane->pixel_source_property = prop;
+
+ return 0;
+}
+EXPORT_SYMBOL(drm_plane_create_pixel_source_property);
diff --git a/include/drm/drm_blend.h b/include/drm/drm_blend.h
index 0338a860b9c8..31af7cfa5b1b 100644
--- a/include/drm/drm_blend.h
+++ b/include/drm/drm_blend.h
@@ -59,4 +59,6 @@ int drm_atomic_normalize_zpos(struct drm_device *dev,
int drm_plane_create_blend_mode_property(struct drm_plane *plane,
unsigned int supported_modes);
int drm_plane_create_solid_fill_property(struct drm_plane *plane);
+int drm_plane_create_pixel_source_property(struct drm_plane *plane,
+ unsigned int supported_sources);
#endif
diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
index f6ab313cb83e..73fb6cf8a5d9 100644
--- a/include/drm/drm_plane.h
+++ b/include/drm/drm_plane.h
@@ -59,6 +59,12 @@ struct drm_solid_fill {
uint32_t b;
};
+enum drm_plane_pixel_source {
+ DRM_PLANE_PIXEL_SOURCE_FB,
+ DRM_PLANE_PIXEL_SOURCE_COLOR,
+ DRM_PLANE_PIXEL_SOURCE_MAX
+};
+
/**
* struct drm_plane_state - mutable plane state
*
@@ -152,6 +158,14 @@ struct drm_plane_state {
*/
struct drm_solid_fill solid_fill;
+ /*
+ * @pixel_source:
+ *
+ * Source of pixel information for the plane. See
+ * drm_plane_create_pixel_source_property() for more details.
+ */
+ enum drm_plane_pixel_source pixel_source;
+
/**
* @alpha:
* Opacity of the plane with 0 as completely transparent and 0xffff as
@@ -742,6 +756,13 @@ struct drm_plane {
*/
struct drm_property *solid_fill_property;
+ /*
+ * @pixel_source_property:
+ * Optional pixel_source property for this plane. See
+ * drm_plane_create_pixel_source_property().
+ */
+ struct drm_property *pixel_source_property;
+
/**
* @alpha_property:
* Optional alpha property for this plane. See
--
2.41.0
On 30/06/2023 03:25, Jessica Zhang wrote:
> Add support for pixel_source property to drm_plane and related
> documentation.
>
> This enum property will allow user to specify a pixel source for the
> plane. Possible pixel sources will be defined in the
> drm_plane_pixel_source enum.
>
> The current possible pixel sources are DRM_PLANE_PIXEL_SOURCE_FB and
> DRM_PLANE_PIXEL_SOURCE_COLOR. The default value is *_SOURCE_FB.
I think, this should come before the solid fill property addition. First
you tell that there is a possibility to define other pixel sources, then
additional sources are defined.
>
> Signed-off-by: Jessica Zhang <[email protected]>
> ---
> drivers/gpu/drm/drm_atomic_state_helper.c | 1 +
> drivers/gpu/drm/drm_atomic_uapi.c | 4 ++
> drivers/gpu/drm/drm_blend.c | 81 +++++++++++++++++++++++++++++++
> include/drm/drm_blend.h | 2 +
> include/drm/drm_plane.h | 21 ++++++++
> 5 files changed, 109 insertions(+)
>
> diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c b/drivers/gpu/drm/drm_atomic_state_helper.c
> index fe14be2bd2b2..86fb876efbe6 100644
> --- a/drivers/gpu/drm/drm_atomic_state_helper.c
> +++ b/drivers/gpu/drm/drm_atomic_state_helper.c
> @@ -252,6 +252,7 @@ void __drm_atomic_helper_plane_state_reset(struct drm_plane_state *plane_state,
>
> plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
> plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
> + plane_state->pixel_source = DRM_PLANE_PIXEL_SOURCE_FB;
>
> if (plane_state->solid_fill_blob) {
> drm_property_blob_put(plane_state->solid_fill_blob);
> diff --git a/drivers/gpu/drm/drm_atomic_uapi.c b/drivers/gpu/drm/drm_atomic_uapi.c
> index a28b4ee79444..6e59c21af66b 100644
> --- a/drivers/gpu/drm/drm_atomic_uapi.c
> +++ b/drivers/gpu/drm/drm_atomic_uapi.c
> @@ -596,6 +596,8 @@ static int drm_atomic_plane_set_property(struct drm_plane *plane,
> drm_property_blob_put(solid_fill);
>
> return ret;
> + } else if (property == plane->pixel_source_property) {
> + state->pixel_source = val;
> } else if (property == plane->alpha_property) {
> state->alpha = val;
> } else if (property == plane->blend_mode_property) {
I think, it was pointed out in the discussion that drm_mode_setplane()
(a pre-atomic IOCTL to turn the plane on and off) should also reset
pixel_source to FB.
> @@ -671,6 +673,8 @@ drm_atomic_plane_get_property(struct drm_plane *plane,
> } else if (property == plane->solid_fill_property) {
> *val = state->solid_fill_blob ?
> state->solid_fill_blob->base.id : 0;
> + } else if (property == plane->pixel_source_property) {
> + *val = state->pixel_source;
> } else if (property == plane->alpha_property) {
> *val = state->alpha;
> } else if (property == plane->blend_mode_property) {
> diff --git a/drivers/gpu/drm/drm_blend.c b/drivers/gpu/drm/drm_blend.c
> index 38c3c5d6453a..8c100a957ee2 100644
> --- a/drivers/gpu/drm/drm_blend.c
> +++ b/drivers/gpu/drm/drm_blend.c
> @@ -189,6 +189,18 @@
> * solid_fill is set up with drm_plane_create_solid_fill_property(). It
> * contains pixel data that drivers can use to fill a plane.
> *
> + * pixel_source:
> + * pixel_source is set up with drm_plane_create_pixel_source_property().
> + * It is used to toggle the source of pixel data for the plane.
> + *
> + * Possible values:
> + *
> + * "FB":
> + * Framebuffer source
> + *
> + * "COLOR":
> + * solid_fill source
> + *
> * Note that all the property extensions described here apply either to the
> * plane or the CRTC (e.g. for the background color, which currently is not
> * exposed and assumed to be black).
> @@ -648,3 +660,72 @@ int drm_plane_create_solid_fill_property(struct drm_plane *plane)
> return 0;
> }
> EXPORT_SYMBOL(drm_plane_create_solid_fill_property);
> +
> +/**
> + * drm_plane_create_pixel_source_property - create a new pixel source property
> + * @plane: drm plane
> + * @supported_sources: bitmask of supported pixel_sources for the driver (NOT
> + * including DRM_PLANE_PIXEL_SOURCE_FB, as it will be supported
> + * by default).
I'd say this is too strong. I'd suggest either renaming this to
extra_sources (mentioning that FB is enabled for all the planes) or
allowing any source bitmask (mentioning that FB should be enabled by the
caller, unless there is a good reason not to do so).
> + *
> + * This creates a new property describing the current source of pixel data for the
> + * plane.
> + *
> + * The property is exposed to userspace as an enumeration property called
> + * "pixel_source" and has the following enumeration values:
> + *
> + * "FB":
> + * Framebuffer pixel source
> + *
> + * "COLOR":
> + * Solid fill color pixel source
> + *
> + * Returns:
> + * Zero on success, negative errno on failure.
> + */
> +int drm_plane_create_pixel_source_property(struct drm_plane *plane,
> + unsigned int supported_sources)
> +{
> + struct drm_device *dev = plane->dev;
> + struct drm_property *prop;
> + const struct drm_prop_enum_list enum_list[] = {
> + { DRM_PLANE_PIXEL_SOURCE_FB, "FB" },
> + { DRM_PLANE_PIXEL_SOURCE_COLOR, "COLOR" },
> + };
> + unsigned int valid_source_mask = BIT(DRM_PLANE_PIXEL_SOURCE_FB) |
> + BIT(DRM_PLANE_PIXEL_SOURCE_COLOR);
static const?
> + int i;
> +
> + /* FB is supported by default */
> + supported_sources |= BIT(DRM_PLANE_PIXEL_SOURCE_FB);
> +
> + if (WARN_ON(supported_sources & ~valid_source_mask))
> + return -EINVAL;
> +
> + prop = drm_property_create(dev, DRM_MODE_PROP_ENUM, "pixel_source",
> + hweight32(supported_sources));
> +
> + if (!prop)
> + return -ENOMEM;
> +
> + for (i = 0; i < ARRAY_SIZE(enum_list); i++) {
> + int ret;
> +
> + if (!(BIT(enum_list[i].type) & supported_sources))
test_bit?
> + continue;
> +
> + ret = drm_property_add_enum(prop, enum_list[i].type, enum_list[i].name);
> +
No need for an empty line in such cases. Please drop it.
> + if (ret) {
> + drm_property_destroy(dev, prop);
> +
> + return ret;
> + }
> + }
> +
> + drm_object_attach_property(&plane->base, prop, DRM_PLANE_PIXEL_SOURCE_FB);
> + plane->pixel_source_property = prop;
> +
> + return 0;
> +}
> +EXPORT_SYMBOL(drm_plane_create_pixel_source_property);
> diff --git a/include/drm/drm_blend.h b/include/drm/drm_blend.h
> index 0338a860b9c8..31af7cfa5b1b 100644
> --- a/include/drm/drm_blend.h
> +++ b/include/drm/drm_blend.h
> @@ -59,4 +59,6 @@ int drm_atomic_normalize_zpos(struct drm_device *dev,
> int drm_plane_create_blend_mode_property(struct drm_plane *plane,
> unsigned int supported_modes);
> int drm_plane_create_solid_fill_property(struct drm_plane *plane);
> +int drm_plane_create_pixel_source_property(struct drm_plane *plane,
> + unsigned int supported_sources);
> #endif
> diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
> index f6ab313cb83e..73fb6cf8a5d9 100644
> --- a/include/drm/drm_plane.h
> +++ b/include/drm/drm_plane.h
> @@ -59,6 +59,12 @@ struct drm_solid_fill {
> uint32_t b;
> };
>
> +enum drm_plane_pixel_source {
> + DRM_PLANE_PIXEL_SOURCE_FB,
> + DRM_PLANE_PIXEL_SOURCE_COLOR,
> + DRM_PLANE_PIXEL_SOURCE_MAX
> +};
> +
> /**
> * struct drm_plane_state - mutable plane state
> *
> @@ -152,6 +158,14 @@ struct drm_plane_state {
> */
> struct drm_solid_fill solid_fill;
>
> + /*
> + * @pixel_source:
> + *
> + * Source of pixel information for the plane. See
> + * drm_plane_create_pixel_source_property() for more details.
> + */
> + enum drm_plane_pixel_source pixel_source;
> +
> /**
> * @alpha:
> * Opacity of the plane with 0 as completely transparent and 0xffff as
> @@ -742,6 +756,13 @@ struct drm_plane {
> */
> struct drm_property *solid_fill_property;
>
> + /*
> + * @pixel_source_property:
> + * Optional pixel_source property for this plane. See
> + * drm_plane_create_pixel_source_property().
> + */
> + struct drm_property *pixel_source_property;
> +
> /**
> * @alpha_property:
> * Optional alpha property for this plane. See
>
--
With best wishes
Dmitry
On 30/06/2023 03:25, Jessica Zhang wrote:
> Add solid_fill and pixel_source properties to DPU plane
>
> Signed-off-by: Jessica Zhang <[email protected]>
> ---
> drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c | 2 ++
> 1 file changed, 2 insertions(+)
This should be the last commit.
Otherwise:
Reviewed-by: Dmitry Baryshkov <[email protected]>
>
> diff --git a/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c b/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c
> index c2aaaded07ed..5f0984ce62b1 100644
> --- a/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c
> +++ b/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c
> @@ -1429,6 +1429,8 @@ struct drm_plane *dpu_plane_init(struct drm_device *dev,
> DPU_ERROR("failed to install zpos property, rc = %d\n", ret);
>
> drm_plane_create_alpha_property(plane);
> + drm_plane_create_solid_fill_property(plane);
> + drm_plane_create_pixel_source_property(plane, BIT(DRM_PLANE_PIXEL_SOURCE_COLOR));
> drm_plane_create_blend_mode_property(plane,
> BIT(DRM_MODE_BLEND_PIXEL_NONE) |
> BIT(DRM_MODE_BLEND_PREMULTI) |
>
--
With best wishes
Dmitry
On Fri, 30 Jun 2023 03:42:28 +0300
Dmitry Baryshkov <[email protected]> wrote:
> On 30/06/2023 03:25, Jessica Zhang wrote:
> > Add support for pixel_source property to drm_plane and related
> > documentation.
> >
> > This enum property will allow user to specify a pixel source for the
> > plane. Possible pixel sources will be defined in the
> > drm_plane_pixel_source enum.
> >
> > The current possible pixel sources are DRM_PLANE_PIXEL_SOURCE_FB and
> > DRM_PLANE_PIXEL_SOURCE_COLOR. The default value is *_SOURCE_FB.
>
> I think, this should come before the solid fill property addition. First
> you tell that there is a possibility to define other pixel sources, then
> additional sources are defined.
Hi,
that would be logical indeed.
> >
> > Signed-off-by: Jessica Zhang <[email protected]>
> > ---
> > drivers/gpu/drm/drm_atomic_state_helper.c | 1 +
> > drivers/gpu/drm/drm_atomic_uapi.c | 4 ++
> > drivers/gpu/drm/drm_blend.c | 81 +++++++++++++++++++++++++++++++
> > include/drm/drm_blend.h | 2 +
> > include/drm/drm_plane.h | 21 ++++++++
> > 5 files changed, 109 insertions(+)
> >
> > diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c b/drivers/gpu/drm/drm_atomic_state_helper.c
> > index fe14be2bd2b2..86fb876efbe6 100644
> > --- a/drivers/gpu/drm/drm_atomic_state_helper.c
> > +++ b/drivers/gpu/drm/drm_atomic_state_helper.c
> > @@ -252,6 +252,7 @@ void __drm_atomic_helper_plane_state_reset(struct drm_plane_state *plane_state,
> >
> > plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
> > plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
> > + plane_state->pixel_source = DRM_PLANE_PIXEL_SOURCE_FB;
> >
> > if (plane_state->solid_fill_blob) {
> > drm_property_blob_put(plane_state->solid_fill_blob);
> > diff --git a/drivers/gpu/drm/drm_atomic_uapi.c b/drivers/gpu/drm/drm_atomic_uapi.c
> > index a28b4ee79444..6e59c21af66b 100644
> > --- a/drivers/gpu/drm/drm_atomic_uapi.c
> > +++ b/drivers/gpu/drm/drm_atomic_uapi.c
> > @@ -596,6 +596,8 @@ static int drm_atomic_plane_set_property(struct drm_plane *plane,
> > drm_property_blob_put(solid_fill);
> >
> > return ret;
> > + } else if (property == plane->pixel_source_property) {
> > + state->pixel_source = val;
> > } else if (property == plane->alpha_property) {
> > state->alpha = val;
> > } else if (property == plane->blend_mode_property) {
>
> I think, it was pointed out in the discussion that drm_mode_setplane()
> (a pre-atomic IOCTL to turn the plane on and off) should also reset
> pixel_source to FB.
>
> > @@ -671,6 +673,8 @@ drm_atomic_plane_get_property(struct drm_plane *plane,
> > } else if (property == plane->solid_fill_property) {
> > *val = state->solid_fill_blob ?
> > state->solid_fill_blob->base.id : 0;
> > + } else if (property == plane->pixel_source_property) {
> > + *val = state->pixel_source;
> > } else if (property == plane->alpha_property) {
> > *val = state->alpha;
> > } else if (property == plane->blend_mode_property) {
> > diff --git a/drivers/gpu/drm/drm_blend.c b/drivers/gpu/drm/drm_blend.c
> > index 38c3c5d6453a..8c100a957ee2 100644
> > --- a/drivers/gpu/drm/drm_blend.c
> > +++ b/drivers/gpu/drm/drm_blend.c
> > @@ -189,6 +189,18 @@
> > * solid_fill is set up with drm_plane_create_solid_fill_property(). It
> > * contains pixel data that drivers can use to fill a plane.
> > *
> > + * pixel_source:
> > + * pixel_source is set up with drm_plane_create_pixel_source_property().
> > + * It is used to toggle the source of pixel data for the plane.
Other sources than the selected one are ignored?
> > + *
> > + * Possible values:
Wouldn't hurt to explicitly mention here that this is an enum.
> > + *
> > + * "FB":
> > + * Framebuffer source
> > + *
> > + * "COLOR":
> > + * solid_fill source
I think these two should be more explicit. Framebuffer source is the
usual source from the property "FB_ID". Solid fill source comes from
the property "solid_fill".
Why "COLOR" and not, say, "SOLID_FILL"?
> > + *
> > * Note that all the property extensions described here apply either to the
> > * plane or the CRTC (e.g. for the background color, which currently is not
> > * exposed and assumed to be black).
> > @@ -648,3 +660,72 @@ int drm_plane_create_solid_fill_property(struct drm_plane *plane)
> > return 0;
> > }
> > EXPORT_SYMBOL(drm_plane_create_solid_fill_property);
> > +
> > +/**
> > + * drm_plane_create_pixel_source_property - create a new pixel source property
> > + * @plane: drm plane
> > + * @supported_sources: bitmask of supported pixel_sources for the driver (NOT
> > + * including DRM_PLANE_PIXEL_SOURCE_FB, as it will be supported
> > + * by default).
>
> I'd say this is too strong. I'd suggest either renaming this to
> extra_sources (mentioning that FB is enabled for all the planes) or
> allowing any source bitmask (mentioning that FB should be enabled by the
> caller, unless there is a good reason not to do so).
Right. I don't see any problem with having planes of type OVERLAY that
support only solid_fill and no FB. Planes of type PRIMARY and CURSOR I
would expect to always support at least FB.
Atomic userspace is prepared to have an OVERLAY plane fail for any
arbitrary reason. Legacy userspace probably should not ever see a plane
that does not support FB.
> > + *
> > + * This creates a new property describing the current source of pixel data for the
> > + * plane.
> > + *
> > + * The property is exposed to userspace as an enumeration property called
> > + * "pixel_source" and has the following enumeration values:
> > + *
> > + * "FB":
> > + * Framebuffer pixel source
> > + *
> > + * "COLOR":
> > + * Solid fill color pixel source
> > + *
> > + * Returns:
> > + * Zero on success, negative errno on failure.
> > + */
> > +int drm_plane_create_pixel_source_property(struct drm_plane *plane,
> > + unsigned int supported_sources)
> > +{
> > + struct drm_device *dev = plane->dev;
> > + struct drm_property *prop;
> > + const struct drm_prop_enum_list enum_list[] = {
> > + { DRM_PLANE_PIXEL_SOURCE_FB, "FB" },
> > + { DRM_PLANE_PIXEL_SOURCE_COLOR, "COLOR" },
> > + };
> > + unsigned int valid_source_mask = BIT(DRM_PLANE_PIXEL_SOURCE_FB) |
> > + BIT(DRM_PLANE_PIXEL_SOURCE_COLOR);
>
>
> static const?
>
> > + int i;
> > +
> > + /* FB is supported by default */
> > + supported_sources |= BIT(DRM_PLANE_PIXEL_SOURCE_FB);
> > +
> > + if (WARN_ON(supported_sources & ~valid_source_mask))
> > + return -EINVAL;
> > +
> > + prop = drm_property_create(dev, DRM_MODE_PROP_ENUM, "pixel_source",
Shouldn't this be an atomic prop?
> > + hweight32(supported_sources));
> > +
> > + if (!prop)
> > + return -ENOMEM;
> > +
> > + for (i = 0; i < ARRAY_SIZE(enum_list); i++) {
> > + int ret;
> > +
> > + if (!(BIT(enum_list[i].type) & supported_sources))
>
> test_bit?
>
> > + continue;
> > +
> > + ret = drm_property_add_enum(prop, enum_list[i].type, enum_list[i].name);
> > +
>
> No need for an empty line in such cases. Please drop it.
>
> > + if (ret) {
> > + drm_property_destroy(dev, prop);
> > +
> > + return ret;
> > + }
> > + }
> > +
> > + drm_object_attach_property(&plane->base, prop, DRM_PLANE_PIXEL_SOURCE_FB);
> > + plane->pixel_source_property = prop;
> > +
> > + return 0;
> > +}
> > +EXPORT_SYMBOL(drm_plane_create_pixel_source_property);
> > diff --git a/include/drm/drm_blend.h b/include/drm/drm_blend.h
> > index 0338a860b9c8..31af7cfa5b1b 100644
> > --- a/include/drm/drm_blend.h
> > +++ b/include/drm/drm_blend.h
> > @@ -59,4 +59,6 @@ int drm_atomic_normalize_zpos(struct drm_device *dev,
> > int drm_plane_create_blend_mode_property(struct drm_plane *plane,
> > unsigned int supported_modes);
> > int drm_plane_create_solid_fill_property(struct drm_plane *plane);
> > +int drm_plane_create_pixel_source_property(struct drm_plane *plane,
> > + unsigned int supported_sources);
> > #endif
> > diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
> > index f6ab313cb83e..73fb6cf8a5d9 100644
> > --- a/include/drm/drm_plane.h
> > +++ b/include/drm/drm_plane.h
> > @@ -59,6 +59,12 @@ struct drm_solid_fill {
> > uint32_t b;
> > };
> >
> > +enum drm_plane_pixel_source {
> > + DRM_PLANE_PIXEL_SOURCE_FB,
> > + DRM_PLANE_PIXEL_SOURCE_COLOR,
> > + DRM_PLANE_PIXEL_SOURCE_MAX
> > +};
Just to be very clear that I'm not confusing you with my comment about
UAPI headers in the previous patch, this enum is already in a good
place. It does not belong in a UAPI header, because userspace
recognises enum values by the name string.
Thanks,
pq
> > +
> > /**
> > * struct drm_plane_state - mutable plane state
> > *
> > @@ -152,6 +158,14 @@ struct drm_plane_state {
> > */
> > struct drm_solid_fill solid_fill;
> >
> > + /*
> > + * @pixel_source:
> > + *
> > + * Source of pixel information for the plane. See
> > + * drm_plane_create_pixel_source_property() for more details.
> > + */
> > + enum drm_plane_pixel_source pixel_source;
> > +
> > /**
> > * @alpha:
> > * Opacity of the plane with 0 as completely transparent and 0xffff as
> > @@ -742,6 +756,13 @@ struct drm_plane {
> > */
> > struct drm_property *solid_fill_property;
> >
> > + /*
> > + * @pixel_source_property:
> > + * Optional pixel_source property for this plane. See
> > + * drm_plane_create_pixel_source_property().
> > + */
> > + struct drm_property *pixel_source_property;
> > +
> > /**
> > * @alpha_property:
> > * Optional alpha property for this plane. See
> >
>
On Thu, 29 Jun 2023 17:25:00 -0700
Jessica Zhang <[email protected]> wrote:
> Document and add support for solid_fill property to drm_plane. In
> addition, add support for setting and getting the values for solid_fill.
>
> To enable solid fill planes, userspace must assign a property blob to
> the "solid_fill" plane property containing the following information:
>
> struct drm_solid_fill_info {
> u8 version;
> u32 r, g, b;
> };
>
> Signed-off-by: Jessica Zhang <[email protected]>
Hi Jessica,
I've left some general UAPI related comments here.
> ---
> drivers/gpu/drm/drm_atomic_state_helper.c | 9 +++++
> drivers/gpu/drm/drm_atomic_uapi.c | 55 +++++++++++++++++++++++++++++++
> drivers/gpu/drm/drm_blend.c | 33 +++++++++++++++++++
> include/drm/drm_blend.h | 1 +
> include/drm/drm_plane.h | 43 ++++++++++++++++++++++++
> 5 files changed, 141 insertions(+)
>
> diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c b/drivers/gpu/drm/drm_atomic_state_helper.c
> index 784e63d70a42..fe14be2bd2b2 100644
> --- a/drivers/gpu/drm/drm_atomic_state_helper.c
> +++ b/drivers/gpu/drm/drm_atomic_state_helper.c
> @@ -253,6 +253,11 @@ void __drm_atomic_helper_plane_state_reset(struct drm_plane_state *plane_state,
> plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
> plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
>
> + if (plane_state->solid_fill_blob) {
> + drm_property_blob_put(plane_state->solid_fill_blob);
> + plane_state->solid_fill_blob = NULL;
> + }
> +
> if (plane->color_encoding_property) {
> if (!drm_object_property_get_default_value(&plane->base,
> plane->color_encoding_property,
> @@ -335,6 +340,9 @@ void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
> if (state->fb)
> drm_framebuffer_get(state->fb);
>
> + if (state->solid_fill_blob)
> + drm_property_blob_get(state->solid_fill_blob);
> +
> state->fence = NULL;
> state->commit = NULL;
> state->fb_damage_clips = NULL;
> @@ -384,6 +392,7 @@ void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state)
> drm_crtc_commit_put(state->commit);
>
> drm_property_blob_put(state->fb_damage_clips);
> + drm_property_blob_put(state->solid_fill_blob);
> }
> EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
>
> diff --git a/drivers/gpu/drm/drm_atomic_uapi.c b/drivers/gpu/drm/drm_atomic_uapi.c
> index d867e7f9f2cd..a28b4ee79444 100644
> --- a/drivers/gpu/drm/drm_atomic_uapi.c
> +++ b/drivers/gpu/drm/drm_atomic_uapi.c
> @@ -316,6 +316,51 @@ drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
> }
> EXPORT_SYMBOL(drm_atomic_set_crtc_for_connector);
>
> +static int drm_atomic_set_solid_fill_prop(struct drm_plane_state *state,
> + struct drm_property_blob *blob)
> +{
> + int ret = 0;
> + int blob_version;
> +
> + if (blob == state->solid_fill_blob)
> + return 0;
> +
> + drm_property_blob_put(state->solid_fill_blob);
> + state->solid_fill_blob = NULL;
Is it ok to destroy old state before it is guaranteed that the new
state is accepted?
> +
> + memset(&state->solid_fill, 0, sizeof(state->solid_fill));
> +
> + if (blob) {
> + struct drm_solid_fill_info *user_info = (struct drm_solid_fill_info *)blob->data;
> +
> + if (blob->length != sizeof(struct drm_solid_fill_info)) {
> + drm_dbg_atomic(state->plane->dev,
> + "[PLANE:%d:%s] bad solid fill blob length: %zu\n",
> + state->plane->base.id, state->plane->name,
> + blob->length);
> + return -EINVAL;
> + }
> +
> + blob_version = user_info->version;
> +
> + /* Add more versions if necessary */
> + if (blob_version == 1) {
> + state->solid_fill.r = user_info->r;
> + state->solid_fill.g = user_info->g;
> + state->solid_fill.b = user_info->b;
> + } else {
> + drm_dbg_atomic(state->plane->dev,
> + "[PLANE:%d:%s] failed to set solid fill (ret=%d)\n",
> + state->plane->base.id, state->plane->name,
> + ret);
> + return -EINVAL;
Btw. how does the atomic check machinery work here?
I expect that a TEST_ONLY atomic commit will do all the above checks
and return failure if anything is not right. Right?
> + }
> + state->solid_fill_blob = drm_property_blob_get(blob);
> + }
> +
> + return ret;
> +}
> +
> static void set_out_fence_for_crtc(struct drm_atomic_state *state,
> struct drm_crtc *crtc, s32 __user *fence_ptr)
> {
> @@ -544,6 +589,13 @@ static int drm_atomic_plane_set_property(struct drm_plane *plane,
> state->src_w = val;
> } else if (property == config->prop_src_h) {
> state->src_h = val;
> + } else if (property == plane->solid_fill_property) {
> + struct drm_property_blob *solid_fill = drm_property_lookup_blob(dev, val);
> +
> + ret = drm_atomic_set_solid_fill_prop(state, solid_fill);
> + drm_property_blob_put(solid_fill);
> +
> + return ret;
> } else if (property == plane->alpha_property) {
> state->alpha = val;
> } else if (property == plane->blend_mode_property) {
> @@ -616,6 +668,9 @@ drm_atomic_plane_get_property(struct drm_plane *plane,
> *val = state->src_w;
> } else if (property == config->prop_src_h) {
> *val = state->src_h;
> + } else if (property == plane->solid_fill_property) {
> + *val = state->solid_fill_blob ?
> + state->solid_fill_blob->base.id : 0;
> } else if (property == plane->alpha_property) {
> *val = state->alpha;
> } else if (property == plane->blend_mode_property) {
> diff --git a/drivers/gpu/drm/drm_blend.c b/drivers/gpu/drm/drm_blend.c
> index 6e74de833466..38c3c5d6453a 100644
> --- a/drivers/gpu/drm/drm_blend.c
> +++ b/drivers/gpu/drm/drm_blend.c
> @@ -185,6 +185,10 @@
> * plane does not expose the "alpha" property, then this is
> * assumed to be 1.0
> *
> + * solid_fill:
> + * solid_fill is set up with drm_plane_create_solid_fill_property(). It
> + * contains pixel data that drivers can use to fill a plane.
This is a nice start, but I feel it needs to explain much more about
how userspace should go about making use of this.
Yeah, the pixel_source property comes in the next patch, but I feel
that it is harder to review if the doc is built over multiple patches.
My personal approach would be to write the doc in full and referring to
pixel_source property already, and explain in the commit message that
the next patch will add pixel_source so people don't wonder about
referring to a non-existing property.
I mean just a reference to pixel_source, and leave the actual
pixel_source doc for the patch adding the property like it already is.
Dmitry's suggestion of swapping the patch order is good too.
> + *
> * Note that all the property extensions described here apply either to the
> * plane or the CRTC (e.g. for the background color, which currently is not
> * exposed and assumed to be black).
> @@ -615,3 +619,32 @@ int drm_plane_create_blend_mode_property(struct drm_plane *plane,
> return 0;
> }
> EXPORT_SYMBOL(drm_plane_create_blend_mode_property);
> +
> +/**
> + * drm_plane_create_solid_fill_property - create a new solid_fill property
> + * @plane: drm plane
> + *
> + * This creates a new property that holds pixel data for solid fill planes. This
> + * property is exposed to userspace as a property blob called "solid_fill".
> + *
> + * For information on what the blob contains, see `drm_solid_fill_info`.
I think you should be more explicit here. For example: the blob must
contain exactly one struct drm_solid_fill_info.
It's better to put this content spec with the UAPI doc rather than in this
kerner-internal function doc that userspace programmers won't know to
look at.
> + *
> + * Returns:
> + * Zero on success, negative errno on failure.
> + */
> +int drm_plane_create_solid_fill_property(struct drm_plane *plane)
> +{
> + struct drm_property *prop;
> +
> + prop = drm_property_create(plane->dev,
> + DRM_MODE_PROP_ATOMIC | DRM_MODE_PROP_BLOB,
> + "solid_fill", 0);
> + if (!prop)
> + return -ENOMEM;
> +
> + drm_object_attach_property(&plane->base, prop, 0);
> + plane->solid_fill_property = prop;
> +
> + return 0;
> +}
> +EXPORT_SYMBOL(drm_plane_create_solid_fill_property);
> diff --git a/include/drm/drm_blend.h b/include/drm/drm_blend.h
> index 88bdfec3bd88..0338a860b9c8 100644
> --- a/include/drm/drm_blend.h
> +++ b/include/drm/drm_blend.h
> @@ -58,4 +58,5 @@ int drm_atomic_normalize_zpos(struct drm_device *dev,
> struct drm_atomic_state *state);
> int drm_plane_create_blend_mode_property(struct drm_plane *plane,
> unsigned int supported_modes);
> +int drm_plane_create_solid_fill_property(struct drm_plane *plane);
> #endif
> diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
> index 51291983ea44..f6ab313cb83e 100644
> --- a/include/drm/drm_plane.h
> +++ b/include/drm/drm_plane.h
> @@ -40,6 +40,25 @@ enum drm_scaling_filter {
> DRM_SCALING_FILTER_NEAREST_NEIGHBOR,
> };
>
> +/**
> + * struct drm_solid_fill_info - User info for solid fill planes
> + */
> +struct drm_solid_fill_info {
> + __u8 version;
> + __u32 r, g, b;
> +};
Shouldn't UAPI structs be in UAPI headers?
Shouldn't UAPI structs use explicit padding to not leave any gaps when
it's unavoidable? And the kernel to check that the gaps are indeed
zeroed?
It also needs more UAPI doc, like a link to the property doc that uses
this and an explanation of what the values mean.
Thanks,
pq
> +
> +/**
> + * struct solid_fill_property - RGB values for solid fill plane
> + *
> + * Note: This is the V1 for this feature
> + */
> +struct drm_solid_fill {
> + uint32_t r;
> + uint32_t g;
> + uint32_t b;
> +};
> +
> /**
> * struct drm_plane_state - mutable plane state
> *
> @@ -116,6 +135,23 @@ struct drm_plane_state {
> /** @src_h: height of visible portion of plane (in 16.16) */
> uint32_t src_h, src_w;
>
> + /**
> + * @solid_fill_blob:
> + *
> + * Blob containing relevant information for a solid fill plane
> + * including pixel format and data. See
> + * drm_plane_create_solid_fill_property() for more details.
> + */
> + struct drm_property_blob *solid_fill_blob;
> +
> + /**
> + * @solid_fill:
> + *
> + * Pixel data for solid fill planes. See
> + * drm_plane_create_solid_fill_property() for more details.
> + */
> + struct drm_solid_fill solid_fill;
> +
> /**
> * @alpha:
> * Opacity of the plane with 0 as completely transparent and 0xffff as
> @@ -699,6 +735,13 @@ struct drm_plane {
> */
> struct drm_plane_state *state;
>
> + /*
> + * @solid_fill_property:
> + * Optional solid_fill property for this plane. See
> + * drm_plane_create_solid_fill_property().
> + */
> + struct drm_property *solid_fill_property;
> +
> /**
> * @alpha_property:
> * Optional alpha property for this plane. See
>
On 30/06/2023 03:25, Jessica Zhang wrote:
> Document and add support for solid_fill property to drm_plane. In
> addition, add support for setting and getting the values for solid_fill.
>
> To enable solid fill planes, userspace must assign a property blob to
> the "solid_fill" plane property containing the following information:
>
> struct drm_solid_fill_info {
> u8 version;
> u32 r, g, b;
> };
>
> Signed-off-by: Jessica Zhang <[email protected]>
> ---
> drivers/gpu/drm/drm_atomic_state_helper.c | 9 +++++
> drivers/gpu/drm/drm_atomic_uapi.c | 55 +++++++++++++++++++++++++++++++
> drivers/gpu/drm/drm_blend.c | 33 +++++++++++++++++++
> include/drm/drm_blend.h | 1 +
> include/drm/drm_plane.h | 43 ++++++++++++++++++++++++
> 5 files changed, 141 insertions(+)
Also, I think the point which we missed up to now. Could you please add
both new properties to dri/N/state debugfs?
--
With best wishes
Dmitry
On Fri, Jun 30, 2023 at 2:26 AM Jessica Zhang <[email protected]> wrote:
>
> Add support for pixel_source property to drm_plane and related
> documentation.
>
> This enum property will allow user to specify a pixel source for the
> plane. Possible pixel sources will be defined in the
> drm_plane_pixel_source enum.
>
> The current possible pixel sources are DRM_PLANE_PIXEL_SOURCE_FB and
> DRM_PLANE_PIXEL_SOURCE_COLOR. The default value is *_SOURCE_FB.
>
> Signed-off-by: Jessica Zhang <[email protected]>
> ---
> drivers/gpu/drm/drm_atomic_state_helper.c | 1 +
> drivers/gpu/drm/drm_atomic_uapi.c | 4 ++
> drivers/gpu/drm/drm_blend.c | 81 +++++++++++++++++++++++++++++++
> include/drm/drm_blend.h | 2 +
> include/drm/drm_plane.h | 21 ++++++++
> 5 files changed, 109 insertions(+)
>
> diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c b/drivers/gpu/drm/drm_atomic_state_helper.c
> index fe14be2bd2b2..86fb876efbe6 100644
> --- a/drivers/gpu/drm/drm_atomic_state_helper.c
> +++ b/drivers/gpu/drm/drm_atomic_state_helper.c
> @@ -252,6 +252,7 @@ void __drm_atomic_helper_plane_state_reset(struct drm_plane_state *plane_state,
>
> plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
> plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
> + plane_state->pixel_source = DRM_PLANE_PIXEL_SOURCE_FB;
>
> if (plane_state->solid_fill_blob) {
> drm_property_blob_put(plane_state->solid_fill_blob);
> diff --git a/drivers/gpu/drm/drm_atomic_uapi.c b/drivers/gpu/drm/drm_atomic_uapi.c
> index a28b4ee79444..6e59c21af66b 100644
> --- a/drivers/gpu/drm/drm_atomic_uapi.c
> +++ b/drivers/gpu/drm/drm_atomic_uapi.c
> @@ -596,6 +596,8 @@ static int drm_atomic_plane_set_property(struct drm_plane *plane,
> drm_property_blob_put(solid_fill);
>
> return ret;
> + } else if (property == plane->pixel_source_property) {
> + state->pixel_source = val;
> } else if (property == plane->alpha_property) {
> state->alpha = val;
> } else if (property == plane->blend_mode_property) {
> @@ -671,6 +673,8 @@ drm_atomic_plane_get_property(struct drm_plane *plane,
> } else if (property == plane->solid_fill_property) {
> *val = state->solid_fill_blob ?
> state->solid_fill_blob->base.id : 0;
> + } else if (property == plane->pixel_source_property) {
> + *val = state->pixel_source;
> } else if (property == plane->alpha_property) {
> *val = state->alpha;
> } else if (property == plane->blend_mode_property) {
> diff --git a/drivers/gpu/drm/drm_blend.c b/drivers/gpu/drm/drm_blend.c
> index 38c3c5d6453a..8c100a957ee2 100644
> --- a/drivers/gpu/drm/drm_blend.c
> +++ b/drivers/gpu/drm/drm_blend.c
> @@ -189,6 +189,18 @@
> * solid_fill is set up with drm_plane_create_solid_fill_property(). It
> * contains pixel data that drivers can use to fill a plane.
> *
> + * pixel_source:
> + * pixel_source is set up with drm_plane_create_pixel_source_property().
> + * It is used to toggle the source of pixel data for the plane.
> + *
> + * Possible values:
> + *
> + * "FB":
> + * Framebuffer source
> + *
> + * "COLOR":
> + * solid_fill source
> + *
> * Note that all the property extensions described here apply either to the
> * plane or the CRTC (e.g. for the background color, which currently is not
> * exposed and assumed to be black).
> @@ -648,3 +660,72 @@ int drm_plane_create_solid_fill_property(struct drm_plane *plane)
> return 0;
> }
> EXPORT_SYMBOL(drm_plane_create_solid_fill_property);
> +
> +/**
> + * drm_plane_create_pixel_source_property - create a new pixel source property
> + * @plane: drm plane
> + * @supported_sources: bitmask of supported pixel_sources for the driver (NOT
> + * including DRM_PLANE_PIXEL_SOURCE_FB, as it will be supported
> + * by default).
> + *
> + * This creates a new property describing the current source of pixel data for the
> + * plane.
> + *
> + * The property is exposed to userspace as an enumeration property called
> + * "pixel_source" and has the following enumeration values:
> + *
> + * "FB":
> + * Framebuffer pixel source
> + *
> + * "COLOR":
> + * Solid fill color pixel source
Can we add a "NONE" value?
I know it has been discussed earlier if we *need* this and I don't
think we do. I just think it would be better API design to disable
planes this way than having to know that a framebuffer pixel source
with a NULL framebuffer disables the plane. Obviously also keep the
old behavior for backwards compatibility.
> + *
> + * Returns:
> + * Zero on success, negative errno on failure.
> + */
> +int drm_plane_create_pixel_source_property(struct drm_plane *plane,
> + unsigned int supported_sources)
> +{
> + struct drm_device *dev = plane->dev;
> + struct drm_property *prop;
> + const struct drm_prop_enum_list enum_list[] = {
> + { DRM_PLANE_PIXEL_SOURCE_FB, "FB" },
> + { DRM_PLANE_PIXEL_SOURCE_COLOR, "COLOR" },
> + };
> + unsigned int valid_source_mask = BIT(DRM_PLANE_PIXEL_SOURCE_FB) |
> + BIT(DRM_PLANE_PIXEL_SOURCE_COLOR);
> + int i;
> +
> + /* FB is supported by default */
> + supported_sources |= BIT(DRM_PLANE_PIXEL_SOURCE_FB);
> +
> + if (WARN_ON(supported_sources & ~valid_source_mask))
> + return -EINVAL;
> +
> + prop = drm_property_create(dev, DRM_MODE_PROP_ENUM, "pixel_source",
> + hweight32(supported_sources));
> +
> + if (!prop)
> + return -ENOMEM;
> +
> + for (i = 0; i < ARRAY_SIZE(enum_list); i++) {
> + int ret;
> +
> + if (!(BIT(enum_list[i].type) & supported_sources))
> + continue;
> +
> + ret = drm_property_add_enum(prop, enum_list[i].type, enum_list[i].name);
> +
> + if (ret) {
> + drm_property_destroy(dev, prop);
> +
> + return ret;
> + }
> + }
> +
> + drm_object_attach_property(&plane->base, prop, DRM_PLANE_PIXEL_SOURCE_FB);
> + plane->pixel_source_property = prop;
> +
> + return 0;
> +}
> +EXPORT_SYMBOL(drm_plane_create_pixel_source_property);
> diff --git a/include/drm/drm_blend.h b/include/drm/drm_blend.h
> index 0338a860b9c8..31af7cfa5b1b 100644
> --- a/include/drm/drm_blend.h
> +++ b/include/drm/drm_blend.h
> @@ -59,4 +59,6 @@ int drm_atomic_normalize_zpos(struct drm_device *dev,
> int drm_plane_create_blend_mode_property(struct drm_plane *plane,
> unsigned int supported_modes);
> int drm_plane_create_solid_fill_property(struct drm_plane *plane);
> +int drm_plane_create_pixel_source_property(struct drm_plane *plane,
> + unsigned int supported_sources);
> #endif
> diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
> index f6ab313cb83e..73fb6cf8a5d9 100644
> --- a/include/drm/drm_plane.h
> +++ b/include/drm/drm_plane.h
> @@ -59,6 +59,12 @@ struct drm_solid_fill {
> uint32_t b;
> };
>
> +enum drm_plane_pixel_source {
> + DRM_PLANE_PIXEL_SOURCE_FB,
> + DRM_PLANE_PIXEL_SOURCE_COLOR,
> + DRM_PLANE_PIXEL_SOURCE_MAX
> +};
> +
> /**
> * struct drm_plane_state - mutable plane state
> *
> @@ -152,6 +158,14 @@ struct drm_plane_state {
> */
> struct drm_solid_fill solid_fill;
>
> + /*
> + * @pixel_source:
> + *
> + * Source of pixel information for the plane. See
> + * drm_plane_create_pixel_source_property() for more details.
> + */
> + enum drm_plane_pixel_source pixel_source;
> +
> /**
> * @alpha:
> * Opacity of the plane with 0 as completely transparent and 0xffff as
> @@ -742,6 +756,13 @@ struct drm_plane {
> */
> struct drm_property *solid_fill_property;
>
> + /*
> + * @pixel_source_property:
> + * Optional pixel_source property for this plane. See
> + * drm_plane_create_pixel_source_property().
> + */
> + struct drm_property *pixel_source_property;
> +
> /**
> * @alpha_property:
> * Optional alpha property for this plane. See
>
> --
> 2.41.0
>
On 6/30/2023 3:33 AM, Dmitry Baryshkov wrote:
> On 30/06/2023 03:25, Jessica Zhang wrote:
>> Document and add support for solid_fill property to drm_plane. In
>> addition, add support for setting and getting the values for solid_fill.
>>
>> To enable solid fill planes, userspace must assign a property blob to
>> the "solid_fill" plane property containing the following information:
>>
>> struct drm_solid_fill_info {
>> u8 version;
>> u32 r, g, b;
>> };
>>
>> Signed-off-by: Jessica Zhang <[email protected]>
>> ---
>> drivers/gpu/drm/drm_atomic_state_helper.c | 9 +++++
>> drivers/gpu/drm/drm_atomic_uapi.c | 55
>> +++++++++++++++++++++++++++++++
>> drivers/gpu/drm/drm_blend.c | 33 +++++++++++++++++++
>> include/drm/drm_blend.h | 1 +
>> include/drm/drm_plane.h | 43 ++++++++++++++++++++++++
>> 5 files changed, 141 insertions(+)
>
> Also, I think the point which we missed up to now. Could you please add
> both new properties to dri/N/state debugfs?
Hi Dmitry,
Good catch -- acked.
Thanks,
Jessica Zhang
>
> --
> With best wishes
> Dmitry
>
On 6/30/2023 7:43 AM, Sebastian Wick wrote:
> On Fri, Jun 30, 2023 at 2:26 AM Jessica Zhang <[email protected]> wrote:
>>
>> Add support for pixel_source property to drm_plane and related
>> documentation.
>>
>> This enum property will allow user to specify a pixel source for the
>> plane. Possible pixel sources will be defined in the
>> drm_plane_pixel_source enum.
>>
>> The current possible pixel sources are DRM_PLANE_PIXEL_SOURCE_FB and
>> DRM_PLANE_PIXEL_SOURCE_COLOR. The default value is *_SOURCE_FB.
>>
>> Signed-off-by: Jessica Zhang <[email protected]>
>> ---
>> drivers/gpu/drm/drm_atomic_state_helper.c | 1 +
>> drivers/gpu/drm/drm_atomic_uapi.c | 4 ++
>> drivers/gpu/drm/drm_blend.c | 81 +++++++++++++++++++++++++++++++
>> include/drm/drm_blend.h | 2 +
>> include/drm/drm_plane.h | 21 ++++++++
>> 5 files changed, 109 insertions(+)
>>
>> diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c b/drivers/gpu/drm/drm_atomic_state_helper.c
>> index fe14be2bd2b2..86fb876efbe6 100644
>> --- a/drivers/gpu/drm/drm_atomic_state_helper.c
>> +++ b/drivers/gpu/drm/drm_atomic_state_helper.c
>> @@ -252,6 +252,7 @@ void __drm_atomic_helper_plane_state_reset(struct drm_plane_state *plane_state,
>>
>> plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
>> plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
>> + plane_state->pixel_source = DRM_PLANE_PIXEL_SOURCE_FB;
>>
>> if (plane_state->solid_fill_blob) {
>> drm_property_blob_put(plane_state->solid_fill_blob);
>> diff --git a/drivers/gpu/drm/drm_atomic_uapi.c b/drivers/gpu/drm/drm_atomic_uapi.c
>> index a28b4ee79444..6e59c21af66b 100644
>> --- a/drivers/gpu/drm/drm_atomic_uapi.c
>> +++ b/drivers/gpu/drm/drm_atomic_uapi.c
>> @@ -596,6 +596,8 @@ static int drm_atomic_plane_set_property(struct drm_plane *plane,
>> drm_property_blob_put(solid_fill);
>>
>> return ret;
>> + } else if (property == plane->pixel_source_property) {
>> + state->pixel_source = val;
>> } else if (property == plane->alpha_property) {
>> state->alpha = val;
>> } else if (property == plane->blend_mode_property) {
>> @@ -671,6 +673,8 @@ drm_atomic_plane_get_property(struct drm_plane *plane,
>> } else if (property == plane->solid_fill_property) {
>> *val = state->solid_fill_blob ?
>> state->solid_fill_blob->base.id : 0;
>> + } else if (property == plane->pixel_source_property) {
>> + *val = state->pixel_source;
>> } else if (property == plane->alpha_property) {
>> *val = state->alpha;
>> } else if (property == plane->blend_mode_property) {
>> diff --git a/drivers/gpu/drm/drm_blend.c b/drivers/gpu/drm/drm_blend.c
>> index 38c3c5d6453a..8c100a957ee2 100644
>> --- a/drivers/gpu/drm/drm_blend.c
>> +++ b/drivers/gpu/drm/drm_blend.c
>> @@ -189,6 +189,18 @@
>> * solid_fill is set up with drm_plane_create_solid_fill_property(). It
>> * contains pixel data that drivers can use to fill a plane.
>> *
>> + * pixel_source:
>> + * pixel_source is set up with drm_plane_create_pixel_source_property().
>> + * It is used to toggle the source of pixel data for the plane.
>> + *
>> + * Possible values:
>> + *
>> + * "FB":
>> + * Framebuffer source
>> + *
>> + * "COLOR":
>> + * solid_fill source
>> + *
>> * Note that all the property extensions described here apply either to the
>> * plane or the CRTC (e.g. for the background color, which currently is not
>> * exposed and assumed to be black).
>> @@ -648,3 +660,72 @@ int drm_plane_create_solid_fill_property(struct drm_plane *plane)
>> return 0;
>> }
>> EXPORT_SYMBOL(drm_plane_create_solid_fill_property);
>> +
>> +/**
>> + * drm_plane_create_pixel_source_property - create a new pixel source property
>> + * @plane: drm plane
>> + * @supported_sources: bitmask of supported pixel_sources for the driver (NOT
>> + * including DRM_PLANE_PIXEL_SOURCE_FB, as it will be supported
>> + * by default).
>> + *
>> + * This creates a new property describing the current source of pixel data for the
>> + * plane.
>> + *
>> + * The property is exposed to userspace as an enumeration property called
>> + * "pixel_source" and has the following enumeration values:
>> + *
>> + * "FB":
>> + * Framebuffer pixel source
>> + *
>> + * "COLOR":
>> + * Solid fill color pixel source
>
> Can we add a "NONE" value?
>
> I know it has been discussed earlier if we *need* this and I don't
> think we do. I just think it would be better API design to disable
> planes this way than having to know that a framebuffer pixel source
> with a NULL framebuffer disables the plane. Obviously also keep the
> old behavior for backwards compatibility.
Hi Sebastian,
Sounds good.
So if pixel_source == NONE disables the planes, would that mean cases
where pixel_source == COLOR && solid_fill_blob == NULL, the atomic
commit should throw an error?
Thanks,
Jessica Zhang
>
>> + *
>> + * Returns:
>> + * Zero on success, negative errno on failure.
>> + */
>> +int drm_plane_create_pixel_source_property(struct drm_plane *plane,
>> + unsigned int supported_sources)
>> +{
>> + struct drm_device *dev = plane->dev;
>> + struct drm_property *prop;
>> + const struct drm_prop_enum_list enum_list[] = {
>> + { DRM_PLANE_PIXEL_SOURCE_FB, "FB" },
>> + { DRM_PLANE_PIXEL_SOURCE_COLOR, "COLOR" },
>> + };
>> + unsigned int valid_source_mask = BIT(DRM_PLANE_PIXEL_SOURCE_FB) |
>> + BIT(DRM_PLANE_PIXEL_SOURCE_COLOR);
>> + int i;
>> +
>> + /* FB is supported by default */
>> + supported_sources |= BIT(DRM_PLANE_PIXEL_SOURCE_FB);
>> +
>> + if (WARN_ON(supported_sources & ~valid_source_mask))
>> + return -EINVAL;
>> +
>> + prop = drm_property_create(dev, DRM_MODE_PROP_ENUM, "pixel_source",
>> + hweight32(supported_sources));
>> +
>> + if (!prop)
>> + return -ENOMEM;
>> +
>> + for (i = 0; i < ARRAY_SIZE(enum_list); i++) {
>> + int ret;
>> +
>> + if (!(BIT(enum_list[i].type) & supported_sources))
>> + continue;
>> +
>> + ret = drm_property_add_enum(prop, enum_list[i].type, enum_list[i].name);
>> +
>> + if (ret) {
>> + drm_property_destroy(dev, prop);
>> +
>> + return ret;
>> + }
>> + }
>> +
>> + drm_object_attach_property(&plane->base, prop, DRM_PLANE_PIXEL_SOURCE_FB);
>> + plane->pixel_source_property = prop;
>> +
>> + return 0;
>> +}
>> +EXPORT_SYMBOL(drm_plane_create_pixel_source_property);
>> diff --git a/include/drm/drm_blend.h b/include/drm/drm_blend.h
>> index 0338a860b9c8..31af7cfa5b1b 100644
>> --- a/include/drm/drm_blend.h
>> +++ b/include/drm/drm_blend.h
>> @@ -59,4 +59,6 @@ int drm_atomic_normalize_zpos(struct drm_device *dev,
>> int drm_plane_create_blend_mode_property(struct drm_plane *plane,
>> unsigned int supported_modes);
>> int drm_plane_create_solid_fill_property(struct drm_plane *plane);
>> +int drm_plane_create_pixel_source_property(struct drm_plane *plane,
>> + unsigned int supported_sources);
>> #endif
>> diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
>> index f6ab313cb83e..73fb6cf8a5d9 100644
>> --- a/include/drm/drm_plane.h
>> +++ b/include/drm/drm_plane.h
>> @@ -59,6 +59,12 @@ struct drm_solid_fill {
>> uint32_t b;
>> };
>>
>> +enum drm_plane_pixel_source {
>> + DRM_PLANE_PIXEL_SOURCE_FB,
>> + DRM_PLANE_PIXEL_SOURCE_COLOR,
>> + DRM_PLANE_PIXEL_SOURCE_MAX
>> +};
>> +
>> /**
>> * struct drm_plane_state - mutable plane state
>> *
>> @@ -152,6 +158,14 @@ struct drm_plane_state {
>> */
>> struct drm_solid_fill solid_fill;
>>
>> + /*
>> + * @pixel_source:
>> + *
>> + * Source of pixel information for the plane. See
>> + * drm_plane_create_pixel_source_property() for more details.
>> + */
>> + enum drm_plane_pixel_source pixel_source;
>> +
>> /**
>> * @alpha:
>> * Opacity of the plane with 0 as completely transparent and 0xffff as
>> @@ -742,6 +756,13 @@ struct drm_plane {
>> */
>> struct drm_property *solid_fill_property;
>>
>> + /*
>> + * @pixel_source_property:
>> + * Optional pixel_source property for this plane. See
>> + * drm_plane_create_pixel_source_property().
>> + */
>> + struct drm_property *pixel_source_property;
>> +
>> /**
>> * @alpha_property:
>> * Optional alpha property for this plane. See
>>
>> --
>> 2.41.0
>>
>
On 6/29/2023 5:49 PM, Dmitry Baryshkov wrote:
> On 30/06/2023 03:25, Jessica Zhang wrote:
>> Add solid_fill and pixel_source properties to DPU plane
>>
>> Signed-off-by: Jessica Zhang <[email protected]>
>> ---
>> drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c | 2 ++
>> 1 file changed, 2 insertions(+)
>
> This should be the last commit.
Hi Dmitry,
Acked, will move this to the end.
Thanks,
Jessica Zhang
> Otherwise:
>
> Reviewed-by: Dmitry Baryshkov <[email protected]>
>
>>
>> diff --git a/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c
>> b/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c
>> index c2aaaded07ed..5f0984ce62b1 100644
>> --- a/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c
>> +++ b/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c
>> @@ -1429,6 +1429,8 @@ struct drm_plane *dpu_plane_init(struct
>> drm_device *dev,
>> DPU_ERROR("failed to install zpos property, rc = %d\n", ret);
>> drm_plane_create_alpha_property(plane);
>> + drm_plane_create_solid_fill_property(plane);
>> + drm_plane_create_pixel_source_property(plane,
>> BIT(DRM_PLANE_PIXEL_SOURCE_COLOR));
>> drm_plane_create_blend_mode_property(plane,
>> BIT(DRM_MODE_BLEND_PIXEL_NONE) |
>> BIT(DRM_MODE_BLEND_PREMULTI) |
>>
>
> --
> With best wishes
> Dmitry
>
On Fri, Jun 30, 2023 at 11:27 PM Jessica Zhang
<[email protected]> wrote:
>
>
>
> On 6/30/2023 7:43 AM, Sebastian Wick wrote:
> > On Fri, Jun 30, 2023 at 2:26 AM Jessica Zhang <[email protected]> wrote:
> >>
> >> Add support for pixel_source property to drm_plane and related
> >> documentation.
> >>
> >> This enum property will allow user to specify a pixel source for the
> >> plane. Possible pixel sources will be defined in the
> >> drm_plane_pixel_source enum.
> >>
> >> The current possible pixel sources are DRM_PLANE_PIXEL_SOURCE_FB and
> >> DRM_PLANE_PIXEL_SOURCE_COLOR. The default value is *_SOURCE_FB.
> >>
> >> Signed-off-by: Jessica Zhang <[email protected]>
> >> ---
> >> drivers/gpu/drm/drm_atomic_state_helper.c | 1 +
> >> drivers/gpu/drm/drm_atomic_uapi.c | 4 ++
> >> drivers/gpu/drm/drm_blend.c | 81 +++++++++++++++++++++++++++++++
> >> include/drm/drm_blend.h | 2 +
> >> include/drm/drm_plane.h | 21 ++++++++
> >> 5 files changed, 109 insertions(+)
> >>
> >> diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c b/drivers/gpu/drm/drm_atomic_state_helper.c
> >> index fe14be2bd2b2..86fb876efbe6 100644
> >> --- a/drivers/gpu/drm/drm_atomic_state_helper.c
> >> +++ b/drivers/gpu/drm/drm_atomic_state_helper.c
> >> @@ -252,6 +252,7 @@ void __drm_atomic_helper_plane_state_reset(struct drm_plane_state *plane_state,
> >>
> >> plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
> >> plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
> >> + plane_state->pixel_source = DRM_PLANE_PIXEL_SOURCE_FB;
> >>
> >> if (plane_state->solid_fill_blob) {
> >> drm_property_blob_put(plane_state->solid_fill_blob);
> >> diff --git a/drivers/gpu/drm/drm_atomic_uapi.c b/drivers/gpu/drm/drm_atomic_uapi.c
> >> index a28b4ee79444..6e59c21af66b 100644
> >> --- a/drivers/gpu/drm/drm_atomic_uapi.c
> >> +++ b/drivers/gpu/drm/drm_atomic_uapi.c
> >> @@ -596,6 +596,8 @@ static int drm_atomic_plane_set_property(struct drm_plane *plane,
> >> drm_property_blob_put(solid_fill);
> >>
> >> return ret;
> >> + } else if (property == plane->pixel_source_property) {
> >> + state->pixel_source = val;
> >> } else if (property == plane->alpha_property) {
> >> state->alpha = val;
> >> } else if (property == plane->blend_mode_property) {
> >> @@ -671,6 +673,8 @@ drm_atomic_plane_get_property(struct drm_plane *plane,
> >> } else if (property == plane->solid_fill_property) {
> >> *val = state->solid_fill_blob ?
> >> state->solid_fill_blob->base.id : 0;
> >> + } else if (property == plane->pixel_source_property) {
> >> + *val = state->pixel_source;
> >> } else if (property == plane->alpha_property) {
> >> *val = state->alpha;
> >> } else if (property == plane->blend_mode_property) {
> >> diff --git a/drivers/gpu/drm/drm_blend.c b/drivers/gpu/drm/drm_blend.c
> >> index 38c3c5d6453a..8c100a957ee2 100644
> >> --- a/drivers/gpu/drm/drm_blend.c
> >> +++ b/drivers/gpu/drm/drm_blend.c
> >> @@ -189,6 +189,18 @@
> >> * solid_fill is set up with drm_plane_create_solid_fill_property(). It
> >> * contains pixel data that drivers can use to fill a plane.
> >> *
> >> + * pixel_source:
> >> + * pixel_source is set up with drm_plane_create_pixel_source_property().
> >> + * It is used to toggle the source of pixel data for the plane.
> >> + *
> >> + * Possible values:
> >> + *
> >> + * "FB":
> >> + * Framebuffer source
> >> + *
> >> + * "COLOR":
> >> + * solid_fill source
> >> + *
> >> * Note that all the property extensions described here apply either to the
> >> * plane or the CRTC (e.g. for the background color, which currently is not
> >> * exposed and assumed to be black).
> >> @@ -648,3 +660,72 @@ int drm_plane_create_solid_fill_property(struct drm_plane *plane)
> >> return 0;
> >> }
> >> EXPORT_SYMBOL(drm_plane_create_solid_fill_property);
> >> +
> >> +/**
> >> + * drm_plane_create_pixel_source_property - create a new pixel source property
> >> + * @plane: drm plane
> >> + * @supported_sources: bitmask of supported pixel_sources for the driver (NOT
> >> + * including DRM_PLANE_PIXEL_SOURCE_FB, as it will be supported
> >> + * by default).
> >> + *
> >> + * This creates a new property describing the current source of pixel data for the
> >> + * plane.
> >> + *
> >> + * The property is exposed to userspace as an enumeration property called
> >> + * "pixel_source" and has the following enumeration values:
> >> + *
> >> + * "FB":
> >> + * Framebuffer pixel source
> >> + *
> >> + * "COLOR":
> >> + * Solid fill color pixel source
> >
> > Can we add a "NONE" value?
> >
> > I know it has been discussed earlier if we *need* this and I don't
> > think we do. I just think it would be better API design to disable
> > planes this way than having to know that a framebuffer pixel source
> > with a NULL framebuffer disables the plane. Obviously also keep the
> > old behavior for backwards compatibility.
>
> Hi Sebastian,
>
> Sounds good.
>
> So if pixel_source == NONE disables the planes, would that mean cases
> where pixel_source == COLOR && solid_fill_blob == NULL, the atomic
> commit should throw an error?
I would say so, yes.
> Thanks,
>
> Jessica Zhang
>
> >
> >> + *
> >> + * Returns:
> >> + * Zero on success, negative errno on failure.
> >> + */
> >> +int drm_plane_create_pixel_source_property(struct drm_plane *plane,
> >> + unsigned int supported_sources)
> >> +{
> >> + struct drm_device *dev = plane->dev;
> >> + struct drm_property *prop;
> >> + const struct drm_prop_enum_list enum_list[] = {
> >> + { DRM_PLANE_PIXEL_SOURCE_FB, "FB" },
> >> + { DRM_PLANE_PIXEL_SOURCE_COLOR, "COLOR" },
> >> + };
> >> + unsigned int valid_source_mask = BIT(DRM_PLANE_PIXEL_SOURCE_FB) |
> >> + BIT(DRM_PLANE_PIXEL_SOURCE_COLOR);
> >> + int i;
> >> +
> >> + /* FB is supported by default */
> >> + supported_sources |= BIT(DRM_PLANE_PIXEL_SOURCE_FB);
> >> +
> >> + if (WARN_ON(supported_sources & ~valid_source_mask))
> >> + return -EINVAL;
> >> +
> >> + prop = drm_property_create(dev, DRM_MODE_PROP_ENUM, "pixel_source",
> >> + hweight32(supported_sources));
> >> +
> >> + if (!prop)
> >> + return -ENOMEM;
> >> +
> >> + for (i = 0; i < ARRAY_SIZE(enum_list); i++) {
> >> + int ret;
> >> +
> >> + if (!(BIT(enum_list[i].type) & supported_sources))
> >> + continue;
> >> +
> >> + ret = drm_property_add_enum(prop, enum_list[i].type, enum_list[i].name);
> >> +
> >> + if (ret) {
> >> + drm_property_destroy(dev, prop);
> >> +
> >> + return ret;
> >> + }
> >> + }
> >> +
> >> + drm_object_attach_property(&plane->base, prop, DRM_PLANE_PIXEL_SOURCE_FB);
> >> + plane->pixel_source_property = prop;
> >> +
> >> + return 0;
> >> +}
> >> +EXPORT_SYMBOL(drm_plane_create_pixel_source_property);
> >> diff --git a/include/drm/drm_blend.h b/include/drm/drm_blend.h
> >> index 0338a860b9c8..31af7cfa5b1b 100644
> >> --- a/include/drm/drm_blend.h
> >> +++ b/include/drm/drm_blend.h
> >> @@ -59,4 +59,6 @@ int drm_atomic_normalize_zpos(struct drm_device *dev,
> >> int drm_plane_create_blend_mode_property(struct drm_plane *plane,
> >> unsigned int supported_modes);
> >> int drm_plane_create_solid_fill_property(struct drm_plane *plane);
> >> +int drm_plane_create_pixel_source_property(struct drm_plane *plane,
> >> + unsigned int supported_sources);
> >> #endif
> >> diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
> >> index f6ab313cb83e..73fb6cf8a5d9 100644
> >> --- a/include/drm/drm_plane.h
> >> +++ b/include/drm/drm_plane.h
> >> @@ -59,6 +59,12 @@ struct drm_solid_fill {
> >> uint32_t b;
> >> };
> >>
> >> +enum drm_plane_pixel_source {
> >> + DRM_PLANE_PIXEL_SOURCE_FB,
> >> + DRM_PLANE_PIXEL_SOURCE_COLOR,
> >> + DRM_PLANE_PIXEL_SOURCE_MAX
> >> +};
> >> +
> >> /**
> >> * struct drm_plane_state - mutable plane state
> >> *
> >> @@ -152,6 +158,14 @@ struct drm_plane_state {
> >> */
> >> struct drm_solid_fill solid_fill;
> >>
> >> + /*
> >> + * @pixel_source:
> >> + *
> >> + * Source of pixel information for the plane. See
> >> + * drm_plane_create_pixel_source_property() for more details.
> >> + */
> >> + enum drm_plane_pixel_source pixel_source;
> >> +
> >> /**
> >> * @alpha:
> >> * Opacity of the plane with 0 as completely transparent and 0xffff as
> >> @@ -742,6 +756,13 @@ struct drm_plane {
> >> */
> >> struct drm_property *solid_fill_property;
> >>
> >> + /*
> >> + * @pixel_source_property:
> >> + * Optional pixel_source property for this plane. See
> >> + * drm_plane_create_pixel_source_property().
> >> + */
> >> + struct drm_property *pixel_source_property;
> >> +
> >> /**
> >> * @alpha_property:
> >> * Optional alpha property for this plane. See
> >>
> >> --
> >> 2.41.0
> >>
> >
>
On 6/30/2023 1:27 AM, Pekka Paalanen wrote:
> On Fri, 30 Jun 2023 03:42:28 +0300
> Dmitry Baryshkov <[email protected]> wrote:
>
>> On 30/06/2023 03:25, Jessica Zhang wrote:
>>> Add support for pixel_source property to drm_plane and related
>>> documentation.
>>>
>>> This enum property will allow user to specify a pixel source for the
>>> plane. Possible pixel sources will be defined in the
>>> drm_plane_pixel_source enum.
>>>
>>> The current possible pixel sources are DRM_PLANE_PIXEL_SOURCE_FB and
>>> DRM_PLANE_PIXEL_SOURCE_COLOR. The default value is *_SOURCE_FB.
>>
>> I think, this should come before the solid fill property addition. First
>> you tell that there is a possibility to define other pixel sources, then
>> additional sources are defined.
>
> Hi,
>
> that would be logical indeed.
Hi Dmitry and Pekka,
Sorry for the delay in response, was out of office last week.
Acked.
>
>>>
>>> Signed-off-by: Jessica Zhang <[email protected]>
>>> ---
>>> drivers/gpu/drm/drm_atomic_state_helper.c | 1 +
>>> drivers/gpu/drm/drm_atomic_uapi.c | 4 ++
>>> drivers/gpu/drm/drm_blend.c | 81 +++++++++++++++++++++++++++++++
>>> include/drm/drm_blend.h | 2 +
>>> include/drm/drm_plane.h | 21 ++++++++
>>> 5 files changed, 109 insertions(+)
>>>
>>> diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c b/drivers/gpu/drm/drm_atomic_state_helper.c
>>> index fe14be2bd2b2..86fb876efbe6 100644
>>> --- a/drivers/gpu/drm/drm_atomic_state_helper.c
>>> +++ b/drivers/gpu/drm/drm_atomic_state_helper.c
>>> @@ -252,6 +252,7 @@ void __drm_atomic_helper_plane_state_reset(struct drm_plane_state *plane_state,
>>>
>>> plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
>>> plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
>>> + plane_state->pixel_source = DRM_PLANE_PIXEL_SOURCE_FB;
>>>
>>> if (plane_state->solid_fill_blob) {
>>> drm_property_blob_put(plane_state->solid_fill_blob);
>>> diff --git a/drivers/gpu/drm/drm_atomic_uapi.c b/drivers/gpu/drm/drm_atomic_uapi.c
>>> index a28b4ee79444..6e59c21af66b 100644
>>> --- a/drivers/gpu/drm/drm_atomic_uapi.c
>>> +++ b/drivers/gpu/drm/drm_atomic_uapi.c
>>> @@ -596,6 +596,8 @@ static int drm_atomic_plane_set_property(struct drm_plane *plane,
>>> drm_property_blob_put(solid_fill);
>>>
>>> return ret;
>>> + } else if (property == plane->pixel_source_property) {
>>> + state->pixel_source = val;
>>> } else if (property == plane->alpha_property) {
>>> state->alpha = val;
>>> } else if (property == plane->blend_mode_property) {
>>
>> I think, it was pointed out in the discussion that drm_mode_setplane()
>> (a pre-atomic IOCTL to turn the plane on and off) should also reset
>> pixel_source to FB.
I don't remember drm_mode_setplane() being mentioned in the pixel_source
discussion... can you share where it was mentioned?
I'd prefer to avoid having driver change the pixel_source directly as it
could cause some unexpected side effects. In general, I would like
userspace to assign the value of pixel_source without driver doing
anything "under the hood".
>>
>>> @@ -671,6 +673,8 @@ drm_atomic_plane_get_property(struct drm_plane *plane,
>>> } else if (property == plane->solid_fill_property) {
>>> *val = state->solid_fill_blob ?
>>> state->solid_fill_blob->base.id : 0;
>>> + } else if (property == plane->pixel_source_property) {
>>> + *val = state->pixel_source;
>>> } else if (property == plane->alpha_property) {
>>> *val = state->alpha;
>>> } else if (property == plane->blend_mode_property) {
>>> diff --git a/drivers/gpu/drm/drm_blend.c b/drivers/gpu/drm/drm_blend.c
>>> index 38c3c5d6453a..8c100a957ee2 100644
>>> --- a/drivers/gpu/drm/drm_blend.c
>>> +++ b/drivers/gpu/drm/drm_blend.c
>>> @@ -189,6 +189,18 @@
>>> * solid_fill is set up with drm_plane_create_solid_fill_property(). It
>>> * contains pixel data that drivers can use to fill a plane.
>>> *
>>> + * pixel_source:
>>> + * pixel_source is set up with drm_plane_create_pixel_source_property().
>>> + * It is used to toggle the source of pixel data for the plane.
>
> Other sources than the selected one are ignored?
Yep, the plane will only display the data from the set pixel_source.
So if pixel_source == FB and solid_fill_blob is non-NULL,
solid_fill_blob will be ignored and the plane will display the FB that
is set.
Will add a note about this in the comment docs.
>
>>> + *
>>> + * Possible values:
>
> Wouldn't hurt to explicitly mention here that this is an enum.
Acked.
>
>>> + *
>>> + * "FB":
>>> + * Framebuffer source
>>> + *
>>> + * "COLOR":
>>> + * solid_fill source
>
> I think these two should be more explicit. Framebuffer source is the
> usual source from the property "FB_ID". Solid fill source comes from
> the property "solid_fill".
Acked.
>
> Why "COLOR" and not, say, "SOLID_FILL"?
Ah, that would make more sense :)
I'll change this to "SOLID_FILL".
>
>>> + *
>>> * Note that all the property extensions described here apply either to the
>>> * plane or the CRTC (e.g. for the background color, which currently is not
>>> * exposed and assumed to be black).
>>> @@ -648,3 +660,72 @@ int drm_plane_create_solid_fill_property(struct drm_plane *plane)
>>> return 0;
>>> }
>>> EXPORT_SYMBOL(drm_plane_create_solid_fill_property);
>>> +
>>> +/**
>>> + * drm_plane_create_pixel_source_property - create a new pixel source property
>>> + * @plane: drm plane
>>> + * @supported_sources: bitmask of supported pixel_sources for the driver (NOT
>>> + * including DRM_PLANE_PIXEL_SOURCE_FB, as it will be supported
>>> + * by default).
>>
>> I'd say this is too strong. I'd suggest either renaming this to
>> extra_sources (mentioning that FB is enabled for all the planes) or
>> allowing any source bitmask (mentioning that FB should be enabled by the
>> caller, unless there is a good reason not to do so).
>
> Right. I don't see any problem with having planes of type OVERLAY that
> support only solid_fill and no FB. Planes of type PRIMARY and CURSOR I
> would expect to always support at least FB.
>
> Atomic userspace is prepared to have an OVERLAY plane fail for any
> arbitrary reason. Legacy userspace probably should not ever see a plane
> that does not support FB.
Got it... If we allow the possibility of FB sources not being supported,
then should the default pixel_source per plane be decided by the driver too?
I'd forced FB support so that I could set pixel_source to FB in
__drm_atomic_helper_plane_state_reset(). If we allow more flexibility in
the default pixel_source value, I guess we can also store a
default_pixel_source value in the plane_state.
>
>>> + *
>>> + * This creates a new property describing the current source of pixel data for the
>>> + * plane.
>>> + *
>>> + * The property is exposed to userspace as an enumeration property called
>>> + * "pixel_source" and has the following enumeration values:
>>> + *
>>> + * "FB":
>>> + * Framebuffer pixel source
>>> + *
>>> + * "COLOR":
>>> + * Solid fill color pixel source
>>> + *
>>> + * Returns:
>>> + * Zero on success, negative errno on failure.
>>> + */
>>> +int drm_plane_create_pixel_source_property(struct drm_plane *plane,
>>> + unsigned int supported_sources)
>>> +{
>>> + struct drm_device *dev = plane->dev;
>>> + struct drm_property *prop;
>>> + const struct drm_prop_enum_list enum_list[] = {
>>> + { DRM_PLANE_PIXEL_SOURCE_FB, "FB" },
>>> + { DRM_PLANE_PIXEL_SOURCE_COLOR, "COLOR" },
>>> + };
>>> + unsigned int valid_source_mask = BIT(DRM_PLANE_PIXEL_SOURCE_FB) |
>>> + BIT(DRM_PLANE_PIXEL_SOURCE_COLOR);
>>
>>
>> static const?
Acked.
>>
>>> + int i;
>>> +
>>> + /* FB is supported by default */
>>> + supported_sources |= BIT(DRM_PLANE_PIXEL_SOURCE_FB);
>>> +
>>> + if (WARN_ON(supported_sources & ~valid_source_mask))
>>> + return -EINVAL;
>>> +
>>> + prop = drm_property_create(dev, DRM_MODE_PROP_ENUM, "pixel_source",
>
> Shouldn't this be an atomic prop?
Acked.
>
>
>>> + hweight32(supported_sources));
>>> +
>>> + if (!prop)
>>> + return -ENOMEM;
>>> +
>>> + for (i = 0; i < ARRAY_SIZE(enum_list); i++) {
>>> + int ret;
>>> +
>>> + if (!(BIT(enum_list[i].type) & supported_sources))
>>
>> test_bit?
Acked.
>>
>>> + continue;
>>> +
>>> + ret = drm_property_add_enum(prop, enum_list[i].type, enum_list[i].name);
>>> +
>>
>> No need for an empty line in such cases. Please drop it.
Acked.
>>
>>> + if (ret) {
>>> + drm_property_destroy(dev, prop);
>>> +
>>> + return ret;
>>> + }
>>> + }
>>> +
>>> + drm_object_attach_property(&plane->base, prop, DRM_PLANE_PIXEL_SOURCE_FB);
>>> + plane->pixel_source_property = prop;
>>> +
>>> + return 0;
>>> +}
>>> +EXPORT_SYMBOL(drm_plane_create_pixel_source_property);
>>> diff --git a/include/drm/drm_blend.h b/include/drm/drm_blend.h
>>> index 0338a860b9c8..31af7cfa5b1b 100644
>>> --- a/include/drm/drm_blend.h
>>> +++ b/include/drm/drm_blend.h
>>> @@ -59,4 +59,6 @@ int drm_atomic_normalize_zpos(struct drm_device *dev,
>>> int drm_plane_create_blend_mode_property(struct drm_plane *plane,
>>> unsigned int supported_modes);
>>> int drm_plane_create_solid_fill_property(struct drm_plane *plane);
>>> +int drm_plane_create_pixel_source_property(struct drm_plane *plane,
>>> + unsigned int supported_sources);
>>> #endif
>>> diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
>>> index f6ab313cb83e..73fb6cf8a5d9 100644
>>> --- a/include/drm/drm_plane.h
>>> +++ b/include/drm/drm_plane.h
>>> @@ -59,6 +59,12 @@ struct drm_solid_fill {
>>> uint32_t b;
>>> };
>>>
>>> +enum drm_plane_pixel_source {
>>> + DRM_PLANE_PIXEL_SOURCE_FB,
>>> + DRM_PLANE_PIXEL_SOURCE_COLOR,
>>> + DRM_PLANE_PIXEL_SOURCE_MAX
>>> +};
>
> Just to be very clear that I'm not confusing you with my comment about
> UAPI headers in the previous patch, this enum is already in a good
> place. It does not belong in a UAPI header, because userspace
> recognises enum values by the name string.
Got it.
Thanks,
Jessica Zhang
>
>
> Thanks,
> pq
>
>>> +
>>> /**
>>> * struct drm_plane_state - mutable plane state
>>> *
>>> @@ -152,6 +158,14 @@ struct drm_plane_state {
>>> */
>>> struct drm_solid_fill solid_fill;
>>>
>>> + /*
>>> + * @pixel_source:
>>> + *
>>> + * Source of pixel information for the plane. See
>>> + * drm_plane_create_pixel_source_property() for more details.
>>> + */
>>> + enum drm_plane_pixel_source pixel_source;
>>> +
>>> /**
>>> * @alpha:
>>> * Opacity of the plane with 0 as completely transparent and 0xffff as
>>> @@ -742,6 +756,13 @@ struct drm_plane {
>>> */
>>> struct drm_property *solid_fill_property;
>>>
>>> + /*
>>> + * @pixel_source_property:
>>> + * Optional pixel_source property for this plane. See
>>> + * drm_plane_create_pixel_source_property().
>>> + */
>>> + struct drm_property *pixel_source_property;
>>> +
>>> /**
>>> * @alpha_property:
>>> * Optional alpha property for this plane. See
>>>
>>
>
On 10/07/2023 22:51, Jessica Zhang wrote:
>
>
> On 6/30/2023 1:27 AM, Pekka Paalanen wrote:
>> On Fri, 30 Jun 2023 03:42:28 +0300
>> Dmitry Baryshkov <[email protected]> wrote:
>>
>>> On 30/06/2023 03:25, Jessica Zhang wrote:
>>>> Add support for pixel_source property to drm_plane and related
>>>> documentation.
>>>>
>>>> This enum property will allow user to specify a pixel source for the
>>>> plane. Possible pixel sources will be defined in the
>>>> drm_plane_pixel_source enum.
>>>>
>>>> The current possible pixel sources are DRM_PLANE_PIXEL_SOURCE_FB and
>>>> DRM_PLANE_PIXEL_SOURCE_COLOR. The default value is *_SOURCE_FB.
>>>
>>> I think, this should come before the solid fill property addition. First
>>> you tell that there is a possibility to define other pixel sources, then
>>> additional sources are defined.
>>
>> Hi,
>>
>> that would be logical indeed.
>
> Hi Dmitry and Pekka,
>
> Sorry for the delay in response, was out of office last week.
>
> Acked.
>
>>
>>>>
>>>> Signed-off-by: Jessica Zhang <[email protected]>
>>>> ---
>>>> drivers/gpu/drm/drm_atomic_state_helper.c | 1 +
>>>> drivers/gpu/drm/drm_atomic_uapi.c | 4 ++
>>>> drivers/gpu/drm/drm_blend.c | 81
>>>> +++++++++++++++++++++++++++++++
>>>> include/drm/drm_blend.h | 2 +
>>>> include/drm/drm_plane.h | 21 ++++++++
>>>> 5 files changed, 109 insertions(+)
>>>>
>>>> diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c
>>>> b/drivers/gpu/drm/drm_atomic_state_helper.c
>>>> index fe14be2bd2b2..86fb876efbe6 100644
>>>> --- a/drivers/gpu/drm/drm_atomic_state_helper.c
>>>> +++ b/drivers/gpu/drm/drm_atomic_state_helper.c
>>>> @@ -252,6 +252,7 @@ void
>>>> __drm_atomic_helper_plane_state_reset(struct drm_plane_state
>>>> *plane_state,
>>>> plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
>>>> plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
>>>> + plane_state->pixel_source = DRM_PLANE_PIXEL_SOURCE_FB;
>>>> if (plane_state->solid_fill_blob) {
>>>> drm_property_blob_put(plane_state->solid_fill_blob);
>>>> diff --git a/drivers/gpu/drm/drm_atomic_uapi.c
>>>> b/drivers/gpu/drm/drm_atomic_uapi.c
>>>> index a28b4ee79444..6e59c21af66b 100644
>>>> --- a/drivers/gpu/drm/drm_atomic_uapi.c
>>>> +++ b/drivers/gpu/drm/drm_atomic_uapi.c
>>>> @@ -596,6 +596,8 @@ static int drm_atomic_plane_set_property(struct
>>>> drm_plane *plane,
>>>> drm_property_blob_put(solid_fill);
>>>> return ret;
>>>> + } else if (property == plane->pixel_source_property) {
>>>> + state->pixel_source = val;
>>>> } else if (property == plane->alpha_property) {
>>>> state->alpha = val;
>>>> } else if (property == plane->blend_mode_property) {
>>>
>>> I think, it was pointed out in the discussion that drm_mode_setplane()
>>> (a pre-atomic IOCTL to turn the plane on and off) should also reset
>>> pixel_source to FB.
>
> I don't remember drm_mode_setplane() being mentioned in the pixel_source
> discussion... can you share where it was mentioned?
https://lore.kernel.org/dri-devel/20230627105849.004050b3@eldfell/
Let me quote it here:
"Legacy non-atomic UAPI wrappers can do whatever they want, and program
any (new) properties they want in order to implement the legacy
expectations, so that does not seem to be a problem."
>
> I'd prefer to avoid having driver change the pixel_source directly as it
> could cause some unexpected side effects. In general, I would like
> userspace to assign the value of pixel_source without driver doing
> anything "under the hood".
s/driver/drm core/
We have to remain compatible with old userspace, especially with the
non-atomic one. If the userspace calls ioctl(DRM_IOCTL_MODE_SETPLANE),
we have to display the specified FB, no matter what was the value of
PIXEL_SOURCE before this ioctl.
>
>>>
>>>> @@ -671,6 +673,8 @@ drm_atomic_plane_get_property(struct drm_plane
>>>> *plane,
>>>> } else if (property == plane->solid_fill_property) {
>>>> *val = state->solid_fill_blob ?
>>>> state->solid_fill_blob->base.id : 0;
>>>> + } else if (property == plane->pixel_source_property) {
>>>> + *val = state->pixel_source;
>>>> } else if (property == plane->alpha_property) {
>>>> *val = state->alpha;
>>>> } else if (property == plane->blend_mode_property) {
>>>> diff --git a/drivers/gpu/drm/drm_blend.c b/drivers/gpu/drm/drm_blend.c
>>>> index 38c3c5d6453a..8c100a957ee2 100644
>>>> --- a/drivers/gpu/drm/drm_blend.c
>>>> +++ b/drivers/gpu/drm/drm_blend.c
>>>> @@ -189,6 +189,18 @@
>>>> * solid_fill is set up with
>>>> drm_plane_create_solid_fill_property(). It
>>>> * contains pixel data that drivers can use to fill a plane.
>>>> *
>>>> + * pixel_source:
>>>> + * pixel_source is set up with
>>>> drm_plane_create_pixel_source_property().
>>>> + * It is used to toggle the source of pixel data for the plane.
>>
>> Other sources than the selected one are ignored?
>
> Yep, the plane will only display the data from the set pixel_source.
>
> So if pixel_source == FB and solid_fill_blob is non-NULL,
> solid_fill_blob will be ignored and the plane will display the FB that
> is set.
correct.
>
> Will add a note about this in the comment docs.
>
>>
>>>> + *
>>>> + * Possible values:
>>
>> Wouldn't hurt to explicitly mention here that this is an enum.
>
> Acked.
>
>>
>>>> + *
>>>> + * "FB":
>>>> + * Framebuffer source
>>>> + *
>>>> + * "COLOR":
>>>> + * solid_fill source
>>
>> I think these two should be more explicit. Framebuffer source is the
>> usual source from the property "FB_ID". Solid fill source comes from
>> the property "solid_fill".
>
> Acked.
>
>>
>> Why "COLOR" and not, say, "SOLID_FILL"?
>
> Ah, that would make more sense :)
>
> I'll change this to "SOLID_FILL".
>
>>
>>>> + *
>>>> * Note that all the property extensions described here apply
>>>> either to the
>>>> * plane or the CRTC (e.g. for the background color, which
>>>> currently is not
>>>> * exposed and assumed to be black).
>>>> @@ -648,3 +660,72 @@ int drm_plane_create_solid_fill_property(struct
>>>> drm_plane *plane)
>>>> return 0;
>>>> }
>>>> EXPORT_SYMBOL(drm_plane_create_solid_fill_property);
>>>> +
>>>> +/**
>>>> + * drm_plane_create_pixel_source_property - create a new pixel
>>>> source property
>>>> + * @plane: drm plane
>>>> + * @supported_sources: bitmask of supported pixel_sources for the
>>>> driver (NOT
>>>> + * including DRM_PLANE_PIXEL_SOURCE_FB, as it
>>>> will be supported
>>>> + * by default).
>>>
>>> I'd say this is too strong. I'd suggest either renaming this to
>>> extra_sources (mentioning that FB is enabled for all the planes) or
>>> allowing any source bitmask (mentioning that FB should be enabled by the
>>> caller, unless there is a good reason not to do so).
>>
>> Right. I don't see any problem with having planes of type OVERLAY that
>> support only solid_fill and no FB. Planes of type PRIMARY and CURSOR I
>> would expect to always support at least FB.
>>
>> Atomic userspace is prepared to have an OVERLAY plane fail for any
>> arbitrary reason. Legacy userspace probably should not ever see a plane
>> that does not support FB.
>
> Got it... If we allow the possibility of FB sources not being supported,
> then should the default pixel_source per plane be decided by the driver
> too?
>
> I'd forced FB support so that I could set pixel_source to FB in
> __drm_atomic_helper_plane_state_reset(). If we allow more flexibility in
> the default pixel_source value, I guess we can also store a
> default_pixel_source value in the plane_state.
I'd say, the FB is a sane default. It the driver has other needs, it can
override the value in drm_plane_funcs::reset().
>
[skipped the rest]
--
With best wishes
Dmitry
On 6/30/2023 1:27 AM, Pekka Paalanen wrote:
> On Thu, 29 Jun 2023 17:25:00 -0700
> Jessica Zhang <[email protected]> wrote:
>
>> Document and add support for solid_fill property to drm_plane. In
>> addition, add support for setting and getting the values for solid_fill.
>>
>> To enable solid fill planes, userspace must assign a property blob to
>> the "solid_fill" plane property containing the following information:
>>
>> struct drm_solid_fill_info {
>> u8 version;
>> u32 r, g, b;
>> };
>>
>> Signed-off-by: Jessica Zhang <[email protected]>
>
> Hi Jessica,
>
> I've left some general UAPI related comments here.
>
>> ---
>> drivers/gpu/drm/drm_atomic_state_helper.c | 9 +++++
>> drivers/gpu/drm/drm_atomic_uapi.c | 55 +++++++++++++++++++++++++++++++
>> drivers/gpu/drm/drm_blend.c | 33 +++++++++++++++++++
>> include/drm/drm_blend.h | 1 +
>> include/drm/drm_plane.h | 43 ++++++++++++++++++++++++
>> 5 files changed, 141 insertions(+)
>>
>> diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c b/drivers/gpu/drm/drm_atomic_state_helper.c
>> index 784e63d70a42..fe14be2bd2b2 100644
>> --- a/drivers/gpu/drm/drm_atomic_state_helper.c
>> +++ b/drivers/gpu/drm/drm_atomic_state_helper.c
>> @@ -253,6 +253,11 @@ void __drm_atomic_helper_plane_state_reset(struct drm_plane_state *plane_state,
>> plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
>> plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
>>
>> + if (plane_state->solid_fill_blob) {
>> + drm_property_blob_put(plane_state->solid_fill_blob);
>> + plane_state->solid_fill_blob = NULL;
>> + }
>> +
>> if (plane->color_encoding_property) {
>> if (!drm_object_property_get_default_value(&plane->base,
>> plane->color_encoding_property,
>> @@ -335,6 +340,9 @@ void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
>> if (state->fb)
>> drm_framebuffer_get(state->fb);
>>
>> + if (state->solid_fill_blob)
>> + drm_property_blob_get(state->solid_fill_blob);
>> +
>> state->fence = NULL;
>> state->commit = NULL;
>> state->fb_damage_clips = NULL;
>> @@ -384,6 +392,7 @@ void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state)
>> drm_crtc_commit_put(state->commit);
>>
>> drm_property_blob_put(state->fb_damage_clips);
>> + drm_property_blob_put(state->solid_fill_blob);
>> }
>> EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
>>
>> diff --git a/drivers/gpu/drm/drm_atomic_uapi.c b/drivers/gpu/drm/drm_atomic_uapi.c
>> index d867e7f9f2cd..a28b4ee79444 100644
>> --- a/drivers/gpu/drm/drm_atomic_uapi.c
>> +++ b/drivers/gpu/drm/drm_atomic_uapi.c
>> @@ -316,6 +316,51 @@ drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
>> }
>> EXPORT_SYMBOL(drm_atomic_set_crtc_for_connector);
>>
>> +static int drm_atomic_set_solid_fill_prop(struct drm_plane_state *state,
>> + struct drm_property_blob *blob)
>> +{
>> + int ret = 0;
>> + int blob_version;
>> +
>> + if (blob == state->solid_fill_blob)
>> + return 0;
>> +
>> + drm_property_blob_put(state->solid_fill_blob);
>> + state->solid_fill_blob = NULL;
>
> Is it ok to destroy old state before it is guaranteed that the new
> state is accepted?
Hi Pekka,
Good point. I'll change this behavior so that an error case will keep
the old solid_fill_blob value.
>
>> +
>> + memset(&state->solid_fill, 0, sizeof(state->solid_fill));
>> +
>> + if (blob) {
>> + struct drm_solid_fill_info *user_info = (struct drm_solid_fill_info *)blob->data;
>> +
>> + if (blob->length != sizeof(struct drm_solid_fill_info)) {
>> + drm_dbg_atomic(state->plane->dev,
>> + "[PLANE:%d:%s] bad solid fill blob length: %zu\n",
>> + state->plane->base.id, state->plane->name,
>> + blob->length);
>> + return -EINVAL;
>> + }
>> +
>> + blob_version = user_info->version;
>> +
>> + /* Add more versions if necessary */
>> + if (blob_version == 1) {
>> + state->solid_fill.r = user_info->r;
>> + state->solid_fill.g = user_info->g;
>> + state->solid_fill.b = user_info->b;
>> + } else {
>> + drm_dbg_atomic(state->plane->dev,
>> + "[PLANE:%d:%s] failed to set solid fill (ret=%d)\n",
>> + state->plane->base.id, state->plane->name,
>> + ret);
>> + return -EINVAL;
>
> Btw. how does the atomic check machinery work here?
>
> I expect that a TEST_ONLY atomic commit will do all the above checks
> and return failure if anything is not right. Right?
Correct, drm_atomic_set_property() will still be called for a TEST_ONLY
commit, so these checks will still happen and return an error (or set
the property) when appropriate.
>
>> + }
>> + state->solid_fill_blob = drm_property_blob_get(blob);
>> + }
>> +
>> + return ret;
>> +}
>> +
>> static void set_out_fence_for_crtc(struct drm_atomic_state *state,
>> struct drm_crtc *crtc, s32 __user *fence_ptr)
>> {
>> @@ -544,6 +589,13 @@ static int drm_atomic_plane_set_property(struct drm_plane *plane,
>> state->src_w = val;
>> } else if (property == config->prop_src_h) {
>> state->src_h = val;
>> + } else if (property == plane->solid_fill_property) {
>> + struct drm_property_blob *solid_fill = drm_property_lookup_blob(dev, val);
>> +
>> + ret = drm_atomic_set_solid_fill_prop(state, solid_fill);
>> + drm_property_blob_put(solid_fill);
>> +
>> + return ret;
>> } else if (property == plane->alpha_property) {
>> state->alpha = val;
>> } else if (property == plane->blend_mode_property) {
>> @@ -616,6 +668,9 @@ drm_atomic_plane_get_property(struct drm_plane *plane,
>> *val = state->src_w;
>> } else if (property == config->prop_src_h) {
>> *val = state->src_h;
>> + } else if (property == plane->solid_fill_property) {
>> + *val = state->solid_fill_blob ?
>> + state->solid_fill_blob->base.id : 0;
>> } else if (property == plane->alpha_property) {
>> *val = state->alpha;
>> } else if (property == plane->blend_mode_property) {
>> diff --git a/drivers/gpu/drm/drm_blend.c b/drivers/gpu/drm/drm_blend.c
>> index 6e74de833466..38c3c5d6453a 100644
>> --- a/drivers/gpu/drm/drm_blend.c
>> +++ b/drivers/gpu/drm/drm_blend.c
>> @@ -185,6 +185,10 @@
>> * plane does not expose the "alpha" property, then this is
>> * assumed to be 1.0
>> *
>> + * solid_fill:
>> + * solid_fill is set up with drm_plane_create_solid_fill_property(). It
>> + * contains pixel data that drivers can use to fill a plane.
>
> This is a nice start, but I feel it needs to explain much more about
> how userspace should go about making use of this.
>
> Yeah, the pixel_source property comes in the next patch, but I feel
> that it is harder to review if the doc is built over multiple patches.
> My personal approach would be to write the doc in full and referring to
> pixel_source property already, and explain in the commit message that
> the next patch will add pixel_source so people don't wonder about
> referring to a non-existing property.
>
> I mean just a reference to pixel_source, and leave the actual
> pixel_source doc for the patch adding the property like it already is.
>
> Dmitry's suggestion of swapping the patch order is good too.
Makes sense. I'll switch the patch order, but will keep this in mind.
>
>> + *
>> * Note that all the property extensions described here apply either to the
>> * plane or the CRTC (e.g. for the background color, which currently is not
>> * exposed and assumed to be black).
>> @@ -615,3 +619,32 @@ int drm_plane_create_blend_mode_property(struct drm_plane *plane,
>> return 0;
>> }
>> EXPORT_SYMBOL(drm_plane_create_blend_mode_property);
>> +
>> +/**
>> + * drm_plane_create_solid_fill_property - create a new solid_fill property
>> + * @plane: drm plane
>> + *
>> + * This creates a new property that holds pixel data for solid fill planes. This
>> + * property is exposed to userspace as a property blob called "solid_fill".
>> + *
>> + * For information on what the blob contains, see `drm_solid_fill_info`.
>
> I think you should be more explicit here. For example: the blob must
> contain exactly one struct drm_solid_fill_info.
>
> It's better to put this content spec with the UAPI doc rather than in this
> kerner-internal function doc that userspace programmers won't know to
> look at.
Acked.
>
>> + *
>> + * Returns:
>> + * Zero on success, negative errno on failure.
>> + */
>> +int drm_plane_create_solid_fill_property(struct drm_plane *plane)
>> +{
>> + struct drm_property *prop;
>> +
>> + prop = drm_property_create(plane->dev,
>> + DRM_MODE_PROP_ATOMIC | DRM_MODE_PROP_BLOB,
>> + "solid_fill", 0);
>> + if (!prop)
>> + return -ENOMEM;
>> +
>> + drm_object_attach_property(&plane->base, prop, 0);
>> + plane->solid_fill_property = prop;
>> +
>> + return 0;
>> +}
>> +EXPORT_SYMBOL(drm_plane_create_solid_fill_property);
>> diff --git a/include/drm/drm_blend.h b/include/drm/drm_blend.h
>> index 88bdfec3bd88..0338a860b9c8 100644
>> --- a/include/drm/drm_blend.h
>> +++ b/include/drm/drm_blend.h
>> @@ -58,4 +58,5 @@ int drm_atomic_normalize_zpos(struct drm_device *dev,
>> struct drm_atomic_state *state);
>> int drm_plane_create_blend_mode_property(struct drm_plane *plane,
>> unsigned int supported_modes);
>> +int drm_plane_create_solid_fill_property(struct drm_plane *plane);
>> #endif
>> diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
>> index 51291983ea44..f6ab313cb83e 100644
>> --- a/include/drm/drm_plane.h
>> +++ b/include/drm/drm_plane.h
>> @@ -40,6 +40,25 @@ enum drm_scaling_filter {
>> DRM_SCALING_FILTER_NEAREST_NEIGHBOR,
>> };
>>
>> +/**
>> + * struct drm_solid_fill_info - User info for solid fill planes
>> + */
>> +struct drm_solid_fill_info {
>> + __u8 version;
>> + __u32 r, g, b;
>> +};
>
> Shouldn't UAPI structs be in UAPI headers?
Acked, will move this to uapi/drm_mode.h
>
> Shouldn't UAPI structs use explicit padding to not leave any gaps when
> it's unavoidable? And the kernel to check that the gaps are indeed
> zeroed?
I don't believe so... From my understanding, padding will be taken care
of by the compiler by default. Looking at the drm_mode_modeinfo UAPI
struct [1], it also doesn't seem to do explicit padding. And the
corresponding set_property() code doesn't seem check the gaps either.
That being said, it's possible that I'm missing something here, so
please let me know if that's the case.
[1]
https://elixir.bootlin.com/linux/v6.5-rc1/source/include/uapi/drm/drm_mode.h#L242
>
> It also needs more UAPI doc, like a link to the property doc that uses
> this and an explanation of what the values mean.
Acked.
Thanks,
Jessica Zhang
>
>
> Thanks,
> pq
>
>> +
>> +/**
>> + * struct solid_fill_property - RGB values for solid fill plane
>> + *
>> + * Note: This is the V1 for this feature
>> + */
>> +struct drm_solid_fill {
>> + uint32_t r;
>> + uint32_t g;
>> + uint32_t b;
>> +};
>> +
>> /**
>> * struct drm_plane_state - mutable plane state
>> *
>> @@ -116,6 +135,23 @@ struct drm_plane_state {
>> /** @src_h: height of visible portion of plane (in 16.16) */
>> uint32_t src_h, src_w;
>>
>> + /**
>> + * @solid_fill_blob:
>> + *
>> + * Blob containing relevant information for a solid fill plane
>> + * including pixel format and data. See
>> + * drm_plane_create_solid_fill_property() for more details.
>> + */
>> + struct drm_property_blob *solid_fill_blob;
>> +
>> + /**
>> + * @solid_fill:
>> + *
>> + * Pixel data for solid fill planes. See
>> + * drm_plane_create_solid_fill_property() for more details.
>> + */
>> + struct drm_solid_fill solid_fill;
>> +
>> /**
>> * @alpha:
>> * Opacity of the plane with 0 as completely transparent and 0xffff as
>> @@ -699,6 +735,13 @@ struct drm_plane {
>> */
>> struct drm_plane_state *state;
>>
>> + /*
>> + * @solid_fill_property:
>> + * Optional solid_fill property for this plane. See
>> + * drm_plane_create_solid_fill_property().
>> + */
>> + struct drm_property *solid_fill_property;
>> +
>> /**
>> * @alpha_property:
>> * Optional alpha property for this plane. See
>>
>
On Mon, 10 Jul 2023 16:12:06 -0700
Jessica Zhang <[email protected]> wrote:
> On 6/30/2023 1:27 AM, Pekka Paalanen wrote:
> > On Thu, 29 Jun 2023 17:25:00 -0700
> > Jessica Zhang <[email protected]> wrote:
> >
> >> Document and add support for solid_fill property to drm_plane. In
> >> addition, add support for setting and getting the values for solid_fill.
> >>
> >> To enable solid fill planes, userspace must assign a property blob to
> >> the "solid_fill" plane property containing the following information:
> >>
> >> struct drm_solid_fill_info {
> >> u8 version;
> >> u32 r, g, b;
> >> };
> >>
> >> Signed-off-by: Jessica Zhang <[email protected]>
> >
> > Hi Jessica,
> >
> > I've left some general UAPI related comments here.
> >
> >> ---
> >> drivers/gpu/drm/drm_atomic_state_helper.c | 9 +++++
> >> drivers/gpu/drm/drm_atomic_uapi.c | 55 +++++++++++++++++++++++++++++++
> >> drivers/gpu/drm/drm_blend.c | 33 +++++++++++++++++++
> >> include/drm/drm_blend.h | 1 +
> >> include/drm/drm_plane.h | 43 ++++++++++++++++++++++++
> >> 5 files changed, 141 insertions(+)
...
> >> diff --git a/include/drm/drm_blend.h b/include/drm/drm_blend.h
> >> index 88bdfec3bd88..0338a860b9c8 100644
> >> --- a/include/drm/drm_blend.h
> >> +++ b/include/drm/drm_blend.h
> >> @@ -58,4 +58,5 @@ int drm_atomic_normalize_zpos(struct drm_device *dev,
> >> struct drm_atomic_state *state);
> >> int drm_plane_create_blend_mode_property(struct drm_plane *plane,
> >> unsigned int supported_modes);
> >> +int drm_plane_create_solid_fill_property(struct drm_plane *plane);
> >> #endif
> >> diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
> >> index 51291983ea44..f6ab313cb83e 100644
> >> --- a/include/drm/drm_plane.h
> >> +++ b/include/drm/drm_plane.h
> >> @@ -40,6 +40,25 @@ enum drm_scaling_filter {
> >> DRM_SCALING_FILTER_NEAREST_NEIGHBOR,
> >> };
> >>
> >> +/**
> >> + * struct drm_solid_fill_info - User info for solid fill planes
> >> + */
> >> +struct drm_solid_fill_info {
> >> + __u8 version;
> >> + __u32 r, g, b;
> >> +};
> >
> > Shouldn't UAPI structs be in UAPI headers?
>
> Acked, will move this to uapi/drm_mode.h
>
> >
> > Shouldn't UAPI structs use explicit padding to not leave any gaps when
> > it's unavoidable? And the kernel to check that the gaps are indeed
> > zeroed?
>
> I don't believe so... From my understanding, padding will be taken care
> of by the compiler by default. Looking at the drm_mode_modeinfo UAPI
> struct [1], it also doesn't seem to do explicit padding. And the
> corresponding set_property() code doesn't seem check the gaps either.
>
> That being said, it's possible that I'm missing something here, so
> please let me know if that's the case.
>
> [1]
> https://elixir.bootlin.com/linux/v6.5-rc1/source/include/uapi/drm/drm_mode.h#L242
I suspect that drm_mode_modeinfo predates the lessons learnt about
"botching up ioctls" by many years:
https://www.kernel.org/doc/Documentation/ioctl/botching-up-ioctls.rst
drm_mode_modeinfo goes all the way back to
commit f453ba0460742ad027ae0c4c7d61e62817b3e7ef
Date: Fri Nov 7 14:05:41 2008 -0800
DRM: add mode setting support
and
commit e0c8463a8b00b467611607df0ff369d062528875
Date: Fri Dec 19 14:50:50 2008 +1000
drm: sanitise drm modesetting API + remove unused hotplug
and it got the proper types later in
commit 1d7f83d5ad6c30b385ba549c1c3a287cc872b7ae
Date: Thu Feb 26 00:51:42 2009 +0100
make drm headers use strict integer types
My personal feeling is that if you cannot avoid padding in a struct,
convert it into explicit fields anyway and require them to be zero.
That way if you ever need to extend or modify the struct, you already
have an "unused" field that old userspace guarantees to be zero, so you
can re-purpose it when it's not zero.
A struct for blob contents is maybe needing slightly less forward
planning than ioctl struct, because KMS properties are cheap compared
to ioctl numbers, I believe.
Maybe eliminating compiler induced padding in structs is not strictly
necessary, but it seems like a good idea to me, because compilers are
allowed to leave the padding bits undefined. If a struct was filled in
by the kernel and delivered to userspace, undefined padding could even
be a security leak, theoretically.
Anyway, don't take my word for it. Maybe kernel devs have a different
style.
Thanks,
pq
> >
> > It also needs more UAPI doc, like a link to the property doc that uses
> > this and an explanation of what the values mean.
>
> Acked.
>
> Thanks,
>
> Jessica Zhang
>
> >
> >
> > Thanks,
> > pq
> >
> >> +
> >> +/**
> >> + * struct solid_fill_property - RGB values for solid fill plane
> >> + *
> >> + * Note: This is the V1 for this feature
> >> + */
> >> +struct drm_solid_fill {
> >> + uint32_t r;
> >> + uint32_t g;
> >> + uint32_t b;
> >> +};
> >> +
> >> /**
> >> * struct drm_plane_state - mutable plane state
> >> *
> >> @@ -116,6 +135,23 @@ struct drm_plane_state {
> >> /** @src_h: height of visible portion of plane (in 16.16) */
> >> uint32_t src_h, src_w;
> >>
> >> + /**
> >> + * @solid_fill_blob:
> >> + *
> >> + * Blob containing relevant information for a solid fill plane
> >> + * including pixel format and data. See
> >> + * drm_plane_create_solid_fill_property() for more details.
> >> + */
> >> + struct drm_property_blob *solid_fill_blob;
> >> +
> >> + /**
> >> + * @solid_fill:
> >> + *
> >> + * Pixel data for solid fill planes. See
> >> + * drm_plane_create_solid_fill_property() for more details.
> >> + */
> >> + struct drm_solid_fill solid_fill;
> >> +
> >> /**
> >> * @alpha:
> >> * Opacity of the plane with 0 as completely transparent and 0xffff as
> >> @@ -699,6 +735,13 @@ struct drm_plane {
> >> */
> >> struct drm_plane_state *state;
> >>
> >> + /*
> >> + * @solid_fill_property:
> >> + * Optional solid_fill property for this plane. See
> >> + * drm_plane_create_solid_fill_property().
> >> + */
> >> + struct drm_property *solid_fill_property;
> >> +
> >> /**
> >> * @alpha_property:
> >> * Optional alpha property for this plane. See
> >>
> >
On 7/11/2023 12:42 AM, Pekka Paalanen wrote:
> On Mon, 10 Jul 2023 16:12:06 -0700
> Jessica Zhang <[email protected]> wrote:
>
>> On 6/30/2023 1:27 AM, Pekka Paalanen wrote:
>>> On Thu, 29 Jun 2023 17:25:00 -0700
>>> Jessica Zhang <[email protected]> wrote:
>>>
>>>> Document and add support for solid_fill property to drm_plane. In
>>>> addition, add support for setting and getting the values for solid_fill.
>>>>
>>>> To enable solid fill planes, userspace must assign a property blob to
>>>> the "solid_fill" plane property containing the following information:
>>>>
>>>> struct drm_solid_fill_info {
>>>> u8 version;
>>>> u32 r, g, b;
>>>> };
>>>>
>>>> Signed-off-by: Jessica Zhang <[email protected]>
>>>
>>> Hi Jessica,
>>>
>>> I've left some general UAPI related comments here.
>>>
>>>> ---
>>>> drivers/gpu/drm/drm_atomic_state_helper.c | 9 +++++
>>>> drivers/gpu/drm/drm_atomic_uapi.c | 55 +++++++++++++++++++++++++++++++
>>>> drivers/gpu/drm/drm_blend.c | 33 +++++++++++++++++++
>>>> include/drm/drm_blend.h | 1 +
>>>> include/drm/drm_plane.h | 43 ++++++++++++++++++++++++
>>>> 5 files changed, 141 insertions(+)
>
> ...
>
>>>> diff --git a/include/drm/drm_blend.h b/include/drm/drm_blend.h
>>>> index 88bdfec3bd88..0338a860b9c8 100644
>>>> --- a/include/drm/drm_blend.h
>>>> +++ b/include/drm/drm_blend.h
>>>> @@ -58,4 +58,5 @@ int drm_atomic_normalize_zpos(struct drm_device *dev,
>>>> struct drm_atomic_state *state);
>>>> int drm_plane_create_blend_mode_property(struct drm_plane *plane,
>>>> unsigned int supported_modes);
>>>> +int drm_plane_create_solid_fill_property(struct drm_plane *plane);
>>>> #endif
>>>> diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
>>>> index 51291983ea44..f6ab313cb83e 100644
>>>> --- a/include/drm/drm_plane.h
>>>> +++ b/include/drm/drm_plane.h
>>>> @@ -40,6 +40,25 @@ enum drm_scaling_filter {
>>>> DRM_SCALING_FILTER_NEAREST_NEIGHBOR,
>>>> };
>>>>
>>>> +/**
>>>> + * struct drm_solid_fill_info - User info for solid fill planes
>>>> + */
>>>> +struct drm_solid_fill_info {
>>>> + __u8 version;
>>>> + __u32 r, g, b;
>>>> +};
>>>
>>> Shouldn't UAPI structs be in UAPI headers?
>>
>> Acked, will move this to uapi/drm_mode.h
>>
>>>
>>> Shouldn't UAPI structs use explicit padding to not leave any gaps when
>>> it's unavoidable? And the kernel to check that the gaps are indeed
>>> zeroed?
>>
>> I don't believe so... From my understanding, padding will be taken care
>> of by the compiler by default. Looking at the drm_mode_modeinfo UAPI
>> struct [1], it also doesn't seem to do explicit padding. And the
>> corresponding set_property() code doesn't seem check the gaps either.
>>
>> That being said, it's possible that I'm missing something here, so
>> please let me know if that's the case.
>>
>> [1]
>> https://elixir.bootlin.com/linux/v6.5-rc1/source/include/uapi/drm/drm_mode.h#L242
>
> I suspect that drm_mode_modeinfo predates the lessons learnt about
> "botching up ioctls" by many years:
> https://www.kernel.org/doc/Documentation/ioctl/botching-up-ioctls.rst
>
> drm_mode_modeinfo goes all the way back to
>
> commit f453ba0460742ad027ae0c4c7d61e62817b3e7ef
> Date: Fri Nov 7 14:05:41 2008 -0800
>
> DRM: add mode setting support
>
> and
>
> commit e0c8463a8b00b467611607df0ff369d062528875
> Date: Fri Dec 19 14:50:50 2008 +1000
>
> drm: sanitise drm modesetting API + remove unused hotplug
>
> and it got the proper types later in
>
> commit 1d7f83d5ad6c30b385ba549c1c3a287cc872b7ae
> Date: Thu Feb 26 00:51:42 2009 +0100
>
> make drm headers use strict integer types
>
>
> My personal feeling is that if you cannot avoid padding in a struct,
> convert it into explicit fields anyway and require them to be zero.
> That way if you ever need to extend or modify the struct, you already
> have an "unused" field that old userspace guarantees to be zero, so you
> can re-purpose it when it's not zero.
>
> A struct for blob contents is maybe needing slightly less forward
> planning than ioctl struct, because KMS properties are cheap compared
> to ioctl numbers, I believe.
>
> Maybe eliminating compiler induced padding in structs is not strictly
> necessary, but it seems like a good idea to me, because compilers are
> allowed to leave the padding bits undefined. If a struct was filled in
> by the kernel and delivered to userspace, undefined padding could even
> be a security leak, theoretically.
>
> Anyway, don't take my word for it. Maybe kernel devs have a different
> style.
Ah, got it. Thanks for the info! Looking over more recent
implementations of blob properties, I do see that there's a precedent
for explicit padding [1].
I think I could also just make `version` a __u32 instead. Either way,
that seems to be how other structs declare `version`.
Thanks,
Jessica Zhang
[1]
https://elixir.bootlin.com/linux/latest/source/include/uapi/drm/virtgpu_drm.h#L178
>
>
> Thanks,
> pq
>
>>>
>>> It also needs more UAPI doc, like a link to the property doc that uses
>>> this and an explanation of what the values mean.
>>
>> Acked.
>>
>> Thanks,
>>
>> Jessica Zhang
>>
>>>
>>>
>>> Thanks,
>>> pq
>>>
>>>> +
>>>> +/**
>>>> + * struct solid_fill_property - RGB values for solid fill plane
>>>> + *
>>>> + * Note: This is the V1 for this feature
>>>> + */
>>>> +struct drm_solid_fill {
>>>> + uint32_t r;
>>>> + uint32_t g;
>>>> + uint32_t b;
>>>> +};
>>>> +
>>>> /**
>>>> * struct drm_plane_state - mutable plane state
>>>> *
>>>> @@ -116,6 +135,23 @@ struct drm_plane_state {
>>>> /** @src_h: height of visible portion of plane (in 16.16) */
>>>> uint32_t src_h, src_w;
>>>>
>>>> + /**
>>>> + * @solid_fill_blob:
>>>> + *
>>>> + * Blob containing relevant information for a solid fill plane
>>>> + * including pixel format and data. See
>>>> + * drm_plane_create_solid_fill_property() for more details.
>>>> + */
>>>> + struct drm_property_blob *solid_fill_blob;
>>>> +
>>>> + /**
>>>> + * @solid_fill:
>>>> + *
>>>> + * Pixel data for solid fill planes. See
>>>> + * drm_plane_create_solid_fill_property() for more details.
>>>> + */
>>>> + struct drm_solid_fill solid_fill;
>>>> +
>>>> /**
>>>> * @alpha:
>>>> * Opacity of the plane with 0 as completely transparent and 0xffff as
>>>> @@ -699,6 +735,13 @@ struct drm_plane {
>>>> */
>>>> struct drm_plane_state *state;
>>>>
>>>> + /*
>>>> + * @solid_fill_property:
>>>> + * Optional solid_fill property for this plane. See
>>>> + * drm_plane_create_solid_fill_property().
>>>> + */
>>>> + struct drm_property *solid_fill_property;
>>>> +
>>>> /**
>>>> * @alpha_property:
>>>> * Optional alpha property for this plane. See
>>>>
>>>
>
On 7/10/2023 1:11 PM, Dmitry Baryshkov wrote:
> On 10/07/2023 22:51, Jessica Zhang wrote:
>>
>>
>> On 6/30/2023 1:27 AM, Pekka Paalanen wrote:
>>> On Fri, 30 Jun 2023 03:42:28 +0300
>>> Dmitry Baryshkov <[email protected]> wrote:
>>>
>>>> On 30/06/2023 03:25, Jessica Zhang wrote:
>>>>> Add support for pixel_source property to drm_plane and related
>>>>> documentation.
>>>>>
>>>>> This enum property will allow user to specify a pixel source for the
>>>>> plane. Possible pixel sources will be defined in the
>>>>> drm_plane_pixel_source enum.
>>>>>
>>>>> The current possible pixel sources are DRM_PLANE_PIXEL_SOURCE_FB and
>>>>> DRM_PLANE_PIXEL_SOURCE_COLOR. The default value is *_SOURCE_FB.
>>>>
>>>> I think, this should come before the solid fill property addition.
>>>> First
>>>> you tell that there is a possibility to define other pixel sources,
>>>> then
>>>> additional sources are defined.
>>>
>>> Hi,
>>>
>>> that would be logical indeed.
>>
>> Hi Dmitry and Pekka,
>>
>> Sorry for the delay in response, was out of office last week.
>>
>> Acked.
>>
>>>
>>>>>
>>>>> Signed-off-by: Jessica Zhang <[email protected]>
>>>>> ---
>>>>> drivers/gpu/drm/drm_atomic_state_helper.c | 1 +
>>>>> drivers/gpu/drm/drm_atomic_uapi.c | 4 ++
>>>>> drivers/gpu/drm/drm_blend.c | 81
>>>>> +++++++++++++++++++++++++++++++
>>>>> include/drm/drm_blend.h | 2 +
>>>>> include/drm/drm_plane.h | 21 ++++++++
>>>>> 5 files changed, 109 insertions(+)
>>>>>
>>>>> diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c
>>>>> b/drivers/gpu/drm/drm_atomic_state_helper.c
>>>>> index fe14be2bd2b2..86fb876efbe6 100644
>>>>> --- a/drivers/gpu/drm/drm_atomic_state_helper.c
>>>>> +++ b/drivers/gpu/drm/drm_atomic_state_helper.c
>>>>> @@ -252,6 +252,7 @@ void
>>>>> __drm_atomic_helper_plane_state_reset(struct drm_plane_state
>>>>> *plane_state,
>>>>> plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
>>>>> plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
>>>>> + plane_state->pixel_source = DRM_PLANE_PIXEL_SOURCE_FB;
>>>>> if (plane_state->solid_fill_blob) {
>>>>> drm_property_blob_put(plane_state->solid_fill_blob);
>>>>> diff --git a/drivers/gpu/drm/drm_atomic_uapi.c
>>>>> b/drivers/gpu/drm/drm_atomic_uapi.c
>>>>> index a28b4ee79444..6e59c21af66b 100644
>>>>> --- a/drivers/gpu/drm/drm_atomic_uapi.c
>>>>> +++ b/drivers/gpu/drm/drm_atomic_uapi.c
>>>>> @@ -596,6 +596,8 @@ static int drm_atomic_plane_set_property(struct
>>>>> drm_plane *plane,
>>>>> drm_property_blob_put(solid_fill);
>>>>> return ret;
>>>>> + } else if (property == plane->pixel_source_property) {
>>>>> + state->pixel_source = val;
>>>>> } else if (property == plane->alpha_property) {
>>>>> state->alpha = val;
>>>>> } else if (property == plane->blend_mode_property) {
>>>>
>>>> I think, it was pointed out in the discussion that drm_mode_setplane()
>>>> (a pre-atomic IOCTL to turn the plane on and off) should also reset
>>>> pixel_source to FB.
>>
>> I don't remember drm_mode_setplane() being mentioned in the
>> pixel_source discussion... can you share where it was mentioned?
>
> https://lore.kernel.org/dri-devel/20230627105849.004050b3@eldfell/
>
> Let me quote it here:
> "Legacy non-atomic UAPI wrappers can do whatever they want, and program
> any (new) properties they want in order to implement the legacy
> expectations, so that does not seem to be a problem."
>
>
>>
>> I'd prefer to avoid having driver change the pixel_source directly as
>> it could cause some unexpected side effects. In general, I would like
>> userspace to assign the value of pixel_source without driver doing
>> anything "under the hood".
>
> s/driver/drm core/
>
> We have to remain compatible with old userspace, especially with the
> non-atomic one. If the userspace calls ioctl(DRM_IOCTL_MODE_SETPLANE),
> we have to display the specified FB, no matter what was the value of
> PIXEL_SOURCE before this ioctl.
Got it, thanks the clarification -- I see your point.
I'm already setting plane_state->pixel_source to FB in
__drm_atomic_helper_plane_reset() and it seems to me that all drivers
are calling that within their respective plane_funcs->reset().
Since (as far as I know) reset() is being called for both the atomic and
non-atomic paths, shouldn't that be enough to default pixel_source to FB
for old userspace?
Thanks,
Jessica Zhang
>
>
>>
>>>>
>>>>> @@ -671,6 +673,8 @@ drm_atomic_plane_get_property(struct drm_plane
>>>>> *plane,
>>>>> } else if (property == plane->solid_fill_property) {
>>>>> *val =state->solid_fill_blob ?
>>>>> state->solid_fill_blob->base.id : 0;
>>>>> + } else if (property == plane->pixel_source_property) {
>>>>> + *val = state->pixel_source;
>>>>> } else if (property == plane->alpha_property) {
>>>>> *val =state->alpha;
>>>>> } else if (property == plane->blend_mode_property) {
>>>>> diff --git a/drivers/gpu/drm/drm_blend.c b/drivers/gpu/drm/drm_blend.c
>>>>> index 38c3c5d6453a..8c100a957ee2 100644
>>>>> --- a/drivers/gpu/drm/drm_blend.c
>>>>> +++ b/drivers/gpu/drm/drm_blend.c
>>>>> @@ -189,6 +189,18 @@
>>>>> * solid_fill is set up with
>>>>> drm_plane_create_solid_fill_property(). It
>>>>> * contains pixel data that drivers can use to fill a plane.
>>>>> *
>>>>> + * pixel_source:
>>>>> + * pixel_source is set up with
>>>>> drm_plane_create_pixel_source_property().
>>>>> + * It is used to toggle the source of pixel data for the plane.
>>>
>>> Other sources than the selected one are ignored?
>>
>> Yep, the plane will only display the data from the set pixel_source.
>>
>> So if pixel_source == FB and solid_fill_blob is non-NULL,
>> solid_fill_blob will be ignored and the plane will display the FB that
>> is set.
>
> correct.
>
>>
>> Will add a note about this in the comment docs.
>>
>>>
>>>>> + *
>>>>> + * Possible values:
>>>
>>> Wouldn't hurt to explicitly mention here that this is an enum.
>>
>> Acked.
>>
>>>
>>>>> + *
>>>>> + * "FB":
>>>>> + * Framebuffer source
>>>>> + *
>>>>> + * "COLOR":
>>>>> + * solid_fill source
>>>
>>> I think these two should be more explicit. Framebuffer source is the
>>> usual source from the property "FB_ID". Solid fill source comes from
>>> the property "solid_fill".
>>
>> Acked.
>>
>>>
>>> Why "COLOR" and not, say, "SOLID_FILL"?
>>
>> Ah, that would make more sense :)
>>
>> I'll change this to "SOLID_FILL".
>>
>>>
>>>>> + *
>>>>> * Note that all the property extensions described here apply
>>>>> either to the
>>>>> * plane or the CRTC (e.g. for the background color, which
>>>>> currently is not
>>>>> * exposed and assumed to be black).
>>>>> @@ -648,3 +660,72 @@ int
>>>>> drm_plane_create_solid_fill_property(struct drm_plane *plane)
>>>>> return 0;
>>>>> }
>>>>> EXPORT_SYMBOL(drm_plane_create_solid_fill_property);
>>>>> +
>>>>> +/**
>>>>> + * drm_plane_create_pixel_source_property - create a new pixel
>>>>> source property
>>>>> + * @plane: drm plane
>>>>> + * @supported_sources: bitmask of supported pixel_sources for the
>>>>> driver (NOT
>>>>> + * including DRM_PLANE_PIXEL_SOURCE_FB, as it
>>>>> will be supported
>>>>> + * by default).
>>>>
>>>> I'd say this is too strong. I'd suggest either renaming this to
>>>> extra_sources (mentioning that FB is enabled for all the planes) or
>>>> allowing any source bitmask (mentioning that FB should be enabled by
>>>> the
>>>> caller, unless there is a good reason not to do so).
>>>
>>> Right. I don't see any problem with having planes of type OVERLAY that
>>> support only solid_fill and no FB. Planes of type PRIMARY and CURSOR I
>>> would expect to always support at least FB.
>>>
>>> Atomic userspace is prepared to have an OVERLAY plane fail for any
>>> arbitrary reason. Legacy userspace probably should not ever see a plane
>>> that does not support FB.
>>
>> Got it... If we allow the possibility of FB sources not being
>> supported, then should the default pixel_source per plane be decided
>> by the driver too?
>>
>> I'd forced FB support so that I could set pixel_source to FB in
>> __drm_atomic_helper_plane_state_reset(). If we allow more flexibility
>> in the default pixel_source value, I guess we can also store a
>> default_pixel_source value in the plane_state.
>
> I'd say, the FB is a sane default. It the driver has other needs, it can
> override the value in drm_plane_funcs::reset().
>
>>
>
> [skipped the rest]
>
> --
> With best wishes
> Dmitry
>
On 12/07/2023 01:07, Jessica Zhang wrote:
>
>
> On 7/10/2023 1:11 PM, Dmitry Baryshkov wrote:
>> On 10/07/2023 22:51, Jessica Zhang wrote:
>>>
>>>
>>> On 6/30/2023 1:27 AM, Pekka Paalanen wrote:
>>>> On Fri, 30 Jun 2023 03:42:28 +0300
>>>> Dmitry Baryshkov <[email protected]> wrote:
>>>>
>>>>> On 30/06/2023 03:25, Jessica Zhang wrote:
>>>>>> Add support for pixel_source property to drm_plane and related
>>>>>> documentation.
>>>>>>
>>>>>> This enum property will allow user to specify a pixel source for the
>>>>>> plane. Possible pixel sources will be defined in the
>>>>>> drm_plane_pixel_source enum.
>>>>>>
>>>>>> The current possible pixel sources are DRM_PLANE_PIXEL_SOURCE_FB and
>>>>>> DRM_PLANE_PIXEL_SOURCE_COLOR. The default value is *_SOURCE_FB.
>>>>>
>>>>> I think, this should come before the solid fill property addition.
>>>>> First
>>>>> you tell that there is a possibility to define other pixel sources,
>>>>> then
>>>>> additional sources are defined.
>>>>
>>>> Hi,
>>>>
>>>> that would be logical indeed.
>>>
>>> Hi Dmitry and Pekka,
>>>
>>> Sorry for the delay in response, was out of office last week.
>>>
>>> Acked.
>>>
>>>>
>>>>>>
>>>>>> Signed-off-by: Jessica Zhang <[email protected]>
>>>>>> ---
>>>>>> drivers/gpu/drm/drm_atomic_state_helper.c | 1 +
>>>>>> drivers/gpu/drm/drm_atomic_uapi.c | 4 ++
>>>>>> drivers/gpu/drm/drm_blend.c | 81
>>>>>> +++++++++++++++++++++++++++++++
>>>>>> include/drm/drm_blend.h | 2 +
>>>>>> include/drm/drm_plane.h | 21 ++++++++
>>>>>> 5 files changed, 109 insertions(+)
>>>>>>
>>>>>> diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c
>>>>>> b/drivers/gpu/drm/drm_atomic_state_helper.c
>>>>>> index fe14be2bd2b2..86fb876efbe6 100644
>>>>>> --- a/drivers/gpu/drm/drm_atomic_state_helper.c
>>>>>> +++ b/drivers/gpu/drm/drm_atomic_state_helper.c
>>>>>> @@ -252,6 +252,7 @@ void
>>>>>> __drm_atomic_helper_plane_state_reset(struct drm_plane_state
>>>>>> *plane_state,
>>>>>> plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
>>>>>> plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
>>>>>> + plane_state->pixel_source = DRM_PLANE_PIXEL_SOURCE_FB;
>>>>>> if (plane_state->solid_fill_blob) {
>>>>>> drm_property_blob_put(plane_state->solid_fill_blob);
>>>>>> diff --git a/drivers/gpu/drm/drm_atomic_uapi.c
>>>>>> b/drivers/gpu/drm/drm_atomic_uapi.c
>>>>>> index a28b4ee79444..6e59c21af66b 100644
>>>>>> --- a/drivers/gpu/drm/drm_atomic_uapi.c
>>>>>> +++ b/drivers/gpu/drm/drm_atomic_uapi.c
>>>>>> @@ -596,6 +596,8 @@ static int
>>>>>> drm_atomic_plane_set_property(struct drm_plane *plane,
>>>>>> drm_property_blob_put(solid_fill);
>>>>>> return ret;
>>>>>> + } else if (property == plane->pixel_source_property) {
>>>>>> + state->pixel_source = val;
>>>>>> } else if (property == plane->alpha_property) {
>>>>>> state->alpha = val;
>>>>>> } else if (property == plane->blend_mode_property) {
>>>>>
>>>>> I think, it was pointed out in the discussion that drm_mode_setplane()
>>>>> (a pre-atomic IOCTL to turn the plane on and off) should also reset
>>>>> pixel_source to FB.
>>>
>>> I don't remember drm_mode_setplane() being mentioned in the
>>> pixel_source discussion... can you share where it was mentioned?
>>
>> https://lore.kernel.org/dri-devel/20230627105849.004050b3@eldfell/
>>
>> Let me quote it here:
>> "Legacy non-atomic UAPI wrappers can do whatever they want, and program
>> any (new) properties they want in order to implement the legacy
>> expectations, so that does not seem to be a problem."
>>
>>
>>>
>>> I'd prefer to avoid having driver change the pixel_source directly as
>>> it could cause some unexpected side effects. In general, I would like
>>> userspace to assign the value of pixel_source without driver doing
>>> anything "under the hood".
>>
>> s/driver/drm core/
>>
>> We have to remain compatible with old userspace, especially with the
>> non-atomic one. If the userspace calls ioctl(DRM_IOCTL_MODE_SETPLANE),
>> we have to display the specified FB, no matter what was the value of
>> PIXEL_SOURCE before this ioctl.
>
>
> Got it, thanks the clarification -- I see your point.
>
> I'm already setting plane_state->pixel_source to FB in
> __drm_atomic_helper_plane_reset() and it seems to me that all drivers
> are calling that within their respective plane_funcs->reset().
>
> Since (as far as I know) reset() is being called for both the atomic and
> non-atomic paths, shouldn't that be enough to default pixel_source to FB
> for old userspace?
No, this will not clean up the state between userspace apps. Currently
the rule is simple: call DRM_IOCTL_MODE_SETPLANE, get the image from FB
displayed. We should keep it so.
>>>
>>>>>
>>>>>> @@ -671,6 +673,8 @@ drm_atomic_plane_get_property(struct drm_plane
>>>>>> *plane,
>>>>>> } else if (property == plane->solid_fill_property) {
>>>>>> *val =state->solid_fill_blob ?
>>>>>> state->solid_fill_blob->base.id : 0;
>>>>>> + } else if (property == plane->pixel_source_property) {
>>>>>> + *val = state->pixel_source;
>>>>>> } else if (property == plane->alpha_property) {
>>>>>> *val =state->alpha;
>>>>>> } else if (property == plane->blend_mode_property) {
>>>>>> diff --git a/drivers/gpu/drm/drm_blend.c
>>>>>> b/drivers/gpu/drm/drm_blend.c
>>>>>> index 38c3c5d6453a..8c100a957ee2 100644
>>>>>> --- a/drivers/gpu/drm/drm_blend.c
>>>>>> +++ b/drivers/gpu/drm/drm_blend.c
>>>>>> @@ -189,6 +189,18 @@
>>>>>> * solid_fill is set up with
>>>>>> drm_plane_create_solid_fill_property(). It
>>>>>> * contains pixel data that drivers can use to fill a plane.
>>>>>> *
>>>>>> + * pixel_source:
>>>>>> + * pixel_source is set up with
>>>>>> drm_plane_create_pixel_source_property().
>>>>>> + * It is used to toggle the source of pixel data for the plane.
>>>>
>>>> Other sources than the selected one are ignored?
>>>
>>> Yep, the plane will only display the data from the set pixel_source.
>>>
>>> So if pixel_source == FB and solid_fill_blob is non-NULL,
>>> solid_fill_blob will be ignored and the plane will display the FB
>>> that is set.
>>
>> correct.
>>
>>>
>>> Will add a note about this in the comment docs.
>>>
>>>>
>>>>>> + *
>>>>>> + * Possible values:
>>>>
>>>> Wouldn't hurt to explicitly mention here that this is an enum.
>>>
>>> Acked.
>>>
>>>>
>>>>>> + *
>>>>>> + * "FB":
>>>>>> + * Framebuffer source
>>>>>> + *
>>>>>> + * "COLOR":
>>>>>> + * solid_fill source
>>>>
>>>> I think these two should be more explicit. Framebuffer source is the
>>>> usual source from the property "FB_ID". Solid fill source comes from
>>>> the property "solid_fill".
>>>
>>> Acked.
>>>
>>>>
>>>> Why "COLOR" and not, say, "SOLID_FILL"?
>>>
>>> Ah, that would make more sense :)
>>>
>>> I'll change this to "SOLID_FILL".
>>>
>>>>
>>>>>> + *
>>>>>> * Note that all the property extensions described here apply
>>>>>> either to the
>>>>>> * plane or the CRTC (e.g. for the background color, which
>>>>>> currently is not
>>>>>> * exposed and assumed to be black).
>>>>>> @@ -648,3 +660,72 @@ int
>>>>>> drm_plane_create_solid_fill_property(struct drm_plane *plane)
>>>>>> return 0;
>>>>>> }
>>>>>> EXPORT_SYMBOL(drm_plane_create_solid_fill_property);
>>>>>> +
>>>>>> +/**
>>>>>> + * drm_plane_create_pixel_source_property - create a new pixel
>>>>>> source property
>>>>>> + * @plane: drm plane
>>>>>> + * @supported_sources: bitmask of supported pixel_sources for the
>>>>>> driver (NOT
>>>>>> + * including DRM_PLANE_PIXEL_SOURCE_FB, as it
>>>>>> will be supported
>>>>>> + * by default).
>>>>>
>>>>> I'd say this is too strong. I'd suggest either renaming this to
>>>>> extra_sources (mentioning that FB is enabled for all the planes) or
>>>>> allowing any source bitmask (mentioning that FB should be enabled
>>>>> by the
>>>>> caller, unless there is a good reason not to do so).
>>>>
>>>> Right. I don't see any problem with having planes of type OVERLAY that
>>>> support only solid_fill and no FB. Planes of type PRIMARY and CURSOR I
>>>> would expect to always support at least FB.
>>>>
>>>> Atomic userspace is prepared to have an OVERLAY plane fail for any
>>>> arbitrary reason. Legacy userspace probably should not ever see a plane
>>>> that does not support FB.
>>>
>>> Got it... If we allow the possibility of FB sources not being
>>> supported, then should the default pixel_source per plane be decided
>>> by the driver too?
>>>
>>> I'd forced FB support so that I could set pixel_source to FB in
>>> __drm_atomic_helper_plane_state_reset(). If we allow more flexibility
>>> in the default pixel_source value, I guess we can also store a
>>> default_pixel_source value in the plane_state.
>>
>> I'd say, the FB is a sane default. It the driver has other needs, it
>> can override the value in drm_plane_funcs::reset().
>>
>>>
>>
>> [skipped the rest]
>>
>> --
>> With best wishes
>> Dmitry
>>
--
With best wishes
Dmitry
On Wed, 12 Jul 2023 at 01:42, Abhinav Kumar <[email protected]> wrote:
>
>
>
> On 7/11/2023 3:19 PM, Dmitry Baryshkov wrote:
> > On 12/07/2023 01:07, Jessica Zhang wrote:
> >>
> >>
> >> On 7/10/2023 1:11 PM, Dmitry Baryshkov wrote:
> >>> On 10/07/2023 22:51, Jessica Zhang wrote:
> >>>>
> >>>>
> >>>> On 6/30/2023 1:27 AM, Pekka Paalanen wrote:
> >>>>> On Fri, 30 Jun 2023 03:42:28 +0300
> >>>>> Dmitry Baryshkov <[email protected]> wrote:
> >>>>>
> >>>>>> On 30/06/2023 03:25, Jessica Zhang wrote:
> >>>>>>> Add support for pixel_source property to drm_plane and related
> >>>>>>> documentation.
> >>>>>>>
> >>>>>>> This enum property will allow user to specify a pixel source for the
> >>>>>>> plane. Possible pixel sources will be defined in the
> >>>>>>> drm_plane_pixel_source enum.
> >>>>>>>
> >>>>>>> The current possible pixel sources are DRM_PLANE_PIXEL_SOURCE_FB and
> >>>>>>> DRM_PLANE_PIXEL_SOURCE_COLOR. The default value is *_SOURCE_FB.
> >>>>>>
> >>>>>> I think, this should come before the solid fill property addition.
> >>>>>> First
> >>>>>> you tell that there is a possibility to define other pixel
> >>>>>> sources, then
> >>>>>> additional sources are defined.
> >>>>>
> >>>>> Hi,
> >>>>>
> >>>>> that would be logical indeed.
> >>>>
> >>>> Hi Dmitry and Pekka,
> >>>>
> >>>> Sorry for the delay in response, was out of office last week.
> >>>>
> >>>> Acked.
> >>>>
> >>>>>
> >>>>>>>
> >>>>>>> Signed-off-by: Jessica Zhang <[email protected]>
> >>>>>>> ---
> >>>>>>> drivers/gpu/drm/drm_atomic_state_helper.c | 1 +
> >>>>>>> drivers/gpu/drm/drm_atomic_uapi.c | 4 ++
> >>>>>>> drivers/gpu/drm/drm_blend.c | 81
> >>>>>>> +++++++++++++++++++++++++++++++
> >>>>>>> include/drm/drm_blend.h | 2 +
> >>>>>>> include/drm/drm_plane.h | 21 ++++++++
> >>>>>>> 5 files changed, 109 insertions(+)
> >>>>>>>
> >>>>>>> diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c
> >>>>>>> b/drivers/gpu/drm/drm_atomic_state_helper.c
> >>>>>>> index fe14be2bd2b2..86fb876efbe6 100644
> >>>>>>> --- a/drivers/gpu/drm/drm_atomic_state_helper.c
> >>>>>>> +++ b/drivers/gpu/drm/drm_atomic_state_helper.c
> >>>>>>> @@ -252,6 +252,7 @@ void
> >>>>>>> __drm_atomic_helper_plane_state_reset(struct drm_plane_state
> >>>>>>> *plane_state,
> >>>>>>> plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
> >>>>>>> plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
> >>>>>>> + plane_state->pixel_source = DRM_PLANE_PIXEL_SOURCE_FB;
> >>>>>>> if (plane_state->solid_fill_blob) {
> >>>>>>> drm_property_blob_put(plane_state->solid_fill_blob);
> >>>>>>> diff --git a/drivers/gpu/drm/drm_atomic_uapi.c
> >>>>>>> b/drivers/gpu/drm/drm_atomic_uapi.c
> >>>>>>> index a28b4ee79444..6e59c21af66b 100644
> >>>>>>> --- a/drivers/gpu/drm/drm_atomic_uapi.c
> >>>>>>> +++ b/drivers/gpu/drm/drm_atomic_uapi.c
> >>>>>>> @@ -596,6 +596,8 @@ static int
> >>>>>>> drm_atomic_plane_set_property(struct drm_plane *plane,
> >>>>>>> drm_property_blob_put(solid_fill);
> >>>>>>> return ret;
> >>>>>>> + } else if (property == plane->pixel_source_property) {
> >>>>>>> + state->pixel_source = val;
> >>>>>>> } else if (property == plane->alpha_property) {
> >>>>>>> state->alpha = val;
> >>>>>>> } else if (property == plane->blend_mode_property) {
> >>>>>>
> >>>>>> I think, it was pointed out in the discussion that
> >>>>>> drm_mode_setplane()
> >>>>>> (a pre-atomic IOCTL to turn the plane on and off) should also reset
> >>>>>> pixel_source to FB.
> >>>>
> >>>> I don't remember drm_mode_setplane() being mentioned in the
> >>>> pixel_source discussion... can you share where it was mentioned?
> >>>
> >>> https://lore.kernel.org/dri-devel/20230627105849.004050b3@eldfell/
> >>>
> >>> Let me quote it here:
> >>> "Legacy non-atomic UAPI wrappers can do whatever they want, and program
> >>> any (new) properties they want in order to implement the legacy
> >>> expectations, so that does not seem to be a problem."
> >>>
> >>>
> >>>>
> >>>> I'd prefer to avoid having driver change the pixel_source directly
> >>>> as it could cause some unexpected side effects. In general, I would
> >>>> like userspace to assign the value of pixel_source without driver
> >>>> doing anything "under the hood".
> >>>
> >>> s/driver/drm core/
> >>>
> >>> We have to remain compatible with old userspace, especially with the
> >>> non-atomic one. If the userspace calls
> >>> ioctl(DRM_IOCTL_MODE_SETPLANE), we have to display the specified FB,
> >>> no matter what was the value of PIXEL_SOURCE before this ioctl.
> >>
> >>
> >> Got it, thanks the clarification -- I see your point.
> >>
> >> I'm already setting plane_state->pixel_source to FB in
> >> __drm_atomic_helper_plane_reset() and it seems to me that all drivers
> >> are calling that within their respective plane_funcs->reset().
> >>
> >> Since (as far as I know) reset() is being called for both the atomic
> >> and non-atomic paths, shouldn't that be enough to default pixel_source
> >> to FB for old userspace?
> >
> > No, this will not clean up the state between userspace apps. Currently
> > the rule is simple: call DRM_IOCTL_MODE_SETPLANE, get the image from FB
> > displayed. We should keep it so.
> >
>
> Ok, so you are considering a use-case where we bootup with a userspace
> (which is aware of pixel_source), that one uses the pixel_source to
> switch the property to solid_color and then we kill this userspace and
> bootup one which is unaware of this property and uses
> DRM_IOCTL_MODE_SETPLANE, then we should default back to FB.
Not necessarily _that_ complex, but yes, that was the idea. We are not
limited to a single composer.
>
> >>>>
> >>>>>>
> >>>>>>> @@ -671,6 +673,8 @@ drm_atomic_plane_get_property(struct
> >>>>>>> drm_plane *plane,
> >>>>>>> } else if (property == plane->solid_fill_property) {
> >>>>>>> *val =state->solid_fill_blob ?
> >>>>>>> state->solid_fill_blob->base.id : 0;
> >>>>>>> + } else if (property == plane->pixel_source_property) {
> >>>>>>> + *val = state->pixel_source;
> >>>>>>> } else if (property == plane->alpha_property) {
> >>>>>>> *val =state->alpha;
> >>>>>>> } else if (property == plane->blend_mode_property) {
> >>>>>>> diff --git a/drivers/gpu/drm/drm_blend.c
> >>>>>>> b/drivers/gpu/drm/drm_blend.c
> >>>>>>> index 38c3c5d6453a..8c100a957ee2 100644
> >>>>>>> --- a/drivers/gpu/drm/drm_blend.c
> >>>>>>> +++ b/drivers/gpu/drm/drm_blend.c
> >>>>>>> @@ -189,6 +189,18 @@
> >>>>>>> * solid_fill is set up with
> >>>>>>> drm_plane_create_solid_fill_property(). It
> >>>>>>> * contains pixel data that drivers can use to fill a plane.
> >>>>>>> *
> >>>>>>> + * pixel_source:
> >>>>>>> + * pixel_source is set up with
> >>>>>>> drm_plane_create_pixel_source_property().
> >>>>>>> + * It is used to toggle the source of pixel data for the plane.
> >>>>>
> >>>>> Other sources than the selected one are ignored?
> >>>>
> >>>> Yep, the plane will only display the data from the set pixel_source.
> >>>>
> >>>> So if pixel_source == FB and solid_fill_blob is non-NULL,
> >>>> solid_fill_blob will be ignored and the plane will display the FB
> >>>> that is set.
> >>>
> >>> correct.
> >>>
> >>>>
> >>>> Will add a note about this in the comment docs.
> >>>>
> >>>>>
> >>>>>>> + *
> >>>>>>> + * Possible values:
> >>>>>
> >>>>> Wouldn't hurt to explicitly mention here that this is an enum.
> >>>>
> >>>> Acked.
> >>>>
> >>>>>
> >>>>>>> + *
> >>>>>>> + * "FB":
> >>>>>>> + * Framebuffer source
> >>>>>>> + *
> >>>>>>> + * "COLOR":
> >>>>>>> + * solid_fill source
> >>>>>
> >>>>> I think these two should be more explicit. Framebuffer source is the
> >>>>> usual source from the property "FB_ID". Solid fill source comes from
> >>>>> the property "solid_fill".
> >>>>
> >>>> Acked.
> >>>>
> >>>>>
> >>>>> Why "COLOR" and not, say, "SOLID_FILL"?
> >>>>
> >>>> Ah, that would make more sense :)
> >>>>
> >>>> I'll change this to "SOLID_FILL".
> >>>>
> >>>>>
> >>>>>>> + *
> >>>>>>> * Note that all the property extensions described here apply
> >>>>>>> either to the
> >>>>>>> * plane or the CRTC (e.g. for the background color, which
> >>>>>>> currently is not
> >>>>>>> * exposed and assumed to be black).
> >>>>>>> @@ -648,3 +660,72 @@ int
> >>>>>>> drm_plane_create_solid_fill_property(struct drm_plane *plane)
> >>>>>>> return 0;
> >>>>>>> }
> >>>>>>> EXPORT_SYMBOL(drm_plane_create_solid_fill_property);
> >>>>>>> +
> >>>>>>> +/**
> >>>>>>> + * drm_plane_create_pixel_source_property - create a new pixel
> >>>>>>> source property
> >>>>>>> + * @plane: drm plane
> >>>>>>> + * @supported_sources: bitmask of supported pixel_sources for
> >>>>>>> the driver (NOT
> >>>>>>> + * including DRM_PLANE_PIXEL_SOURCE_FB, as
> >>>>>>> it will be supported
> >>>>>>> + * by default).
> >>>>>>
> >>>>>> I'd say this is too strong. I'd suggest either renaming this to
> >>>>>> extra_sources (mentioning that FB is enabled for all the planes) or
> >>>>>> allowing any source bitmask (mentioning that FB should be enabled
> >>>>>> by the
> >>>>>> caller, unless there is a good reason not to do so).
> >>>>>
> >>>>> Right. I don't see any problem with having planes of type OVERLAY that
> >>>>> support only solid_fill and no FB. Planes of type PRIMARY and CURSOR I
> >>>>> would expect to always support at least FB.
> >>>>>
> >>>>> Atomic userspace is prepared to have an OVERLAY plane fail for any
> >>>>> arbitrary reason. Legacy userspace probably should not ever see a
> >>>>> plane
> >>>>> that does not support FB.
> >>>>
> >>>> Got it... If we allow the possibility of FB sources not being
> >>>> supported, then should the default pixel_source per plane be decided
> >>>> by the driver too?
> >>>>
> >>>> I'd forced FB support so that I could set pixel_source to FB in
> >>>> __drm_atomic_helper_plane_state_reset(). If we allow more
> >>>> flexibility in the default pixel_source value, I guess we can also
> >>>> store a default_pixel_source value in the plane_state.
> >>>
> >>> I'd say, the FB is a sane default. It the driver has other needs, it
> >>> can override the value in drm_plane_funcs::reset().
> >>>
> >>>>
> >>>
> >>> [skipped the rest]
> >>>
> >>> --
> >>> With best wishes
> >>> Dmitry
> >>>
> >
--
With best wishes
Dmitry
On 7/11/2023 3:19 PM, Dmitry Baryshkov wrote:
> On 12/07/2023 01:07, Jessica Zhang wrote:
>>
>>
>> On 7/10/2023 1:11 PM, Dmitry Baryshkov wrote:
>>> On 10/07/2023 22:51, Jessica Zhang wrote:
>>>>
>>>>
>>>> On 6/30/2023 1:27 AM, Pekka Paalanen wrote:
>>>>> On Fri, 30 Jun 2023 03:42:28 +0300
>>>>> Dmitry Baryshkov <[email protected]> wrote:
>>>>>
>>>>>> On 30/06/2023 03:25, Jessica Zhang wrote:
>>>>>>> Add support for pixel_source property to drm_plane and related
>>>>>>> documentation.
>>>>>>>
>>>>>>> This enum property will allow user to specify a pixel source for the
>>>>>>> plane. Possible pixel sources will be defined in the
>>>>>>> drm_plane_pixel_source enum.
>>>>>>>
>>>>>>> The current possible pixel sources are DRM_PLANE_PIXEL_SOURCE_FB and
>>>>>>> DRM_PLANE_PIXEL_SOURCE_COLOR. The default value is *_SOURCE_FB.
>>>>>>
>>>>>> I think, this should come before the solid fill property addition.
>>>>>> First
>>>>>> you tell that there is a possibility to define other pixel
>>>>>> sources, then
>>>>>> additional sources are defined.
>>>>>
>>>>> Hi,
>>>>>
>>>>> that would be logical indeed.
>>>>
>>>> Hi Dmitry and Pekka,
>>>>
>>>> Sorry for the delay in response, was out of office last week.
>>>>
>>>> Acked.
>>>>
>>>>>
>>>>>>>
>>>>>>> Signed-off-by: Jessica Zhang <[email protected]>
>>>>>>> ---
>>>>>>> drivers/gpu/drm/drm_atomic_state_helper.c | 1 +
>>>>>>> drivers/gpu/drm/drm_atomic_uapi.c | 4 ++
>>>>>>> drivers/gpu/drm/drm_blend.c | 81
>>>>>>> +++++++++++++++++++++++++++++++
>>>>>>> include/drm/drm_blend.h | 2 +
>>>>>>> include/drm/drm_plane.h | 21 ++++++++
>>>>>>> 5 files changed, 109 insertions(+)
>>>>>>>
>>>>>>> diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c
>>>>>>> b/drivers/gpu/drm/drm_atomic_state_helper.c
>>>>>>> index fe14be2bd2b2..86fb876efbe6 100644
>>>>>>> --- a/drivers/gpu/drm/drm_atomic_state_helper.c
>>>>>>> +++ b/drivers/gpu/drm/drm_atomic_state_helper.c
>>>>>>> @@ -252,6 +252,7 @@ void
>>>>>>> __drm_atomic_helper_plane_state_reset(struct drm_plane_state
>>>>>>> *plane_state,
>>>>>>> plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
>>>>>>> plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
>>>>>>> + plane_state->pixel_source = DRM_PLANE_PIXEL_SOURCE_FB;
>>>>>>> if (plane_state->solid_fill_blob) {
>>>>>>> drm_property_blob_put(plane_state->solid_fill_blob);
>>>>>>> diff --git a/drivers/gpu/drm/drm_atomic_uapi.c
>>>>>>> b/drivers/gpu/drm/drm_atomic_uapi.c
>>>>>>> index a28b4ee79444..6e59c21af66b 100644
>>>>>>> --- a/drivers/gpu/drm/drm_atomic_uapi.c
>>>>>>> +++ b/drivers/gpu/drm/drm_atomic_uapi.c
>>>>>>> @@ -596,6 +596,8 @@ static int
>>>>>>> drm_atomic_plane_set_property(struct drm_plane *plane,
>>>>>>> drm_property_blob_put(solid_fill);
>>>>>>> return ret;
>>>>>>> + } else if (property == plane->pixel_source_property) {
>>>>>>> + state->pixel_source = val;
>>>>>>> } else if (property == plane->alpha_property) {
>>>>>>> state->alpha = val;
>>>>>>> } else if (property == plane->blend_mode_property) {
>>>>>>
>>>>>> I think, it was pointed out in the discussion that
>>>>>> drm_mode_setplane()
>>>>>> (a pre-atomic IOCTL to turn the plane on and off) should also reset
>>>>>> pixel_source to FB.
>>>>
>>>> I don't remember drm_mode_setplane() being mentioned in the
>>>> pixel_source discussion... can you share where it was mentioned?
>>>
>>> https://lore.kernel.org/dri-devel/20230627105849.004050b3@eldfell/
>>>
>>> Let me quote it here:
>>> "Legacy non-atomic UAPI wrappers can do whatever they want, and program
>>> any (new) properties they want in order to implement the legacy
>>> expectations, so that does not seem to be a problem."
>>>
>>>
>>>>
>>>> I'd prefer to avoid having driver change the pixel_source directly
>>>> as it could cause some unexpected side effects. In general, I would
>>>> like userspace to assign the value of pixel_source without driver
>>>> doing anything "under the hood".
>>>
>>> s/driver/drm core/
>>>
>>> We have to remain compatible with old userspace, especially with the
>>> non-atomic one. If the userspace calls
>>> ioctl(DRM_IOCTL_MODE_SETPLANE), we have to display the specified FB,
>>> no matter what was the value of PIXEL_SOURCE before this ioctl.
>>
>>
>> Got it, thanks the clarification -- I see your point.
>>
>> I'm already setting plane_state->pixel_source to FB in
>> __drm_atomic_helper_plane_reset() and it seems to me that all drivers
>> are calling that within their respective plane_funcs->reset().
>>
>> Since (as far as I know) reset() is being called for both the atomic
>> and non-atomic paths, shouldn't that be enough to default pixel_source
>> to FB for old userspace?
>
> No, this will not clean up the state between userspace apps. Currently
> the rule is simple: call DRM_IOCTL_MODE_SETPLANE, get the image from FB
> displayed. We should keep it so.
>
Ok, so you are considering a use-case where we bootup with a userspace
(which is aware of pixel_source), that one uses the pixel_source to
switch the property to solid_color and then we kill this userspace and
bootup one which is unaware of this property and uses
DRM_IOCTL_MODE_SETPLANE, then we should default back to FB.
>>>>
>>>>>>
>>>>>>> @@ -671,6 +673,8 @@ drm_atomic_plane_get_property(struct
>>>>>>> drm_plane *plane,
>>>>>>> } else if (property == plane->solid_fill_property) {
>>>>>>> *val =state->solid_fill_blob ?
>>>>>>> state->solid_fill_blob->base.id : 0;
>>>>>>> + } else if (property == plane->pixel_source_property) {
>>>>>>> + *val = state->pixel_source;
>>>>>>> } else if (property == plane->alpha_property) {
>>>>>>> *val =state->alpha;
>>>>>>> } else if (property == plane->blend_mode_property) {
>>>>>>> diff --git a/drivers/gpu/drm/drm_blend.c
>>>>>>> b/drivers/gpu/drm/drm_blend.c
>>>>>>> index 38c3c5d6453a..8c100a957ee2 100644
>>>>>>> --- a/drivers/gpu/drm/drm_blend.c
>>>>>>> +++ b/drivers/gpu/drm/drm_blend.c
>>>>>>> @@ -189,6 +189,18 @@
>>>>>>> * solid_fill is set up with
>>>>>>> drm_plane_create_solid_fill_property(). It
>>>>>>> * contains pixel data that drivers can use to fill a plane.
>>>>>>> *
>>>>>>> + * pixel_source:
>>>>>>> + * pixel_source is set up with
>>>>>>> drm_plane_create_pixel_source_property().
>>>>>>> + * It is used to toggle the source of pixel data for the plane.
>>>>>
>>>>> Other sources than the selected one are ignored?
>>>>
>>>> Yep, the plane will only display the data from the set pixel_source.
>>>>
>>>> So if pixel_source == FB and solid_fill_blob is non-NULL,
>>>> solid_fill_blob will be ignored and the plane will display the FB
>>>> that is set.
>>>
>>> correct.
>>>
>>>>
>>>> Will add a note about this in the comment docs.
>>>>
>>>>>
>>>>>>> + *
>>>>>>> + * Possible values:
>>>>>
>>>>> Wouldn't hurt to explicitly mention here that this is an enum.
>>>>
>>>> Acked.
>>>>
>>>>>
>>>>>>> + *
>>>>>>> + * "FB":
>>>>>>> + * Framebuffer source
>>>>>>> + *
>>>>>>> + * "COLOR":
>>>>>>> + * solid_fill source
>>>>>
>>>>> I think these two should be more explicit. Framebuffer source is the
>>>>> usual source from the property "FB_ID". Solid fill source comes from
>>>>> the property "solid_fill".
>>>>
>>>> Acked.
>>>>
>>>>>
>>>>> Why "COLOR" and not, say, "SOLID_FILL"?
>>>>
>>>> Ah, that would make more sense :)
>>>>
>>>> I'll change this to "SOLID_FILL".
>>>>
>>>>>
>>>>>>> + *
>>>>>>> * Note that all the property extensions described here apply
>>>>>>> either to the
>>>>>>> * plane or the CRTC (e.g. for the background color, which
>>>>>>> currently is not
>>>>>>> * exposed and assumed to be black).
>>>>>>> @@ -648,3 +660,72 @@ int
>>>>>>> drm_plane_create_solid_fill_property(struct drm_plane *plane)
>>>>>>> return 0;
>>>>>>> }
>>>>>>> EXPORT_SYMBOL(drm_plane_create_solid_fill_property);
>>>>>>> +
>>>>>>> +/**
>>>>>>> + * drm_plane_create_pixel_source_property - create a new pixel
>>>>>>> source property
>>>>>>> + * @plane: drm plane
>>>>>>> + * @supported_sources: bitmask of supported pixel_sources for
>>>>>>> the driver (NOT
>>>>>>> + * including DRM_PLANE_PIXEL_SOURCE_FB, as
>>>>>>> it will be supported
>>>>>>> + * by default).
>>>>>>
>>>>>> I'd say this is too strong. I'd suggest either renaming this to
>>>>>> extra_sources (mentioning that FB is enabled for all the planes) or
>>>>>> allowing any source bitmask (mentioning that FB should be enabled
>>>>>> by the
>>>>>> caller, unless there is a good reason not to do so).
>>>>>
>>>>> Right. I don't see any problem with having planes of type OVERLAY that
>>>>> support only solid_fill and no FB. Planes of type PRIMARY and CURSOR I
>>>>> would expect to always support at least FB.
>>>>>
>>>>> Atomic userspace is prepared to have an OVERLAY plane fail for any
>>>>> arbitrary reason. Legacy userspace probably should not ever see a
>>>>> plane
>>>>> that does not support FB.
>>>>
>>>> Got it... If we allow the possibility of FB sources not being
>>>> supported, then should the default pixel_source per plane be decided
>>>> by the driver too?
>>>>
>>>> I'd forced FB support so that I could set pixel_source to FB in
>>>> __drm_atomic_helper_plane_state_reset(). If we allow more
>>>> flexibility in the default pixel_source value, I guess we can also
>>>> store a default_pixel_source value in the plane_state.
>>>
>>> I'd say, the FB is a sane default. It the driver has other needs, it
>>> can override the value in drm_plane_funcs::reset().
>>>
>>>>
>>>
>>> [skipped the rest]
>>>
>>> --
>>> With best wishes
>>> Dmitry
>>>
>
On Tue, 11 Jul 2023 15:42:28 -0700
Abhinav Kumar <[email protected]> wrote:
> On 7/11/2023 3:19 PM, Dmitry Baryshkov wrote:
> > On 12/07/2023 01:07, Jessica Zhang wrote:
> >>
> >>
> >> On 7/10/2023 1:11 PM, Dmitry Baryshkov wrote:
> >>> On 10/07/2023 22:51, Jessica Zhang wrote:
> >>>>
> >>>>
> >>>> On 6/30/2023 1:27 AM, Pekka Paalanen wrote:
> >>>>> On Fri, 30 Jun 2023 03:42:28 +0300
> >>>>> Dmitry Baryshkov <[email protected]> wrote:
> >>>>>
> >>>>>> On 30/06/2023 03:25, Jessica Zhang wrote:
> >>>>>>> Add support for pixel_source property to drm_plane and related
> >>>>>>> documentation.
> >>>>>>>
> >>>>>>> This enum property will allow user to specify a pixel source for the
> >>>>>>> plane. Possible pixel sources will be defined in the
> >>>>>>> drm_plane_pixel_source enum.
> >>>>>>>
> >>>>>>> The current possible pixel sources are DRM_PLANE_PIXEL_SOURCE_FB and
> >>>>>>> DRM_PLANE_PIXEL_SOURCE_COLOR. The default value is *_SOURCE_FB.
> >>>>>>
> >>>>>> I think, this should come before the solid fill property addition.
> >>>>>> First
> >>>>>> you tell that there is a possibility to define other pixel
> >>>>>> sources, then
> >>>>>> additional sources are defined.
> >>>>>
> >>>>> Hi,
> >>>>>
> >>>>> that would be logical indeed.
> >>>>
> >>>> Hi Dmitry and Pekka,
> >>>>
> >>>> Sorry for the delay in response, was out of office last week.
> >>>>
> >>>> Acked.
> >>>>
> >>>>>
> >>>>>>>
> >>>>>>> Signed-off-by: Jessica Zhang <[email protected]>
> >>>>>>> ---
> >>>>>>> drivers/gpu/drm/drm_atomic_state_helper.c | 1 +
> >>>>>>> drivers/gpu/drm/drm_atomic_uapi.c | 4 ++
> >>>>>>> drivers/gpu/drm/drm_blend.c | 81
> >>>>>>> +++++++++++++++++++++++++++++++
> >>>>>>> include/drm/drm_blend.h | 2 +
> >>>>>>> include/drm/drm_plane.h | 21 ++++++++
> >>>>>>> 5 files changed, 109 insertions(+)
> >>>>>>>
> >>>>>>> diff --git a/drivers/gpu/drm/drm_atomic_state_helper.c
> >>>>>>> b/drivers/gpu/drm/drm_atomic_state_helper.c
> >>>>>>> index fe14be2bd2b2..86fb876efbe6 100644
> >>>>>>> --- a/drivers/gpu/drm/drm_atomic_state_helper.c
> >>>>>>> +++ b/drivers/gpu/drm/drm_atomic_state_helper.c
> >>>>>>> @@ -252,6 +252,7 @@ void
> >>>>>>> __drm_atomic_helper_plane_state_reset(struct drm_plane_state
> >>>>>>> *plane_state,
> >>>>>>> plane_state->alpha = DRM_BLEND_ALPHA_OPAQUE;
> >>>>>>> plane_state->pixel_blend_mode = DRM_MODE_BLEND_PREMULTI;
> >>>>>>> + plane_state->pixel_source = DRM_PLANE_PIXEL_SOURCE_FB;
> >>>>>>> if (plane_state->solid_fill_blob) {
> >>>>>>> drm_property_blob_put(plane_state->solid_fill_blob);
> >>>>>>> diff --git a/drivers/gpu/drm/drm_atomic_uapi.c
> >>>>>>> b/drivers/gpu/drm/drm_atomic_uapi.c
> >>>>>>> index a28b4ee79444..6e59c21af66b 100644
> >>>>>>> --- a/drivers/gpu/drm/drm_atomic_uapi.c
> >>>>>>> +++ b/drivers/gpu/drm/drm_atomic_uapi.c
> >>>>>>> @@ -596,6 +596,8 @@ static int
> >>>>>>> drm_atomic_plane_set_property(struct drm_plane *plane,
> >>>>>>> drm_property_blob_put(solid_fill);
> >>>>>>> return ret;
> >>>>>>> + } else if (property == plane->pixel_source_property) {
> >>>>>>> + state->pixel_source = val;
> >>>>>>> } else if (property == plane->alpha_property) {
> >>>>>>> state->alpha = val;
> >>>>>>> } else if (property == plane->blend_mode_property) {
> >>>>>>
> >>>>>> I think, it was pointed out in the discussion that
> >>>>>> drm_mode_setplane()
> >>>>>> (a pre-atomic IOCTL to turn the plane on and off) should also reset
> >>>>>> pixel_source to FB.
> >>>>
> >>>> I don't remember drm_mode_setplane() being mentioned in the
> >>>> pixel_source discussion... can you share where it was mentioned?
> >>>
> >>> https://lore.kernel.org/dri-devel/20230627105849.004050b3@eldfell/
> >>>
> >>> Let me quote it here:
> >>> "Legacy non-atomic UAPI wrappers can do whatever they want, and program
> >>> any (new) properties they want in order to implement the legacy
> >>> expectations, so that does not seem to be a problem."
> >>>
> >>>
> >>>>
> >>>> I'd prefer to avoid having driver change the pixel_source directly
> >>>> as it could cause some unexpected side effects. In general, I would
> >>>> like userspace to assign the value of pixel_source without driver
> >>>> doing anything "under the hood".
> >>>
> >>> s/driver/drm core/
> >>>
> >>> We have to remain compatible with old userspace, especially with the
> >>> non-atomic one. If the userspace calls
> >>> ioctl(DRM_IOCTL_MODE_SETPLANE), we have to display the specified FB,
> >>> no matter what was the value of PIXEL_SOURCE before this ioctl.
> >>
> >>
> >> Got it, thanks the clarification -- I see your point.
> >>
> >> I'm already setting plane_state->pixel_source to FB in
> >> __drm_atomic_helper_plane_reset() and it seems to me that all drivers
> >> are calling that within their respective plane_funcs->reset().
> >>
> >> Since (as far as I know) reset() is being called for both the atomic
> >> and non-atomic paths, shouldn't that be enough to default pixel_source
> >> to FB for old userspace?
> >
> > No, this will not clean up the state between userspace apps. Currently
> > the rule is simple: call DRM_IOCTL_MODE_SETPLANE, get the image from FB
> > displayed. We should keep it so.
> >
>
> Ok, so you are considering a use-case where we bootup with a userspace
> (which is aware of pixel_source), that one uses the pixel_source to
> switch the property to solid_color and then we kill this userspace and
> bootup one which is unaware of this property and uses
> DRM_IOCTL_MODE_SETPLANE, then we should default back to FB.
Not even that complex. There is no need to reboot and no need to kill
anything to hit this. A simple VT-switch can switch between two
different KMS clients, one could be using atomic with solid_fill, and
the other is an old legacy UAPI user. If the atomic client leaves stuff
up in KMS state, it would be nice if the legacy app still worked.
Or, maybe it's not a VT-switch but switching from, say, a graphical
login manager to a desktop or back. The same thing, different KMS
clients. But in this case it is more likely that userspace follows
common play rules, so it's less likely to have problematic left-over
KMS state.
Or, maybe you simply quit the atomic KMS client and expect fbcon to
successfully take over. I don't know what APIs fbcon uses inside the
kernel, but it definitely should clean up any mess left over by an
atomic (or legacy) KMS client to make sure it shows itself.
Traditionally it has failed to do that though, I don't know if things
are better nowadays (GAMMA_LUT, HDR_OUTPUT_METADATA, probably more).
Switching between two KMS clients is fundamentally problematic. If both
old and new KMS client are atomic, the kernel cannot simply go
resetting any KMS state automatically, because the kernel does not
know which part of state is good to reset and which would just cause
unwanted flicker and delays. That means that it is up to the two atomic
KMS clients to agree on common play rules and not leave funny state up.
IOW, not the kernel's problem, by what I have understood from kernel
developer opinions.
However, legacy KMS clients are different. As legacy clients, they may
not even have access to the properties they might need to clean up
after a previous atomic KMS client. The legacy UAPI is expected to
be slow and glitchy, but also Just Work(TM), so the kernel can reset
everything a legacy KMS client would not have access to when a legacy
KMS client issues drmModeSetPlane or drmModeSetCrtc (pardon for using
libdrm API functions for the ioctls whose names I never memorised).
Thanks,
pq