xref: /freebsd/sys/fs/cuse/cuse_defs.h (revision 71625ec9ad2a9bc8c09784fbd23b759830e0ee5f)
1 /*-
2  * Copyright (c) 2010-2012 Hans Petter Selasky. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  */
25 
26 #ifndef _CUSE_DEFS_H_
27 #define	_CUSE_DEFS_H_
28 
29 #define	CUSE_VERSION		0x000125
30 
31 #define	CUSE_ERR_NONE		0
32 #define	CUSE_ERR_BUSY		-1
33 #define	CUSE_ERR_WOULDBLOCK	-2
34 #define	CUSE_ERR_INVALID	-3
35 #define	CUSE_ERR_NO_MEMORY	-4
36 #define	CUSE_ERR_FAULT		-5
37 #define	CUSE_ERR_SIGNAL		-6
38 #define	CUSE_ERR_OTHER		-7
39 #define	CUSE_ERR_NOT_LOADED	-8
40 #define	CUSE_ERR_NO_DEVICE	-9
41 
42 #define	CUSE_POLL_NONE		0
43 #define	CUSE_POLL_READ		1
44 #define	CUSE_POLL_WRITE		2
45 #define	CUSE_POLL_ERROR		4
46 
47 #define	CUSE_FFLAG_NONE		0
48 #define	CUSE_FFLAG_READ		1
49 #define	CUSE_FFLAG_WRITE	2
50 #define	CUSE_FFLAG_NONBLOCK	4
51 #define	CUSE_FFLAG_COMPAT32	8 /* peer is running in 32-bit compat mode */
52 
53 #define	CUSE_DBG_NONE		0
54 #define	CUSE_DBG_FULL		1
55 
56 /* maximum data transfer length */
57 #define	CUSE_LENGTH_MAX		0x7FFFFFFFU
58 
59 enum {
60 	CUSE_CMD_NONE,
61 	CUSE_CMD_OPEN,
62 	CUSE_CMD_CLOSE,
63 	CUSE_CMD_READ,
64 	CUSE_CMD_WRITE,
65 	CUSE_CMD_IOCTL,
66 	CUSE_CMD_POLL,
67 	CUSE_CMD_SIGNAL,
68 	CUSE_CMD_SYNC,
69 	CUSE_CMD_MAX,
70 };
71 
72 #define	CUSE_MAKE_ID(a,b,c,u) ((((a) & 0x7F) << 24)| \
73     (((b) & 0xFF) << 16)|(((c) & 0xFF) << 8)|((u) & 0xFF))
74 
75 #define	CUSE_ID_MASK 0x7FFFFF00U
76 
77 /*
78  * The following ID's are defined:
79  * ===============================
80  */
81 #define	CUSE_ID_DEFAULT(what) CUSE_MAKE_ID(0,0,what,0)
82 #define	CUSE_ID_WEBCAMD(what) CUSE_MAKE_ID('W','C',what,0)	/* Used by Webcamd. */
83 #define	CUSE_ID_SUNDTEK(what) CUSE_MAKE_ID('S','K',what,0)	/* Used by Sundtek. */
84 #define	CUSE_ID_CX88(what) CUSE_MAKE_ID('C','X',what,0)		/* Used by cx88 driver. */
85 #define	CUSE_ID_UHIDD(what) CUSE_MAKE_ID('U','D',what,0)	/* Used by uhidd. */
86 
87 #endif					/* _CUSE_DEFS_H_ */
88