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