*
* Uses NVME_IOCTL_ADMIN64_CMD for the ioctl request.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_submit_admin_passthru64(int fd, struct nvme_passthru_cmd64 *cmd,
__u64 *result);
*
* Known values for @opcode are defined in &enum nvme_admin_opcode.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_admin_passthru64(int fd, __u8 opcode, __u8 flags, __u16 rsvd,
__u32 nsid, __u32 cdw2, __u32 cdw3, __u32 cdw10, __u32 cdw11,
*
* Uses NVME_IOCTL_ADMIN_CMD for the ioctl request.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_submit_admin_passthru(int fd, struct nvme_passthru_cmd *cmd,
__u32 *result);
*
* Known values for @opcode are defined in &enum nvme_admin_opcode.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_admin_passthru(int fd, __u8 opcode, __u8 flags, __u16 rsvd,
__u32 nsid, __u32 cdw2, __u32 cdw3, __u32 cdw10, __u32 cdw11,
*
* Uses NVME_IOCTL_IO64_CMD for the ioctl request.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_submit_io_passthru64(int fd, struct nvme_passthru_cmd64 *cmd,
__u64 *result);
*
* Known values for @opcode are defined in &enum nvme_io_opcode.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_io_passthru64(int fd, __u8 opcode, __u8 flags, __u16 rsvd,
__u32 nsid, __u32 cdw2, __u32 cdw3, __u32 cdw10, __u32 cdw11,
*
* Uses NVME_IOCTL_IO_CMD for the ioctl request.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_submit_io_passthru(int fd, struct nvme_passthru_cmd *cmd,
__u32 *result);
*
* Known values for @opcode are defined in &enum nvme_io_opcode.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_io_passthru(int fd, __u8 opcode, __u8 flags, __u16 rsvd,
__u32 nsid, __u32 cdw2, __u32 cdw3, __u32 cdw10, __u32 cdw11,
* The Identify command returns a data buffer that describes information about
* the NVM subsystem, the controller or the namespace(s).
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_identify(int fd, enum nvme_identify_cns cns, __u32 nsid,
__u16 cntid, __u16 nvmsetid, __u8 uuidx, void *data);
*
* See &struct nvme_id_ctrl for details on the data returned.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_identify_ctrl(int fd, struct nvme_id_ctrl *id);
*
* See &struct nvme_id_ns for details on the structure returned.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_identify_ns(int fd, __u32 nsid, struct nvme_id_ns *ns);
* @nsid: Namespace to identify
* @ns: User space destination address to transfer the data
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_identify_allocated_ns(int fd, __u32 nsid, struct nvme_id_ns *ns);
*
* See &struct nvme_ns_list for the definition of the returned structure.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_identify_active_ns_list(int fd, __u32 nsid, struct nvme_ns_list *list);
*
* See &struct nvme_ns_list for the definition of the returned structure.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_identify_allocated_ns_list(int fd, __u32 nsid,
struct nvme_ns_list *list);
*
* See &struct nvme_ctrl_list for a definition of the structure returned.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_identify_ctrl_list(int fd, __u16 cntid,
struct nvme_ctrl_list *ctrlist);
*
* See &struct nvme_ctrl_list for a definition of the structure returned.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1
*/
int nvme_identify_nsid_ctrl_list(int fd, __u32 nsid, __u16 cntid,
struct nvme_ctrl_list *ctrlist);
*
* See &struct nvme_ns_id_desc for the definition of the returned structure.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_identify_ns_descs(int fd, __u32 nsid, struct nvme_ns_id_desc *descs);
*
* See &struct nvme_id_nvmset_list for the defintion of the returned structure.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_identify_nvmset_list(int fd, __u16 nvmsetid,
struct nvme_id_nvmset_list *nvmset);
*
* See &struct nvme_primary_ctrl_cap for the defintion of the returned structure, @cap.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_identify_primary_ctrl(int fd, __u16 cntid,
struct nvme_primary_ctrl_cap *cap);
* See &struct nvme_secondary_ctrls_list for a defintion of the returned
* structure.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_identify_secondary_ctrl_list(int fd, __u16 cntid,
struct nvme_secondary_ctrl_list *list);
* See &struct nvme_id_ns_granularity_list for the definition of the returned
* structure.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_identify_ns_granularity(int fd, struct nvme_id_ns_granularity_list *list);
*
* See &struct nvme_id_uuid_list for the definition of the returned structure.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_identify_uuid(int fd, struct nvme_id_uuid_list *list);
/**
* nvme_get_log() - NVMe Admin Get Log command
- * @fd: File descriptor of nvme device
- * @lid: Log page identifier, see &enum nvme_cmd_get_log_lid for known values
- * @nsid: Namespace identifier, if applicable
- * @lpo: Log page offset for partial log transfers
- * @lsp: Log specific field
- * @lsi: Endurance group information
- * @rae: Retain asynchronous events
- * @uuidx: UUID selection, if supported
- * @len: Length of provided user buffer to hold the log data in bytes
- * @log: User space destination address to transfer the data
- *
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * @fd: File descriptor of nvme device
+ * @lid: Log page identifier, see &enum nvme_cmd_get_log_lid for known values
+ * @nsid: Namespace identifier, if applicable
+ * @lpo: Log page offset for partial log transfers
+ * @lsp: Log specific field
+ * @lsi: Endurance group information
+ * @rae: Retain asynchronous events
+ * @uuidx: UUID selection, if supported
+ * @len: Length of provided user buffer to hold the log data in bytes
+ * @log: User space destination address to transfer the data
+ *
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_log(int fd, enum nvme_cmd_get_log_lid lid, __u32 nsid, __u64 lpo,
__u8 lsp, __u16 lsi, bool rae, __u8 uuidx, __u32 len, void *log);
* that completed with error, or may report an error that is not specific to a
* particular command.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_log_error(int fd, unsigned nr_entries, bool rae,
struct nvme_error_log_page *log);
* requesting the log page on a per namespace basis, as indicated by bit 0 of
* the LPA field in the Identify Controller data structure.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_log_smart(int fd, __u32 nsid, bool rae, struct nvme_smart_log *log);
* firmware slot supported. The firmware revision is indicated as an ASCII
* string. The log page also indicates the active slot number.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_log_fw_slot(int fd, bool rae, struct nvme_firmware_slot *log);
* that have changed since the last time the namespace was identified, been
* added, or deleted.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_log_changed_ns_list(int fd, bool rae, struct nvme_ns_list *log);
* This log page is used to describe the commands that the controller supports
* and the effects of those commands on the state of the NVM subsystem.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_log_cmd_effects(int fd, struct nvme_cmd_effects_log *log);
* the percent complete of that operation, and the results of the previous 20
* self-test operations.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_log_device_self_test(int fd, struct nvme_self_test_log *log);
* Retreives the Telemetry Host-Initiated log page at the requested offset
* using the previously existing capture.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_log_telemetry_host(int fd, __u64 offset, __u32 len, void *log);
* generated when an entry for an Endurance Group is newly added to this log
* page.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_log_endurance_group(int fd, __u16 endgid,
struct nvme_endurance_group_log *log);
* @fd:
* @nvmsetid:
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_log_predictable_lat_nvmset(int fd, __u16 nvmsetid,
struct nvme_nvmset_predictable_lat_log *log);
__u32 len, void *log);
/**
- *
+ * enum nvme_log_ana_lsp -
+ * @NVME_LOG_ANA_LSP_RGO_NAMESPACES:
+ * @NVME_LOG_ANA_LSP_RGO_GROUPS_ONLY:
*/
enum nvme_log_ana_lsp {
NVME_LOG_ANA_LSP_RGO_NAMESPACES = 0,
*
* See &struct nvme_ana_rsp_hdr for the defintion of the returned structure.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_log_ana(int fd, enum nvme_log_ana_lsp lsp, bool rae, __u64 offset,
__u32 len, void *log);
* Supported only by fabrics discovery controllers, returning discovery
* records.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_log_discovery(int fd, bool rae, __u32 offset, __u32 len, void *log);
* The Sanitize Status log page is used to report sanitize operation time
* estimates and information about the most recent sanitize operation.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_log_sanitize(int fd, bool rae,
struct nvme_sanitize_log_page *log);
* @data: User address of feature data, if applicable
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features(int fd, __u8 fid, __u32 nsid, __u32 cdw11, __u32 cdw12,
bool save, __u8 uuidx, __u32 cdw15, __u32 data_len,
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_arbitration(int fd, __u8 ab, __u8 lpw, __u8 mpw,
__u8 hpw, bool save, __u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_power_mgmt(int fd, __u8 ps, __u8 wh, bool save,
__u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_lba_range(int fd, __u32 nsid, __u32 nr_ranges, bool save,
struct nvme_lba_range_type *data, __u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_temp_thresh(int fd, __u16 tmpth, __u8 tmpsel,
enum nvme_feat_tmpthresh_thsel thsel,
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_err_recovery(int fd, __u32 nsid, __u16 tler,
bool dulbe, bool save, __u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_volatile_wc(int fd, bool wce, bool save,
__u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_irq_coalesce(int fd, __u8 thr, __u8 time,
bool save, __u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_irq_config(int fd, __u16 iv, bool cd, bool save,
__u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_write_atomic(int fd, bool dn, bool save,
__u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_async_event(int fd, __u32 events, bool save,
__u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_auto_pst(int fd, bool apste, bool save,
struct nvme_feat_auto_pst *apst,
* @save: Save value across power states
* @timestamp: The current timestamp value to assign to this this feature
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_timestamp(int fd, bool save, __u64 timestamp);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_hctm(int fd, __u16 tmt2, __u16 tmt1, bool save,
__u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_rrl(int fd, __u8 rrl, __u16 nvmsetid, bool save,
__u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_plm_config(int fd, bool enable, __u16 nvmsetid,
bool save, struct nvme_plm_config *data,
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_plm_window(int fd, enum nvme_feat_plm_window_select sel,
__u16 nvmsetid, bool save, __u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_lba_sts_interval(int fd, __u16 lsiri, __u16 lsipi,
bool save, __u32 *result);
* @fd: File descriptor of nvme device
* @save: Save value across power states
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_host_behavior(int fd, bool save,
struct nvme_feat_host_behavior *data);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_sanitize(int fd, bool nodrm, bool save, __u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_endurance_evt_cfg(int fd, __u16 endgid, __u8 egwarn,
bool save, __u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_sw_progress(int fd, __u8 pbslc, bool save,
__u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_host_id(int fd, bool exhid, bool save, __u8 *hostid);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_resv_mask(int fd, __u32 mask, bool save, __u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_resv_persist(int fd, bool ptpl, bool save, __u32 *result);
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_write_protect(int fd, enum nvme_feat_nswpcfg_state state,
bool save, __u32 *result);
/**
* nvme_get_features() - Retrieve a feature attribute
* @fd: File descriptor of nvme device
- * @fid: Feature identifier
+ * @fid: Feature identifier, see &enum nvme_features_id
* @nsid: Namespace ID, if applicable
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @cdw11: Feature specific command dword11 field
* @data: User address of feature data, if applicable
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features(int fd, enum nvme_features_id fid, __u32 nsid,
enum nvme_get_features_sel sel, __u32 cdw11, __u8 uuidx,
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_arbitration(int fd, enum nvme_get_features_sel sel,
__u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_power_mgmt(int fd, enum nvme_get_features_sel sel,
__u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_lba_range(int fd, enum nvme_get_features_sel sel,
struct nvme_lba_range_type *data,
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_temp_thresh(int fd, enum nvme_get_features_sel sel,
__u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_err_recovery(int fd, enum nvme_get_features_sel sel,
__u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_volatile_wc(int fd, enum nvme_get_features_sel sel,
__u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_num_queues(int fd, enum nvme_get_features_sel sel,
__u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_irq_coalesce(int fd, enum nvme_get_features_sel sel,
__u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_irq_config(int fd, enum nvme_get_features_sel sel,
__u16 iv, __u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_write_atomic(int fd, enum nvme_get_features_sel sel,
__u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_async_event(int fd, enum nvme_get_features_sel sel,
__u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_auto_pst(int fd, enum nvme_get_features_sel sel,
struct nvme_feat_auto_pst *apst, __u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_host_mem_buf(int fd, enum nvme_get_features_sel sel,
__u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_timestamp(int fd, enum nvme_get_features_sel sel,
struct nvme_timestamp *ts);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_kato(int fd, enum nvme_get_features_sel sel, __u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_hctm(int fd, enum nvme_get_features_sel sel, __u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_nopsc(int fd, enum nvme_get_features_sel sel, __u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_rrl(int fd, enum nvme_get_features_sel sel, __u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_plm_config(int fd, enum nvme_get_features_sel sel,
__u16 nvmsetid, struct nvme_plm_config *data,
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_plm_window(int fd, enum nvme_get_features_sel sel,
__u16 nvmsetid, __u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_lba_sts_interval(int fd, enum nvme_get_features_sel sel,
__u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_host_behavior(int fd, enum nvme_get_features_sel sel,
struct nvme_feat_host_behavior *data,
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_sanitize(int fd, enum nvme_get_features_sel sel,
__u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_endurance_event_cfg(int fd, enum nvme_get_features_sel sel,
__u16 endgid, __u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_sw_progress(int fd, enum nvme_get_features_sel sel,
__u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_host_id(int fd, enum nvme_get_features_sel sel,
bool exhid, __u32 len, __u8 *hostid);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_resv_mask(int fd, enum nvme_get_features_sel sel,
__u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_resv_persist(int fd, enum nvme_get_features_sel sel,
__u32 *result);
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_write_protect(int fd, __u32 nsid,
enum nvme_get_features_sel sel,
* size. A low level format may destroy all data and metadata associated with
* all namespaces or only the specific namespace associated with the command
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_format_nvm(int fd, __u32 nsid, __u8 lbaf,
enum nvme_cmd_format_mset mset,
* attached to any controller. Use the nvme_ns_attach_ctrls() to assign the
* namespace to one or more controllers.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_ns_mgmt_create(int fd, struct nvme_id_ns *ns, __u32 *nsid,
__u32 timeout);
* controller. Use the nvme_ns_detach_ctrls() first if the namespace is still
* attached.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_ns_mgmt_delete(int fd, __u32 nsid);
* Download command. Use the nvme_fw_commit() to activate a newly downloaded
* image.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_fw_download(int fd, __u32 offset, __u32 data_len, void *data);
* The Firmware Commit command is used to modify the firmware image or Boot
* Partitions.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise. The command status
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise. The command
+ * status
* response may specify additional
* reset actions required to complete the commit process.
*/
* The security data is protocol specific and is not defined by the NVMe
* specification.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_security_send(int fd, __u32 nsid, __u8 nssf, __u8 spsp0, __u8 spsp1,
__u8 secp, __u32 tl, __u32 data_len, void *data,
* @data: Security data payload to send
* @result: The command completion result from CQE dword0
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_security_receive(int fd, __u32 nsid, __u8 nssf, __u8 spsp0,
__u8 spsp1, __u8 secp, __u32 al, __u32 data_len,
* The Get LBA Status command requests information about Potentially
* Unrecoverable LBAs. Refer to the specification for action type descriptions.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_lba_status(int fd, __u32 nsid, __u64 slba, __u32 mndw, __u16 rl,
enum nvme_lba_status_atype atype,
*
* See the NVMe specification for more information.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_directive_send(int fd, __u32 nsid, __u16 dspec,
enum nvme_directive_send_doper doper,
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_directive_send_id_endir(int fd, __u32 nsid, bool endir,
enum nvme_directive_dtype dtype,
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_directive_send_stream_release_identifier(int fd, __u32 nsid,
__u16 stream_id);
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_directive_send_stream_release_resource(int fd, __u32 nsid);
* @data: Usespace address of data payload in bytes
* @result: If successful, the CQE dword0 value
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_directive_recv(int fd, __u32 nsid, __u16 dspec,
enum nvme_directive_receive_doper doper,
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_directive_recv_identify_parameters(int fd, __u32 nsid,
struct nvme_id_directives *id);
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_directive_recv_stream_parameters(int fd, __u32 nsid,
struct nvme_streams_directive_params *parms);
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_directive_recv_stream_status(int fd, __u32 nsid, unsigned nr_entries,
struct nvme_streams_directive_status *id);
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_directive_recv_stream_allocate(int fd, __u32 nsid, __u16 nsr,
__u32 *result);
* This is an NVMe-over-Fabrics specific command, not applicable to PCIe. These
* properties align to the PCI MMIO controller registers.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_property(int fd, int offset, __u64 value);
* This is an NVMe-over-Fabrics specific command, not applicable to PCIe. These
* properties align to the PCI MMIO controller registers.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_property(int fd, int offset, __u64 *value);
* sanitize operations are processed in the background, i.e., completion of the
* sanitize command does not indicate completion of the sanitize operation.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_sanitize_nvm(int fd, enum nvme_sanitize_sanact sanact, bool ause,
__u8 owpass, bool oipbp, bool nodas, __u32 ovrpat);
* 0xffffffff to test all namespaces. All other values tests a specific
* namespace, if present.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_dev_self_test(int fd, __u32 nsid, enum nvme_dst_stc stc);
* - Assigning Flexible Resources for secondary controllers
* - Setting the Online and Offline state for secondary controllers
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_virtual_mgmt(int fd, enum nvme_virt_mgmt_act act,
enum nvme_virt_mgmt_rt rt, __u16 cntlid, __u16 nr,
* The Flush command is used to request that the contents of volatile write
* cache be made non-volatile.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_flush(int fd, __u32 nsid);
* metadata_len:Length of user buffer, @metadata, in bytes
* @metadata: Pointer to user address of the metadata buffer
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_read(int fd, __u32 nsid, __u64 slba, __u16 nlb, __u16 control,
__u8 dsm, __u32 reftag, __u16 apptag, __u16 appmask,
* metadata_len:Length of user buffer, @metadata, in bytes
* @metadata: Pointer to user address of the metadata buffer
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_write(int fd, __u32 nsid, __u64 slba, __u16 nlb, __u16 control,
__u8 dsm, __u16 dspec, __u32 reftag, __u16 apptag,
* metadata_len:Length of user buffer, @metadata, in bytes
* @metadata: Pointer to user address of the metadata buffer
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_compare(int fd, __u32 nsid, __u64 slba, __u16 nlb, __u16 control,
__u32 reftag, __u16 apptag, __u16 appmask, __u32 data_len,
* subsequent reads of logical blocks in this range shall be all bytes cleared
* to 0h until a write occurs to this LBA range.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_write_zeros(int fd, __u32 nsid, __u64 slba, __u16 nlb, __u16 control,
__u32 reftag, __u16 apptag, __u16 appmask);
* invalid logical block status, a write operation on those logical blocks is
* required.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_write_uncorrectable(int fd, __u32 nsid, __u64 slba, __u16 nlb);
* and metadata, if applicable, for the LBAs indicated without transferring any
* data or metadata to the host.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_verify(int fd, __u32 nsid, __u64 slba, __u16 nlb, __u16 control,
__u32 reftag, __u16 apptag, __u16 appmask);
* to optimize performance and reliability, and may be used to
* deallocate/unmap/trim those logical blocks.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_dsm(int fd, __u32 nsid, __u32 attrs, __u16 nr_ranges,
struct nvme_dsm_range *dsm);
* namespace, preempt a reservation held on a namespace, and abort a
* reservation held on a namespace.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_resv_acquire(int fd, __u32 nsid, enum nvme_reservation_rtype rtype,
enum nvme_reservation_racqa racqa, bool iekey,
* The Reservation Register command is used to register, unregister, or replace
* a reservation key.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_resv_register(int fd, __u32 nsid, enum nvme_reservation_rrega rrega,
enum nvme_reservation_cptpl cptpl, bool iekey,
* @iekey: Set to ignore the existing key
* @crkey: The current reservation key to release
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_resv_release(int fd, __u32 nsid, enum nvme_reservation_rtype rtype,
enum nvme_reservation_rrela rrela, bool iekey,
* registration and reservation status of a namespace. See the defintion for
* the returned structure, &struct nvme_reservation_status, for more details.
*
- * Return: The nvme command status if a response was received (see &enum
- * nvme_status_field) or -1 with errno set otherwise.
+ * Return: The nvme command status if a response was received (see
+ * &enum
*/
int nvme_resv_report(int fd, __u32 nsid, bool eds, __u32 len,
struct nvme_reservation_status *report);
projects / users / sagi / libnvme.git / commitdiff