1.38 Ɉàä „›ÞÀæ0íÉ// SPDX-License-Identifier: GPL-2.0+ /* * Copyright (C) 2010 - 2013 UNISYS CORPORATION * All rights reserved. */ /* * This header file is to be included by other kernel mode components that * implement a particular kind of visor_device. Each of these other kernel * mode components is called a visor device driver. Refer to visortemplate * for a minimal sample visor device driver. * * There should be nothing in this file that is private to the visorbus * bus implementation itself. */ #ifndef __VISORBUS_H__ #define __VISORBUS_H__ #include #define VISOR_CHANNEL_SIGNATURE ('L' << 24 | 'N' << 16 | 'C' << 8 | 'E') /* * enum channel_serverstate * @CHANNELSRV_UNINITIALIZED: Channel is in an undefined state. * @CHANNELSRV_READY: Channel has been initialized by server. */ enum channel_serverstate { CHANNELSRV_UNINITIALIZED = 0, CHANNELSRV_READY = 1 }; /* * enum channel_clientstate * @CHANNELCLI_DETACHED: * @CHANNELCLI_DISABLED: Client can see channel but is NOT allowed to use it * unless given TBD* explicit request * (should actually be < DETACHED). * @CHANNELCLI_ATTACHING: Legacy EFI client request for EFI server to attach. * @CHANNELCLI_ATTACHED: Idle, but client may want to use channel any time. * @CHANNELCLI_BUSY: Client either wants to use or is using channel. * @CHANNELCLI_OWNED: "No worries" state - client can access channel * anytime. */ enum channel_clientstate { CHANNELCLI_DETACHED = 0, CHANNELCLI_DISABLED = 1, CHANNELCLI_ATTACHING = 2, CHANNELCLI_ATTACHED = 3, CHANNELCLI_BUSY = 4, CHANNELCLI_OWNED = 5 }; /* * Values for VISOR_CHANNEL_PROTOCOL.Features: This define exists so that * a guest can look at the FeatureFlags in the io channel, and configure the * driver to use interrupts or not based on this setting. All feature bits for * all channels should be defined here. The io channel feature bits are defined * below. */ #define VISOR_DRIVER_ENABLES_INTS (0x1ULL << 1) #define VISOR_CHANNEL_IS_POLLING (0x1ULL << 3) #define VISOR_IOVM_OK_DRIVER_DISABLING_INTS (0x1ULL << 4) #define VISOR_DRIVER_DISABLES_INTS (0x1ULL << 5) #define VISOR_DRIVER_ENHANCED_RCVBUF_CHECKING (0x1ULL << 6) /* * struct channel_header - Common Channel Header * @signature: Signature. * @legacy_state: DEPRECATED - being replaced by. * @header_size: sizeof(struct channel_header). * @size: Total size of this channel in bytes. * @features: Flags to modify behavior. * @chtype: Channel type: data, bus, control, etc.. * @partition_handle: ID of guest partition. * @handle: Device number of this channel in client. * @ch_space_offset: Offset in bytes to channel specific area. * @version_id: Struct channel_header Version ID. * @partition_index: Index of guest partition. * @zone_uuid: Guid of Channel's zone. * @cli_str_offset: Offset from channel header to null-terminated * ClientString (0 if ClientString not present). * @cli_state_boot: CHANNEL_CLIENTSTATE of pre-boot EFI client of this * channel. * @cmd_state_cli: CHANNEL_COMMANDSTATE (overloaded in Windows drivers, see * ServerStateUp, ServerStateDown, etc). * @cli_state_os: CHANNEL_CLIENTSTATE of Guest OS client of this channel. * @ch_characteristic: CHANNEL_CHARACTERISTIC_. * @cmd_state_srv: CHANNEL_COMMANDSTATE (overloaded in Windows drivers, see * ServerStateUp, ServerStateDown, etc). * @srv_state: CHANNEL_SERVERSTATE. * @cli_error_boot: Bits to indicate err states for boot clients, so err * messages can be throttled. * @cli_error_os: Bits to indicate err states for OS clients, so err * messages can be throttled. * @filler: Pad out to 128 byte cacheline. * @recover_channel: Please add all new single-byte values below here. */ struct channel_header { u64 signature; u32 legacy_state; /* SrvState, CliStateBoot, and CliStateOS below */ u32 header_size; u64 size; u64 features; guid_t chty