Quelle  drm_device.h   Sprache: C

#ifndef _DRM_DEVICE_H_
#define _DRM_DEVICE_H_

#include <linux/list.h>
#include <linux/kref.h>
#include <linux/mutex.h>
#include <linux/idr.h>
#include <linux/sched.h>

#include <drm/drm_mode_config.h>

struct drm_driver;
struct drm_minor;
struct drm_master;
struct drm_vblank_crtc;
struct drm_vma_offset_manager;
struct drm_vram_mm;
struct drm_fb_helper;

struct inode;

struct pci_dev;
struct pci_controller;

/*
 * Recovery methods for wedged device in order of less to more side-effects.
 * To be used with drm_dev_wedged_event() as recovery @method. Callers can
 * use any one, multiple (or'd) or none depending on their needs.
 */
#define DRM_WEDGE_RECOVERY_NONE  BIT(0) /* optional telemetry collection */
#define DRM_WEDGE_RECOVERY_REBIND BIT(1) /* unbind + bind driver */
#define DRM_WEDGE_RECOVERY_BUS_RESET BIT(2) /* unbind + reset bus device + bind */

/**
 * struct drm_wedge_task_info - information about the guilty task of a wedge dev
 */
struct drm_wedge_task_info {
 /** @pid: pid of the task */
 pid_t pid;
 /** @comm: command name of the task */
 char comm[TASK_COMM_LEN];
};

/**
 * enum switch_power_state - power state of drm device
 */

enum switch_power_state {
 /** @DRM_SWITCH_POWER_ON: Power state is ON */
 DRM_SWITCH_POWER_ON = 0,

 /** @DRM_SWITCH_POWER_OFF: Power state is OFF */
 DRM_SWITCH_POWER_OFF = 1,

 /** @DRM_SWITCH_POWER_CHANGING: Power state is changing */
 DRM_SWITCH_POWER_CHANGING = 2,

 /** @DRM_SWITCH_POWER_DYNAMIC_OFF: Suspended */
 DRM_SWITCH_POWER_DYNAMIC_OFF = 3,
};

/**
 * struct drm_device - DRM device structure
 *
 * This structure represent a complete card that
 * may contain multiple heads.
 */
struct drm_device {
 /** @if_version: Highest interface version set */
 int if_version;

 /** @ref: Object ref-count */
 struct kref ref;

 /** @dev: Device structure of bus-device */
 struct device *dev;

 /**
  * @dma_dev:
  *
  * Device for DMA operations. Only required if the device @dev
  * cannot perform DMA by itself. Should be NULL otherwise. Call
  * drm_dev_dma_dev() to get the DMA device instead of using this
  * field directly. Call drm_dev_set_dma_dev() to set this field.
  *
  * DRM devices are sometimes bound to virtual devices that cannot
  * perform DMA by themselves. Drivers should set this field to the
  * respective DMA controller.
  *
  * Devices on USB and other peripheral busses also cannot perform
  * DMA by themselves. The @dma_dev field should point the bus
  * controller that does DMA on behalve of such a device. Required
  * for importing buffers via dma-buf.
  *
  * If set, the DRM core automatically releases the reference on the
  * device.
 */
 struct device *dma_dev;

 /**
  * @managed:
  *
  * Managed resources linked to the lifetime of this &drm_device as
  * tracked by @ref.
 */
 struct {
  /** @managed.resources: managed resources list */
  struct list_head resources;
  /** @managed.final_kfree: pointer for final kfree() call */
  void *final_kfree;
  /** @managed.lock: protects @managed.resources */
  spinlock_t lock;
 } managed;

 /** @driver: DRM driver managing the device */
 const struct drm_driver *driver;

 /**
  * @dev_private:
  *
  * DRM driver private data. This is deprecated and should be left set to
  * NULL.
  *
  * Instead of using this pointer it is recommended that drivers use
  * devm_drm_dev_alloc() and embed struct &drm_device in their larger
  * per-device structure.
 */
 void *dev_private;

 /**
  * @primary:
  *
  * Primary node. Drivers should not interact with this
  * directly. debugfs interfaces can be registered with
  * drm_debugfs_add_file(), and sysfs should be directly added on the
  * hardware (and not character device node) struct device @dev.
 */
 struct drm_minor *primary;

 /**
  * @render:
  *
  * Render node. Drivers should not interact with this directly ever.
  * Drivers should not expose any additional interfaces in debugfs or
  * sysfs on this node.
 */
 struct drm_minor *render;

 /** @accel: Compute Acceleration node */
 struct drm_minor *accel;

 /**
  * @registered:
  *
  * Internally used by drm_dev_register() and drm_connector_register().
 */
 bool registered;

 /**
  * @master:
  *
  * Currently active master for this device.
  * Protected by &master_mutex
 */
 struct drm_master *master;

 /**
  * @driver_features: per-device driver features
  *
  * Drivers can clear specific flags here to disallow
  * certain features on a per-device basis while still
  * sharing a single &struct drm_driver instance across
  * all devices.
 */
 u32 driver_features;

 /**
  * @unplugged:
  *
  * Flag to tell if the device has been unplugged.
  * See drm_dev_enter() and drm_dev_is_unplugged().
 */
 bool unplugged;

 /** @anon_inode: inode for private address-space */
 struct inode *anon_inode;

 /** @unique: Unique name of the device */
 char *unique;

