- Add DRM_GET_PRIV_WITH_RETURN macro. This can be used in shared code to
[platform/upstream/libdrm.git] / linux-core / drm_os_linux.h
1 /**
2  * \file drm_os_linux.h
3  * OS abstraction macros.
4  */
5
6 #define __NO_VERSION__
7
8 #include <linux/interrupt.h>    /* For task queue support */
9 #include <linux/delay.h>
10
11 /** File pointer type */
12 #define DRMFILE                         struct file *
13 /** Ioctl arguments */
14 #define DRM_IOCTL_ARGS                  struct inode *inode, struct file *filp, unsigned int cmd, unsigned long data
15 #define DRM_ERR(d)                      -(d)
16 /** Current process ID */
17 #define DRM_CURRENTPID                  current->pid
18 #define DRM_UDELAY(d)                   udelay(d)
19 /** Read a byte from a MMIO region */
20 #define DRM_READ8(map, offset)          readb(((unsigned long)(map)->handle) + (offset))
21 /** Read a dword from a MMIO region */
22 #define DRM_READ32(map, offset)         readl(((unsigned long)(map)->handle) + (offset))
23 /** Write a byte into a MMIO region */
24 #define DRM_WRITE8(map, offset, val)    writeb(val, ((unsigned long)(map)->handle) + (offset))
25 /** Write a dword into a MMIO region */
26 #define DRM_WRITE32(map, offset, val)   writel(val, ((unsigned long)(map)->handle) + (offset))
27 /** Read memory barrier */
28 #define DRM_READMEMORYBARRIER()         rmb()
29 /** Write memory barrier */
30 #define DRM_WRITEMEMORYBARRIER()        wmb()
31 /** Read/write memory barrier */
32 #define DRM_MEMORYBARRIER()             mb()
33 /** DRM device local declaration */
34 #define DRM_DEVICE      drm_file_t      *priv   = filp->private_data; \
35                         drm_device_t    *dev    = priv->dev
36
37 /** IRQ handler arguments and return type and values */
38 #define DRM_IRQ_ARGS            int irq, void *arg, struct pt_regs *regs
39 /** backwards compatibility with old irq return values */
40 #ifndef IRQ_HANDLED
41 typedef void irqreturn_t;
42 #define IRQ_HANDLED   /* nothing */
43 #define IRQ_NONE      /* nothing */
44 #endif
45
46 /** AGP types */
47 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,5,70)
48 #define DRM_AGP_MEM             agp_memory
49 #define DRM_AGP_KERN            agp_kern_info
50 #else
51 #define DRM_AGP_MEM             struct agp_memory
52 #define DRM_AGP_KERN            struct agp_kern_info
53 #endif
54
55 /** Task queue handler arguments */
56 #define DRM_TASKQUEUE_ARGS      void *arg
57
58 /** For data going into the kernel through the ioctl argument */
59 #define DRM_COPY_FROM_USER_IOCTL(arg1, arg2, arg3)      \
60         if ( copy_from_user(&arg1, arg2, arg3) )        \
61                 return -EFAULT
62 /** For data going from the kernel through the ioctl argument */
63 #define DRM_COPY_TO_USER_IOCTL(arg1, arg2, arg3)        \
64         if ( copy_to_user(arg1, &arg2, arg3) )          \
65                 return -EFAULT
66 /** Other copying of data to kernel space */
67 #define DRM_COPY_FROM_USER(arg1, arg2, arg3)            \
68         copy_from_user(arg1, arg2, arg3)
69 /** Other copying of data from kernel space */
70 #define DRM_COPY_TO_USER(arg1, arg2, arg3)              \
71         copy_to_user(arg1, arg2, arg3)
72 /* Macros for copyfrom user, but checking readability only once */
73 #define DRM_VERIFYAREA_READ( uaddr, size )              \
74         verify_area( VERIFY_READ, uaddr, size )
75 #define DRM_COPY_FROM_USER_UNCHECKED(arg1, arg2, arg3)  \
76         __copy_from_user(arg1, arg2, arg3)
77 #define DRM_GET_USER_UNCHECKED(val, uaddr)              \
78         __get_user(val, uaddr)
79
80
81 /** 'malloc' without the overhead of DRM(alloc)() */
82 #define DRM_MALLOC(x) kmalloc(x, GFP_KERNEL)
83 /** 'free' without the overhead of DRM(free)() */
84 #define DRM_FREE(x,size) kfree(x)
85
86 #define DRM_GET_PRIV_WITH_RETURN(_priv, _filp) _priv = _filp->private_data
87
88 /** 
89  * Get the pointer to the SAREA.
90  *
91  * Searches the SAREA on the mapping lists and points drm_device::sarea to it.
92  */
93 #define DRM_GETSAREA()                                                   \
94 do {                                                                     \
95         drm_map_list_t *entry;                                           \
96         list_for_each_entry( entry, &dev->maplist->head, head ) {        \
97                 if ( entry->map &&                                       \
98                      entry->map->type == _DRM_SHM &&                     \
99                      (entry->map->flags & _DRM_CONTAINS_LOCK) ) {        \
100                         dev_priv->sarea = entry->map;                    \
101                         break;                                           \
102                 }                                                        \
103         }                                                                \
104 } while (0)
105
106 #define DRM_HZ HZ
107
108 #define DRM_WAIT_ON( ret, queue, timeout, condition )           \
109 do {                                                            \
110         DECLARE_WAITQUEUE(entry, current);                      \
111         unsigned long end = jiffies + (timeout);                \
112         add_wait_queue(&(queue), &entry);                       \
113                                                                 \
114         for (;;) {                                              \
115                 current->state = TASK_INTERRUPTIBLE;            \
116                 if (condition)                                  \
117                         break;                                  \
118                 if (time_after_eq(jiffies, end)) {              \
119                         ret = -EBUSY;                           \
120                         break;                                  \
121                 }                                               \
122                 schedule_timeout((HZ/100 > 1) ? HZ/100 : 1);    \
123                 if (signal_pending(current)) {                  \
124                         ret = -EINTR;                           \
125                         break;                                  \
126                 }                                               \
127         }                                                       \
128         current->state = TASK_RUNNING;                          \
129         remove_wait_queue(&(queue), &entry);                    \
130 } while (0)
131
132
133 #define DRM_WAKEUP( queue ) wake_up_interruptible( queue )
134 #define DRM_INIT_WAITQUEUE( queue ) init_waitqueue_head( queue )
135