xref: /illumos-gate/usr/src/lib/fm/topo/modules/i86pc/chip/chip.h (revision d0caeb890c33e30d7a9addcbccdda2343401d3e7)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright 2019, Joyent, Inc.
24  * Copyright 2020 Oxide Computer Company
25  */
26 
27 #ifndef _CHIP_H
28 #define	_CHIP_H
29 
30 #include <kstat.h>
31 #include <libnvpair.h>
32 #include <fm/libtopo.h>
33 #include <fm/topo_mod.h>
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 #define	CHIP_VERSION		TOPO_VERSION
40 
41 /* Below should match the definitions in x86pi_impl.h */
42 #define	X86PI_FULL		1
43 #define	X86PI_NONE		2
44 
45 /*
46  * FM_AWARE_SMBIOS means SMBIOS meets FMA needs
47  * X86PI_FULL is defined as 1 in x86pi.so
48  * And passed from x86pi.so to chip.so as module
49  * private data
50  */
51 #define	FM_AWARE_SMBIOS(mod)	\
52 	(topo_mod_getspecific(mod) != NULL && \
53 	    (*(int *)topo_mod_getspecific(mod) == X86PI_FULL))
54 #define	IGNORE_ID	0xFFFF
55 
56 /*
57  * These definitions are for the Tree Nodes
58  * in the FM Topology
59  */
60 #define	CHIP_NODE_NAME		"chip"
61 #define	CORE_NODE_NAME		"core"
62 #define	STRAND_NODE_NAME	"strand"
63 #define	MCT_NODE_NAME		"memory-controller"
64 #define	CHAN_NODE_NAME		"dram-channel"
65 #define	CS_NODE_NAME		"chip-select"
66 #define	DIMM_NODE_NAME		"dimm"
67 #define	RANK_NODE_NAME		"rank"
68 
69 #define	PGNAME(prefix)	(prefix##_NODE_NAME "-properties")
70 
71 /*
72  * chip-properties
73  */
74 #define	CHIP_BRAND		"brand"
75 #define	CHIP_FAMILY		"family"
76 #define	CHIP_MODEL		"model"
77 #define	CHIP_NCORE		"ncore_per_chip"
78 #define	CHIP_SOCKET		"socket"
79 #define	CHIP_STEPPING		"stepping"
80 #define	CHIP_VENDOR_ID		"vendor_id"
81 
82 /*
83  * memory-controller-properties
84  * check usr/src/uts/i86pc/os/cpuid.c to understand more
85  * on procnodeid values for AMD & Intel
86  */
87 #define	MCT_PROCNODE_ID		"procnodeid"
88 
89 /*
90  * core-properties
91  */
92 #define	CORE_CHIP_ID		"chip_id"
93 #define	CORE_PROCNODE_ID	"procnodeid"
94 
95 /*
96  * strand-properties
97  */
98 #define	STRAND_CHIP_ID		"chip_id"
99 #define	STRAND_PROCNODE_ID	"procnodeid"
100 #define	STRAND_CORE_ID		"core_id"
101 #define	STRAND_PKG_CORE_ID	"pkg_core_id"
102 #define	STRAND_CPU_ID		"cpuid"
103 
104 /*
105  * label property methods
106  */
107 #define	SIMPLE_DIMM_LBL		"simple_dimm_label"
108 #define	SIMPLE_DIMM_LBL_MP	"simple_dimm_label_mp"
109 #define	SEQ_DIMM_LBL		"seq_dimm_label"
110 #define	G4_DIMM_LBL		"g4_dimm_label"
111 #define	G12F_DIMM_LBL		"g12f_dimm_label"
112 #define	SIMPLE_CHIP_LBL		"simple_chip_label"
113 #define	G4_CHIP_LBL		"g4_chip_label"
114 #define	A4FPLUS_CHIP_LBL	"a4fplus_chip_label"
115 #define	SIMPLE_CS_LBL_MP	"simple_cs_label_mp"
116 #define	FSB2_CHIP_LBL		"fsb2_chip_label"
117 
118 /*
119  * DIMM serial number property methods
120  */
121 #define	GET_DIMM_SERIAL		"get_dimm_serial"
122 
123 extern int simple_dimm_label(topo_mod_t *, tnode_t *, topo_version_t,
124     nvlist_t *, nvlist_t **);
125 extern int simple_dimm_label_mp(topo_mod_t *, tnode_t *, topo_version_t,
126     nvlist_t *, nvlist_t **);
127 extern int seq_dimm_label(topo_mod_t *, tnode_t *, topo_version_t,
128     nvlist_t *, nvlist_t **);
129 extern int g4_dimm_label(topo_mod_t *, tnode_t *, topo_version_t, nvlist_t *,
130     nvlist_t **);
131 
132 extern int g12f_dimm_label(topo_mod_t *, tnode_t *, topo_version_t, nvlist_t *,
133     nvlist_t **);
134 
135 extern int simple_chip_label(topo_mod_t *, tnode_t *, topo_version_t,
136     nvlist_t *, nvlist_t **);
137 extern int g4_chip_label(topo_mod_t *, tnode_t *, topo_version_t,
138     nvlist_t *, nvlist_t **);
139 extern int a4fplus_chip_label(topo_mod_t *, tnode_t *, topo_version_t,
140     nvlist_t *, nvlist_t **);
141 extern int simple_cs_label_mp(topo_mod_t *, tnode_t *, topo_version_t,
142     nvlist_t *, nvlist_t **);
143 extern int get_dimm_serial(topo_mod_t *, tnode_t *, topo_version_t, nvlist_t *,
144     nvlist_t **);
145 extern int fsb2_chip_label(topo_mod_t *, tnode_t *, topo_version_t,
146     nvlist_t *, nvlist_t **);
147 
148 /*
149  * Support functions of chip_subr.c
150  */
151 extern void whinge(topo_mod_t *, int *, const char *, ...);
152 extern int nvprop_add(topo_mod_t *, nvpair_t *, const char *, tnode_t *);
153 extern int add_nvlist_strprop(topo_mod_t *, tnode_t *, nvlist_t *,
154     const char *, const char *, const char **);
155 extern int add_nvlist_longprop(topo_mod_t *, tnode_t *, nvlist_t *,
156     const char *, const char *, int32_t *);
157 extern int add_nvlist_longprops(topo_mod_t *, tnode_t *, nvlist_t *,
158     const char *, int32_t *, ...);
159 extern int mkrsrc(topo_mod_t *, tnode_t *, const char *, int,
160     nvlist_t *, nvlist_t **);
161 extern nvlist_t *cpu_fmri_create(topo_mod_t *, uint32_t, char *, uint8_t);
162 extern boolean_t is_xpv();
163 extern void get_chip_kstat_strs(topo_mod_t *, kstat_ctl_t *, int32_t, char **,
164     char **);
165 
166 /*
167  * topo methods
168  */
169 extern int mem_asru_compute(topo_mod_t *, tnode_t *, topo_version_t,
170     nvlist_t *, nvlist_t **);
171 extern int rank_fmri_present(topo_mod_t *, tnode_t *, topo_version_t,
172     nvlist_t *, nvlist_t **);
173 extern int rank_fmri_replaced(topo_mod_t *, tnode_t *, topo_version_t,
174     nvlist_t *, nvlist_t **);
175 extern int retire_strands(topo_mod_t *, tnode_t *, topo_version_t,
176     nvlist_t *, nvlist_t **);
177 extern int unretire_strands(topo_mod_t *, tnode_t *, topo_version_t,
178     nvlist_t *, nvlist_t **);
179 extern int service_state_strands(topo_mod_t *, tnode_t *, topo_version_t,
180     nvlist_t *, nvlist_t **);
181 extern int unusable_strands(topo_mod_t *, tnode_t *, topo_version_t,
182     nvlist_t *, nvlist_t **);
183 extern int ntv_page_retire(topo_mod_t *, tnode_t *, topo_version_t,
184     nvlist_t *, nvlist_t **);
185 extern int ntv_page_service_state(topo_mod_t *, tnode_t *, topo_version_t,
186     nvlist_t *, nvlist_t **);
187 extern int ntv_page_unretire(topo_mod_t *, tnode_t *, topo_version_t,
188     nvlist_t *, nvlist_t **);
189 extern int ntv_page_unusable(topo_mod_t *, tnode_t *, topo_version_t,
190     nvlist_t *, nvlist_t **);
191 extern int chip_fmri_replaced(topo_mod_t *, tnode_t *, topo_version_t,
192     nvlist_t *, nvlist_t **);
193 
194 extern int mem_asru_create(topo_mod_t *, nvlist_t *, nvlist_t **);
195 
196 /*
197  * Prototypes for chip_amd.c
198  */
199 extern void amd_mc_create(topo_mod_t *, uint16_t, tnode_t *, const char *,
200     nvlist_t *, int32_t, int32_t, int, int, int *);
201 
202 /*
203  * Prototypes for chip_intel.c
204  */
205 extern int mc_offchip_open(void);
206 extern int mc_offchip_create(topo_mod_t *, tnode_t *, const char *, nvlist_t *);
207 extern void onchip_mc_create(topo_mod_t *, uint16_t, tnode_t *,
208     const char *, nvlist_t *);
209 
210 extern char *get_fmtstr(topo_mod_t *, nvlist_t *);
211 extern int store_prop_val(topo_mod_t *, char *, char *, nvlist_t **out);
212 
213 /*
214  * Prototypes for chip_smbios.c
215  */
216 
217 extern int init_chip_smbios(topo_mod_t *);
218 extern int chip_status_smbios_get(topo_mod_t *, id_t);
219 extern int chip_fru_smbios_get(topo_mod_t *, id_t);
220 extern const char *chip_label_smbios_get(topo_mod_t *, tnode_t *, id_t, char *);
221 extern const char *chip_serial_smbios_get(topo_mod_t *, id_t);
222 extern const char *chip_part_smbios_get(topo_mod_t *, id_t);
223 extern const char *chip_rev_smbios_get(topo_mod_t *, id_t);
224 extern id_t memnode_to_smbiosid(topo_mod_t *, uint16_t, const char *,
225     uint64_t, void *);
226 
227 /*
228  * Prototypes for chip_temp.c
229  */
230 extern int chip_create_chip_temp_sensor(topo_mod_t *, tnode_t *);
231 extern int chip_create_core_temp_sensor(topo_mod_t *, tnode_t *);
232 
233 #ifdef __cplusplus
234 }
235 #endif
236 
237 #endif /* _CHIP_H */
238