1047043c2SRobert Mustacchi /* 2047043c2SRobert Mustacchi * This file and its contents are supplied under the terms of the 3047043c2SRobert Mustacchi * Common Development and Distribution License ("CDDL"), version 1.0. 4047043c2SRobert Mustacchi * You may only use this file in accordance with the terms of version 5047043c2SRobert Mustacchi * 1.0 of the CDDL. 6047043c2SRobert Mustacchi * 7047043c2SRobert Mustacchi * A full copy of the text of the CDDL should have accompanied this 8047043c2SRobert Mustacchi * source. A copy of the CDDL is also available via the Internet at 9047043c2SRobert Mustacchi * http://www.illumos.org/license/CDDL. 10047043c2SRobert Mustacchi */ 11047043c2SRobert Mustacchi 12047043c2SRobert Mustacchi /* 13*dd23d762SRobert Mustacchi * Copyright 2023 Oxide Computer Company 14047043c2SRobert Mustacchi */ 15047043c2SRobert Mustacchi 16047043c2SRobert Mustacchi #ifndef _AMDZEN_CLIENT_H 17047043c2SRobert Mustacchi #define _AMDZEN_CLIENT_H 18047043c2SRobert Mustacchi 19047043c2SRobert Mustacchi /* 20047043c2SRobert Mustacchi * This header provides client routines to clients of the amdzen nexus driver. 21047043c2SRobert Mustacchi */ 22047043c2SRobert Mustacchi 23047043c2SRobert Mustacchi #include <sys/types.h> 2471815ce7SRobert Mustacchi #include <sys/amdzen/df.h> 25ba215efeSKeith M Wesolowski #include <sys/amdzen/smn.h> 26047043c2SRobert Mustacchi 27047043c2SRobert Mustacchi #ifdef __cplusplus 28047043c2SRobert Mustacchi extern "C" { 29047043c2SRobert Mustacchi #endif 30047043c2SRobert Mustacchi 3171815ce7SRobert Mustacchi /* 3271815ce7SRobert Mustacchi * This struct encodes enough information to later be used to compose and 3371815ce7SRobert Mustacchi * decompose a fabric ID and component ID. A fabric ID is broken into its node 3471815ce7SRobert Mustacchi * and component IDs and then a node ID is further decomposed into a socket and 3571815ce7SRobert Mustacchi * die ID. 3671815ce7SRobert Mustacchi */ 3771815ce7SRobert Mustacchi typedef struct { 3871815ce7SRobert Mustacchi uint32_t dfd_sock_mask; 3971815ce7SRobert Mustacchi uint32_t dfd_die_mask; 4071815ce7SRobert Mustacchi uint32_t dfd_node_mask; 4171815ce7SRobert Mustacchi uint32_t dfd_comp_mask; 4271815ce7SRobert Mustacchi uint8_t dfd_sock_shift; 4371815ce7SRobert Mustacchi uint8_t dfd_die_shift; 4471815ce7SRobert Mustacchi uint8_t dfd_node_shift; 4571815ce7SRobert Mustacchi uint8_t dfd_comp_shift; 4671815ce7SRobert Mustacchi } df_fabric_decomp_t; 4771815ce7SRobert Mustacchi 48*dd23d762SRobert Mustacchi /* 49*dd23d762SRobert Mustacchi * This struct is similar to the above, but describes how an APIC ID is broken 50*dd23d762SRobert Mustacchi * down into its logical pieces. These are not the same as those above and 51*dd23d762SRobert Mustacchi * cannot be assumed to be. The mask is present when decomposing the ID and 52*dd23d762SRobert Mustacchi * should be applied before the shift. 53*dd23d762SRobert Mustacchi */ 54*dd23d762SRobert Mustacchi typedef struct { 55*dd23d762SRobert Mustacchi uint32_t aad_sock_mask; 56*dd23d762SRobert Mustacchi uint32_t aad_die_mask; 57*dd23d762SRobert Mustacchi uint32_t aad_ccd_mask; 58*dd23d762SRobert Mustacchi uint32_t aad_ccx_mask; 59*dd23d762SRobert Mustacchi uint32_t aad_core_mask; 60*dd23d762SRobert Mustacchi uint32_t aad_thread_mask; 61*dd23d762SRobert Mustacchi uint8_t aad_sock_shift; 62*dd23d762SRobert Mustacchi uint8_t aad_die_shift; 63*dd23d762SRobert Mustacchi uint8_t aad_ccd_shift; 64*dd23d762SRobert Mustacchi uint8_t aad_ccx_shift; 65*dd23d762SRobert Mustacchi uint8_t aad_core_shift; 66*dd23d762SRobert Mustacchi uint8_t aad_thread_shift; 67*dd23d762SRobert Mustacchi } amdzen_apic_decomp_t; 68*dd23d762SRobert Mustacchi 69*dd23d762SRobert Mustacchi /* 70*dd23d762SRobert Mustacchi * The following routines are used for Fabric and APIC ID decomposition and are 71*dd23d762SRobert Mustacchi * suitable either for kernel or userland use. They are found in 72*dd23d762SRobert Mustacchi * usr/src/common/zen/zen_fabric_utils.c. 73*dd23d762SRobert Mustacchi */ 74*dd23d762SRobert Mustacchi extern boolean_t zen_fabric_id_valid_fabid(const df_fabric_decomp_t *, 75*dd23d762SRobert Mustacchi const uint32_t); 76*dd23d762SRobert Mustacchi extern boolean_t zen_fabric_id_valid_parts(const df_fabric_decomp_t *, 77*dd23d762SRobert Mustacchi const uint32_t, const uint32_t, const uint32_t); 78*dd23d762SRobert Mustacchi extern void zen_fabric_id_decompose(const df_fabric_decomp_t *, const uint32_t, 79*dd23d762SRobert Mustacchi uint32_t *, uint32_t *, uint32_t *); 80*dd23d762SRobert Mustacchi extern void zen_fabric_id_compose(const df_fabric_decomp_t *, const uint32_t, 81*dd23d762SRobert Mustacchi const uint32_t, const uint32_t, uint32_t *); 82*dd23d762SRobert Mustacchi 83*dd23d762SRobert Mustacchi extern void zen_apic_id_compose(const amdzen_apic_decomp_t *, const uint32_t, 84*dd23d762SRobert Mustacchi const uint32_t, const uint32_t, const uint32_t, const uint32_t, 85*dd23d762SRobert Mustacchi const uint32_t, uint32_t *); 86*dd23d762SRobert Mustacchi 87*dd23d762SRobert Mustacchi #ifdef _KERNEL 88*dd23d762SRobert Mustacchi 8971815ce7SRobert Mustacchi extern uint_t amdzen_c_df_count(void); 9071815ce7SRobert Mustacchi extern df_rev_t amdzen_c_df_rev(void); 9171815ce7SRobert Mustacchi extern int amdzen_c_df_fabric_decomp(df_fabric_decomp_t *); 9271815ce7SRobert Mustacchi 9371815ce7SRobert Mustacchi /* 9471815ce7SRobert Mustacchi * SMN and DF access routines. 9571815ce7SRobert Mustacchi */ 964adf43b0SKeith M Wesolowski extern int amdzen_c_smn_read(uint_t, const smn_reg_t, uint32_t *); 974adf43b0SKeith M Wesolowski extern int amdzen_c_smn_write(uint_t, const smn_reg_t, const uint32_t); 9871815ce7SRobert Mustacchi extern int amdzen_c_df_read32(uint_t, uint8_t, const df_reg_def_t, uint32_t *); 9971815ce7SRobert Mustacchi extern int amdzen_c_df_read64(uint_t, uint8_t, const df_reg_def_t, uint64_t *); 10071815ce7SRobert Mustacchi 10171815ce7SRobert Mustacchi /* 10271815ce7SRobert Mustacchi * The following are logical types that we can iterate over. Note, that these 10371815ce7SRobert Mustacchi * are a combination of a DF type and subtype. This is used to smooth over the 10471815ce7SRobert Mustacchi * differences between different DF revisions and how they indicate these types. 10571815ce7SRobert Mustacchi */ 10671815ce7SRobert Mustacchi typedef enum { 10771815ce7SRobert Mustacchi /* 10871815ce7SRobert Mustacchi * Iterate over only DDR memory controllers. 10971815ce7SRobert Mustacchi */ 11071815ce7SRobert Mustacchi ZEN_DF_TYPE_CS_UMC, 11171815ce7SRobert Mustacchi /* 11271815ce7SRobert Mustacchi * Iterate only over CPU based CCMs. 11371815ce7SRobert Mustacchi */ 11471815ce7SRobert Mustacchi ZEN_DF_TYPE_CCM_CPU 11571815ce7SRobert Mustacchi } zen_df_type_t; 11671815ce7SRobert Mustacchi 11771815ce7SRobert Mustacchi typedef int (*amdzen_c_iter_f)(uint_t, uint32_t, uint32_t, void *); 11871815ce7SRobert Mustacchi extern int amdzen_c_df_iter(uint_t, zen_df_type_t, amdzen_c_iter_f, void *); 119047043c2SRobert Mustacchi 120*dd23d762SRobert Mustacchi #endif /* _KERNEL */ 121*dd23d762SRobert Mustacchi 122047043c2SRobert Mustacchi #ifdef __cplusplus 123047043c2SRobert Mustacchi } 124047043c2SRobert Mustacchi #endif 125047043c2SRobert Mustacchi 126047043c2SRobert Mustacchi #endif /* _AMDZEN_CLIENT_H */ 127