vmmouse_proto.h revision 8746cb53 
1/*
2 * Copyright 1999-2006 by VMware, Inc.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
21 *
22 * Except as contained in this notice, the name of the copyright holder(s)
23 * and author(s) shall not be used in advertising or otherwise to promote
24 * the sale, use or other dealings in this Software without prior written
25 * authorization from the copyright holder(s) and author(s).
26 */
27
28/*
29 * vmmouse_proto.h --
30 *
31 *      The communication protocol between the guest and the vmmouse
32 *      virtual device.
33 */
34
35
36#ifndef _VMMOUSE_PROTO_H_
37#define _VMMOUSE_PROTO_H_
38
39#include <stdint.h>
40
41#ifdef HAVE_XORG_SERVER_1_1_0
42#include <unistd.h>
43#else
44#include "xf86_libc.h"
45#endif
46
47/* Map Solaris/Sun compiler #defines to gcc equivalents */
48#if !defined __i386__ && defined __i386
49# define __i386__
50#endif
51
52#if !defined __x86_64__ && defined __amd64
53# define __x86_64__
54#endif
55
56#if !defined __i386__ && !defined __x86_64__
57#error The vmmouse protocol is only supported on x86 architectures.
58#endif
59
60#define VMMOUSE_PROTO_MAGIC 0x564D5868
61#define VMMOUSE_PROTO_PORT 0x5658
62
63#define VMMOUSE_PROTO_CMD_GETVERSION		10
64#define VMMOUSE_PROTO_CMD_ABSPOINTER_DATA	39
65#define VMMOUSE_PROTO_CMD_ABSPOINTER_STATUS	40
66#define VMMOUSE_PROTO_CMD_ABSPOINTER_COMMAND	41
67#define VMMOUSE_PROTO_CMD_ABSPOINTER_RESTRICT   86
68
69#define DECLARE_REG32_STRUCT(_r) \
70   union { \
71      struct { \
72         uint16_t low; \
73         uint16_t high; \
74      } vE##_r##_; \
75      uint32_t vE##_r; \
76   }
77
78#ifdef __x86_64__
79
80#define DECLARE_REG64_STRUCT(_r) \
81   union { \
82      DECLARE_REG32_STRUCT(_r); \
83      struct { \
84         uint32_t low; \
85         uint32_t high; \
86      } vR##_r##_; \
87      uint64_t vR##_r; \
88   }
89
90#define DECLARE_REG_STRUCT(x) DECLARE_REG64_STRUCT(x)
91
92#else
93
94#define DECLARE_REG_STRUCT(x) DECLARE_REG32_STRUCT(x)
95
96#endif
97
98typedef union {
99   struct {
100      union {
101         uint32_t magic;
102         DECLARE_REG_STRUCT(ax);
103      };
104      union {
105         size_t size;
106         DECLARE_REG_STRUCT(bx);
107      };
108      union {
109         uint16_t command;
110         DECLARE_REG_STRUCT(cx);
111      };
112      union {
113         uint16_t port;
114         DECLARE_REG_STRUCT(dx);
115      };
116      DECLARE_REG_STRUCT(si);
117      DECLARE_REG_STRUCT(di);
118   } in;
119   struct {
120      DECLARE_REG_STRUCT(ax);
121      DECLARE_REG_STRUCT(bx);
122      DECLARE_REG_STRUCT(cx);
123      DECLARE_REG_STRUCT(dx);
124      DECLARE_REG_STRUCT(si);
125      DECLARE_REG_STRUCT(di);
126   } out;
127} VMMouseProtoCmd;
128
129
130void
131VMMouseProto_SendCmd(VMMouseProtoCmd *cmd); // IN/OUT
132
133
134#undef DECLARE_REG_STRUCT
135
136#endif /* _VMMOUSE_PROTO_H_ */
137