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