Debian Codegraph @

doc/man/nvme_mi_mi_subsystem_health_status_poll.2

raw
1 .TH "nvme_mi_mi_subsystem_health_status_poll" 9 "nvme_mi_mi_subsystem_health_status_poll" "November 2025" "libnvme API manual" LINUX
2 .SH NAME
3 nvme_mi_mi_subsystem_health_status_poll \- Read the Subsystem Health Data Structure from the NVM subsystem
4 .SH SYNOPSIS
5 .B "int" nvme_mi_mi_subsystem_health_status_poll
6 .BI "(nvme_mi_ep_t ep " ","
7 .BI "bool clear " ","
8 .BI "struct nvme_mi_nvm_ss_health_status *nshds " ");"
9 .SH ARGUMENTS
10 .IP "ep" 12
11 endpoint for MI communication
12 .IP "clear" 12
13 flag to clear the Composite Controller Status state
14 .IP "nshds" 12
15 subsystem health status data to populate
16 .SH "DESCRIPTION"
17 Retrieves the Subsystem Health Data Structure into \fInshds\fP. If \fIclear\fP is
18 set, requests that the Composite Controller Status bits are cleared after
19 the read. See NVMe-MI section 5.6 for details on the CCS bits.
20
21 See \fIstruct nvme_mi_nvm_ss_health_status\fP.
22 .SH "RETURN"
23 The nvme command status if a response was received (see
24 \fIenum nvme_status_field\fP) or -1 with errno set otherwise..