diff --git a/doc/nvme.md b/doc/nvme.md index a671eb6d1..9ef0cb3cc 100644 --- a/doc/nvme.md +++ b/doc/nvme.md @@ -10,6 +10,7 @@ - @ref nvme_multi_process - @ref nvme_hotplug - @ref nvme_cuse +- @ref nvme_led ## Introduction {#nvme_intro} @@ -406,3 +407,12 @@ with SPDK NVMe CUSE. SCSI to NVMe Translation Layer is not implemented. Tools that are using this layer to identify, manage or operate device might not work properly or their use may be limited. + +## NVMe LED management {#nvme_led} + +It is possible to use the ledctl(8) utility to control the state of LEDs in systems supporting +NPEM (Native PCIe Enclosure Management), even when the NVMe devices are controlled by SPDK. +However, in this case it is necessary to determine the slot device number because the block device +is unavailable. The [ledctl.sh](https://github.com/spdk/spdk/tree/master/scripts/ledctl.sh) script +can be used to help with this. It takes the name of the nvme bdev and invokes ledctl with +appropriate options. diff --git a/scripts/ledctl.sh b/scripts/ledctl.sh new file mode 100755 index 000000000..882a13aa5 --- /dev/null +++ b/scripts/ledctl.sh @@ -0,0 +1,79 @@ +#!/usr/bin/env bash +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (C) 2023 Intel Corporation +# All rights reserved. + +usage() { + echo "Control LED on an NVMe bdev with NPEM capability." + echo "Usage: $(basename $0) [BDEV_NAME] [LED_STATE]" + echo "" + echo "BDEV_NAME: The name of the SPDK NVMe bdev." + echo "LED_STATE: The desired state of the LED. If omitted, the current state will be shown." + echo " Consult ledctl documentation for a list of supported states." +} + +if [[ "$#" -lt 1 || "$#" -gt 2 ]]; then + usage + exit 1 +fi + +if ! command -v "ledctl" > /dev/null 2>&1; then + echo "ERROR: ledctl is not found." >&2 + exit 1 +fi + +if ! ledctl --help | grep -q -- "--set-slot"; then + echo "ERROR: The installed version of ledctl does not support the --set-slot command." >&2 + exit 1 +fi + +scriptdir=$(dirname $0) +bdev_name=$1 +led_state=$2 + +# Find the PCI address of the nvme bdev +if ! bdev_info=$($scriptdir/rpc.py bdev_get_bdevs -b $bdev_name | jq -r '.[0]' 2> /dev/null); then + echo "ERROR: bdev $bdev_name not found." >&2 + exit 1 +fi + +nvme_info=$(echo $bdev_info | jq -r '.driver_specific["nvme"] | select(.)') +if [ -z "$nvme_info" ]; then + echo "ERROR: $bdev_name is not an nvme bdev." >&2 + exit 1 +fi + +nvme_pci_addr=$(echo $nvme_info | jq -r '.[0].pci_address | select(.)') +if [ -z "$nvme_pci_addr" ]; then + echo "ERROR: $bdev_name pci address unknown." >&2 + exit 1 +fi + +# Get a list of slots recognized by ledctl +npem_slots=$(ledctl -P -c NPEM 2> /dev/null | awk '{print $2}') + +# Get the slot that the nvme device is attached to +devpath=$(realpath --relative-to=/sys/devices /sys/bus/pci/devices/$nvme_pci_addr) + +while [ "$devpath" != "." ]; do + dev=$(basename $devpath) + + if echo $npem_slots | grep -wq $dev; then + slot=$dev + break + fi + + devpath=$(dirname $devpath) +done + +if [ -z "$slot" ]; then + echo "ERROR: $bdev_name not recognized by ledctl as NPEM-capable." >&2 + exit 1 +fi + +# Pass the slot to ledctl +if [ -z "$led_state" ]; then + ledctl -G -c NPEM -p $slot +else + ledctl -S -c NPEM -p $slot -s $led_state +fi