Hyper-V interface. More...

#include <stdint.h>
#include <ipxe/io.h>
#include <bits/hyperv.h>

Data Structures
struct	hv_post_message
	A posted message. More...
struct	hv_message
	A received message. More...
struct	hv_signal_event
	A signalled event. More...
struct	hv_event
	A received event. More...
struct	hv_monitor_trigger
	A monitor trigger group. More...
struct	hv_monitor_parameter
	A monitor parameter set. More...
struct	hv_monitor
	A monitor page. More...
struct	hv_synic
	A synthetic interrupt controller. More...
union	hv_message_buffer
	A message buffer. More...
struct	hv_hypervisor
	A Hyper-V hypervisor. More...

Macros
#define	HV_INTERFACE_ID 0x31237648 /* "Hv#1" */
	Hyper-V interface identification.
#define	HV_GUEST_OS_ID_IPXE ( ( 1ULL << 63 ) \| ( 0x18aeULL << 48 ) )
	Guest OS identity for iPXE.
#define	HV_GUEST_OS_ID_UEFI ( 1ULL << 40 )
	Guest OS identity for Gen 2 UEFI firmware.
#define	HV_HYPERCALL_ENABLE 0x00000001UL
	Enable hypercall page.
#define	HV_SCONTROL_ENABLE 0x00000001UL
	Enable SynIC.
#define	HV_SIEFP_ENABLE 0x00000001UL
	Enable SynIC event flags.
#define	HV_SIMP_ENABLE 0x00000001UL
	Enable SynIC messages.
#define	HV_SINT_AUTO_EOI 0x00020000UL
	Perform implicit EOI upon synthetic interrupt delivery.
#define	HV_SINT_MASKED 0x00010000UL
	Mask synthetic interrupt.
#define	HV_SINT_VECTOR(x)
	Synthetic interrupt vector.
#define	HV_SINT_VECTOR_MASK HV_SINT_VECTOR ( 0xff )
	Synthetic interrupt vector mask.
#define	HV_SINT_MAX 15
	Maximum synthetic interrupt number.
#define	HV_POST_MESSAGE 0x005c
	Post message.
#define	HV_SIGNAL_EVENT 0x005d
	Signal event.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
