Merge pull request #419 from igaw/spell-checking

Fixing typos and whitespace damage in header files

Author: dwsuse

src/nvme/api-types.h

@@ -189,7 +189,7 @@ struct nvme_format_nvm_args {
 /**
  * struct nvme_ns_mgmt_args - Arguments for NVMe Namespace Management command
  * @result:	NVMe command result
- * @ns:		Namespace identication descriptors
+ * @ns:		Namespace identification descriptors
  * @args_size:	Size of &struct nvme_ns_mgmt_args
  * @fd:		File descriptor of nvme device
  * @timeout:	Timeout in ms
@@ -338,7 +338,7 @@ struct nvme_security_receive_args {
  * @timeout:	Timeout in ms
  * @nsid:	Namespace ID to retrieve LBA status
  * @mndw:	Maximum number of dwords to return
- * @atype:	Action type mechanism to determine LBA status desctriptors to
+ * @atype:	Action type mechanism to determine LBA status descriptors to
  *		return, see &enum nvme_lba_status_atype
  * @rl:		Range length from slba to perform the action
  */
@@ -358,7 +358,7 @@ struct nvme_get_lba_status_args {
 /**
  * struct nvme_directive_send_args - Arguments for the NVMe Directive Send command
  * @result:	If successful, the CQE dword0 value
- * @data:	Data payload to to be send
+ * @data:	Data payload to be send
  * @args_size:	Size of &struct nvme_directive_send_args
  * @fd:		File descriptor of nvme device
  * @timeout:	Timeout in ms
@@ -386,7 +386,7 @@ struct nvme_directive_send_args {
 /**
  * struct nvme_directive_recv_args - Arguments for the NVMe Directive Receive command
  * @result:	If successful, the CQE dword0 value
- * @data:	Usespace address of data payload
+ * @data:	Userspace address of data payload
  * @args_size:	Size of &struct nvme_directive_recv_args
  * @fd:		File descriptor of nvme device
  * @timeout:	Timeout in ms
@@ -501,7 +501,7 @@ struct nvme_get_property_args {
  * @timeout:	Timeout in ms
  * @ovrpat:	Overwrite pattern
  * @sanact:	Sanitize action, see &enum nvme_sanitize_sanact
- * @ause:	Set to allow unrestriced sanitize exit
+ * @ause:	Set to allow unrestricted sanitize exit
  * @owpass:	Overwrite pass count
  * @oipbp:	Set to overwrite invert pattern between passes
  * @nodas:	Set to not deallocate blocks after sanitizing
@@ -650,7 +650,7 @@ struct nvme_dsm_args {
  * struct nvme_copy_args - Arguments for the NVMe Copy command
  * @sdlba:	Start destination LBA
  * @result:	The command completion result from CQE dword0
- * @copy:	Range descriptior
+ * @copy:	Range description
  * @args_size:	Size of &struct nvme_copy_args
  * @fd:		File descriptor of the nvme device
  * @timeout:	Timeout in ms
@@ -692,7 +692,7 @@ struct nvme_copy_args {
 };
 
 /**
- * struct nvme_resv_acquire_args - Arguments for the NVMe Reservation Acquire Comand
+ * struct nvme_resv_acquire_args - Arguments for the NVMe Reservation Acquire Command
  * @nrkey:	The reservation key to be unregistered from the namespace if
  *		the action is preempt
  * @iekey:	Set to ignore the existing key
@@ -754,7 +754,7 @@ struct nvme_resv_register_args {
  * @timeout:	Timeout in ms
  * @nsid:	Namespace identifier
  * @rtype:	The type of reservation to be create, see &enum nvme_resv_rtype
- * @rrela:	Reservation releast action, see &enum nvme_resv_rrela
+ * @rrela:	Reservation release action, see &enum nvme_resv_rrela
  * @iekey:	Set to ignore the existing key
  */
 struct nvme_resv_release_args {
@@ -778,7 +778,7 @@ struct nvme_resv_release_args {
  * @fd:		File descriptor of nvme device
  * @timeout:	Timeout in ms
  * @nsid:	Namespace identifier
- * @len:	Number of bytes to request transfered with this command
+ * @len:	Number of bytes to request transferred with this command
  * @eds:	Request extended Data Structure
  */
 struct nvme_resv_report_args {

src/nvme/fabrics.h

@@ -4,7 +4,7 @@
  * Copyright (c) 2020 Western Digital Corporation or its affiliates.
  *
  * Authors: Keith Busch <[email protected]>
- * 	    Chaitanya Kulkarni <[email protected]>
+ *	    Chaitanya Kulkarni <[email protected]>
  */
 #ifndef _LIBNVME_FABRICS_H
 #define _LIBNVME_FABRICS_H
@@ -195,7 +195,7 @@ int nvmf_add_ctrl(nvme_host_t h, nvme_ctrl_t c,
 
 /**
  * nvmf_get_discovery_log() - Return the discovery log page
- * @c:			Discover controller to use 
+ * @c:			Discover controller to use
  * @logp:		Pointer to the log page to be returned
  * @max_retries:	maximum number of log page entries to be returned
  *
@@ -213,25 +213,25 @@ char *nvmf_hostnqn_generate();
 
 /**
  * nvmf_hostnqn_from_file() - Reads the host nvm qualified name from the config
- * 			      default location in @SYSCONFDIR@/nvme/
+ *			      default location in @SYSCONFDIR@/nvme/
  * Return: The host nqn, or NULL if unsuccessful. If found, the caller
  * is responsible to free the string.
  */
 char *nvmf_hostnqn_from_file();
 
 /**
  * nvmf_hostid_from_file() - Reads the host identifier from the config default
- * 			     location in @SYSCONFDIR@/nvme/.
+ *			     location in @SYSCONFDIR@/nvme/.
  * Return: The host identifier, or NULL if unsuccessful. If found, the caller
- * 	   is responsible to free the string.
+ *	   is responsible to free the string.
  */
 char *nvmf_hostid_from_file();
 
 /**
  * nvmf_connect_disc_entry() - Connect controller based on the discovery log page entry
  * @h:		Host to which the controller should be connected
  * @e:		Discovery log page entry
- * @defcfg:	Default configurationn to be used for the new controller
+ * @defcfg:	Default configuration to be used for the new controller
  * @discover:	Set to 'true' if the new controller is a discovery controller
  *
  * Return: Pointer to the new controller

src/nvme/ioctl.h

@@ -4,7 +4,7 @@
  * Copyright (c) 2020 Western Digital Corporation or its affiliates.
  *
  * Authors: Keith Busch <[email protected]>
- * 	    Chaitanya Kulkarni <[email protected]>
+ *	    Chaitanya Kulkarni <[email protected]>
  */
 
 #ifndef _LIBNVME_IOCTL_H
@@ -99,25 +99,25 @@ struct nvme_passthru_cmd {
  * @result:	Set on completion to the command's CQE DWORD 0-1 controller response
  */
 struct nvme_passthru_cmd64 {
-        __u8    opcode;
-        __u8    flags;
-        __u16   rsvd1;
-        __u32   nsid;
-        __u32   cdw2;
-        __u32   cdw3;
-        __u64   metadata;
-        __u64   addr;
-        __u32   metadata_len;
-        __u32   data_len;
-        __u32   cdw10;
-        __u32   cdw11;
-        __u32   cdw12;
-        __u32   cdw13;
-        __u32   cdw14;
-        __u32   cdw15;
-        __u32   timeout_ms;
-        __u32   rsvd2;
-        __u64   result;
+	__u8    opcode;
+	__u8    flags;
+	__u16   rsvd1;
+	__u32   nsid;
+	__u32   cdw2;
+	__u32   cdw3;
+	__u64   metadata;
+	__u64   addr;
+	__u32   metadata_len;
+	__u32   data_len;
+	__u32   cdw10;
+	__u32   cdw11;
+	__u32   cdw12;
+	__u32   cdw13;
+	__u32   cdw14;
+	__u32   cdw15;
+	__u32   timeout_ms;
+	__u32   rsvd2;
+	__u64   result;
 };
 
 /**
@@ -186,16 +186,16 @@ struct nvme_uring_cmd {
  * @align:	Alignment information
  */
 #define sizeof_args(type, member, align)					\
-  ({										\
-	  type s;								\
-	  size_t t = offsetof(type, member) + sizeof(s.member);			\
-	  size_t p = (sizeof(align) - (t % sizeof(align))) % sizeof(align);	\
-	  t + p;								\
-  })
+({										\
+	type s;									\
+	size_t t = offsetof(type, member) + sizeof(s.member);			\
+	size_t p = (sizeof(align) - (t % sizeof(align))) % sizeof(align);	\
+	t + p;									\
+})
 
 /**
  * nvme_submit_admin_passthru64() - Submit a 64-bit nvme passthrough admin
- * 				    command
+ *				    command
  * @fd:		File descriptor of nvme device
  * @cmd:	The nvme admin command to send
  * @result:	Optional field to return the result from the CQE DW0-1
@@ -517,7 +517,7 @@ static inline int nvme_identify_ns(int fd, __u32 nsid, struct nvme_id_ns *ns)
 
 /**
  * nvme_identify_allocated_ns() - Same as nvme_identify_ns, but only for
- * 				  allocated namespaces
+ *				  allocated namespaces
  * @fd:		File descriptor of nvme device
  * @nsid:	Namespace to identify
  * @ns:		User space destination address to transfer the data
@@ -709,7 +709,7 @@ static inline int nvme_identify_nvmset_list(int fd, __u16 nvmsetid,
 
 /**
  * nvme_identify_primary_ctrl() - Retrieve NVMe Primary Controller
- * 				  identification
+ *				  identification
  * @fd:		File descriptor of nvme device
  * @cntid:	Return controllers starting at this identifier
  * @cap:	User space destination buffer address to transfer the data
@@ -779,7 +779,7 @@ static inline int nvme_identify_secondary_ctrl_list(int fd, __u32 nsid,
 
 /**
  * nvme_identify_ns_granularity() - Retrieves namespace granularity
- * 				    identification
+ *				    identification
  * @fd:		File descriptor of nvme device
  * @gr_list:	User space destination address to transfer the data
  *
@@ -886,7 +886,7 @@ static inline int nvme_identify_ctrl_csi(int fd, enum nvme_csi csi, void *data)
 }
 
 /**
- * nvme_identify_active_ns_list_csi() - Active namespace ID list associated with a specified I/O command set 
+ * nvme_identify_active_ns_list_csi() - Active namespace ID list associated with a specified I/O command set
  * @fd:		File descriptor of nvme device
  * @nsid:	Return namespaces greater than this identifier
  * @csi:	Command Set Identifier
@@ -1287,8 +1287,8 @@ static inline int nvme_get_log_supported_log_pages(int fd, bool rae,
  * Return: The nvme command status if a response was received (see
  * &enum nvme_status_field) or -1 with errno set otherwise.
  */
-static inline int nvme_get_log_error(int fd, unsigned nr_entries, bool rae,
-		       struct nvme_error_log_page *err_log)
+static inline int nvme_get_log_error(int fd, unsigned int nr_entries, bool rae,
+				     struct nvme_error_log_page *err_log)
 {
 	return nvme_get_nsid_log(fd, rae, NVME_LOG_LID_ERROR,
 				 NVME_NSID_ALL, sizeof(*err_log) * nr_entries,
@@ -1641,7 +1641,7 @@ static inline int nvme_get_log_predictable_lat_event(int fd, bool rae,
  * &enum nvme_status_field) or -1 with errno set otherwise.
  */
 static inline int nvme_get_log_ana(int fd, enum nvme_log_ana_lsp lsp, bool rae,
-			           __u64 offset, __u32 len, void *log)
+				   __u64 offset, __u32 len, void *log)
 {
 	struct nvme_get_log_args args = {
 		.lpo = offset,
@@ -2249,7 +2249,7 @@ int nvme_set_features_auto_pst(int fd, bool apste, bool save,
  * nvme_set_features_timestamp() - Set timestamp feature
  * @fd:		File descriptor of nvme device
  * @save:	Save value across power states
- * @timestamp:	The current timestamp value to assign to this this feature
+ * @timestamp:	The current timestamp value to assign to this feature
  *
  * Return: The nvme command status if a response was received (see
  * &enum nvme_status_field) or -1 with errno set otherwise.
@@ -2310,7 +2310,7 @@ int nvme_set_features_rrl(int fd, __u8 rrl, __u16 nvmsetid, bool save,
  */
 int nvme_set_features_plm_config(int fd, bool enable, __u16 nvmsetid,
 				 bool save, struct nvme_plm_config *data,
-				 __u32*result);
+				 __u32 *result);
 
 /**
  * nvme_set_features_plm_window() - Set window select feature
@@ -3067,7 +3067,7 @@ int nvme_security_send(struct nvme_security_send_args *args);
 
 /**
  * nvme_security_receive() - Security Receive command
- * @args:	&struct nvme_security_recevice argument structure
+ * @args:	&struct nvme_security_receive argument structure
  *
  * Return: The nvme command status if a response was received (see
  * &enum nvme_status_field) or -1 with errno set otherwise.
@@ -3250,7 +3250,7 @@ static inline int nvme_directive_recv_stream_parameters(int fd, __u32 nsid,
  * &enum nvme_status_field) or -1 with errno set otherwise.
  */
 static inline int nvme_directive_recv_stream_status(int fd, __u32 nsid,
-			unsigned nr_entries,
+			unsigned int nr_entries,
 			struct nvme_streams_directive_status *id)
 {
 	struct nvme_directive_recv_args args = {
@@ -3409,7 +3409,8 @@ int nvme_virtual_mgmt(struct nvme_virtual_mgmt_args *args);
  * Return: The nvme command status if a response was received (see
  * &enum nvme_status_field) or -1 with errno set otherwise.
  */
-static inline int nvme_flush(int fd, __u32 nsid) {
+static inline int nvme_flush(int fd, __u32 nsid)
+{
 	struct nvme_passthru_cmd cmd = {};
 
 	cmd.opcode = nvme_cmd_flush;

src/nvme/linux.h

@@ -25,7 +25,7 @@
  * @fd:		File descriptor of nvme device
  * @size:	Total size of the firmware image to transfer
  * @xfer:	Maximum size to send with each partial transfer
- * @offset:	Starting offset to send with this firmware downlaod
+ * @offset:	Starting offset to send with this firmware download
  * @buf:	Address of buffer containing all or part of the firmware image.
  *
  * Return: The nvme command status if a response was received (see
@@ -109,7 +109,7 @@ int nvme_get_new_host_telemetry(int fd,  struct nvme_telemetry_log **log,
 int nvme_get_log_page(int fd, __u32 xfer_len, struct nvme_get_log_args *args);
 
 /**
- * nvme_get_ana_log_len() - Retreive size of the current ANA log
+ * nvme_get_ana_log_len() - Retrieve size of the current ANA log
  * @fd:		File descriptor of nvme device
  * @analen:	Pointer to where the length will be set on success
  *
@@ -130,11 +130,11 @@ int nvme_get_ana_log_len(int fd, size_t *analen);
 int nvme_get_logical_block_size(int fd, __u32 nsid, int *blksize);
 
 /**
- * nvme_get_lba_status_log() - Retreive the LBA Status log page
+ * nvme_get_lba_status_log() - Retrieve the LBA Status log page
  * @fd:		File descriptor of the nvme device
  * @rae:	Retain asynchronous events
- * @log:	On success, set to the value of the allocated and retreived log.
-  *
+ * @log:	On success, set to the value of the allocated and retrieved log.
+ *
  * Return: The nvme command status if a response was received (see
  * &enum nvme_status_field) or -1 with errno set otherwise.
  */