Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Copyright (C) 2016 Noralf Trønnes
4 */
5
6#include <linux/module.h>
7#include <linux/slab.h>
8
9#include <drm/drm_atomic.h>
10#include <drm/drm_atomic_helper.h>
11#include <drm/drm_plane_helper.h>
12#include <drm/drm_probe_helper.h>
13#include <drm/drm_simple_kms_helper.h>
14
15/**
16 * DOC: overview
17 *
18 * This helper library provides helpers for drivers for simple display
19 * hardware.
20 *
21 * drm_simple_display_pipe_init() initializes a simple display pipeline
22 * which has only one full-screen scanout buffer feeding one output. The
23 * pipeline is represented by &struct drm_simple_display_pipe and binds
24 * together &drm_plane, &drm_crtc and &drm_encoder structures into one fixed
25 * entity. Some flexibility for code reuse is provided through a separately
26 * allocated &drm_connector object and supporting optional &drm_bridge
27 * encoder drivers.
28 */
29
30static const struct drm_encoder_funcs drm_simple_kms_encoder_funcs = {
31 .destroy = drm_encoder_cleanup,
32};
33
34static enum drm_mode_status
35drm_simple_kms_crtc_mode_valid(struct drm_crtc *crtc,
36 const struct drm_display_mode *mode)
37{
38 struct drm_simple_display_pipe *pipe;
39
40 pipe = container_of(crtc, struct drm_simple_display_pipe, crtc);
41 if (!pipe->funcs || !pipe->funcs->mode_valid)
42 /* Anything goes */
43 return MODE_OK;
44
45 return pipe->funcs->mode_valid(crtc, mode);
46}
47
48static int drm_simple_kms_crtc_check(struct drm_crtc *crtc,
49 struct drm_crtc_state *state)
50{
51 bool has_primary = state->plane_mask &
52 drm_plane_mask(crtc->primary);
53
54 /* We always want to have an active plane with an active CRTC */
55 if (has_primary != state->enable)
56 return -EINVAL;
57
58 return drm_atomic_add_affected_planes(state->state, crtc);
59}
60
61static void drm_simple_kms_crtc_enable(struct drm_crtc *crtc,
62 struct drm_crtc_state *old_state)
63{
64 struct drm_plane *plane;
65 struct drm_simple_display_pipe *pipe;
66
67 pipe = container_of(crtc, struct drm_simple_display_pipe, crtc);
68 if (!pipe->funcs || !pipe->funcs->enable)
69 return;
70
71 plane = &pipe->plane;
72 pipe->funcs->enable(pipe, crtc->state, plane->state);
73}
74
75static void drm_simple_kms_crtc_disable(struct drm_crtc *crtc,
76 struct drm_crtc_state *old_state)
77{
78 struct drm_simple_display_pipe *pipe;
79
80 pipe = container_of(crtc, struct drm_simple_display_pipe, crtc);
81 if (!pipe->funcs || !pipe->funcs->disable)
82 return;
83
84 pipe->funcs->disable(pipe);
85}
86
87static const struct drm_crtc_helper_funcs drm_simple_kms_crtc_helper_funcs = {
88 .mode_valid = drm_simple_kms_crtc_mode_valid,
89 .atomic_check = drm_simple_kms_crtc_check,
90 .atomic_enable = drm_simple_kms_crtc_enable,
91 .atomic_disable = drm_simple_kms_crtc_disable,
92};
93
94static int drm_simple_kms_crtc_enable_vblank(struct drm_crtc *crtc)
95{
96 struct drm_simple_display_pipe *pipe;
97
98 pipe = container_of(crtc, struct drm_simple_display_pipe, crtc);
99 if (!pipe->funcs || !pipe->funcs->enable_vblank)
100 return 0;
101
102 return pipe->funcs->enable_vblank(pipe);
103}
104
105static void drm_simple_kms_crtc_disable_vblank(struct drm_crtc *crtc)
106{
107 struct drm_simple_display_pipe *pipe;
108
109 pipe = container_of(crtc, struct drm_simple_display_pipe, crtc);
110 if (!pipe->funcs || !pipe->funcs->disable_vblank)
111 return;
112
113 pipe->funcs->disable_vblank(pipe);
114}
115
116static const struct drm_crtc_funcs drm_simple_kms_crtc_funcs = {
117 .reset = drm_atomic_helper_crtc_reset,
118 .destroy = drm_crtc_cleanup,
119 .set_config = drm_atomic_helper_set_config,
120 .page_flip = drm_atomic_helper_page_flip,
121 .atomic_duplicate_state = drm_atomic_helper_crtc_duplicate_state,
122 .atomic_destroy_state = drm_atomic_helper_crtc_destroy_state,
123 .enable_vblank = drm_simple_kms_crtc_enable_vblank,
124 .disable_vblank = drm_simple_kms_crtc_disable_vblank,
125};
126
127static int drm_simple_kms_plane_atomic_check(struct drm_plane *plane,
128 struct drm_plane_state *plane_state)
129{
130 struct drm_simple_display_pipe *pipe;
131 struct drm_crtc_state *crtc_state;
132 int ret;
133
134 pipe = container_of(plane, struct drm_simple_display_pipe, plane);
135 crtc_state = drm_atomic_get_new_crtc_state(plane_state->state,
136 &pipe->crtc);
137
138 ret = drm_atomic_helper_check_plane_state(plane_state, crtc_state,
139 DRM_PLANE_HELPER_NO_SCALING,
140 DRM_PLANE_HELPER_NO_SCALING,
141 false, true);
142 if (ret)
143 return ret;
144
145 if (!plane_state->visible)
146 return 0;
147
148 if (!pipe->funcs || !pipe->funcs->check)
149 return 0;
150
151 return pipe->funcs->check(pipe, plane_state, crtc_state);
152}
153
154static void drm_simple_kms_plane_atomic_update(struct drm_plane *plane,
155 struct drm_plane_state *old_pstate)
156{
157 struct drm_simple_display_pipe *pipe;
158
159 pipe = container_of(plane, struct drm_simple_display_pipe, plane);
160 if (!pipe->funcs || !pipe->funcs->update)
161 return;
162
163 pipe->funcs->update(pipe, old_pstate);
164}
165
166static int drm_simple_kms_plane_prepare_fb(struct drm_plane *plane,
167 struct drm_plane_state *state)
168{
169 struct drm_simple_display_pipe *pipe;
170
171 pipe = container_of(plane, struct drm_simple_display_pipe, plane);
172 if (!pipe->funcs || !pipe->funcs->prepare_fb)
173 return 0;
174
175 return pipe->funcs->prepare_fb(pipe, state);
176}
177
178static void drm_simple_kms_plane_cleanup_fb(struct drm_plane *plane,
179 struct drm_plane_state *state)
180{
181 struct drm_simple_display_pipe *pipe;
182
183 pipe = container_of(plane, struct drm_simple_display_pipe, plane);
184 if (!pipe->funcs || !pipe->funcs->cleanup_fb)
185 return;
186
187 pipe->funcs->cleanup_fb(pipe, state);
188}
189
190static bool drm_simple_kms_format_mod_supported(struct drm_plane *plane,
191 uint32_t format,
192 uint64_t modifier)
193{
194 return modifier == DRM_FORMAT_MOD_LINEAR;
195}
196
197static const struct drm_plane_helper_funcs drm_simple_kms_plane_helper_funcs = {
198 .prepare_fb = drm_simple_kms_plane_prepare_fb,
199 .cleanup_fb = drm_simple_kms_plane_cleanup_fb,
200 .atomic_check = drm_simple_kms_plane_atomic_check,
201 .atomic_update = drm_simple_kms_plane_atomic_update,
202};
203
204static const struct drm_plane_funcs drm_simple_kms_plane_funcs = {
205 .update_plane = drm_atomic_helper_update_plane,
206 .disable_plane = drm_atomic_helper_disable_plane,
207 .destroy = drm_plane_cleanup,
208 .reset = drm_atomic_helper_plane_reset,
209 .atomic_duplicate_state = drm_atomic_helper_plane_duplicate_state,
210 .atomic_destroy_state = drm_atomic_helper_plane_destroy_state,
211 .format_mod_supported = drm_simple_kms_format_mod_supported,
212};
213
214/**
215 * drm_simple_display_pipe_attach_bridge - Attach a bridge to the display pipe
216 * @pipe: simple display pipe object
217 * @bridge: bridge to attach
218 *
219 * Makes it possible to still use the drm_simple_display_pipe helpers when
220 * a DRM bridge has to be used.
221 *
222 * Note that you probably want to initialize the pipe by passing a NULL
223 * connector to drm_simple_display_pipe_init().
224 *
225 * Returns:
226 * Zero on success, negative error code on failure.
227 */
228int drm_simple_display_pipe_attach_bridge(struct drm_simple_display_pipe *pipe,
229 struct drm_bridge *bridge)
230{
231 return drm_bridge_attach(&pipe->encoder, bridge, NULL);
232}
233EXPORT_SYMBOL(drm_simple_display_pipe_attach_bridge);
234
235/**
236 * drm_simple_display_pipe_init - Initialize a simple display pipeline
237 * @dev: DRM device
238 * @pipe: simple display pipe object to initialize
239 * @funcs: callbacks for the display pipe (optional)
240 * @formats: array of supported formats (DRM_FORMAT\_\*)
241 * @format_count: number of elements in @formats
242 * @format_modifiers: array of formats modifiers
243 * @connector: connector to attach and register (optional)
244 *
245 * Sets up a display pipeline which consist of a really simple
246 * plane-crtc-encoder pipe.
247 *
248 * If a connector is supplied, the pipe will be coupled with the provided
249 * connector. You may supply a NULL connector when using drm bridges, that
250 * handle connectors themselves (see drm_simple_display_pipe_attach_bridge()).
251 *
252 * Teardown of a simple display pipe is all handled automatically by the drm
253 * core through calling drm_mode_config_cleanup(). Drivers afterwards need to
254 * release the memory for the structure themselves.
255 *
256 * Returns:
257 * Zero on success, negative error code on failure.
258 */
259int drm_simple_display_pipe_init(struct drm_device *dev,
260 struct drm_simple_display_pipe *pipe,
261 const struct drm_simple_display_pipe_funcs *funcs,
262 const uint32_t *formats, unsigned int format_count,
263 const uint64_t *format_modifiers,
264 struct drm_connector *connector)
265{
266 struct drm_encoder *encoder = &pipe->encoder;
267 struct drm_plane *plane = &pipe->plane;
268 struct drm_crtc *crtc = &pipe->crtc;
269 int ret;
270
271 pipe->connector = connector;
272 pipe->funcs = funcs;
273
274 drm_plane_helper_add(plane, &drm_simple_kms_plane_helper_funcs);
275 ret = drm_universal_plane_init(dev, plane, 0,
276 &drm_simple_kms_plane_funcs,
277 formats, format_count,
278 format_modifiers,
279 DRM_PLANE_TYPE_PRIMARY, NULL);
280 if (ret)
281 return ret;
282
283 drm_crtc_helper_add(crtc, &drm_simple_kms_crtc_helper_funcs);
284 ret = drm_crtc_init_with_planes(dev, crtc, plane, NULL,
285 &drm_simple_kms_crtc_funcs, NULL);
286 if (ret)
287 return ret;
288
289 encoder->possible_crtcs = drm_crtc_mask(crtc);
290 ret = drm_encoder_init(dev, encoder, &drm_simple_kms_encoder_funcs,
291 DRM_MODE_ENCODER_NONE, NULL);
292 if (ret || !connector)
293 return ret;
294
295 return drm_connector_attach_encoder(connector, encoder);
296}
297EXPORT_SYMBOL(drm_simple_display_pipe_init);
298
299MODULE_LICENSE("GPL");
1/*
2 * Copyright (C) 2016 Noralf Trønnes
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 */
9
10#include <drm/drmP.h>
11#include <drm/drm_atomic.h>
12#include <drm/drm_atomic_helper.h>
13#include <drm/drm_crtc_helper.h>
14#include <drm/drm_plane_helper.h>
15#include <drm/drm_simple_kms_helper.h>
16#include <linux/slab.h>
17
18/**
19 * DOC: overview
20 *
21 * This helper library provides helpers for drivers for simple display
22 * hardware.
23 *
24 * drm_simple_display_pipe_init() initializes a simple display pipeline
25 * which has only one full-screen scanout buffer feeding one output. The
26 * pipeline is represented by struct &drm_simple_display_pipe and binds
27 * together &drm_plane, &drm_crtc and &drm_encoder structures into one fixed
28 * entity. Some flexibility for code reuse is provided through a separately
29 * allocated &drm_connector object and supporting optional &drm_bridge
30 * encoder drivers.
31 */
32
33static const struct drm_encoder_funcs drm_simple_kms_encoder_funcs = {
34 .destroy = drm_encoder_cleanup,
35};
36
37static int drm_simple_kms_crtc_check(struct drm_crtc *crtc,
38 struct drm_crtc_state *state)
39{
40 return drm_atomic_add_affected_planes(state->state, crtc);
41}
42
43static void drm_simple_kms_crtc_enable(struct drm_crtc *crtc)
44{
45 struct drm_simple_display_pipe *pipe;
46
47 pipe = container_of(crtc, struct drm_simple_display_pipe, crtc);
48 if (!pipe->funcs || !pipe->funcs->enable)
49 return;
50
51 pipe->funcs->enable(pipe, crtc->state);
52}
53
54static void drm_simple_kms_crtc_disable(struct drm_crtc *crtc)
55{
56 struct drm_simple_display_pipe *pipe;
57
58 pipe = container_of(crtc, struct drm_simple_display_pipe, crtc);
59 if (!pipe->funcs || !pipe->funcs->disable)
60 return;
61
62 pipe->funcs->disable(pipe);
63}
64
65static const struct drm_crtc_helper_funcs drm_simple_kms_crtc_helper_funcs = {
66 .atomic_check = drm_simple_kms_crtc_check,
67 .disable = drm_simple_kms_crtc_disable,
68 .enable = drm_simple_kms_crtc_enable,
69};
70
71static const struct drm_crtc_funcs drm_simple_kms_crtc_funcs = {
72 .reset = drm_atomic_helper_crtc_reset,
73 .destroy = drm_crtc_cleanup,
74 .set_config = drm_atomic_helper_set_config,
75 .page_flip = drm_atomic_helper_page_flip,
76 .atomic_duplicate_state = drm_atomic_helper_crtc_duplicate_state,
77 .atomic_destroy_state = drm_atomic_helper_crtc_destroy_state,
78};
79
80static int drm_simple_kms_plane_atomic_check(struct drm_plane *plane,
81 struct drm_plane_state *plane_state)
82{
83 struct drm_rect clip = { 0 };
84 struct drm_simple_display_pipe *pipe;
85 struct drm_crtc_state *crtc_state;
86 int ret;
87
88 pipe = container_of(plane, struct drm_simple_display_pipe, plane);
89 crtc_state = drm_atomic_get_existing_crtc_state(plane_state->state,
90 &pipe->crtc);
91 if (crtc_state->enable != !!plane_state->crtc)
92 return -EINVAL; /* plane must match crtc enable state */
93
94 if (!crtc_state->enable)
95 return 0; /* nothing to check when disabling or disabled */
96
97 clip.x2 = crtc_state->adjusted_mode.hdisplay;
98 clip.y2 = crtc_state->adjusted_mode.vdisplay;
99
100 ret = drm_plane_helper_check_state(plane_state, &clip,
101 DRM_PLANE_HELPER_NO_SCALING,
102 DRM_PLANE_HELPER_NO_SCALING,
103 false, true);
104 if (ret)
105 return ret;
106
107 if (!plane_state->visible)
108 return -EINVAL;
109
110 if (!pipe->funcs || !pipe->funcs->check)
111 return 0;
112
113 return pipe->funcs->check(pipe, plane_state, crtc_state);
114}
115
116static void drm_simple_kms_plane_atomic_update(struct drm_plane *plane,
117 struct drm_plane_state *pstate)
118{
119 struct drm_simple_display_pipe *pipe;
120
121 pipe = container_of(plane, struct drm_simple_display_pipe, plane);
122 if (!pipe->funcs || !pipe->funcs->update)
123 return;
124
125 pipe->funcs->update(pipe, pstate);
126}
127
128static int drm_simple_kms_plane_prepare_fb(struct drm_plane *plane,
129 struct drm_plane_state *state)
130{
131 struct drm_simple_display_pipe *pipe;
132
133 pipe = container_of(plane, struct drm_simple_display_pipe, plane);
134 if (!pipe->funcs || !pipe->funcs->prepare_fb)
135 return 0;
136
137 return pipe->funcs->prepare_fb(pipe, state);
138}
139
140static void drm_simple_kms_plane_cleanup_fb(struct drm_plane *plane,
141 struct drm_plane_state *state)
142{
143 struct drm_simple_display_pipe *pipe;
144
145 pipe = container_of(plane, struct drm_simple_display_pipe, plane);
146 if (!pipe->funcs || !pipe->funcs->cleanup_fb)
147 return;
148
149 pipe->funcs->cleanup_fb(pipe, state);
150}
151
152static const struct drm_plane_helper_funcs drm_simple_kms_plane_helper_funcs = {
153 .prepare_fb = drm_simple_kms_plane_prepare_fb,
154 .cleanup_fb = drm_simple_kms_plane_cleanup_fb,
155 .atomic_check = drm_simple_kms_plane_atomic_check,
156 .atomic_update = drm_simple_kms_plane_atomic_update,
157};
158
159static const struct drm_plane_funcs drm_simple_kms_plane_funcs = {
160 .update_plane = drm_atomic_helper_update_plane,
161 .disable_plane = drm_atomic_helper_disable_plane,
162 .destroy = drm_plane_cleanup,
163 .reset = drm_atomic_helper_plane_reset,
164 .atomic_duplicate_state = drm_atomic_helper_plane_duplicate_state,
165 .atomic_destroy_state = drm_atomic_helper_plane_destroy_state,
166};
167
168/**
169 * drm_simple_display_pipe_attach_bridge - Attach a bridge to the display pipe
170 * @pipe: simple display pipe object
171 * @bridge: bridge to attach
172 *
173 * Makes it possible to still use the drm_simple_display_pipe helpers when
174 * a DRM bridge has to be used.
175 *
176 * Note that you probably want to initialize the pipe by passing a NULL
177 * connector to drm_simple_display_pipe_init().
178 *
179 * Returns:
180 * Zero on success, negative error code on failure.
181 */
182int drm_simple_display_pipe_attach_bridge(struct drm_simple_display_pipe *pipe,
183 struct drm_bridge *bridge)
184{
185 bridge->encoder = &pipe->encoder;
186 pipe->encoder.bridge = bridge;
187 return drm_bridge_attach(pipe->encoder.dev, bridge);
188}
189EXPORT_SYMBOL(drm_simple_display_pipe_attach_bridge);
190
191/**
192 * drm_simple_display_pipe_detach_bridge - Detach the bridge from the display pipe
193 * @pipe: simple display pipe object
194 *
195 * Detaches the drm bridge previously attached with
196 * drm_simple_display_pipe_attach_bridge()
197 */
198void drm_simple_display_pipe_detach_bridge(struct drm_simple_display_pipe *pipe)
199{
200 if (WARN_ON(!pipe->encoder.bridge))
201 return;
202
203 drm_bridge_detach(pipe->encoder.bridge);
204 pipe->encoder.bridge = NULL;
205}
206EXPORT_SYMBOL(drm_simple_display_pipe_detach_bridge);
207
208/**
209 * drm_simple_display_pipe_init - Initialize a simple display pipeline
210 * @dev: DRM device
211 * @pipe: simple display pipe object to initialize
212 * @funcs: callbacks for the display pipe (optional)
213 * @formats: array of supported formats (DRM_FORMAT\_\*)
214 * @format_count: number of elements in @formats
215 * @connector: connector to attach and register (optional)
216 *
217 * Sets up a display pipeline which consist of a really simple
218 * plane-crtc-encoder pipe.
219 *
220 * If a connector is supplied, the pipe will be coupled with the provided
221 * connector. You may supply a NULL connector when using drm bridges, that
222 * handle connectors themselves (see drm_simple_display_pipe_attach_bridge()).
223 *
224 * Teardown of a simple display pipe is all handled automatically by the drm
225 * core through calling drm_mode_config_cleanup(). Drivers afterwards need to
226 * release the memory for the structure themselves.
227 *
228 * Returns:
229 * Zero on success, negative error code on failure.
230 */
231int drm_simple_display_pipe_init(struct drm_device *dev,
232 struct drm_simple_display_pipe *pipe,
233 const struct drm_simple_display_pipe_funcs *funcs,
234 const uint32_t *formats, unsigned int format_count,
235 struct drm_connector *connector)
236{
237 struct drm_encoder *encoder = &pipe->encoder;
238 struct drm_plane *plane = &pipe->plane;
239 struct drm_crtc *crtc = &pipe->crtc;
240 int ret;
241
242 pipe->connector = connector;
243 pipe->funcs = funcs;
244
245 drm_plane_helper_add(plane, &drm_simple_kms_plane_helper_funcs);
246 ret = drm_universal_plane_init(dev, plane, 0,
247 &drm_simple_kms_plane_funcs,
248 formats, format_count,
249 DRM_PLANE_TYPE_PRIMARY, NULL);
250 if (ret)
251 return ret;
252
253 drm_crtc_helper_add(crtc, &drm_simple_kms_crtc_helper_funcs);
254 ret = drm_crtc_init_with_planes(dev, crtc, plane, NULL,
255 &drm_simple_kms_crtc_funcs, NULL);
256 if (ret)
257 return ret;
258
259 encoder->possible_crtcs = 1 << drm_crtc_index(crtc);
260 ret = drm_encoder_init(dev, encoder, &drm_simple_kms_encoder_funcs,
261 DRM_MODE_ENCODER_NONE, NULL);
262 if (ret || !connector)
263 return ret;
264
265 return drm_mode_connector_attach_encoder(connector, encoder);
266}
267EXPORT_SYMBOL(drm_simple_display_pipe_init);
268
269MODULE_LICENSE("GPL");