i86pc/chip/chip_serial.c

	chip_serial.c revision 2cb5535af222653abf2eba5c180ded4a7b85d8b6
/*
 * 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 2008 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#pragma ident   "%Z%%M% %I% %E% SMI"

#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <strings.h>
#include <libnvpair.h>
#include <sys/types.h>
#include <libipmi.h>
#include <fm/topo_mod.h>
#include <ctype.h>
#include "chip.h"

#define BUFSZ   128
#define JEDEC_TBL_SZ    4

/*
 * The following table maps DIMM manufacturer names to a JEDEC ID as sourced
 * from JEDEC publication JEP106W.  This is (obviously) a sparse table which
 * only contains entries for manufacturers whose DIMM's have been qualified
 * for use on Sun platforms.
 */
static const char *jedec_tbl[JEDEC_TBL_SZ][2] =
{
    { "INFINEON", "00C1" },
    { "MICRON TECHNOLOGY", "002C" },
    { "QIMONDA", "7F51" },
    { "SAMSUNG", "00CE" },
};

static int
ipmi_serial_lookup(topo_mod_t *mod, char *ipmi_tag, char *buf)
{
    char *fru_data;
    int i, found_id = 0, serial_len;
    ipmi_handle_t *hdl;
    ipmi_sdr_fru_locator_t *fru_loc;
    ipmi_fru_prod_info_t prod_info;

    topo_mod_dprintf(mod, "ipmi_serial_lookup() called\n");
    if ((hdl = topo_mod_ipmi(mod)) == NULL) {
        topo_mod_dprintf(mod, "Failed to get IPMI handle\n");
        return (topo_mod_seterrno(mod, EMOD_UNKNOWN));
    }

    topo_mod_dprintf(mod, "Looking up FRU data for %s ...\n", ipmi_tag);
    if ((fru_loc = ipmi_sdr_lookup_fru(hdl, (const char *)ipmi_tag))
        == NULL) {
        topo_mod_dprintf(mod, "Failed to lookup %s (%s)\n", ipmi_tag,
            ipmi_errmsg(hdl));
        return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
    }


    topo_mod_dprintf(mod, "Reading FRU data ...\n");
    if (ipmi_fru_read(hdl, fru_loc, &fru_data) < 0) {
        topo_mod_dprintf(mod, "Failed to read FRU data (%s)\n",
            ipmi_errmsg(hdl));
        return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
    }

    topo_mod_dprintf(mod, "Parsing product info area ...\n");
    if (ipmi_fru_parse_product(hdl, fru_data, &prod_info) < 0) {
        topo_mod_dprintf(mod, "Failed to read FRU product info (%s)\n",
            ipmi_errmsg(hdl));
        free(fru_data);
        return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
    }
    free(fru_data);

    topo_mod_dprintf(mod, "FRU Product Serial: %s\n",
        prod_info.ifpi_product_serial);
    topo_mod_dprintf(mod, "Manufacturer Name: \"%s\"\n",
        prod_info.ifpi_manuf_name);

    serial_len = strnlen(prod_info.ifpi_product_serial, FRU_INFO_MAXLEN);

    /*
     * Newer ILOM software that has the fix for CR 6607996 will have
     * an 18-character serial number that has been synthesized using
     * the recipe from the Sun SPD JEDEC DIMM specification.  If we
     * find an 18-character then we'll simply use it, as-is, and
     * return.
     */
    if (serial_len == 18) {
        (void) memcpy(buf, prod_info.ifpi_product_serial, 18);
        *(buf+18) = '\0';
        return (0);
    }
    /*
     * Older ILOM software that DOESN'T have the fix for CR 6607996 will
     * only provide the 8 character manufacturer serial number.
     *
     * However, if for some reason the product info area doesn't have the
     * serial information or if the serial isn't 8 characters (we may
     * encounter SP's that don't populate the serial field or are buggy and
     * populate it with garbage), then we'll stop right now and just set the
     * buf to an empty string.
     */
    if (serial_len != 8) {
        *buf = '\0';
        return (0);
    }

    /*
     * What follows is a very crude adaptation of the recipe from the
     * Sun SPD JEDEC DIMM specification for synthesizing globally unique
     * serial numbers from the 8 character manufacturer serial number.
     *
     * The Sun serial number takes the following form:
     *
     * jjjjllyywwssssssss
     *
     * The components are:
     *
     * yyyy: JEDEC ID in hex (2 byte manufacture ID, 2 byte continuation
     *      code).
     *
     * ll:   The memory module's manufacturing location.
     *
     * yyww: The module's manufacturing date (2-digit year/2-digit week)
     *
     * ssssssss: The 8 character maufacturer serial number
     */
    /*
     * 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 *fmtstr, ipmi_tag[BUFSZ], fru_serial[FRU_INFO_MAXLEN];
    tnode_t *chip;
    int ret;
    uint32_t offset;
    nvlist_t *args;

    topo_mod_dprintf(mod, "get_dimm_serial() called\n");
    if ((ret = nvlist_lookup_nvlist(in, "args", &args)) != 0) {
        topo_mod_dprintf(mod, "Failed to lookup 'args' list (%s)\n",
            strerror(ret));
        return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
    }
    if ((ret = nvlist_lookup_uint32(args, "offset", &offset)) != 0) {
        topo_mod_dprintf(mod, "Failed to lookup 'offset' arg (%s)\n",
            strerror(ret));
        return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
    }
    if ((fmtstr = get_fmtstr(mod, in)) == NULL) {
        /* topo errno set */
        topo_mod_dprintf(mod, "Failed to retrieve format arg\n");
        return (-1);
    }

    chip = topo_node_parent(topo_node_parent(node));

    /* LINTED: E_SEC_PRINTF_VAR_FMT */
    (void) snprintf(ipmi_tag, BUFSZ, fmtstr, topo_node_instance(chip),
        (topo_node_instance(node) + offset));

    if (ipmi_serial_lookup(mod, ipmi_tag, fru_serial) != 0) {
        topo_mod_dprintf(mod, "Failed to lookup serial for %s\n",
            ipmi_tag);
        (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 */
        return (-1);
    }
    return (0);
}