Re: [PATCH v4 04/19] drm/plane: add drmm_universal_plane_alloc()

On Tue, Dec 08, 2020 at 04:54:36PM +0100, Philipp Zabel wrote:

Add an alternative to drm_universal_plane_init() that allocates and initializes a plane and registers drm_plane_cleanup() with drmm_add_action_or_reset().

Signed-off-by: Philipp Zabel p.zabel@pengutronix.de Reviewed-by: Laurent Pinchart laurent.pinchart@ideasonboard.com

---

drivers/gpu/drm/drm_plane.c | 126 +++++++++++++++++++++++++++--------- include/drm/drm_plane.h | 42 ++++++++++++ 2 files changed, 139 insertions(+), 29 deletions(-)

diff --git a/drivers/gpu/drm/drm_plane.c b/drivers/gpu/drm/drm_plane.c index e6231947f987..6b1261fe09fb 100644 --- a/drivers/gpu/drm/drm_plane.c +++ b/drivers/gpu/drm/drm_plane.c @@ -30,6 +30,7 @@ #include <drm/drm_file.h> #include <drm/drm_crtc.h> #include <drm/drm_fourcc.h> +#include <drm/drm_managed.h> #include <drm/drm_vblank.h>

#include "drm_crtc_internal.h" @@ -152,31 +153,16 @@ static int create_in_format_blob(struct drm_device *dev, struct drm_plane *plane return 0; }

-/**

• • drm_universal_plane_init - Initialize a new universal plane object
• • @dev: DRM device
• • @plane: plane object to init
• • @possible_crtcs: bitmask of possible CRTCs
• • @funcs: callbacks for the new plane
• • @formats: array of supported formats (DRM_FORMAT_*)
• • @format_count: number of elements in @formats
• • @format_modifiers: array of struct drm_format modifiers terminated by

• •                DRM_FORMAT_MOD_INVALID
    

• • @type: type of plane (overlay, primary, cursor)
• • @name: printf style format string for the plane name, or NULL for default name
• • Initializes a plane object of type @type.
• • Returns:
• • Zero on success, error code on failure.
• */

-int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,

• 	     uint32_t possible_crtcs,
  

• 	     const struct drm_plane_funcs *funcs,
  

• 	     const uint32_t *formats, unsigned int format_count,
  

• 	     const uint64_t *format_modifiers,
  

• 	     enum drm_plane_type type,
  

• 	     const char *name, ...)
  

+__printf(9, 0) +static int __drm_universal_plane_init(struct drm_device *dev,

• 		      struct drm_plane *plane,
  

• 		      uint32_t possible_crtcs,
  

• 		      const struct drm_plane_funcs *funcs,
  

• 		      const uint32_t *formats,
  

• 		      unsigned int format_count,
  

• 		      const uint64_t *format_modifiers,
  

• 		      enum drm_plane_type type,
  

• 		      const char *name, va_list ap)
  

{ struct drm_mode_config *config = &dev->mode_config; unsigned int format_modifier_count = 0; @@ -237,11 +223,7 @@ int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane, }

if (name) {

• va_list ap;
  

• va_start(ap, name);
  

  plane->name = kvasprintf(GFP_KERNEL, name, ap);

• va_end(ap);
  

  } else { plane->name = kasprintf(GFP_KERNEL, "plane-%d", drm_num_planes(dev));

@@ -286,8 +268,94 @@ int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,

return 0; }

+/**

• • drm_universal_plane_init - Initialize a new universal plane object
• • @dev: DRM device
• • @plane: plane object to init
• • @possible_crtcs: bitmask of possible CRTCs
• • @funcs: callbacks for the new plane
• • @formats: array of supported formats (DRM_FORMAT_*)
• • @format_count: number of elements in @formats
• • @format_modifiers: array of struct drm_format modifiers terminated by

• •                DRM_FORMAT_MOD_INVALID
    

• • @type: type of plane (overlay, primary, cursor)
• • @name: printf style format string for the plane name, or NULL for default name
• • Initializes a plane object of type @type.

Same as with the others, please include a note that funcs->destroy must clean stuff up and call kfree(), and that drivers should consider the new drmm_ version instead.

• • Returns:
• • Zero on success, error code on failure.
• */

+int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,

• 	     uint32_t possible_crtcs,
  

• 	     const struct drm_plane_funcs *funcs,
  

• 	     const uint32_t *formats, unsigned int format_count,
  

• 	     const uint64_t *format_modifiers,
  

• 	     enum drm_plane_type type,
  

• 	     const char *name, ...)
  

