core/command/memory_spd.c

/*
 * Copyright 2012, Google Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *    * Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *    * Redistributions in binary form must reproduce the above
 *      copyright notice, this list of conditions and the following
 *      disclaimer in the documentation and/or other materials provided
 *      with the distribution.
 *    * Neither the name of Google Inc. nor the names of its
 *      contributors may be used to endorse or promote products derived
 *      from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <inttypes.h>

#include "mosys/kv_pair.h"
#include "mosys/log.h"
#include "mosys/output.h"
#include "mosys/platform.h"

#include "lib/nonspd.h"
#include "lib/spd.h"

static int memory_spd_dump_cmd(struct platform_intf *intf,
			       struct platform_cmd *cmd, int argc, char **argv)
{
	struct spd_device *spd;
	uint8_t dimm;

	/* get dimm number from command line */
	if (argc < 1) {
		platform_cmd_usage(cmd);
		errno = EINVAL;
		return -1;
	}

	if (!intf->cb->memory->spd || !intf->cb->memory->spd->read) {
		errno = ENOSYS;
		return -1;
	}

	dimm = (uint8_t) strtoul(argv[0], NULL, 0);

	lprintf(LOG_DEBUG, "memory spd dump %u\n", dimm);

	spd = new_spd_device(intf, dimm);
	if (spd == NULL) {
		lprintf(LOG_ERR, "Failed to read from SPD %u (not present?)\n",
				 dimm);
		return -1;
	}

	print_buffer(&spd->eeprom.data[0], spd->eeprom.length);

	free(spd);
	return 0;
}

static int memory_spd_print_geometry(struct platform_intf *intf, int dimm)
{
	struct kv_pair *kv;
	struct spd_device *spd;
	uint8_t *spd_data;
	int rc;

	if (!intf->cb->memory->spd || !intf->cb->memory->spd->read) {
		errno = ENOSYS;
		return -1;
	}

	kv = kv_pair_new();

	spd = new_spd_device(intf, dimm);
	if (spd == NULL) {
		lprintf(LOG_DEBUG,
			"Failed to read from SPD %u (not present?)\n", dimm);
		return 0;	/* not an error */
	}

	spd_data = &spd->eeprom.data[0];

	kv_pair_fmt(kv, "dimm", "%u", dimm);
	spd_print_field(intf, kv, spd_data, SPD_GET_SIZE);
	spd_print_field(intf, kv, spd_data, SPD_GET_RANKS);
	spd_print_field(intf, kv, spd_data, SPD_GET_WIDTH);

	rc = kv_pair_print(kv);
	kv_pair_free(kv);

	free(spd);
	return rc;
}

static int memory_nonspd_print_geometry(struct platform_intf *intf, int dimm)
{
	struct kv_pair *kv;
	const struct nonspd_mem_info *info;
	int rc;

	if (!intf->cb->memory->nonspd_mem_info) {
		errno = ENOSYS;
		return -1;
	}

	if (intf->cb->memory->nonspd_mem_info(intf, &info) < 0)
		return -1;

	kv = kv_pair_new();

	kv_pair_fmt(kv, "dimm", "%u", dimm);
	nonspd_print_field(kv, info, SPD_GET_SIZE);
	nonspd_print_field(kv, info, SPD_GET_RANKS);
	nonspd_print_field(kv, info, SPD_GET_WIDTH);

	rc = kv_pair_print(kv);
	kv_pair_free(kv);

	return rc;
}

