i86pc/chip/chip_serial.c

	chip_serial.c revision 88045cff0aae4ed8823cd0989168e8f56927f83e
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/*
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * CDDL HEADER START
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms of the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Common Development and Distribution License (the "License").
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You may not use this file except in compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * or http://www.opensolaris.org/os/licensing.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing permissions
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL HEADER in each
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below this CDDL HEADER, with the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * fields enclosed by brackets "[]" replaced with your own identifying
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * information: Portions Copyright [yyyy] [name of copyright owner]
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * CDDL HEADER END
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/*
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Use is subject to license terms.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#include <stdio.h>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#include <stdlib.h>
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major#include <stdarg.h>
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major#include <string.h>
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major#include <strings.h>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#include <libnvpair.h>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#include <sys/types.h>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#include <libipmi.h>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#include <fm/topo_mod.h>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#include <ctype.h>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#include "chip.h"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#define BUFSZ   128
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#define JEDEC_TBL_SZ    5
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/*
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The following table maps DIMM manufacturer names to a JEDEC ID as sourced
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * from JEDEC publication JEP106W.  This is (obviously) a sparse table which
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * only contains entries for manufacturers whose DIMM's have been qualified
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * for use on Sun platforms.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterstatic const char *jedec_tbl[JEDEC_TBL_SZ][2] =
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster{
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    { "HYUNDAI ELECTRONICS", "00AD" },
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    { "INFINEON", "00C1" },
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    { "MICRON TECHNOLOGY", "002C" },
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    { "QIMONDA", "7F51" },
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    { "SAMSUNG", "00CE" },
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster};
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterstatic int
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosteripmi_serial_lookup(topo_mod_t *mod, char *ipmi_tag, char *buf)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster{
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    char *fru_data;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    int i, found_id = 0, serial_len;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    ipmi_handle_t *hdl;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    ipmi_sdr_fru_locator_t *fru_loc;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    ipmi_fru_prod_info_t prod_info;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    topo_mod_dprintf(mod, "ipmi_serial_lookup() called\n");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    if ((hdl = topo_mod_ipmi_hold(mod)) == NULL) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        topo_mod_dprintf(mod, "Failed to get IPMI handle\n");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return (topo_mod_seterrno(mod, EMOD_UNKNOWN));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    topo_mod_dprintf(mod, "Looking up FRU data for %s ...\n", ipmi_tag);
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major    if ((fru_loc = ipmi_sdr_lookup_fru(hdl, (const char *)ipmi_tag))
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major        == NULL) {
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major        topo_mod_dprintf(mod, "Failed to lookup %s (%s)\n", ipmi_tag,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            ipmi_errmsg(hdl));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        topo_mod_ipmi_rele(mod);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major    topo_mod_dprintf(mod, "Reading FRU data ...\n");
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major    if (ipmi_fru_read(hdl, fru_loc, &fru_data) < 0) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        topo_mod_dprintf(mod, "Failed to read FRU data (%s)\n",
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            ipmi_errmsg(hdl));
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major        topo_mod_ipmi_rele(mod);
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major        return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major    topo_mod_dprintf(mod, "Parsing product info area ...\n");
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major    if (ipmi_fru_parse_product(hdl, fru_data, &prod_info) < 0) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        topo_mod_dprintf(mod, "Failed to read FRU product info (%s)\n",
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major            ipmi_errmsg(hdl));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        free(fru_data);
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major        topo_mod_ipmi_rele(mod);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major    free(fru_data);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    topo_mod_ipmi_rele(mod);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    topo_mod_dprintf(mod, "FRU Product Serial: %s\n",
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        prod_info.ifpi_product_serial);
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major    topo_mod_dprintf(mod, "Manufacturer Name: \"%s\"\n",
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        prod_info.ifpi_manuf_name);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major    serial_len = strnlen(prod_info.ifpi_product_serial, FRU_INFO_MAXLEN);
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major    /*
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major     * Newer ILOM software that has the fix for CR 6607996 will have
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major     * an 18-character serial number that has been synthesized using
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * the recipe from the Sun SPD JEDEC DIMM specification.  If we
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * find an 18-character then we'll simply use it, as-is, and
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major     * return.
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    if (serial_len == 18) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        (void) memcpy(buf, prod_info.ifpi_product_serial, 18);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        *(buf+18) = '\0';
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return (0);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /*
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Older ILOM software that DOESN'T have the fix for CR 6607996 will
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major     * only provide the 8 character manufacturer serial number.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * However, if for some reason the product info area doesn't have the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * serial information or if the serial isn't 8 characters (we may
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major     * encounter SP's that don't populate the serial field or are buggy and
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major     * populate it with garbage), then we'll stop right now and just set the
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major     * buf to an empty string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    if (serial_len != 8) {
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major        *buf = '\0';
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major        return (0);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
882df6887ad52745d38d9bf0d92b3ac6f7703126Peter Major
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /*
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * What follows is a very crude adaptation of the recipe from the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sun SPD JEDEC DIMM specification for synthesizing globally unique
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * serial numbers from the 8 character manufacturer serial number.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * The Sun serial number takes the following form:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * jjjjllyywwssssssss
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * The components are:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * yyyy: JEDEC ID in hex (2 byte manufacture ID, 2 byte continuation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *      code).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * ll:   The memory module's manufacturing location.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * yyww: The module's manufacturing date (2-digit year/2-digit week)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * ssssssss: The 8 character maufacturer serial number
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
    /*
     * First we need to normalize the manufacturer name we pulled out of
     * the FRU product info area.  Our normalization algorithm is fairly
     * simple:
     *   - convert all alpha chars to uppercase
     *   - convert non-alphanumeric characters to a single space
     *
     * We use the normalized name to lookup the JEDEC ID from a static
     * table.  If the FRU area didn't have a manufacturer name or if the ID
     * lookup fails we'll set jjjj to 0000.
     */
    for (i = 0; prod_info.ifpi_manuf_name[i]; i++) {
        prod_info.ifpi_manuf_name[i] =
            toupper(prod_info.ifpi_manuf_name[i]);
        if (!isalpha(prod_info.ifpi_manuf_name[i]) &&
            !isdigit(prod_info.ifpi_manuf_name[i]))
            prod_info.ifpi_manuf_name[i] = (char)0x20;
    }
    topo_mod_dprintf(mod, "Normalized Manufacturer Name \"%s\"\n",
        prod_info.ifpi_manuf_name);

    for (i = 0; i < JEDEC_TBL_SZ; i++)
        if (strcmp(prod_info.ifpi_manuf_name, jedec_tbl[i][0]) == 0) {
            found_id = 1;
            break;
        }

    if (found_id)
        (void) memcpy(buf, jedec_tbl[i][1], 4);
    else
        (void) memcpy(buf, (char *)("0000"), 4);

    /*
     * The manufacturing location and date is not available via IPMI on
     * Sun platforms, so we simply set these six digits to zeros.
     */
    (void) memcpy((buf+4), (char *)("000000"), 6);

    /*
     * Finally, we just copy the 8 character product serial straight over
     * and then NULL terminate the string.
     */
    (void) memcpy((buf+10), prod_info.ifpi_product_serial, 8);
    *(buf+18) = '\0';

    return (0);
}

