1e4b86885SCheng Sean Ye /* 2e4b86885SCheng Sean Ye * CDDL HEADER START 3e4b86885SCheng Sean Ye * 4e4b86885SCheng Sean Ye * The contents of this file are subject to the terms of the 5e4b86885SCheng Sean Ye * Common Development and Distribution License (the "License"). 6e4b86885SCheng Sean Ye * You may not use this file except in compliance with the License. 7e4b86885SCheng Sean Ye * 8e4b86885SCheng Sean Ye * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9e4b86885SCheng Sean Ye * or http://www.opensolaris.org/os/licensing. 10e4b86885SCheng Sean Ye * See the License for the specific language governing permissions 11e4b86885SCheng Sean Ye * and limitations under the License. 12e4b86885SCheng Sean Ye * 13e4b86885SCheng Sean Ye * When distributing Covered Code, include this CDDL HEADER in each 14e4b86885SCheng Sean Ye * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15e4b86885SCheng Sean Ye * If applicable, add the following below this CDDL HEADER, with the 16e4b86885SCheng Sean Ye * fields enclosed by brackets "[]" replaced with your own identifying 17e4b86885SCheng Sean Ye * information: Portions Copyright [yyyy] [name of copyright owner] 18e4b86885SCheng Sean Ye * 19e4b86885SCheng Sean Ye * CDDL HEADER END 20e4b86885SCheng Sean Ye */ 21e4b86885SCheng Sean Ye 22e4b86885SCheng Sean Ye /* 23a3114836SGerry Liu * Copyright 2010 Sun Microsystems, Inc. All rights reserved. 24e4b86885SCheng Sean Ye * Use is subject to license terms. 25eb00b1c8SRobert Mustacchi * Copyright 2019 Joyent, Inc. 26*dd23d762SRobert Mustacchi * Copyright 2023 Oxide Computer Co. 27e4b86885SCheng Sean Ye */ 28e4b86885SCheng Sean Ye 29e4b86885SCheng Sean Ye #ifndef _SYS_CPU_MODULE_H 30e4b86885SCheng Sean Ye #define _SYS_CPU_MODULE_H 31e4b86885SCheng Sean Ye 32e4b86885SCheng Sean Ye #include <sys/types.h> 33e4b86885SCheng Sean Ye #include <sys/cpuvar.h> 34e4b86885SCheng Sean Ye #include <sys/nvpair.h> 35e4b86885SCheng Sean Ye #include <sys/mc.h> 36e4b86885SCheng Sean Ye #include <sys/sunddi.h> 3722e4c3acSKeith M Wesolowski #include <sys/x86_archext.h> 38e4b86885SCheng Sean Ye 39e4b86885SCheng Sean Ye #ifdef __cplusplus 40e4b86885SCheng Sean Ye extern "C" { 41e4b86885SCheng Sean Ye #endif 42e4b86885SCheng Sean Ye 43e4b86885SCheng Sean Ye #ifdef _KERNEL 44e4b86885SCheng Sean Ye 45e4b86885SCheng Sean Ye #define CMIERR_BASE 0xc000 46e4b86885SCheng Sean Ye 47e4b86885SCheng Sean Ye typedef enum cmi_errno { 48e4b86885SCheng Sean Ye CMI_SUCCESS = 0, 49e4b86885SCheng Sean Ye /* 50e4b86885SCheng Sean Ye * CPU Module Interface API error return values/ 51e4b86885SCheng Sean Ye */ 52e4b86885SCheng Sean Ye CMIERR_UNKNOWN = CMIERR_BASE, /* no specific error reason reported */ 53e4b86885SCheng Sean Ye CMIERR_API, /* API usage error caught */ 54e4b86885SCheng Sean Ye CMIERR_NOTSUP, /* Unsupported operation */ 55e4b86885SCheng Sean Ye CMIERR_HDL_CLASS, /* Inappropriate handle class */ 56e4b86885SCheng Sean Ye CMIERR_HDL_NOTFOUND, /* Can't find handle for resource */ 57e4b86885SCheng Sean Ye CMIERR_MSRGPF, /* #GP during cmi_hdl_{wr,rd}msr */ 58e4b86885SCheng Sean Ye CMIERR_INTERPOSE, /* MSR/PCICFG interposition error */ 59e4b86885SCheng Sean Ye CMIERR_DEADLOCK, /* Deadlock avoidance */ 60e4b86885SCheng Sean Ye /* 61e4b86885SCheng Sean Ye * Memory-controller related errors 62e4b86885SCheng Sean Ye */ 63e4b86885SCheng Sean Ye CMIERR_MC_ABSENT, /* No, or not yet registered, MC ops */ 64e4b86885SCheng Sean Ye CMIERR_MC_NOTSUP, /* Requested functionality unimpld */ 65e4b86885SCheng Sean Ye CMIERR_MC_NOMEMSCRUB, /* No dram scrubber, or disabled */ 66e4b86885SCheng Sean Ye CMIERR_MC_SYNDROME, /* Invalid syndrome or syndrome type */ 67e4b86885SCheng Sean Ye CMIERR_MC_BADSTATE, /* MC driver state is invalid */ 68e4b86885SCheng Sean Ye CMIERR_MC_NOADDR, /* Address not found */ 69e4b86885SCheng Sean Ye CMIERR_MC_RSRCNOTPRESENT, /* Resource not present in system */ 70e4b86885SCheng Sean Ye CMIERR_MC_ADDRBITS, /* Too few valid addr bits */ 71e4b86885SCheng Sean Ye CMIERR_MC_INVALUNUM, /* Invalid input unum */ 72eb00b1c8SRobert Mustacchi CMIERR_MC_PARTIALUNUMTOPA, /* unum to pa reflected physaddr */ 73*dd23d762SRobert Mustacchi CMIERR_MC_NOTDIMMADDR, /* Address not backed by DRAM */ 74*dd23d762SRobert Mustacchi /* 75*dd23d762SRobert Mustacchi * Cache related errors 76*dd23d762SRobert Mustacchi */ 77*dd23d762SRobert Mustacchi CMIERR_C_NODATA, /* CPU didn't provide required data */ 78*dd23d762SRobert Mustacchi CMIERR_C_BADCACHENO /* Invalid cache number */ 79e4b86885SCheng Sean Ye } cmi_errno_t; 80e4b86885SCheng Sean Ye 81e4b86885SCheng Sean Ye /* 82e4b86885SCheng Sean Ye * All access to cpu information is made via a handle, in order to get 83e4b86885SCheng Sean Ye * the desired info even when running non-natively. 84e4b86885SCheng Sean Ye * 85e4b86885SCheng Sean Ye * A CMI_HDL_NATIVE handle is used when we believe we are running on 86e4b86885SCheng Sean Ye * bare-metal. If we *are* on bare metal then this handle type will 87e4b86885SCheng Sean Ye * get us through to the real hardware, and there will be a 1:1 correspondence 88e4b86885SCheng Sean Ye * between handles and cpu_t structures; if not, say we are a domU to 89e4b86885SCheng Sean Ye * some unknown/undetected/unannounced hypervisor then chances are the 90e4b86885SCheng Sean Ye * hypervisor is not exposing much hardware detail to us so we should 91e4b86885SCheng Sean Ye * be prepared for some operations that "cannot fail" to fail or return 92e4b86885SCheng Sean Ye * odd data. 93e4b86885SCheng Sean Ye * 94e4b86885SCheng Sean Ye * A CMI_HDL_SOLARIS_xVM_MCA handle is used when we are running 95e4b86885SCheng Sean Ye * in i86xpv architecture - dom0 to a Solaris xVM hypervisor - and want to 96e4b86885SCheng Sean Ye * use a handle on each real execution core (as opposed to vcpu) 97e4b86885SCheng Sean Ye * to perform MCA related activities. The model for this handle type 98e4b86885SCheng Sean Ye * is that the hypervisor continues to own the real hardware and 99e4b86885SCheng Sean Ye * includes a polling service and #MC handler which forward error 100e4b86885SCheng Sean Ye * telemetry to dom0 for logging and diagnosis. As such, the operations 101e4b86885SCheng Sean Ye * such as RDMSR and WRMSR for this handle type do *not* read and write 102e4b86885SCheng Sean Ye * real MSRs via hypercalls- instead they should provide the values from 103e4b86885SCheng Sean Ye * already-read MCA bank telemetry, and writes are discarded. 104e4b86885SCheng Sean Ye * 105e4b86885SCheng Sean Ye * If some application requires real MSR read and write access another 106e4b86885SCheng Sean Ye * handle class should be introduced. 107e4b86885SCheng Sean Ye */ 108e4b86885SCheng Sean Ye 109e4b86885SCheng Sean Ye typedef struct cmi_hdl *cmi_hdl_t; /* opaque chip/core/strand handle */ 110e4b86885SCheng Sean Ye 111e4b86885SCheng Sean Ye enum cmi_hdl_class { 112e4b86885SCheng Sean Ye CMI_HDL_NATIVE, 113e4b86885SCheng Sean Ye CMI_HDL_SOLARIS_xVM_MCA, 114e4b86885SCheng Sean Ye CMI_HDL_NEUTRAL 115e4b86885SCheng Sean Ye }; 116e4b86885SCheng Sean Ye 117e4b86885SCheng Sean Ye struct regs; 118e4b86885SCheng Sean Ye 119e4b86885SCheng Sean Ye typedef struct cmi_mc_ops { 120e4b86885SCheng Sean Ye cmi_errno_t (*cmi_mc_patounum)(void *, uint64_t, uint8_t, uint8_t, 121e4b86885SCheng Sean Ye uint32_t, int, mc_unum_t *); 122e4b86885SCheng Sean Ye cmi_errno_t (*cmi_mc_unumtopa)(void *, mc_unum_t *, nvlist_t *, 123e4b86885SCheng Sean Ye uint64_t *); 124e4b86885SCheng Sean Ye void (*cmi_mc_logout)(cmi_hdl_t, boolean_t, boolean_t); 125e4b86885SCheng Sean Ye } cmi_mc_ops_t; 126e4b86885SCheng Sean Ye 127e4b86885SCheng Sean Ye extern cmi_hdl_t cmi_init(enum cmi_hdl_class, uint_t, uint_t, uint_t); 128e4b86885SCheng Sean Ye extern void cmi_post_startup(void); 129e4b86885SCheng Sean Ye extern void cmi_post_mpstartup(void); 130e4b86885SCheng Sean Ye extern void cmi_fini(cmi_hdl_t); 131e4b86885SCheng Sean Ye 132e4b86885SCheng Sean Ye extern void cmi_hdl_hold(cmi_hdl_t); 133e4b86885SCheng Sean Ye extern void cmi_hdl_rele(cmi_hdl_t); 134e4b86885SCheng Sean Ye extern void *cmi_hdl_getcmidata(cmi_hdl_t); 135e4b86885SCheng Sean Ye extern void cmi_hdl_setspecific(cmi_hdl_t, void *); 136e4b86885SCheng Sean Ye extern void *cmi_hdl_getspecific(cmi_hdl_t); 137e4b86885SCheng Sean Ye extern const struct cmi_mc_ops *cmi_hdl_getmcops(cmi_hdl_t); 138e4b86885SCheng Sean Ye extern void *cmi_hdl_getmcdata(cmi_hdl_t); 139e4b86885SCheng Sean Ye extern enum cmi_hdl_class cmi_hdl_class(cmi_hdl_t); 140e4b86885SCheng Sean Ye 141e4b86885SCheng Sean Ye extern cmi_hdl_t cmi_hdl_lookup(enum cmi_hdl_class, uint_t, uint_t, uint_t); 142e4b86885SCheng Sean Ye extern cmi_hdl_t cmi_hdl_any(void); 143e4b86885SCheng Sean Ye 144e4b86885SCheng Sean Ye #define CMI_HDL_WALK_NEXT 0 145e4b86885SCheng Sean Ye #define CMI_HDL_WALK_DONE 1 146e4b86885SCheng Sean Ye extern void cmi_hdl_walk(int (*)(cmi_hdl_t, void *, void *, void *), 147e4b86885SCheng Sean Ye void *, void *, void *); 148e4b86885SCheng Sean Ye 149e4b86885SCheng Sean Ye extern void cmi_hdlconf_rdmsr_nohw(cmi_hdl_t); 150e4b86885SCheng Sean Ye extern void cmi_hdlconf_wrmsr_nohw(cmi_hdl_t); 151e4b86885SCheng Sean Ye extern cmi_errno_t cmi_hdl_rdmsr(cmi_hdl_t, uint_t, uint64_t *); 152e4b86885SCheng Sean Ye extern cmi_errno_t cmi_hdl_wrmsr(cmi_hdl_t, uint_t, uint64_t); 153e4b86885SCheng Sean Ye 154e4b86885SCheng Sean Ye extern void cmi_hdl_enable_mce(cmi_hdl_t); 155e4b86885SCheng Sean Ye extern uint_t cmi_hdl_vendor(cmi_hdl_t); 156e4b86885SCheng Sean Ye extern const char *cmi_hdl_vendorstr(cmi_hdl_t); 157e4b86885SCheng Sean Ye extern uint_t cmi_hdl_family(cmi_hdl_t); 158e4b86885SCheng Sean Ye extern uint_t cmi_hdl_model(cmi_hdl_t); 159e4b86885SCheng Sean Ye extern uint_t cmi_hdl_stepping(cmi_hdl_t); 160e4b86885SCheng Sean Ye extern uint_t cmi_hdl_chipid(cmi_hdl_t); 1618031591dSSrihari Venkatesan extern uint_t cmi_hdl_procnodeid(cmi_hdl_t); 162e4b86885SCheng Sean Ye extern uint_t cmi_hdl_coreid(cmi_hdl_t); 163e4b86885SCheng Sean Ye extern uint_t cmi_hdl_strandid(cmi_hdl_t); 164074bb90dSTom Pothier extern uint_t cmi_hdl_strand_apicid(cmi_hdl_t); 1658031591dSSrihari Venkatesan extern uint_t cmi_hdl_procnodes_per_pkg(cmi_hdl_t); 166e4b86885SCheng Sean Ye extern boolean_t cmi_hdl_is_cmt(cmi_hdl_t); 16722e4c3acSKeith M Wesolowski extern x86_chiprev_t cmi_hdl_chiprev(cmi_hdl_t); 168e4b86885SCheng Sean Ye extern const char *cmi_hdl_chiprevstr(cmi_hdl_t); 169e4b86885SCheng Sean Ye extern uint32_t cmi_hdl_getsockettype(cmi_hdl_t); 17089e921d5SKuriakose Kuruvilla extern const char *cmi_hdl_getsocketstr(cmi_hdl_t); 171e4b86885SCheng Sean Ye extern id_t cmi_hdl_logical_id(cmi_hdl_t); 172074bb90dSTom Pothier extern uint16_t cmi_hdl_smbiosid(cmi_hdl_t); 173074bb90dSTom Pothier extern uint_t cmi_hdl_smb_chipid(cmi_hdl_t); 174074bb90dSTom Pothier extern nvlist_t *cmi_hdl_smb_bboard(cmi_hdl_t); 1752a613b59SRobert Mustacchi extern uint_t cmi_hdl_chipsig(cmi_hdl_t); 1762a613b59SRobert Mustacchi extern const char *cmi_hdl_chipident(cmi_hdl_t); 177e4b86885SCheng Sean Ye 178e4b86885SCheng Sean Ye extern int cmi_hdl_online(cmi_hdl_t, int, int *); 179e4b86885SCheng Sean Ye 180e4b86885SCheng Sean Ye #ifndef __xpv 181e4b86885SCheng Sean Ye extern uint_t cmi_ntv_hwchipid(cpu_t *); 1828031591dSSrihari Venkatesan extern uint_t cmi_ntv_hwprocnodeid(cpu_t *); 183e4b86885SCheng Sean Ye extern uint_t cmi_ntv_hwcoreid(cpu_t *); 184e4b86885SCheng Sean Ye extern uint_t cmi_ntv_hwstrandid(cpu_t *); 185a3114836SGerry Liu extern void cmi_ntv_hwdisable_mce(cmi_hdl_t); 186e4b86885SCheng Sean Ye #endif /* __xpv */ 187e4b86885SCheng Sean Ye 188e4b86885SCheng Sean Ye typedef struct cmi_mca_regs { 189e4b86885SCheng Sean Ye uint_t cmr_msrnum; 190e4b86885SCheng Sean Ye uint64_t cmr_msrval; 191e4b86885SCheng Sean Ye } cmi_mca_regs_t; 192e4b86885SCheng Sean Ye 193e4b86885SCheng Sean Ye extern cmi_errno_t cmi_hdl_msrinject(cmi_hdl_t, cmi_mca_regs_t *, uint_t, 194e4b86885SCheng Sean Ye int); 195e4b86885SCheng Sean Ye extern void cmi_hdl_msrinterpose(cmi_hdl_t, cmi_mca_regs_t *, uint_t); 196e4b86885SCheng Sean Ye extern void cmi_hdl_msrforward(cmi_hdl_t, cmi_mca_regs_t *, uint_t); 197e4b86885SCheng Sean Ye extern boolean_t cmi_inj_tainted(void); 198e4b86885SCheng Sean Ye 199e4b86885SCheng Sean Ye extern void cmi_faulted_enter(cmi_hdl_t); 200e4b86885SCheng Sean Ye extern void cmi_faulted_exit(cmi_hdl_t); 201e4b86885SCheng Sean Ye 202e4b86885SCheng Sean Ye extern void cmi_pcird_nohw(void); 203e4b86885SCheng Sean Ye extern void cmi_pciwr_nohw(void); 204e4b86885SCheng Sean Ye extern uint8_t cmi_pci_getb(int, int, int, int, int *, ddi_acc_handle_t); 205e4b86885SCheng Sean Ye extern uint16_t cmi_pci_getw(int, int, int, int, int *, ddi_acc_handle_t); 206e4b86885SCheng Sean Ye extern uint32_t cmi_pci_getl(int, int, int, int, int *, ddi_acc_handle_t); 207e4b86885SCheng Sean Ye extern void cmi_pci_interposeb(int, int, int, int, uint8_t); 208e4b86885SCheng Sean Ye extern void cmi_pci_interposew(int, int, int, int, uint16_t); 209e4b86885SCheng Sean Ye extern void cmi_pci_interposel(int, int, int, int, uint32_t); 210e4b86885SCheng Sean Ye extern void cmi_pci_putb(int, int, int, int, ddi_acc_handle_t, uint8_t); 211e4b86885SCheng Sean Ye extern void cmi_pci_putw(int, int, int, int, ddi_acc_handle_t, uint16_t); 212e4b86885SCheng Sean Ye extern void cmi_pci_putl(int, int, int, int, ddi_acc_handle_t, uint32_t); 213e4b86885SCheng Sean Ye 214e4b86885SCheng Sean Ye extern void cmi_mca_init(cmi_hdl_t); 215e4b86885SCheng Sean Ye 216e4b86885SCheng Sean Ye extern void cmi_hdl_poke(cmi_hdl_t); 217e4b86885SCheng Sean Ye extern void cmi_hdl_int(cmi_hdl_t, int); 218e4b86885SCheng Sean Ye 219e4b86885SCheng Sean Ye extern void cmi_mca_trap(struct regs *); 220e4b86885SCheng Sean Ye 221e4b86885SCheng Sean Ye extern boolean_t cmi_panic_on_ue(void); 222e4b86885SCheng Sean Ye 223e4b86885SCheng Sean Ye extern void cmi_mc_register(cmi_hdl_t, const struct cmi_mc_ops *, void *); 224a3114836SGerry Liu extern cmi_errno_t cmi_mc_register_global(const struct cmi_mc_ops *, void *); 225e4b86885SCheng Sean Ye extern void cmi_mc_sw_memscrub_disable(void); 226e4b86885SCheng Sean Ye extern cmi_errno_t cmi_mc_patounum(uint64_t, uint8_t, uint8_t, uint32_t, int, 227e4b86885SCheng Sean Ye mc_unum_t *); 228e4b86885SCheng Sean Ye extern cmi_errno_t cmi_mc_unumtopa(mc_unum_t *, nvlist_t *, uint64_t *); 229e4b86885SCheng Sean Ye extern void cmi_mc_logout(cmi_hdl_t, boolean_t, boolean_t); 230e4b86885SCheng Sean Ye 231e4b86885SCheng Sean Ye extern void cmi_panic_callback(void); 232e4b86885SCheng Sean Ye 233*dd23d762SRobert Mustacchi extern cmi_errno_t cmi_cache_ncaches(cmi_hdl_t, uint32_t *); 234*dd23d762SRobert Mustacchi extern cmi_errno_t cmi_cache_info(cmi_hdl_t, uint32_t, x86_cache_t *); 235*dd23d762SRobert Mustacchi 236e4b86885SCheng Sean Ye #endif /* _KERNEL */ 237e4b86885SCheng Sean Ye 238e4b86885SCheng Sean Ye #ifdef __cplusplus 239e4b86885SCheng Sean Ye } 240e4b86885SCheng Sean Ye #endif 241e4b86885SCheng Sean Ye 242e4b86885SCheng Sean Ye #endif /* _SYS_CPU_MODULE_H */ 243