]> nv-tegra.nvidia Code Review - linux-2.6.git/blobdiff - drivers/char/drm/drm.h
drm: lindent the drm directory.
[linux-2.6.git] / drivers / char / drm / drm.h
index fc6598a81acdd5888fd11893f941e75fa0d13d70..64d6237fdd0baa5ce661472ba12ddd7eddacf304 100644 (file)
@@ -1,7 +1,7 @@
 /**
- * \file drm.h 
+ * \file drm.h
  * Header for the Direct Rendering Manager
- * 
+ *
  * \author Rickard E. (Rik) Faith <faith@valinux.com>
  *
  * \par Acknowledgments:
@@ -33,7 +33,6 @@
  * OTHER DEALINGS IN THE SOFTWARE.
  */
 
-
 #ifndef _DRM_H_
 #define _DRM_H_
 
@@ -56,7 +55,7 @@
 #define ioctl(a,b,c)           xf86ioctl(a,b,c)
 #else
 #include <sys/ioccom.h>
-#endif /* __FreeBSD__ && xf86ioctl */
+#endif                         /* __FreeBSD__ && xf86ioctl */
 #define DRM_IOCTL_NR(n)                ((n) & 0xff)
 #define DRM_IOC_VOID           IOC_VOID
 #define DRM_IOC_READ           IOC_OUT
 #define _DRM_LOCK_IS_CONT(lock)           ((lock) & _DRM_LOCK_CONT)
 #define _DRM_LOCKING_CONTEXT(lock) ((lock) & ~(_DRM_LOCK_HELD|_DRM_LOCK_CONT))
 
-
-typedef unsigned int  drm_handle_t;
-typedef unsigned int  drm_context_t;
-typedef unsigned int  drm_drawable_t;
-typedef unsigned int  drm_magic_t;
-
+typedef unsigned int drm_handle_t;
+typedef unsigned int drm_context_t;
+typedef unsigned int drm_drawable_t;
+typedef unsigned int drm_magic_t;
 
 /**
  * Cliprect.
- * 
+ *
  * \warning: If you change this structure, make sure you change
  * XF86DRIClipRectRec in the server as well
  *
@@ -114,22 +111,21 @@ typedef unsigned int  drm_magic_t;
  * backwards-compatibility reasons.
  */
 typedef struct drm_clip_rect {
-       unsigned short  x1;
-       unsigned short  y1;
-       unsigned short  x2;
-       unsigned short  y2;
+       unsigned short x1;
+       unsigned short y1;
+       unsigned short x2;
+       unsigned short y2;
 } drm_clip_rect_t;
 
-
 /**
  * Texture region,
  */
 typedef struct drm_tex_region {
-       unsigned char   next;
-       unsigned char   prev;
-       unsigned char   in_use;
-       unsigned char   padding;
-       unsigned int    age;
+       unsigned char next;
+       unsigned char prev;
+       unsigned char in_use;
+       unsigned char padding;
+       unsigned int age;
 } drm_tex_region_t;
 
 /**
@@ -141,28 +137,26 @@ typedef struct drm_tex_region {
  */
 typedef struct drm_hw_lock {
        __volatile__ unsigned int lock;         /**< lock variable */
-       char                      padding[60];  /**< Pad to cache line */
+       char padding[60];                       /**< Pad to cache line */
 } drm_hw_lock_t;
 
-
 /**
  * DRM_IOCTL_VERSION ioctl argument type.
- * 
+ *
  * \sa drmGetVersion().
  */
 typedef struct drm_version {
-       int    version_major;     /**< Major version */
-       int    version_minor;     /**< Minor version */
-       int    version_patchlevel;/**< Patch level */
+       int version_major;        /**< Major version */
+       int version_minor;        /**< Minor version */
+       int version_patchlevel;   /**< Patch level */
        size_t name_len;          /**< Length of name buffer */
-       char   __user *name;      /**< Name of driver */
+       char __user *name;        /**< Name of driver */
        size_t date_len;          /**< Length of date buffer */
-       char   __user *date;      /**< User-space buffer to hold date */
+       char __user *date;        /**< User-space buffer to hold date */
        size_t desc_len;          /**< Length of desc buffer */
-       char   __user *desc;      /**< User-space buffer to hold desc */
+       char __user *desc;        /**< User-space buffer to hold desc */
 } drm_version_t;
 