static int memory_spd_print_geometry_cmd(struct platform_intf *intf,
                                         struct platform_cmd *cmd,
                                         int argc, char **argv)
{
	int dimm = 0, last_dimm;

	if (!intf->cb->memory || !intf->cb->memory->dimm_count) {
		errno = ENOSYS;
		return -1;
	}

	last_dimm = intf->cb->memory->dimm_count(intf);

	if (argc) {
		dimm = strtol(argv[0], NULL, 0);
		if ((dimm < 0) || (dimm > (last_dimm - 1))) {
			lprintf(LOG_ERR, "Invalid DIMM: %d\n", dimm);
			errno = EINVAL;
			return -1;
		}
		if (intf->cb->memory->spd)
			memory_spd_print_geometry(intf, dimm);
		else
			memory_nonspd_print_geometry(intf, dimm);
	} else {
		do {
			if (intf->cb->memory->spd)
				memory_spd_print_geometry(intf, dimm);
			else
				memory_nonspd_print_geometry(intf, dimm);
			dimm++;
		} while (dimm < last_dimm);
	}

	return 0;
}

static int memory_spd_print_id(struct platform_intf *intf, int dimm)
{
	struct kv_pair *kv;
	struct spd_device *spd;
	uint8_t *spd_data;
	int rc;

	if (!intf->cb->memory->spd || !intf->cb->memory->spd->read) {
		errno = ENOSYS;
		return -1;
	}

	kv = kv_pair_new();

	spd = new_spd_device(intf, dimm);
	if (spd == NULL) {
		lprintf(LOG_DEBUG,
			"Failed to read from SPD %u (not present?)\n", dimm);
		return 0;	/* not an error */
	}

	spd_data = &spd->eeprom.data[0];

	kv_pair_fmt(kv, "dimm", "%u", dimm);
	spd_print_field(intf, kv, spd_data, SPD_GET_MFG_ID);
	spd_print_field(intf, kv, spd_data, SPD_GET_SERIAL_NUMBER);
	spd_print_field(intf, kv, spd_data, SPD_GET_PART_NUMBER);

	rc = kv_pair_print(kv);
	kv_pair_free(kv);

	free(spd);
	return rc;
}

static int memory_nonspd_print_id(struct platform_intf *intf, int dimm)
{
	struct kv_pair *kv;
	const struct nonspd_mem_info *info;
	int rc;

	if (!intf->cb->memory->nonspd_mem_info) {
		errno = ENOSYS;
		return -1;
	}

	if (intf->cb->memory->nonspd_mem_info(intf, &info) < 0)
		return -1;

	kv = kv_pair_new();

	kv_pair_fmt(kv, "dimm", "%u", dimm);
	nonspd_print_field(kv, info, SPD_GET_MFG_ID);
	nonspd_print_field(kv, info, SPD_GET_SERIAL_NUMBER);
	nonspd_print_field(kv, info, SPD_GET_PART_NUMBER);

	rc = kv_pair_print(kv);
	kv_pair_free(kv);

	return rc;
}

static int memory_spd_print_id_cmd(struct platform_intf *intf,
                                   struct platform_cmd *cmd,
                                   int argc, char **argv)
{
	int dimm = 0, last_dimm;

	if (!intf->cb->memory || !intf->cb->memory->dimm_count) {
		errno = ENOSYS;
		return -1;
	}

	last_dimm = intf->cb->memory->dimm_count(intf);

	if (argc) {
		dimm = strtol(argv[0], NULL, 0);
		if ((dimm < 0) || (dimm > (last_dimm - 1))) {
			lprintf(LOG_ERR, "Invalid DIMM: %d\n", dimm);
			errno = EINVAL;
			return -1;
		}
		if (intf->cb->memory->spd)
			memory_spd_print_id(intf, dimm);
		else
			memory_nonspd_print_id(intf, dimm);
	} else {
		do {
			if (intf->cb->memory->spd)
				memory_spd_print_id(intf, dimm);
			else
				memory_nonspd_print_id(intf, dimm);
			dimm++;
		} while (dimm < last_dimm);
	}

	return 0;
}

