1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun
3*4882a593Smuzhiyun #ifndef _DRM_MANAGED_H_
4*4882a593Smuzhiyun #define _DRM_MANAGED_H_
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun #include <linux/gfp.h>
7*4882a593Smuzhiyun #include <linux/overflow.h>
8*4882a593Smuzhiyun #include <linux/types.h>
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun struct drm_device;
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun typedef void (*drmres_release_t)(struct drm_device *dev, void *res);
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun /**
15*4882a593Smuzhiyun * drmm_add_action - add a managed release action to a &drm_device
16*4882a593Smuzhiyun * @dev: DRM device
17*4882a593Smuzhiyun * @action: function which should be called when @dev is released
18*4882a593Smuzhiyun * @data: opaque pointer, passed to @action
19*4882a593Smuzhiyun *
20*4882a593Smuzhiyun * This function adds the @release action with optional parameter @data to the
21*4882a593Smuzhiyun * list of cleanup actions for @dev. The cleanup actions will be run in reverse
22*4882a593Smuzhiyun * order in the final drm_dev_put() call for @dev.
23*4882a593Smuzhiyun */
24*4882a593Smuzhiyun #define drmm_add_action(dev, action, data) \
25*4882a593Smuzhiyun __drmm_add_action(dev, action, data, #action)
26*4882a593Smuzhiyun
27*4882a593Smuzhiyun int __must_check __drmm_add_action(struct drm_device *dev,
28*4882a593Smuzhiyun drmres_release_t action,
29*4882a593Smuzhiyun void *data, const char *name);
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun /**
32*4882a593Smuzhiyun * drmm_add_action_or_reset - add a managed release action to a &drm_device
33*4882a593Smuzhiyun * @dev: DRM device
34*4882a593Smuzhiyun * @action: function which should be called when @dev is released
35*4882a593Smuzhiyun * @data: opaque pointer, passed to @action
36*4882a593Smuzhiyun *
37*4882a593Smuzhiyun * Similar to drmm_add_action(), with the only difference that upon failure
38*4882a593Smuzhiyun * @action is directly called for any cleanup work necessary on failures.
39*4882a593Smuzhiyun */
40*4882a593Smuzhiyun #define drmm_add_action_or_reset(dev, action, data) \
41*4882a593Smuzhiyun __drmm_add_action_or_reset(dev, action, data, #action)
42*4882a593Smuzhiyun
43*4882a593Smuzhiyun int __must_check __drmm_add_action_or_reset(struct drm_device *dev,
44*4882a593Smuzhiyun drmres_release_t action,
45*4882a593Smuzhiyun void *data, const char *name);
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun void drmm_add_final_kfree(struct drm_device *dev, void *container);
48*4882a593Smuzhiyun
49*4882a593Smuzhiyun void *drmm_kmalloc(struct drm_device *dev, size_t size, gfp_t gfp) __malloc;
50*4882a593Smuzhiyun
51*4882a593Smuzhiyun /**
52*4882a593Smuzhiyun * drmm_kzalloc - &drm_device managed kzalloc()
53*4882a593Smuzhiyun * @dev: DRM device
54*4882a593Smuzhiyun * @size: size of the memory allocation
55*4882a593Smuzhiyun * @gfp: GFP allocation flags
56*4882a593Smuzhiyun *
57*4882a593Smuzhiyun * This is a &drm_device managed version of kzalloc(). The allocated memory is
58*4882a593Smuzhiyun * automatically freed on the final drm_dev_put(). Memory can also be freed
59*4882a593Smuzhiyun * before the final drm_dev_put() by calling drmm_kfree().
60*4882a593Smuzhiyun */
drmm_kzalloc(struct drm_device * dev,size_t size,gfp_t gfp)61*4882a593Smuzhiyun static inline void *drmm_kzalloc(struct drm_device *dev, size_t size, gfp_t gfp)
62*4882a593Smuzhiyun {
63*4882a593Smuzhiyun return drmm_kmalloc(dev, size, gfp | __GFP_ZERO);
64*4882a593Smuzhiyun }
65*4882a593Smuzhiyun
66*4882a593Smuzhiyun /**
67*4882a593Smuzhiyun * drmm_kmalloc_array - &drm_device managed kmalloc_array()
68*4882a593Smuzhiyun * @dev: DRM device
69*4882a593Smuzhiyun * @n: number of array elements to allocate
70*4882a593Smuzhiyun * @size: size of array member
71*4882a593Smuzhiyun * @flags: GFP allocation flags
72*4882a593Smuzhiyun *
73*4882a593Smuzhiyun * This is a &drm_device managed version of kmalloc_array(). The allocated
74*4882a593Smuzhiyun * memory is automatically freed on the final drm_dev_put() and works exactly
75*4882a593Smuzhiyun * like a memory allocation obtained by drmm_kmalloc().
76*4882a593Smuzhiyun */
drmm_kmalloc_array(struct drm_device * dev,size_t n,size_t size,gfp_t flags)77*4882a593Smuzhiyun static inline void *drmm_kmalloc_array(struct drm_device *dev,
78*4882a593Smuzhiyun size_t n, size_t size, gfp_t flags)
79*4882a593Smuzhiyun {
80*4882a593Smuzhiyun size_t bytes;
81*4882a593Smuzhiyun
82*4882a593Smuzhiyun if (unlikely(check_mul_overflow(n, size, &bytes)))
83*4882a593Smuzhiyun return NULL;
84*4882a593Smuzhiyun
85*4882a593Smuzhiyun return drmm_kmalloc(dev, bytes, flags);
86*4882a593Smuzhiyun }
87*4882a593Smuzhiyun
88*4882a593Smuzhiyun /**
89*4882a593Smuzhiyun * drmm_kcalloc - &drm_device managed kcalloc()
90*4882a593Smuzhiyun * @dev: DRM device
91*4882a593Smuzhiyun * @n: number of array elements to allocate
92*4882a593Smuzhiyun * @size: size of array member
93*4882a593Smuzhiyun * @flags: GFP allocation flags
94*4882a593Smuzhiyun *
95*4882a593Smuzhiyun * This is a &drm_device managed version of kcalloc(). The allocated memory is
96*4882a593Smuzhiyun * automatically freed on the final drm_dev_put() and works exactly like a
97*4882a593Smuzhiyun * memory allocation obtained by drmm_kmalloc().
98*4882a593Smuzhiyun */
drmm_kcalloc(struct drm_device * dev,size_t n,size_t size,gfp_t flags)99*4882a593Smuzhiyun static inline void *drmm_kcalloc(struct drm_device *dev,
100*4882a593Smuzhiyun size_t n, size_t size, gfp_t flags)
101*4882a593Smuzhiyun {
102*4882a593Smuzhiyun return drmm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
103*4882a593Smuzhiyun }
104*4882a593Smuzhiyun
105*4882a593Smuzhiyun char *drmm_kstrdup(struct drm_device *dev, const char *s, gfp_t gfp);
106*4882a593Smuzhiyun
107*4882a593Smuzhiyun void drmm_kfree(struct drm_device *dev, void *data);
108*4882a593Smuzhiyun
109*4882a593Smuzhiyun #endif
110