xref: /openbmc/linux/drivers/gpu/drm/omapdrm/omap_drv.h (revision de2bdb3d)
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 
28 #include <drm/drmP.h>
29 #include <drm/drm_crtc_helper.h>
30 #include <drm/drm_gem.h>
31 #include <drm/omap_drm.h>
32 
33 #include "dss/omapdss.h"
34 
35 #define DBG(fmt, ...) DRM_DEBUG(fmt"\n", ##__VA_ARGS__)
36 #define VERB(fmt, ...) if (0) DRM_DEBUG(fmt, ##__VA_ARGS__) /* verbose debug */
37 
38 #define MODULE_NAME     "omapdrm"
39 
40 struct omap_drm_usergart;
41 
42 /* parameters which describe (unrotated) coordinates of scanout within a fb: */
43 struct omap_drm_window {
44 	uint32_t rotation;
45 	int32_t  crtc_x, crtc_y;		/* signed because can be offscreen */
46 	uint32_t crtc_w, crtc_h;
47 	uint32_t src_x, src_y;
48 	uint32_t src_w, src_h;
49 };
50 
51 /* For transiently registering for different DSS irqs that various parts
52  * of the KMS code need during setup/configuration.  We these are not
53  * necessarily the same as what drm_vblank_get/put() are requesting, and
54  * the hysteresis in drm_vblank_put() is not necessarily desirable for
55  * internal housekeeping related irq usage.
56  */
57 struct omap_drm_irq {
58 	struct list_head node;
59 	uint32_t irqmask;
60 	bool registered;
61 	void (*irq)(struct omap_drm_irq *irq, uint32_t irqstatus);
62 };
63 
64 /* For KMS code that needs to wait for a certain # of IRQs:
65  */
66 struct omap_irq_wait;
67 struct omap_irq_wait * omap_irq_wait_init(struct drm_device *dev,
68 		uint32_t irqmask, int count);
69 int omap_irq_wait(struct drm_device *dev, struct omap_irq_wait *wait,
70 		unsigned long timeout);
71 
72 struct omap_drm_private {
73 	uint32_t omaprev;
74 
75 	unsigned int num_crtcs;
76 	struct drm_crtc *crtcs[8];
77 
78 	unsigned int num_planes;
79 	struct drm_plane *planes[8];
80 
81 	unsigned int num_encoders;
82 	struct drm_encoder *encoders[8];
83 
84 	unsigned int num_connectors;
85 	struct drm_connector *connectors[8];
86 
87 	struct drm_fb_helper *fbdev;
88 
89 	struct workqueue_struct *wq;
90 
91 	/* lock for obj_list below */
92 	spinlock_t list_lock;
93 
94 	/* list of GEM objects: */
95 	struct list_head obj_list;
96 
97 	struct omap_drm_usergart *usergart;
98 	bool has_dmm;
99 
100 	/* properties: */
101 	struct drm_property *zorder_prop;
102 
103 	/* irq handling: */
104 	struct list_head irq_list;    /* list of omap_drm_irq */
105 	uint32_t vblank_mask;         /* irq bits set for userspace vblank */
106 	struct omap_drm_irq error_handler;
107 
108 	/* atomic commit */
109 	struct {
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 videomode *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 uint32_t omap_framebuffer_get_formats(uint32_t *pixel_formats,
175 		uint32_t max_formats, enum omap_color_mode supported_modes);
176 struct drm_framebuffer *omap_framebuffer_create(struct drm_device *dev,
177 		struct drm_file *file, const struct drm_mode_fb_cmd2 *mode_cmd);
178 struct drm_framebuffer *omap_framebuffer_init(struct drm_device *dev,
179 		const struct drm_mode_fb_cmd2 *mode_cmd, struct drm_gem_object **bos);
180 int omap_framebuffer_pin(struct drm_framebuffer *fb);
181 void omap_framebuffer_unpin(struct drm_framebuffer *fb);
182 void omap_framebuffer_update_scanout(struct drm_framebuffer *fb,
183 		struct omap_drm_window *win, struct omap_overlay_info *info);
184 struct drm_connector *omap_framebuffer_get_next_connector(
185 		struct drm_framebuffer *fb, struct drm_connector *from);
186 bool omap_framebuffer_supports_rotation(struct drm_framebuffer *fb);
187 
188 void omap_gem_init(struct drm_device *dev);
189 void omap_gem_deinit(struct drm_device *dev);
190 
191 struct drm_gem_object *omap_gem_new(struct drm_device *dev,
192 		union omap_gem_size gsize, uint32_t flags);
193 struct drm_gem_object *omap_gem_new_dmabuf(struct drm_device *dev, size_t size,
194 		struct sg_table *sgt);
195 int omap_gem_new_handle(struct drm_device *dev, struct drm_file *file,
196 		union omap_gem_size gsize, uint32_t flags, uint32_t *handle);
197 void omap_gem_free_object(struct drm_gem_object *obj);
198 void *omap_gem_vaddr(struct drm_gem_object *obj);
199 int omap_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
200 		uint32_t handle, uint64_t *offset);
201 int omap_gem_dumb_create(struct drm_file *file, struct drm_device *dev,
202 		struct drm_mode_create_dumb *args);
203 int omap_gem_mmap(struct file *filp, struct vm_area_struct *vma);
204 int omap_gem_mmap_obj(struct drm_gem_object *obj,
205 		struct vm_area_struct *vma);
206 int omap_gem_fault(struct vm_area_struct *vma, struct vm_fault *vmf);
207 int omap_gem_op_start(struct drm_gem_object *obj, enum omap_gem_op op);
208 int omap_gem_op_finish(struct drm_gem_object *obj, enum omap_gem_op op);
209 int omap_gem_op_sync(struct drm_gem_object *obj, enum omap_gem_op op);
210 int omap_gem_op_async(struct drm_gem_object *obj, enum omap_gem_op op,
211 		void (*fxn)(void *arg), void *arg);
212 int omap_gem_roll(struct drm_gem_object *obj, uint32_t roll);
213 void omap_gem_cpu_sync(struct drm_gem_object *obj, int pgoff);
214 void omap_gem_dma_sync(struct drm_gem_object *obj,
215 		enum dma_data_direction dir);
216 int omap_gem_get_paddr(struct drm_gem_object *obj,
217 		dma_addr_t *paddr, bool remap);
218 void omap_gem_put_paddr(struct drm_gem_object *obj);
219 int omap_gem_get_pages(struct drm_gem_object *obj, struct page ***pages,
220 		bool remap);
221 int omap_gem_put_pages(struct drm_gem_object *obj);
222 uint32_t omap_gem_flags(struct drm_gem_object *obj);
223 int omap_gem_rotated_paddr(struct drm_gem_object *obj, uint32_t orient,
224 		int x, int y, dma_addr_t *paddr);
225 uint64_t omap_gem_mmap_offset(struct drm_gem_object *obj);
226 size_t omap_gem_mmap_size(struct drm_gem_object *obj);
227 int omap_gem_tiled_stride(struct drm_gem_object *obj, uint32_t orient);
228 
229 struct dma_buf *omap_gem_prime_export(struct drm_device *dev,
230 		struct drm_gem_object *obj, int flags);
231 struct drm_gem_object *omap_gem_prime_import(struct drm_device *dev,
232 		struct dma_buf *buffer);
233 
234 /* map crtc to vblank mask */
235 uint32_t pipe2vbl(struct drm_crtc *crtc);
236 struct omap_dss_device *omap_encoder_get_dssdev(struct drm_encoder *encoder);
237 
238 /* should these be made into common util helpers?
239  */
240 
241 static inline int objects_lookup(
242 		struct drm_file *filp, uint32_t pixel_format,
243 		struct drm_gem_object **bos, const uint32_t *handles)
244 {
245 	int i, n = drm_format_num_planes(pixel_format);
246 
247 	for (i = 0; i < n; i++) {
248 		bos[i] = drm_gem_object_lookup(filp, handles[i]);
249 		if (!bos[i])
250 			goto fail;
251 
252 	}
253 
254 	return 0;
255 
256 fail:
257 	while (--i > 0)
258 		drm_gem_object_unreference_unlocked(bos[i]);
259 
260 	return -ENOENT;
261 }
262 
263 #endif /* __OMAP_DRV_H__ */
264