-
 /**
  * DRM_IOCTL_GET_UNIQUE ioctl argument type.
  *
@@ -170,21 +164,18 @@ typedef struct drm_version {
  */
 typedef struct drm_unique {
        size_t unique_len;        /**< Length of unique */
-       char   __user *unique;    /**< Unique name for driver instantiation */
+       char __user *unique;      /**< Unique name for driver instantiation */
 } drm_unique_t;
 
-
 typedef struct drm_list {
-       int              count;   /**< Length of user-space structures */
-       drm_version_t    __user *version;
+       int count;                /**< Length of user-space structures */
+       drm_version_t __user *version;
 } drm_list_t;
 
-
 typedef struct drm_block {
-       int              unused;
+       int unused;
 } drm_block_t;
 
-
 /**
  * DRM_IOCTL_CONTROL ioctl argument type.
  *
@@ -196,44 +187,40 @@ typedef struct drm_control {
                DRM_RM_COMMAND,
                DRM_INST_HANDLER,
                DRM_UNINST_HANDLER
-       }                func;
-       int              irq;
+       } func;
+       int irq;
 } drm_control_t;
 
-
 /**
  * Type of memory to map.
  */
 typedef enum drm_map_type {
-       _DRM_FRAME_BUFFER   = 0,  /**< WC (no caching), no core dump */
-       _DRM_REGISTERS      = 1,  /**< no caching, no core dump */
-       _DRM_SHM            = 2,  /**< shared, cached */
-       _DRM_AGP            = 3,  /**< AGP/GART */
+       _DRM_FRAME_BUFFER = 0,    /**< WC (no caching), no core dump */
+       _DRM_REGISTERS = 1,       /**< no caching, no core dump */
+       _DRM_SHM = 2,             /**< shared, cached */
+       _DRM_AGP = 3,             /**< AGP/GART */
        _DRM_SCATTER_GATHER = 4,  /**< Scatter/gather memory for PCI DMA */
-       _DRM_CONSISTENT     = 5,  /**< Consistent memory for PCI DMA */
+       _DRM_CONSISTENT = 5,      /**< Consistent memory for PCI DMA */
 } drm_map_type_t;
 
-
 /**
  * Memory mapping flags.
  */
 typedef enum drm_map_flags {
-       _DRM_RESTRICTED      = 0x01, /**< Cannot be mapped to user-virtual */
-       _DRM_READ_ONLY       = 0x02,
-       _DRM_LOCKED          = 0x04, /**< shared, cached, locked */
-       _DRM_KERNEL          = 0x08, /**< kernel requires access */
+       _DRM_RESTRICTED = 0x01,      /**< Cannot be mapped to user-virtual */
+       _DRM_READ_ONLY = 0x02,
+       _DRM_LOCKED = 0x04,          /**< shared, cached, locked */
+       _DRM_KERNEL = 0x08,          /**< kernel requires access */
        _DRM_WRITE_COMBINING = 0x10, /**< use write-combining if available */
-       _DRM_CONTAINS_LOCK   = 0x20, /**< SHM page that contains lock */
-       _DRM_REMOVABLE       = 0x40  /**< Removable mapping */
+       _DRM_CONTAINS_LOCK = 0x20,   /**< SHM page that contains lock */
+       _DRM_REMOVABLE = 0x40        /**< Removable mapping */
 } drm_map_flags_t;
 
-
 typedef struct drm_ctx_priv_map {
-       unsigned int    ctx_id;  /**< Context requesting private mapping */
-       void            *handle; /**< Handle of map */
+       unsigned int ctx_id;     /**< Context requesting private mapping */
+       void *handle;            /**< Handle of map */
 } drm_ctx_priv_map_t;
 
