blob: 2f283fe2449dcf620b6b0029ccffa2e4dfdb217f [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass11f4dc12015-04-28 20:25:09 -06002/*
3 * Copyright (c) 2015 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
Simon Glass11f4dc12015-04-28 20:25:09 -06005 */
6
7#ifndef __CPU_H
8#define __CPU_H
9
10/**
11 * struct cpu_platdata - platform data for a CPU
Mario Six50d188b2018-08-06 10:23:42 +020012 * @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
Bin Mengb8596942018-12-12 06:12:24 -080017 * @timebase_freq: the current frequency at which the cpu timer timebase
18 * registers are updated (in Hz)
Simon Glass11f4dc12015-04-28 20:25:09 -060019 *
20 * This can be accessed with dev_get_parent_platdata() for any UCLASS_CPU
21 * device.
Simon Glass11f4dc12015-04-28 20:25:09 -060022 */
23struct cpu_platdata {
24 int cpu_id;
Simon Glass740d5d32016-03-06 19:27:49 -070025 int ucode_version;
26 ulong device_id;
Mario Six50d188b2018-08-06 10:23:42 +020027 u16 family;
28 u32 id[2];
Bin Mengb8596942018-12-12 06:12:24 -080029 u32 timebase_freq;
Simon Glass11f4dc12015-04-28 20:25:09 -060030};
31
32/* CPU features - mostly just a placeholder for now */
33enum {
34 CPU_FEAT_L1_CACHE = 0, /* Supports level 1 cache */
35 CPU_FEAT_MMU = 1, /* Supports virtual memory */
Simon Glass740d5d32016-03-06 19:27:49 -070036 CPU_FEAT_UCODE = 2, /* Requires/uses microcode */
37 CPU_FEAT_DEVICE_ID = 3, /* Provides a device ID */
Simon Glass11f4dc12015-04-28 20:25:09 -060038
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
Simon Glass600f5842020-04-08 16:57:20 -060047 * @address_width: Width of the CPU address space in bits (e.g. 32)
Simon Glass11f4dc12015-04-28 20:25:09 -060048 */
49struct cpu_info {
50 ulong cpu_freq;
51 ulong features;
Simon Glass600f5842020-04-08 16:57:20 -060052 uint address_width;
Simon Glass11f4dc12015-04-28 20:25:09 -060053};
54
55struct 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 */
Tom Rini72083962020-07-24 08:42:06 -040064 int (*get_desc)(struct udevice *dev, char *buf, int size);
Simon Glass11f4dc12015-04-28 20:25:09 -060065
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 */
Tom Rini72083962020-07-24 08:42:06 -040073 int (*get_info)(struct udevice *dev, struct cpu_info *info);
Bin Meng780bfdd2015-06-17 11:15:34 +080074
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 */
Tom Rini72083962020-07-24 08:42:06 -040081 int (*get_count)(struct udevice *dev);
Alexander Graf94eaa792016-08-19 01:23:27 +020082
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 */
Tom Rini72083962020-07-24 08:42:06 -040091 int (*get_vendor)(struct udevice *dev, char *buf, int size);
Peng Fan4c809ae2020-05-03 21:58:47 +080092
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);
Simon Glass11f4dc12015-04-28 20:25:09 -0600101};
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
Simon Glass11f4dc12015-04-28 20:25:09 -0600107 * @dev: Device to check (UCLASS_CPU)
108 * @buf: Buffer to place string
109 * @size: Size of string space
Mario Six50d188b2018-08-06 10:23:42 +0200110 *
111 * Return: 0 if OK, -ENOSPC if buffer is too small, other -ve on error
Simon Glass11f4dc12015-04-28 20:25:09 -0600112 */
Tom Rini72083962020-07-24 08:42:06 -0400113int cpu_get_desc(struct udevice *dev, char *buf, int size);
Simon Glass11f4dc12015-04-28 20:25:09 -0600114
115/**
116 * cpu_get_info() - Get information about a CPU
Simon Glass11f4dc12015-04-28 20:25:09 -0600117 * @dev: Device to check (UCLASS_CPU)
118 * @info: Returns CPU info
Mario Six50d188b2018-08-06 10:23:42 +0200119 *
120 * Return: 0 if OK, -ve on error
Simon Glass11f4dc12015-04-28 20:25:09 -0600121 */
Tom Rini72083962020-07-24 08:42:06 -0400122int cpu_get_info(struct udevice *dev, struct cpu_info *info);
Simon Glass11f4dc12015-04-28 20:25:09 -0600123
Bin Meng780bfdd2015-06-17 11:15:34 +0800124/**
125 * cpu_get_count() - Get number of CPUs
Bin Meng780bfdd2015-06-17 11:15:34 +0800126 * @dev: Device to check (UCLASS_CPU)
Mario Six50d188b2018-08-06 10:23:42 +0200127 *
128 * Return: CPU count if OK, -ve on error
Bin Meng780bfdd2015-06-17 11:15:34 +0800129 */
Tom Rini72083962020-07-24 08:42:06 -0400130int cpu_get_count(struct udevice *dev);
Bin Meng780bfdd2015-06-17 11:15:34 +0800131
Alexander Graf94eaa792016-08-19 01:23:27 +0200132/**
133 * cpu_get_vendor() - Get vendor name of a CPU
Alexander Graf94eaa792016-08-19 01:23:27 +0200134 * @dev: Device to check (UCLASS_CPU)
135 * @buf: Buffer to place string
136 * @size: Size of string space
Mario Six50d188b2018-08-06 10:23:42 +0200137 *
138 * Return: 0 if OK, -ENOSPC if buffer is too small, other -ve on error
Alexander Graf94eaa792016-08-19 01:23:27 +0200139 */
Tom Rini72083962020-07-24 08:42:06 -0400140int cpu_get_vendor(struct udevice *dev, char *buf, int size);
Alexander Graf94eaa792016-08-19 01:23:27 +0200141
Mario Six57370de2018-08-06 10:23:43 +0200142/**
143 * cpu_probe_all() - Probe all available CPUs
144 *
145 * Return: 0 if OK, -ve on error
146 */
147int cpu_probe_all(void);
148
Peng Fan4c809ae2020-05-03 21:58:47 +0800149/**
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 */
154int 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 */
161struct udevice *cpu_get_current_dev(void);
162
Simon Glass11f4dc12015-04-28 20:25:09 -0600163#endif