freebsd-skq/sys/dev/hyperv/utilities/vmbus_icreg.h
sephe 6091327a9b hyperv/timesync: Support "sent TC" to improve accuracy.
MFC after:	1 week
Sponsored by:	Microsoft
Differential Revision:	https://reviews.freebsd.org/D8723
2016-12-08 05:37:39 +00:00

127 lines
4.0 KiB
C

/*-
* Copyright (c) 2016 Microsoft Corp.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice unmodified, this list of conditions, and the following
* disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* $FreeBSD$
*/
#ifndef _VMBUS_ICREG_H_
#define _VMBUS_ICREG_H_
#define VMBUS_ICMSG_TYPE_NEGOTIATE 0
#define VMBUS_ICMSG_TYPE_HEARTBEAT 1
#define VMBUS_ICMSG_TYPE_KVP 2
#define VMBUS_ICMSG_TYPE_SHUTDOWN 3
#define VMBUS_ICMSG_TYPE_TIMESYNC 4
#define VMBUS_ICMSG_TYPE_VSS 5
#define VMBUS_ICMSG_STATUS_OK 0x00000000
#define VMBUS_ICMSG_STATUS_FAIL 0x80004005
#define VMBUS_IC_VERSION(major, minor) ((major) | (((uint32_t)(minor)) << 16))
#define VMBUS_ICVER_MAJOR(ver) ((ver) & 0xffff)
#define VMBUS_ICVER_MINOR(ver) (((ver) & 0xffff0000) >> 16)
#define VMBUS_ICVER_SWAP(ver) \
((VMBUS_ICVER_MAJOR((ver)) << 16) | VMBUS_ICVER_MINOR((ver)))
#define VMBUS_ICVER_LE(v1, v2) \
(VMBUS_ICVER_SWAP((v1)) <= VMBUS_ICVER_SWAP((v2)))
#define VMBUS_ICVER_GT(v1, v2) \
(VMBUS_ICVER_SWAP((v1)) > VMBUS_ICVER_SWAP((v2)))
struct vmbus_pipe_hdr {
uint32_t ph_flags;
uint32_t ph_msgsz;
} __packed;
struct vmbus_icmsg_hdr {
struct vmbus_pipe_hdr ic_pipe;
uint32_t ic_fwver; /* framework version */
uint16_t ic_type;
uint32_t ic_msgver; /* message version */
uint16_t ic_dsize; /* data size */
uint32_t ic_status; /* VMBUS_ICMSG_STATUS_ */
uint8_t ic_xactid;
uint8_t ic_flags; /* VMBUS_ICMSG_FLAG_ */
uint8_t ic_rsvd[2];
} __packed;
#define VMBUS_ICMSG_FLAG_XACT 0x0001
#define VMBUS_ICMSG_FLAG_REQ 0x0002
#define VMBUS_ICMSG_FLAG_RESP 0x0004
/* VMBUS_ICMSG_TYPE_NEGOTIATE */
struct vmbus_icmsg_negotiate {
struct vmbus_icmsg_hdr ic_hdr;
uint16_t ic_fwver_cnt;
uint16_t ic_msgver_cnt;
uint32_t ic_rsvd;
/*
* This version array contains two set of supported
* versions:
* - The first set consists of #ic_fwver_cnt supported framework
* versions.
* - The second set consists of #ic_msgver_cnt supported message
* versions.
*/
uint32_t ic_ver[];
} __packed;
/* VMBUS_ICMSG_TYPE_HEARTBEAT */
struct vmbus_icmsg_heartbeat {
struct vmbus_icmsg_hdr ic_hdr;
uint64_t ic_seq;
uint32_t ic_rsvd[8];
} __packed;
#define VMBUS_ICMSG_HEARTBEAT_SIZE_MIN \
__offsetof(struct vmbus_icmsg_heartbeat, ic_rsvd[0])
/* VMBUS_ICMSG_TYPE_SHUTDOWN */
struct vmbus_icmsg_shutdown {
struct vmbus_icmsg_hdr ic_hdr;
uint32_t ic_code;
uint32_t ic_timeo;
uint32_t ic_haltflags;
uint8_t ic_msg[2048];
} __packed;
#define VMBUS_ICMSG_SHUTDOWN_SIZE_MIN \
__offsetof(struct vmbus_icmsg_shutdown, ic_msg[0])
/* VMBUS_ICMSG_TYPE_TIMESYNC */
struct vmbus_icmsg_timesync {
struct vmbus_icmsg_hdr ic_hdr;
uint64_t ic_hvtime;
uint64_t ic_vmtime;
uint64_t ic_sent_tc;
uint8_t ic_tsflags; /* VMBUS_ICMSG_TS_FLAG_ */
} __packed;
#define VMBUS_ICMSG_TS_FLAG_SYNC 0x01
#define VMBUS_ICMSG_TS_FLAG_SAMPLE 0x02
#define VMBUS_ICMSG_TS_BASE 116444736000000000ULL
#endif /* !_VMBUS_ICREG_H_ */