+{

• va_list ap;
• int ret;

I think WARN_ON(!funcs.destroy); maybe.

• va_start(ap, name);
• ret = __drm_universal_plane_init(dev, plane, possible_crtcs, funcs,

• 			 formats, format_count, format_modifiers,
  

• 			 type, name, ap);
  

• va_end(ap);
• return ret;

+} EXPORT_SYMBOL(drm_universal_plane_init);

+static void drmm_universal_plane_alloc_release(struct drm_device *dev, void *ptr) +{

• struct drm_plane *plane = ptr;
• if (WARN_ON(!plane->dev))

• return;
  

• drm_plane_cleanup(plane);

+}

+void *__drmm_universal_plane_alloc(struct drm_device *dev, size_t size,

• 		   size_t offset, uint32_t possible_crtcs,
  

• 		   const struct drm_plane_funcs *funcs,
  

• 		   const uint32_t *formats, unsigned int format_count,
  

• 		   const uint64_t *format_modifiers,
  

• 		   enum drm_plane_type type,
  

• 		   const char *name, ...)
  

+{

• void *container;
• struct drm_plane *plane;
• va_list ap;
• int ret;
• if (!funcs || funcs->destroy)

• return ERR_PTR(-EINVAL);
  

• container = drmm_kzalloc(dev, size, GFP_KERNEL);
• if (!container)

• return ERR_PTR(-ENOMEM);
  

• plane = container + offset;
• va_start(ap, name);
• ret = __drm_universal_plane_init(dev, plane, possible_crtcs, funcs,

• 			 formats, format_count, format_modifiers,
  

• 			 type, name, ap);
  

• va_end(ap);
• if (ret)

• return ERR_PTR(ret);
  

• ret = drmm_add_action_or_reset(dev, drmm_universal_plane_alloc_release,

• 		       plane);
  

• if (ret)

• return ERR_PTR(ret);
  

• return container;

+} +EXPORT_SYMBOL(__drmm_universal_plane_alloc);

int drm_plane_register_all(struct drm_device *dev) { unsigned int num_planes = 0; diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h index 1d82b264e5e4..8ef06ee1c8eb 100644 --- a/include/drm/drm_plane.h +++ b/include/drm/drm_plane.h @@ -764,6 +764,48 @@ int drm_plane_init(struct drm_device *dev, bool is_primary); void drm_plane_cleanup(struct drm_plane *plane);

+__printf(10, 11) +void *__drmm_universal_plane_alloc(struct drm_device *dev,

• 		   size_t size, size_t offset,
  

• 		   uint32_t possible_crtcs,
  

• 		   const struct drm_plane_funcs *funcs,
  

• 		   const uint32_t *formats,
  

• 		   unsigned int format_count,
  

• 		   const uint64_t *format_modifiers,
  

• 		   enum drm_plane_type plane_type,
  

• 		   const char *name, ...);
  

+/**

• • drmm_universal_plane_alloc - Allocate and initialize an universal plane object
• • @dev: DRM device
• • @type: the type of the struct which contains struct &drm_plane
• • @member: the name of the &drm_plane within @type
• • @possible_crtcs: bitmask of possible CRTCs
• • @funcs: callbacks for the new plane
• • @formats: array of supported formats (DRM_FORMAT_*)
• • @format_count: number of elements in @formats
• • @format_modifiers: array of struct drm_format modifiers terminated by

• •                DRM_FORMAT_MOD_INVALID
    

• • @plane_type: type of plane (overlay, primary, cursor)
• • @name: printf style format string for the plane name, or NULL for default name
• • Allocates and initializes a plane object of type @type. Cleanup is
• • automatically handled through registering drm_plane_cleanup() with
• • drmm_add_action().
• • The @drm_plane_funcs.destroy hook must be NULL.

I wonder whether we should warn about this somewhere ...

• • Returns:
• • Pointer to new plane, or ERR_PTR on failure.
• */

+#define drmm_universal_plane_alloc(dev, type, member, possible_crtcs, funcs, formats, \

• 		   format_count, format_modifiers, plane_type, name, ...) \
  

• ((type *)__drmm_universal_plane_alloc(dev, sizeof(type), \

Type upcast with container_of

With the nits addressed somehow:

Reviewed-by: Daniel Vetter daniel.vetter@ffwll.ch

• 			      offsetof(type, member), \
  

• 			      possible_crtcs, funcs, formats, \
  

• 			      format_count, format_modifiers, \
  

• 			      plane_type, name, ##__VA_ARGS__))
  

/**

• drm_plane_index - find the index of a registered plane
• @plane: plane to find index for

-- 2.20.1