Definition:

struct drm_client_funcs {    struct module *owner;    void (*free)(struct drm_client_dev *client);    void (*unregister)(struct drm_client_dev *client);    int (*restore)(struct drm_client_dev *client, bool force);    int (*hotplug)(struct drm_client_dev *client);    int (*suspend)(struct drm_client_dev *client);    int (*resume)(struct drm_client_dev *client);};

Members

owner

The module owner

free

Called when the client gets unregistered. Implementations shouldrelease all client-specific data and free the memory.

This callback is optional.

unregister

Called whendrm_device is unregistered. The client should respond byreleasing its resources usingdrm_client_release().

This callback is optional.

restore

Called ondrm_lastclose(). The first client instance in the list thatreturns zero gets the privilege to restore and no more clients arecalled. This callback is not called afterunregister has been called.

Note that the core does not guarantee exclusion against concurrentdrm_open(). Clients need to ensure this themselves, for example byusingdrm_master_internal_acquire() anddrm_master_internal_release().

If the caller passes force, the client should ignore any present DRMmaster and restore the display anyway.

This callback is optional.

hotplug

Called ondrm_kms_helper_hotplug_event().This callback is not called afterunregister has been called.

This callback is optional.

suspend

Called when suspending the device.

This callback is optional.

resume

Called when resuming the device from suspend.

This callback is optional.

Definition:

struct drm_client_dev {    struct drm_device *dev;    const char *name;    struct list_head list;    const struct drm_client_funcs *funcs;    struct drm_file *file;    struct mutex modeset_mutex;    struct drm_mode_set *modesets;    bool suspended;    bool hotplug_pending;    bool hotplug_failed;};

Members

dev

DRM device

name

Name of the client.

list

List of all clients of a DRM device, linked intodrm_device.clientlist. Protected bydrm_device.clientlist_mutex.

funcs

DRM client functions (optional)

file

DRM file

modeset_mutex

Protectsmodesets.

modesets

CRTC configurations

suspended

The client has been suspended.

hotplug_pending

A hotplug event has been received while the client was suspended.Try again on resume.

hotplug_failed

Set by client hotplug helpers if the hotplugging failedbefore. It is usually not tried again.

Definition:

struct drm_client_buffer {    struct drm_client_dev *client;    struct drm_gem_object *gem;    struct iosys_map map;    struct drm_framebuffer *fb;};

Members

client

DRM client

gem

GEM object backing this buffer

FIXME: The DRM framebuffer holds a reference on its GEMbuffer objects. Do not use this field in new code andupdate existing users.

map

Virtual address for the buffer

fb

DRM framebuffer

Parameters

modeset

drm_mode_set loop cursor

client

DRM client

Parameters

connector

structdrm_connector pointer used as cursor

iter

structdrm_connector_list_iter

Description

This iterates the connectors that are useable for internal clients (excludeswriteback connectors).

For more info seedrm_for_each_connector_iter().

Parameters

structdrm_device*dev

DRM device

structdrm_client_dev*client

DRM client

constchar*name

Client name

conststructdrm_client_funcs*funcs

DRM client functions (optional)

Description

This initialises the client and opens adrm_file.Usedrm_client_register() to complete the process.The caller needs to hold a reference ondev before calling this function.The client is freed when thedrm_device is unregistered. Seedrm_client_release().

Return

Zero on success or negative error code on failure.

Parameters

structdrm_client_dev*client

DRM client

Description

Add the client to thedrm_device client list to activate its callbacks.client must be initialized by a call todrm_client_init(). Afterdrm_client_register() it is no longer permissible to calldrm_client_release()directly (outside the unregister callback), instead cleanup will happenautomatically on driver unload.

Registering a client generates a hotplug event that allows the clientto set up its display from pre-existing outputs. The client must haveinitialized its state to able to handle the hotplug event successfully.

Parameters

structdrm_client_dev*client

DRM client

Description

Releases resources by closing thedrm_file that was opened bydrm_client_init().It is called automatically if thedrm_client_funcs.unregister callback is _not_ set.

This function should only be called from the unregister callback. An exceptionis fbdev which cannot free the buffer if userspace has open file descriptors.

Note

Clients cannot initiate a release by themselves. This is done to keep the code simple.The driver has to be unloaded before the client can be unloaded.

Parameters

structdrm_client_buffer*buffer

DRM client buffer

Parameters

structdrm_client_buffer*buffer

DRM client buffer

structiosys_map*map_copy

Returns the mapped memory’s address

Description

