drm_drv.h

Go to the documentation of this file.

/*
 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
 * Copyright (c) 2009-2010, Code Aurora Forum.
 * Copyright 2016 Intel Corp.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
 
#ifndef _DRM_DRV_H_
#define _DRM_DRV_H_
 
#include <linux/list.h>
#include <linux/irqreturn.h>
 
/*
 * <linux/capability.h> for capable(), which the drm sources reach through
 * this header without naming it: drm_framebuffer.c:557 and :635 write
 * `capable(CAP_SYS_ADMIN)` and include neither capability.h nor pci.h -- and
 * pci.h is the carrier for the other two consumers, drm_file.c:149 and
 * drm_ioctl.c:152.
 *
 * In mainline the chain is longer and automatic: this header includes
 * <linux/fs.h>, and mainline's fs.h includes <linux/capability.h>. DCL's
 * fs.h is a pinned ABI blob that includes nothing, so the chain has no last
 * link and this header names the source itself. mainline's drm_drv.h does
 * include <linux/fs.h> (for struct file's role in drm_driver), which is why
 * this is the faithful place for it rather than a bolt-on.
 *
 * Leaf: capability.h includes only <stdbool.h>.
 */
#include <linux/capability.h>
 
#include <video/nomodeset.h>
 
#include <drm/drm_device.h>
 
struct dmem_cgroup_region;
struct drm_fb_helper;
struct drm_fb_helper_surface_size;
struct drm_file;
struct drm_gem_object;
struct drm_master;
struct drm_minor;
struct dma_buf;
struct dma_buf_attachment;
struct drm_display_mode;
struct drm_mode_create_dumb;
struct drm_printer;
struct sg_table;
 
enum drm_driver_feature {
    DRIVER_GEM          = BIT(0),
    DRIVER_MODESET          = BIT(1),
    DRIVER_RENDER           = BIT(3),
    DRIVER_ATOMIC           = BIT(4),
    DRIVER_SYNCOBJ                  = BIT(5),
    DRIVER_SYNCOBJ_TIMELINE         = BIT(6),
    DRIVER_COMPUTE_ACCEL            = BIT(7),
    DRIVER_GEM_GPUVA        = BIT(8),
    DRIVER_CURSOR_HOTSPOT           = BIT(9),
 
    /* IMPORTANT: Below are all the legacy flags, add new ones above. */
 
    DRIVER_USE_AGP          = BIT(25),
    DRIVER_LEGACY           = BIT(26),
    DRIVER_PCI_DMA          = BIT(27),
    DRIVER_SG           = BIT(28),
 
    DRIVER_HAVE_DMA         = BIT(29),
    DRIVER_HAVE_IRQ         = BIT(30),
};
 
struct drm_driver {
    int (*load) (struct drm_device *, unsigned long flags);
 
    int (*open) (struct drm_device *, struct drm_file *);
 
    void (*postclose) (struct drm_device *, struct drm_file *);
 
    void (*unload) (struct drm_device *);
 
    void (*release) (struct drm_device *);
 
    void (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
               bool from_open);
    void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv);
 
    void (*debugfs_init)(struct drm_minor *minor);
 
    struct drm_gem_object *(*gem_create_object)(struct drm_device *dev,
                            size_t size);
 
    int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
                uint32_t handle, uint32_t flags, int *prime_fd);
    int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
                int prime_fd, uint32_t *handle);
 
    struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
                struct dma_buf *dma_buf);
    struct drm_gem_object *(*gem_prime_import_sg_table)(
                struct drm_device *dev,
                struct dma_buf_attachment *attach,
                struct sg_table *sgt);
 
    int (*dumb_create)(struct drm_file *file_priv,
               struct drm_device *dev,
               struct drm_mode_create_dumb *args);
    int (*dumb_map_offset)(struct drm_file *file_priv,
                   struct drm_device *dev, uint32_t handle,
                   uint64_t *offset);
 
    int (*fbdev_probe)(struct drm_fb_helper *fbdev_helper,
               struct drm_fb_helper_surface_size *sizes);
 
    void (*show_fdinfo)(struct drm_printer *p, struct drm_file *f);
 
    int major;
    int minor;
    int patchlevel;
    char *name;
    char *desc;
 
    u32 driver_features;
 
    const struct drm_ioctl_desc *ioctls;
    int num_ioctls;
 
    const struct file_operations *fops;
};
 
void *__devm_drm_dev_alloc(struct device *parent,
               const struct drm_driver *driver,
               size_t size, size_t offset);
 
struct dmem_cgroup_region *
drmm_cgroup_register_region(struct drm_device *dev,
                const char *region_name, u64 size);
 
#define devm_drm_dev_alloc(parent, driver, type, member) \
    ((type *) __devm_drm_dev_alloc(parent, driver, sizeof(type), \
                       offsetof(type, member)))
 
struct drm_device *drm_dev_alloc(const struct drm_driver *driver,
                 struct device *parent);
 
void *__drm_dev_alloc(struct device *parent,
              const struct drm_driver *driver,
              size_t size, size_t offset);
 
int drm_dev_register(struct drm_device *dev, unsigned long flags);
void drm_dev_unregister(struct drm_device *dev);
 
void drm_dev_get(struct drm_device *dev);
void drm_dev_put(struct drm_device *dev);
void drm_put_dev(struct drm_device *dev);
bool drm_dev_enter(struct drm_device *dev, int *idx);
void drm_dev_exit(int idx);
void drm_dev_unplug(struct drm_device *dev);
int drm_dev_wedged_event(struct drm_device *dev, unsigned long method,
             struct drm_wedge_task_info *info);
 
static inline bool drm_dev_is_unplugged(struct drm_device *dev)
{
    int idx;
 
    if (drm_dev_enter(dev, &idx)) {
        drm_dev_exit(idx);
        return false;
    }
 
    return true;
}
 
static inline bool drm_core_check_all_features(const struct drm_device *dev,
                           u32 features)
{
    u32 supported = dev->driver->driver_features & dev->driver_features;
 
    return features && (supported & features) == features;
}
 
static inline bool drm_core_check_feature(const struct drm_device *dev,
                      enum drm_driver_feature feature)
{
    return drm_core_check_all_features(dev, feature);
}
 
static inline bool drm_drv_uses_atomic_modeset(struct drm_device *dev)
{
    return drm_core_check_feature(dev, DRIVER_ATOMIC) ||
        (dev->mode_config.funcs && dev->mode_config.funcs->atomic_commit != NULL);
}
 
 
/* TODO: Inline drm_firmware_drivers_only() in all its callers. */
static inline bool drm_firmware_drivers_only(void)
{
    return video_firmware_drivers_only();
}
 
#if defined(CONFIG_DEBUG_FS)
void drm_debugfs_dev_init(struct drm_device *dev);
void drm_debugfs_init_root(void);
void drm_debugfs_remove_root(void);
void drm_debugfs_bridge_params(void);
#else
static inline void drm_debugfs_dev_init(struct drm_device *dev)
{
}
 
static inline void drm_debugfs_init_root(void)
{
}
 
static inline void drm_debugfs_remove_root(void)
{
}
 
static inline void drm_debugfs_bridge_params(void)
{
}
#endif
 
#endif