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, Version 1.0 only 6 * (the "License"). You may not use this file except in compliance 7 * with the License. 8 * 9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10 * or http://www.opensolaris.org/os/licensing. 11 * See the License for the specific language governing permissions 12 * and limitations under the License. 13 * 14 * When distributing Covered Code, include this CDDL HEADER in each 15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16 * If applicable, add the following below this CDDL HEADER, with the 17 * fields enclosed by brackets "[]" replaced with your own identifying 18 * information: Portions Copyright [yyyy] [name of copyright owner] 19 * 20 * CDDL HEADER END 21 */ 22 /* 23 * Copyright 2005 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _MEM_H 28 #define _MEM_H 29 30 #pragma ident "%Z%%M% %I% %E% SMI" 31 32 #include <sys/types.h> 33 #include <sys/mdesc.h> 34 35 #ifdef __cplusplus 36 extern "C" { 37 #endif 38 39 /* 40 * FMRI plugin for the `mem' scheme. 41 * 42 * The mem scheme can be used to name individual memory modules, as well as 43 * groups of memory modules, also known as banks. The name `dimm' is used as a 44 * synonym for individual memory modules, for no good reason. Mem FMRIs can 45 * be further refined with the addition of a member which identifies a 46 * particular physical page within the bank or DIMM. The named page is as 47 * viewed by the VM system, and may thus span multiple memory modules. It will, 48 * however, be at least partially contained by the named bank or DIMM. 49 * 50 * Memory modules are identified by two things - their physical position, or 51 * slot, in the machine, and their serial number. DIMMs are identified by this 52 * tuple on platforms which support the retrieval of serial numbers. Platforms 53 * which don't have this support rely on the slot number, with the corresponding 54 * degradation in their ability to detect hardware changees. 55 * 56 * The physical location is embodied by the unum, which is highly specific to 57 * each platform, and bears a passing resemblance to the name of the slot, as 58 * printed on the actual hardware. The unum is mapped to a DIMM-specific 59 * device, which is then read to determine the serial number. See mem_disc.c 60 * for details of the process by which unums are mapped to devices, and 61 * mem_read.c for the code which actually retrieves the serial number from the 62 * device. 63 * 64 * Banks are also identified by unums, which must be broken apart into the 65 * unums which identify each constituent memory module. Serial numbers are 66 * retrieved for banks - one per member module - in the same way as for 67 * individual modules. See mem_unum.c for the code which bursts bank unums. 68 * 69 * Serial number retrieval, on platforms which support it, is very expensive 70 * (on the order of several tenths of a second, which adds up in a hurry on 71 * larger machines). So, while we pre-generate the list of DIMM device paths, 72 * we only read their serial numbers when requested by plugin consumers. To 73 * further reduce the perceived cost, we don't re-read until/unless we detect 74 * that a DR operation has taken place. 75 * 76 * Using the facilities described above, the plugin implements the following 77 * entry points: (see mem.c) 78 * 79 * - nvl2str: The printed representation of the named bank or DIMM is 80 * generated. No attempt is made to determine whether or not the named 81 * item is still present in the system. 82 * 83 * - expand: At the time of this writing, no platforms include bank or DIMM 84 * serial numbers in their ereports. As such, the serial number(s) must 85 * be added by the diagnosis engine. This entry point will read the 86 * serial number(s) for the named item, and will add it/them to the passed 87 * FMRI. Errors will be returned if the FMRI (unum) was unparseable, or if 88 * the serial number could not be retrieved. 89 * 90 * - present: Given a mem-schemed FMRI with a serial number, this entry 91 * point will attempt to determine whether the bank or module named in the 92 * FMRI is still present in the system at the same location. Programmer 93 * errors (invalid FMRIs) will be signalled to the caller. Warnings will 94 * be emitted for otherwise-valid FMRIs whose serial numbers could not be 95 * read, with the caller told that the FMRI is not present. 96 * 97 * - contains: Used to determine whether a given bank contains a given DIMM. 98 * No attempt is made to determine whether the module named by the FMRIs are 99 * actually present in the system. Programmer errors (invalidd FMRIs) will 100 * be returned to the caller. Warnings will be emitted for otherwise-valid 101 * FMRIs whose relationship could not be determined, with the caller told 102 * that there is no relationship. 103 */ 104 105 #define MEM_SERID_MAXLEN 9 /* 8+nul for SPD, 6+nul for SEEPROM */ 106 #define MDESC_PATH "%s/devices/pseudo/mdesc@0:mdesc" 107 #define MDESC_MAXPATHLEN 128 108 109 typedef struct mem_dimm_map { 110 struct mem_dimm_map *dm_next; /* The next DIMM map */ 111 char *dm_label; /* The UNUM for this DIMM */ 112 char *dm_device; /* Path to I2C device for DIMM */ 113 char dm_serid[MEM_SERID_MAXLEN]; /* Cached serial number */ 114 uint64_t dm_drgen; /* DR gen count for cached S/N */ 115 } mem_dimm_map_t; 116 117 typedef struct mem { 118 mem_dimm_map_t *mem_dm; /* List supported DIMMs */ 119 uint64_t mem_memconfig; /* HV memory-configuration-id# */ 120 md_t *mem_mdp; /* pointer to mdesc buffer */ 121 size_t mem_mdbufsz; /* size of mdesc buffer */ 122 } mem_t; 123 124 extern md_t *mdesc_devinit(size_t *); 125 extern int mem_discover(void); 126 extern void mem_destroy(void); 127 128 extern int mem_get_serid(const char *, char *, size_t); 129 130 extern int mem_unum_burst(const char *, char ***, size_t *); 131 extern int mem_unum_contains(const char *, const char *); 132 133 extern void mem_strarray_free(char **, size_t); 134 extern int mem_page_cmd(int, uint64_t); 135 136 extern mem_t mem; 137 138 #ifdef __cplusplus 139 } 140 #endif 141 142 #endif /* _MEM_H */ 143