-
 /**
  * DRM_IOCTL_GET_MAP, DRM_IOCTL_ADD_MAP and DRM_IOCTL_RM_MAP ioctls
  * argument type.
@@ -241,30 +228,28 @@ typedef struct drm_ctx_priv_map {
  * \sa drmAddMap().
  */
 typedef struct drm_map {
-       unsigned long   offset;  /**< Requested physical address (0 for SAREA)*/
-       unsigned long   size;    /**< Requested physical size (bytes) */
-       drm_map_type_t  type;    /**< Type of memory to map */
+       unsigned long offset;    /**< Requested physical address (0 for SAREA)*/
+       unsigned long size;      /**< Requested physical size (bytes) */
+       drm_map_type_t type;     /**< Type of memory to map */
        drm_map_flags_t flags;   /**< Flags */
-       void            *handle; /**< User-space: "Handle" to pass to mmap() */
+       void *handle;            /**< User-space: "Handle" to pass to mmap() */
                                 /**< Kernel-space: kernel-virtual address */
-       int             mtrr;    /**< MTRR slot used */
-                                /*   Private data */
+       int mtrr;                /**< MTRR slot used */
+       /*   Private data */
 } drm_map_t;
 
-
 /**
  * DRM_IOCTL_GET_CLIENT ioctl argument type.
  */
 typedef struct drm_client {
-       int             idx;    /**< Which client desired? */
-       int             auth;   /**< Is client authenticated? */
-       unsigned long   pid;    /**< Process ID */
-       unsigned long   uid;    /**< User ID */
-       unsigned long   magic;  /**< Magic */
-       unsigned long   iocs;   /**< Ioctl count */
+       int idx;                /**< Which client desired? */
+       int auth;               /**< Is client authenticated? */
+       unsigned long pid;      /**< Process ID */
+       unsigned long uid;      /**< User ID */
+       unsigned long magic;    /**< Magic */
+       unsigned long iocs;     /**< Ioctl count */
 } drm_client_t;
 
