| 1 | /* $Id: HGSMIBase.h 106061 2024-09-16 14:03:52Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * VBox Host Guest Shared Memory Interface (HGSMI) - buffer management.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006-2024 Oracle and/or its affiliates.
|
|---|
| 8 | *
|
|---|
| 9 | * Permission is hereby granted, free of charge, to any person
|
|---|
| 10 | * obtaining a copy of this software and associated documentation
|
|---|
| 11 | * files (the "Software"), to deal in the Software without
|
|---|
| 12 | * restriction, including without limitation the rights to use,
|
|---|
| 13 | * copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|---|
| 14 | * copies of the Software, and to permit persons to whom the
|
|---|
| 15 | * Software is furnished to do so, subject to the following
|
|---|
| 16 | * conditions:
|
|---|
| 17 | *
|
|---|
| 18 | * The above copyright notice and this permission notice shall be
|
|---|
| 19 | * included in all copies or substantial portions of the Software.
|
|---|
| 20 | *
|
|---|
| 21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|---|
| 22 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|---|
| 23 | * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|---|
| 24 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|---|
| 25 | * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|---|
| 26 | * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|---|
| 27 | * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|---|
| 28 | * OTHER DEALINGS IN THE SOFTWARE.
|
|---|
| 29 | */
|
|---|
| 30 |
|
|---|
| 31 | #ifndef VBOX_INCLUDED_Graphics_HGSMIBase_h
|
|---|
| 32 | #define VBOX_INCLUDED_Graphics_HGSMIBase_h
|
|---|
| 33 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 34 | # pragma once
|
|---|
| 35 | #endif
|
|---|
| 36 |
|
|---|
| 37 | #include "HGSMI.h"
|
|---|
| 38 | #include "HGSMIContext.h"
|
|---|
| 39 | #include "VBoxVideoIPRT.h"
|
|---|
| 40 |
|
|---|
| 41 | RT_C_DECLS_BEGIN
|
|---|
| 42 |
|
|---|
| 43 | /** @name Base HGSMI Buffer APIs
|
|---|
| 44 | * @{ */
|
|---|
| 45 |
|
|---|
| 46 | /** Acknowlege an IRQ. */
|
|---|
| 47 | DECLINLINE(void) VBoxHGSMIClearIrq(PHGSMIHOSTCOMMANDCONTEXT pCtx)
|
|---|
| 48 | {
|
|---|
| 49 | VBVO_PORT_WRITE_U32(pCtx->port, HGSMIOFFSET_VOID);
|
|---|
| 50 | }
|
|---|
| 51 |
|
|---|
| 52 | DECLHIDDEN(void RT_UNTRUSTED_VOLATILE_HOST *) VBoxHGSMIBufferAlloc(PHGSMIGUESTCOMMANDCONTEXT pCtx, HGSMISIZE cbData,
|
|---|
| 53 | uint8_t u8Ch, uint16_t u16Op);
|
|---|
| 54 | DECLHIDDEN(void) VBoxHGSMIBufferFree(PHGSMIGUESTCOMMANDCONTEXT pCtx, void RT_UNTRUSTED_VOLATILE_HOST *pvBuffer);
|
|---|
| 55 | DECLHIDDEN(int) VBoxHGSMIBufferSubmit(PHGSMIGUESTCOMMANDCONTEXT pCtx, void RT_UNTRUSTED_VOLATILE_HOST *pvBuffer);
|
|---|
| 56 | /** @} */
|
|---|
| 57 |
|
|---|
| 58 | RT_C_DECLS_END
|
|---|
| 59 |
|
|---|
| 60 | #endif /* !VBOX_INCLUDED_Graphics_HGSMIBase_h */
|
|---|
