/*
* Copyright (c) 2024 Apple Inc. All rights reserved.
*
* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. The rights granted to you under the License
* may not be used to create, or enable the creation or redistribution of,
* unlawful or unlicensed copies of an Apple operating system, or to
* circumvent, violate, or enable the circumvention or violation of, any
* terms of an Apple operating system software license agreement.
*
* Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
*/
/**
* Data structures that reveal the CPU topology of the system. This header is
* used to contain the API which is kernel private for now, since things are
* constantly evolving and kexts that depend on it could break unexpectedly.
* It should not be included directly but instead is included from
* machine_routines.h
*/
#ifndef _ARM_CPU_TOPOLOGY_H_
#define _ARM_CPU_TOPOLOGY_H_
#include <stdint.h>
__BEGIN_DECLS
typedef struct ml_topology_cpu {
unsigned int cpu_id;
uint32_t phys_id;
unsigned int cluster_id;
unsigned int die_id;
cluster_type_t cluster_type;
uint32_t l2_access_penalty; /* unused */
uint32_t l2_cache_size;
uint32_t l2_cache_id;
uint32_t l3_cache_size;
uint32_t l3_cache_id;
vm_offset_t cpu_IMPL_regs;
uint64_t cpu_IMPL_pa;
uint64_t cpu_IMPL_len;
vm_offset_t cpu_UTTDBG_regs;
uint64_t cpu_UTTDBG_pa;
uint64_t cpu_UTTDBG_len;
vm_offset_t coresight_regs;
uint64_t coresight_pa;
uint64_t coresight_len;
unsigned int die_cluster_id;
unsigned int cluster_core_id;
} ml_topology_cpu_t;
typedef struct ml_topology_cluster {
unsigned int cluster_id;
cluster_type_t cluster_type;
unsigned int num_cpus;
unsigned int first_cpu_id;
uint64_t cpu_mask;
unsigned int die_id;
unsigned int die_cluster_id;
vm_offset_t acc_IMPL_regs;
uint64_t acc_IMPL_pa;
uint64_t acc_IMPL_len;
vm_offset_t cpm_IMPL_regs;
uint64_t cpm_IMPL_pa;
uint64_t cpm_IMPL_len;
} ml_topology_cluster_t;
// Bump this version number any time any ml_topology_* struct changes in a
// way that is likely to break kexts, so that users can check whether their
// headers are compatible with the running kernel
#define CPU_TOPOLOGY_VERSION 1
typedef struct ml_topology_info {
unsigned int version;
unsigned int num_cpus;
unsigned int max_cpu_id;
unsigned int num_clusters;
unsigned int max_cluster_id;
unsigned int max_die_id;
ml_topology_cpu_t *cpus;
ml_topology_cluster_t *clusters;
ml_topology_cpu_t *boot_cpu;
ml_topology_cluster_t *boot_cluster;
unsigned int chip_revision;
unsigned int cluster_types;
unsigned int cluster_type_num_cpus[MAX_CPU_TYPES];
unsigned int cluster_type_num_clusters[MAX_CPU_TYPES];
unsigned int cluster_power_down;
} ml_topology_info_t;
/*!
* @function ml_get_topology_info
* @result A pointer to the read-only topology struct. Does not need to be freed. Returns NULL
* if the struct hasn't been initialized or the feature is unsupported.
*/
const ml_topology_info_t *ml_get_topology_info(void);
__END_DECLS
#endif /* _ARM_CPU_TOPOLOGY_H_ */