drm/vboxvideo/vboxvideo.h

1 /* SPDX-License-Identifier: MIT */
2 /* Copyright (C) 2006-2016 Oracle Corporation */
10  * The last 4096 bytes of the guest VRAM contains the generic info for all
18  *   Last 4096 bytes - Adapter information area.
20  *   Slack - what left after dividing the VRAM.
24  * The Virtual Graphics Adapter information in the guest VRAM is stored by the
25  * guest video driver using structures prepended by VBOXVIDEOINFOHDR.
27  * When the guest driver writes dword 0 to the VBE_DISPI_INDEX_VBOX_VIDEO
30  * actual information chain. That way the guest driver can have some
40  * The guest driver writes dword 0xffffffff to the VBE_DISPI_INDEX_VBOX_VIDEO
46  * The guest writes the VBE_DISPI_INDEX_VBOX_VIDEO index register, the
67  * Guest starts writing to the buffer by initializing a record entry in the
69  * written. As data is written to the ring buffer, the guest increases
74  * len_and_flags & ~VBVA_F_RECORD_PARTIAL >= VBVA_RING_BUFFER_SIZE -
80 #define VBVA_RING_BUFFER_SIZE        (4194304 - 1024)
114  * The display number is encoded in low 16 bits.
146 /* guest->host commands */
165 /* G->H DMA command */
170  * Report the guest virtual desktop position and size for mapping host and
171  * guest pointer positions.
174 /* Report the guest cursor position and query the host position. */
177 /* host->guest commands */
181 /* vbva_conf32::index */
190  * Returns VINF_SUCCESS if the host can report guest cursor enabled status via
205 	u32 index;  member
212  * Guest cursor capability: can the host show a hardware cursor at the host
226 	/* Index of the screen, assigned by the guest. */
247  * The virtual monitor has been disabled by the guest and should be removed
252  * The virtual monitor has been blanked by the guest and should be blacked
258  * The virtual monitor has been blanked by the guest and should be blacked
340 	 * Guest driver must create the AND mask for pointers with alpha chan.,
347 	 * bits at the end of any scanline are undefined.
366  * The guest driver can handle asynch guest cmd completion by reading the
370 /* the guest driver can handle video adapter IRQs */
372 /* The guest can read video mode hints sent via VBVA. */
374 /* The guest can switch to a software cursor on demand. */
376 /* The guest does not depend on host handling the VBE registers. */
395  * Structure in which a mode hint is returned. The guest allocates an array
398  * specifies the size of the vbva_modehint structures allocated by the guest,
409 	u32 dx;			/* X offset into the virtual frame-buffer. */
410 	u32 dy;			/* Y offset into the virtual frame-buffer. */
420  * virtual screens and must be re-set.
423 	s32 x;	/* Upper left X co-ordinate relative to the first screen. */
424 	s32 y;	/* Upper left Y co-ordinate relative to the first screen. */
430  * Report the guest cursor position and query the host one. The host may wish
431  * to use the guest information to re-position its own cursor (though this is
436 	u32 x;			/* Guest cursor X position */
437 	u32 y;			/* Guest cursor Y position */