1df0e7f7eSEmmanuel Vadot // SPDX-License-Identifier: GPL-2.0 or MIT
2c76f0f7cSNoralf Trønnes /*
3c76f0f7cSNoralf Trønnes * Copyright 2018 Noralf Trønnes
4c76f0f7cSNoralf Trønnes */
5c76f0f7cSNoralf Trønnes
67938f421SLucas De Marchi #include <linux/iosys-map.h>
7c76f0f7cSNoralf Trønnes #include <linux/list.h>
8c76f0f7cSNoralf Trønnes #include <linux/mutex.h>
9c76f0f7cSNoralf Trønnes #include <linux/seq_file.h>
10c76f0f7cSNoralf Trønnes #include <linux/slab.h>
11c76f0f7cSNoralf Trønnes
12c76f0f7cSNoralf Trønnes #include <drm/drm_client.h>
13c76f0f7cSNoralf Trønnes #include <drm/drm_debugfs.h>
14c76f0f7cSNoralf Trønnes #include <drm/drm_device.h>
15c76f0f7cSNoralf Trønnes #include <drm/drm_drv.h>
16c76f0f7cSNoralf Trønnes #include <drm/drm_file.h>
17c76f0f7cSNoralf Trønnes #include <drm/drm_fourcc.h>
180500c04eSSam Ravnborg #include <drm/drm_framebuffer.h>
19c76f0f7cSNoralf Trønnes #include <drm/drm_gem.h>
20c76f0f7cSNoralf Trønnes #include <drm/drm_mode.h>
21c76f0f7cSNoralf Trønnes #include <drm/drm_print.h>
22c76f0f7cSNoralf Trønnes
23c76f0f7cSNoralf Trønnes #include "drm_crtc_internal.h"
24c76f0f7cSNoralf Trønnes #include "drm_internal.h"
25c76f0f7cSNoralf Trønnes
26c76f0f7cSNoralf Trønnes /**
27c76f0f7cSNoralf Trønnes * DOC: overview
28c76f0f7cSNoralf Trønnes *
29c76f0f7cSNoralf Trønnes * This library provides support for clients running in the kernel like fbdev and bootsplash.
30c76f0f7cSNoralf Trønnes *
31c76f0f7cSNoralf Trønnes * GEM drivers which provide a GEM based dumb buffer with a virtual address are supported.
32c76f0f7cSNoralf Trønnes */
33c76f0f7cSNoralf Trønnes
drm_client_open(struct drm_client_dev * client)34c76f0f7cSNoralf Trønnes static int drm_client_open(struct drm_client_dev *client)
35c76f0f7cSNoralf Trønnes {
36c76f0f7cSNoralf Trønnes struct drm_device *dev = client->dev;
37c76f0f7cSNoralf Trønnes struct drm_file *file;
38c76f0f7cSNoralf Trønnes
39c76f0f7cSNoralf Trønnes file = drm_file_alloc(dev->primary);
40c76f0f7cSNoralf Trønnes if (IS_ERR(file))
41c76f0f7cSNoralf Trønnes return PTR_ERR(file);
42c76f0f7cSNoralf Trønnes
43c76f0f7cSNoralf Trønnes mutex_lock(&dev->filelist_mutex);
44c76f0f7cSNoralf Trønnes list_add(&file->lhead, &dev->filelist_internal);
45c76f0f7cSNoralf Trønnes mutex_unlock(&dev->filelist_mutex);
46c76f0f7cSNoralf Trønnes
47c76f0f7cSNoralf Trønnes client->file = file;
48c76f0f7cSNoralf Trønnes
49c76f0f7cSNoralf Trønnes return 0;
50c76f0f7cSNoralf Trønnes }
51c76f0f7cSNoralf Trønnes
drm_client_close(struct drm_client_dev * client)52c76f0f7cSNoralf Trønnes static void drm_client_close(struct drm_client_dev *client)
53c76f0f7cSNoralf Trønnes {
54c76f0f7cSNoralf Trønnes struct drm_device *dev = client->dev;
55c76f0f7cSNoralf Trønnes
56c76f0f7cSNoralf Trønnes mutex_lock(&dev->filelist_mutex);
57c76f0f7cSNoralf Trønnes list_del(&client->file->lhead);
58c76f0f7cSNoralf Trønnes mutex_unlock(&dev->filelist_mutex);
59c76f0f7cSNoralf Trønnes
60c76f0f7cSNoralf Trønnes drm_file_free(client->file);
61c76f0f7cSNoralf Trønnes }
62c76f0f7cSNoralf Trønnes
63c76f0f7cSNoralf Trønnes /**
644d4c2d89SNoralf Trønnes * drm_client_init - Initialise a DRM client
65c76f0f7cSNoralf Trønnes * @dev: DRM device
66c76f0f7cSNoralf Trønnes * @client: DRM client
67c76f0f7cSNoralf Trønnes * @name: Client name
68c76f0f7cSNoralf Trønnes * @funcs: DRM client functions (optional)
69c76f0f7cSNoralf Trønnes *
70e33898a2SNoralf Trønnes * This initialises the client and opens a &drm_file.
71e33898a2SNoralf Trønnes * Use drm_client_register() to complete the process.
72c76f0f7cSNoralf Trønnes * The caller needs to hold a reference on @dev before calling this function.
73c76f0f7cSNoralf Trønnes * The client is freed when the &drm_device is unregistered. See drm_client_release().
74c76f0f7cSNoralf Trønnes *
75c76f0f7cSNoralf Trønnes * Returns:
76c76f0f7cSNoralf Trønnes * Zero on success or negative error code on failure.
77c76f0f7cSNoralf Trønnes */
drm_client_init(struct drm_device * dev,struct drm_client_dev * client,const char * name,const struct drm_client_funcs * funcs)784d4c2d89SNoralf Trønnes int drm_client_init(struct drm_device *dev, struct drm_client_dev *client,
79c76f0f7cSNoralf Trønnes const char *name, const struct drm_client_funcs *funcs)
80c76f0f7cSNoralf Trønnes {
81c76f0f7cSNoralf Trønnes int ret;
82c76f0f7cSNoralf Trønnes
83b39b5394SNoralf Trønnes if (!drm_core_check_feature(dev, DRIVER_MODESET) || !dev->driver->dumb_create)
8469fdf420SChris Wilson return -EOPNOTSUPP;
85c76f0f7cSNoralf Trønnes
86c76f0f7cSNoralf Trønnes client->dev = dev;
87c76f0f7cSNoralf Trønnes client->name = name;
88c76f0f7cSNoralf Trønnes client->funcs = funcs;
89c76f0f7cSNoralf Trønnes
90d81294afSNoralf Trønnes ret = drm_client_modeset_create(client);
91c76f0f7cSNoralf Trønnes if (ret)
92312292a4SThomas Zimmermann return ret;
93c76f0f7cSNoralf Trønnes
94d81294afSNoralf Trønnes ret = drm_client_open(client);
95d81294afSNoralf Trønnes if (ret)
96d81294afSNoralf Trønnes goto err_free;
97d81294afSNoralf Trønnes
98c76f0f7cSNoralf Trønnes drm_dev_get(dev);
99c76f0f7cSNoralf Trønnes
100c76f0f7cSNoralf Trønnes return 0;
101c76f0f7cSNoralf Trønnes
102d81294afSNoralf Trønnes err_free:
103d81294afSNoralf Trønnes drm_client_modeset_free(client);
104c76f0f7cSNoralf Trønnes return ret;
105c76f0f7cSNoralf Trønnes }
1064d4c2d89SNoralf Trønnes EXPORT_SYMBOL(drm_client_init);
1074d4c2d89SNoralf Trønnes
1084d4c2d89SNoralf Trønnes /**
109e33898a2SNoralf Trønnes * drm_client_register - Register client
1104d4c2d89SNoralf Trønnes * @client: DRM client
1114d4c2d89SNoralf Trønnes *
1124d4c2d89SNoralf Trønnes * Add the client to the &drm_device client list to activate its callbacks.
1134d4c2d89SNoralf Trønnes * @client must be initialized by a call to drm_client_init(). After
114e33898a2SNoralf Trønnes * drm_client_register() it is no longer permissible to call drm_client_release()
1154d4c2d89SNoralf Trønnes * directly (outside the unregister callback), instead cleanup will happen
1164d4c2d89SNoralf Trønnes * automatically on driver unload.
11727655b9bSThomas Zimmermann *
11827655b9bSThomas Zimmermann * Registering a client generates a hotplug event that allows the client
11927655b9bSThomas Zimmermann * to set up its display from pre-existing outputs. The client must have
12027655b9bSThomas Zimmermann * initialized its state to able to handle the hotplug event successfully.
1214d4c2d89SNoralf Trønnes */
drm_client_register(struct drm_client_dev * client)122e33898a2SNoralf Trønnes void drm_client_register(struct drm_client_dev *client)
1234d4c2d89SNoralf Trønnes {
1244d4c2d89SNoralf Trønnes struct drm_device *dev = client->dev;
12527655b9bSThomas Zimmermann int ret;
1264d4c2d89SNoralf Trønnes
1274d4c2d89SNoralf Trønnes mutex_lock(&dev->clientlist_mutex);
1284d4c2d89SNoralf Trønnes list_add(&client->list, &dev->clientlist);
12927655b9bSThomas Zimmermann
13027655b9bSThomas Zimmermann if (client->funcs && client->funcs->hotplug) {
13127655b9bSThomas Zimmermann /*
13227655b9bSThomas Zimmermann * Perform an initial hotplug event to pick up the
13327655b9bSThomas Zimmermann * display configuration for the client. This step
13427655b9bSThomas Zimmermann * has to be performed *after* registering the client
13527655b9bSThomas Zimmermann * in the list of clients, or a concurrent hotplug
13627655b9bSThomas Zimmermann * event might be lost; leaving the display off.
13727655b9bSThomas Zimmermann *
13827655b9bSThomas Zimmermann * Hold the clientlist_mutex as for a regular hotplug
13927655b9bSThomas Zimmermann * event.
14027655b9bSThomas Zimmermann */
14127655b9bSThomas Zimmermann ret = client->funcs->hotplug(client);
14227655b9bSThomas Zimmermann if (ret)
14327655b9bSThomas Zimmermann drm_dbg_kms(dev, "client hotplug ret=%d\n", ret);
14427655b9bSThomas Zimmermann }
1454d4c2d89SNoralf Trønnes mutex_unlock(&dev->clientlist_mutex);
1464d4c2d89SNoralf Trønnes }
147e33898a2SNoralf Trønnes EXPORT_SYMBOL(drm_client_register);
148c76f0f7cSNoralf Trønnes
149c76f0f7cSNoralf Trønnes /**
150c76f0f7cSNoralf Trønnes * drm_client_release - Release DRM client resources
151c76f0f7cSNoralf Trønnes * @client: DRM client
152c76f0f7cSNoralf Trønnes *
1534d4c2d89SNoralf Trønnes * Releases resources by closing the &drm_file that was opened by drm_client_init().
154c76f0f7cSNoralf Trønnes * It is called automatically if the &drm_client_funcs.unregister callback is _not_ set.
155c76f0f7cSNoralf Trønnes *
156c76f0f7cSNoralf Trønnes * This function should only be called from the unregister callback. An exception
157c76f0f7cSNoralf Trønnes * is fbdev which cannot free the buffer if userspace has open file descriptors.
158c76f0f7cSNoralf Trønnes *
159c76f0f7cSNoralf Trønnes * Note:
160c76f0f7cSNoralf Trønnes * Clients cannot initiate a release by themselves. This is done to keep the code simple.
161c76f0f7cSNoralf Trønnes * The driver has to be unloaded before the client can be unloaded.
162c76f0f7cSNoralf Trønnes */
drm_client_release(struct drm_client_dev * client)163c76f0f7cSNoralf Trønnes void drm_client_release(struct drm_client_dev *client)
164c76f0f7cSNoralf Trønnes {
165c76f0f7cSNoralf Trønnes struct drm_device *dev = client->dev;
166c76f0f7cSNoralf Trønnes
16741cb6603SJani Nikula drm_dbg_kms(dev, "%s\n", client->name);
168c76f0f7cSNoralf Trønnes
169d81294afSNoralf Trønnes drm_client_modeset_free(client);
170c76f0f7cSNoralf Trønnes drm_client_close(client);
171c76f0f7cSNoralf Trønnes drm_dev_put(dev);
172c76f0f7cSNoralf Trønnes }
173c76f0f7cSNoralf Trønnes EXPORT_SYMBOL(drm_client_release);
174c76f0f7cSNoralf Trønnes
175acc29d50SThomas Zimmermann /**
176acc29d50SThomas Zimmermann * drm_client_dev_unregister - Unregister clients
177acc29d50SThomas Zimmermann * @dev: DRM device
178acc29d50SThomas Zimmermann *
179acc29d50SThomas Zimmermann * This function releases all clients by calling each client's
180acc29d50SThomas Zimmermann * &drm_client_funcs.unregister callback. The callback function
181acc29d50SThomas Zimmermann * is responsibe for releaseing all resources including the client
182acc29d50SThomas Zimmermann * itself.
183acc29d50SThomas Zimmermann *
184acc29d50SThomas Zimmermann * The helper drm_dev_unregister() calls this function. Drivers
185acc29d50SThomas Zimmermann * that use it don't need to call this function themselves.
186acc29d50SThomas Zimmermann */
drm_client_dev_unregister(struct drm_device * dev)187c76f0f7cSNoralf Trønnes void drm_client_dev_unregister(struct drm_device *dev)
188c76f0f7cSNoralf Trønnes {
189c76f0f7cSNoralf Trønnes struct drm_client_dev *client, *tmp;
190c76f0f7cSNoralf Trønnes
191c76f0f7cSNoralf Trønnes if (!drm_core_check_feature(dev, DRIVER_MODESET))
192c76f0f7cSNoralf Trønnes return;
193c76f0f7cSNoralf Trønnes
194c76f0f7cSNoralf Trønnes mutex_lock(&dev->clientlist_mutex);
195c76f0f7cSNoralf Trønnes list_for_each_entry_safe(client, tmp, &dev->clientlist, list) {
196c76f0f7cSNoralf Trønnes list_del(&client->list);
197c76f0f7cSNoralf Trønnes if (client->funcs && client->funcs->unregister) {
198c76f0f7cSNoralf Trønnes client->funcs->unregister(client);
199c76f0f7cSNoralf Trønnes } else {
200c76f0f7cSNoralf Trønnes drm_client_release(client);
201c76f0f7cSNoralf Trønnes kfree(client);
202c76f0f7cSNoralf Trønnes }
203c76f0f7cSNoralf Trønnes }
204c76f0f7cSNoralf Trønnes mutex_unlock(&dev->clientlist_mutex);
205c76f0f7cSNoralf Trønnes }
206acc29d50SThomas Zimmermann EXPORT_SYMBOL(drm_client_dev_unregister);
207c76f0f7cSNoralf Trønnes
208c76f0f7cSNoralf Trønnes /**
209c76f0f7cSNoralf Trønnes * drm_client_dev_hotplug - Send hotplug event to clients
210c76f0f7cSNoralf Trønnes * @dev: DRM device
211c76f0f7cSNoralf Trønnes *
212c76f0f7cSNoralf Trønnes * This function calls the &drm_client_funcs.hotplug callback on the attached clients.
213c76f0f7cSNoralf Trønnes *
214c76f0f7cSNoralf Trønnes * drm_kms_helper_hotplug_event() calls this function, so drivers that use it
215c76f0f7cSNoralf Trønnes * don't need to call this function themselves.
216c76f0f7cSNoralf Trønnes */
drm_client_dev_hotplug(struct drm_device * dev)217c76f0f7cSNoralf Trønnes void drm_client_dev_hotplug(struct drm_device *dev)
218c76f0f7cSNoralf Trønnes {
219c76f0f7cSNoralf Trønnes struct drm_client_dev *client;
220c76f0f7cSNoralf Trønnes int ret;
221c76f0f7cSNoralf Trønnes
222c76f0f7cSNoralf Trønnes if (!drm_core_check_feature(dev, DRIVER_MODESET))
223c76f0f7cSNoralf Trønnes return;
224c76f0f7cSNoralf Trønnes
225c2bb3be6SThomas Zimmermann if (!dev->mode_config.num_connector) {
226c2bb3be6SThomas Zimmermann drm_dbg_kms(dev, "No connectors found, will not send hotplug events!\n");
227c2bb3be6SThomas Zimmermann return;
228c2bb3be6SThomas Zimmermann }
229c2bb3be6SThomas Zimmermann
230c76f0f7cSNoralf Trønnes mutex_lock(&dev->clientlist_mutex);
231c76f0f7cSNoralf Trønnes list_for_each_entry(client, &dev->clientlist, list) {
232c76f0f7cSNoralf Trønnes if (!client->funcs || !client->funcs->hotplug)
233c76f0f7cSNoralf Trønnes continue;
234c76f0f7cSNoralf Trønnes
2356a9d5ad3SThomas Zimmermann if (client->hotplug_failed)
2366a9d5ad3SThomas Zimmermann continue;
2376a9d5ad3SThomas Zimmermann
238c76f0f7cSNoralf Trønnes ret = client->funcs->hotplug(client);
23941cb6603SJani Nikula drm_dbg_kms(dev, "%s: ret=%d\n", client->name, ret);
2406a9d5ad3SThomas Zimmermann if (ret)
2416a9d5ad3SThomas Zimmermann client->hotplug_failed = true;
242c76f0f7cSNoralf Trønnes }
243c76f0f7cSNoralf Trønnes mutex_unlock(&dev->clientlist_mutex);
244c76f0f7cSNoralf Trønnes }
245c76f0f7cSNoralf Trønnes EXPORT_SYMBOL(drm_client_dev_hotplug);
246c76f0f7cSNoralf Trønnes
drm_client_dev_restore(struct drm_device * dev)247c76f0f7cSNoralf Trønnes void drm_client_dev_restore(struct drm_device *dev)
248c76f0f7cSNoralf Trønnes {
249c76f0f7cSNoralf Trønnes struct drm_client_dev *client;
250c76f0f7cSNoralf Trønnes int ret;
251c76f0f7cSNoralf Trønnes
252c76f0f7cSNoralf Trønnes if (!drm_core_check_feature(dev, DRIVER_MODESET))
253c76f0f7cSNoralf Trønnes return;
254c76f0f7cSNoralf Trønnes
255c76f0f7cSNoralf Trønnes mutex_lock(&dev->clientlist_mutex);
256c76f0f7cSNoralf Trønnes list_for_each_entry(client, &dev->clientlist, list) {
257c76f0f7cSNoralf Trønnes if (!client->funcs || !client->funcs->restore)
258c76f0f7cSNoralf Trønnes continue;
259c76f0f7cSNoralf Trønnes
260c76f0f7cSNoralf Trønnes ret = client->funcs->restore(client);
26141cb6603SJani Nikula drm_dbg_kms(dev, "%s: ret=%d\n", client->name, ret);
262c76f0f7cSNoralf Trønnes if (!ret) /* The first one to return zero gets the privilege to restore */
263c76f0f7cSNoralf Trønnes break;
264c76f0f7cSNoralf Trønnes }
265c76f0f7cSNoralf Trønnes mutex_unlock(&dev->clientlist_mutex);
266c76f0f7cSNoralf Trønnes }
267c76f0f7cSNoralf Trønnes
drm_client_buffer_delete(struct drm_client_buffer * buffer)268c76f0f7cSNoralf Trønnes static void drm_client_buffer_delete(struct drm_client_buffer *buffer)
269c76f0f7cSNoralf Trønnes {
270444bbba7SDmitry Osipenko if (buffer->gem) {
27127b2ae65SDmitry Osipenko drm_gem_vunmap_unlocked(buffer->gem, &buffer->map);
272be6ee102SEmil Velikov drm_gem_object_put(buffer->gem);
273444bbba7SDmitry Osipenko }
274c76f0f7cSNoralf Trønnes
275c76f0f7cSNoralf Trønnes kfree(buffer);
276c76f0f7cSNoralf Trønnes }
277c76f0f7cSNoralf Trønnes
278c76f0f7cSNoralf Trønnes static struct drm_client_buffer *
drm_client_buffer_create(struct drm_client_dev * client,u32 width,u32 height,u32 format,u32 * handle)27985e26dd5SChristian König drm_client_buffer_create(struct drm_client_dev *client, u32 width, u32 height,
28085e26dd5SChristian König u32 format, u32 *handle)
281c76f0f7cSNoralf Trønnes {
28224c478eaSMaxime Ripard const struct drm_format_info *info = drm_format_info(format);
283c76f0f7cSNoralf Trønnes struct drm_mode_create_dumb dumb_args = { };
284c76f0f7cSNoralf Trønnes struct drm_device *dev = client->dev;
285c76f0f7cSNoralf Trønnes struct drm_client_buffer *buffer;
286c76f0f7cSNoralf Trønnes struct drm_gem_object *obj;
287c76f0f7cSNoralf Trønnes int ret;
288c76f0f7cSNoralf Trønnes
289c76f0f7cSNoralf Trønnes buffer = kzalloc(sizeof(*buffer), GFP_KERNEL);
290c76f0f7cSNoralf Trønnes if (!buffer)
291c76f0f7cSNoralf Trønnes return ERR_PTR(-ENOMEM);
292c76f0f7cSNoralf Trønnes
293c76f0f7cSNoralf Trønnes buffer->client = client;
294c76f0f7cSNoralf Trønnes
295c76f0f7cSNoralf Trønnes dumb_args.width = width;
296c76f0f7cSNoralf Trønnes dumb_args.height = height;
297356d2c8eSGeert Uytterhoeven dumb_args.bpp = drm_format_info_bpp(info, 0);
298c76f0f7cSNoralf Trønnes ret = drm_mode_create_dumb(dev, &dumb_args, client->file);
299c76f0f7cSNoralf Trønnes if (ret)
300cf19fa2cSNoralf Trønnes goto err_delete;
301c76f0f7cSNoralf Trønnes
302c76f0f7cSNoralf Trønnes obj = drm_gem_object_lookup(client->file, dumb_args.handle);
303c76f0f7cSNoralf Trønnes if (!obj) {
304c76f0f7cSNoralf Trønnes ret = -ENOENT;
305c76f0f7cSNoralf Trønnes goto err_delete;
306c76f0f7cSNoralf Trønnes }
307c76f0f7cSNoralf Trønnes
30885e26dd5SChristian König buffer->pitch = dumb_args.pitch;
309c76f0f7cSNoralf Trønnes buffer->gem = obj;
31085e26dd5SChristian König *handle = dumb_args.handle;
311c76f0f7cSNoralf Trønnes
312c76f0f7cSNoralf Trønnes return buffer;
313c76f0f7cSNoralf Trønnes
314c76f0f7cSNoralf Trønnes err_delete:
315c76f0f7cSNoralf Trønnes drm_client_buffer_delete(buffer);
316c76f0f7cSNoralf Trønnes
317c76f0f7cSNoralf Trønnes return ERR_PTR(ret);
318c76f0f7cSNoralf Trønnes }
319c76f0f7cSNoralf Trønnes
32015dd0fc8SThomas Zimmermann /**
321b4b0193eSThomas Zimmermann * drm_client_buffer_vmap_local - Map DRM client buffer into address space
322b4b0193eSThomas Zimmermann * @buffer: DRM client buffer
323b4b0193eSThomas Zimmermann * @map_copy: Returns the mapped memory's address
324b4b0193eSThomas Zimmermann *
325b4b0193eSThomas Zimmermann * This function maps a client buffer into kernel address space. If the
326b4b0193eSThomas Zimmermann * buffer is already mapped, it returns the existing mapping's address.
327b4b0193eSThomas Zimmermann *
328b4b0193eSThomas Zimmermann * Client buffer mappings are not ref'counted. Each call to
329b4b0193eSThomas Zimmermann * drm_client_buffer_vmap_local() should be closely followed by a call to
330b4b0193eSThomas Zimmermann * drm_client_buffer_vunmap_local(). See drm_client_buffer_vmap() for
331b4b0193eSThomas Zimmermann * long-term mappings.
332b4b0193eSThomas Zimmermann *
333b4b0193eSThomas Zimmermann * The returned address is a copy of the internal value. In contrast to
334b4b0193eSThomas Zimmermann * other vmap interfaces, you don't need it for the client's vunmap
335b4b0193eSThomas Zimmermann * function. So you can modify it at will during blit and draw operations.
336b4b0193eSThomas Zimmermann *
337b4b0193eSThomas Zimmermann * Returns:
338b4b0193eSThomas Zimmermann * 0 on success, or a negative errno code otherwise.
339b4b0193eSThomas Zimmermann */
drm_client_buffer_vmap_local(struct drm_client_buffer * buffer,struct iosys_map * map_copy)340b4b0193eSThomas Zimmermann int drm_client_buffer_vmap_local(struct drm_client_buffer *buffer,
341b4b0193eSThomas Zimmermann struct iosys_map *map_copy)
342b4b0193eSThomas Zimmermann {
343b4b0193eSThomas Zimmermann struct drm_gem_object *gem = buffer->gem;
344b4b0193eSThomas Zimmermann struct iosys_map *map = &buffer->map;
345b4b0193eSThomas Zimmermann int ret;
346b4b0193eSThomas Zimmermann
347b4b0193eSThomas Zimmermann drm_gem_lock(gem);
348b4b0193eSThomas Zimmermann
349b4b0193eSThomas Zimmermann ret = drm_gem_vmap(gem, map);
350b4b0193eSThomas Zimmermann if (ret)
351b4b0193eSThomas Zimmermann goto err_drm_gem_vmap_unlocked;
352b4b0193eSThomas Zimmermann *map_copy = *map;
353b4b0193eSThomas Zimmermann
354b4b0193eSThomas Zimmermann return 0;
355b4b0193eSThomas Zimmermann
356b4b0193eSThomas Zimmermann err_drm_gem_vmap_unlocked:
357b4b0193eSThomas Zimmermann drm_gem_unlock(gem);
358*b5fbf924SDan Carpenter return ret;
359b4b0193eSThomas Zimmermann }
360b4b0193eSThomas Zimmermann EXPORT_SYMBOL(drm_client_buffer_vmap_local);
361b4b0193eSThomas Zimmermann
362b4b0193eSThomas Zimmermann /**
363b4b0193eSThomas Zimmermann * drm_client_buffer_vunmap_local - Unmap DRM client buffer
364b4b0193eSThomas Zimmermann * @buffer: DRM client buffer
365b4b0193eSThomas Zimmermann *
366b4b0193eSThomas Zimmermann * This function removes a client buffer's memory mapping established
367b4b0193eSThomas Zimmermann * with drm_client_buffer_vunmap_local(). Calling this function is only
368b4b0193eSThomas Zimmermann * required by clients that manage their buffer mappings by themselves.
369b4b0193eSThomas Zimmermann */
drm_client_buffer_vunmap_local(struct drm_client_buffer * buffer)370b4b0193eSThomas Zimmermann void drm_client_buffer_vunmap_local(struct drm_client_buffer *buffer)
371b4b0193eSThomas Zimmermann {
372b4b0193eSThomas Zimmermann struct drm_gem_object *gem = buffer->gem;
373b4b0193eSThomas Zimmermann struct iosys_map *map = &buffer->map;
374b4b0193eSThomas Zimmermann
375b4b0193eSThomas Zimmermann drm_gem_vunmap(gem, map);
376b4b0193eSThomas Zimmermann drm_gem_unlock(gem);
377b4b0193eSThomas Zimmermann }
378b4b0193eSThomas Zimmermann EXPORT_SYMBOL(drm_client_buffer_vunmap_local);
379b4b0193eSThomas Zimmermann
380b4b0193eSThomas Zimmermann /**
38115dd0fc8SThomas Zimmermann * drm_client_buffer_vmap - Map DRM client buffer into address space
38215dd0fc8SThomas Zimmermann * @buffer: DRM client buffer
383a8595556SThomas Zimmermann * @map_copy: Returns the mapped memory's address
38415dd0fc8SThomas Zimmermann *
38515dd0fc8SThomas Zimmermann * This function maps a client buffer into kernel address space. If the
386a8595556SThomas Zimmermann * buffer is already mapped, it returns the existing mapping's address.
38715dd0fc8SThomas Zimmermann *
38815dd0fc8SThomas Zimmermann * Client buffer mappings are not ref'counted. Each call to
38915dd0fc8SThomas Zimmermann * drm_client_buffer_vmap() should be followed by a call to
39015dd0fc8SThomas Zimmermann * drm_client_buffer_vunmap(); or the client buffer should be mapped
391cf1ca9aeSThomas Zimmermann * throughout its lifetime.
39215dd0fc8SThomas Zimmermann *
393a8595556SThomas Zimmermann * The returned address is a copy of the internal value. In contrast to
394a8595556SThomas Zimmermann * other vmap interfaces, you don't need it for the client's vunmap
395a8595556SThomas Zimmermann * function. So you can modify it at will during blit and draw operations.
396a8595556SThomas Zimmermann *
39715dd0fc8SThomas Zimmermann * Returns:
398a8595556SThomas Zimmermann * 0 on success, or a negative errno code otherwise.
39915dd0fc8SThomas Zimmermann */
400a8595556SThomas Zimmermann int
drm_client_buffer_vmap(struct drm_client_buffer * buffer,struct iosys_map * map_copy)4017938f421SLucas De Marchi drm_client_buffer_vmap(struct drm_client_buffer *buffer,
4027938f421SLucas De Marchi struct iosys_map *map_copy)
40315dd0fc8SThomas Zimmermann {
4041709474bSThomas Zimmermann struct drm_gem_object *gem = buffer->gem;
4057938f421SLucas De Marchi struct iosys_map *map = &buffer->map;
406a745fb1cSThomas Zimmermann int ret;
40715dd0fc8SThomas Zimmermann
4081709474bSThomas Zimmermann drm_gem_lock(gem);
4091709474bSThomas Zimmermann
4101709474bSThomas Zimmermann ret = drm_gem_pin_locked(gem);
411a745fb1cSThomas Zimmermann if (ret)
4121709474bSThomas Zimmermann goto err_drm_gem_pin_locked;
4131709474bSThomas Zimmermann ret = drm_gem_vmap(gem, map);
4141709474bSThomas Zimmermann if (ret)
4151709474bSThomas Zimmermann goto err_drm_gem_vmap;
4161709474bSThomas Zimmermann
4171709474bSThomas Zimmermann drm_gem_unlock(gem);
41815dd0fc8SThomas Zimmermann
419a8595556SThomas Zimmermann *map_copy = *map;
42015dd0fc8SThomas Zimmermann
421a8595556SThomas Zimmermann return 0;
4221709474bSThomas Zimmermann
4231709474bSThomas Zimmermann err_drm_gem_vmap:
4241709474bSThomas Zimmermann drm_gem_unpin_locked(buffer->gem);
4251709474bSThomas Zimmermann err_drm_gem_pin_locked:
4261709474bSThomas Zimmermann drm_gem_unlock(gem);
4271709474bSThomas Zimmermann return ret;
42815dd0fc8SThomas Zimmermann }
42915dd0fc8SThomas Zimmermann EXPORT_SYMBOL(drm_client_buffer_vmap);
43015dd0fc8SThomas Zimmermann
43115dd0fc8SThomas Zimmermann /**
43215dd0fc8SThomas Zimmermann * drm_client_buffer_vunmap - Unmap DRM client buffer
43315dd0fc8SThomas Zimmermann * @buffer: DRM client buffer
43415dd0fc8SThomas Zimmermann *
435cf1ca9aeSThomas Zimmermann * This function removes a client buffer's memory mapping. Calling this
436cf1ca9aeSThomas Zimmermann * function is only required by clients that manage their buffer mappings
437cf1ca9aeSThomas Zimmermann * by themselves.
43815dd0fc8SThomas Zimmermann */
drm_client_buffer_vunmap(struct drm_client_buffer * buffer)43915dd0fc8SThomas Zimmermann void drm_client_buffer_vunmap(struct drm_client_buffer *buffer)
44015dd0fc8SThomas Zimmermann {
4411709474bSThomas Zimmermann struct drm_gem_object *gem = buffer->gem;
4427938f421SLucas De Marchi struct iosys_map *map = &buffer->map;
443a745fb1cSThomas Zimmermann
4441709474bSThomas Zimmermann drm_gem_lock(gem);
4451709474bSThomas Zimmermann drm_gem_vunmap(gem, map);
4461709474bSThomas Zimmermann drm_gem_unpin_locked(gem);
4471709474bSThomas Zimmermann drm_gem_unlock(gem);
44815dd0fc8SThomas Zimmermann }
44915dd0fc8SThomas Zimmermann EXPORT_SYMBOL(drm_client_buffer_vunmap);
45015dd0fc8SThomas Zimmermann
drm_client_buffer_rmfb(struct drm_client_buffer * buffer)451c76f0f7cSNoralf Trønnes static void drm_client_buffer_rmfb(struct drm_client_buffer *buffer)
452c76f0f7cSNoralf Trønnes {
453c76f0f7cSNoralf Trønnes int ret;
454c76f0f7cSNoralf Trønnes
455c76f0f7cSNoralf Trønnes if (!buffer->fb)
456c76f0f7cSNoralf Trønnes return;
457c76f0f7cSNoralf Trønnes
458c76f0f7cSNoralf Trønnes ret = drm_mode_rmfb(buffer->client->dev, buffer->fb->base.id, buffer->client->file);
459c76f0f7cSNoralf Trønnes if (ret)
46041cb6603SJani Nikula drm_err(buffer->client->dev,
461c76f0f7cSNoralf Trønnes "Error removing FB:%u (%d)\n", buffer->fb->base.id, ret);
462c76f0f7cSNoralf Trønnes
463c76f0f7cSNoralf Trønnes buffer->fb = NULL;
464c76f0f7cSNoralf Trønnes }
465c76f0f7cSNoralf Trønnes
drm_client_buffer_addfb(struct drm_client_buffer * buffer,u32 width,u32 height,u32 format,u32 handle)466c76f0f7cSNoralf Trønnes static int drm_client_buffer_addfb(struct drm_client_buffer *buffer,
46785e26dd5SChristian König u32 width, u32 height, u32 format,
46885e26dd5SChristian König u32 handle)
469c76f0f7cSNoralf Trønnes {
470c76f0f7cSNoralf Trønnes struct drm_client_dev *client = buffer->client;
4716ae2ff23SGeert Uytterhoeven struct drm_mode_fb_cmd2 fb_req = { };
472c76f0f7cSNoralf Trønnes int ret;
473c76f0f7cSNoralf Trønnes
474c76f0f7cSNoralf Trønnes fb_req.width = width;
475c76f0f7cSNoralf Trønnes fb_req.height = height;
4766ae2ff23SGeert Uytterhoeven fb_req.pixel_format = format;
4776ae2ff23SGeert Uytterhoeven fb_req.handles[0] = handle;
4786ae2ff23SGeert Uytterhoeven fb_req.pitches[0] = buffer->pitch;
479c76f0f7cSNoralf Trønnes
4806ae2ff23SGeert Uytterhoeven ret = drm_mode_addfb2(client->dev, &fb_req, client->file);
481c76f0f7cSNoralf Trønnes if (ret)
482c76f0f7cSNoralf Trønnes return ret;
483c76f0f7cSNoralf Trønnes
484c76f0f7cSNoralf Trønnes buffer->fb = drm_framebuffer_lookup(client->dev, buffer->client->file, fb_req.fb_id);
485c76f0f7cSNoralf Trønnes if (WARN_ON(!buffer->fb))
486c76f0f7cSNoralf Trønnes return -ENOENT;
487c76f0f7cSNoralf Trønnes
488c76f0f7cSNoralf Trønnes /* drop the reference we picked up in framebuffer lookup */
489c76f0f7cSNoralf Trønnes drm_framebuffer_put(buffer->fb);
490c76f0f7cSNoralf Trønnes
491c76f0f7cSNoralf Trønnes strscpy(buffer->fb->comm, client->name, TASK_COMM_LEN);
492c76f0f7cSNoralf Trønnes
493c76f0f7cSNoralf Trønnes return 0;
494c76f0f7cSNoralf Trønnes }
495c76f0f7cSNoralf Trønnes
496c76f0f7cSNoralf Trønnes /**
497c76f0f7cSNoralf Trønnes * drm_client_framebuffer_create - Create a client framebuffer
498c76f0f7cSNoralf Trønnes * @client: DRM client
499c76f0f7cSNoralf Trønnes * @width: Framebuffer width
500c76f0f7cSNoralf Trønnes * @height: Framebuffer height
501c76f0f7cSNoralf Trønnes * @format: Buffer format
502c76f0f7cSNoralf Trønnes *
503c76f0f7cSNoralf Trønnes * This function creates a &drm_client_buffer which consists of a
504c76f0f7cSNoralf Trønnes * &drm_framebuffer backed by a dumb buffer.
505c76f0f7cSNoralf Trønnes * Call drm_client_framebuffer_delete() to free the buffer.
506c76f0f7cSNoralf Trønnes *
507c76f0f7cSNoralf Trønnes * Returns:
508c76f0f7cSNoralf Trønnes * Pointer to a client buffer or an error pointer on failure.
509c76f0f7cSNoralf Trønnes */
510c76f0f7cSNoralf Trønnes struct drm_client_buffer *
drm_client_framebuffer_create(struct drm_client_dev * client,u32 width,u32 height,u32 format)511c76f0f7cSNoralf Trønnes drm_client_framebuffer_create(struct drm_client_dev *client, u32 width, u32 height, u32 format)
512c76f0f7cSNoralf Trønnes {
513c76f0f7cSNoralf Trønnes struct drm_client_buffer *buffer;
51485e26dd5SChristian König u32 handle;
515c76f0f7cSNoralf Trønnes int ret;
516c76f0f7cSNoralf Trønnes
51785e26dd5SChristian König buffer = drm_client_buffer_create(client, width, height, format,
51885e26dd5SChristian König &handle);
519c76f0f7cSNoralf Trønnes if (IS_ERR(buffer))
520c76f0f7cSNoralf Trønnes return buffer;
521c76f0f7cSNoralf Trønnes
52285e26dd5SChristian König ret = drm_client_buffer_addfb(buffer, width, height, format, handle);
52385e26dd5SChristian König
52485e26dd5SChristian König /*
52585e26dd5SChristian König * The handle is only needed for creating the framebuffer, destroy it
52685e26dd5SChristian König * again to solve a circular dependency should anybody export the GEM
52785e26dd5SChristian König * object as DMA-buf. The framebuffer and our buffer structure are still
52885e26dd5SChristian König * holding references to the GEM object to prevent its destruction.
52985e26dd5SChristian König */
53085e26dd5SChristian König drm_mode_destroy_dumb(client->dev, handle, client->file);
53185e26dd5SChristian König
532c76f0f7cSNoralf Trønnes if (ret) {
533c76f0f7cSNoralf Trønnes drm_client_buffer_delete(buffer);
534c76f0f7cSNoralf Trønnes return ERR_PTR(ret);
535c76f0f7cSNoralf Trønnes }
536c76f0f7cSNoralf Trønnes
537c76f0f7cSNoralf Trønnes return buffer;
538c76f0f7cSNoralf Trønnes }
539c76f0f7cSNoralf Trønnes EXPORT_SYMBOL(drm_client_framebuffer_create);
540c76f0f7cSNoralf Trønnes
541c76f0f7cSNoralf Trønnes /**
542c76f0f7cSNoralf Trønnes * drm_client_framebuffer_delete - Delete a client framebuffer
543c76f0f7cSNoralf Trønnes * @buffer: DRM client buffer (can be NULL)
544c76f0f7cSNoralf Trønnes */
drm_client_framebuffer_delete(struct drm_client_buffer * buffer)545c76f0f7cSNoralf Trønnes void drm_client_framebuffer_delete(struct drm_client_buffer *buffer)
546c76f0f7cSNoralf Trønnes {
547c76f0f7cSNoralf Trønnes if (!buffer)
548c76f0f7cSNoralf Trønnes return;
549c76f0f7cSNoralf Trønnes
550c76f0f7cSNoralf Trønnes drm_client_buffer_rmfb(buffer);
551c76f0f7cSNoralf Trønnes drm_client_buffer_delete(buffer);
552c76f0f7cSNoralf Trønnes }
553c76f0f7cSNoralf Trønnes EXPORT_SYMBOL(drm_client_framebuffer_delete);
554e896c132SNoralf Trønnes
555c9c03e3cSNoralf Trønnes /**
556c9c03e3cSNoralf Trønnes * drm_client_framebuffer_flush - Manually flush client framebuffer
557c9c03e3cSNoralf Trønnes * @buffer: DRM client buffer (can be NULL)
558c9c03e3cSNoralf Trønnes * @rect: Damage rectangle (if NULL flushes all)
559c9c03e3cSNoralf Trønnes *
560c9c03e3cSNoralf Trønnes * This calls &drm_framebuffer_funcs->dirty (if present) to flush buffer changes
561c9c03e3cSNoralf Trønnes * for drivers that need it.
562c9c03e3cSNoralf Trønnes *
563c9c03e3cSNoralf Trønnes * Returns:
564c9c03e3cSNoralf Trønnes * Zero on success or negative error code on failure.
565c9c03e3cSNoralf Trønnes */
drm_client_framebuffer_flush(struct drm_client_buffer * buffer,struct drm_rect * rect)566c9c03e3cSNoralf Trønnes int drm_client_framebuffer_flush(struct drm_client_buffer *buffer, struct drm_rect *rect)
567c9c03e3cSNoralf Trønnes {
568c9c03e3cSNoralf Trønnes if (!buffer || !buffer->fb || !buffer->fb->funcs->dirty)
569c9c03e3cSNoralf Trønnes return 0;
570c9c03e3cSNoralf Trønnes
571c9c03e3cSNoralf Trønnes if (rect) {
572c9c03e3cSNoralf Trønnes struct drm_clip_rect clip = {
573c9c03e3cSNoralf Trønnes .x1 = rect->x1,
574c9c03e3cSNoralf Trønnes .y1 = rect->y1,
575c9c03e3cSNoralf Trønnes .x2 = rect->x2,
576c9c03e3cSNoralf Trønnes .y2 = rect->y2,
577c9c03e3cSNoralf Trønnes };
578c9c03e3cSNoralf Trønnes
579c9c03e3cSNoralf Trønnes return buffer->fb->funcs->dirty(buffer->fb, buffer->client->file,
580c9c03e3cSNoralf Trønnes 0, 0, &clip, 1);
581c9c03e3cSNoralf Trønnes }
582c9c03e3cSNoralf Trønnes
583c9c03e3cSNoralf Trønnes return buffer->fb->funcs->dirty(buffer->fb, buffer->client->file,
584c9c03e3cSNoralf Trønnes 0, 0, NULL, 0);
585c9c03e3cSNoralf Trønnes }
586c9c03e3cSNoralf Trønnes EXPORT_SYMBOL(drm_client_framebuffer_flush);
587c9c03e3cSNoralf Trønnes
588e896c132SNoralf Trønnes #ifdef CONFIG_DEBUG_FS
drm_client_debugfs_internal_clients(struct seq_file * m,void * data)589e896c132SNoralf Trønnes static int drm_client_debugfs_internal_clients(struct seq_file *m, void *data)
590e896c132SNoralf Trønnes {
5916fd80729SMaíra Canal struct drm_debugfs_entry *entry = m->private;
5926fd80729SMaíra Canal struct drm_device *dev = entry->dev;
593e896c132SNoralf Trønnes struct drm_printer p = drm_seq_file_printer(m);
594e896c132SNoralf Trønnes struct drm_client_dev *client;
595e896c132SNoralf Trønnes
596e896c132SNoralf Trønnes mutex_lock(&dev->clientlist_mutex);
597e896c132SNoralf Trønnes list_for_each_entry(client, &dev->clientlist, list)
598e896c132SNoralf Trønnes drm_printf(&p, "%s\n", client->name);
599e896c132SNoralf Trønnes mutex_unlock(&dev->clientlist_mutex);
600e896c132SNoralf Trønnes
601e896c132SNoralf Trønnes return 0;
602e896c132SNoralf Trønnes }
603e896c132SNoralf Trønnes
6046fd80729SMaíra Canal static const struct drm_debugfs_info drm_client_debugfs_list[] = {
605e896c132SNoralf Trønnes { "internal_clients", drm_client_debugfs_internal_clients, 0 },
606e896c132SNoralf Trønnes };
607e896c132SNoralf Trønnes
drm_client_debugfs_init(struct drm_device * dev)6080b30d57aSChristian König void drm_client_debugfs_init(struct drm_device *dev)
609e896c132SNoralf Trønnes {
6100b30d57aSChristian König drm_debugfs_add_files(dev, drm_client_debugfs_list,
6116fd80729SMaíra Canal ARRAY_SIZE(drm_client_debugfs_list));
612e896c132SNoralf Trønnes }
613e896c132SNoralf Trønnes #endif
614