1 files changed, 205 insertions, 83 deletions

diff --git a/include/drm/drm_device.h b/include/drm/drm_device.h
index 42411b3ea0c8..d5e092dccf3e 100644
--- a/include/drm/drm_device.h
+++ b/include/drm/drm_device.h
@@ -24,25 +24,79 @@ struct inode;
 struct pci_dev;
 struct pci_controller;
 
+
 /**
- * DRM device structure. This structure represent a complete card that
+ * enum drm_switch_power - 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 {
-        struct list_head legacy_dev_list;/**< list of devices per driver for stealth attach cleanup */
-        int if_version;                 /**< Highest interface version set */
-
-        /** \name Lifetime Management */
-        /*@{ */
-        struct kref ref;                /**< Object ref-count */
-        struct device *dev;             /**< Device structure of bus-device */
-        struct drm_driver *driver;      /**< DRM driver managing the device */
-        void *dev_private;              /**< DRM driver private data */
-        struct drm_minor *primary;              /**< Primary node */
-        struct drm_minor *render;               /**< Render node */
+        /**
+         * @legacy_dev_list:
+         *
+         * List of devices per driver for stealth attach cleanup
+         */
+        struct list_head legacy_dev_list;
+
+        /** @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;
+
+        /** @driver: DRM driver managing the device */
+        struct drm_driver *driver;
+
+        /**
+         * @dev_private:
+         *
+         * DRM driver private data. Instead of using this pointer it is
+         * recommended that drivers use drm_dev_init() and embed struct
+         * &drm_device in their larger per-device structure.
+         */
+        void *dev_private;
+
+        /** @primary: Primary node */
+        struct drm_minor *primary;
+
+        /** @render: Render node */
+        struct drm_minor *render;
+
+        /**
+         * @registered:
+         *
+         * Internally used by drm_dev_register() and drm_connector_register().
+         */
         bool registered;
 
-        /* currently active master for this device. Protected by master_mutex */
+        /**
+         * @master:
+         *
+         * Currently active master for this device.
+         * Protected by &master_mutex
+         */
         struct drm_master *master;
 
         /**
@@ -63,76 +117,65 @@ struct drm_device {
          */
         bool unplugged;
 
-        struct inode *anon_inode;               /**< inode for private address-space */
-        char *unique;                           /**< unique name of the device */
-        /*@} */
+        /** @anon_inode: inode for private address-space */
+        struct inode *anon_inode;
+
+        /** @unique: Unique name of the device */
+        char *unique;
 
-        /** \name Locks */
-        /*@{ */
-        struct mutex struct_mutex;      /**< For others */
-        struct mutex master_mutex;      /**< For drm_minor::master and drm_file::is_master */
-        /*@} */
+        /**
+         * @struct_mutex:
+         *
+         * Lock for others (not &drm_minor.master and &drm_file.is_master)
+         */
+        struct mutex struct_mutex;
 
-        /** \name Usage Counters */
-        /*@{ */
-        int open_count;                 /**< Outstanding files open, protected by drm_global_mutex. */
-        spinlock_t buf_lock;            /**< For drm_device::buf_use and a few other things. */
-        int buf_use;                    /**< Buffers in use -- cannot alloc */
-        atomic_t buf_alloc;             /**< Buffer allocation in progress */
-        /*@} */
+        /**
+         * @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
+         */
+        int 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.
+         * List of open DRM files for in-kernel clients.
+         * Protected by &filelist_mutex.
          */
         struct list_head filelist_internal;
 
         /**
          * @clientlist_mutex:
          *
-         * Protects @clientlist access.
+         * Protects &clientlist access.
          */
         struct mutex clientlist_mutex;
 
         /**
          * @clientlist:
          *
-         * List of in-kernel clients. Protected by @clientlist_mutex.
+         * List of in-kernel clients. Protected by &clientlist_mutex.
          */
         struct list_head clientlist;
 
