drivers/staging/omapdrm/omap_drv.h

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