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