cpu: Support querying the address width
[oweals/u-boot.git] / include / cpu.h
index 954257715a4197dab2d999324af020cf7c2c7d4a..6b1b6b37b3bf2446b1f840dc9beb3cd1f117e25a 100644 (file)
@@ -1,8 +1,7 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
 /*
  * Copyright (c) 2015 Google, Inc
  * Written by Simon Glass <sjg@chromium.org>
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #ifndef __CPU_H
 
 /**
  * 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
+ * @timebase_freq: the current frequency at which the cpu timer timebase
+ *                registers are updated (in Hz)
  *
  * 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];
+       u32 timebase_freq;
 };
 
 /* CPU features - mostly just a placeholder for now */
@@ -40,10 +44,12 @@ enum {
  *
  * @cpu_freq:  Current CPU frequency in Hz
  * @features:  Flags for supported CPU features
+ * @address_width:     Width of the CPU address space in bits (e.g. 32)
  */
 struct cpu_info {
        ulong cpu_freq;
        ulong features;
+       uint address_width;
 };
 
 struct cpu_ops {
@@ -89,39 +95,46 @@ 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);
 
+/**
+ * cpu_probe_all() - Probe all available CPUs
+ *
+ * Return: 0 if OK, -ve on error
+ */
+int cpu_probe_all(void);
+
 #endif