/* * 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 /* * 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 #include #else #include #include #endif #include #include #include #include #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 */