OrgACRN
/
clear-pkgs-linux-iot-lts2018
mirror of https://github.com/clearlinux-pkgs/linux-iot-lts2018.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
clear-pkgs-linux-iot-lts2018/0514-sos-sync-common-header...

253 lines
7.1 KiB
Diff
Raw Blame History

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Mingqiang Chi <mingqiang.chi@intel.com>
Date: Fri, 31 Aug 2018 10:59:00 +0800
Subject: [PATCH] sos: sync common header file
sync common header file (acrn_common.h)
Change-Id: I5d236b89f0799c788dca652ac0ebeb729e20e40c
Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
Reviewed-on:
---
include/linux/vhm/acrn_common.h | 169 ++++++++++++++++++++++++++------
1 file changed, 138 insertions(+), 31 deletions(-)
diff --git a/include/linux/vhm/acrn_common.h b/include/linux/vhm/acrn_common.h
index d48fe80f6fab..40f3444b7e73 100644
--- a/include/linux/vhm/acrn_common.h
+++ b/include/linux/vhm/acrn_common.h
@@ -74,6 +74,16 @@
#define REQUEST_READ 0
#define REQUEST_WRITE 1
+/* Generic VM flags from guest OS */
+#define SECURE_WORLD_ENABLED (1UL<<0) /* Whether secure world is enabled */
+
+/**
+ * @brief Hypercall
+ *
+ * @addtogroup acrn_hypercall ACRN Hypercall
+ * @{
+ */
+
struct mmio_request {
uint32_t direction;
uint32_t reserved;
@@ -139,66 +149,149 @@ struct vhm_request_buffer {
};
} __attribute__((aligned(4096)));
-/* Common API params */
+/**
+ * @brief Info to create a VM, the parameter for HC_CREATE_VM hypercall
+ */
struct acrn_create_vm {
- int32_t vmid; /* OUT: return vmid to VHM. Keep it first field */
- uint32_t vcpu_num; /* IN: VM vcpu number */
- uint8_t GUID[16]; /* IN: GUID of this vm */
- uint8_t secure_world_enabled;/* IN: whether Secure World is enabled */
- uint8_t reserved[31]; /* Reserved for future use */
+ /** created vmid return to VHM. Keep it first field */
+ int32_t vmid;
+
+ /** VCPU numbers this VM want to create */
+ uint32_t vcpu_num;
+
+ /** the GUID of this VM */
+ uint8_t GUID[16];
+
+ /* VM flag bits from Guest OS, now used
+ * SECURE_WORLD_ENABLED (1UL<<0)
+ */
+ uint64_t vm_flag;
+
+ /** Reserved for future use*/
+ uint8_t reserved[24];
} __attribute__((aligned(8)));
+/**
+ * @brief Info to create a VCPU
+ *
+ * the parameter for HC_CREATE_VCPU hypercall
+ */
struct acrn_create_vcpu {
- uint32_t vcpu_id; /* IN: vcpu id */
- uint32_t pcpu_id; /* IN: pcpu id */
+ /** the virtual CPU ID for the VCPU created */
+ uint32_t vcpu_id;
+
+ /** the physical CPU ID for the VCPU created */
+ uint32_t pcpu_id;
} __attribute__((aligned(8)));
+/**
+ * @brief Info to set ioreq buffer for a created VM
+ *
+ * the parameter for HC_SET_IOREQ_BUFFER hypercall
+ */
struct acrn_set_ioreq_buffer {
- uint64_t req_buf; /* IN: gpa of per VM request_buffer*/
+ /** guest physical address of VM request_buffer */
+ uint64_t req_buf;
} __attribute__((aligned(8)));
-/*
- * intr type
- * IOAPIC: inject interrupt to IOAPIC
- * ISA: inject interrupt to both PIC and IOAPIC
- */
+/** Interrupt type for acrn_irqline: inject interrupt to IOAPIC */
#define ACRN_INTR_TYPE_ISA 0
+
+/** Interrupt type for acrn_irqline: inject interrupt to both PIC and IOAPIC */
#define ACRN_INTR_TYPE_IOAPIC 1
-/* For ISA, PIC, IOAPIC etc */
+/**
+ * @brief Info to assert/deassert/pulse a virtual IRQ line for a VM
+ *
+ * the parameter for HC_ASSERT_IRQLINE/HC_DEASSERT_IRQLINE/HC_PULSE_IRQLINE
+ * hypercall
+ */
struct acrn_irqline {
+ /** interrupt type which could be IOAPIC or ISA */
uint32_t intr_type;
+
+ /** reserved for alignment padding */
uint32_t reserved;
- uint64_t pic_irq; /* IN: for ISA type */
- uint64_t ioapic_irq; /* IN: for IOAPIC type, -1 don't inject */
+
+ /** pic IRQ for ISA type */
+ uint64_t pic_irq;
+
+ /** ioapic IRQ for IOAPIC & ISA TYPE,
+ * if -1 then this IRQ will not be injected
+ */
+ uint64_t ioapic_irq;
} __attribute__((aligned(8)));
-/* For MSI type inject */
+/**
+ * @brief Info to inject a MSI interrupt to VM
+ *
+ * the parameter for HC_INJECT_MSI hypercall
+ */
struct acrn_msi_entry {
- uint64_t msi_addr; /* IN: addr[19:12] with dest vcpu id */
- uint64_t msi_data; /* IN: data[7:0] with vector */
+ /** MSI addr[19:12] with dest VCPU ID */
+ uint64_t msi_addr;
+
+ /** MSI data[7:0] with vector */
+ uint64_t msi_data;
} __attribute__((aligned(8)));
-/* For NMI inject */
+/**
+ * @brief Info to inject a NMI interrupt for a VM
+ */
struct acrn_nmi_entry {
- int64_t vcpuid; /* IN: -1 means vcpu0 */
+ /** virtual CPU ID to inject */
+ int64_t vcpu_id;
} __attribute__((aligned(8)));
+/**
+ * @brief Info to remap pass-through PCI MSI for a VM
+ *
+ * the parameter for HC_VM_PCI_MSIX_REMAP hypercall
+ */
struct acrn_vm_pci_msix_remap {
- uint16_t virt_bdf; /* IN: Device virtual BDF# */
- uint16_t phys_bdf; /* IN: Device physical BDF# */
- uint16_t msi_ctl; /* IN: PCI MSI/x cap control data */
+ /** pass-through PCI device virtual BDF# */
+ uint16_t virt_bdf;
+
+ /** pass-through PCI device physical BDF# */
+ uint16_t phys_bdf;
+
+ /** pass-through PCI device MSI/MSI-X cap control data */
+ uint16_t msi_ctl;
+
+ /** reserved for alignment padding */
uint16_t reserved;
+
+ /** pass-through PCI device MSI address to remap, which will
+ * return the caller after remapping
+ */
uint64_t msi_addr; /* IN/OUT: msi address to fix */
- uint32_t msi_data; /* IN/OUT: msi data to fix */
- int32_t msix; /* IN: 0 - MSI, 1 - MSI-X */
- int32_t msix_entry_index; /* IN: MSI-X the entry table index */
- /* IN: Vector Control for MSI-X Entry, field defined in MSIX spec */
+
+ /** pass-through PCI device MSI data to remap, which will
+ * return the caller after remapping
+ */
+ uint32_t msi_data;
+
+ /** pass-through PCI device is MSI or MSI-X
+ * 0 - MSI, 1 - MSI-X
+ */
+ int32_t msix;
+
+ /** if the pass-through PCI device is MSI-X, this field contains
+ * the MSI-X entry table index
+ */
+ int32_t msix_entry_index;
+
+ /** if the pass-through PCI device is MSI-X, this field contains
+ * Vector Control for MSI-X Entry, field defined in MSI-X spec
+ */
uint32_t vector_ctl;
} __attribute__((aligned(8)));
-/* It's designed to support passing DM config data pointer, based on it,
- * hypervisor would parse then pass DM defined configration to GUEST vcpu
+/**
+ * @brief The guest config pointer offset.
+ *
+ * It's designed to support passing DM config data pointer, based on it,
+ * hypervisor would parse then pass DM defined configuration to GUEST VCPU
* when booting guest VM.
* the address 0xd0000 here is designed by DM, as it arranged all memory
* layout below 1M, DM should make sure there is no overlap for the address
@@ -206,6 +299,10 @@ struct acrn_vm_pci_msix_remap {
*/
#define GUEST_CFG_OFFSET 0xd0000
+/**
+ * @brief Info The power state data of a VCPU.
+ *
+ */
struct cpu_px_data {
uint64_t core_frequency; /* megahertz */
uint64_t power; /* milliWatts */
@@ -215,6 +312,12 @@ struct cpu_px_data {
uint64_t status; /* success indicator */
} __attribute__((aligned(8)));
+/**
+ * @brief Info PM command from DM/VHM.
+ *
+ * The command would specify request type(i.e. get px count or data) for
+ * specific VM and specific VCPU with specific state number.like P(n).
+ */
#define PMCMD_VMID_MASK 0xff000000
#define PMCMD_VCPUID_MASK 0x00ff0000
#define PMCMD_STATE_NUM_MASK 0x0000ff00
@@ -229,4 +332,8 @@ enum pm_cmd_type {
PMCMD_GET_PX_DATA,
};
+/**
+ * @}
+ */
+
#endif /* ACRN_COMMON_H */
--
https://clearlinux.org
Reference in New Issue View Git Blame Copy Permalink