static int memory_spd_print_timings(struct platform_intf *intf, int dimm)
{
	struct kv_pair *kv;
	struct spd_device *spd;
	uint8_t *spd_data;
	int rc;

	if (!intf->cb->memory->spd || !intf->cb->memory->spd->read) {
		errno = ENOSYS;
		return -1;
	}

	kv = kv_pair_new();

	spd = new_spd_device(intf, dimm);
	if (spd == NULL) {
		lprintf(LOG_DEBUG,
			"Failed to read from SPD %u (not present?)\n", dimm);
		return 0;	/* not an error */
	}

	spd_data = &spd->eeprom.data[0];

	kv_pair_fmt(kv, "dimm", "%u", dimm);
	spd_print_field(intf, kv, spd_data, SPD_GET_SPEEDS);

	rc = kv_pair_print(kv);
	kv_pair_free(kv);

	free(spd);
	return rc;
}

static int memory_nonspd_print_timings(struct platform_intf *intf, int dimm)
{
	struct kv_pair *kv;
	const struct nonspd_mem_info *info;
	int rc;

	if (!intf->cb->memory->nonspd_mem_info) {
		errno = ENOSYS;
		return -1;
	}

	if (intf->cb->memory->nonspd_mem_info(intf, &info) < 0)
		return -1;

	kv = kv_pair_new();

	kv_pair_fmt(kv, "dimm", "%u", dimm);
	nonspd_print_field(kv, info, SPD_GET_SPEEDS);

	rc = kv_pair_print(kv);
	kv_pair_free(kv);

	return rc;
}

static int memory_spd_print_timings_cmd(struct platform_intf *intf,
                                   struct platform_cmd *cmd,
                                   int argc, char **argv)
{
	int dimm = 0, last_dimm;

	if (!intf->cb->memory || !intf->cb->memory->dimm_count) {
		errno = ENOSYS;
		return -1;
	}

	last_dimm = intf->cb->memory->dimm_count(intf);

	if (argc) {
		dimm = strtol(argv[0], NULL, 0);
		if ((dimm < 0) || (dimm > (last_dimm - 1))) {
			lprintf(LOG_ERR, "Invalid DIMM: %d\n", dimm);
			errno = EINVAL;
			return -1;
		}
		if (intf->cb->memory->spd)
			memory_spd_print_timings(intf, dimm);
		else
			memory_nonspd_print_timings(intf, dimm);
	} else {
		do {
			if (intf->cb->memory->spd)
				memory_spd_print_timings(intf, dimm);
			else
				memory_nonspd_print_timings(intf, dimm);
			dimm++;
		} while (dimm < last_dimm);
	}

	return 0;
}

static int memory_spd_print_type(struct platform_intf *intf, int dimm)
{
	struct kv_pair *kv;
	struct spd_device *spd;
	uint8_t *spd_data;
	int rc;

	if (!intf->cb->memory->spd || !intf->cb->memory->spd->read) {
		errno = ENOSYS;
		return -1;
	}

	kv = kv_pair_new();

	spd = new_spd_device(intf, dimm);
	if (spd == NULL) {
		lprintf(LOG_DEBUG,
			"Failed to read from SPD %u (not present?)\n", dimm);
		return 0;	/* not an error */
	}

	spd_data = &spd->eeprom.data[0];

	kv_pair_fmt(kv, "dimm", "%u", dimm);
	spd_print_field(intf, kv, spd_data, SPD_GET_DRAM_TYPE);
	spd_print_field(intf, kv, spd_data, SPD_GET_MODULE_TYPE);

	rc = kv_pair_print(kv);
	kv_pair_free(kv);

	free(spd);
	return rc;
}

static int memory_nonspd_print_type(struct platform_intf *intf, int dimm)
{
	struct kv_pair *kv;
	const struct nonspd_mem_info *info;
	int rc;

	if (!intf->cb->memory->nonspd_mem_info) {
		errno = ENOSYS;
		return -1;
	}

	if (intf->cb->memory->nonspd_mem_info(intf, &info) < 0)
		return -1;

	kv = kv_pair_new();
	kv_pair_fmt(kv, "dimm", "%u", dimm);
	nonspd_print_field(kv, info, SPD_GET_DRAM_TYPE);
	nonspd_print_field(kv, info, SPD_GET_MODULE_TYPE);

	rc = kv_pair_print(kv);
	kv_pair_free(kv);

	return rc;
}

