Commit | Line | Data |
---|---|---|
5b809074 NT |
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 | |
ea0dd85a | 26 | * pipeline is represented by &struct drm_simple_display_pipe and binds |
5b809074 NT |
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 | ||
33 | static const struct drm_encoder_funcs drm_simple_kms_encoder_funcs = { | |
34 | .destroy = drm_encoder_cleanup, | |
35 | }; | |
36 | ||
40275dc4 LW |
37 | static enum drm_mode_status |
38 | drm_simple_kms_crtc_mode_valid(struct drm_crtc *crtc, | |
39 | const struct drm_display_mode *mode) | |
40 | { | |
41 | struct drm_simple_display_pipe *pipe; | |
42 | ||
43 | pipe = container_of(crtc, struct drm_simple_display_pipe, crtc); | |
44 | if (!pipe->funcs || !pipe->funcs->mode_valid) | |
45 | /* Anything goes */ | |
46 | return MODE_OK; | |
47 | ||
48 | return pipe->funcs->mode_valid(crtc, mode); | |
49 | } | |
50 | ||
6dcf0de7 DV |
51 | static int drm_simple_kms_crtc_check(struct drm_crtc *crtc, |
52 | struct drm_crtc_state *state) | |
53 | { | |
765831dc ML |
54 | bool has_primary = state->plane_mask & |
55 | BIT(drm_plane_index(crtc->primary)); | |
56 | ||
57 | /* We always want to have an active plane with an active CRTC */ | |
58 | if (has_primary != state->enable) | |
59 | return -EINVAL; | |
60 | ||
6dcf0de7 DV |
61 | return drm_atomic_add_affected_planes(state->state, crtc); |
62 | } | |
63 | ||
0b20a0f8 LP |
64 | static void drm_simple_kms_crtc_enable(struct drm_crtc *crtc, |
65 | struct drm_crtc_state *old_state) | |
5b809074 NT |
66 | { |
67 | struct drm_simple_display_pipe *pipe; | |
68 | ||
69 | pipe = container_of(crtc, struct drm_simple_display_pipe, crtc); | |
70 | if (!pipe->funcs || !pipe->funcs->enable) | |
71 | return; | |
72 | ||
73 | pipe->funcs->enable(pipe, crtc->state); | |
74 | } | |
75 | ||
64581714 LP |
76 | static void drm_simple_kms_crtc_disable(struct drm_crtc *crtc, |
77 | struct drm_crtc_state *old_state) | |
5b809074 NT |
78 | { |
79 | struct drm_simple_display_pipe *pipe; | |
80 | ||
81 | pipe = container_of(crtc, struct drm_simple_display_pipe, crtc); | |
82 | if (!pipe->funcs || !pipe->funcs->disable) | |
83 | return; | |
84 | ||
85 | pipe->funcs->disable(pipe); | |
86 | } | |
87 | ||
88 | static const struct drm_crtc_helper_funcs drm_simple_kms_crtc_helper_funcs = { | |
40275dc4 | 89 | .mode_valid = drm_simple_kms_crtc_mode_valid, |
6dcf0de7 | 90 | .atomic_check = drm_simple_kms_crtc_check, |
0b20a0f8 | 91 | .atomic_enable = drm_simple_kms_crtc_enable, |
64581714 | 92 | .atomic_disable = drm_simple_kms_crtc_disable, |
5b809074 NT |
93 | }; |
94 | ||
95 | static const struct drm_crtc_funcs drm_simple_kms_crtc_funcs = { | |
96 | .reset = drm_atomic_helper_crtc_reset, | |
97 | .destroy = drm_crtc_cleanup, | |
98 | .set_config = drm_atomic_helper_set_config, | |
99 | .page_flip = drm_atomic_helper_page_flip, | |
100 | .atomic_duplicate_state = drm_atomic_helper_crtc_duplicate_state, | |
101 | .atomic_destroy_state = drm_atomic_helper_crtc_destroy_state, | |
102 | }; | |
103 | ||
104 | static int drm_simple_kms_plane_atomic_check(struct drm_plane *plane, | |
105 | struct drm_plane_state *plane_state) | |
106 | { | |
5b809074 NT |
107 | struct drm_rect clip = { 0 }; |
108 | struct drm_simple_display_pipe *pipe; | |
109 | struct drm_crtc_state *crtc_state; | |
5b809074 NT |
110 | int ret; |
111 | ||
112 | pipe = container_of(plane, struct drm_simple_display_pipe, plane); | |
b4d93679 ML |
113 | crtc_state = drm_atomic_get_new_crtc_state(plane_state->state, |
114 | &pipe->crtc); | |
4be12cc2 | 115 | |
a01cb8ba VS |
116 | ret = drm_atomic_helper_check_plane_state(plane_state, crtc_state, |
117 | &clip, | |
118 | DRM_PLANE_HELPER_NO_SCALING, | |
119 | DRM_PLANE_HELPER_NO_SCALING, | |
120 | false, true); | |
5b809074 NT |
121 | if (ret) |
122 | return ret; | |
123 | ||
4be12cc2 | 124 | if (!plane_state->visible) |
4751cf73 OA |
125 | return 0; |
126 | ||
127 | drm_mode_get_hv_timing(&crtc_state->mode, &clip.x2, &clip.y2); | |
5b809074 NT |
128 | |
129 | if (!pipe->funcs || !pipe->funcs->check) | |
130 | return 0; | |
131 | ||
132 | return pipe->funcs->check(pipe, plane_state, crtc_state); | |
133 | } | |
134 | ||
135 | static void drm_simple_kms_plane_atomic_update(struct drm_plane *plane, | |
bcd2ba02 | 136 | struct drm_plane_state *old_pstate) |
5b809074 NT |
137 | { |
138 | struct drm_simple_display_pipe *pipe; | |
139 | ||
140 | pipe = container_of(plane, struct drm_simple_display_pipe, plane); | |
141 | if (!pipe->funcs || !pipe->funcs->update) | |
142 | return; | |
143 | ||
bcd2ba02 | 144 | pipe->funcs->update(pipe, old_pstate); |
5b809074 NT |
145 | } |
146 | ||
7d83a155 MV |
147 | static int drm_simple_kms_plane_prepare_fb(struct drm_plane *plane, |
148 | struct drm_plane_state *state) | |
149 | { | |
150 | struct drm_simple_display_pipe *pipe; | |
151 | ||
152 | pipe = container_of(plane, struct drm_simple_display_pipe, plane); | |
153 | if (!pipe->funcs || !pipe->funcs->prepare_fb) | |
154 | return 0; | |
155 | ||
156 | return pipe->funcs->prepare_fb(pipe, state); | |
157 | } | |
158 | ||
159 | static void drm_simple_kms_plane_cleanup_fb(struct drm_plane *plane, | |
160 | struct drm_plane_state *state) | |
161 | { | |
162 | struct drm_simple_display_pipe *pipe; | |
163 | ||
164 | pipe = container_of(plane, struct drm_simple_display_pipe, plane); | |
165 | if (!pipe->funcs || !pipe->funcs->cleanup_fb) | |
166 | return; | |
167 | ||
168 | pipe->funcs->cleanup_fb(pipe, state); | |
169 | } | |
170 | ||
5b809074 | 171 | static const struct drm_plane_helper_funcs drm_simple_kms_plane_helper_funcs = { |
7d83a155 MV |
172 | .prepare_fb = drm_simple_kms_plane_prepare_fb, |
173 | .cleanup_fb = drm_simple_kms_plane_cleanup_fb, | |
5b809074 NT |
174 | .atomic_check = drm_simple_kms_plane_atomic_check, |
175 | .atomic_update = drm_simple_kms_plane_atomic_update, | |
176 | }; | |
177 | ||
178 | static const struct drm_plane_funcs drm_simple_kms_plane_funcs = { | |
179 | .update_plane = drm_atomic_helper_update_plane, | |
180 | .disable_plane = drm_atomic_helper_disable_plane, | |
181 | .destroy = drm_plane_cleanup, | |
182 | .reset = drm_atomic_helper_plane_reset, | |
183 | .atomic_duplicate_state = drm_atomic_helper_plane_duplicate_state, | |
184 | .atomic_destroy_state = drm_atomic_helper_plane_destroy_state, | |
185 | }; | |
186 | ||
315486c6 AM |
187 | /** |
188 | * drm_simple_display_pipe_attach_bridge - Attach a bridge to the display pipe | |
189 | * @pipe: simple display pipe object | |
190 | * @bridge: bridge to attach | |
191 | * | |
192 | * Makes it possible to still use the drm_simple_display_pipe helpers when | |
193 | * a DRM bridge has to be used. | |
194 | * | |
195 | * Note that you probably want to initialize the pipe by passing a NULL | |
196 | * connector to drm_simple_display_pipe_init(). | |
197 | * | |
198 | * Returns: | |
199 | * Zero on success, negative error code on failure. | |
200 | */ | |
201 | int drm_simple_display_pipe_attach_bridge(struct drm_simple_display_pipe *pipe, | |
202 | struct drm_bridge *bridge) | |
203 | { | |
3bb80f24 | 204 | return drm_bridge_attach(&pipe->encoder, bridge, NULL); |
315486c6 AM |
205 | } |
206 | EXPORT_SYMBOL(drm_simple_display_pipe_attach_bridge); | |
207 | ||
5b809074 NT |
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) | |
62cacc79 | 213 | * @formats: array of supported formats (DRM_FORMAT\_\*) |
5b809074 | 214 | * @format_count: number of elements in @formats |
e6fc3b68 | 215 | * @format_modifiers: array of formats modifiers |
4f993973 | 216 | * @connector: connector to attach and register (optional) |
5b809074 NT |
217 | * |
218 | * Sets up a display pipeline which consist of a really simple | |
4f993973 AM |
219 | * plane-crtc-encoder pipe. |
220 | * | |
221 | * If a connector is supplied, the pipe will be coupled with the provided | |
222 | * connector. You may supply a NULL connector when using drm bridges, that | |
223 | * handle connectors themselves (see drm_simple_display_pipe_attach_bridge()). | |
224 | * | |
5b809074 NT |
225 | * Teardown of a simple display pipe is all handled automatically by the drm |
226 | * core through calling drm_mode_config_cleanup(). Drivers afterwards need to | |
227 | * release the memory for the structure themselves. | |
228 | * | |
229 | * Returns: | |
230 | * Zero on success, negative error code on failure. | |
231 | */ | |
232 | int drm_simple_display_pipe_init(struct drm_device *dev, | |
233 | struct drm_simple_display_pipe *pipe, | |
234 | const struct drm_simple_display_pipe_funcs *funcs, | |
235 | const uint32_t *formats, unsigned int format_count, | |
e6fc3b68 | 236 | const uint64_t *format_modifiers, |
5b809074 NT |
237 | struct drm_connector *connector) |
238 | { | |
239 | struct drm_encoder *encoder = &pipe->encoder; | |
240 | struct drm_plane *plane = &pipe->plane; | |
241 | struct drm_crtc *crtc = &pipe->crtc; | |
242 | int ret; | |
243 | ||
244 | pipe->connector = connector; | |
245 | pipe->funcs = funcs; | |
246 | ||
247 | drm_plane_helper_add(plane, &drm_simple_kms_plane_helper_funcs); | |
248 | ret = drm_universal_plane_init(dev, plane, 0, | |
249 | &drm_simple_kms_plane_funcs, | |
250 | formats, format_count, | |
e6fc3b68 | 251 | format_modifiers, |
5b809074 NT |
252 | DRM_PLANE_TYPE_PRIMARY, NULL); |
253 | if (ret) | |
254 | return ret; | |
255 | ||
256 | drm_crtc_helper_add(crtc, &drm_simple_kms_crtc_helper_funcs); | |
257 | ret = drm_crtc_init_with_planes(dev, crtc, plane, NULL, | |
258 | &drm_simple_kms_crtc_funcs, NULL); | |
259 | if (ret) | |
260 | return ret; | |
261 | ||
262 | encoder->possible_crtcs = 1 << drm_crtc_index(crtc); | |
263 | ret = drm_encoder_init(dev, encoder, &drm_simple_kms_encoder_funcs, | |
264 | DRM_MODE_ENCODER_NONE, NULL); | |
4f993973 | 265 | if (ret || !connector) |
5b809074 NT |
266 | return ret; |
267 | ||
268 | return drm_mode_connector_attach_encoder(connector, encoder); | |
269 | } | |
270 | EXPORT_SYMBOL(drm_simple_display_pipe_init); | |
271 | ||
272 | MODULE_LICENSE("GPL"); |