a6dbe3721e
per Intel policy to include file commit date using git cmd below. The policy does not apply to non-Intel (C) notices. git log --follow -C90% --format=%ad --date default <file> | tail -1 and then pull just the 4 digit year from the result. Intel copyrights were not added to files where Intel either had no contribution ot the contribution lacked substance (ie license header updates, formatting changes, etc). Contribution date used "--follow -C95%" to get the most accurate date. Note that several files in this patch didn't end the license/(c) block with a blank comment line so these were added as the vast majority of files do have this last blank line. Simply there for consistency. Signed-off-by: paul luse <paul.e.luse@intel.com> Change-Id: Id5b7ce4f658fe87132f14139ead58d6e285c04d4 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/15192 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Community-CI: Mellanox Build Bot
106 lines
2.7 KiB
C
106 lines
2.7 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright (C) 2019 Intel Corporation.
|
|
* All rights reserved.
|
|
*/
|
|
|
|
/** \file
|
|
* VMD driver public interface
|
|
*/
|
|
|
|
#ifndef SPDK_VMD_H
|
|
#define SPDK_VMD_H
|
|
|
|
#include "spdk/stdinc.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include "spdk/env.h"
|
|
|
|
/* Maximum VMD devices - up to 6 per cpu */
|
|
#define MAX_VMD_TARGET 24
|
|
|
|
/**
|
|
* Enumerate VMD devices and hook them into the spdk pci subsystem
|
|
*
|
|
* \return 0 on success, -1 on failure
|
|
*/
|
|
int spdk_vmd_init(void);
|
|
|
|
/**
|
|
* Release any resources allocated by the VMD library via spdk_vmd_init().
|
|
*/
|
|
void spdk_vmd_fini(void);
|
|
|
|
/**
|
|
* Returns a list of nvme devices found on the given vmd pci BDF.
|
|
*
|
|
* \param vmd_addr pci BDF of the vmd device to return end device list
|
|
* \param nvme_list buffer of exactly MAX_VMD_TARGET to return spdk_pci_device array.
|
|
*
|
|
* \return Returns count of nvme device attached to input VMD.
|
|
*/
|
|
int spdk_vmd_pci_device_list(struct spdk_pci_addr vmd_addr, struct spdk_pci_device *nvme_list);
|
|
|
|
/** State of the LEDs */
|
|
enum spdk_vmd_led_state {
|
|
SPDK_VMD_LED_STATE_OFF,
|
|
SPDK_VMD_LED_STATE_IDENTIFY,
|
|
SPDK_VMD_LED_STATE_FAULT,
|
|
SPDK_VMD_LED_STATE_REBUILD,
|
|
SPDK_VMD_LED_STATE_UNKNOWN,
|
|
};
|
|
|
|
/**
|
|
* Sets the state of the LED on specified PCI device. The device needs to be behind VMD.
|
|
*
|
|
* \param pci_device PCI device
|
|
* \param state LED state to set
|
|
*
|
|
* \return 0 on success, negative errno otherwise
|
|
*/
|
|
int spdk_vmd_set_led_state(struct spdk_pci_device *pci_device, enum spdk_vmd_led_state state);
|
|
|
|
/**
|
|
* Retrieves the state of the LED on specified PCI device. The device needs to be behind VMD.
|
|
*
|
|
* \param pci_device PCI device
|
|
* \param state current LED state
|
|
*
|
|
* \return 0 on success, negative errno otherwise
|
|
*/
|
|
int spdk_vmd_get_led_state(struct spdk_pci_device *pci_device, enum spdk_vmd_led_state *state);
|
|
|
|
/**
|
|
* Checks for hotplug/hotremove events of the devices behind the VMD. Needs to be called
|
|
* periodically to detect them.
|
|
*
|
|
* \return number of hotplug events detected or negative errno in case of errors
|
|
*/
|
|
int spdk_vmd_hotplug_monitor(void);
|
|
|
|
/**
|
|
* Removes a given device from the PCI subsystem simulating a hot-remove. If the device is being
|
|
* actively used by another module, the actual detach might be deferred.
|
|
*
|
|
* \param addr Address of a PCI device to remove.
|
|
*
|
|
* \return 0 if the device was successfully removed, negative errno otherwise.
|
|
*/
|
|
int spdk_vmd_remove_device(const struct spdk_pci_addr *addr);
|
|
|
|
/**
|
|
* Forces a rescan of the devices behind the VMD. If a device was previously removed through
|
|
* spdk_vmd_remove_device() this will cause it to be reattached.
|
|
*
|
|
* \return number of new devices found during scanning or negative errno on failure.
|
|
*/
|
|
int spdk_vmd_rescan(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* SPDK_VMD_H */
|