1c76f0f7cSNoralf Trønnes /* SPDX-License-Identifier: GPL-2.0 */ 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 10d81294afSNoralf Trønnes #include <drm/drm_crtc.h> 11d81294afSNoralf Trønnes 12c76f0f7cSNoralf Trønnes struct drm_client_dev; 13c76f0f7cSNoralf Trønnes struct drm_device; 14c76f0f7cSNoralf Trønnes struct drm_file; 15c76f0f7cSNoralf Trønnes struct drm_framebuffer; 16c76f0f7cSNoralf Trønnes struct drm_gem_object; 17e896c132SNoralf Trønnes struct drm_minor; 18c76f0f7cSNoralf Trønnes struct module; 19c76f0f7cSNoralf Trønnes 20d81294afSNoralf Trønnes #define DRM_CLIENT_MAX_CLONED_CONNECTORS 8 21d81294afSNoralf Trønnes 22c76f0f7cSNoralf Trønnes /** 23c76f0f7cSNoralf Trønnes * struct drm_client_funcs - DRM client callbacks 24c76f0f7cSNoralf Trønnes */ 25c76f0f7cSNoralf Trønnes struct drm_client_funcs { 26c76f0f7cSNoralf Trønnes /** 27c76f0f7cSNoralf Trønnes * @owner: The module owner 28c76f0f7cSNoralf Trønnes */ 29c76f0f7cSNoralf Trønnes struct module *owner; 30c76f0f7cSNoralf Trønnes 31c76f0f7cSNoralf Trønnes /** 32c76f0f7cSNoralf Trønnes * @unregister: 33c76f0f7cSNoralf Trønnes * 34c76f0f7cSNoralf Trønnes * Called when &drm_device is unregistered. The client should respond by 351e55a53aSMatt Roper * releasing its resources using drm_client_release(). 36c76f0f7cSNoralf Trønnes * 37c76f0f7cSNoralf Trønnes * This callback is optional. 38c76f0f7cSNoralf Trønnes */ 39c76f0f7cSNoralf Trønnes void (*unregister)(struct drm_client_dev *client); 40c76f0f7cSNoralf Trønnes 41c76f0f7cSNoralf Trønnes /** 42c76f0f7cSNoralf Trønnes * @restore: 43c76f0f7cSNoralf Trønnes * 44c76f0f7cSNoralf Trønnes * Called on drm_lastclose(). The first client instance in the list that 45c76f0f7cSNoralf Trønnes * returns zero gets the privilege to restore and no more clients are 46c76f0f7cSNoralf Trønnes * called. This callback is not called after @unregister has been called. 47c76f0f7cSNoralf Trønnes * 48c76f0f7cSNoralf Trønnes * This callback is optional. 49c76f0f7cSNoralf Trønnes */ 50c76f0f7cSNoralf Trønnes int (*restore)(struct drm_client_dev *client); 51c76f0f7cSNoralf Trønnes 52c76f0f7cSNoralf Trønnes /** 53c76f0f7cSNoralf Trønnes * @hotplug: 54c76f0f7cSNoralf Trønnes * 55c76f0f7cSNoralf Trønnes * Called on drm_kms_helper_hotplug_event(). 56c76f0f7cSNoralf Trønnes * This callback is not called after @unregister has been called. 57c76f0f7cSNoralf Trønnes * 58c76f0f7cSNoralf Trønnes * This callback is optional. 59c76f0f7cSNoralf Trønnes */ 60c76f0f7cSNoralf Trønnes int (*hotplug)(struct drm_client_dev *client); 61c76f0f7cSNoralf Trønnes }; 62c76f0f7cSNoralf Trønnes 63c76f0f7cSNoralf Trønnes /** 64c76f0f7cSNoralf Trønnes * struct drm_client_dev - DRM client instance 65c76f0f7cSNoralf Trønnes */ 66c76f0f7cSNoralf Trønnes struct drm_client_dev { 67c76f0f7cSNoralf Trønnes /** 68c76f0f7cSNoralf Trønnes * @dev: DRM device 69c76f0f7cSNoralf Trønnes */ 70c76f0f7cSNoralf Trønnes struct drm_device *dev; 71c76f0f7cSNoralf Trønnes 72c76f0f7cSNoralf Trønnes /** 73c76f0f7cSNoralf Trønnes * @name: Name of the client. 74c76f0f7cSNoralf Trønnes */ 75c76f0f7cSNoralf Trønnes const char *name; 76c76f0f7cSNoralf Trønnes 77c76f0f7cSNoralf Trønnes /** 78c76f0f7cSNoralf Trønnes * @list: 79c76f0f7cSNoralf Trønnes * 80c76f0f7cSNoralf Trønnes * List of all clients of a DRM device, linked into 81c76f0f7cSNoralf Trønnes * &drm_device.clientlist. Protected by &drm_device.clientlist_mutex. 82c76f0f7cSNoralf Trønnes */ 83c76f0f7cSNoralf Trønnes struct list_head list; 84c76f0f7cSNoralf Trønnes 85c76f0f7cSNoralf Trønnes /** 86c76f0f7cSNoralf Trønnes * @funcs: DRM client functions (optional) 87c76f0f7cSNoralf Trønnes */ 88c76f0f7cSNoralf Trønnes const struct drm_client_funcs *funcs; 89c76f0f7cSNoralf Trønnes 90c76f0f7cSNoralf Trønnes /** 91c76f0f7cSNoralf Trønnes * @file: DRM file 92c76f0f7cSNoralf Trønnes */ 93c76f0f7cSNoralf Trønnes struct drm_file *file; 94d81294afSNoralf Trønnes 95d81294afSNoralf Trønnes /** 96d81294afSNoralf Trønnes * @modeset_mutex: Protects @modesets. 97d81294afSNoralf Trønnes */ 98d81294afSNoralf Trønnes struct mutex modeset_mutex; 99d81294afSNoralf Trønnes 100d81294afSNoralf Trønnes /** 101d81294afSNoralf Trønnes * @modesets: CRTC configurations 102d81294afSNoralf Trønnes */ 103d81294afSNoralf Trønnes struct drm_mode_set *modesets; 104c76f0f7cSNoralf Trønnes }; 105c76f0f7cSNoralf Trønnes 1064d4c2d89SNoralf Trønnes int drm_client_init(struct drm_device *dev, struct drm_client_dev *client, 107c76f0f7cSNoralf Trønnes const char *name, const struct drm_client_funcs *funcs); 108c76f0f7cSNoralf Trønnes void drm_client_release(struct drm_client_dev *client); 109e33898a2SNoralf Trønnes void drm_client_register(struct drm_client_dev *client); 110c76f0f7cSNoralf Trønnes 111c76f0f7cSNoralf Trønnes void drm_client_dev_unregister(struct drm_device *dev); 112c76f0f7cSNoralf Trønnes void drm_client_dev_hotplug(struct drm_device *dev); 113c76f0f7cSNoralf Trønnes void drm_client_dev_restore(struct drm_device *dev); 114c76f0f7cSNoralf Trønnes 115c76f0f7cSNoralf Trønnes /** 116c76f0f7cSNoralf Trønnes * struct drm_client_buffer - DRM client buffer 117c76f0f7cSNoralf Trønnes */ 118c76f0f7cSNoralf Trønnes struct drm_client_buffer { 119c76f0f7cSNoralf Trønnes /** 120c76f0f7cSNoralf Trønnes * @client: DRM client 121c76f0f7cSNoralf Trønnes */ 122c76f0f7cSNoralf Trønnes struct drm_client_dev *client; 123c76f0f7cSNoralf Trønnes 124c76f0f7cSNoralf Trønnes /** 125c76f0f7cSNoralf Trønnes * @handle: Buffer handle 126c76f0f7cSNoralf Trønnes */ 127c76f0f7cSNoralf Trønnes u32 handle; 128c76f0f7cSNoralf Trønnes 129c76f0f7cSNoralf Trønnes /** 130c76f0f7cSNoralf Trønnes * @pitch: Buffer pitch 131c76f0f7cSNoralf Trønnes */ 132c76f0f7cSNoralf Trønnes u32 pitch; 133c76f0f7cSNoralf Trønnes 134c76f0f7cSNoralf Trønnes /** 135c76f0f7cSNoralf Trønnes * @gem: GEM object backing this buffer 136c76f0f7cSNoralf Trønnes */ 137c76f0f7cSNoralf Trønnes struct drm_gem_object *gem; 138c76f0f7cSNoralf Trønnes 139c76f0f7cSNoralf Trønnes /** 140c76f0f7cSNoralf Trønnes * @vaddr: Virtual address for the buffer 141c76f0f7cSNoralf Trønnes */ 142c76f0f7cSNoralf Trønnes void *vaddr; 143c76f0f7cSNoralf Trønnes 144c76f0f7cSNoralf Trønnes /** 145c76f0f7cSNoralf Trønnes * @fb: DRM framebuffer 146c76f0f7cSNoralf Trønnes */ 147c76f0f7cSNoralf Trønnes struct drm_framebuffer *fb; 148c76f0f7cSNoralf Trønnes }; 149c76f0f7cSNoralf Trønnes 150c76f0f7cSNoralf Trønnes struct drm_client_buffer * 151c76f0f7cSNoralf Trønnes drm_client_framebuffer_create(struct drm_client_dev *client, u32 width, u32 height, u32 format); 152c76f0f7cSNoralf Trønnes void drm_client_framebuffer_delete(struct drm_client_buffer *buffer); 153c76f0f7cSNoralf Trønnes 154d81294afSNoralf Trønnes int drm_client_modeset_create(struct drm_client_dev *client); 155d81294afSNoralf Trønnes void drm_client_modeset_free(struct drm_client_dev *client); 156d81294afSNoralf Trønnes void drm_client_modeset_release(struct drm_client_dev *client); 157d81294afSNoralf Trønnes struct drm_mode_set *drm_client_find_modeset(struct drm_client_dev *client, struct drm_crtc *crtc); 158aec3925fSNoralf Trønnes bool drm_client_panel_rotation(struct drm_mode_set *modeset, unsigned int *rotation); 159aec3925fSNoralf Trønnes int drm_client_modeset_commit_force(struct drm_client_dev *client); 160aec3925fSNoralf Trønnes int drm_client_modeset_commit(struct drm_client_dev *client); 161aec3925fSNoralf Trønnes int drm_client_modeset_dpms(struct drm_client_dev *client, int mode); 162d81294afSNoralf Trønnes 163d81294afSNoralf Trønnes /** 164d81294afSNoralf Trønnes * drm_client_for_each_modeset() - Iterate over client modesets 165d81294afSNoralf Trønnes * @modeset: &drm_mode_set loop cursor 166d81294afSNoralf Trønnes * @client: DRM client 167d81294afSNoralf Trønnes */ 168d81294afSNoralf Trønnes #define drm_client_for_each_modeset(modeset, client) \ 169d81294afSNoralf Trønnes for (({ lockdep_assert_held(&(client)->modeset_mutex); }), \ 170d81294afSNoralf Trønnes modeset = (client)->modesets; modeset->crtc; modeset++) 171d81294afSNoralf Trønnes 172e896c132SNoralf Trønnes int drm_client_debugfs_init(struct drm_minor *minor); 173e896c132SNoralf Trønnes 174c76f0f7cSNoralf Trønnes #endif 175