From: Keith Busch Date: Mon, 17 Feb 2020 20:32:58 +0000 (-0800) Subject: Fix split line documentation X-Git-Tag: v1.0-rc0~166 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=667ba8f9fc9051e08167d1c214ebfa708348d4f0;p=users%2Fsagi%2Flibnvme.git Fix split line documentation The documentation parser won't recognize the desired link nmae if enum and the name are on separate lines. Signed-off-by: Keith Busch --- diff --git a/src/nvme/ioctl.h b/src/nvme/ioctl.h index 6e315fe9..838d15ce 100644 --- a/src/nvme/ioctl.h +++ b/src/nvme/ioctl.h @@ -131,8 +131,8 @@ struct nvme_passthru_cmd64 { * * 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); @@ -164,8 +164,8 @@ int nvme_submit_admin_passthru64(int fd, struct nvme_passthru_cmd64 *cmd, * * 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, @@ -181,8 +181,8 @@ int nvme_admin_passthru64(int fd, __u8 opcode, __u8 flags, __u16 rsvd, * * 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); @@ -214,8 +214,8 @@ int nvme_submit_admin_passthru(int fd, struct nvme_passthru_cmd *cmd, * * 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, @@ -231,8 +231,8 @@ int nvme_admin_passthru(int fd, __u8 opcode, __u8 flags, __u16 rsvd, * * 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); @@ -264,8 +264,8 @@ int nvme_submit_io_passthru64(int fd, struct nvme_passthru_cmd64 *cmd, * * 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, @@ -282,8 +282,8 @@ int nvme_io_passthru64(int fd, __u8 opcode, __u8 flags, __u16 rsvd, * * 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); @@ -315,8 +315,8 @@ int nvme_submit_io_passthru(int fd, struct nvme_passthru_cmd *cmd, * * 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, @@ -771,8 +771,8 @@ enum nvme_virt_mgmt_rt { * 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); @@ -786,8 +786,8 @@ int nvme_identify(int fd, enum nvme_identify_cns cns, __u32 nsid, * * 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); @@ -808,8 +808,8 @@ 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); @@ -820,8 +820,8 @@ 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); @@ -837,8 +837,8 @@ 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); @@ -854,8 +854,8 @@ 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); @@ -872,8 +872,8 @@ int nvme_identify_allocated_ns_list(int fd, __u32 nsid, * * 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); @@ -891,8 +891,8 @@ int nvme_identify_ctrl_list(int fd, __u16 cntid, * * 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); @@ -911,8 +911,8 @@ int nvme_identify_nsid_ctrl_list(int fd, __u32 nsid, __u16 cntid, * * 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); @@ -929,8 +929,8 @@ 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); @@ -944,8 +944,8 @@ int nvme_identify_nvmset_list(int fd, __u16 nvmsetid, * * 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); @@ -964,8 +964,8 @@ int nvme_identify_primary_ctrl(int fd, __u16 cntid, * 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); @@ -983,8 +983,8 @@ int nvme_identify_secondary_ctrl_list(int fd, __u16 cntid, * 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); @@ -998,26 +998,26 @@ int nvme_identify_ns_granularity(int fd, struct nvme_id_ns_granularity_list *lis * * 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); @@ -1033,8 +1033,8 @@ int nvme_get_log(int fd, enum nvme_cmd_get_log_lid lid, __u32 nsid, __u64 lpo, * 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); @@ -1053,8 +1053,8 @@ int nvme_get_log_error(int fd, unsigned nr_entries, bool rae, * 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); @@ -1068,8 +1068,8 @@ 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); @@ -1083,8 +1083,8 @@ 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); @@ -1096,8 +1096,8 @@ 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); @@ -1111,8 +1111,8 @@ 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); @@ -1131,8 +1131,8 @@ int nvme_get_log_create_telemetry_host(int fd, struct nvme_telemetry_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); @@ -1160,8 +1160,8 @@ int nvme_get_log_telemetry_ctrl(int fd, bool rae, __u64 offset, __u32 len, * 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); @@ -1171,8 +1171,8 @@ int nvme_get_log_endurance_group(int fd, __u16 endgid, * @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); @@ -1186,7 +1186,9 @@ int nvme_get_log_predictable_lat_event(int fd, bool rae, __u32 offset, __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, @@ -1207,8 +1209,8 @@ enum nvme_log_ana_lsp { * * 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); @@ -1250,8 +1252,8 @@ int nvme_get_log_endurance_grp_evt(int fd, bool rae, __u32 offset, __u32 len, * 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); @@ -1272,8 +1274,8 @@ int nvme_get_log_reservation(int fd, bool rae, * 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); @@ -1292,8 +1294,8 @@ int nvme_get_log_sanitize(int fd, bool rae, * @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, @@ -1305,8 +1307,8 @@ int nvme_set_features(int fd, __u8 fid, __u32 nsid, __u32 cdw11, __u32 cdw12, * @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); @@ -1317,8 +1319,8 @@ int nvme_set_features_arbitration(int fd, __u8 ab, __u8 lpw, __u8 mpw, * @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); @@ -1329,8 +1331,8 @@ int nvme_set_features_power_mgmt(int fd, __u8 ps, __u8 wh, bool save, * @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); @@ -1350,8 +1352,8 @@ enum nvme_feat_tmpthresh_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_temp_thresh(int fd, __u16 tmpth, __u8 tmpsel, enum nvme_feat_tmpthresh_thsel thsel, @@ -1363,8 +1365,8 @@ int nvme_set_features_temp_thresh(int fd, __u16 tmpth, __u8 tmpsel, * @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); @@ -1376,8 +1378,8 @@ int nvme_set_features_err_recovery(int fd, __u32 nsid, __u16 tler, * @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); @@ -1388,8 +1390,8 @@ int nvme_set_features_volatile_wc(int fd, bool wce, bool save, * @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); @@ -1400,8 +1402,8 @@ int nvme_set_features_irq_coalesce(int fd, __u8 thr, __u8 time, * @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); @@ -1413,8 +1415,8 @@ int nvme_set_features_irq_config(int fd, __u16 iv, bool cd, bool save, * @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); @@ -1445,8 +1447,8 @@ enum nvme_features_async_event_config_flags { * @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); @@ -1458,8 +1460,8 @@ int nvme_set_features_async_event(int fd, __u32 events, bool save, * @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, @@ -1471,8 +1473,8 @@ int nvme_set_features_auto_pst(int fd, bool apste, bool save, * @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); @@ -1483,8 +1485,8 @@ 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); @@ -1500,8 +1502,8 @@ int nvme_set_features_nopsc(int fd, bool noppme, 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); @@ -1512,8 +1514,8 @@ int nvme_set_features_rrl(int fd, __u8 rrl, __u16 nvmsetid, bool save, * @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, @@ -1533,8 +1535,8 @@ enum nvme_feat_plm_window_select { * @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); @@ -1546,8 +1548,8 @@ int nvme_set_features_plm_window(int fd, enum nvme_feat_plm_window_select sel, * @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); @@ -1558,8 +1560,8 @@ int nvme_set_features_lba_sts_interval(int fd, __u16 lsiri, __u16 lsipi, * @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); @@ -1570,8 +1572,8 @@ int nvme_set_features_host_behavior(int fd, bool save, * @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); @@ -1583,8 +1585,8 @@ 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); @@ -1595,8 +1597,8 @@ int nvme_set_features_endurance_evt_cfg(int fd, __u16 endgid, __u8 egwarn, * @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); @@ -1608,8 +1610,8 @@ int nvme_set_features_sw_progress(int fd, __u8 pbslc, bool save, * @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); @@ -1628,8 +1630,8 @@ enum nvme_feat_resv_notify_flags { * @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); @@ -1639,8 +1641,8 @@ 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); @@ -1664,8 +1666,8 @@ enum nvme_feat_nswpcfg_state { * @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); @@ -1673,7 +1675,7 @@ int nvme_set_features_write_protect(int fd, enum nvme_feat_nswpcfg_state state, /** * 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 @@ -1682,8 +1684,8 @@ int nvme_set_features_write_protect(int fd, enum nvme_feat_nswpcfg_state state, * @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, @@ -1695,8 +1697,8 @@ int nvme_get_features(int fd, enum nvme_features_id fid, __u32 nsid, * @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); @@ -1707,8 +1709,8 @@ int nvme_get_features_arbitration(int fd, enum nvme_get_features_sel sel, * @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); @@ -1719,8 +1721,8 @@ int nvme_get_features_power_mgmt(int fd, enum nvme_get_features_sel sel, * @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, @@ -1732,8 +1734,8 @@ int nvme_get_features_lba_range(int fd, enum nvme_get_features_sel sel, * @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); @@ -1744,8 +1746,8 @@ int nvme_get_features_temp_thresh(int fd, enum nvme_get_features_sel sel, * @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); @@ -1756,8 +1758,8 @@ int nvme_get_features_err_recovery(int fd, enum nvme_get_features_sel sel, * @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); @@ -1768,8 +1770,8 @@ int nvme_get_features_volatile_wc(int fd, enum nvme_get_features_sel sel, * @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); @@ -1780,8 +1782,8 @@ int nvme_get_features_num_queues(int fd, enum nvme_get_features_sel sel, * @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); @@ -1792,8 +1794,8 @@ int nvme_get_features_irq_coalesce(int fd, enum nvme_get_features_sel sel, * @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); @@ -1804,8 +1806,8 @@ int nvme_get_features_irq_config(int fd, enum nvme_get_features_sel sel, * @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); @@ -1816,8 +1818,8 @@ int nvme_get_features_write_atomic(int fd, enum nvme_get_features_sel sel, * @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); @@ -1828,8 +1830,8 @@ int nvme_get_features_async_event(int fd, enum nvme_get_features_sel sel, * @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); @@ -1840,8 +1842,8 @@ int nvme_get_features_auto_pst(int fd, enum nvme_get_features_sel sel, * @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); @@ -1852,8 +1854,8 @@ int nvme_get_features_host_mem_buf(int fd, enum nvme_get_features_sel sel, * @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); @@ -1864,8 +1866,8 @@ int nvme_get_features_timestamp(int fd, enum nvme_get_features_sel sel, * @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); @@ -1875,8 +1877,8 @@ 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); @@ -1886,8 +1888,8 @@ 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); @@ -1897,8 +1899,8 @@ int nvme_get_features_nopsc(int fd, enum nvme_get_features_sel sel, __u32 *resul * @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); @@ -1908,8 +1910,8 @@ 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, @@ -1921,8 +1923,8 @@ int nvme_get_features_plm_config(int fd, enum nvme_get_features_sel sel, * @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); @@ -1933,8 +1935,8 @@ int nvme_get_features_plm_window(int fd, enum nvme_get_features_sel sel, * @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); @@ -1945,8 +1947,8 @@ int nvme_get_features_lba_sts_interval(int fd, enum nvme_get_features_sel sel, * @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, @@ -1958,8 +1960,8 @@ int nvme_get_features_host_behavior(int fd, enum nvme_get_features_sel sel, * @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); @@ -1970,8 +1972,8 @@ int nvme_get_features_sanitize(int fd, enum nvme_get_features_sel sel, * @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); @@ -1982,8 +1984,8 @@ int nvme_get_features_endurance_event_cfg(int fd, enum nvme_get_features_sel sel * @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); @@ -1994,8 +1996,8 @@ int nvme_get_features_sw_progress(int fd, enum nvme_get_features_sel sel, * @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); @@ -2006,8 +2008,8 @@ int nvme_get_features_host_id(int fd, enum nvme_get_features_sel sel, * @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); @@ -2018,8 +2020,8 @@ int nvme_get_features_resv_mask(int fd, enum nvme_get_features_sel sel, * @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); @@ -2031,8 +2033,8 @@ int nvme_get_features_resv_persist(int fd, enum nvme_get_features_sel sel, * @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, @@ -2056,8 +2058,8 @@ int nvme_get_features_write_protect(int fd, __u32 nsid, * 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, @@ -2085,8 +2087,8 @@ int nvme_ns_mgmt(int fd, __u32 nsid, enum nvme_ns_mgmt_sel sel, * 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); @@ -2100,8 +2102,8 @@ int nvme_ns_mgmt_create(int fd, struct nvme_id_ns *ns, __u32 *nsid, * 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); @@ -2152,8 +2154,8 @@ int nvme_ns_detach_ctrls(int fd, __u32 nsid, struct nvme_ctrl_list *ctrlist); * 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); @@ -2167,8 +2169,9 @@ 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. */ @@ -2196,8 +2199,8 @@ int nvme_fw_commit(int fd, __u8 slot, enum nvme_fw_commit_ca action, bool bpid); * 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, @@ -2216,8 +2219,8 @@ int nvme_security_send(int fd, __u32 nsid, __u8 nssf, __u8 spsp0, __u8 spsp1, * @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, @@ -2237,8 +2240,8 @@ int nvme_security_receive(int fd, __u32 nsid, __u8 nssf, __u8 spsp0, * 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, @@ -2262,8 +2265,8 @@ int nvme_get_lba_status(int fd, __u32 nsid, __u64 slba, __u32 mndw, __u16 rl, * * 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, @@ -2275,8 +2278,8 @@ int nvme_directive_send(int fd, __u32 nsid, __u16 dspec, * @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, @@ -2287,8 +2290,8 @@ int nvme_directive_send_id_endir(int fd, __u32 nsid, bool endir, * @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); @@ -2298,8 +2301,8 @@ int nvme_directive_send_stream_release_identifier(int fd, __u32 nsid, * @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); @@ -2315,8 +2318,8 @@ 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, @@ -2328,8 +2331,8 @@ int nvme_directive_recv(int fd, __u32 nsid, __u16 dspec, * @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); @@ -2339,8 +2342,8 @@ int nvme_directive_recv_identify_parameters(int fd, __u32 nsid, * @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); @@ -2350,8 +2353,8 @@ int nvme_directive_recv_stream_parameters(int fd, __u32 nsid, * @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); @@ -2361,8 +2364,8 @@ int nvme_directive_recv_stream_status(int fd, __u32 nsid, unsigned nr_entries, * @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); @@ -2394,8 +2397,8 @@ enum nvme_fctype { * 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); @@ -2408,8 +2411,8 @@ 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); @@ -2433,8 +2436,8 @@ 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); @@ -2456,8 +2459,8 @@ int nvme_sanitize_nvm(int fd, enum nvme_sanitize_sanact sanact, bool ause, * 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); @@ -2478,8 +2481,8 @@ 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, @@ -2523,8 +2526,8 @@ enum nvme_io_opcode { * 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); @@ -2608,8 +2611,8 @@ enum nvme_io_dsm_flags { * 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, @@ -2638,8 +2641,8 @@ int nvme_read(int fd, __u32 nsid, __u64 slba, __u16 nlb, __u16 control, * 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, @@ -2667,8 +2670,8 @@ int nvme_write(int fd, __u32 nsid, __u64 slba, __u16 nlb, __u16 control, * 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, @@ -2696,8 +2699,8 @@ int nvme_compare(int fd, __u32 nsid, __u64 slba, __u16 nlb, __u16 control, * 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); @@ -2715,8 +2718,8 @@ int nvme_write_zeros(int fd, __u32 nsid, __u64 slba, __u16 nlb, __u16 control, * 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); @@ -2741,8 +2744,8 @@ 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); @@ -2773,8 +2776,8 @@ enum nvme_dsm_attributes { * 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); @@ -2824,8 +2827,8 @@ enum nvme_reservation_racqa { * 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, @@ -2869,8 +2872,8 @@ enum nvme_reservation_cptpl { * 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, @@ -2895,8 +2898,8 @@ enum nvme_reservation_rrela { * @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, @@ -2914,8 +2917,8 @@ int nvme_resv_release(int fd, __u32 nsid, enum nvme_reservation_rtype rtype, * 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); diff --git a/src/nvme/types.h b/src/nvme/types.h index 75a220d1..98eda658 100644 --- a/src/nvme/types.h +++ b/src/nvme/types.h @@ -2330,7 +2330,7 @@ struct nvme_resv_notification_log { * @NVME_RESV_NOTIFY_RNLPT_RESERVATION_RELEASED: * @NVME_RESV_NOTIFY_RNLPT_RESERVATION_PREEMPTED: */ -enum nvme_resv_notify_rnlpt {{ +enum nvme_resv_notify_rnlpt { NVME_RESV_NOTIFY_RNLPT_EMPTY = 0, NVME_RESV_NOTIFY_RNLPT_REGISTRATION_PREEMPTED = 1, NVME_RESV_NOTIFY_RNLPT_RESERVATION_RELEASED = 2, diff --git a/src/nvme/util.h b/src/nvme/util.h index c9803225..62298c0a 100644 --- a/src/nvme/util.h +++ b/src/nvme/util.h @@ -29,8 +29,8 @@ __u8 nvme_status_to_errno(int status, bool fabrics); * @offset: Starting offset to send with this firmware downlaod * @buf: Address of buffer containing all or part of the firmware 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_seq(int fd, __u32 size, __u32 xfer, __u32 offset, void *buf); @@ -44,8 +44,8 @@ int nvme_fw_download_seq(int fd, __u32 size, __u32 xfer, __u32 offset, * The total size allocated can be calculated as: * (&struct nvme_telemetry_log.dalb3 + 1) * %NVME_LOG_TELEM_BLOCK_SIZE. * - * 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_ctrl_telemetry(int fd, bool rae, struct nvme_telemetry_log **log); @@ -57,8 +57,8 @@ int nvme_get_ctrl_telemetry(int fd, bool rae, struct nvme_telemetry_log **log); * The total size allocated can be calculated as: * (&struct nvme_telemetry_log.dalb3 + 1) * %NVME_LOG_TELEM_BLOCK_SIZE. * - * 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_host_telemetry(int fd, struct nvme_telemetry_log **log); @@ -70,8 +70,8 @@ int nvme_get_host_telemetry(int fd, struct nvme_telemetry_log **log); * The total size allocated can be calculated as: * (&struct nvme_telemetry_log.dalb3 + 1) * %NVME_LOG_TELEM_BLOCK_SIZE. * - * 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_new_host_telemetry(int fd, struct nvme_telemetry_log **log); @@ -131,8 +131,8 @@ void nvme_init_dsm_range(struct nvme_dsm_range *dsm, __u32 *ctx_attrs, * @data_len: Total length of the log to transfer. * @data: User address of at least &data_len to store the log. * - * 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_page(int fd, __u32 nsid, __u8 log_id, bool rae, __u32 xfer_len, __u32 data_len, void *data); @@ -149,8 +149,8 @@ int __nvme_get_log_page(int fd, __u32 nsid, __u8 log_id, bool rae, * Calls __nvme_get_log_page() with a default 4k transfer length, as that is * guarnateed by the protocol to be a safe transfer size. * - * 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_page(int fd, __u32 nsid, __u8 log_id, bool rae, __u32 data_len, void *data); @@ -160,8 +160,8 @@ int nvme_get_log_page(int fd, __u32 nsid, __u8 log_id, bool rae, * @fd: File descriptor of nvme device * @analen: Pointer to where the length will be set on success * - * 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_ana_log_len(int fd, size_t *analen); @@ -172,8 +172,8 @@ int nvme_get_ana_log_len(int fd, size_t *analen); * @num_ctrls: Number of controllers in ctrlist * @ctrlist: List of controller IDs to perform the attach action * - * 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_namespace_attach_ctrls(int fd, __u32 nsid, __u16 num_ctrls, __u16 *ctrlist); @@ -184,8 +184,8 @@ int nvme_namespace_attach_ctrls(int fd, __u32 nsid, __u16 num_ctrls, __u16 *ctrl * @num_ctrls: Number of controllers in ctrlist * @ctrlist: List of controller IDs to perform the detach action * - * 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_namespace_detach_ctrls(int fd, __u32 nsid, __u16 num_ctrls, __u16 *ctrlist);