struct hv_post_message	__attribute__ ((packed))
static unsigned int	hv_pfn_count (physaddr_t data, size_t len)
	Calculate the number of pages covering an address range.
	__attribute__ ((sentinel)) int hv_alloc_pages(struct hv_hypervisor *hv
void	hv_enable_sint (struct hv_hypervisor *hv, unsigned int sintx)
	Enable synthetic interrupt.
void	hv_disable_sint (struct hv_hypervisor *hv, unsigned int sintx)
	Disable synthetic interrupt.
int	hv_post_message (struct hv_hypervisor hv, unsigned int id, unsigned int type, const void data, size_t len)
	Post message.
int	hv_wait_for_message (struct hv_hypervisor *hv, unsigned int sintx)
	Wait for received message.
int	hv_signal_event (struct hv_hypervisor *hv, unsigned int id, unsigned int flag)
	Signal event.

Variables
uint32_t	id
	Connection ID.
uint32_t	reserved
	Padding.
uint32_t	type
	Type.
uint32_t	len
	Length of message.
uint8_t	data [240]
	Message.
uint8_t	flags
	Flags.
uint64_t	origin
	Origin.
uint16_t	flag
	Flag number.
uint32_t	pending
	Pending events.
uint32_t	armed
	Armed events.
uint8_t	reserved_a [4]
	Reserved.
struct hv_monitor_trigger	trigger [4]
	Trigger groups.
uint8_t	reserved_b [536]
	Reserved.
uint16	latency [4][32]
	Latencies.
uint8_t	reserved_c [256]
	Reserved.
struct hv_monitor_parameter	param [4][32]
	Parameters.
uint8_t	reserved_d [1984]
	Reserved.
struct hv_synic	__attribute__

Detailed Description

Hyper-V interface.

Definition in file hyperv.h.

Macro Definition Documentation

◆ HV_INTERFACE_ID

#define HV_INTERFACE_ID 0x31237648 /* "Hv#1" */

Hyper-V interface identification.

Definition at line 16 of file hyperv.h.

Referenced by hv_check_hv(), and hv_timer_probe().

◆ HV_GUEST_OS_ID_IPXE

#define HV_GUEST_OS_ID_IPXE ( ( 1ULL << 63 ) | ( 0x18aeULL << 48 ) )

Guest OS identity for iPXE.

This field comprises:

Bit 63 : set to 1 to indicate an open source OS Bits 62:56 : OS Type Bits 55:48 : OS ID Bits 47:16 : Version Bits 15:0 : Build number

There appears to be no central registry for the "OS Type". The specification states that "Linux is 0x100", and the FreeBSD source states that "FreeBSD is 0x200". Both of these statements are actually referring to the combined "OS Type" and "OS ID" field.

We choose to use 0x98ae: this is generated by setting bit 63 (to indicate an open source OS) and setting the OS Type+ID equal to the PnP vendor ID used in romprefix.S. No version information or build number is included.

Definition at line 38 of file hyperv.h.

Referenced by hv_map_hypercall().

◆ HV_GUEST_OS_ID_UEFI

#define HV_GUEST_OS_ID_UEFI ( 1ULL << 40 )

Guest OS identity for Gen 2 UEFI firmware.

This does not conform to the documented structure for guest OS identities.

Definition at line 45 of file hyperv.h.

Referenced by hv_check_uefi().

◆ HV_HYPERCALL_ENABLE

#define HV_HYPERCALL_ENABLE 0x00000001UL

Enable hypercall page.

Definition at line 48 of file hyperv.h.

Referenced by hv_map_hypercall(), and hv_unmap_hypercall().

◆ HV_SCONTROL_ENABLE

#define HV_SCONTROL_ENABLE 0x00000001UL

Enable SynIC.

Definition at line 51 of file hyperv.h.

Referenced by hv_map_synic(), and hv_unmap_synic().

◆ HV_SIEFP_ENABLE

#define HV_SIEFP_ENABLE 0x00000001UL

Enable SynIC event flags.

Definition at line 54 of file hyperv.h.

Referenced by hv_map_synic(), and hv_unmap_synic_no_scontrol().

◆ HV_SIMP_ENABLE

#define HV_SIMP_ENABLE 0x00000001UL

Enable SynIC messages.

Definition at line 57 of file hyperv.h.

Referenced by hv_map_synic(), hv_unmap_synic_no_scontrol(), and hv_unquiesce().

◆ HV_SINT_AUTO_EOI

#define HV_SINT_AUTO_EOI 0x00020000UL

Perform implicit EOI upon synthetic interrupt delivery.

Definition at line 60 of file hyperv.h.

Referenced by hv_disable_sint(), and hv_enable_sint().

◆ HV_SINT_MASKED

#define HV_SINT_MASKED 0x00010000UL

Mask synthetic interrupt.

Definition at line 63 of file hyperv.h.

Referenced by hv_disable_sint(), and hv_enable_sint().

◆ HV_SINT_VECTOR

#define HV_SINT_VECTOR ( x )

Value:

( (x) << 0 )

x

static unsigned int x

Definition pixbuf.h:63

Synthetic interrupt vector.

Definition at line 66 of file hyperv.h.

Referenced by hv_enable_sint().

◆ HV_SINT_VECTOR_MASK

#define HV_SINT_VECTOR_MASK HV_SINT_VECTOR ( 0xff )

Synthetic interrupt vector mask.

Definition at line 69 of file hyperv.h.

Referenced by hv_enable_sint().

◆ HV_SINT_MAX

#define HV_SINT_MAX 15

Maximum synthetic interrupt number.

Definition at line 72 of file hyperv.h.

Referenced by hv_quiesce().

◆ HV_POST_MESSAGE

#define HV_POST_MESSAGE 0x005c

Post message.

Definition at line 75 of file hyperv.h.

Referenced by hv_post_message().

◆ HV_SIGNAL_EVENT

#define HV_SIGNAL_EVENT 0x005d

Signal event.

Definition at line 116 of file hyperv.h.

Referenced by hv_signal_event().

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ attribute() [1/2]

struct hv_post_message __attribute__ ( (packed) )

◆ hv_pfn_count()

unsigned int hv_pfn_count	(	physaddr_t	data,
		size_t	len )

inlinestatic

Calculate the number of pages covering an address range.

Parameters

data	Start of data
len	Length of data (must be non-zero)

Return values

pfn_count Number of pages covered

Definition at line 223 of file hyperv.h.

                                                                        {
        unsigned int first_pfn = ( data / PAGE_SIZE );
        unsigned int last_pfn = ( ( data + len - 1 ) / PAGE_SIZE );
 
        return ( last_pfn - first_pfn + 1 );
}

References data, len, and PAGE_SIZE.

Referenced by vmbus_establish_gpadl(), and vmbus_send_data().

◆ attribute() [2/2]

__attribute__ ( (sentinel) )

extern

References data, flag, len, and type.

◆ hv_enable_sint()

void hv_enable_sint	(	struct hv_hypervisor *	hv,
		unsigned int	sintx )

extern

Enable synthetic interrupt.

Parameters

hv	Hyper-V hypervisor
sintx	Synthetic interrupt number

Definition at line 397 of file hyperv.c.

                                                                     {
        unsigned long msr = HV_X64_MSR_SINT ( sintx );
        uint64_t sint;
 
        /* Enable synthetic interrupt
         *
         * We have to enable the interrupt, otherwise messages will
         * not be delivered (even though the documentation implies
         * that polling for messages is possible).  We enable AutoEOI
         * and hook the interrupt to the obsolete IRQ13 (FPU
         * exception) vector, which will be implemented as a no-op.
         */
        sint = rdmsr ( msr );
        sint &= ~( HV_SINT_MASKED | HV_SINT_VECTOR_MASK );
        sint |= ( HV_SINT_AUTO_EOI |
                  HV_SINT_VECTOR ( IRQ_INT ( 13 /* See comment above */ ) ) );
        DBGC2 ( hv, "HV %p SINT%d MSR is %#08llx\n", hv, sintx, sint );
        wrmsr ( msr, sint );
}

References DBGC2, HV_SINT_AUTO_EOI, HV_SINT_MASKED, HV_SINT_VECTOR, HV_SINT_VECTOR_MASK, HV_X64_MSR_SINT, and IRQ_INT.

Referenced by vmbus_probe(), and vmbus_reset().

◆ hv_disable_sint()

void hv_disable_sint	(	struct hv_hypervisor *	hv,
		unsigned int	sintx )

extern

Disable synthetic interrupt.

Parameters

hv	Hyper-V hypervisor
sintx	Synthetic interrupt number

Definition at line 423 of file hyperv.c.

                                                                      {
        unsigned long msr = HV_X64_MSR_SINT ( sintx );
        uint64_t sint;
 
        /* Do nothing if interrupt is already disabled */
        sint = rdmsr ( msr );
        if ( sint & HV_SINT_MASKED )
                return;
 
        /* Disable synthetic interrupt */
        sint &= ~HV_SINT_AUTO_EOI;
        sint |= HV_SINT_MASKED;
        DBGC2 ( hv, "HV %p SINT%d MSR is %#08llx\n", hv, sintx, sint );
        wrmsr ( msr, sint );
}

References DBGC2, HV_SINT_AUTO_EOI, HV_SINT_MASKED, and HV_X64_MSR_SINT.

Referenced by hv_quiesce(), vmbus_probe(), and vmbus_remove().

◆ hv_post_message()

int hv_post_message	(	struct hv_hypervisor *	hv,
		unsigned int	id,
		unsigned int	type,
		const void *	data,
		size_t	len )

extern

Post message.

Parameters

hv	Hyper-V hypervisor
id	Connection ID
type	Message type
data	Message
len	Length of message

Return values

rc	Return status code

Definition at line 449 of file hyperv.c.

                                                                        {
        struct hv_post_message *msg = &hv->message->posted;
        int status;
        int rc;
 
        /* Sanity check */
        assert ( len <= sizeof ( msg->data ) );
 
        /* Construct message */
        memset ( msg, 0, sizeof ( *msg ) );
        msg->id = cpu_to_le32 ( id );
        msg->type = cpu_to_le32 ( type );
        msg->len = cpu_to_le32 ( len );
        memcpy ( msg->data, data, len );
        DBGC2 ( hv, "HV %p connection %d posting message type %#08x:\n",
                hv, id, type );
        DBGC2_HDA ( hv, 0, msg->data, len );
 
        /* Post message */
        if ( ( status = hv_call ( hv, HV_POST_MESSAGE, msg, NULL ) ) != 0 ) {
                rc = -EHV ( status );
                DBGC ( hv, "HV %p could not post message to %#08x: %s\n",
                       hv, id, strerror ( rc ) );
                return rc;
        }
 
        return 0;
}

References assert, cpu_to_le32, data, DBGC, DBGC2, DBGC2_HDA, EHV, HV_POST_MESSAGE, len, memcpy(), memset(), hv_hypervisor::message, msg(), NULL, hv_message_buffer::posted, rc, status, strerror(), and type.

◆ hv_wait_for_message()

int hv_wait_for_message	(	struct hv_hypervisor *	hv,
		unsigned int	sintx )

extern

Wait for received message.

Parameters

hv	Hyper-V hypervisor
sintx	Synthetic interrupt number

Return values

rc	Return status code

Definition at line 486 of file hyperv.c.

                                                                         {
        struct hv_message *msg = &hv->message->received;
        struct hv_message *src = &hv->synic.message[sintx];
        unsigned int retries;
        size_t len;
 
        /* Wait for message to arrive */
        for ( retries = 0 ; retries < HV_MESSAGE_MAX_WAIT_MS ; retries++ ) {
 
                /* Check for message */
                if ( src->type ) {
 
                        /* Copy message */
                        memset ( msg, 0, sizeof ( *msg ) );
                        len = src->len;
                        assert ( len <= sizeof ( *msg ) );
                        memcpy ( msg, src,
                                 ( offsetof ( typeof ( *msg ), data ) + len ) );
                        DBGC2 ( hv, "HV %p SINT%d received message type "
                                "%#08x:\n", hv, sintx,
                                le32_to_cpu ( msg->type ) );
                        DBGC2_HDA ( hv, 0, msg->data, len );
 
                        /* Consume message */
                        src->type = 0;
 
                        return 0;
                }
 
                /* Trigger message delivery */
                wrmsr ( HV_X64_MSR_EOM, 0 );
 
                /* Delay */
                mdelay ( 1 );
        }
 
        DBGC ( hv, "HV %p SINT%d timed out waiting for message\n",
               hv, sintx );
        return -ETIMEDOUT;
}

References assert, data, DBGC, DBGC2, DBGC2_HDA, ETIMEDOUT, HV_MESSAGE_MAX_WAIT_MS, HV_X64_MSR_EOM, le32_to_cpu, len, mdelay(), memcpy(), memset(), hv_hypervisor::message, hv_synic::message, msg(), offsetof, hv_message_buffer::received, src, hv_hypervisor::synic, and typeof().

Referenced by vmbus_wait_for_any_message().

◆ hv_signal_event()

int hv_signal_event	(	struct hv_hypervisor *	hv,
		unsigned int	id,
		unsigned int	flag )

extern

Signal event.

Parameters

hv	Hyper-V hypervisor
id	Connection ID
flag	Flag number

Return values

rc	Return status code

Definition at line 535 of file hyperv.c.

                                          {
        struct hv_signal_event *event = &hv->message->signalled;
        int status;
        int rc;
 
        /* Construct event */
        memset ( event, 0, sizeof ( *event ) );
        event->id = cpu_to_le32 ( id );
        event->flag = cpu_to_le16 ( flag );
 
        /* Signal event */
        if ( ( status = hv_call ( hv, HV_SIGNAL_EVENT, event, NULL ) ) != 0 ) {
                rc = -EHV ( status );
                DBGC ( hv, "HV %p could not signal event to %#08x: %s\n",
                       hv, id, strerror ( rc ) );
                return rc;
        }
 
        return 0;
}

References cpu_to_le16, cpu_to_le32, DBGC, EHV, flag, HV_SIGNAL_EVENT, memset(), hv_hypervisor::message, NULL, rc, hv_message_buffer::signalled, status, and strerror().

Variable Documentation

◆ id

uint32_t id

Connection ID.

Definition at line 1 of file hyperv.h.

◆ reserved

uint16_t reserved

Padding.

Reserved.

Definition at line 3 of file hyperv.h.

◆ type

uint32_t type

Type.

Definition at line 5 of file hyperv.h.

◆ len

uint8_t len

Length of message.

Definition at line 7 of file hyperv.h.

◆ data

uint8_t data[240]

Message.

Definition at line 9 of file hyperv.h.

◆ flags

uint32_t flags

Flags.

Event flags.

Definition at line 5 of file hyperv.h.

◆ origin

uint64_t origin

Origin.

Definition at line 9 of file hyperv.h.

Referenced by efi_snp_hii_fetch(), fetch_setting(), fetch_setting_alloc(), fetch_setting_copy(), fetchf_setting(), fetchf_setting_copy(), fetchn_setting(), ibft_fill_nic(), ibft_set_string_setting(), ipv6_create_routes(), and show_exec().

◆ flag

uint16_t flag

Flag number.

Definition at line 3 of file hyperv.h.

◆ pending

uint32_t pending

Pending events.

Definition at line 1 of file hyperv.h.

Referenced by ath5k_hw_stop_tx_dma(), b44_process_rx_packets(), b44_rx_refill(), b44_rx_refill(), efi_get_wakeup_time_wrapper(), is_pending(), pending_get(), pending_put(), pending_rx_index(), pending_tx_index(), and sis190_process_tx().

◆ armed

uint32_t armed

Armed events.

Definition at line 3 of file hyperv.h.

◆ reserved_a

uint8_t reserved_a[4]

Reserved.

Definition at line 3 of file hyperv.h.

◆ trigger

struct hv_monitor_trigger trigger[4]

Trigger groups.

Definition at line 5 of file hyperv.h.

Referenced by vmbus_signal_monitor().

◆ reserved_b

uint8_t reserved_b[536]

Reserved.

Definition at line 7 of file hyperv.h.

◆ latency

uint16 latency[4][32]

Latencies.

Definition at line 9 of file hyperv.h.

◆ reserved_c

uint8_t reserved_c[256]

Reserved.

Definition at line 11 of file hyperv.h.

◆ param

◆ reserved_d

uint8_t reserved_d[1984]

Reserved.

Definition at line 15 of file hyperv.h.

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ HV_INTERFACE_ID

◆ HV_GUEST_OS_ID_IPXE

◆ HV_GUEST_OS_ID_UEFI

◆ HV_HYPERCALL_ENABLE

◆ HV_SCONTROL_ENABLE

◆ HV_SIEFP_ENABLE

◆ HV_SIMP_ENABLE

◆ HV_SINT_AUTO_EOI

◆ HV_SINT_MASKED

◆ HV_SINT_VECTOR

◆ HV_SINT_VECTOR_MASK

◆ HV_SINT_MAX

◆ HV_POST_MESSAGE

◆ HV_SIGNAL_EVENT

Function Documentation

◆ FILE_LICENCE()

◆ __attribute__() [1/2]

◆ hv_pfn_count()

◆ __attribute__() [2/2]

◆ hv_enable_sint()

◆ hv_disable_sint()

◆ hv_post_message()

◆ hv_wait_for_message()

◆ hv_signal_event()

Variable Documentation

◆ id

◆ reserved

◆ type

◆ len

◆ data

◆ flags

◆ origin

◆ flag

◆ pending

◆ armed

◆ reserved_a

◆ trigger

◆ reserved_b

◆ latency

◆ reserved_c

◆ param

◆ reserved_d

◆ attribute() [1/2]

◆ attribute() [2/2]