xref: /openbmc/linux/drivers/gpu/drm/omapdrm/omap_drv.h (revision c819e2cf)
1 /*
2  * drivers/gpu/drm/omapdrm/omap_drv.h
3  *
4  * Copyright (C) 2011 Texas Instruments
5  * Author: Rob Clark <rob@ti.com>
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License version 2 as published by
9  * the Free Software Foundation.
10  *
11  * This program is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
14  * more details.
15  *
16  * You should have received a copy of the GNU General Public License along with
17  * this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef __OMAP_DRV_H__
21 #define __OMAP_DRV_H__
22 
23 #include <video/omapdss.h>
24 #include <linux/module.h>
25 #include <linux/types.h>
26 #include <drm/drmP.h>
27 #include <drm/drm_crtc_helper.h>
28 #include <drm/omap_drm.h>
29 #include <drm/drm_gem.h>
30 #include <linux/platform_data/omap_drm.h>
31 
32 
33 #define DBG(fmt, ...) DRM_DEBUG(fmt"\n", ##__VA_ARGS__)
34 #define VERB(fmt, ...) if (0) DRM_DEBUG(fmt, ##__VA_ARGS__) /* verbose debug */
35 
36 #define MODULE_NAME     "omapdrm"
37 
38 /* max # of mapper-id's that can be assigned.. todo, come up with a better
39  * (but still inexpensive) way to store/access per-buffer mapper private
40  * data..
41  */
42 #define MAX_MAPPERS 2
43 
44 /* parameters which describe (unrotated) coordinates of scanout within a fb: */
45 struct omap_drm_window {
46 	uint32_t rotation;
47 	int32_t  crtc_x, crtc_y;		/* signed because can be offscreen */
48 	uint32_t crtc_w, crtc_h;
49 	uint32_t src_x, src_y;
50 	uint32_t src_w, src_h;
51 };
52 
53 /* Once GO bit is set, we can't make further updates to shadowed registers
54  * until the GO bit is cleared.  So various parts in the kms code that need
55  * to update shadowed registers queue up a pair of callbacks, pre_apply
56  * which is called before setting GO bit, and post_apply that is called
57  * after GO bit is cleared.  The crtc manages the queuing, and everyone
58  * else goes thru omap_crtc_apply() using these callbacks so that the
59  * code which has to deal w/ GO bit state is centralized.
60  */
61 struct omap_drm_apply {
62 	struct list_head pending_node, queued_node;
63 	bool queued;
64 	void (*pre_apply)(struct omap_drm_apply *apply);
65 	void (*post_apply)(struct omap_drm_apply *apply);
66 };
67 
68 /* For transiently registering for different DSS irqs that various parts
69  * of the KMS code need during setup/configuration.  We these are not
70  * necessarily the same as what drm_vblank_get/put() are requesting, and
71  * the hysteresis in drm_vblank_put() is not necessarily desirable for
72  * internal housekeeping related irq usage.
73  */
74 struct omap_drm_irq {
75 	struct list_head node;
76 	uint32_t irqmask;
77 	bool registered;
78 	void (*irq)(struct omap_drm_irq *irq, uint32_t irqstatus);
79 };
80 
81 /* For KMS code that needs to wait for a certain # of IRQs:
82  */
83 struct omap_irq_wait;
84 struct omap_irq_wait * omap_irq_wait_init(struct drm_device *dev,
85 		uint32_t irqmask, int count);
86 int omap_irq_wait(struct drm_device *dev, struct omap_irq_wait *wait,
87 		unsigned long timeout);
88 
89 struct omap_drm_private {
90 	uint32_t omaprev;
91 
92 	unsigned int num_crtcs;
93 	struct drm_crtc *crtcs[8];
94 
95 	unsigned int num_planes;
96 	struct drm_plane *planes[8];
97 
98 	unsigned int num_encoders;
99 	struct drm_encoder *encoders[8];
100 
101 	unsigned int num_connectors;
102 	struct drm_connector *connectors[8];
103 
104 	struct drm_fb_helper *fbdev;
105 
106 	struct workqueue_struct *wq;
107 
108 	/* list of GEM objects: */
109 	struct list_head obj_list;
110 
111 	bool has_dmm;
112 
113 	/* properties: */
114 	struct drm_property *rotation_prop;
115 	struct drm_property *zorder_prop;
116 
117 	/* irq handling: */
118 	struct list_head irq_list;    /* list of omap_drm_irq */
119 	uint32_t vblank_mask;         /* irq bits set for userspace vblank */
120 	struct omap_drm_irq error_handler;
121 };
122 
123 
124 #ifdef CONFIG_DEBUG_FS
125 int omap_debugfs_init(struct drm_minor *minor);
126 void omap_debugfs_cleanup(struct drm_minor *minor);
127 void omap_framebuffer_describe(struct drm_framebuffer *fb, struct seq_file *m);
128 void omap_gem_describe(struct drm_gem_object *obj, struct seq_file *m);
129 void omap_gem_describe_objects(struct list_head *list, struct seq_file *m);
130 #endif
131 
132 #ifdef CONFIG_PM
133 int omap_gem_resume(struct device *dev);
134 #endif
135 
136 int omap_irq_enable_vblank(struct drm_device *dev, int crtc_id);
137 void omap_irq_disable_vblank(struct drm_device *dev, int crtc_id);
138 irqreturn_t omap_irq_handler(int irq, void *arg);
139 void omap_irq_preinstall(struct drm_device *dev);
140 int omap_irq_postinstall(struct drm_device *dev);
141 void omap_irq_uninstall(struct drm_device *dev);
142 void __omap_irq_register(struct drm_device *dev, struct omap_drm_irq *irq);
143 void __omap_irq_unregister(struct drm_device *dev, struct omap_drm_irq *irq);
144 void omap_irq_register(struct drm_device *dev, struct omap_drm_irq *irq);
145 void omap_irq_unregister(struct drm_device *dev, struct omap_drm_irq *irq);
146 int omap_drm_irq_uninstall(struct drm_device *dev);
147 int omap_drm_irq_install(struct drm_device *dev);
148 
149 struct drm_fb_helper *omap_fbdev_init(struct drm_device *dev);
150 void omap_fbdev_free(struct drm_device *dev);
151 
152 const struct omap_video_timings *omap_crtc_timings(struct drm_crtc *crtc);
153 enum omap_channel omap_crtc_channel(struct drm_crtc *crtc);
154 int omap_crtc_apply(struct drm_crtc *crtc,
155 		struct omap_drm_apply *apply);
156 void omap_crtc_pre_init(void);
157 void omap_crtc_pre_uninit(void);
158 struct drm_crtc *omap_crtc_init(struct drm_device *dev,
159 		struct drm_plane *plane, enum omap_channel channel, int id);
160 void omap_crtc_flush(struct drm_crtc *crtc);
161 
162 struct drm_plane *omap_plane_init(struct drm_device *dev,
163 		int plane_id, bool private_plane);
164 int omap_plane_dpms(struct drm_plane *plane, int mode);
165 int omap_plane_mode_set(struct drm_plane *plane,
166 		struct drm_crtc *crtc, struct drm_framebuffer *fb,
167 		int crtc_x, int crtc_y,
168 		unsigned int crtc_w, unsigned int crtc_h,
169 		uint32_t src_x, uint32_t src_y,
170 		uint32_t src_w, uint32_t src_h,
171 		void (*fxn)(void *), void *arg);
172 void omap_plane_install_properties(struct drm_plane *plane,
173 		struct drm_mode_object *obj);
174 int omap_plane_set_property(struct drm_plane *plane,
175 		struct drm_property *property, uint64_t val);
176 
177 struct drm_encoder *omap_encoder_init(struct drm_device *dev,
178 		struct omap_dss_device *dssdev);
179 int omap_encoder_set_enabled(struct drm_encoder *encoder, bool enabled);
180 int omap_encoder_update(struct drm_encoder *encoder,
181 		struct omap_overlay_manager *mgr,
182 		struct omap_video_timings *timings);
183 
184 struct drm_connector *omap_connector_init(struct drm_device *dev,
185 		int connector_type, struct omap_dss_device *dssdev,
186 		struct drm_encoder *encoder);
187 struct drm_encoder *omap_connector_attached_encoder(
188 		struct drm_connector *connector);
189 void omap_connector_flush(struct drm_connector *connector,
190 		int x, int y, int w, int h);
191 bool omap_connector_get_hdmi_mode(struct drm_connector *connector);
192 
193 void copy_timings_omap_to_drm(struct drm_display_mode *mode,
194 		struct omap_video_timings *timings);
195 void copy_timings_drm_to_omap(struct omap_video_timings *timings,
196 		struct drm_display_mode *mode);
197 
198 uint32_t omap_framebuffer_get_formats(uint32_t *pixel_formats,
199 		uint32_t max_formats, enum omap_color_mode supported_modes);
200 struct drm_framebuffer *omap_framebuffer_create(struct drm_device *dev,
201 		struct drm_file *file, struct drm_mode_fb_cmd2 *mode_cmd);
202 struct drm_framebuffer *omap_framebuffer_init(struct drm_device *dev,
203 		struct drm_mode_fb_cmd2 *mode_cmd, struct drm_gem_object **bos);
204 struct drm_gem_object *omap_framebuffer_bo(struct drm_framebuffer *fb, int p);
205 int omap_framebuffer_pin(struct drm_framebuffer *fb);
206 int omap_framebuffer_unpin(struct drm_framebuffer *fb);
207 void omap_framebuffer_update_scanout(struct drm_framebuffer *fb,
208 		struct omap_drm_window *win, struct omap_overlay_info *info);
209 struct drm_connector *omap_framebuffer_get_next_connector(
210 		struct drm_framebuffer *fb, struct drm_connector *from);
211 void omap_framebuffer_flush(struct drm_framebuffer *fb,
212 		int x, int y, int w, int h);
213 
214 void omap_gem_init(struct drm_device *dev);
215 void omap_gem_deinit(struct drm_device *dev);
216 
217 struct drm_gem_object *omap_gem_new(struct drm_device *dev,
218 		union omap_gem_size gsize, uint32_t flags);
219 int omap_gem_new_handle(struct drm_device *dev, struct drm_file *file,
220 		union omap_gem_size gsize, uint32_t flags, uint32_t *handle);
221 void omap_gem_free_object(struct drm_gem_object *obj);
222 void *omap_gem_vaddr(struct drm_gem_object *obj);
223 int omap_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
224 		uint32_t handle, uint64_t *offset);
225 int omap_gem_dumb_create(struct drm_file *file, struct drm_device *dev,
226 		struct drm_mode_create_dumb *args);
227 int omap_gem_mmap(struct file *filp, struct vm_area_struct *vma);
228 int omap_gem_mmap_obj(struct drm_gem_object *obj,
229 		struct vm_area_struct *vma);
230 int omap_gem_fault(struct vm_area_struct *vma, struct vm_fault *vmf);
231 int omap_gem_op_start(struct drm_gem_object *obj, enum omap_gem_op op);
232 int omap_gem_op_finish(struct drm_gem_object *obj, enum omap_gem_op op);
233 int omap_gem_op_sync(struct drm_gem_object *obj, enum omap_gem_op op);
234 int omap_gem_op_async(struct drm_gem_object *obj, enum omap_gem_op op,
235 		void (*fxn)(void *arg), void *arg);
236 int omap_gem_roll(struct drm_gem_object *obj, uint32_t roll);
237 void omap_gem_cpu_sync(struct drm_gem_object *obj, int pgoff);
238 void omap_gem_dma_sync(struct drm_gem_object *obj,
239 		enum dma_data_direction dir);
240 int omap_gem_get_paddr(struct drm_gem_object *obj,
241 		dma_addr_t *paddr, bool remap);
242 int omap_gem_put_paddr(struct drm_gem_object *obj);
243 int omap_gem_get_pages(struct drm_gem_object *obj, struct page ***pages,
244 		bool remap);
245 int omap_gem_put_pages(struct drm_gem_object *obj);
246 uint32_t omap_gem_flags(struct drm_gem_object *obj);
247 int omap_gem_rotated_paddr(struct drm_gem_object *obj, uint32_t orient,
248 		int x, int y, dma_addr_t *paddr);
249 uint64_t omap_gem_mmap_offset(struct drm_gem_object *obj);
250 size_t omap_gem_mmap_size(struct drm_gem_object *obj);
251 int omap_gem_tiled_size(struct drm_gem_object *obj, uint16_t *w, uint16_t *h);
252 int omap_gem_tiled_stride(struct drm_gem_object *obj, uint32_t orient);
253 
254 struct dma_buf *omap_gem_prime_export(struct drm_device *dev,
255 		struct drm_gem_object *obj, int flags);
256 struct drm_gem_object *omap_gem_prime_import(struct drm_device *dev,
257 		struct dma_buf *buffer);
258 
259 static inline int align_pitch(int pitch, int width, int bpp)
260 {
261 	int bytespp = (bpp + 7) / 8;
262 	/* in case someone tries to feed us a completely bogus stride: */
263 	pitch = max(pitch, width * bytespp);
264 	/* PVR needs alignment to 8 pixels.. right now that is the most
265 	 * restrictive stride requirement..
266 	 */
267 	return ALIGN(pitch, 8 * bytespp);
268 }
269 
270 /* map crtc to vblank mask */
271 uint32_t pipe2vbl(struct drm_crtc *crtc);
272 struct omap_dss_device *omap_encoder_get_dssdev(struct drm_encoder *encoder);
273 
274 /* should these be made into common util helpers?
275  */
276 
277 static inline int objects_lookup(struct drm_device *dev,
278 		struct drm_file *filp, uint32_t pixel_format,
279 		struct drm_gem_object **bos, uint32_t *handles)
280 {
281 	int i, n = drm_format_num_planes(pixel_format);
282 
283 	for (i = 0; i < n; i++) {
284 		bos[i] = drm_gem_object_lookup(dev, filp, handles[i]);
285 		if (!bos[i])
286 			goto fail;
287 
288 	}
289 
290 	return 0;
291 
292 fail:
293 	while (--i > 0)
294 		drm_gem_object_unreference_unlocked(bos[i]);
295 
296 	return -ENOENT;
297 }
298 
299 #endif /* __OMAP_DRV_H__ */
300