1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* or http://www.opensolaris.org/os/licensing.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _MCAMD_API_H
#define _MCAMD_API_H
#pragma ident "%Z%%M% %I% %E% SMI"
/*
* Primary header file for mcamd_* routines in $SRC/common/mc. The
* routines not implemented there are required to be implemented in the
* kernel or userland consumer of this interface (such as the mc-amd driver).
* The common code must use the wrapper functions provided by the consumer
* to navigate the MC tree, get properties etc.
*/
#if defined(_KERNEL)
#include <sys/systm.h>
#include <sys/sunddi.h>
#else
#include <string.h>
#include <assert.h>
#endif
#include <sys/types.h>
#include <sys/mc.h>
#include <sys/mca_amd.h>
#include <sys/mc_amd.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* Consumers of this common code must implement the following types.
*/
typedef struct mcamd_node mcamd_node_t;
struct mcamd_hdl;
/*
* Properties and raw register values for an mcamd_node_t are retrieved via
* mcamd_get_numprop(s) and mcamd_get_cfgreg(s) specifying a property or
* register code below.
*/
typedef uint64_t mcamd_prop_t;
typedef uint32_t mcamd_cfgreg_t;
typedef enum mcamd_propcode {
/*
* Common properties
*/
MCAMD_PROP_NUM = 0x4000,
#define MCAMD_PROPSTR_NUM "num"
MCAMD_PROP_SIZE,
#define MCAMD_PROPSTR_SIZE "size"
MCAMD_PROP_BASE_ADDR,
#define MCAMD_PROPSTR_BASE_ADDR "base-addr"
/*
* Memory controller properties
*/
MCAMD_PROP_REV = 0x5000,
#define MCAMD_PROPSTR_REV "revision"
MCAMD_PROP_LIM_ADDR,
#define MCAMD_PROPSTR_LIM_ADDR "lim-addr"
MCAMD_PROP_ILEN,
#define MCAMD_PROPSTR_ILEN "node-ilen"
MCAMD_PROP_ILSEL,
#define MCAMD_PROPSTR_ILSEL "node-ilsel"
MCAMD_PROP_CSINTLVFCTR,
#define MCAMD_PROPSTR_CSINTLVFCTR "cs-intlv-factor"
MCAMD_PROP_DRAMHOLE_SIZE,
#define MCAMD_PROPSTR_DRAMHOLE_SIZE "dram-hole-size"
MCAMD_PROP_ACCESS_WIDTH,
#define MCAMD_PROPSTR_ACCESS_WIDTH "access-width"
MCAMD_PROP_CSBANKMAPREG,
#define MCAMD_PROPSTR_CSBANKMAPREG "bank-mapping"
MCAMD_PROP_BANKSWZL,
#define MCAMD_PROPSTR_BANKSWZL "bankswizzle"
MCAMD_PROP_MOD64MUX,
#define MCAMD_PROPSTR_MOD64MUX "mismatched-dimm-support"
MCAMD_PROP_SPARECS,
#define MCAMD_PROPSTR_SPARECS "spare-csnum"
MCAMD_PROP_BADCS,
#define MCAMD_PROPSTR_BADCS "bad-csnum"
/*
* Chip-select properties
*/
MCAMD_PROP_MASK = 0x6000,
#define MCAMD_PROPSTR_MASK "mask"
MCAMD_PROP_CSBE,
#define MCAMD_PROPSTR_CSBE "cs-bank-enable"
MCAMD_PROP_SPARE,
#define MCAMD_PROPSTR_SPARE "online-spare"
MCAMD_PROP_TESTFAIL,
#define MCAMD_PROPSTR_TESTFAIL "failed-test"
MCAMD_PROP_CSDIMM1,
#define MCAMD_PROPSTR_CSDIMM1 "dimm1-num"
MCAMD_PROP_CSDIMM2,
#define MCAMD_PROPSTR_CSDIMM2 "dimm2-num"
MCAMD_PROP_DIMMRANK
#define MCAMD_PROPSTR_DIMMRANK "dimm-rank"
} mcamd_propcode_t;
typedef enum mcamd_regcode {
MCAMD_REG_DRAMBASE = 0x7000,
MCAMD_REG_DRAMLIMIT,
MCAMD_REG_DRAMHOLE,
MCAMD_REG_DRAMCFGLO,
MCAMD_REG_DRAMCFGHI,
MCAMD_REG_CSBASE,
MCAMD_REG_CSMASK
} mcamd_regcode_t;
/*
* Flags for mcamd_dprintf
*/
#define MCAMD_DBG_ERR 0x1
#define MCAMD_DBG_FLOW 0x2
typedef union mcamd_dimm_offset_un mcamd_dimm_offset_un_t;
/*
* Offset definition. Encode everything in a single uint64_t, allowing some
* room for growth in numbers of rows/columns/banks in future MC revisions.
* Some consumers will handle this as an opaque uint64 to be passed around,
* while others will want to look inside via the union defined below. Since
* we must support a 32-bit kernel we structure this as two uint32_t.
*/
#define MCAMD_OFFSET_VERSION_0 0x0
#define MCAMD_OFFSET_VERSION MCAMD_OFFSET_VERSION_0
union mcamd_dimm_offset_un {
uint64_t _dou_offset;
struct {
struct {
uint32_t dou_col:20; /* column address */
uint32_t dou_bank:4; /* internal sdram bank number */
uint32_t unused:8;
} lo;
struct {
uint32_t dou_row:20; /* row address */
uint32_t dou_rank:3; /* cs rank on dimm */
uint32_t unused:4;
uint32_t dou_version:4; /* offset encoding version */
uint32_t dou_valid:1; /* set if valid */
} hi;
} _dou_hilo;
};
#define do_offset _dou_offset
#define do_valid _dou_hilo.hi.dou_valid
#define do_version _dou_hilo.hi.dou_version
#define do_rank _dou_hilo.hi.dou_rank
#define do_row _dou_hilo.hi.dou_row
#define do_bank _dou_hilo.lo.dou_bank
#define do_col _dou_hilo.lo.dou_col
/*
* The following work on an offset treated as a uint64_t.
*/
#define MCAMD_RC_OFFSET_VALID(offset) (((uint64_t)(offset) & (1ULL << 63)) != 0)
#define MCAMD_RC_OFFSET_VERSION(offset) (((uint64_t)offset >> 59) & 0xf)
/*
* Value to be used to indicate an invalid offset.
*/
#define MCAMD_RC_INVALID_OFFSET 0x0
/*
* Routines provided by the common mcamd code.
*/
extern const char *mcamd_get_propname(mcamd_propcode_t);
extern int mcamd_patounum(struct mcamd_hdl *, mcamd_node_t *, uint64_t,
uint8_t, uint8_t, uint32_t, int, mc_unum_t *);
extern int mcamd_unumtopa(struct mcamd_hdl *, mcamd_node_t *, mc_unum_t *,
uint64_t *);
extern int mc_pa_to_offset(struct mcamd_hdl *, mcamd_node_t *, mcamd_node_t *,
uint64_t, uint64_t *);
extern int mc_offset_to_pa(struct mcamd_hdl *, mcamd_node_t *, mcamd_node_t *,
uint64_t, uint64_t *);
extern int mcamd_cs_size(struct mcamd_hdl *, mcamd_node_t *, int, size_t *);
extern int mcamd_synd_validate(struct mcamd_hdl *, uint32_t, int);
extern int mcamd_eccsynd_decode(struct mcamd_hdl *, uint32_t, uint_t *);
extern int mcamd_cksynd_decode(struct mcamd_hdl *, uint32_t, uint_t *,
uint_t *);
extern int mcamd_cksym_decode(struct mcamd_hdl *, uint_t, int *, int *,
int *, int *);
extern void *mcamd_set_errno_ptr(struct mcamd_hdl *, int);
extern const char *mcamd_strerror(int);
extern const char *mcamd_errmsg(struct mcamd_hdl *);
/*
* Routines to be provided by wrapper code.
*/
extern mcamd_node_t *mcamd_mc_next(struct mcamd_hdl *, mcamd_node_t *,
mcamd_node_t *);
extern mcamd_node_t *mcamd_cs_next(struct mcamd_hdl *, mcamd_node_t *,
mcamd_node_t *);
extern mcamd_node_t *mcamd_dimm_next(struct mcamd_hdl *, mcamd_node_t *,
mcamd_node_t *);
extern mcamd_node_t *mcamd_cs_mc(struct mcamd_hdl *, mcamd_node_t *);
extern mcamd_node_t *mcamd_dimm_mc(struct mcamd_hdl *, mcamd_node_t *);
extern int mcamd_get_numprop(struct mcamd_hdl *, mcamd_node_t *,
mcamd_propcode_t, mcamd_prop_t *);
extern int mcamd_get_numprops(struct mcamd_hdl *, ...);
extern int mcamd_get_cfgreg(struct mcamd_hdl *, mcamd_node_t *,
mcamd_regcode_t, mcamd_cfgreg_t *);
extern int mcamd_get_cfgregs(struct mcamd_hdl *, ...);
extern int mcamd_errno(struct mcamd_hdl *);
extern int mcamd_set_errno(struct mcamd_hdl *, int);
extern void mcamd_dprintf(struct mcamd_hdl *, int, const char *, ...);
#ifdef __cplusplus
}
#endif
#endif /* _MCAMD_API_H */
|
