mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-05-09 17:07:00 +00:00
584f6b7255
`@return` is dedicated for brief description of return values, not for comments stating actual return values. In addition, sphinx + breathe does not join multiple adjacent `@return`. This results in multiple `Return` sections in the generated document, which is confusing. This patch replaces `@return` with `@retval` for the lists of return values. Adjacent `@retval` can be joined into one list by breathe. v1 -> v2: * Replace return value descriptions like `negative` and `positive` with expressions like `<0` and `>0` in `@retval`. * Keep the list of `@retval` comprehensive, even when there is a `@return` to generally describe what the return value means. * Drop duplicated `@return` when it does not give more information than the `@retval` list. Tracked-On: #1595 Signed-off-by: Junjie Mao <junjie.mao@intel.com>
87 lines
1.7 KiB
C
87 lines
1.7 KiB
C
/*
|
|
* Copyright (C) <2018> Intel Corporation
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
/**
|
|
* @file mtrr.h
|
|
*
|
|
* @brief MTRR Virtualization
|
|
*/
|
|
#ifndef MTRR_H
|
|
#define MTRR_H
|
|
/**
|
|
* @brief MTRR Virtualization
|
|
*
|
|
* @addtogroup acrn_mem ACRN Memory Management
|
|
* @{
|
|
*/
|
|
#define FIXED_RANGE_MTRR_NUM 11U
|
|
#define MTRR_SUB_RANGE_NUM 8U
|
|
|
|
union mtrr_cap_reg {
|
|
uint64_t value;
|
|
struct {
|
|
uint32_t vcnt:8;
|
|
uint32_t fix:1;
|
|
uint32_t res0:1;
|
|
uint32_t wc:1;
|
|
uint32_t res1:21;
|
|
uint32_t res2:32;
|
|
} bits;
|
|
};
|
|
|
|
union mtrr_def_type_reg {
|
|
uint64_t value;
|
|
struct {
|
|
uint32_t type:8;
|
|
uint32_t res0:2;
|
|
uint32_t fixed_enable:1;
|
|
uint32_t enable:1;
|
|
uint32_t res1:20;
|
|
uint32_t res2:32;
|
|
} bits;
|
|
};
|
|
|
|
union mtrr_fixed_range_reg {
|
|
uint64_t value;
|
|
uint8_t type[MTRR_SUB_RANGE_NUM];
|
|
};
|
|
|
|
struct mtrr_state {
|
|
union mtrr_cap_reg cap;
|
|
union mtrr_def_type_reg def_type;
|
|
union mtrr_fixed_range_reg fixed_range[FIXED_RANGE_MTRR_NUM];
|
|
};
|
|
|
|
/**
|
|
* @brief Virtual MTRR MSR write
|
|
*
|
|
* @param[inout] vcpu The pointer that points VCPU data structure
|
|
* @param[in] msr Virtual MTRR MSR Address
|
|
* @param[in] value The value that will be writen into virtual MTRR MSR
|
|
*
|
|
* @return None
|
|
*/
|
|
void mtrr_wrmsr(struct acrn_vcpu *vcpu, uint32_t msr, uint64_t value);
|
|
/**
|
|
* @brief Virtual MTRR MSR read
|
|
*
|
|
* @param[in] vcpu The pointer that points VCPU data structure
|
|
* @param[in] msr Virtual MTRR MSR Address
|
|
*
|
|
* @return The specified virtual MTRR MSR value
|
|
*/
|
|
uint64_t mtrr_rdmsr(const struct acrn_vcpu *vcpu, uint32_t msr);
|
|
/**
|
|
* @brief Virtual MTRR initialization
|
|
*
|
|
* @param[inout] vcpu The pointer that points VCPU data structure
|
|
*
|
|
* @return None
|
|
*/
|
|
void init_mtrr(struct acrn_vcpu *vcpu);
|
|
/**
|
|
* @}
|
|
*/
|
|
#endif /* MTRR_H */
|