examples/vmd/led: LED management app

Added application allowing for probing and changing the state of the
LEDs of the devices behind the VMD.

Change-Id: I6c513c556d8e3de8ecf9b5783d7c66ac3b9c6a71
Signed-off-by: orden smith <orden.e.smith@intel.com>
Signed-off-by: Konrad Sztyber <konrad.sztyber@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/470652
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Wojciech Malikowski <wojciech.malikowski@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
This commit is contained in:
Konrad Sztyber 2019-10-04 13:14:59 +02:00 committed by Jim Harris
parent 6d2ba25561
commit 7135856e6d
4 changed files with 258 additions and 1 deletions

View File

@ -34,7 +34,7 @@
SPDK_ROOT_DIR := $(abspath $(CURDIR)/../..)
include $(SPDK_ROOT_DIR)/mk/spdk.common.mk
DIRS-y += lsvmd
DIRS-y += lsvmd led
.PHONY: all clean $(DIRS-y)

1
examples/vmd/led/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
led

44
examples/vmd/led/Makefile Normal file
View File

@ -0,0 +1,44 @@
#
# BSD LICENSE
#
# Copyright (c) Intel Corporation.
# 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 Intel Corporation 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.
#
SPDK_ROOT_DIR := $(abspath $(CURDIR)/../../..)
include $(SPDK_ROOT_DIR)/mk/spdk.common.mk
include $(SPDK_ROOT_DIR)/mk/spdk.modules.mk
APP = led
C_SRCS := led.c
SPDK_LIB_LIST = vmd log
include $(SPDK_ROOT_DIR)/mk/spdk.app.mk

212
examples/vmd/led/led.c Normal file
View File

@ -0,0 +1,212 @@
/*-
* BSD LICENSE
*
* Copyright (c) Intel Corporation.
* 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 Intel Corporation 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 "spdk/stdinc.h"
#include "spdk/log.h"
#include "spdk/likely.h"
#include "spdk/env.h"
#include "spdk/vmd.h"
enum app_action {
APP_ACTION_SET,
APP_ACTION_GET,
APP_ACTION_NOP,
};
struct app_opts {
const char *app_name;
struct spdk_pci_addr pci_addr;
bool all_devices;
enum app_action action;
enum spdk_vmd_led_state led_state;
};
struct app_opts g_opts = {
.all_devices = true,
.action = APP_ACTION_GET,
.led_state = SPDK_VMD_LED_STATE_UNKNOWN,
};
static const char *g_led_states[] = {
[SPDK_VMD_LED_STATE_OFF] = "off",
[SPDK_VMD_LED_STATE_IDENTIFY] = "identify",
[SPDK_VMD_LED_STATE_FAULT] = "fault",
[SPDK_VMD_LED_STATE_REBUILD] = "rebuild",
[SPDK_VMD_LED_STATE_UNKNOWN] = "unknown",
};
static void
usage(void)
{
printf("Usage: %s [-d] [-s STATE] [-r TRADDR]\n", g_opts.app_name);
printf("\n");
printf("Options:\n");
printf(" -d enables debug logs from the VMD module\n");
printf(" -s STATE sets the state of the LEDs. Available states are:\n");
printf(" off, identify, fault, rebuild\n");
printf(" -r TRADDR uses device identified by TRADDR\n");
printf(" -h shows this help\n");
}
static int
parse_args(int argc, char **argv)
{
int led_state;
int op;
g_opts.app_name = argv[0];
while ((op = getopt(argc, argv, "dhr:s:")) != -1) {
switch (op) {
case 'r':
if (spdk_pci_addr_parse(&g_opts.pci_addr, optarg)) {
fprintf(stderr, "Unable to parse PCI address: %s\n", optarg);
return -EINVAL;
}
g_opts.all_devices = false;
break;
case 'd':
#ifdef DEBUG
spdk_log_set_print_level(SPDK_LOG_DEBUG);
spdk_log_set_flag("vmd");
break;
#else
fprintf(stderr, "%s must be rebuilt with --enable-debug for the -d flag\n",
argv[0]);
return -EINVAL;
#endif
case 's':
for (led_state = SPDK_VMD_LED_STATE_OFF;
led_state <= SPDK_VMD_LED_STATE_REBUILD;
led_state++) {
if (strcmp(optarg, g_led_states[led_state]) == 0) {
g_opts.led_state = (enum spdk_vmd_led_state)led_state;
break;
}
}
if (g_opts.led_state == SPDK_VMD_LED_STATE_UNKNOWN) {
fprintf(stderr, "Invalid LED state\n");
return -EINVAL;
}
g_opts.action = APP_ACTION_SET;
break;
case 'h':
g_opts.action = APP_ACTION_NOP;
usage();
break;
default:
return -EINVAL;
}
}
return 0;
}
int
main(int argc, char **argv)
{
struct spdk_env_opts opts;
struct spdk_pci_device *pci_device;
enum spdk_vmd_led_state led_state;
char addr_buf[128];
int rc, status = 0;
if (parse_args(argc, argv) != 0) {
usage();
return 1;
}
if (g_opts.action == APP_ACTION_NOP) {
return 0;
}
spdk_env_opts_init(&opts);
opts.name = "led";
if (spdk_env_init(&opts) < 0) {
fprintf(stderr, "Unable to initialize SPDK environment\n");
return 1;
}
rc = spdk_vmd_init();
if (rc) {
fprintf(stderr, "Unable to initialize VMD subsystem\n");
return 1;
}
for (pci_device = spdk_pci_get_first_device(); pci_device != NULL;
pci_device = spdk_pci_get_next_device(pci_device)) {
if (strcmp(spdk_pci_device_get_type(pci_device), "vmd") != 0) {
continue;
}
if (!g_opts.all_devices &&
spdk_pci_addr_compare(&g_opts.pci_addr, &pci_device->addr) != 0) {
continue;
}
rc = spdk_pci_addr_fmt(addr_buf, sizeof(addr_buf), &pci_device->addr);
if (rc != 0) {
fprintf(stderr, "Failed to format VMD's PCI address\n");
status = 1;
break;
}
if (g_opts.action == APP_ACTION_GET) {
rc = spdk_vmd_get_led_state(pci_device, &led_state);
if (spdk_unlikely(rc != 0)) {
fprintf(stderr, "Failed to retrieve the state of the LED on %s\n",
addr_buf);
status = 1;
break;
}
printf("%s: %s\n", addr_buf, g_led_states[led_state]);
} else {
rc = spdk_vmd_set_led_state(pci_device, g_opts.led_state);
if (spdk_unlikely(rc != 0)) {
fprintf(stderr, "Failed to set LED state on %s\n", addr_buf);
status = 1;
break;
}
}
}
return status;
}