Staging: hv: update the TODO file
[safe/jmp/linux-2.6] / drivers / staging / hv / osd.h
1 /*
2  *
3  * Copyright (c) 2009, Microsoft Corporation.
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms and conditions of the GNU General Public License,
7  * version 2, as published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
12  * more details.
13  *
14  * You should have received a copy of the GNU General Public License along with
15  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16  * Place - Suite 330, Boston, MA 02111-1307 USA.
17  *
18  * Authors:
19  *   Haiyang Zhang <haiyangz@microsoft.com>
20  *   Hank Janssen  <hjanssen@microsoft.com>
21  *
22  */
23
24
25 #ifndef _OSD_H_
26 #define _OSD_H_
27
28
29 /* Defines */
30 #define ALIGN_UP(value, align)  (((value) & (align-1)) ?                \
31                                  (((value) + (align-1)) & ~(align-1)) : \
32                                  (value))
33 #define ALIGN_DOWN(value, align)        ((value) & ~(align-1))
34 #define NUM_PAGES_SPANNED(addr, len)    ((ALIGN_UP(addr+len, PAGE_SIZE) - \
35                                          ALIGN_DOWN(addr, PAGE_SIZE)) >>  \
36                                          PAGE_SHIFT)
37
38 #define LOWORD(dw)      ((unsigned short)(dw))
39 #define HIWORD(dw)      ((unsigned short)(((unsigned int) (dw) >> 16) & 0xFFFF))
40
41 struct hv_guid {
42         unsigned char data[16];
43 };
44
45 struct osd_waitevent {
46         int condition;
47         wait_queue_head_t event;
48 };
49
50 /* Osd routines */
51
52 extern void *osd_VirtualAllocExec(unsigned int size);
53
54 extern void *osd_PageAlloc(unsigned int count);
55 extern void osd_PageFree(void *page, unsigned int count);
56
57 extern struct osd_waitevent *osd_WaitEventCreate(void);
58 extern void osd_WaitEventSet(struct osd_waitevent *waitEvent);
59 extern int osd_WaitEventWait(struct osd_waitevent *waitEvent);
60
61 /* If >0, waitEvent got signaled. If ==0, timeout. If < 0, error */
62 extern int osd_WaitEventWaitEx(struct osd_waitevent *waitEvent,
63                                u32 TimeoutInMs);
64
65 int osd_schedule_callback(struct workqueue_struct *wq,
66                           void (*func)(void *),
67                           void *data);
68
69 #endif /* _OSD_H_ */