include/cpu.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright (c) 2015 Google, Inc
   4  * Written by Simon Glass <sjg@chromium.org>
   5  */
   6
   7 #ifndef __CPU_H
   8 #define __CPU_H
   9
  10 /**
  11  * struct cpu_platdata - platform data for a CPU
  12  * @cpu_id:        Platform-specific way of identifying the CPU.
  13  * @ucode_version: Microcode version, if CPU_FEAT_UCODE is set
  14  * @device_id:     Driver-defined device identifier
  15  * @family:        DMTF CPU Family identifier
  16  * @id:            DMTF CPU Processor identifier
  17  * @timebase_freq: the current frequency at which the cpu timer timebase
  18  *                 registers are updated (in Hz)
  19  *
  20  * This can be accessed with dev_get_parent_platdata() for any UCLASS_CPU
  21  * device.
  22  */
  23 struct cpu_platdata {
  24         int cpu_id;
  25         int ucode_version;
  26         ulong device_id;
  27         u16 family;
  28         u32 id[2];
  29         u32 timebase_freq;
  30 };
  31
  32 /* CPU features - mostly just a placeholder for now */
  33 enum {
  34         CPU_FEAT_L1_CACHE       = 0,    /* Supports level 1 cache */
  35         CPU_FEAT_MMU            = 1,    /* Supports virtual memory */
  36         CPU_FEAT_UCODE          = 2,    /* Requires/uses microcode */
  37         CPU_FEAT_DEVICE_ID      = 3,    /* Provides a device ID */
  38
  39         CPU_FEAT_COUNT,
  40 };
  41
  42 /**
  43  * struct cpu_info - Information about a CPU
  44  *
  45  * @cpu_freq:   Current CPU frequency in Hz
  46  * @features:   Flags for supported CPU features
  47  * @address_width:      Width of the CPU address space in bits (e.g. 32)
  48  */
  49 struct cpu_info {
  50         ulong cpu_freq;
  51         ulong features;
  52         uint address_width;
  53 };
  54
  55 struct cpu_ops {
  56         /**
  57          * get_desc() - Get a description string for a CPU
  58          *
  59          * @dev:        Device to check (UCLASS_CPU)
  60          * @buf:        Buffer to place string
  61          * @size:       Size of string space
  62          * @return 0 if OK, -ENOSPC if buffer is too small, other -ve on error
  63          */
  64         int (*get_desc)(const struct udevice *dev, char *buf, int size);
  65
  66         /**
  67          * get_info() - Get information about a CPU
  68          *
  69          * @dev:        Device to check (UCLASS_CPU)
  70          * @info:       Returns CPU info
  71          * @return 0 if OK, -ve on error
  72          */
  73         int (*get_info)(const struct udevice *dev, struct cpu_info *info);
  74
  75         /**
  76          * get_count() - Get number of CPUs
  77          *
  78          * @dev:        Device to check (UCLASS_CPU)
  79          * @return CPU count if OK, -ve on error
  80          */
  81         int (*get_count)(const struct udevice *dev);
  82
  83         /**
  84          * get_vendor() - Get vendor name of a CPU
  85          *
  86          * @dev:        Device to check (UCLASS_CPU)
  87          * @buf:        Buffer to place string
  88          * @size:       Size of string space
  89          * @return 0 if OK, -ENOSPC if buffer is too small, other -ve on error
  90          */
  91         int (*get_vendor)(const struct udevice *dev, char *buf, int size);
  92
  93         /**
  94          * is_current() - Check if the CPU that U-Boot is currently running from
  95          *
  96          * @dev:        Device to check (UCLASS_CPU)
  97          * @return 1 if the CPU that U-Boot is currently running from, 0
  98          *         if not.
  99          */
 100         int (*is_current)(struct udevice *dev);
 101 };
 102
 103 #define cpu_get_ops(dev)        ((struct cpu_ops *)(dev)->driver->ops)
 104
 105 /**
 106  * cpu_get_desc() - Get a description string for a CPU
 107  * @dev:        Device to check (UCLASS_CPU)
 108  * @buf:        Buffer to place string
 109  * @size:       Size of string space
 110  *
 111  * Return: 0 if OK, -ENOSPC if buffer is too small, other -ve on error
 112  */
 113 int cpu_get_desc(const struct udevice *dev, char *buf, int size);
 114
 115 /**
 116  * cpu_get_info() - Get information about a CPU
 117  * @dev:        Device to check (UCLASS_CPU)
 118  * @info:       Returns CPU info
 119  *
 120  * Return: 0 if OK, -ve on error
 121  */
 122 int cpu_get_info(const struct udevice *dev, struct cpu_info *info);
 123
 124 /**
 125  * cpu_get_count() - Get number of CPUs
 126  * @dev:        Device to check (UCLASS_CPU)
 127  *
 128  * Return: CPU count if OK, -ve on error
 129  */
 130 int cpu_get_count(const struct udevice *dev);
 131
 132 /**
 133  * cpu_get_vendor() - Get vendor name of a CPU
 134  * @dev:        Device to check (UCLASS_CPU)
 135  * @buf:        Buffer to place string
 136  * @size:       Size of string space
 137  *
 138  * Return: 0 if OK, -ENOSPC if buffer is too small, other -ve on error
 139  */
 140 int cpu_get_vendor(const struct udevice *dev, char *buf, int size);
 141
 142 /**
 143  * cpu_probe_all() - Probe all available CPUs
 144  *
 145  * Return: 0 if OK, -ve on error
 146  */
 147 int cpu_probe_all(void);
 148
 149 /**
 150  * cpu_is_current() - Check if the CPU that U-Boot is currently running from
 151  *
 152  * Return: 1 if yes, - 0 if not
 153  */
 154 int cpu_is_current(struct udevice *cpu);
 155
 156 /**
 157  * cpu_get_current_dev() - Get CPU udevice for current CPU
 158  *
 159  * Return: udevice if OK, - NULL on error
 160  */
 161 struct udevice *cpu_get_current_dev(void);
 162
 163 #endif