mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-08-27 11:19:37 +00:00
![Greg Kroah-Hartman](/assets/img/avatar_default.png)
Now that the SPDX tag is in all unisys driver files, that identifies the license in a specific and legally-defined manner. So the extra GPL text wording can be removed as it is no longer needed at all. This is done on a quest to remove the 700+ different ways that files in the kernel describe the GPL license text. And there's unneeded stuff like the address (sometimes incorrect) for the FSF which is never needed. No copyright headers or other non-license-description text was removed. Cc: David Kershner <david.kershner@unisys.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
179 lines
6 KiB
C
179 lines
6 KiB
C
// SPDX-License-Identifier: GPL-2.0+
|
|
/*
|
|
* Copyright (C) 2010 - 2013 UNISYS CORPORATION
|
|
* All rights reserved.
|
|
*/
|
|
|
|
#ifndef __VISORCHANNEL_H__
|
|
#define __VISORCHANNEL_H__
|
|
|
|
#include <linux/types.h>
|
|
#include <linux/uuid.h>
|
|
|
|
#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_<xxx>.
|
|
* @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 chtype;
|
|
u64 partition_handle;
|
|
u64 handle;
|
|
u64 ch_space_offset;
|
|
u32 version_id;
|
|
u32 partition_index;
|
|
guid_t zone_guid;
|
|
u32 cli_str_offset;
|
|
u32 cli_state_boot;
|
|
u32 cmd_state_cli;
|
|
u32 cli_state_os;
|
|
u32 ch_characteristic;
|
|
u32 cmd_state_srv;
|
|
u32 srv_state;
|
|
u8 cli_error_boot;
|
|
u8 cli_error_os;
|
|
u8 filler[1];
|
|
u8 recover_channel;
|
|
} __packed;
|
|
|
|
#define VISOR_CHANNEL_ENABLE_INTS (0x1ULL << 0)
|
|
|
|
/*
|
|
* struct signal_queue_header - Subheader for the Signal Type variation of the
|
|
* Common Channel.
|
|
* @version: SIGNAL_QUEUE_HEADER Version ID.
|
|
* @chtype: Queue type: storage, network.
|
|
* @size: Total size of this queue in bytes.
|
|
* @sig_base_offset: Offset to signal queue area.
|
|
* @features: Flags to modify behavior.
|
|
* @num_sent: Total # of signals placed in this queue.
|
|
* @num_overflows: Total # of inserts failed due to full queue.
|
|
* @signal_size: Total size of a signal for this queue.
|
|
* @max_slots: Max # of slots in queue, 1 slot is always empty.
|
|
* @max_signals: Max # of signals in queue (MaxSignalSlots-1).
|
|
* @head: Queue head signal #.
|
|
* @num_received: Total # of signals removed from this queue.
|
|
* @tail: Queue tail signal.
|
|
* @reserved1: Reserved field.
|
|
* @reserved2: Reserved field.
|
|
* @client_queue:
|
|
* @num_irq_received: Total # of Interrupts received. This is incremented by the
|
|
* ISR in the guest windows driver.
|
|
* @num_empty: Number of times that visor_signal_remove is called and
|
|
* returned Empty Status.
|
|
* @errorflags: Error bits set during SignalReinit to denote trouble with
|
|
* client's fields.
|
|
* @filler: Pad out to 64 byte cacheline.
|
|
*/
|
|
struct signal_queue_header {
|
|
/* 1st cache line */
|
|
u32 version;
|
|
u32 chtype;
|
|
u64 size;
|
|
u64 sig_base_offset;
|
|
u64 features;
|
|
u64 num_sent;
|
|
u64 num_overflows;
|
|
u32 signal_size;
|
|
u32 max_slots;
|
|
u32 max_signals;
|
|
u32 head;
|
|
/* 2nd cache line */
|
|
u64 num_received;
|
|
u32 tail;
|
|
u32 reserved1;
|
|
u64 reserved2;
|
|
u64 client_queue;
|
|
u64 num_irq_received;
|
|
u64 num_empty;
|
|
u32 errorflags;
|
|
u8 filler[12];
|
|
} __packed;
|
|
|
|
/* VISORCHANNEL Guids */
|
|
/* {414815ed-c58c-11da-95a9-00e08161165f} */
|
|
#define VISOR_VHBA_CHANNEL_GUID \
|
|
GUID_INIT(0x414815ed, 0xc58c, 0x11da, \
|
|
0x95, 0xa9, 0x0, 0xe0, 0x81, 0x61, 0x16, 0x5f)
|
|
#define VISOR_VHBA_CHANNEL_GUID_STR \
|
|
"414815ed-c58c-11da-95a9-00e08161165f"
|
|
#endif
|