projects/linux·blob master · refs

310 lines · 11.1 KiB

1/* SPDX-License-Identifier: MIT */
2/* Copyright © 2025 Intel Corporation x*/
3
4#ifndef __DISPLAY_PARENT_INTERFACE_H__
5#define __DISPLAY_PARENT_INTERFACE_H__
6
7#include <linux/types.h>
8
9enum vlv_iosf_sb_unit;
10struct dma_fence;
11struct drm_device;
12struct drm_file;
13struct drm_framebuffer;
14struct drm_gem_object;
15struct drm_mode_fb_cmd2;
16struct drm_plane_state;
17struct drm_scanout_buffer;
18struct fb_info;
19struct i915_gtt_view;
20struct i915_vma;
21struct intel_dpt;
22struct intel_dsb_buffer;
23struct intel_frontbuffer;
24struct intel_hdcp_gsc_context;
25struct intel_initial_plane_config;
26struct intel_panic;
27struct intel_stolen_node;
28struct iosys_map;
29struct ref_tracker;
30struct seq_file;
31struct vm_area_struct;
32
33struct intel_fb_pin_params {
34 const struct i915_gtt_view *view;
35 unsigned int alignment;
36 unsigned int phys_alignment;
37 unsigned int vtd_guard;
38 bool needs_cpu_lmem_access;
39 bool needs_low_address;
40 bool needs_physical;
41 bool needs_fence;
42};
43
44/* Keep struct definitions sorted */
45
46struct intel_display_bo_interface {
47 bool (*is_tiled)(struct drm_gem_object *obj); /* Optional */
48 bool (*is_userptr)(struct drm_gem_object *obj); /* Optional */
49 bool (*is_shmem)(struct drm_gem_object *obj); /* Optional */
50 bool (*is_protected)(struct drm_gem_object *obj);
51 int (*key_check)(struct drm_gem_object *obj);
52 int (*fb_mmap)(struct drm_gem_object *obj, struct vm_area_struct *vma);
53 int (*read_from_page)(struct drm_gem_object *obj, u64 offset, void *dst, int size);
54 void (*describe)(struct seq_file *m, struct drm_gem_object *obj); /* Optional */
55 int (*framebuffer_init)(struct drm_gem_object *obj, struct drm_mode_fb_cmd2 *mode_cmd);
56 void (*framebuffer_fini)(struct drm_gem_object *obj);
57 struct drm_gem_object *(*framebuffer_lookup)(struct drm_device *drm,
58 struct drm_file *filp,
59 const struct drm_mode_fb_cmd2 *user_mode_cmd);
60#if IS_ENABLED(CONFIG_DRM_FBDEV_EMULATION)
61 struct drm_gem_object *(*fbdev_create)(struct drm_device *drm, int size);
62 void (*fbdev_destroy)(struct drm_gem_object *obj);
63 int (*fbdev_fill_info)(struct drm_gem_object *obj, struct fb_info *info, struct i915_vma *vma);
64 u32 (*fbdev_pitch_align)(u32 stride);
65#endif
66};
67
68struct intel_display_dpt_interface {
69 struct intel_dpt *(*create)(struct drm_gem_object *obj, size_t size);
70 void (*destroy)(struct intel_dpt *dpt);
71 void (*suspend)(struct intel_dpt *dpt);
72 void (*resume)(struct intel_dpt *dpt);
73};
74
75struct intel_display_dsb_interface {
76 u32 (*ggtt_offset)(struct intel_dsb_buffer *dsb_buf);
77 void (*write)(struct intel_dsb_buffer *dsb_buf, u32 idx, u32 val);
78 u32 (*read)(struct intel_dsb_buffer *dsb_buf, u32 idx);
79 void (*fill)(struct intel_dsb_buffer *dsb_buf, u32 idx, u32 val, size_t size);
80 struct intel_dsb_buffer *(*create)(struct drm_device *drm, size_t size);
81 void (*cleanup)(struct intel_dsb_buffer *dsb_buf);
82 void (*flush_map)(struct intel_dsb_buffer *dsb_buf);
83};
84
85struct intel_display_fb_pin_interface {
86 int (*ggtt_pin)(struct drm_gem_object *obj,
87 const struct intel_fb_pin_params *pin_params,
88 struct i915_vma **out_ggtt_vma,
89 u32 *out_offset,
90 int *out_fence_id);
91 void (*ggtt_unpin)(struct i915_vma *ggtt_vma,
92 int fence_id);
93 int (*dpt_pin)(struct drm_gem_object *obj,
94 struct intel_dpt *dpt,
95 const struct intel_fb_pin_params *pin_params,
96 struct i915_vma **out_dpt_vma,
97 struct i915_vma **out_ggtt_vma,
98 u32 *out_offset);
99 void (*dpt_unpin)(struct intel_dpt *dpt,
100 struct i915_vma *dpt_vma,
101 struct i915_vma *ggtt_vma);
102 struct i915_vma *(*reuse_vma)(struct i915_vma *old_ggtt_vma,
103 struct drm_gem_object *old_obj,
104 const struct i915_gtt_view *old_view,
105 struct drm_gem_object *new_obj,
106 const struct i915_gtt_view *new_view,
107 u32 *out_offset);
108 void (*get_map)(struct i915_vma *vma, struct iosys_map *map);
109};
110
111struct intel_display_frontbuffer_interface {
112 struct intel_frontbuffer *(*get)(struct drm_gem_object *obj);
113 void (*ref)(struct intel_frontbuffer *front);
114 void (*put)(struct intel_frontbuffer *front);
115 void (*flush_for_display)(struct intel_frontbuffer *front);
116};
117
118struct intel_display_hdcp_interface {
119 ssize_t (*gsc_msg_send)(struct intel_hdcp_gsc_context *gsc_context,
120 void *msg_in, size_t msg_in_len,
121 void *msg_out, size_t msg_out_len);
122 bool (*gsc_check_status)(struct drm_device *drm);
123 struct intel_hdcp_gsc_context *(*gsc_context_alloc)(struct drm_device *drm);
124 void (*gsc_context_free)(struct intel_hdcp_gsc_context *gsc_context);
125};
126
127struct intel_display_initial_plane_interface {
128 struct drm_gem_object *(*alloc_obj)(struct drm_device *drm, struct intel_initial_plane_config *plane_config);
129 int (*setup)(struct drm_plane_state *plane_state, struct intel_initial_plane_config *plane_config,
130 struct drm_framebuffer *fb, struct i915_vma *vma);
131 void (*config_fini)(struct intel_initial_plane_config *plane_config);
132};
133
134struct intel_display_irq_interface {
135 bool (*enabled)(struct drm_device *drm);
136 void (*synchronize)(struct drm_device *drm);
137};
138
139struct intel_display_overlay_interface {
140 bool (*is_active)(struct drm_device *drm);
141
142 int (*overlay_on)(struct drm_device *drm,
143 u32 frontbuffer_bits);
144 int (*overlay_continue)(struct drm_device *drm,
145 struct i915_vma *vma,
146 bool load_polyphase_filter);
147 int (*overlay_off)(struct drm_device *drm);
148 int (*recover_from_interrupt)(struct drm_device *drm);
149 int (*release_old_vid)(struct drm_device *drm);
150
151 void (*reset)(struct drm_device *drm);
152
153 struct i915_vma *(*pin_fb)(struct drm_device *drm,
154 struct drm_gem_object *obj,
155 u32 *offset);
156 void (*unpin_fb)(struct drm_device *drm,
157 struct i915_vma *vma);
158
159 struct drm_gem_object *(*obj_lookup)(struct drm_device *drm,
160 struct drm_file *filp,
161 u32 handle);
162
163 void __iomem *(*setup)(struct drm_device *drm,
164 bool needs_physical);
165 void (*cleanup)(struct drm_device *drm);
166};
167
168struct intel_display_panic_interface {
169 struct intel_panic *(*alloc)(void);
170 int (*setup)(struct intel_panic *panic, struct drm_scanout_buffer *sb,
171 struct drm_gem_object *obj,
172 unsigned int (*tiling)(unsigned int x, unsigned int y, unsigned int width));
173 void (*finish)(struct intel_panic *panic);
174};
175
176struct intel_display_pc8_interface {
177 void (*block)(struct drm_device *drm);
178 void (*unblock)(struct drm_device *drm);
179};
180
181struct intel_display_pcode_interface {
182 int (*read)(struct drm_device *drm, u32 mbox, u32 *val, u32 *val1);
183 int (*write)(struct drm_device *drm, u32 mbox, u32 val, int timeout_ms);
184 int (*request)(struct drm_device *drm, u32 mbox, u32 request,
185 u32 reply_mask, u32 reply, int timeout_base_ms);
186};
187
188struct intel_display_rpm_interface {
189 struct ref_tracker *(*get)(const struct drm_device *drm);
190 struct ref_tracker *(*get_raw)(const struct drm_device *drm);
191 struct ref_tracker *(*get_if_in_use)(const struct drm_device *drm);
192 struct ref_tracker *(*get_noresume)(const struct drm_device *drm);
193
194 void (*put)(const struct drm_device *drm, struct ref_tracker *wakeref);
195 void (*put_raw)(const struct drm_device *drm, struct ref_tracker *wakeref);
196 void (*put_unchecked)(const struct drm_device *drm);
197
198 bool (*suspended)(const struct drm_device *drm);
199 void (*assert_held)(const struct drm_device *drm);
200 void (*assert_block)(const struct drm_device *drm);
201 void (*assert_unblock)(const struct drm_device *drm);
202};
203
204struct intel_display_rps_interface {
205 void (*boost_if_not_started)(struct dma_fence *fence);
206 void (*mark_interactive)(struct drm_device *drm, bool interactive);
207 void (*ilk_irq_handler)(struct drm_device *drm);
208};
209
210struct intel_display_stolen_interface {
211 int (*insert_node_in_range)(struct intel_stolen_node *node, u64 size,
212 unsigned int align, u64 start, u64 end);
213 int (*insert_node)(struct intel_stolen_node *node, u64 size, unsigned int align); /* Optional */
214 void (*remove_node)(struct intel_stolen_node *node);
215 bool (*initialized)(struct drm_device *drm);
216 bool (*node_allocated)(const struct intel_stolen_node *node);
217 u64 (*node_offset)(const struct intel_stolen_node *node);
218 u64 (*area_address)(struct drm_device *drm); /* Optional */
219 u64 (*area_size)(struct drm_device *drm); /* Optional */
220 u64 (*node_address)(const struct intel_stolen_node *node);
221 u64 (*node_size)(const struct intel_stolen_node *node);
222 struct intel_stolen_node *(*node_alloc)(struct drm_device *drm);
223 void (*node_free)(const struct intel_stolen_node *node);
224};
225
226struct intel_display_vlv_iosf_interface {
227 void (*get)(struct drm_device *drm, unsigned long unit_mask);
228 void (*put)(struct drm_device *drm, unsigned long unit_mask);
229 u32 (*read)(struct drm_device *drm, enum vlv_iosf_sb_unit unit, u32 addr);
230 int (*write)(struct drm_device *drm, enum vlv_iosf_sb_unit unit, u32 addr, u32 val);
231};
232
233/**
234 * struct intel_display_parent_interface - services parent driver provides to display
235 *
236 * The parent, or core, driver provides a pointer to this structure to display
237 * driver when calling intel_display_device_probe(). The display driver uses it
238 * to access services provided by the parent driver. The structure may contain
239 * sub-struct pointers to group function pointers by functionality.
240 *
241 * All function and sub-struct pointers must be initialized and callable unless
242 * explicitly marked as "optional" below. The display driver will only NULL
243 * check the optional pointers.
244 */
245struct intel_display_parent_interface {
246 /** @bo: BO interface */
247 const struct intel_display_bo_interface *bo;
248
249 /** @dpt: DPT interface. Optional. */
250 const struct intel_display_dpt_interface *dpt;
251
252 /** @dsb: DSB buffer interface */
253 const struct intel_display_dsb_interface *dsb;
254
255 /** @fb_pin: Framebuffer pin interface */
256 const struct intel_display_fb_pin_interface *fb_pin;
257
258 /** @frontbuffer: Frontbuffer interface */
259 const struct intel_display_frontbuffer_interface *frontbuffer;
260
261 /** @hdcp: HDCP GSC interface */
262 const struct intel_display_hdcp_interface *hdcp;
263
264 /** @initial_plane: Initial plane interface */
265 const struct intel_display_initial_plane_interface *initial_plane;
266
267 /** @irq: IRQ interface */
268 const struct intel_display_irq_interface *irq;
269
270 /** @panic: Panic interface */
271 const struct intel_display_panic_interface *panic;
272
273 /** @overlay: Overlay. Optional. */
274 const struct intel_display_overlay_interface *overlay;
275
276 /** @pc8: PC8 interface. Optional. */
277 const struct intel_display_pc8_interface *pc8;
278
279 /** @pcode: Pcode interface */
280 const struct intel_display_pcode_interface *pcode;
281
282 /** @rpm: Runtime PM functions */
283 const struct intel_display_rpm_interface *rpm;
284
285 /** @rps: RPS interface. Optional. */
286 const struct intel_display_rps_interface *rps;
287
288 /** @stolen: Stolen memory. */
289 const struct intel_display_stolen_interface *stolen;
290
291 /** @vlv_iosf: VLV IOSF sideband. Optional. */
292 const struct intel_display_vlv_iosf_interface *vlv_iosf;
293
294 /* Generic independent functions */
295 struct {
296 /** @fence_priority_display: Set display priority. Optional. */
297 void (*fence_priority_display)(struct dma_fence *fence);
298
299 /** @has_auxccs: Are AuxCCS formats supported by the parent. Optional. */
300 bool (*has_auxccs)(struct drm_device *drm);
301
302 /** @has_fenced_regions: Support legacy fencing? Optional. */
303 bool (*has_fenced_regions)(struct drm_device *drm);
304
305 /** @vgpu_active: Is vGPU active? Optional. */
306 bool (*vgpu_active)(struct drm_device *drm);
307 };
308};
309
310#endif