211 lines · c
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 callbacks24 */25struct drm_client_funcs {26 /**27 * @owner: The module owner28 */29 struct module *owner;30 31 /**32 * @unregister:33 *34 * Called when &drm_device is unregistered. The client should respond by35 * 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 that45 * returns zero gets the privilege to restore and no more clients are46 * called. This callback is not called after @unregister has been called.47 *48 * Note that the core does not guarantee exclusion against concurrent49 * drm_open(). Clients need to ensure this themselves, for example by50 * using drm_master_internal_acquire() and51 * 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 instance70 */71struct drm_client_dev {72 /**73 * @dev: DRM device74 */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 into86 * &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 file97 */98 struct drm_file *file;99 100 /**101 * @modeset_mutex: Protects @modesets.102 */103 struct mutex modeset_mutex;104 105 /**106 * @modesets: CRTC configurations107 */108 struct drm_mode_set *modesets;109 110 /**111 * @hotplug_failed:112 *113 * Set by client hotplug helpers if the hotplugging failed114 * before. It is usually not tried again.115 */116 bool hotplug_failed;117};118 119int drm_client_init(struct drm_device *dev, struct drm_client_dev *client,120 const char *name, const struct drm_client_funcs *funcs);121void drm_client_release(struct drm_client_dev *client);122void drm_client_register(struct drm_client_dev *client);123 124void drm_client_dev_unregister(struct drm_device *dev);125void drm_client_dev_hotplug(struct drm_device *dev);126void drm_client_dev_restore(struct drm_device *dev);127 128/**129 * struct drm_client_buffer - DRM client buffer130 */131struct drm_client_buffer {132 /**133 * @client: DRM client134 */135 struct drm_client_dev *client;136 137 /**138 * @pitch: Buffer pitch139 */140 u32 pitch;141 142 /**143 * @gem: GEM object backing this buffer144 *145 * FIXME: The dependency on GEM here isn't required, we could146 * convert the driver handle to a dma-buf instead and use the147 * backend-agnostic dma-buf vmap support instead. This would148 * require that the handle2fd prime ioctl is reworked to pull the149 * fd_install step out of the driver backend hooks, to make that150 * final step optional for internal users.151 */152 struct drm_gem_object *gem;153 154 /**155 * @map: Virtual address for the buffer156 */157 struct iosys_map map;158 159 /**160 * @fb: DRM framebuffer161 */162 struct drm_framebuffer *fb;163};164 165struct drm_client_buffer *166drm_client_framebuffer_create(struct drm_client_dev *client, u32 width, u32 height, u32 format);167void drm_client_framebuffer_delete(struct drm_client_buffer *buffer);168int drm_client_framebuffer_flush(struct drm_client_buffer *buffer, struct drm_rect *rect);169int drm_client_buffer_vmap_local(struct drm_client_buffer *buffer,170 struct iosys_map *map_copy);171void drm_client_buffer_vunmap_local(struct drm_client_buffer *buffer);172int drm_client_buffer_vmap(struct drm_client_buffer *buffer,173 struct iosys_map *map);174void drm_client_buffer_vunmap(struct drm_client_buffer *buffer);175 176int drm_client_modeset_create(struct drm_client_dev *client);177void drm_client_modeset_free(struct drm_client_dev *client);178int drm_client_modeset_probe(struct drm_client_dev *client, unsigned int width, unsigned int height);179bool drm_client_rotation(struct drm_mode_set *modeset, unsigned int *rotation);180int drm_client_modeset_check(struct drm_client_dev *client);181int drm_client_modeset_commit_locked(struct drm_client_dev *client);182int drm_client_modeset_commit(struct drm_client_dev *client);183int drm_client_modeset_dpms(struct drm_client_dev *client, int mode);184 185/**186 * drm_client_for_each_modeset() - Iterate over client modesets187 * @modeset: &drm_mode_set loop cursor188 * @client: DRM client189 */190#define drm_client_for_each_modeset(modeset, client) \191 for (({ lockdep_assert_held(&(client)->modeset_mutex); }), \192 modeset = (client)->modesets; modeset->crtc; modeset++)193 194/**195 * drm_client_for_each_connector_iter - connector_list iterator macro196 * @connector: &struct drm_connector pointer used as cursor197 * @iter: &struct drm_connector_list_iter198 *199 * This iterates the connectors that are useable for internal clients (excludes200 * writeback connectors).201 *202 * For more info see drm_for_each_connector_iter().203 */204#define drm_client_for_each_connector_iter(connector, iter) \205 drm_for_each_connector_iter(connector, iter) \206 if (connector->connector_type != DRM_MODE_CONNECTOR_WRITEBACK)207 208void drm_client_debugfs_init(struct drm_device *dev);209 210#endif211