-        /** \name Memory management */
-        /*@{ */
-        struct list_head maplist;       /**< Linked list of regions */
-        struct drm_open_hash map_hash;  /**< User token hash table for maps */
-
-        /** \name Context handle management */
-        /*@{ */
-        struct list_head ctxlist;       /**< Linked list of context handles */
-        struct mutex ctxlist_mutex;     /**< For ctxlist */
-
-        struct idr ctx_idr;
-
-        struct list_head vmalist;       /**< List of vmas (for debugging) */
-
-        /*@} */
-
-        /** \name DMA support */
-        /*@{ */
-        struct drm_device_dma *dma;             /**< Optional pointer for DMA support */
-        /*@} */
-
-        /** \name Context support */
-        /*@{ */
-
-        __volatile__ long context_flag; /**< Context swapping flag */
-        int last_context;               /**< Last current context */
-        /*@} */
-
         /**
          * @irq_enabled:
          *
@@ -141,6 +184,10 @@ struct drm_device {
          * to true manually.
          */
         bool irq_enabled;
+
+        /**
+         * @irq: Used by the drm_irq_install() and drm_irq_unistall() helpers.
+         */
         int irq;
 
         /**
@@ -168,7 +215,16 @@ struct drm_device {
          */
         struct drm_vblank_crtc *vblank;
 
-        spinlock_t vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
+        /**
+         * @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;
 
         /**
@@ -184,45 +240,61 @@ struct drm_device {
          * races and imprecision over longer time periods, hence exposing a
          * hardware vblank counter is always recommended.
          *
-         * If non-zeor, &drm_crtc_funcs.get_vblank_counter must be set.
+         * 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;           /**< size of vblank counter register */
+        u32 max_vblank_count;
+
+        /** @vblank_event_list: List of vblank events */
+        struct list_head vblank_event_list;
 
         /**
-         * List of events
+         * @event_lock:
+         *
+         * Protects @vblank_event_list and event delivery in
+         * general. See drm_send_event() and drm_send_event_locked().
          */
-        struct list_head vblank_event_list;
         spinlock_t event_lock;
 
-        /*@} */
+        /** @agp: AGP data */
+        struct drm_agp_head *agp;
 
-        struct drm_agp_head *agp;       /**< AGP data */
+        /** @pdev: PCI device structure */
+        struct pci_dev *pdev;
 
-        struct pci_dev *pdev;           /**< PCI device structure */
 #ifdef __alpha__
+        /** @hose: PCI hose, only used on ALPHA platforms. */
         struct pci_controller *hose;
 #endif
+        /** @num_crtcs: Number of CRTCs on this device */
+        unsigned int num_crtcs;
 
-        struct drm_sg_mem *sg;  /**< Scatter gather memory */
-        unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
+        /** @mode_config: Current mode config */
+        struct drm_mode_config mode_config;
 
-        struct {
-                int context;
-                struct drm_hw_lock *lock;
-        } sigdata;
-
-        struct drm_local_map *agp_buffer_map;
-        unsigned int agp_buffer_token;
-
-        struct drm_mode_config mode_config;     /**< Current mode config */
-
-        /** \name GEM information */
-        /*@{ */
+        /** @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;
-        /*@} */
-        int switch_power_state;
+
+        /**
+         * @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:
@@ -231,6 +303,56 @@ struct drm_device {
          * Set by drm_fb_helper_init() and cleared by drm_fb_helper_fini().
          */
         struct drm_fb_helper *fb_helper;
+
+        /* Everything below here is for legacy driver, never use! */
+        /* private: */
+
+        /* Context handle management - linked list of context handles */
+        struct list_head ctxlist;
+
+        /* Context handle management - mutex for &ctxlist */
+        struct mutex ctxlist_mutex;
+
+        /* Context handle management */
+        struct idr ctx_idr;
+
+        /* Memory management - linked list of regions */
+        struct list_head maplist;
+
+        /* Memory management - user token hash table for maps */
+        struct drm_open_hash map_hash;
+
+        /* Context handle management - list of vmas (for debugging) */
+        struct list_head vmalist;
+
+        /* Optional pointer for DMA support */
+        struct drm_device_dma *dma;
+
+        /* Context swapping flag */
+        __volatile__ long context_flag;
+
+        /* Last current context */
+        int last_context;
+
+        /* Lock for &buf_use and a few other things. */
+        spinlock_t buf_lock;
+
+        /* Usage counter for buffers in use -- cannot alloc */
+        int buf_use;
+
+        /* Buffer allocation in progress */
+        atomic_t buf_alloc;
+
+        struct {
+                int context;
+                struct drm_hw_lock *lock;
+        } sigdata;
+
+        struct drm_local_map *agp_buffer_map;
+        unsigned int agp_buffer_token;
+
+        /* Scatter gather memory */
+        struct drm_sg_mem *sg;
 };
 
 #endif