acrn-hypervisor/hypervisor/include/arch/x86/vm_config.h

/*
 * Copyright (C) 2018 Intel Corporation. All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

#ifndef VM_CONFIG_H_
#define VM_CONFIG_H_

#include <types.h>
#include <pci.h>
#include <boot.h>
#include <board_info.h>
#include <acrn_common.h>
#include <vm_uuids.h>
#include <vm_configurations.h>
#include <sgx.h>
#include <acrn_hv_defs.h>

#define CONFIG_MAX_VM_NUM	(PRE_VM_NUM + SOS_VM_NUM + MAX_POST_VM_NUM)

#define AFFINITY_CPU(n)		(1UL << (n))
#define MAX_VCPUS_PER_VM	MAX_PCPU_NUM
#define MAX_VUART_NUM_PER_VM	2U
#define MAX_VM_OS_NAME_LEN	32U
#define MAX_MOD_TAG_LEN		32U

#ifdef CONFIG_SCHED_NOOP
#define SOS_IDLE		""
#else
#define SOS_IDLE		"idle=halt "
#endif

#define PCI_DEV_TYPE_PTDEV	(1U << 0U)
#define PCI_DEV_TYPE_HVEMUL	(1U << 1U)
#define PCI_DEV_TYPE_SOSEMUL	(1U << 2U)

#define MAX_MMIO_DEV_NUM	2U

#define CONFIG_SOS_VM		.load_order = SOS_VM,	\
				.uuid = SOS_VM_UUID,	\
				.severity = SEVERITY_SOS,	\
				.pci_dev_num = 0U,	\
				.pci_devs = sos_pci_devs

#define CONFIG_SAFETY_VM(idx)	.load_order = PRE_LAUNCHED_VM,	\
				.uuid = SAFETY_VM_UUID##idx,	\
				.severity = SEVERITY_SAFETY_VM

#define CONFIG_PRE_STD_VM(idx)	.load_order = PRE_LAUNCHED_VM,	\
				.uuid = PRE_STANDARD_VM_UUID##idx,	\
				.severity = SEVERITY_STANDARD_VM

#define CONFIG_PRE_RT_VM(idx)	.load_order = PRE_LAUNCHED_VM,	\
				.uuid = PRE_RTVM_UUID##idx,	\
				.severity = SEVERITY_RTVM

#define CONFIG_POST_STD_VM(idx)	.load_order = POST_LAUNCHED_VM,	\
				.uuid = POST_STANDARD_VM_UUID##idx,	\
				.severity = SEVERITY_STANDARD_VM

#define CONFIG_POST_RT_VM(idx)	.load_order = POST_LAUNCHED_VM,	\
				.uuid = POST_RTVM_UUID##idx,	\
				.severity = SEVERITY_RTVM

#define CONFIG_KATA_VM(idx)	.load_order = POST_LAUNCHED_VM,	\
				.uuid = KATA_VM_UUID##idx,	\
				.severity = SEVERITY_STANDARD_VM

/*
 * PRE_LAUNCHED_VM is launched by ACRN hypervisor, with LAPIC_PT;
 * SOS_VM is launched by ACRN hypervisor, without LAPIC_PT;
 * POST_LAUNCHED_VM is launched by ACRN devicemodel, with/without LAPIC_PT depends on usecases.
 *
 * Assumption: vm_configs array is completely initialized w.r.t. load_order member of
 * 		acrn_vm_config for all the VMs.
 */
enum acrn_vm_load_order {
	PRE_LAUNCHED_VM = 0,
	SOS_VM,
	POST_LAUNCHED_VM,	/* Launched by Devicemodel in SOS_VM */
	MAX_LOAD_ORDER
};

/* ACRN guest severity */
enum acrn_vm_severity {
	SEVERITY_SAFETY_VM = 0x40U,
	SEVERITY_RTVM = 0x30U,
	SEVERITY_SOS = 0x20U,
	SEVERITY_STANDARD_VM = 0x10U,
};

struct acrn_vm_mem_config {
	uint64_t start_hpa;	/* the start HPA of VM memory configuration, for pre-launched VMs only */
	uint64_t size;		/* VM memory size configuration */
	uint64_t start_hpa2;	/* Start of second HPA for non-contiguous allocations in VM memory configuration,
				   for pre-launched VMs only */
	uint64_t size_hpa2;	/* Size of second HPA for non-contiguous allocations in VM memory configuration */
};

struct target_vuart {
	uint8_t vm_id;		/* target VM id */
	uint8_t vuart_id;	/* target vuart index in a VM */
};

