xref: /illumos-gate/usr/src/lib/fm/topo/modules/common/ipmi/ipmi_methods.c (revision e5dcf7beb7c949f9234713d5818b581ec3825443)
12eeaed14Srobj /*
22eeaed14Srobj  * CDDL HEADER START
32eeaed14Srobj  *
42eeaed14Srobj  * The contents of this file are subject to the terms of the
52eeaed14Srobj  * Common Development and Distribution License (the "License").
62eeaed14Srobj  * You may not use this file except in compliance with the License.
72eeaed14Srobj  *
82eeaed14Srobj  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
92eeaed14Srobj  * or http://www.opensolaris.org/os/licensing.
102eeaed14Srobj  * See the License for the specific language governing permissions
112eeaed14Srobj  * and limitations under the License.
122eeaed14Srobj  *
132eeaed14Srobj  * When distributing Covered Code, include this CDDL HEADER in each
142eeaed14Srobj  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
152eeaed14Srobj  * If applicable, add the following below this CDDL HEADER, with the
162eeaed14Srobj  * fields enclosed by brackets "[]" replaced with your own identifying
172eeaed14Srobj  * information: Portions Copyright [yyyy] [name of copyright owner]
182eeaed14Srobj  *
192eeaed14Srobj  * CDDL HEADER END
202eeaed14Srobj  */
212eeaed14Srobj 
222eeaed14Srobj /*
23*e5dcf7beSRobert Johnston  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
242eeaed14Srobj  * Use is subject to license terms.
252eeaed14Srobj  */
262eeaed14Srobj 
272eeaed14Srobj #include <stdio.h>
282eeaed14Srobj #include <stdlib.h>
292eeaed14Srobj #include <stdarg.h>
302eeaed14Srobj #include <string.h>
312eeaed14Srobj #include <strings.h>
322eeaed14Srobj #include <libnvpair.h>
332eeaed14Srobj #include <sys/types.h>
342eeaed14Srobj #include <fm/topo_mod.h>
352eeaed14Srobj 
362eeaed14Srobj #define	BUFSZ	128
372eeaed14Srobj 
382eeaed14Srobj static char *
392eeaed14Srobj get_fmtstr(topo_mod_t *mod, nvlist_t *in)
402eeaed14Srobj {
412eeaed14Srobj 	char *fmtstr;
422eeaed14Srobj 	nvlist_t *args;
432eeaed14Srobj 	int ret;
442eeaed14Srobj 
452eeaed14Srobj 	topo_mod_dprintf(mod, "get_fmtstr() called\n");
462eeaed14Srobj 
472eeaed14Srobj 	if ((ret = nvlist_lookup_nvlist(in, TOPO_PROP_ARGS, &args)) != 0) {
482eeaed14Srobj 		topo_mod_dprintf(mod, "Failed to lookup 'args' list (%s)\n",
492eeaed14Srobj 		    strerror(ret));
502eeaed14Srobj 		(void) topo_mod_seterrno(mod, EMOD_NVL_INVAL);
512eeaed14Srobj 		return (NULL);
522eeaed14Srobj 	}
532eeaed14Srobj 	if ((ret = nvlist_lookup_string(args, "format", &fmtstr)) != 0) {
542eeaed14Srobj 		topo_mod_dprintf(mod, "Failed to lookup 'format' arg (%s)\n",
552eeaed14Srobj 		    strerror(ret));
562eeaed14Srobj 		(void) topo_mod_seterrno(mod, EMOD_NVL_INVAL);
572eeaed14Srobj 		return (NULL);
582eeaed14Srobj 	}
592eeaed14Srobj 	return (fmtstr);
602eeaed14Srobj }
612eeaed14Srobj 
622eeaed14Srobj static int
632eeaed14Srobj store_prop_val(topo_mod_t *mod, void *buf, char *propname, topo_type_t type,
642eeaed14Srobj     nvlist_t **out)
652eeaed14Srobj {
662eeaed14Srobj 	if (topo_mod_nvalloc(mod, out, NV_UNIQUE_NAME) != 0) {
672eeaed14Srobj 		topo_mod_dprintf(mod, "Failed to allocate 'out' nvlist\n");
682eeaed14Srobj 		return (topo_mod_seterrno(mod, EMOD_NOMEM));
692eeaed14Srobj 	}
702eeaed14Srobj 	if (nvlist_add_string(*out, TOPO_PROP_VAL_NAME, propname) != 0) {
712eeaed14Srobj 		topo_mod_dprintf(mod, "Failed to set '%s'\n",
722eeaed14Srobj 		    TOPO_PROP_VAL_NAME);
732eeaed14Srobj 		nvlist_free(*out);
742eeaed14Srobj 		return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
752eeaed14Srobj 	}
762eeaed14Srobj 	if (nvlist_add_uint32(*out, TOPO_PROP_VAL_TYPE, type)
772eeaed14Srobj 	    != 0) {
782eeaed14Srobj 		topo_mod_dprintf(mod, "Failed to set '%s'\n",
792eeaed14Srobj 		    TOPO_PROP_VAL_TYPE);
802eeaed14Srobj 		nvlist_free(*out);
812eeaed14Srobj 		return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
822eeaed14Srobj 	}
832eeaed14Srobj 	if (type == TOPO_TYPE_STRING) {
842eeaed14Srobj 		if (nvlist_add_string(*out, TOPO_PROP_VAL_VAL, (char *)buf)
852eeaed14Srobj 		    != 0) {
862eeaed14Srobj 			topo_mod_dprintf(mod, "Failed to set '%s'\n",
872eeaed14Srobj 			    TOPO_PROP_VAL_VAL);
882eeaed14Srobj 			nvlist_free(*out);
892eeaed14Srobj 			return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
902eeaed14Srobj 		}
91*e5dcf7beSRobert Johnston 	} else if (type == TOPO_TYPE_FMRI) {
922eeaed14Srobj 		if (nvlist_add_nvlist(*out, TOPO_PROP_VAL_VAL, (nvlist_t *)buf)
932eeaed14Srobj 		    != 0) {
942eeaed14Srobj 			topo_mod_dprintf(mod, "Failed to set '%s'\n",
952eeaed14Srobj 			    TOPO_PROP_VAL_VAL);
962eeaed14Srobj 			nvlist_free(*out);
972eeaed14Srobj 			return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
982eeaed14Srobj 		}
99*e5dcf7beSRobert Johnston 	} else if (type == TOPO_TYPE_UINT32) {
100*e5dcf7beSRobert Johnston 		if (nvlist_add_uint32(*out, TOPO_PROP_VAL_VAL, *(uint32_t *)buf)
101*e5dcf7beSRobert Johnston 		    != 0) {
102*e5dcf7beSRobert Johnston 			topo_mod_dprintf(mod, "Failed to set '%s'\n",
103*e5dcf7beSRobert Johnston 			    TOPO_PROP_VAL_VAL);
104*e5dcf7beSRobert Johnston 			nvlist_free(*out);
105*e5dcf7beSRobert Johnston 			return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
106*e5dcf7beSRobert Johnston 		}
107*e5dcf7beSRobert Johnston 	}
1082eeaed14Srobj 	return (0);
1092eeaed14Srobj }
1102eeaed14Srobj 
1112eeaed14Srobj /*
1122eeaed14Srobj  * This is a somewhat generic property method for labelling the PSU and fan
1132eeaed14Srobj  * FRU's that we're enumerating.  It takes the following three arguments:
1142eeaed14Srobj  *
1152eeaed14Srobj  * format:	a string containing a printf-like format with a two %d tokens
1162eeaed14Srobj  *              for the cpu and dimm slot label numbers, which this method
1172eeaed14Srobj  *              computes
1182eeaed14Srobj  *
1192eeaed14Srobj  *              i.e.: Fan %d
1202eeaed14Srobj  *
1212eeaed14Srobj  * offset:      a numeric offset that we'll number the FRU's from.  This is to
1222eeaed14Srobj  *              allow for the fact that some systems may number the FRU's
1232eeaed14Srobj  *              from zero while others may start from one
1242eeaed14Srobj  */
1252eeaed14Srobj /* ARGSUSED */
1262eeaed14Srobj int
1272eeaed14Srobj ipmi_fru_label(topo_mod_t *mod, tnode_t *node, topo_version_t vers,
1282eeaed14Srobj     nvlist_t *in, nvlist_t **out)
1292eeaed14Srobj {
1302eeaed14Srobj 	char *fmtstr, buf[BUFSZ];
1312eeaed14Srobj 	int ret;
1322eeaed14Srobj 	uint32_t offset;
1332eeaed14Srobj 	nvlist_t *args;
1342eeaed14Srobj 
1352eeaed14Srobj 	topo_mod_dprintf(mod, "ipmi_fru_label() called\n");
1362eeaed14Srobj 	if ((ret = nvlist_lookup_nvlist(in, TOPO_PROP_ARGS, &args)) != 0) {
1372eeaed14Srobj 		topo_mod_dprintf(mod, "Failed to lookup 'args' list (%s)\n",
1382eeaed14Srobj 		    strerror(ret));
1392eeaed14Srobj 		return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
1402eeaed14Srobj 	}
1412eeaed14Srobj 	if ((ret = nvlist_lookup_uint32(args, "offset", &offset)) != 0) {
1422eeaed14Srobj 		topo_mod_dprintf(mod, "Failed to lookup 'offset' arg (%s)\n",
1432eeaed14Srobj 		    strerror(ret));
1442eeaed14Srobj 		return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
1452eeaed14Srobj 	}
1462eeaed14Srobj 
1472eeaed14Srobj 	if ((fmtstr = get_fmtstr(mod, in)) == NULL) {
1482eeaed14Srobj 		topo_mod_dprintf(mod, "Failed to retrieve 'format' arg\n");
1492eeaed14Srobj 		/* topo errno already set */
1502eeaed14Srobj 		return (-1);
1512eeaed14Srobj 	}
1522eeaed14Srobj 
1532eeaed14Srobj 	/* LINTED: E_SEC_PRINTF_VAR_FMT */
1542eeaed14Srobj 	(void) snprintf(buf, BUFSZ, fmtstr,
1552eeaed14Srobj 	    (topo_node_instance(node) + offset));
1562eeaed14Srobj 
1572eeaed14Srobj 	if (store_prop_val(mod, (void *)buf, "label", TOPO_TYPE_STRING, out)
1582eeaed14Srobj 	    != 0) {
1592eeaed14Srobj 		topo_mod_dprintf(mod, "Failed to set label\n");
1602eeaed14Srobj 		/* topo errno already set */
1612eeaed14Srobj 		return (-1);
1622eeaed14Srobj 	}
1632eeaed14Srobj 
1642eeaed14Srobj 	return (0);
1652eeaed14Srobj }
1662eeaed14Srobj /*
1672eeaed14Srobj  * This is a somewhat generic property method for attaching a FRU fmri onto
1682eeaed14Srobj  * a power supply or fan based on the assumption that the FRU will either be
1692eeaed14Srobj  * the fan/psu itself or the parent node.
1702eeaed14Srobj  *
1712eeaed14Srobj  * entity:	either "self" or "parent"
1722eeaed14Srobj  */
1732eeaed14Srobj /* ARGSUSED */
1742eeaed14Srobj int
1752eeaed14Srobj ipmi_fru_fmri(topo_mod_t *mod, tnode_t *node, topo_version_t vers,
1762eeaed14Srobj     nvlist_t *in, nvlist_t **out)
1772eeaed14Srobj {
1782eeaed14Srobj 	char *entity;
1792eeaed14Srobj 	int ret, err;
1802eeaed14Srobj 	nvlist_t *args, *fru;
1812eeaed14Srobj 
1822eeaed14Srobj 	topo_mod_dprintf(mod, "ipmi_fru_fmri() called\n");
1832eeaed14Srobj 	if ((ret = nvlist_lookup_nvlist(in, TOPO_PROP_ARGS, &args)) != 0) {
1842eeaed14Srobj 		topo_mod_dprintf(mod, "Failed to lookup 'args' list (%s)\n",
1852eeaed14Srobj 		    strerror(ret));
1862eeaed14Srobj 		return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
1872eeaed14Srobj 	}
1882eeaed14Srobj 	if ((ret = nvlist_lookup_string(args, "entity", &entity)) != 0) {
1892eeaed14Srobj 		topo_mod_dprintf(mod, "Failed to lookup 'entity' arg (%s)\n",
1902eeaed14Srobj 		    strerror(ret));
1912eeaed14Srobj 		return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
1922eeaed14Srobj 	}
1932eeaed14Srobj 
1942eeaed14Srobj 	if (strcasecmp(entity, "self") == 0) {
1952eeaed14Srobj 		if (topo_node_resource(node, &fru, &err) != 0)
1962eeaed14Srobj 			return (-1);
1972eeaed14Srobj 	} else if (strcasecmp(entity, "parent") == 0) {
1982eeaed14Srobj 		if (topo_node_resource(topo_node_parent(node), &fru, &err) != 0)
1992eeaed14Srobj 			return (-1);
2002eeaed14Srobj 	} else {
2012eeaed14Srobj 		topo_mod_dprintf(mod, "Invalid 'entity' value\n");
2022eeaed14Srobj 		return (topo_mod_seterrno(mod, EMOD_NVL_INVAL));
2032eeaed14Srobj 	}
2042eeaed14Srobj 
2052eeaed14Srobj 	if (store_prop_val(mod, (void *)fru, "FRU", TOPO_TYPE_FMRI, out) != 0) {
2062eeaed14Srobj 		nvlist_free(fru);
2072eeaed14Srobj 		topo_mod_dprintf(mod, "Failed to set FRU\n");
2082eeaed14Srobj 		/* topo errno already set */
2092eeaed14Srobj 		return (-1);
2102eeaed14Srobj 	}
2112eeaed14Srobj 
2122eeaed14Srobj 	nvlist_free(fru);
2132eeaed14Srobj 
2142eeaed14Srobj 	return (0);
2152eeaed14Srobj }
216