-
 typedef enum {
        _DRM_STAT_LOCK,
        _DRM_STAT_OPENS,
@@ -282,63 +267,58 @@ typedef enum {
        _DRM_STAT_DMA,          /**< DMA */
        _DRM_STAT_SPECIAL,      /**< Special DMA (e.g., priority or polled) */
        _DRM_STAT_MISSED        /**< Missed DMA opportunity */
-
-                               /* Add to the *END* of the list */
+           /* Add to the *END* of the list */
 } drm_stat_type_t;
 
-
 /**
  * DRM_IOCTL_GET_STATS ioctl argument type.
  */
 typedef struct drm_stats {
        unsigned long count;
        struct {
-               unsigned long   value;
+               unsigned long value;
                drm_stat_type_t type;
        } data[15];
 } drm_stats_t;
 
-
 /**
  * Hardware locking flags.
  */
 typedef enum drm_lock_flags {
-       _DRM_LOCK_READY      = 0x01, /**< Wait until hardware is ready for DMA */
-       _DRM_LOCK_QUIESCENT  = 0x02, /**< Wait until hardware quiescent */
-       _DRM_LOCK_FLUSH      = 0x04, /**< Flush this context's DMA queue first */
-       _DRM_LOCK_FLUSH_ALL  = 0x08, /**< Flush all DMA queues first */
-                               /* These *HALT* flags aren't supported yet
-                                  -- they will be used to support the
-                                  full-screen DGA-like mode. */
+       _DRM_LOCK_READY = 0x01,      /**< Wait until hardware is ready for DMA */
+       _DRM_LOCK_QUIESCENT = 0x02,  /**< Wait until hardware quiescent */
+       _DRM_LOCK_FLUSH = 0x04,      /**< Flush this context's DMA queue first */
+       _DRM_LOCK_FLUSH_ALL = 0x08,  /**< Flush all DMA queues first */
+       /* These *HALT* flags aren't supported yet
+          -- they will be used to support the
+          full-screen DGA-like mode. */
        _DRM_HALT_ALL_QUEUES = 0x10, /**< Halt all current and future queues */
        _DRM_HALT_CUR_QUEUES = 0x20  /**< Halt all current queues */
 } drm_lock_flags_t;
 
-
 /**
  * DRM_IOCTL_LOCK, DRM_IOCTL_UNLOCK and DRM_IOCTL_FINISH ioctl argument type.
- * 
+ *
  * \sa drmGetLock() and drmUnlock().
  */
 typedef struct drm_lock {
-       int              context;
+       int context;
        drm_lock_flags_t flags;
 } drm_lock_t;
 
-
 /**
  * DMA flags
  *
- * \warning 
+ * \warning
  * These values \e must match xf86drm.h.
  *
  * \sa drm_dma.
  */
-typedef enum drm_dma_flags {         
-                                     /* Flags for DMA buffer dispatch */
-       _DRM_DMA_BLOCK        = 0x01, /**<
+typedef enum drm_dma_flags {
+       /* Flags for DMA buffer dispatch */
+       _DRM_DMA_BLOCK = 0x01,        /**<
                                       * Block until buffer dispatched.
-                                      * 
+                                      *
                                       * \note The buffer may not yet have
                                       * been processed by the hardware --
                                       * getting a hardware lock with the
@@ -347,79 +327,73 @@ typedef enum drm_dma_flags {
                                       * processed.
                                       */
        _DRM_DMA_WHILE_LOCKED = 0x02, /**< Dispatch while lock held */
-       _DRM_DMA_PRIORITY     = 0x04, /**< High priority dispatch */
+       _DRM_DMA_PRIORITY = 0x04,     /**< High priority dispatch */
 
-                                     /* Flags for DMA buffer request */
-       _DRM_DMA_WAIT         = 0x10, /**< Wait for free buffers */
-       _DRM_DMA_SMALLER_OK   = 0x20, /**< Smaller-than-requested buffers OK */
-       _DRM_DMA_LARGER_OK    = 0x40  /**< Larger-than-requested buffers OK */
+       /* Flags for DMA buffer request */
+       _DRM_DMA_WAIT = 0x10,         /**< Wait for free buffers */
+       _DRM_DMA_SMALLER_OK = 0x20,   /**< Smaller-than-requested buffers OK */
+       _DRM_DMA_LARGER_OK = 0x40     /**< Larger-than-requested buffers OK */
 } drm_dma_flags_t;
 
-
 /**
  * DRM_IOCTL_ADD_BUFS and DRM_IOCTL_MARK_BUFS ioctl argument type.
  *
  * \sa drmAddBufs().
  */
 typedef struct drm_buf_desc {
-       int           count;     /**< Number of buffers of this size */
-       int           size;      /**< Size in bytes */
-       int           low_mark;  /**< Low water mark */
-       int           high_mark; /**< High water mark */
+       int count;               /**< Number of buffers of this size */
+       int size;                /**< Size in bytes */
+       int low_mark;            /**< Low water mark */
+       int high_mark;           /**< High water mark */
        enum {
-               _DRM_PAGE_ALIGN = 0x01, /**< Align on page boundaries for DMA */
-               _DRM_AGP_BUFFER = 0x02, /**< Buffer is in AGP space */
-               _DRM_SG_BUFFER  = 0x04, /**< Scatter/gather memory buffer */
-               _DRM_FB_BUFFER  = 0x08  /**< Buffer is in frame buffer */
-       }             flags;
-       unsigned long agp_start; /**< 
+               _DRM_PAGE_ALIGN = 0x01, /**< Align on page boundaries for DMA */
+               _DRM_AGP_BUFFER = 0x02, /**< Buffer is in AGP space */
+               _DRM_SG_BUFFER = 0x04,  /**< Scatter/gather memory buffer */
+               _DRM_FB_BUFFER = 0x08   /**< Buffer is in frame buffer */
+       } flags;
+       unsigned long agp_start; /**<
                                  * Start address of where the AGP buffers are
                                  * in the AGP aperture
                                  */
 } drm_buf_desc_t;
 
-
 /**
  * DRM_IOCTL_INFO_BUFS ioctl argument type.
  */
 typedef struct drm_buf_info {
-       int            count;   /**< Entries in list */
+       int count;              /**< Entries in list */
        drm_buf_desc_t __user *list;
 } drm_buf_info_t;
 
-
 /**
  * DRM_IOCTL_FREE_BUFS ioctl argument type.
  */
 typedef struct drm_buf_free {
-       int            count;
-       int            __user *list;
+       int count;
+       int __user *list;
 } drm_buf_free_t;
 