/* ARGSUSED */
int
get_dimm_serial(topo_mod_t *mod, tnode_t *node, topo_version_t vers,
    nvlist_t *in, nvlist_t **out)
{
    char **entity_refs, fru_serial[FRU_INFO_MAXLEN];
    int err, rv = 0, i;
    uint_t nelems;
    boolean_t found_serial = B_FALSE;

    if (topo_prop_get_string_array(node, TOPO_PGROUP_IPMI, "entity_ref",
        &entity_refs, &nelems, &err) != 0) {
        topo_mod_dprintf(mod, "%s: Failed to lookup entity_ref property"
            " (%s)", __func__, topo_strerror(err));
        return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
    }

    for (i = 0; i < nelems; i++) {
        if (ipmi_serial_lookup(mod, entity_refs[i], fru_serial) == 0) {
            found_serial = B_TRUE;
            break;
        } else
            topo_mod_dprintf(mod, "Failed to lookup serial for "
                "%s\n", entity_refs[i]);
    }
    if (! found_serial)
        (void) strcpy(fru_serial, "");

    if (store_prop_val(mod, fru_serial, "serial", out) != 0) {
        topo_mod_dprintf(mod, "Failed to set serial\n");
        /* topo errno already set */
        rv = -1;
    }
    for (i = 0; i < nelems; i++)
        topo_mod_strfree(mod, entity_refs[i]);
    topo_mod_free(mod, entity_refs, (nelems * sizeof (char *)));

    return (rv);
}