1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */
2 /**********************************************************
3  * Copyright 2007-2015 VMware, Inc.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without
8  * restriction, including without limitation the rights to use, copy,
9  * modify, merge, publish, distribute, sublicense, and/or sell copies
10  * of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
20  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23  * SOFTWARE.
24  *
25  **********************************************************/
26 
27 /*
28  * svga_escape.h --
29  *
30  *    Definitions for our own (vendor-specific) SVGA Escape commands.
31  */
32 
33 #ifndef _SVGA_ESCAPE_H_
34 #define _SVGA_ESCAPE_H_
35 
36 
37 /*
38  * Namespace IDs for the escape command
39  */
40 
41 #define SVGA_ESCAPE_NSID_VMWARE 0x00000000
42 #define SVGA_ESCAPE_NSID_DEVEL  0xFFFFFFFF
43 
44 
45 /*
46  * Within SVGA_ESCAPE_NSID_VMWARE, we multiplex commands according to
47  * the first DWORD of escape data (after the nsID and size). As a
48  * guideline we're using the high word and low word as a major and
49  * minor command number, respectively.
50  *
51  * Major command number allocation:
52  *
53  *   0000: Reserved
54  *   0001: SVGA_ESCAPE_VMWARE_LOG (svga_binary_logger.h)
55  *   0002: SVGA_ESCAPE_VMWARE_VIDEO (svga_overlay.h)
56  *   0003: SVGA_ESCAPE_VMWARE_HINT (svga_escape.h)
57  */
58 
59 #define SVGA_ESCAPE_VMWARE_MAJOR_MASK  0xFFFF0000
60 
61 
62 /*
63  * SVGA Hint commands.
64  *
65  * These escapes let the SVGA driver provide optional information to
66  * he host about the state of the guest or guest applications. The
67  * host can use these hints to make user interface or performance
68  * decisions.
69  *
70  * Notes:
71  *
72  *   - SVGA_ESCAPE_VMWARE_HINT_FULLSCREEN is deprecated for guests
73  *     that use the SVGA Screen Object extension. Instead of sending
74  *     this escape, use the SVGA_SCREEN_FULLSCREEN_HINT flag on your
75  *     Screen Object.
76  */
77 
78 #define SVGA_ESCAPE_VMWARE_HINT               0x00030000
79 #define SVGA_ESCAPE_VMWARE_HINT_FULLSCREEN    0x00030001  /* Deprecated */
80 
81 typedef
82 struct {
83    uint32 command;
84    uint32 fullscreen;
85    struct {
86       int32 x, y;
87    } monitorPosition;
88 } SVGAEscapeHintFullscreen;
89 
90 #endif /* _SVGA_ESCAPE_H_ */
91