Loading...
1/* SPDX-License-Identifier: GPL-2.0 or MIT */
2
3#ifndef _DRM_CLIENT_H_
4#define _DRM_CLIENT_H_
5
6#include <linux/iosys-map.h>
7#include <linux/lockdep.h>
8#include <linux/mutex.h>
9#include <linux/types.h>
10
11#include <drm/drm_connector.h>
12#include <drm/drm_crtc.h>
13
14struct drm_client_dev;
15struct drm_device;
16struct drm_file;
17struct drm_framebuffer;
18struct drm_gem_object;
19struct drm_minor;
20struct module;
21
22/**
23 * struct drm_client_funcs - DRM client callbacks
24 */
25struct drm_client_funcs {
26 /**
27 * @owner: The module owner
28 */
29 struct module *owner;
30
31 /**
32 * @unregister:
33 *
34 * Called when &drm_device is unregistered. The client should respond by
35 * releasing its resources using drm_client_release().
36 *
37 * This callback is optional.
38 */
39 void (*unregister)(struct drm_client_dev *client);
40
41 /**
42 * @restore:
43 *
44 * Called on drm_lastclose(). The first client instance in the list that
45 * returns zero gets the privilege to restore and no more clients are
46 * called. This callback is not called after @unregister has been called.
47 *
48 * Note that the core does not guarantee exclusion against concurrent
49 * drm_open(). Clients need to ensure this themselves, for example by
50 * using drm_master_internal_acquire() and
51 * drm_master_internal_release().
52 *
53 * This callback is optional.
54 */
55 int (*restore)(struct drm_client_dev *client);
56
57 /**
58 * @hotplug:
59 *
60 * Called on drm_kms_helper_hotplug_event().
61 * This callback is not called after @unregister has been called.
62 *
63 * This callback is optional.
64 */
65 int (*hotplug)(struct drm_client_dev *client);
66};
67
68/**
69 * struct drm_client_dev - DRM client instance
70 */
71struct drm_client_dev {
72 /**
73 * @dev: DRM device
74 */
75 struct drm_device *dev;
76
77 /**
78 * @name: Name of the client.
79 */
80 const char *name;
81
82 /**
83 * @list:
84 *
85 * List of all clients of a DRM device, linked into
86 * &drm_device.clientlist. Protected by &drm_device.clientlist_mutex.
87 */
88 struct list_head list;
89
90 /**
91 * @funcs: DRM client functions (optional)
92 */
93 const struct drm_client_funcs *funcs;
94
95 /**
96 * @file: DRM file
97 */
98 struct drm_file *file;
99
100 /**
101 * @modeset_mutex: Protects @modesets.
102 */
103 struct mutex modeset_mutex;
104
105 /**
106 * @modesets: CRTC configurations
107 */
108 struct drm_mode_set *modesets;
109};
110
111int drm_client_init(struct drm_device *dev, struct drm_client_dev *client,
112 const char *name, const struct drm_client_funcs *funcs);
113void drm_client_release(struct drm_client_dev *client);
114void drm_client_register(struct drm_client_dev *client);
115
116void drm_client_dev_unregister(struct drm_device *dev);
117void drm_client_dev_hotplug(struct drm_device *dev);
118void drm_client_dev_restore(struct drm_device *dev);
119
120/**
121 * struct drm_client_buffer - DRM client buffer
122 */
123struct drm_client_buffer {
124 /**
125 * @client: DRM client
126 */
127 struct drm_client_dev *client;
128
129 /**
130 * @pitch: Buffer pitch
131 */
132 u32 pitch;
133
134 /**
135 * @gem: GEM object backing this buffer
136 */
137 struct drm_gem_object *gem;
138
139 /**
140 * @map: Virtual address for the buffer
141 */
142 struct iosys_map map;
143
144 /**
145 * @fb: DRM framebuffer
146 */
147 struct drm_framebuffer *fb;
148};
149
150struct drm_client_buffer *
151drm_client_framebuffer_create(struct drm_client_dev *client, u32 width, u32 height, u32 format);
152void drm_client_framebuffer_delete(struct drm_client_buffer *buffer);
153int drm_client_framebuffer_flush(struct drm_client_buffer *buffer, struct drm_rect *rect);
154int drm_client_buffer_vmap(struct drm_client_buffer *buffer,
155 struct iosys_map *map);
156void drm_client_buffer_vunmap(struct drm_client_buffer *buffer);
157
158int drm_client_modeset_create(struct drm_client_dev *client);
159void drm_client_modeset_free(struct drm_client_dev *client);
160int drm_client_modeset_probe(struct drm_client_dev *client, unsigned int width, unsigned int height);
161bool drm_client_rotation(struct drm_mode_set *modeset, unsigned int *rotation);
162int drm_client_modeset_check(struct drm_client_dev *client);
163int drm_client_modeset_commit_locked(struct drm_client_dev *client);
164int drm_client_modeset_commit(struct drm_client_dev *client);
165int drm_client_modeset_dpms(struct drm_client_dev *client, int mode);
166
167/**
168 * drm_client_for_each_modeset() - Iterate over client modesets
169 * @modeset: &drm_mode_set loop cursor
170 * @client: DRM client
171 */
172#define drm_client_for_each_modeset(modeset, client) \
173 for (({ lockdep_assert_held(&(client)->modeset_mutex); }), \
174 modeset = (client)->modesets; modeset->crtc; modeset++)
175
176/**
177 * drm_client_for_each_connector_iter - connector_list iterator macro
178 * @connector: &struct drm_connector pointer used as cursor
179 * @iter: &struct drm_connector_list_iter
180 *
181 * This iterates the connectors that are useable for internal clients (excludes
182 * writeback connectors).
183 *
184 * For more info see drm_for_each_connector_iter().
185 */
186#define drm_client_for_each_connector_iter(connector, iter) \
187 drm_for_each_connector_iter(connector, iter) \
188 if (connector->connector_type != DRM_MODE_CONNECTOR_WRITEBACK)
189
190void drm_client_debugfs_init(struct drm_minor *minor);
191
192#endif
1/* SPDX-License-Identifier: GPL-2.0 or MIT */
2
3#ifndef _DRM_CLIENT_H_
4#define _DRM_CLIENT_H_
5
6#include <linux/lockdep.h>
7#include <linux/mutex.h>
8#include <linux/types.h>
9
10#include <drm/drm_connector.h>
11#include <drm/drm_crtc.h>
12
13struct drm_client_dev;
14struct drm_device;
15struct drm_file;
16struct drm_framebuffer;
17struct drm_gem_object;
18struct drm_minor;
19struct module;
20
21/**
22 * struct drm_client_funcs - DRM client callbacks
23 */
24struct drm_client_funcs {
25 /**
26 * @owner: The module owner
27 */
28 struct module *owner;
29
30 /**
31 * @unregister:
32 *
33 * Called when &drm_device is unregistered. The client should respond by
34 * releasing its resources using drm_client_release().
35 *
36 * This callback is optional.
37 */
38 void (*unregister)(struct drm_client_dev *client);
39
40 /**
41 * @restore:
42 *
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.
46 *
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().
51 *
52 * This callback is optional.
53 */
54 int (*restore)(struct drm_client_dev *client);
55
56 /**
57 * @hotplug:
58 *
59 * Called on drm_kms_helper_hotplug_event().
60 * This callback is not called after @unregister has been called.
61 *
62 * This callback is optional.
63 */
64 int (*hotplug)(struct drm_client_dev *client);
65};
66
67/**
68 * struct drm_client_dev - DRM client instance
69 */
70struct drm_client_dev {
71 /**
72 * @dev: DRM device
73 */
74 struct drm_device *dev;
75
76 /**
77 * @name: Name of the client.
78 */
79 const char *name;
80
81 /**
82 * @list:
83 *
84 * List of all clients of a DRM device, linked into
85 * &drm_device.clientlist. Protected by &drm_device.clientlist_mutex.
86 */
87 struct list_head list;
88
89 /**
90 * @funcs: DRM client functions (optional)
91 */
92 const struct drm_client_funcs *funcs;
93
94 /**
95 * @file: DRM file
96 */
97 struct drm_file *file;
98
99 /**
100 * @modeset_mutex: Protects @modesets.
101 */
102 struct mutex modeset_mutex;
103
104 /**
105 * @modesets: CRTC configurations
106 */
107 struct drm_mode_set *modesets;
108};
109
110int drm_client_init(struct drm_device *dev, struct drm_client_dev *client,
111 const char *name, const struct drm_client_funcs *funcs);
112void drm_client_release(struct drm_client_dev *client);
113void drm_client_register(struct drm_client_dev *client);
114
115void drm_client_dev_unregister(struct drm_device *dev);
116void drm_client_dev_hotplug(struct drm_device *dev);
117void drm_client_dev_restore(struct drm_device *dev);
118
119/**
120 * struct drm_client_buffer - DRM client buffer
121 */
122struct drm_client_buffer {
123 /**
124 * @client: DRM client
125 */
126 struct drm_client_dev *client;
127
128 /**
129 * @handle: Buffer handle
130 */
131 u32 handle;
132
133 /**
134 * @pitch: Buffer pitch
135 */
136 u32 pitch;
137
138 /**
139 * @gem: GEM object backing this buffer
140 */
141 struct drm_gem_object *gem;
142
143 /**
144 * @vaddr: Virtual address for the buffer
145 */
146 void *vaddr;
147
148 /**
149 * @fb: DRM framebuffer
150 */
151 struct drm_framebuffer *fb;
152};
153
154struct drm_client_buffer *
155drm_client_framebuffer_create(struct drm_client_dev *client, u32 width, u32 height, u32 format);
156void drm_client_framebuffer_delete(struct drm_client_buffer *buffer);
157int drm_client_framebuffer_flush(struct drm_client_buffer *buffer, struct drm_rect *rect);
158void *drm_client_buffer_vmap(struct drm_client_buffer *buffer);
159void drm_client_buffer_vunmap(struct drm_client_buffer *buffer);
160
161int drm_client_modeset_create(struct drm_client_dev *client);
162void drm_client_modeset_free(struct drm_client_dev *client);
163int drm_client_modeset_probe(struct drm_client_dev *client, unsigned int width, unsigned int height);
164bool drm_client_rotation(struct drm_mode_set *modeset, unsigned int *rotation);
165int drm_client_modeset_check(struct drm_client_dev *client);
166int drm_client_modeset_commit_locked(struct drm_client_dev *client);
167int drm_client_modeset_commit(struct drm_client_dev *client);
168int drm_client_modeset_dpms(struct drm_client_dev *client, int mode);
169
170/**
171 * drm_client_for_each_modeset() - Iterate over client modesets
172 * @modeset: &drm_mode_set loop cursor
173 * @client: DRM client
174 */
175#define drm_client_for_each_modeset(modeset, client) \
176 for (({ lockdep_assert_held(&(client)->modeset_mutex); }), \
177 modeset = (client)->modesets; modeset->crtc; modeset++)
178
179/**
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
183 *
184 * This iterates the connectors that are useable for internal clients (excludes
185 * writeback connectors).
186 *
187 * For more info see drm_for_each_connector_iter().
188 */
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)
192
193void drm_client_debugfs_init(struct drm_minor *minor);
194
195#endif