This function maps a client buffer into kernel address space. If thebuffer is already mapped, it returns the existing mapping’s address.

Client buffer mappings are not ref’counted. Each call todrm_client_buffer_vmap_local() should be closely followed by a call todrm_client_buffer_vunmap_local(). Seedrm_client_buffer_vmap() forlong-term mappings.

The returned address is a copy of the internal value. In contrast toother vmap interfaces, you don’t need it for the client’s vunmapfunction. So you can modify it at will during blit and draw operations.

Return

0 on success, or a negative errno code otherwise.

Parameters

structdrm_client_buffer*buffer

DRM client buffer

Description

This function removes a client buffer’s memory mapping establishedwithdrm_client_buffer_vunmap_local(). Calling this function is onlyrequired by clients that manage their buffer mappings by themselves.

Parameters

structdrm_client_buffer*buffer

DRM client buffer

structiosys_map*map_copy

Returns the mapped memory’s address

Description

This function maps a client buffer into kernel address space. If thebuffer is already mapped, it returns the existing mapping’s address.

Client buffer mappings are not ref’counted. Each call todrm_client_buffer_vmap() should be followed by a call todrm_client_buffer_vunmap(); or the client buffer should be mappedthroughout its lifetime.

The returned address is a copy of the internal value. In contrast toother vmap interfaces, you don’t need it for the client’s vunmapfunction. So you can modify it at will during blit and draw operations.

Return

0 on success, or a negative errno code otherwise.

Parameters

structdrm_client_buffer*buffer

DRM client buffer

Description

This function removes a client buffer’s memory mapping. Calling thisfunction is only required by clients that manage their buffer mappingsby themselves.

Parameters

structdrm_client_dev*client

DRM client

u32width

Framebuffer width

u32height

Framebuffer height

u32format

Buffer format

Description

This function creates adrm_client_buffer which consists of adrm_framebuffer backed by a dumb buffer.Calldrm_client_buffer_delete() to free the buffer.

Return

Pointer to a client buffer or an error pointer on failure.

Parameters

structdrm_client_buffer*buffer

DRM client buffer

structdrm_rect*rect

Damage rectangle (if NULL flushes all)

Description

This callsdrm_framebuffer_funcs->dirty (if present) to flush buffer changesfor drivers that need it.

Return

Zero on success or negative error code on failure.

Parameters

structdrm_client_dev*client

DRM client

unsignedintwidth

Maximum display mode width (optional)

unsignedintheight

Maximum display mode height (optional)

Description

This function sets up display pipelines for enabled connectors and stores theconfig in the client’s modeset array.

Return

Zero on success or negative error code on failure.

Parameters

structdrm_mode_set*modeset

DRM modeset

unsignedint*rotation

Returned rotation value

Description

This function checks if the primary plane inmodeset can hw rotateto match the rotation needed on its connector.

Note

Currently only 0 and 180 degrees are supported.

Return

True if the plane can do the rotation, false otherwise.

Parameters

structdrm_client_dev*client

DRM client

Description

Check modeset configuration.

Return

Zero on success or negative error code on failure.

Parameters

structdrm_client_dev*client

DRM client

Description

Commit modeset configuration to crtcs without checking if there is a DRMmaster. The assumption is that the caller already holds an internal DRMmaster reference acquired withdrm_master_internal_acquire().

Return

Zero on success or negative error code on failure.

Parameters

structdrm_client_dev*client

DRM client

Description

Commit modeset configuration to crtcs.

Return

Zero on success or negative error code on failure.

Parameters

structdrm_client_dev*client

DRM client

intmode

DPMS mode

Note

For atomic driversmode is reduced to on/off.

Return

Zero on success or negative error code on failure.

Parameters

structdrm_client_dev*client

DRM client

unsignedintcrtc_index

The ndex of the CRTC to wait on

Description

Block the caller until the given CRTC has seen a VBLANK. Do nothingif the CRTC is disabled. If there’s another DRM master present, failwith -EBUSY.

Return

0 on success, or negative error code otherwise.

Parameters

structdrm_device*dev

DRM device

Description

This function releases all clients by calling each client’sdrm_client_funcs.unregister callback. The callback functionis responsibe for releaseing all resources including the clientitself.

The helperdrm_dev_unregister() calls this function. Driversthat use it don’t need to call this function themselves.

Parameters

structdrm_device*dev

DRM device

Description

This function calls thedrm_client_funcs.hotplug callback on the attached clients.

drm_kms_helper_hotplug_event() calls this function, so drivers that use itdon’t need to call this function themselves.