2025-02-16 10:50:33 +01:00
|
|
|
.TH "nvme_mi_mi_subsystem_health_status_poll" 9 "nvme_mi_mi_subsystem_health_status_poll" "May 2024" "libnvme API manual" LINUX
|
2025-02-16 10:03:28 +01:00
|
|
|
.SH NAME
|
|
|
|
|
nvme_mi_mi_subsystem_health_status_poll \- Read the Subsystem Health Data Structure from the NVM subsystem
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B "int" nvme_mi_mi_subsystem_health_status_poll
|
|
|
|
|
.BI "(nvme_mi_ep_t ep " ","
|
|
|
|
|
.BI "bool clear " ","
|
|
|
|
|
.BI "struct nvme_mi_nvm_ss_health_status *nshds " ");"
|
|
|
|
|
.SH ARGUMENTS
|
|
|
|
|
.IP "ep" 12
|
|
|
|
|
endpoint for MI communication
|
|
|
|
|
.IP "clear" 12
|
|
|
|
|
flag to clear the Composite Controller Status state
|
|
|
|
|
.IP "nshds" 12
|
|
|
|
|
subsystem health status data to populate
|
|
|
|
|
.SH "DESCRIPTION"
|
|
|
|
|
Retrieves the Subsystem Health Data Structure into \fInshds\fP. If \fIclear\fP is
|
|
|
|
|
set, requests that the Composite Controller Status bits are cleared after
|
|
|
|
|
the read. See NVMe-MI section 5.6 for details on the CCS bits.
|
|
|
|
|
|
|
|
|
|
See \fIstruct nvme_mi_nvm_ss_health_status\fP.
|
|
|
|
|
.SH "RETURN"
|
2025-02-16 10:05:45 +01:00
|
|
|
The nvme command status if a response was received (see
|
|
|
|
|
\fIenum nvme_status_field\fP) or -1 with errno set otherwise..
|