-
 /**
  * Buffer information
  *
  * \sa drm_buf_map.
  */
 typedef struct drm_buf_pub {
-       int               idx;         /**< Index into the master buffer list */
-       int               total;       /**< Buffer size */
-       int               used;        /**< Amount of buffer in use (for DMA) */
-       void      __user *address;     /**< Address of buffer */
+       int idx;                       /**< Index into the master buffer list */
+       int total;                     /**< Buffer size */
+       int used;                      /**< Amount of buffer in use (for DMA) */
+       void __user *address;          /**< Address of buffer */
 } drm_buf_pub_t;
 
-
 /**
  * DRM_IOCTL_MAP_BUFS ioctl argument type.
  */
 typedef struct drm_buf_map {
-       int           count;    /**< Length of the buffer list */
-       void          __user *virtual;  /**< Mmap'd area in user-virtual */
+       int count;              /**< Length of the buffer list */
+       void __user *virtual;           /**< Mmap'd area in user-virtual */
        drm_buf_pub_t __user *list;     /**< Buffer information */
 } drm_buf_map_t;
 
-
 /**
  * DRM_IOCTL_DMA ioctl argument type.
  *
@@ -428,61 +402,55 @@ typedef struct drm_buf_map {
  * \sa drmDMA().
  */
 typedef struct drm_dma {
-       int             context;          /**< Context handle */
-       int             send_count;       /**< Number of buffers to send */
-       int     __user *send_indices;     /**< List of handles to buffers */
-       int     __user *send_sizes;       /**< Lengths of data to send */
+       int context;                      /**< Context handle */
+       int send_count;                   /**< Number of buffers to send */
+       int __user *send_indices;         /**< List of handles to buffers */
+       int __user *send_sizes;           /**< Lengths of data to send */
        drm_dma_flags_t flags;            /**< Flags */
-       int             request_count;    /**< Number of buffers requested */
-       int             request_size;     /**< Desired size for buffers */
-       int     __user *request_indices;  /**< Buffer information */
-       int     __user *request_sizes;
-       int             granted_count;    /**< Number of buffers granted */
+       int request_count;                /**< Number of buffers requested */
+       int request_size;                 /**< Desired size for buffers */
+       int __user *request_indices;      /**< Buffer information */
+       int __user *request_sizes;
+       int granted_count;                /**< Number of buffers granted */
 } drm_dma_t;
 
-
 typedef enum {
        _DRM_CONTEXT_PRESERVED = 0x01,
-       _DRM_CONTEXT_2DONLY    = 0x02
+       _DRM_CONTEXT_2DONLY = 0x02
 } drm_ctx_flags_t;
 
-
 /**
  * DRM_IOCTL_ADD_CTX ioctl argument type.
  *
  * \sa drmCreateContext() and drmDestroyContext().
  */
 typedef struct drm_ctx {
-       drm_context_t   handle;
+       drm_context_t handle;
        drm_ctx_flags_t flags;
 } drm_ctx_t;
 
-
 /**
  * DRM_IOCTL_RES_CTX ioctl argument type.
  */
 typedef struct drm_ctx_res {
-       int             count;
-       drm_ctx_t       __user *contexts;
+       int count;
+       drm_ctx_t __user *contexts;
 } drm_ctx_res_t;
 
-
 /**
  * DRM_IOCTL_ADD_DRAW and DRM_IOCTL_RM_DRAW ioctl argument type.
  */
 typedef struct drm_draw {
-       drm_drawable_t  handle;
+       drm_drawable_t handle;
 } drm_draw_t;
 
-
 /**
  * DRM_IOCTL_GET_MAGIC and DRM_IOCTL_AUTH_MAGIC ioctl argument type.
  */
 typedef struct drm_auth {
-       drm_magic_t     magic;
+       drm_magic_t magic;
 } drm_auth_t;
 
-
 /**
  * DRM_IOCTL_IRQ_BUSID ioctl argument type.
  *
@@ -495,24 +463,20 @@ typedef struct drm_irq_busid {
        int funcnum;    /**< function number */
 } drm_irq_busid_t;
 
