doxygen: fix wrong description in hypercall.h

JasonChenCJ · lijinxia · commit fcd79325e158 · 2018-05-22T16:39:24.000+08:00
fix wrong description for hcall_get_cpu_pm_state/hcall_world_switch

Signed-off-by: Jason Chen CJ &lt;jason.cj.chen@intel.com&gt;
diff --git a/hypervisor/include/common/hypercall.h b/hypervisor/include/common/hypercall.h
@@ -335,19 +335,21 @@ int64_t hcall_reset_ptdev_intr_info(struct vm *vm, uint64_t vmid,
 int64_t hcall_setup_sbuf(struct vm *vm, uint64_t param);
 
 /**
- * @brief Switch VCPU state between Normal/Secure World.
+ * @brief Get VCPU Power state.
  *
- * @param vcpu Pointer to VCPU data structure
+ * @param cmd cmd to show get which VCPU power state data
+ * @param param VCPU power state data
  *
  * @return 0 on success, non-zero on error.
  */
 
 int64_t hcall_get_cpu_pm_state(struct vm *vm, uint64_t cmd, uint64_t param);
 
+
 /**
- * @brief Get VCPU Power state.
+ * @brief Switch VCPU state between Normal/Secure World.
  *
- * @param VCPU power state data
+ * @param vcpu Pointer to VCPU data structure
  *
  * @return 0 on success, non-zero on error.
  */

Original file line number	Diff line number	Diff line change
`@@ -335,19 +335,21 @@ int64_t hcall_reset_ptdev_intr_info(struct vm *vm, uint64_t vmid,`
`335`	`335`	`int64_t hcall_setup_sbuf(struct vm *vm, uint64_t param);`
`336`	`336`
`337`	`337`	`/**`
`338`		`- * @brief Switch VCPU state between Normal/Secure World.`
	`338`	`+ * @brief Get VCPU Power state.`
`339`	`339`	`*`
`340`		`- * @param vcpu Pointer to VCPU data structure`
	`340`	`+ * @param cmd cmd to show get which VCPU power state data`
	`341`	`+ * @param param VCPU power state data`
`341`	`342`	`*`
`342`	`343`	`* @return 0 on success, non-zero on error.`
`343`	`344`	`*/`
`344`	`345`
`345`	`346`	`int64_t hcall_get_cpu_pm_state(struct vm *vm, uint64_t cmd, uint64_t param);`
`346`	`347`
	`348`	`+`
`347`	`349`	`/**`
`348`		`- * @brief Get VCPU Power state.`
	`350`	`+ * @brief Switch VCPU state between Normal/Secure World.`
`349`	`351`	`*`
`350`		`- * @param VCPU power state data`
	`352`	`+ * @param vcpu Pointer to VCPU data structure`
`351`	`353`	`*`
`352`	`354`	`* @return 0 on success, non-zero on error.`
`353`	`355`	`*/`