static int memory_spd_print_type_cmd(struct platform_intf *intf,
                                     struct platform_cmd *cmd,
                                     int argc, char **argv)
{
	int dimm = 0, last_dimm;

	if (!intf->cb->memory || !intf->cb->memory->dimm_count) {
		errno = ENOSYS;
		return -1;
	}

	last_dimm = intf->cb->memory->dimm_count(intf);

	if (argc) {
		dimm = strtol(argv[0], NULL, 0);
		if ((dimm < 0) || (dimm > (last_dimm - 1))) {
			lprintf(LOG_ERR, "Invalid DIMM: %d\n", dimm);
			errno = EINVAL;
			return -1;
		}
		if (intf->cb->memory->spd)
			memory_spd_print_type(intf, dimm);
		else
			memory_nonspd_print_type(intf, dimm);
	} else {
		do {
			if (intf->cb->memory->spd)
				memory_spd_print_type(intf, dimm);
			else
				memory_nonspd_print_type(intf, dimm);
			dimm++;
		} while (dimm < last_dimm);
	}

	return 0;
}

static int memory_spd_print_all_cmd(struct platform_intf *intf,
                                    struct platform_cmd *cmd,
                                    int argc, char **argv)
{
	int rc = 0, dimm;

	if (!intf->cb->memory || !intf->cb->memory->dimm_count) {
		errno = ENOSYS;
		return -1;
	}

	if (argc) {
		dimm = strtol(argv[0], NULL, 0);
		if ((dimm < 0) ||
		    (dimm > (intf->cb->memory->dimm_count(intf) - 1))) {
			lprintf(LOG_ERR, "Invalid DIMM: %d\n", dimm);
			errno = EINVAL;
			return -1;
		}
	}

	rc |= memory_spd_print_type_cmd(intf, cmd, argc, argv);
	rc |= memory_spd_print_id_cmd(intf, cmd, argc, argv);
	rc |= memory_spd_print_geometry_cmd(intf, cmd, argc, argv);
	rc |= memory_spd_print_timings_cmd(intf, cmd, argc, argv);

	return rc;
}

static struct platform_cmd memory_spd_print_cmds[] = {
	{
		.name	= "geometry",
		.desc	= "Print module geometry and capacity",
		.usage	= "<dimm number>",
		.type	= ARG_TYPE_GETTER,
		.arg	= { .func = memory_spd_print_geometry_cmd }
	},
	{
		.name	= "id",
		.desc	= "Print module ID information",
		.usage	= "<dimm number>",
		.type	= ARG_TYPE_GETTER,
		.arg	= { .func = memory_spd_print_id_cmd }
	},
	{
		.name	= "timings",
		.desc	= "Print module timing capabilities",
		.usage	= "<dimm number>",
		.type	= ARG_TYPE_GETTER,
		.arg	= { .func = memory_spd_print_timings_cmd }
	},
	{
		.name	= "type",
		.desc	= "Print module and dram type information",
		.usage	= "<dimm number>",
		.type	= ARG_TYPE_GETTER,
		.arg	= { .func = memory_spd_print_type_cmd }
	},
	{
		.name	= "all",
		.desc	= "Print all of the above",
		.usage	= "<dimm number>",
		.type	= ARG_TYPE_GETTER,
		.arg	= { .func = memory_spd_print_all_cmd }
	},
	{ NULL }
};

struct platform_cmd memory_spd_cmds[] = {
	{
		.name	= "print",
		.desc	= "Print SPD Information",
		.usage	= "<dimm number>",
		.type	= ARG_TYPE_SUB,
		.arg	= { .sub = memory_spd_print_cmds }
	},
	{
		.name	= "dump",
		.desc	= "Dump SPD info as raw binary",
		.usage	= "<dimm number>",
		.type	= ARG_TYPE_GETTER,
		.arg	= { .func = memory_spd_dump_cmd }
	},
	{ NULL }
};