| 1 | /** @file
|
|---|
| 2 | *
|
|---|
| 3 | * VBox Host Guest Shared Memory Interface (HGSMI).
|
|---|
| 4 | * Host/Guest shared part.
|
|---|
| 5 | * Channel identifiers.
|
|---|
| 6 | */
|
|---|
| 7 |
|
|---|
| 8 | /*
|
|---|
| 9 | * Copyright (C) 2006-2017 Oracle Corporation
|
|---|
| 10 | *
|
|---|
| 11 | * Permission is hereby granted, free of charge, to any person obtaining a
|
|---|
| 12 | * copy of this software and associated documentation files (the "Software"),
|
|---|
| 13 | * to deal in the Software without restriction, including without limitation
|
|---|
| 14 | * the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|---|
| 15 | * and/or sell copies of the Software, and to permit persons to whom the
|
|---|
| 16 | * Software is furnished to do so, subject to the following conditions:
|
|---|
| 17 | *
|
|---|
| 18 | * The above copyright notice and this permission notice shall be included in
|
|---|
| 19 | * all copies or substantial portions of the Software.
|
|---|
| 20 | *
|
|---|
| 21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|---|
| 22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|---|
| 23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
|---|
| 24 | * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
|
|---|
| 25 | * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
|
|---|
| 26 | * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|---|
| 27 | * OTHER DEALINGS IN THE SOFTWARE.
|
|---|
| 28 | */
|
|---|
| 29 |
|
|---|
| 30 |
|
|---|
| 31 | #ifndef __HGSMIChannels_h__
|
|---|
| 32 | #define __HGSMIChannels_h__
|
|---|
| 33 |
|
|---|
| 34 |
|
|---|
| 35 | /* Each channel has an 8 bit identifier. There are a number of predefined
|
|---|
| 36 | * (hardcoded) channels.
|
|---|
| 37 | *
|
|---|
| 38 | * HGSMI_CH_HGSMI channel can be used to map a string channel identifier
|
|---|
| 39 | * to a free 16 bit numerical value. values are allocated in range
|
|---|
| 40 | * [HGSMI_CH_STRING_FIRST;HGSMI_CH_STRING_LAST].
|
|---|
| 41 | *
|
|---|
| 42 | */
|
|---|
| 43 |
|
|---|
| 44 |
|
|---|
| 45 | /* Predefined channel identifiers. Used internally by VBOX to simplify the channel setup. */
|
|---|
| 46 | #define HGSMI_CH_RESERVED (0x00) /* A reserved channel value. */
|
|---|
| 47 |
|
|---|
| 48 | #define HGSMI_CH_HGSMI (0x01) /* HGCMI: setup and configuration channel. */
|
|---|
| 49 |
|
|---|
| 50 | #define HGSMI_CH_VBVA (0x02) /* Graphics: VBVA. */
|
|---|
| 51 | #define HGSMI_CH_SEAMLESS (0x03) /* Graphics: Seamless with a single guest region. */
|
|---|
| 52 | #define HGSMI_CH_SEAMLESS2 (0x04) /* Graphics: Seamless with separate host windows. */
|
|---|
| 53 | #define HGSMI_CH_OPENGL (0x05) /* Graphics: OpenGL HW acceleration. */
|
|---|
| 54 |
|
|---|
| 55 |
|
|---|
| 56 | /* Dynamically allocated channel identifiers. */
|
|---|
| 57 | #define HGSMI_CH_STRING_FIRST (0x20) /* The first channel index to be used for string mappings (inclusive). */
|
|---|
| 58 | #define HGSMI_CH_STRING_LAST (0xff) /* The last channel index for string mappings (inclusive). */
|
|---|
| 59 |
|
|---|
| 60 |
|
|---|
| 61 | /* Check whether the channel identifier is allocated for a dynamic channel. */
|
|---|
| 62 | #define HGSMI_IS_DYNAMIC_CHANNEL(_channel) (((uint8_t)(_channel) & 0xE0) != 0)
|
|---|
| 63 |
|
|---|
| 64 |
|
|---|
| 65 | #endif /* !__HGSMIChannels_h__*/
|
|---|
