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