1 /* SPDX-License-Identifier: GPL-2.0 or MIT */
6 #include <linux/lockdep.h>
7 #include <linux/mutex.h>
8 #include <linux/types.h>
10 #include <drm/drm_connector.h>
11 #include <drm/drm_crtc.h>
13 struct drm_client_dev;
16 struct drm_framebuffer;
17 struct drm_gem_object;
22 * struct drm_client_funcs - DRM client callbacks
24 struct drm_client_funcs {
26 * @owner: The module owner
33 * Called when &drm_device is unregistered. The client should respond by
34 * releasing its resources using drm_client_release().
36 * This callback is optional.
38 void (*unregister)(struct drm_client_dev *client);
43 * Called on drm_lastclose(). The first client instance in the list that
44 * returns zero gets the privilege to restore and no more clients are
45 * called. This callback is not called after @unregister has been called.
47 * Note that the core does not guarantee exclusion against concurrent
48 * drm_open(). Clients need to ensure this themselves, for example by
49 * using drm_master_internal_acquire() and
50 * drm_master_internal_release().
52 * This callback is optional.
54 int (*restore)(struct drm_client_dev *client);
59 * Called on drm_kms_helper_hotplug_event().
60 * This callback is not called after @unregister has been called.
62 * This callback is optional.
64 int (*hotplug)(struct drm_client_dev *client);
68 * struct drm_client_dev - DRM client instance
70 struct drm_client_dev {
74 struct drm_device *dev;
77 * @name: Name of the client.
84 * List of all clients of a DRM device, linked into
85 * &drm_device.clientlist. Protected by &drm_device.clientlist_mutex.
87 struct list_head list;
90 * @funcs: DRM client functions (optional)
92 const struct drm_client_funcs *funcs;
97 struct drm_file *file;
100 * @modeset_mutex: Protects @modesets.
102 struct mutex modeset_mutex;
105 * @modesets: CRTC configurations
107 struct drm_mode_set *modesets;
110 int drm_client_init(struct drm_device *dev, struct drm_client_dev *client,
111 const char *name, const struct drm_client_funcs *funcs);
112 void drm_client_release(struct drm_client_dev *client);
113 void drm_client_register(struct drm_client_dev *client);
115 void drm_client_dev_unregister(struct drm_device *dev);
116 void drm_client_dev_hotplug(struct drm_device *dev);
117 void drm_client_dev_restore(struct drm_device *dev);
120 * struct drm_client_buffer - DRM client buffer
122 struct drm_client_buffer {
124 * @client: DRM client
126 struct drm_client_dev *client;
129 * @handle: Buffer handle
134 * @pitch: Buffer pitch
139 * @gem: GEM object backing this buffer
141 struct drm_gem_object *gem;
144 * @vaddr: Virtual address for the buffer
149 * @fb: DRM framebuffer
151 struct drm_framebuffer *fb;
154 struct drm_client_buffer *
155 drm_client_framebuffer_create(struct drm_client_dev *client, u32 width, u32 height, u32 format);
156 void drm_client_framebuffer_delete(struct drm_client_buffer *buffer);
157 int drm_client_framebuffer_flush(struct drm_client_buffer *buffer, struct drm_rect *rect);
158 void *drm_client_buffer_vmap(struct drm_client_buffer *buffer);
159 void drm_client_buffer_vunmap(struct drm_client_buffer *buffer);
161 int drm_client_modeset_create(struct drm_client_dev *client);
162 void drm_client_modeset_free(struct drm_client_dev *client);
163 int drm_client_modeset_probe(struct drm_client_dev *client, unsigned int width, unsigned int height);
164 bool drm_client_rotation(struct drm_mode_set *modeset, unsigned int *rotation);
165 int drm_client_modeset_check(struct drm_client_dev *client);
166 int drm_client_modeset_commit_locked(struct drm_client_dev *client);
167 int drm_client_modeset_commit(struct drm_client_dev *client);
168 int drm_client_modeset_dpms(struct drm_client_dev *client, int mode);
171 * drm_client_for_each_modeset() - Iterate over client modesets
172 * @modeset: &drm_mode_set loop cursor
173 * @client: DRM client
175 #define drm_client_for_each_modeset(modeset, client) \
176 for (({ lockdep_assert_held(&(client)->modeset_mutex); }), \
177 modeset = (client)->modesets; modeset->crtc; modeset++)
180 * drm_client_for_each_connector_iter - connector_list iterator macro
181 * @connector: &struct drm_connector pointer used as cursor
182 * @iter: &struct drm_connector_list_iter
184 * This iterates the connectors that are useable for internal clients (excludes
185 * writeback connectors).
187 * For more info see drm_for_each_connector_iter().
189 #define drm_client_for_each_connector_iter(connector, iter) \
190 drm_for_each_connector_iter(connector, iter) \
191 if (connector->connector_type != DRM_MODE_CONNECTOR_WRITEBACK)
193 void drm_client_debugfs_init(struct drm_minor *minor);