 /**
  * @struct_mutex:
  *
  * Lock for others (not &drm_minor.master and &drm_file.is_master)
  *
  * TODO: This lock used to be the BKL of the DRM subsystem. Move the
  *       lock into i915, which is the only remaining user.
 */
 struct mutex struct_mutex;

 /**
  * @master_mutex:
  *
  * Lock for &drm_minor.master and &drm_file.is_master
 */
 struct mutex master_mutex;

 /**
  * @open_count:
  *
  * Usage counter for outstanding files open,
  * protected by drm_global_mutex
 */
 atomic_t open_count;

 /** @filelist_mutex: Protects @filelist. */
 struct mutex filelist_mutex;
 /**
  * @filelist:
  *
  * List of userspace clients, linked through &drm_file.lhead.
 */
 struct list_head filelist;

 /**
  * @filelist_internal:
  *
  * List of open DRM files for in-kernel clients.
  * Protected by &filelist_mutex.
 */
 struct list_head filelist_internal;

 /**
  * @clientlist_mutex:
  *
  * Protects &clientlist access.
 */
 struct mutex clientlist_mutex;

 /**
  * @clientlist:
  *
  * List of in-kernel clients. Protected by &clientlist_mutex.
 */
 struct list_head clientlist;

 /**
  * @vblank_disable_immediate:
  *
  * If true, vblank interrupt will be disabled immediately when the
  * refcount drops to zero, as opposed to via the vblank disable
  * timer.
  *
  * This can be set to true it the hardware has a working vblank counter
  * with high-precision timestamping (otherwise there are races) and the
  * driver uses drm_crtc_vblank_on() and drm_crtc_vblank_off()
  * appropriately. Also, see @max_vblank_count,
  * &drm_crtc_funcs.get_vblank_counter and
  * &drm_vblank_crtc_config.disable_immediate.
 */
 bool vblank_disable_immediate;

 /**
  * @vblank:
  *
  * Array of vblank tracking structures, one per &struct drm_crtc. For
  * historical reasons (vblank support predates kernel modesetting) this
  * is free-standing and not part of &struct drm_crtc itself. It must be
  * initialized explicitly by calling drm_vblank_init().
 */
 struct drm_vblank_crtc *vblank;

 /**
  * @vblank_time_lock:
  *
  *  Protects vblank count and time updates during vblank enable/disable
 */
 spinlock_t vblank_time_lock;
 /**
  * @vbl_lock: Top-level vblank references lock, wraps the low-level
  * @vblank_time_lock.
 */
 spinlock_t vbl_lock;

 /**
  * @max_vblank_count:
  *
  * Maximum value of the vblank registers. This value +1 will result in a
  * wrap-around of the vblank register. It is used by the vblank core to
  * handle wrap-arounds.
  *
  * If set to zero the vblank core will try to guess the elapsed vblanks
  * between times when the vblank interrupt is disabled through
  * high-precision timestamps. That approach is suffering from small
  * races and imprecision over longer time periods, hence exposing a
  * hardware vblank counter is always recommended.
  *
  * This is the statically configured device wide maximum. The driver
  * can instead choose to use a runtime configurable per-crtc value
  * &drm_vblank_crtc.max_vblank_count, in which case @max_vblank_count
  * must be left at zero. See drm_crtc_set_max_vblank_count() on how
  * to use the per-crtc value.
  *
  * If non-zero, &drm_crtc_funcs.get_vblank_counter must be set.
 */
 u32 max_vblank_count;

 /** @vblank_event_list: List of vblank events */
 struct list_head vblank_event_list;

 /**
  * @event_lock:
  *
  * Protects @vblank_event_list and event delivery in
  * general. See drm_send_event() and drm_send_event_locked().
 */
 spinlock_t event_lock;

 /** @num_crtcs: Number of CRTCs on this device */
 unsigned int num_crtcs;

 /** @mode_config: Current mode config */
 struct drm_mode_config mode_config;

 /** @object_name_lock: GEM information */
 struct mutex object_name_lock;

 /** @object_name_idr: GEM information */
 struct idr object_name_idr;

 /** @vma_offset_manager: GEM information */
 struct drm_vma_offset_manager *vma_offset_manager;

 /** @vram_mm: VRAM MM memory manager */
 struct drm_vram_mm *vram_mm;

 /**
  * @switch_power_state:
  *
  * Power state of the client.
  * Used by drivers supporting the switcheroo driver.
  * The state is maintained in the
  * &vga_switcheroo_client_ops.set_gpu_state callback
 */
 enum switch_power_state switch_power_state;

 /**
  * @fb_helper:
  *
  * Pointer to the fbdev emulation structure.
  * Set by drm_fb_helper_init() and cleared by drm_fb_helper_fini().
 */
 struct drm_fb_helper *fb_helper;

 /**
  * @debugfs_root:
  *
  * Root directory for debugfs files.
 */
 struct dentry *debugfs_root;
};

void drm_dev_set_dma_dev(struct drm_device *dev, struct device *dma_dev);

/**
 * drm_dev_dma_dev - returns the DMA device for a DRM device
 * @dev: DRM device
 *
 * Returns the DMA device of the given DRM device. By default, this
 * the DRM device's parent. See drm_dev_set_dma_dev().
 *
 * Returns:
 * A DMA-capable device for the DRM device.
 */
static inline struct device *drm_dev_dma_dev(struct drm_device *dev)
{
 if (dev->dma_dev)
  return dev->dma_dev;
 return dev->dev;
}

#endif