xref: /netbsd-src/sys/arch/arm/include/cpu_topology.h (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1 /*	$NetBSD: cpu_topology.h,v 1.2 2020/02/15 08:16:11 skrll Exp $	*/
2 
3 /*
4  * Copyright (c) 2020 Matthew R. Green
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. The name of the author may not be used to endorse or promote products
16  *    derived from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
23  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 #ifndef _ARM_CPU_TOPOLOGY_H_
32 #define _ARM_CPU_TOPOLOGY_H_
33 
34 /*
35  * ARMv7 and ARMv8 compatible CPU topology support.
36  *
37  * arm_cpu_do_topology(cpuinfo)
38  *
39  * Call arm_cpu_do_topology() in cpu_attach(). It will update the topology
40  * view of relative speed.
41  *
42  * The CPU frontend can set the "capacity_dmips_mhz" property for this CPU,
43  * and arm_cpu_do_topology() will update the system view of this and other
44  * CPUs relative speeds
45  *
46  * arm_cpu_topology_set(cpuinfo, mpidr)
47  *
48  * arm_cpu_topology_set() is provided for locore and the boot CPU,
49  * and application CPUs.  It updates data for the current CPU.
50  */
51 
52 #include <sys/param.h>
53 #include <sys/cpu.h>
54 
55 void arm_cpu_do_topology(struct cpu_info * const);
56 void arm_cpu_topology_set(struct cpu_info * const, mpidr_t);
57 
58 #endif /* _ARM_CPU_TOPOLOGY_H_ */
59