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