[U-Boot] [PATCH v4 13/17] cpu: Fix cpu.h documentation
Mario Six
mario.six at gdsys.cc
Mon Aug 6 08:23:42 UTC 2018
Documentation in cpu.h is not in kernel-doc format. Change it to comply
with it.
Signed-off-by: Mario Six <mario.six at gdsys.cc>
---
Notes:
v3 -> v4:
New in v4
include/cpu.h | 28 +++++++++++++++-------------
1 file changed, 15 insertions(+), 13 deletions(-)
diff --git a/include/cpu.h b/include/cpu.h
index 5cc7c5abd72..22467cb9b3a 100644
--- a/include/cpu.h
+++ b/include/cpu.h
@@ -9,19 +9,21 @@
/**
* struct cpu_platdata - platform data for a CPU
+ * @cpu_id: Platform-specific way of identifying the CPU.
+ * @ucode_version: Microcode version, if CPU_FEAT_UCODE is set
+ * @device_id: Driver-defined device identifier
+ * @family: DMTF CPU Family identifier
+ * @id: DMTF CPU Processor identifier
*
* This can be accessed with dev_get_parent_platdata() for any UCLASS_CPU
* device.
- *
- * @cpu_id: Platform-specific way of identifying the CPU.
- * @ucode_version: Microcode version, if CPU_FEAT_UCODE is set
*/
struct cpu_platdata {
int cpu_id;
int ucode_version;
ulong device_id;
- u16 family; /* DMTF CPU Family */
- u32 id[2]; /* DMTF CPU Processor IDs */
+ u16 family;
+ u32 id[2];
};
/* CPU features - mostly just a placeholder for now */
@@ -88,38 +90,38 @@ struct cpu_ops {
/**
* cpu_get_desc() - Get a description string for a CPU
- *
* @dev: Device to check (UCLASS_CPU)
* @buf: Buffer to place string
* @size: Size of string space
- * @return 0 if OK, -ENOSPC if buffer is too small, other -ve on error
+ *
+ * Return: 0 if OK, -ENOSPC if buffer is too small, other -ve on error
*/
int cpu_get_desc(struct udevice *dev, char *buf, int size);
/**
* cpu_get_info() - Get information about a CPU
- *
* @dev: Device to check (UCLASS_CPU)
* @info: Returns CPU info
- * @return 0 if OK, -ve on error
+ *
+ * Return: 0 if OK, -ve on error
*/
int cpu_get_info(struct udevice *dev, struct cpu_info *info);
/**
* cpu_get_count() - Get number of CPUs
- *
* @dev: Device to check (UCLASS_CPU)
- * @return CPU count if OK, -ve on error
+ *
+ * Return: CPU count if OK, -ve on error
*/
int cpu_get_count(struct udevice *dev);
/**
* cpu_get_vendor() - Get vendor name of a CPU
- *
* @dev: Device to check (UCLASS_CPU)
* @buf: Buffer to place string
* @size: Size of string space
- * @return 0 if OK, -ENOSPC if buffer is too small, other -ve on error
+ *
+ * Return: 0 if OK, -ENOSPC if buffer is too small, other -ve on error
*/
int cpu_get_vendor(struct udevice *dev, char *buf, int size);
--
2.11.0
More information about the U-Boot
mailing list