-
 typedef enum {
-    _DRM_VBLANK_ABSOLUTE = 0x0,                /**< Wait for specific vblank sequence number */
-    _DRM_VBLANK_RELATIVE = 0x1,                /**< Wait for given number of vblanks */
-    _DRM_VBLANK_SIGNAL   = 0x40000000  /**< Send signal instead of blocking */
+       _DRM_VBLANK_ABSOLUTE = 0x0,     /**< Wait for specific vblank sequence number */
+       _DRM_VBLANK_RELATIVE = 0x1,     /**< Wait for given number of vblanks */
+       _DRM_VBLANK_SIGNAL = 0x40000000 /**< Send signal instead of blocking */
 } drm_vblank_seq_type_t;
 
-
 #define _DRM_VBLANK_FLAGS_MASK _DRM_VBLANK_SIGNAL
 
-
 struct drm_wait_vblank_request {
        drm_vblank_seq_type_t type;
        unsigned int sequence;
        unsigned long signal;
 };
 
-
 struct drm_wait_vblank_reply {
        drm_vblank_seq_type_t type;
        unsigned int sequence;
@@ -520,7 +484,6 @@ struct drm_wait_vblank_reply {
        long tval_usec;
 };
 
-
 /**
  * DRM_IOCTL_WAIT_VBLANK ioctl argument type.
  *
@@ -531,7 +494,6 @@ typedef union drm_wait_vblank {
        struct drm_wait_vblank_reply reply;
 } drm_wait_vblank_t;
 
-
 /**
  * DRM_IOCTL_AGP_ENABLE ioctl argument type.
  *
@@ -541,7 +503,6 @@ typedef struct drm_agp_mode {
        unsigned long mode;     /**< AGP mode */
 } drm_agp_mode_t;
 
-
 /**
  * DRM_IOCTL_AGP_ALLOC and DRM_IOCTL_AGP_FREE ioctls argument type.
  *
@@ -550,22 +511,20 @@ typedef struct drm_agp_mode {
 typedef struct drm_agp_buffer {
        unsigned long size;     /**< In bytes -- will round to page boundary */
        unsigned long handle;   /**< Used for binding / unbinding */
-       unsigned long type;     /**< Type of memory to allocate */
-        unsigned long physical; /**< Physical used by i810 */
+       unsigned long type;     /**< Type of memory to allocate */
+       unsigned long physical; /**< Physical used by i810 */
 } drm_agp_buffer_t;
 
-
 /**
  * DRM_IOCTL_AGP_BIND and DRM_IOCTL_AGP_UNBIND ioctls argument type.
  *
  * \sa drmAgpBind() and drmAgpUnbind().
  */
 typedef struct drm_agp_binding {
-       unsigned long handle;   /**< From drm_agp_buffer */
+       unsigned long handle;   /**< From drm_agp_buffer */
        unsigned long offset;   /**< In bytes -- will round to page boundary */
 } drm_agp_binding_t;
 
-
 /**
  * DRM_IOCTL_AGP_INFO ioctl argument type.
  *
@@ -574,20 +533,19 @@ typedef struct drm_agp_binding {
  * drmAgpVendorId() and drmAgpDeviceId().
  */
 typedef struct drm_agp_info {
-       int            agp_version_major;
-       int            agp_version_minor;
-       unsigned long  mode;
-       unsigned long  aperture_base;  /* physical address */
-       unsigned long  aperture_size;  /* bytes */
-       unsigned long  memory_allowed; /* bytes */
-       unsigned long  memory_used;
-
-                               /* PCI information */
+       int agp_version_major;
+       int agp_version_minor;
+       unsigned long mode;
+       unsigned long aperture_base;    /* physical address */
+       unsigned long aperture_size;    /* bytes */
+       unsigned long memory_allowed;   /* bytes */
+       unsigned long memory_used;
+
+       /* PCI information */
        unsigned short id_vendor;
        unsigned short id_device;
 } drm_agp_info_t;
 
-
 /**
  * DRM_IOCTL_SG_ALLOC ioctl argument type.
  */
@@ -606,7 +564,6 @@ typedef struct drm_set_version {
        int drm_dd_minor;
 } drm_set_version_t;
 
-
 #define DRM_IOCTL_BASE                 'd'
 #define DRM_IO(nr)                     _IO(DRM_IOCTL_BASE,nr)
 #define DRM_IOR(nr,type)               _IOR(DRM_IOCTL_BASE,nr,type)