1935774cdSBrian Starkey // SPDX-License-Identifier: GPL-2.0
2935774cdSBrian Starkey /*
3935774cdSBrian Starkey * (C) COPYRIGHT 2016 ARM Limited. All rights reserved.
4935774cdSBrian Starkey * Author: Brian Starkey <brian.starkey@arm.com>
5935774cdSBrian Starkey *
6935774cdSBrian Starkey * This program is free software and is provided to you under the terms of the
7935774cdSBrian Starkey * GNU General Public License version 2 as published by the Free Software
8935774cdSBrian Starkey * Foundation, and any use by you of this program is subject to the terms
9935774cdSBrian Starkey * of such GNU licence.
10935774cdSBrian Starkey */
11935774cdSBrian Starkey
120500c04eSSam Ravnborg #include <linux/dma-fence.h>
130500c04eSSam Ravnborg
14935774cdSBrian Starkey #include <drm/drm_crtc.h>
150500c04eSSam Ravnborg #include <drm/drm_device.h>
160500c04eSSam Ravnborg #include <drm/drm_drv.h>
17*720cf96dSVille Syrjälä #include <drm/drm_framebuffer.h>
18935774cdSBrian Starkey #include <drm/drm_modeset_helper_vtables.h>
19935774cdSBrian Starkey #include <drm/drm_property.h>
20935774cdSBrian Starkey #include <drm/drm_writeback.h>
21935774cdSBrian Starkey
22935774cdSBrian Starkey /**
23935774cdSBrian Starkey * DOC: overview
24935774cdSBrian Starkey *
25935774cdSBrian Starkey * Writeback connectors are used to expose hardware which can write the output
26935774cdSBrian Starkey * from a CRTC to a memory buffer. They are used and act similarly to other
27935774cdSBrian Starkey * types of connectors, with some important differences:
2873915b2bSBoris Brezillon *
2973915b2bSBoris Brezillon * * Writeback connectors don't provide a way to output visually to the user.
3073915b2bSBoris Brezillon *
3171a5cb3eSAlexandru Gheorghe * * Writeback connectors are visible to userspace only when the client sets
3271a5cb3eSAlexandru Gheorghe * DRM_CLIENT_CAP_WRITEBACK_CONNECTORS.
3373915b2bSBoris Brezillon *
3473915b2bSBoris Brezillon * * Writeback connectors don't have EDID.
35935774cdSBrian Starkey *
36935774cdSBrian Starkey * A framebuffer may only be attached to a writeback connector when the
37935774cdSBrian Starkey * connector is attached to a CRTC. The WRITEBACK_FB_ID property which sets the
38935774cdSBrian Starkey * framebuffer applies only to a single commit (see below). A framebuffer may
39935774cdSBrian Starkey * not be attached while the CRTC is off.
40935774cdSBrian Starkey *
41b13cc8ddSBrian Starkey * Unlike with planes, when a writeback framebuffer is removed by userspace DRM
42b13cc8ddSBrian Starkey * makes no attempt to remove it from active use by the connector. This is
43b13cc8ddSBrian Starkey * because no method is provided to abort a writeback operation, and in any
44b13cc8ddSBrian Starkey * case making a new commit whilst a writeback is ongoing is undefined (see
45b13cc8ddSBrian Starkey * WRITEBACK_OUT_FENCE_PTR below). As soon as the current writeback is finished,
46b13cc8ddSBrian Starkey * the framebuffer will automatically no longer be in active use. As it will
47b13cc8ddSBrian Starkey * also have already been removed from the framebuffer list, there will be no
48b13cc8ddSBrian Starkey * way for any userspace application to retrieve a reference to it in the
49b13cc8ddSBrian Starkey * intervening period.
50b13cc8ddSBrian Starkey *
51935774cdSBrian Starkey * Writeback connectors have some additional properties, which userspace
52935774cdSBrian Starkey * can use to query and control them:
53935774cdSBrian Starkey *
54935774cdSBrian Starkey * "WRITEBACK_FB_ID":
55935774cdSBrian Starkey * Write-only object property storing a DRM_MODE_OBJECT_FB: it stores the
56935774cdSBrian Starkey * framebuffer to be written by the writeback connector. This property is
57935774cdSBrian Starkey * similar to the FB_ID property on planes, but will always read as zero
58935774cdSBrian Starkey * and is not preserved across commits.
59935774cdSBrian Starkey * Userspace must set this property to an output buffer every time it
60935774cdSBrian Starkey * wishes the buffer to get filled.
61935774cdSBrian Starkey *
62935774cdSBrian Starkey * "WRITEBACK_PIXEL_FORMATS":
63935774cdSBrian Starkey * Immutable blob property to store the supported pixel formats table. The
64935774cdSBrian Starkey * data is an array of u32 DRM_FORMAT_* fourcc values.
65935774cdSBrian Starkey * Userspace can use this blob to find out what pixel formats are supported
66935774cdSBrian Starkey * by the connector's writeback engine.
67b13cc8ddSBrian Starkey *
68b13cc8ddSBrian Starkey * "WRITEBACK_OUT_FENCE_PTR":
69b13cc8ddSBrian Starkey * Userspace can use this property to provide a pointer for the kernel to
70b13cc8ddSBrian Starkey * fill with a sync_file file descriptor, which will signal once the
71b13cc8ddSBrian Starkey * writeback is finished. The value should be the address of a 32-bit
72b13cc8ddSBrian Starkey * signed integer, cast to a u64.
73b13cc8ddSBrian Starkey * Userspace should wait for this fence to signal before making another
74b13cc8ddSBrian Starkey * commit affecting any of the same CRTCs, Planes or Connectors.
75b13cc8ddSBrian Starkey * **Failure to do so will result in undefined behaviour.**
76b13cc8ddSBrian Starkey * For this reason it is strongly recommended that all userspace
77b13cc8ddSBrian Starkey * applications making use of writeback connectors *always* retrieve an
78b13cc8ddSBrian Starkey * out-fence for the commit and use it appropriately.
79b13cc8ddSBrian Starkey * From userspace, this property will always read as zero.
80935774cdSBrian Starkey */
81935774cdSBrian Starkey
82b13cc8ddSBrian Starkey #define fence_to_wb_connector(x) container_of(x->lock, \
83b13cc8ddSBrian Starkey struct drm_writeback_connector, \
84b13cc8ddSBrian Starkey fence_lock)
85b13cc8ddSBrian Starkey
drm_writeback_fence_get_driver_name(struct dma_fence * fence)86b13cc8ddSBrian Starkey static const char *drm_writeback_fence_get_driver_name(struct dma_fence *fence)
87b13cc8ddSBrian Starkey {
88b13cc8ddSBrian Starkey struct drm_writeback_connector *wb_connector =
89b13cc8ddSBrian Starkey fence_to_wb_connector(fence);
90b13cc8ddSBrian Starkey
91b13cc8ddSBrian Starkey return wb_connector->base.dev->driver->name;
92b13cc8ddSBrian Starkey }
93b13cc8ddSBrian Starkey
94b13cc8ddSBrian Starkey static const char *
drm_writeback_fence_get_timeline_name(struct dma_fence * fence)95b13cc8ddSBrian Starkey drm_writeback_fence_get_timeline_name(struct dma_fence *fence)
96b13cc8ddSBrian Starkey {
97b13cc8ddSBrian Starkey struct drm_writeback_connector *wb_connector =
98b13cc8ddSBrian Starkey fence_to_wb_connector(fence);
99b13cc8ddSBrian Starkey
100b13cc8ddSBrian Starkey return wb_connector->timeline_name;
101b13cc8ddSBrian Starkey }
102b13cc8ddSBrian Starkey
drm_writeback_fence_enable_signaling(struct dma_fence * fence)103b13cc8ddSBrian Starkey static bool drm_writeback_fence_enable_signaling(struct dma_fence *fence)
104b13cc8ddSBrian Starkey {
105b13cc8ddSBrian Starkey return true;
106b13cc8ddSBrian Starkey }
107b13cc8ddSBrian Starkey
108b13cc8ddSBrian Starkey static const struct dma_fence_ops drm_writeback_fence_ops = {
109b13cc8ddSBrian Starkey .get_driver_name = drm_writeback_fence_get_driver_name,
110b13cc8ddSBrian Starkey .get_timeline_name = drm_writeback_fence_get_timeline_name,
111b13cc8ddSBrian Starkey .enable_signaling = drm_writeback_fence_enable_signaling,
112b13cc8ddSBrian Starkey };
113b13cc8ddSBrian Starkey
create_writeback_properties(struct drm_device * dev)114935774cdSBrian Starkey static int create_writeback_properties(struct drm_device *dev)
115935774cdSBrian Starkey {
116935774cdSBrian Starkey struct drm_property *prop;
117935774cdSBrian Starkey
118935774cdSBrian Starkey if (!dev->mode_config.writeback_fb_id_property) {
119935774cdSBrian Starkey prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
120935774cdSBrian Starkey "WRITEBACK_FB_ID",
121935774cdSBrian Starkey DRM_MODE_OBJECT_FB);
122935774cdSBrian Starkey if (!prop)
123935774cdSBrian Starkey return -ENOMEM;
124935774cdSBrian Starkey dev->mode_config.writeback_fb_id_property = prop;
125935774cdSBrian Starkey }
126935774cdSBrian Starkey
127935774cdSBrian Starkey if (!dev->mode_config.writeback_pixel_formats_property) {
128935774cdSBrian Starkey prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
129935774cdSBrian Starkey DRM_MODE_PROP_ATOMIC |
130935774cdSBrian Starkey DRM_MODE_PROP_IMMUTABLE,
131935774cdSBrian Starkey "WRITEBACK_PIXEL_FORMATS", 0);
132935774cdSBrian Starkey if (!prop)
133935774cdSBrian Starkey return -ENOMEM;
134935774cdSBrian Starkey dev->mode_config.writeback_pixel_formats_property = prop;
135935774cdSBrian Starkey }
136935774cdSBrian Starkey
137b13cc8ddSBrian Starkey if (!dev->mode_config.writeback_out_fence_ptr_property) {
138b13cc8ddSBrian Starkey prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
139b13cc8ddSBrian Starkey "WRITEBACK_OUT_FENCE_PTR", 0,
140b13cc8ddSBrian Starkey U64_MAX);
141b13cc8ddSBrian Starkey if (!prop)
142b13cc8ddSBrian Starkey return -ENOMEM;
143b13cc8ddSBrian Starkey dev->mode_config.writeback_out_fence_ptr_property = prop;
144b13cc8ddSBrian Starkey }
145b13cc8ddSBrian Starkey
146935774cdSBrian Starkey return 0;
147935774cdSBrian Starkey }
148935774cdSBrian Starkey
149935774cdSBrian Starkey static const struct drm_encoder_funcs drm_writeback_encoder_funcs = {
150935774cdSBrian Starkey .destroy = drm_encoder_cleanup,
151935774cdSBrian Starkey };
152935774cdSBrian Starkey
153935774cdSBrian Starkey /**
154935774cdSBrian Starkey * drm_writeback_connector_init - Initialize a writeback connector and its properties
155935774cdSBrian Starkey * @dev: DRM device
156935774cdSBrian Starkey * @wb_connector: Writeback connector to initialize
157935774cdSBrian Starkey * @con_funcs: Connector funcs vtable
158935774cdSBrian Starkey * @enc_helper_funcs: Encoder helper funcs vtable to be used by the internal encoder
159935774cdSBrian Starkey * @formats: Array of supported pixel formats for the writeback engine
160935774cdSBrian Starkey * @n_formats: Length of the formats array
16157b8280aSAbhinav Kumar * @possible_crtcs: possible crtcs for the internal writeback encoder
162935774cdSBrian Starkey *
163935774cdSBrian Starkey * This function creates the writeback-connector-specific properties if they
164935774cdSBrian Starkey * have not been already created, initializes the connector as
165935774cdSBrian Starkey * type DRM_MODE_CONNECTOR_WRITEBACK, and correctly initializes the property
166935774cdSBrian Starkey * values. It will also create an internal encoder associated with the
167935774cdSBrian Starkey * drm_writeback_connector and set it to use the @enc_helper_funcs vtable for
168935774cdSBrian Starkey * the encoder helper.
169935774cdSBrian Starkey *
170935774cdSBrian Starkey * Drivers should always use this function instead of drm_connector_init() to
171935774cdSBrian Starkey * set up writeback connectors.
172935774cdSBrian Starkey *
173935774cdSBrian Starkey * Returns: 0 on success, or a negative error code
174935774cdSBrian Starkey */
drm_writeback_connector_init(struct drm_device * dev,struct drm_writeback_connector * wb_connector,const struct drm_connector_funcs * con_funcs,const struct drm_encoder_helper_funcs * enc_helper_funcs,const u32 * formats,int n_formats,u32 possible_crtcs)175935774cdSBrian Starkey int drm_writeback_connector_init(struct drm_device *dev,
176935774cdSBrian Starkey struct drm_writeback_connector *wb_connector,
177935774cdSBrian Starkey const struct drm_connector_funcs *con_funcs,
178935774cdSBrian Starkey const struct drm_encoder_helper_funcs *enc_helper_funcs,
17957b8280aSAbhinav Kumar const u32 *formats, int n_formats,
18057b8280aSAbhinav Kumar u32 possible_crtcs)
181935774cdSBrian Starkey {
1827933aecfSAbhinav Kumar int ret = 0;
1837933aecfSAbhinav Kumar
1847933aecfSAbhinav Kumar drm_encoder_helper_add(&wb_connector->encoder, enc_helper_funcs);
1857933aecfSAbhinav Kumar
1867933aecfSAbhinav Kumar wb_connector->encoder.possible_crtcs = possible_crtcs;
1877933aecfSAbhinav Kumar
1887933aecfSAbhinav Kumar ret = drm_encoder_init(dev, &wb_connector->encoder,
1897933aecfSAbhinav Kumar &drm_writeback_encoder_funcs,
1907933aecfSAbhinav Kumar DRM_MODE_ENCODER_VIRTUAL, NULL);
1917933aecfSAbhinav Kumar if (ret)
1927933aecfSAbhinav Kumar return ret;
1937933aecfSAbhinav Kumar
1947933aecfSAbhinav Kumar ret = drm_writeback_connector_init_with_encoder(dev, wb_connector, &wb_connector->encoder,
1957933aecfSAbhinav Kumar con_funcs, formats, n_formats);
1967933aecfSAbhinav Kumar
1977933aecfSAbhinav Kumar if (ret)
1987933aecfSAbhinav Kumar drm_encoder_cleanup(&wb_connector->encoder);
1997933aecfSAbhinav Kumar
2007933aecfSAbhinav Kumar return ret;
2017933aecfSAbhinav Kumar }
2027933aecfSAbhinav Kumar EXPORT_SYMBOL(drm_writeback_connector_init);
2037933aecfSAbhinav Kumar
2047933aecfSAbhinav Kumar /**
2057933aecfSAbhinav Kumar * drm_writeback_connector_init_with_encoder - Initialize a writeback connector with
2067933aecfSAbhinav Kumar * a custom encoder
2077933aecfSAbhinav Kumar *
2087933aecfSAbhinav Kumar * @dev: DRM device
2097933aecfSAbhinav Kumar * @wb_connector: Writeback connector to initialize
2107933aecfSAbhinav Kumar * @enc: handle to the already initialized drm encoder
2117933aecfSAbhinav Kumar * @con_funcs: Connector funcs vtable
2127933aecfSAbhinav Kumar * @formats: Array of supported pixel formats for the writeback engine
2137933aecfSAbhinav Kumar * @n_formats: Length of the formats array
2147933aecfSAbhinav Kumar *
2157933aecfSAbhinav Kumar * This function creates the writeback-connector-specific properties if they
2167933aecfSAbhinav Kumar * have not been already created, initializes the connector as
2177933aecfSAbhinav Kumar * type DRM_MODE_CONNECTOR_WRITEBACK, and correctly initializes the property
2187933aecfSAbhinav Kumar * values.
2197933aecfSAbhinav Kumar *
2207933aecfSAbhinav Kumar * This function assumes that the drm_writeback_connector's encoder has already been
2217933aecfSAbhinav Kumar * created and initialized before invoking this function.
2227933aecfSAbhinav Kumar *
2237933aecfSAbhinav Kumar * In addition, this function also assumes that callers of this API will manage
2247933aecfSAbhinav Kumar * assigning the encoder helper functions, possible_crtcs and any other encoder
2257933aecfSAbhinav Kumar * specific operation.
2267933aecfSAbhinav Kumar *
2277933aecfSAbhinav Kumar * Drivers should always use this function instead of drm_connector_init() to
2287933aecfSAbhinav Kumar * set up writeback connectors if they want to manage themselves the lifetime of the
2297933aecfSAbhinav Kumar * associated encoder.
2307933aecfSAbhinav Kumar *
2317933aecfSAbhinav Kumar * Returns: 0 on success, or a negative error code
2327933aecfSAbhinav Kumar */
drm_writeback_connector_init_with_encoder(struct drm_device * dev,struct drm_writeback_connector * wb_connector,struct drm_encoder * enc,const struct drm_connector_funcs * con_funcs,const u32 * formats,int n_formats)2337933aecfSAbhinav Kumar int drm_writeback_connector_init_with_encoder(struct drm_device *dev,
2347933aecfSAbhinav Kumar struct drm_writeback_connector *wb_connector, struct drm_encoder *enc,
2357933aecfSAbhinav Kumar const struct drm_connector_funcs *con_funcs, const u32 *formats,
2367933aecfSAbhinav Kumar int n_formats)
2377933aecfSAbhinav Kumar {
238935774cdSBrian Starkey struct drm_property_blob *blob;
239935774cdSBrian Starkey struct drm_connector *connector = &wb_connector->base;
240935774cdSBrian Starkey struct drm_mode_config *config = &dev->mode_config;
241935774cdSBrian Starkey int ret = create_writeback_properties(dev);
242935774cdSBrian Starkey
243935774cdSBrian Starkey if (ret != 0)
244935774cdSBrian Starkey return ret;
245935774cdSBrian Starkey
246935774cdSBrian Starkey blob = drm_property_create_blob(dev, n_formats * sizeof(*formats),
247935774cdSBrian Starkey formats);
248935774cdSBrian Starkey if (IS_ERR(blob))
249935774cdSBrian Starkey return PTR_ERR(blob);
250935774cdSBrian Starkey
251935774cdSBrian Starkey
252935774cdSBrian Starkey connector->interlace_allowed = 0;
253935774cdSBrian Starkey
254935774cdSBrian Starkey ret = drm_connector_init(dev, connector, con_funcs,
255935774cdSBrian Starkey DRM_MODE_CONNECTOR_WRITEBACK);
256935774cdSBrian Starkey if (ret)
257935774cdSBrian Starkey goto connector_fail;
258935774cdSBrian Starkey
2597933aecfSAbhinav Kumar ret = drm_connector_attach_encoder(connector, enc);
260935774cdSBrian Starkey if (ret)
261935774cdSBrian Starkey goto attach_fail;
262935774cdSBrian Starkey
263935774cdSBrian Starkey INIT_LIST_HEAD(&wb_connector->job_queue);
264935774cdSBrian Starkey spin_lock_init(&wb_connector->job_lock);
265935774cdSBrian Starkey
266b13cc8ddSBrian Starkey wb_connector->fence_context = dma_fence_context_alloc(1);
267b13cc8ddSBrian Starkey spin_lock_init(&wb_connector->fence_lock);
268b13cc8ddSBrian Starkey snprintf(wb_connector->timeline_name,
269b13cc8ddSBrian Starkey sizeof(wb_connector->timeline_name),
270b13cc8ddSBrian Starkey "CONNECTOR:%d-%s", connector->base.id, connector->name);
271b13cc8ddSBrian Starkey
272b13cc8ddSBrian Starkey drm_object_attach_property(&connector->base,
273b13cc8ddSBrian Starkey config->writeback_out_fence_ptr_property, 0);
274b13cc8ddSBrian Starkey
275935774cdSBrian Starkey drm_object_attach_property(&connector->base,
276935774cdSBrian Starkey config->writeback_fb_id_property, 0);
277935774cdSBrian Starkey
278935774cdSBrian Starkey drm_object_attach_property(&connector->base,
279935774cdSBrian Starkey config->writeback_pixel_formats_property,
280935774cdSBrian Starkey blob->base.id);
281935774cdSBrian Starkey wb_connector->pixel_formats_blob_ptr = blob;
282935774cdSBrian Starkey
283935774cdSBrian Starkey return 0;
284935774cdSBrian Starkey
285935774cdSBrian Starkey attach_fail:
286935774cdSBrian Starkey drm_connector_cleanup(connector);
287935774cdSBrian Starkey connector_fail:
288935774cdSBrian Starkey drm_property_blob_put(blob);
289935774cdSBrian Starkey return ret;
290935774cdSBrian Starkey }
2917933aecfSAbhinav Kumar EXPORT_SYMBOL(drm_writeback_connector_init_with_encoder);
292935774cdSBrian Starkey
drm_writeback_set_fb(struct drm_connector_state * conn_state,struct drm_framebuffer * fb)2939d2230dcSLaurent Pinchart int drm_writeback_set_fb(struct drm_connector_state *conn_state,
2949d2230dcSLaurent Pinchart struct drm_framebuffer *fb)
2959d2230dcSLaurent Pinchart {
2969d2230dcSLaurent Pinchart WARN_ON(conn_state->connector->connector_type != DRM_MODE_CONNECTOR_WRITEBACK);
2979d2230dcSLaurent Pinchart
2989d2230dcSLaurent Pinchart if (!conn_state->writeback_job) {
2999d2230dcSLaurent Pinchart conn_state->writeback_job =
3009d2230dcSLaurent Pinchart kzalloc(sizeof(*conn_state->writeback_job), GFP_KERNEL);
3019d2230dcSLaurent Pinchart if (!conn_state->writeback_job)
3029d2230dcSLaurent Pinchart return -ENOMEM;
3039d2230dcSLaurent Pinchart
3049d2230dcSLaurent Pinchart conn_state->writeback_job->connector =
3059d2230dcSLaurent Pinchart drm_connector_to_writeback(conn_state->connector);
3069d2230dcSLaurent Pinchart }
3079d2230dcSLaurent Pinchart
3089d2230dcSLaurent Pinchart drm_framebuffer_assign(&conn_state->writeback_job->fb, fb);
3099d2230dcSLaurent Pinchart return 0;
3109d2230dcSLaurent Pinchart }
3119d2230dcSLaurent Pinchart
drm_writeback_prepare_job(struct drm_writeback_job * job)3129d2230dcSLaurent Pinchart int drm_writeback_prepare_job(struct drm_writeback_job *job)
3139d2230dcSLaurent Pinchart {
3149d2230dcSLaurent Pinchart struct drm_writeback_connector *connector = job->connector;
3159d2230dcSLaurent Pinchart const struct drm_connector_helper_funcs *funcs =
3169d2230dcSLaurent Pinchart connector->base.helper_private;
3179d2230dcSLaurent Pinchart int ret;
3189d2230dcSLaurent Pinchart
3199d2230dcSLaurent Pinchart if (funcs->prepare_writeback_job) {
3209d2230dcSLaurent Pinchart ret = funcs->prepare_writeback_job(connector, job);
3219d2230dcSLaurent Pinchart if (ret < 0)
3229d2230dcSLaurent Pinchart return ret;
3239d2230dcSLaurent Pinchart }
3249d2230dcSLaurent Pinchart
3259d2230dcSLaurent Pinchart job->prepared = true;
3269d2230dcSLaurent Pinchart return 0;
3279d2230dcSLaurent Pinchart }
3289d2230dcSLaurent Pinchart EXPORT_SYMBOL(drm_writeback_prepare_job);
3299d2230dcSLaurent Pinchart
330935774cdSBrian Starkey /**
331935774cdSBrian Starkey * drm_writeback_queue_job - Queue a writeback job for later signalling
332935774cdSBrian Starkey * @wb_connector: The writeback connector to queue a job on
33397eb9eaeSLaurent Pinchart * @conn_state: The connector state containing the job to queue
334935774cdSBrian Starkey *
33597eb9eaeSLaurent Pinchart * This function adds the job contained in @conn_state to the job_queue for a
33697eb9eaeSLaurent Pinchart * writeback connector. It takes ownership of the writeback job and sets the
33797eb9eaeSLaurent Pinchart * @conn_state->writeback_job to NULL, and so no access to the job may be
33897eb9eaeSLaurent Pinchart * performed by the caller after this function returns.
339935774cdSBrian Starkey *
340935774cdSBrian Starkey * Drivers must ensure that for a given writeback connector, jobs are queued in
341935774cdSBrian Starkey * exactly the same order as they will be completed by the hardware (and
342935774cdSBrian Starkey * signaled via drm_writeback_signal_completion).
343935774cdSBrian Starkey *
344935774cdSBrian Starkey * For every call to drm_writeback_queue_job() there must be exactly one call to
345935774cdSBrian Starkey * drm_writeback_signal_completion()
346935774cdSBrian Starkey *
347935774cdSBrian Starkey * See also: drm_writeback_signal_completion()
348935774cdSBrian Starkey */
drm_writeback_queue_job(struct drm_writeback_connector * wb_connector,struct drm_connector_state * conn_state)349935774cdSBrian Starkey void drm_writeback_queue_job(struct drm_writeback_connector *wb_connector,
35097eb9eaeSLaurent Pinchart struct drm_connector_state *conn_state)
351935774cdSBrian Starkey {
35297eb9eaeSLaurent Pinchart struct drm_writeback_job *job;
353935774cdSBrian Starkey unsigned long flags;
354935774cdSBrian Starkey
35597eb9eaeSLaurent Pinchart job = conn_state->writeback_job;
35697eb9eaeSLaurent Pinchart conn_state->writeback_job = NULL;
35797eb9eaeSLaurent Pinchart
358935774cdSBrian Starkey spin_lock_irqsave(&wb_connector->job_lock, flags);
359935774cdSBrian Starkey list_add_tail(&job->list_entry, &wb_connector->job_queue);
360935774cdSBrian Starkey spin_unlock_irqrestore(&wb_connector->job_lock, flags);
361935774cdSBrian Starkey }
362935774cdSBrian Starkey EXPORT_SYMBOL(drm_writeback_queue_job);
363935774cdSBrian Starkey
drm_writeback_cleanup_job(struct drm_writeback_job * job)364e482ae9bSLaurent Pinchart void drm_writeback_cleanup_job(struct drm_writeback_job *job)
365e482ae9bSLaurent Pinchart {
3669d2230dcSLaurent Pinchart struct drm_writeback_connector *connector = job->connector;
3679d2230dcSLaurent Pinchart const struct drm_connector_helper_funcs *funcs =
3689d2230dcSLaurent Pinchart connector->base.helper_private;
3699d2230dcSLaurent Pinchart
3709d2230dcSLaurent Pinchart if (job->prepared && funcs->cleanup_writeback_job)
3719d2230dcSLaurent Pinchart funcs->cleanup_writeback_job(connector, job);
3729d2230dcSLaurent Pinchart
373e482ae9bSLaurent Pinchart if (job->fb)
374e482ae9bSLaurent Pinchart drm_framebuffer_put(job->fb);
375e482ae9bSLaurent Pinchart
376b1066a12SLowry Li (Arm Technology China) if (job->out_fence)
377b1066a12SLowry Li (Arm Technology China) dma_fence_put(job->out_fence);
378b1066a12SLowry Li (Arm Technology China)
379e482ae9bSLaurent Pinchart kfree(job);
380e482ae9bSLaurent Pinchart }
381e482ae9bSLaurent Pinchart EXPORT_SYMBOL(drm_writeback_cleanup_job);
382e482ae9bSLaurent Pinchart
383935774cdSBrian Starkey /*
384935774cdSBrian Starkey * @cleanup_work: deferred cleanup of a writeback job
385935774cdSBrian Starkey *
386935774cdSBrian Starkey * The job cannot be cleaned up directly in drm_writeback_signal_completion,
387935774cdSBrian Starkey * because it may be called in interrupt context. Dropping the framebuffer
388935774cdSBrian Starkey * reference can sleep, and so the cleanup is deferred to a workqueue.
389935774cdSBrian Starkey */
cleanup_work(struct work_struct * work)390935774cdSBrian Starkey static void cleanup_work(struct work_struct *work)
391935774cdSBrian Starkey {
392935774cdSBrian Starkey struct drm_writeback_job *job = container_of(work,
393935774cdSBrian Starkey struct drm_writeback_job,
394935774cdSBrian Starkey cleanup_work);
395935774cdSBrian Starkey
396e482ae9bSLaurent Pinchart drm_writeback_cleanup_job(job);
397e482ae9bSLaurent Pinchart }
398935774cdSBrian Starkey
399935774cdSBrian Starkey /**
400935774cdSBrian Starkey * drm_writeback_signal_completion - Signal the completion of a writeback job
401935774cdSBrian Starkey * @wb_connector: The writeback connector whose job is complete
402b13cc8ddSBrian Starkey * @status: Status code to set in the writeback out_fence (0 for success)
403935774cdSBrian Starkey *
404935774cdSBrian Starkey * Drivers should call this to signal the completion of a previously queued
405935774cdSBrian Starkey * writeback job. It should be called as soon as possible after the hardware
406935774cdSBrian Starkey * has finished writing, and may be called from interrupt context.
407935774cdSBrian Starkey * It is the driver's responsibility to ensure that for a given connector, the
408935774cdSBrian Starkey * hardware completes writeback jobs in the same order as they are queued.
409935774cdSBrian Starkey *
410935774cdSBrian Starkey * Unless the driver is holding its own reference to the framebuffer, it must
411935774cdSBrian Starkey * not be accessed after calling this function.
412935774cdSBrian Starkey *
413935774cdSBrian Starkey * See also: drm_writeback_queue_job()
414935774cdSBrian Starkey */
415935774cdSBrian Starkey void
drm_writeback_signal_completion(struct drm_writeback_connector * wb_connector,int status)416b13cc8ddSBrian Starkey drm_writeback_signal_completion(struct drm_writeback_connector *wb_connector,
417b13cc8ddSBrian Starkey int status)
418935774cdSBrian Starkey {
419935774cdSBrian Starkey unsigned long flags;
420935774cdSBrian Starkey struct drm_writeback_job *job;
421b1066a12SLowry Li (Arm Technology China) struct dma_fence *out_fence;
422935774cdSBrian Starkey
423935774cdSBrian Starkey spin_lock_irqsave(&wb_connector->job_lock, flags);
424935774cdSBrian Starkey job = list_first_entry_or_null(&wb_connector->job_queue,
425935774cdSBrian Starkey struct drm_writeback_job,
426935774cdSBrian Starkey list_entry);
427b1066a12SLowry Li (Arm Technology China) if (job)
428935774cdSBrian Starkey list_del(&job->list_entry);
429b1066a12SLowry Li (Arm Technology China)
430935774cdSBrian Starkey spin_unlock_irqrestore(&wb_connector->job_lock, flags);
431935774cdSBrian Starkey
432935774cdSBrian Starkey if (WARN_ON(!job))
433935774cdSBrian Starkey return;
434935774cdSBrian Starkey
435b1066a12SLowry Li (Arm Technology China) out_fence = job->out_fence;
436b1066a12SLowry Li (Arm Technology China) if (out_fence) {
437b1066a12SLowry Li (Arm Technology China) if (status)
438b1066a12SLowry Li (Arm Technology China) dma_fence_set_error(out_fence, status);
439b1066a12SLowry Li (Arm Technology China) dma_fence_signal(out_fence);
440b1066a12SLowry Li (Arm Technology China) dma_fence_put(out_fence);
441b1066a12SLowry Li (Arm Technology China) job->out_fence = NULL;
442b1066a12SLowry Li (Arm Technology China) }
443b1066a12SLowry Li (Arm Technology China)
444935774cdSBrian Starkey INIT_WORK(&job->cleanup_work, cleanup_work);
445935774cdSBrian Starkey queue_work(system_long_wq, &job->cleanup_work);
446935774cdSBrian Starkey }
447935774cdSBrian Starkey EXPORT_SYMBOL(drm_writeback_signal_completion);
448b13cc8ddSBrian Starkey
449b13cc8ddSBrian Starkey struct dma_fence *
drm_writeback_get_out_fence(struct drm_writeback_connector * wb_connector)450b13cc8ddSBrian Starkey drm_writeback_get_out_fence(struct drm_writeback_connector *wb_connector)
451b13cc8ddSBrian Starkey {
452b13cc8ddSBrian Starkey struct dma_fence *fence;
453b13cc8ddSBrian Starkey
454b13cc8ddSBrian Starkey if (WARN_ON(wb_connector->base.connector_type !=
455b13cc8ddSBrian Starkey DRM_MODE_CONNECTOR_WRITEBACK))
456b13cc8ddSBrian Starkey return NULL;
457b13cc8ddSBrian Starkey
458b13cc8ddSBrian Starkey fence = kzalloc(sizeof(*fence), GFP_KERNEL);
459b13cc8ddSBrian Starkey if (!fence)
460b13cc8ddSBrian Starkey return NULL;
461b13cc8ddSBrian Starkey
462b13cc8ddSBrian Starkey dma_fence_init(fence, &drm_writeback_fence_ops,
463b13cc8ddSBrian Starkey &wb_connector->fence_lock, wb_connector->fence_context,
464b13cc8ddSBrian Starkey ++wb_connector->fence_seqno);
465b13cc8ddSBrian Starkey
466b13cc8ddSBrian Starkey return fence;
467b13cc8ddSBrian Starkey }
468b13cc8ddSBrian Starkey EXPORT_SYMBOL(drm_writeback_get_out_fence);
469