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