enum vuart_type {
	VUART_LEGACY_PIO = 0,	/* legacy PIO vuart */
	VUART_PCI,		/* PCI vuart, may removed */
};

union vuart_addr {
	uint16_t port_base;		/* addr for legacy type */
	struct {			/* addr for pci type */
		uint8_t f : 3;		/* BITs 0-2 */
		uint8_t d : 5;		/* BITs 3-7 */
		uint8_t b;		/* BITs 8-15 */
	} bdf;
};

struct vuart_config {
	enum vuart_type type;		/* legacy PIO or PCI  */
	union vuart_addr addr;		/* port addr if in legacy type, or bdf addr if in pci type */
	uint16_t irq;
	struct target_vuart t_vuart;	/* target vuart */
} __aligned(8);

enum os_kernel_type {
	KERNEL_BZIMAGE = 1,
	KERNEL_ZEPHYR,
};

struct acrn_vm_os_config {
	char name[MAX_VM_OS_NAME_LEN];			/* OS name, useful for debug */
	enum os_kernel_type kernel_type;		/* used for kernel specifc loading method */
	char kernel_mod_tag[MAX_MOD_TAG_LEN];		/* multiboot module tag for kernel */
	char ramdisk_mod_tag[MAX_MOD_TAG_LEN];		/* multiboot module tag for ramdisk */
	char bootargs[MAX_BOOTARGS_SIZE];		/* boot args/cmdline */
	uint64_t kernel_load_addr;
	uint64_t kernel_entry_addr;
	uint64_t kernel_ramdisk_addr;
} __aligned(8);

/* the vbdf is assgined by device model */
#define UNASSIGNED_VBDF        0xFFFFU

struct acrn_vm_pci_dev_config {
	uint32_t emu_type;				/* the type how the device is emulated. */
	union pci_bdf vbdf;				/* virtual BDF of PCI device */
	union pci_bdf pbdf;				/* physical BDF of PCI device */
	char shm_region_name[32];			/* TODO: combine pbdf and shm_region_name into a union member */
	uint64_t vbar_base[PCI_BAR_COUNT];		/* vbar base address of PCI device, which is power-on default value */
	struct pci_pdev *pdev;				/* the physical PCI device if it's a PT device */
	const struct pci_vdev_ops *vdev_ops;		/* operations for PCI CFG read/write */
} __aligned(8);

struct acrn_vm_config {
	enum acrn_vm_load_order load_order;		/* specify the load order of VM */
	char name[MAX_VM_OS_NAME_LEN];			/* VM name identifier, useful for debug. */
	const uint8_t uuid[16];				/* UUID of the VM */
	uint8_t reserved[2];				/* Temporarily reserve it so that don't need to update
							 * the users of get_platform_info frequently.
							 */
	uint8_t severity;				/* severity of the VM */
	uint64_t cpu_affinity;				/* The set bits represent the pCPUs the vCPUs of
							 * the VM may run on.
							 */
	uint64_t guest_flags;				/* VM flags that we want to configure for guest
							 * Now we have two flags:
							 *	GUEST_FLAG_SECURE_WORLD_ENABLED
							 *	GUEST_FLAG_LAPIC_PASSTHROUGH
							 * We could add more guest flags in future;
							 */
	struct acrn_vm_mem_config memory;		/* memory configuration of VM */
	struct epc_section epc;				/* EPC memory configuration of VM */
	uint16_t pci_dev_num;				/* indicate how many PCI devices in VM */
	struct acrn_vm_pci_dev_config *pci_devs;	/* point to PCI devices BDF list */
	struct acrn_vm_os_config os_config;		/* OS information the VM */

	/*
	 * below are varaible length members (per build).
	 * SOS can get the vm_configs[] array through hypercall, but SOS may not
	 * need to parse these members.
	 */
	uint16_t clos[MAX_VCPUS_PER_VM];		/* Class of Service, effective only if CONFIG_RDT_ENABLED
							 * is defined on CAT capable platforms
							 */

	struct vuart_config vuart[MAX_VUART_NUM_PER_VM];/* vuart configuration for VM */

	bool pt_tpm2;
	struct acrn_mmiodev mmiodevs[MAX_MMIO_DEV_NUM];
} __aligned(8);

struct acrn_vm_config *get_vm_config(uint16_t vm_id);
uint8_t get_vm_severity(uint16_t vm_id);
bool vm_has_matched_uuid(uint16_t vmid, const uint8_t *uuid);

extern struct acrn_vm_config vm_configs[CONFIG_MAX_VM_NUM];

#endif /* VM_CONFIG_H_ */