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: */
 44struct 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 */
 60struct 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 */
 73struct 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 */
 82struct omap_irq_wait;
 83struct omap_irq_wait * omap_irq_wait_init(struct drm_device *dev,
 84		uint32_t irqmask, int count);
 85int omap_irq_wait(struct drm_device *dev, struct omap_irq_wait *wait,
 86		unsigned long timeout);
 87
 88struct 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
131int omap_debugfs_init(struct drm_minor *minor);
132void omap_debugfs_cleanup(struct drm_minor *minor);
133void omap_framebuffer_describe(struct drm_framebuffer *fb, struct seq_file *m);
134void omap_gem_describe(struct drm_gem_object *obj, struct seq_file *m);
135void omap_gem_describe_objects(struct list_head *list, struct seq_file *m);
136#endif
137
138#ifdef CONFIG_PM
139int omap_gem_resume(struct device *dev);
140#endif
141
142int omap_irq_enable_vblank(struct drm_device *dev, int crtc_id);
143void omap_irq_disable_vblank(struct drm_device *dev, int crtc_id);
144irqreturn_t omap_irq_handler(int irq, void *arg);
145void omap_irq_preinstall(struct drm_device *dev);
146int omap_irq_postinstall(struct drm_device *dev);
147void omap_irq_uninstall(struct drm_device *dev);
148void __omap_irq_register(struct drm_device *dev, struct omap_drm_irq *irq);
149void __omap_irq_unregister(struct drm_device *dev, struct omap_drm_irq *irq);
150void omap_irq_register(struct drm_device *dev, struct omap_drm_irq *irq);
151void omap_irq_unregister(struct drm_device *dev, struct omap_drm_irq *irq);
152int omap_drm_irq_uninstall(struct drm_device *dev);
153int omap_drm_irq_install(struct drm_device *dev);
154
155struct drm_fb_helper *omap_fbdev_init(struct drm_device *dev);
156void omap_fbdev_free(struct drm_device *dev);
157
158const struct omap_video_timings *omap_crtc_timings(struct drm_crtc *crtc);
159enum omap_channel omap_crtc_channel(struct drm_crtc *crtc);
160int omap_crtc_apply(struct drm_crtc *crtc,
161		struct omap_drm_apply *apply);
162void omap_crtc_pre_init(void);
163void omap_crtc_pre_uninit(void);
164struct drm_crtc *omap_crtc_init(struct drm_device *dev,
165		struct drm_plane *plane, enum omap_channel channel, int id);
166void omap_crtc_flush(struct drm_crtc *crtc);
167
168struct drm_plane *omap_plane_init(struct drm_device *dev,
169		int plane_id, bool private_plane);
170int omap_plane_dpms(struct drm_plane *plane, int mode);
171int omap_plane_mode_set(struct drm_plane *plane,
172		struct drm_crtc *crtc, struct drm_framebuffer *fb,
173		int crtc_x, int crtc_y,
174		unsigned int crtc_w, unsigned int crtc_h,
175		uint32_t src_x, uint32_t src_y,
176		uint32_t src_w, uint32_t src_h,
177		void (*fxn)(void *), void *arg);
178void omap_plane_install_properties(struct drm_plane *plane,
179		struct drm_mode_object *obj);
180int omap_plane_set_property(struct drm_plane *plane,
181		struct drm_property *property, uint64_t val);
182
183struct drm_encoder *omap_encoder_init(struct drm_device *dev,
184		struct omap_dss_device *dssdev);
185int omap_encoder_set_enabled(struct drm_encoder *encoder, bool enabled);
186int omap_encoder_update(struct drm_encoder *encoder,
187		struct omap_overlay_manager *mgr,
188		struct omap_video_timings *timings);
189
190struct drm_connector *omap_connector_init(struct drm_device *dev,
191		int connector_type, struct omap_dss_device *dssdev,
192		struct drm_encoder *encoder);
193struct drm_encoder *omap_connector_attached_encoder(
194		struct drm_connector *connector);
195void omap_connector_flush(struct drm_connector *connector,
196		int x, int y, int w, int h);
197
198void copy_timings_omap_to_drm(struct drm_display_mode *mode,
199		struct omap_video_timings *timings);
200void copy_timings_drm_to_omap(struct omap_video_timings *timings,
201		struct drm_display_mode *mode);
202
203uint32_t omap_framebuffer_get_formats(uint32_t *pixel_formats,
204		uint32_t max_formats, enum omap_color_mode supported_modes);
205struct drm_framebuffer *omap_framebuffer_create(struct drm_device *dev,
206		struct drm_file *file, struct drm_mode_fb_cmd2 *mode_cmd);
207struct drm_framebuffer *omap_framebuffer_init(struct drm_device *dev,
208		struct drm_mode_fb_cmd2 *mode_cmd, struct drm_gem_object **bos);
209struct drm_gem_object *omap_framebuffer_bo(struct drm_framebuffer *fb, int p);
210int omap_framebuffer_pin(struct drm_framebuffer *fb);
211int omap_framebuffer_unpin(struct drm_framebuffer *fb);
212void omap_framebuffer_update_scanout(struct drm_framebuffer *fb,
213		struct omap_drm_window *win, struct omap_overlay_info *info);
214struct drm_connector *omap_framebuffer_get_next_connector(
215		struct drm_framebuffer *fb, struct drm_connector *from);
216void omap_framebuffer_flush(struct drm_framebuffer *fb,
217		int x, int y, int w, int h);
218
219void omap_gem_init(struct drm_device *dev);
220void omap_gem_deinit(struct drm_device *dev);
221
222struct drm_gem_object *omap_gem_new(struct drm_device *dev,
223		union omap_gem_size gsize, uint32_t flags);
224int omap_gem_new_handle(struct drm_device *dev, struct drm_file *file,
225		union omap_gem_size gsize, uint32_t flags, uint32_t *handle);
226void omap_gem_free_object(struct drm_gem_object *obj);
227void *omap_gem_vaddr(struct drm_gem_object *obj);
228int omap_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
229		uint32_t handle, uint64_t *offset);
230int omap_gem_dumb_create(struct drm_file *file, struct drm_device *dev,
231		struct drm_mode_create_dumb *args);
232int omap_gem_mmap(struct file *filp, struct vm_area_struct *vma);
233int omap_gem_mmap_obj(struct drm_gem_object *obj,
234		struct vm_area_struct *vma);
235int omap_gem_fault(struct vm_area_struct *vma, struct vm_fault *vmf);
236int omap_gem_op_start(struct drm_gem_object *obj, enum omap_gem_op op);
237int omap_gem_op_finish(struct drm_gem_object *obj, enum omap_gem_op op);
238int omap_gem_op_sync(struct drm_gem_object *obj, enum omap_gem_op op);
239int omap_gem_op_async(struct drm_gem_object *obj, enum omap_gem_op op,
240		void (*fxn)(void *arg), void *arg);
241int omap_gem_roll(struct drm_gem_object *obj, uint32_t roll);
242void omap_gem_cpu_sync(struct drm_gem_object *obj, int pgoff);
243void omap_gem_dma_sync(struct drm_gem_object *obj,
244		enum dma_data_direction dir);
245int omap_gem_get_paddr(struct drm_gem_object *obj,
246		dma_addr_t *paddr, bool remap);
247int omap_gem_put_paddr(struct drm_gem_object *obj);
248int omap_gem_get_pages(struct drm_gem_object *obj, struct page ***pages,
249		bool remap);
250int omap_gem_put_pages(struct drm_gem_object *obj);
251uint32_t omap_gem_flags(struct drm_gem_object *obj);
252int omap_gem_rotated_paddr(struct drm_gem_object *obj, uint32_t orient,
253		int x, int y, dma_addr_t *paddr);
254uint64_t omap_gem_mmap_offset(struct drm_gem_object *obj);
255size_t omap_gem_mmap_size(struct drm_gem_object *obj);
256int omap_gem_tiled_size(struct drm_gem_object *obj, uint16_t *w, uint16_t *h);
257int omap_gem_tiled_stride(struct drm_gem_object *obj, uint32_t orient);
258
259struct dma_buf *omap_gem_prime_export(struct drm_device *dev,
260		struct drm_gem_object *obj, int flags);
261struct drm_gem_object *omap_gem_prime_import(struct drm_device *dev,
262		struct dma_buf *buffer);
263
264static inline int align_pitch(int pitch, int width, int bpp)
265{
266	int bytespp = (bpp + 7) / 8;
267	/* in case someone tries to feed us a completely bogus stride: */
268	pitch = max(pitch, width * bytespp);
269	/* PVR needs alignment to 8 pixels.. right now that is the most
270	 * restrictive stride requirement..
271	 */
272	return ALIGN(pitch, 8 * bytespp);
273}
274
275/* map crtc to vblank mask */
276uint32_t pipe2vbl(struct drm_crtc *crtc);
277struct omap_dss_device *omap_encoder_get_dssdev(struct drm_encoder *encoder);
278
279/* should these be made into common util helpers?
280 */
281
282static inline int objects_lookup(struct drm_device *dev,
283		struct drm_file *filp, uint32_t pixel_format,
284		struct drm_gem_object **bos, uint32_t *handles)
285{
286	int i, n = drm_format_num_planes(pixel_format);
287
288	for (i = 0; i < n; i++) {
289		bos[i] = drm_gem_object_lookup(dev, filp, handles[i]);
290		if (!bos[i])
291			goto fail;
292
293	}
294
295	return 0;
296
297fail:
298	while (--i > 0)
299		drm_gem_object_unreference_unlocked(bos[i]);
300
301	return -ENOENT;
302}
303
304#endif /* __OMAP_DRV_H__ */