xref: /openbmc/linux/drivers/gpu/drm/omapdrm/omap_drv.h (revision 110e6f26)
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 <linux/module.h>
24 #include <linux/platform_data/omap_drm.h>
25 #include <linux/types.h>
26 #include <linux/wait.h>
27 #include <video/omapdss.h>
28 
29 #include <drm/drmP.h>
30 #include <drm/drm_crtc_helper.h>
31 #include <drm/drm_gem.h>
32 #include <drm/omap_drm.h>
33 
34 #include "dss/omapdss.h"
35 
36 #define DBG(fmt, ...) DRM_DEBUG(fmt"\n", ##__VA_ARGS__)
37 #define VERB(fmt, ...) if (0) DRM_DEBUG(fmt, ##__VA_ARGS__) /* verbose debug */
38 
39 #define MODULE_NAME     "omapdrm"
40 
41 struct omap_drm_usergart;
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 /* For transiently registering for different DSS irqs that various parts
53  * of the KMS code need during setup/configuration.  We these are not
54  * necessarily the same as what drm_vblank_get/put() are requesting, and
55  * the hysteresis in drm_vblank_put() is not necessarily desirable for
56  * internal housekeeping related irq usage.
57  */
58 struct omap_drm_irq {
59 	struct list_head node;
60 	uint32_t irqmask;
61 	bool registered;
62 	void (*irq)(struct omap_drm_irq *irq, uint32_t irqstatus);
63 };
64 
65 /* For KMS code that needs to wait for a certain # of IRQs:
66  */
67 struct omap_irq_wait;
68 struct omap_irq_wait * omap_irq_wait_init(struct drm_device *dev,
69 		uint32_t irqmask, int count);
70 int omap_irq_wait(struct drm_device *dev, struct omap_irq_wait *wait,
71 		unsigned long timeout);
72 
73 struct omap_drm_private {
74 	uint32_t omaprev;
75 
76 	unsigned int num_crtcs;
77 	struct drm_crtc *crtcs[8];
78 
79 	unsigned int num_planes;
80 	struct drm_plane *planes[8];
81 
82 	unsigned int num_encoders;
83 	struct drm_encoder *encoders[8];
84 
85 	unsigned int num_connectors;
86 	struct drm_connector *connectors[8];
87 
88 	struct drm_fb_helper *fbdev;
89 
90 	struct workqueue_struct *wq;
91 
92 	/* lock for obj_list below */
93 	spinlock_t list_lock;
94 
95 	/* list of GEM objects: */
96 	struct list_head obj_list;
97 
98 	struct omap_drm_usergart *usergart;
99 	bool has_dmm;
100 
101 	/* properties: */
102 	struct drm_property *zorder_prop;
103 
104 	/* irq handling: */
105 	struct list_head irq_list;    /* list of omap_drm_irq */
106 	uint32_t vblank_mask;         /* irq bits set for userspace vblank */
107 	struct omap_drm_irq error_handler;
108 
109 	/* atomic commit */
110 	struct {
111 		wait_queue_head_t wait;
112 		u32 pending;
113 		spinlock_t lock;	/* Protects commit.pending */
114 	} commit;
115 };
116 
117 
118 #ifdef CONFIG_DEBUG_FS
119 int omap_debugfs_init(struct drm_minor *minor);
120 void omap_debugfs_cleanup(struct drm_minor *minor);
121 void omap_framebuffer_describe(struct drm_framebuffer *fb, struct seq_file *m);
122 void omap_gem_describe(struct drm_gem_object *obj, struct seq_file *m);
123 void omap_gem_describe_objects(struct list_head *list, struct seq_file *m);
124 #endif
125 
126 #ifdef CONFIG_PM
127 int omap_gem_resume(struct device *dev);
128 #endif
129 
130 int omap_irq_enable_vblank(struct drm_device *dev, unsigned int pipe);
131 void omap_irq_disable_vblank(struct drm_device *dev, unsigned int pipe);
132 void __omap_irq_register(struct drm_device *dev, struct omap_drm_irq *irq);
133 void __omap_irq_unregister(struct drm_device *dev, struct omap_drm_irq *irq);
134 void omap_irq_register(struct drm_device *dev, struct omap_drm_irq *irq);
135 void omap_irq_unregister(struct drm_device *dev, struct omap_drm_irq *irq);
136 void omap_drm_irq_uninstall(struct drm_device *dev);
137 int omap_drm_irq_install(struct drm_device *dev);
138 
139 #ifdef CONFIG_DRM_FBDEV_EMULATION
140 struct drm_fb_helper *omap_fbdev_init(struct drm_device *dev);
141 void omap_fbdev_free(struct drm_device *dev);
142 #else
143 static inline struct drm_fb_helper *omap_fbdev_init(struct drm_device *dev)
144 {
145 	return NULL;
146 }
147 static inline void omap_fbdev_free(struct drm_device *dev)
148 {
149 }
150 #endif
151 
152 struct omap_video_timings *omap_crtc_timings(struct drm_crtc *crtc);
153 enum omap_channel omap_crtc_channel(struct drm_crtc *crtc);
154 void omap_crtc_pre_init(void);
155 void omap_crtc_pre_uninit(void);
156 struct drm_crtc *omap_crtc_init(struct drm_device *dev,
157 		struct drm_plane *plane, enum omap_channel channel, int id);
158 int omap_crtc_wait_pending(struct drm_crtc *crtc);
159 
160 struct drm_plane *omap_plane_init(struct drm_device *dev,
161 		int id, enum drm_plane_type type);
162 void omap_plane_install_properties(struct drm_plane *plane,
163 		struct drm_mode_object *obj);
164 
165 struct drm_encoder *omap_encoder_init(struct drm_device *dev,
166 		struct omap_dss_device *dssdev);
167 
168 struct drm_connector *omap_connector_init(struct drm_device *dev,
169 		int connector_type, struct omap_dss_device *dssdev,
170 		struct drm_encoder *encoder);
171 struct drm_encoder *omap_connector_attached_encoder(
172 		struct drm_connector *connector);
173 bool omap_connector_get_hdmi_mode(struct drm_connector *connector);
174 
175 void copy_timings_omap_to_drm(struct drm_display_mode *mode,
176 		struct omap_video_timings *timings);
177 void copy_timings_drm_to_omap(struct omap_video_timings *timings,
178 		struct drm_display_mode *mode);
179 
180 uint32_t omap_framebuffer_get_formats(uint32_t *pixel_formats,
181 		uint32_t max_formats, enum omap_color_mode supported_modes);
182 struct drm_framebuffer *omap_framebuffer_create(struct drm_device *dev,
183 		struct drm_file *file, const struct drm_mode_fb_cmd2 *mode_cmd);
184 struct drm_framebuffer *omap_framebuffer_init(struct drm_device *dev,
185 		const struct drm_mode_fb_cmd2 *mode_cmd, struct drm_gem_object **bos);
186 struct drm_gem_object *omap_framebuffer_bo(struct drm_framebuffer *fb, int p);
187 int omap_framebuffer_pin(struct drm_framebuffer *fb);
188 void omap_framebuffer_unpin(struct drm_framebuffer *fb);
189 void omap_framebuffer_update_scanout(struct drm_framebuffer *fb,
190 		struct omap_drm_window *win, struct omap_overlay_info *info);
191 struct drm_connector *omap_framebuffer_get_next_connector(
192 		struct drm_framebuffer *fb, struct drm_connector *from);
193 bool omap_framebuffer_supports_rotation(struct drm_framebuffer *fb);
194 
195 void omap_gem_init(struct drm_device *dev);
196 void omap_gem_deinit(struct drm_device *dev);
197 
198 struct drm_gem_object *omap_gem_new(struct drm_device *dev,
199 		union omap_gem_size gsize, uint32_t flags);
200 struct drm_gem_object *omap_gem_new_dmabuf(struct drm_device *dev, size_t size,
201 		struct sg_table *sgt);
202 int omap_gem_new_handle(struct drm_device *dev, struct drm_file *file,
203 		union omap_gem_size gsize, uint32_t flags, uint32_t *handle);
204 void omap_gem_free_object(struct drm_gem_object *obj);
205 void *omap_gem_vaddr(struct drm_gem_object *obj);
206 int omap_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
207 		uint32_t handle, uint64_t *offset);
208 int omap_gem_dumb_create(struct drm_file *file, struct drm_device *dev,
209 		struct drm_mode_create_dumb *args);
210 int omap_gem_mmap(struct file *filp, struct vm_area_struct *vma);
211 int omap_gem_mmap_obj(struct drm_gem_object *obj,
212 		struct vm_area_struct *vma);
213 int omap_gem_fault(struct vm_area_struct *vma, struct vm_fault *vmf);
214 int omap_gem_op_start(struct drm_gem_object *obj, enum omap_gem_op op);
215 int omap_gem_op_finish(struct drm_gem_object *obj, enum omap_gem_op op);
216 int omap_gem_op_sync(struct drm_gem_object *obj, enum omap_gem_op op);
217 int omap_gem_op_async(struct drm_gem_object *obj, enum omap_gem_op op,
218 		void (*fxn)(void *arg), void *arg);
219 int omap_gem_roll(struct drm_gem_object *obj, uint32_t roll);
220 void omap_gem_cpu_sync(struct drm_gem_object *obj, int pgoff);
221 void omap_gem_dma_sync(struct drm_gem_object *obj,
222 		enum dma_data_direction dir);
223 int omap_gem_get_paddr(struct drm_gem_object *obj,
224 		dma_addr_t *paddr, bool remap);
225 void omap_gem_put_paddr(struct drm_gem_object *obj);
226 int omap_gem_get_pages(struct drm_gem_object *obj, struct page ***pages,
227 		bool remap);
228 int omap_gem_put_pages(struct drm_gem_object *obj);
229 uint32_t omap_gem_flags(struct drm_gem_object *obj);
230 int omap_gem_rotated_paddr(struct drm_gem_object *obj, uint32_t orient,
231 		int x, int y, dma_addr_t *paddr);
232 uint64_t omap_gem_mmap_offset(struct drm_gem_object *obj);
233 size_t omap_gem_mmap_size(struct drm_gem_object *obj);
234 int omap_gem_tiled_size(struct drm_gem_object *obj, uint16_t *w, uint16_t *h);
235 int omap_gem_tiled_stride(struct drm_gem_object *obj, uint32_t orient);
236 
237 struct dma_buf *omap_gem_prime_export(struct drm_device *dev,
238 		struct drm_gem_object *obj, int flags);
239 struct drm_gem_object *omap_gem_prime_import(struct drm_device *dev,
240 		struct dma_buf *buffer);
241 
242 static inline int align_pitch(int pitch, int width, int bpp)
243 {
244 	int bytespp = (bpp + 7) / 8;
245 	/* in case someone tries to feed us a completely bogus stride: */
246 	pitch = max(pitch, width * bytespp);
247 	/* PVR needs alignment to 8 pixels.. right now that is the most
248 	 * restrictive stride requirement..
249 	 */
250 	return roundup(pitch, 8 * bytespp);
251 }
252 
253 /* map crtc to vblank mask */
254 uint32_t pipe2vbl(struct drm_crtc *crtc);
255 struct omap_dss_device *omap_encoder_get_dssdev(struct drm_encoder *encoder);
256 
257 /* should these be made into common util helpers?
258  */
259 
260 static inline int objects_lookup(struct drm_device *dev,
261 		struct drm_file *filp, uint32_t pixel_format,
262 		struct drm_gem_object **bos, const uint32_t *handles)
263 {
264 	int i, n = drm_format_num_planes(pixel_format);
265 
266 	for (i = 0; i < n; i++) {
267 		bos[i] = drm_gem_object_lookup(dev, filp, handles[i]);
268 		if (!bos[i])
269 			goto fail;
270 
271 	}
272 
273 	return 0;
274 
275 fail:
276 	while (--i > 0)
277 		drm_gem_object_unreference_unlocked(bos[i]);
278 
279 	return -ENOENT;
280 }
281 
282 #endif /* __OMAP_DRV_H__ */
283