xcache: Add missing licence headers
[archipelago] / xseg / sys / kernel / segdev.h
1 /*
2  * Copyright 2012 GRNET S.A. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or
5  * without modification, are permitted provided that the following
6  * conditions are met:
7  *
8  *   1. Redistributions of source code must retain the above
9  *      copyright notice, this list of conditions and the following
10  *      disclaimer.
11  *   2. Redistributions in binary form must reproduce the above
12  *      copyright notice, this list of conditions and the following
13  *      disclaimer in the documentation and/or other materials
14  *      provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
17  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
20  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  *
29  * The views and conclusions contained in the software and
30  * documentation are those of the authors and should not be
31  * interpreted as representing official policies, either expressed
32  * or implied, of GRNET S.A.
33  */
34
35 /*
36  */
37
38 #ifndef _SEGDEV_H
39 #define _SEGDEV_H
40
41 #define SEGDEV_MAJOR            60
42
43 #ifdef __KERNEL__ 
44
45 #include <linux/fs.h>
46 #include <linux/kernel.h>
47 #include <linux/module.h>
48 #include <linux/cdev.h>
49
50 #define SEGDEV_READY            1
51 #define SEGDEV_RESERVED         2
52 #define SEGDEV_BUFSIZE          512
53
54 struct segdev {
55         int minor;
56         u64 segsize;
57         char *segment;
58         struct cdev cdev;
59         unsigned long flags;
60         void (*callback)(struct segdev *segdev, uint32_t portno);
61         void *priv;
62
63         spinlock_t lock;
64         struct mutex mutex;
65         wait_queue_head_t wq;
66         atomic_t usercount;
67         unsigned int buffer_index;
68         char buffer[SEGDEV_BUFSIZE];
69 };
70
71 int segdev_create_segment(struct segdev *dev, u64 segsize, char reserved);
72 int segdev_destroy_segment(struct segdev *dev);
73 struct segdev *segdev_get(int minor);
74 void segdev_put(struct segdev *dev);
75
76
77 #endif  /* __KERNEL__ */
78
79 #include <linux/ioctl.h>
80
81 #define SEGDEV_IOC_MAGIC        SEGDEV_MAJOR
82 #define SEGDEV_IOC_CREATESEG    _IOR(SEGDEV_IOC_MAGIC, 0, unsigned long)
83 #define SEGDEV_IOC_DESTROYSEG   _IOR(SEGDEV_IOC_MAGIC, 1, unsigned long)
84 #define SEGDEV_IOC_SEGSIZE      _IOR(SEGDEV_IOC_MAGIC, 2, unsigned long)
85
86 #define SEGDEV_IOC_MAXNR        2
87
88 #endif  /* _SEGDEV_H */
89