nvme: Fix typos in header files

A quick run with ispell to fix the obvious typos.

Signed-off-by: Daniel Wagner <[email protected]>

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

@@ -231,7 +231,7 @@ 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

@@ -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.

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,10 +130,10 @@ 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.

src/nvme/mi.h

@@ -147,7 +147,7 @@ enum nvme_mi_ror {
  * @NVME_MI_RESP_ENC_XFER_REFUSED: Enclosure services transfer refused
  * @NVME_MI_RESP_ENC_FUNC_UNSUP: Unsupported enclosure services function
  * @NVME_MI_RESP_ENC_SERV_UNAVAIL: Enclosure services unavailable
- * @NVME_MI_RESP_ENC_DEGRADED: Noncriticial failure detected by enc. services
+ * @NVME_MI_RESP_ENC_DEGRADED: Noncritical failure detected by enc. services
  * @NVME_MI_RESP_SANITIZE_IN_PROGRESS: Command prohibited during sanitize
  */
 enum nvme_mi_resp_status {
@@ -523,7 +523,7 @@ nvme_mi_ctrl_t nvme_mi_next_ctrl(nvme_mi_ep_t ep, nvme_mi_ctrl_t c);
  * @netid: MCTP network ID on this system
  * @eid: MCTP endpoint ID
  *
- * Transport-specific endpoint initialisation for MI-connected endpoints. Once
+ * Transport-specific endpoint initialization for MI-connected endpoints. Once
  * an endpoint is created, the rest of the API is transport-independent.
  *
  * Return: New endpoint object for @netid & @eid, or NULL on failure.
@@ -543,8 +543,8 @@ void nvme_mi_close(nvme_mi_ep_t ep);
 /**
  * nvme_mi_scan_mctp - look for MCTP-connected NVMe-MI endpoints.
  *
- * Description: This function queries the system mctp daemon ("mctpd") over
- * dbus, to find MCTP endpoints that report support for NVMe-MI over MCTP.
+ * Description: This function queries the system MCTP daemon ("mctpd") over
+ * D-Bus, to find MCTP endpoints that report support for NVMe-MI over MCTP.
  *
  * This requires libvnme-mi to be compiled with D-Bus support; if not, this
  * will return NULL.
@@ -577,7 +577,7 @@ int nvme_mi_scan_ep(nvme_mi_ep_t ep, bool force_rescan);
 /**
  * nvme_mi_init_ctrl() - initialise a NVMe controller.
  * @ep: Endpoint to create under
- * @ctrl_id: ID of controller to initialise.
+ * @ctrl_id: ID of controller to initialize.
  *
  * Create a connection to a controller behind the endpoint specified in @ep.
  * Controller IDs may be queried from the endpoint through
@@ -706,7 +706,7 @@ int nvme_mi_mi_subsystem_health_status_poll(nvme_mi_ep_t ep, bool clear,
  * as the LSB of @dw0. Other @dw0 and @dw1 data is configuration-identifier
  * specific.
  *
- * On a sucessful Configuration Get, the @nmresp pointer will be populated with
+ * On a successful Configuration Get, the @nmresp pointer will be populated with
  * the bytes from the 3-byte NMRESP field, converted to native endian.
  *
  * See &enum nvme_mi_config_id for identifiers.
@@ -733,7 +733,7 @@ int nvme_mi_mi_config_get(nvme_mi_ep_t ep, __u32 dw0, __u32 dw1,
 int nvme_mi_mi_config_set(nvme_mi_ep_t ep, __u32 dw0, __u32 dw1);
 
 /**
- * nvme_mi_mi_config_get_smbus_freq - get configuraton: SMBus port frequency
+ * nvme_mi_mi_config_get_smbus_freq - get configuration: SMBus port frequency
  * @ep: endpoint for MI communication
  * @port: port ID to query
  * @freq: output value for current frequency configuration
@@ -759,7 +759,7 @@ static inline int nvme_mi_mi_config_get_smbus_freq(nvme_mi_ep_t ep, __u8 port,
 }
 
 /**
- * nvme_mi_mi_config_set_smbus_freq - set configuraton: SMBus port frequency
+ * nvme_mi_mi_config_set_smbus_freq - set configuration: SMBus port frequency
  * @ep: endpoint for MI communication
  * @port: port ID to set
  * @freq: new frequency configuration
@@ -805,7 +805,7 @@ static inline int nvme_mi_mi_config_set_health_status_change(nvme_mi_ep_t ep,
 }
 
 /**
- * nvme_mi_mi_config_get_mctp_mtu - get configuraton: MCTP MTU
+ * nvme_mi_mi_config_get_mctp_mtu - get configuration: MCTP MTU
  * @ep: endpoint for MI communication
  * @port: port ID to query
  * @mtu: output value for current MCTP MTU configuration
@@ -836,7 +836,7 @@ static inline int nvme_mi_mi_config_get_mctp_mtu(nvme_mi_ep_t ep, __u8 port,
 }
 
 /**
- * nvme_mi_mi_config_set_mctp_mtu - set configuraton: MCTP MTU
+ * nvme_mi_mi_config_set_mctp_mtu - set configuration: MCTP MTU
  * @ep: endpoint for MI communication
  * @port: port ID to set
  * @mtu: new MTU configuration
@@ -913,7 +913,7 @@ int nvme_mi_admin_xfer(nvme_mi_ctrl_t ctrl,
  * Unless you're performing a vendor-unique identify command, You'll probably
  * want to use one of the identify helpers (nvme_mi_admin_identify,
  * nvme_mi_admin_identify_cns_nsid, or nvme_mi_admin_identify_<type>) instead
- * of this. If the type of your identify command is standardised but not
+ * of this. If the type of your identify command is standardized but not
  * yet supported by libnvme-mi, please contact the maintainers.
  *
  * Return: 0 on success, non-zero on failure
@@ -995,7 +995,7 @@ static inline int nvme_mi_admin_identify_cns_nsid(nvme_mi_ctrl_t ctrl,
  *
  * Will return an error if the length of the response data (from the
  * controller) is not a full &NVME_IDENTIFY_DATA_SIZE, so @id will be
- * be fully populated on success.
+ * fully populated on success.
  *
  * Return: 0 on success, non-zero on failure
  *
@@ -1020,7 +1020,7 @@ static inline int nvme_mi_admin_identify_ctrl(nvme_mi_ctrl_t ctrl,
  *
  * Will return an error if the length of the response data (from the
  * controller) is not a full &NVME_IDENTIFY_DATA_SIZE, so @id will be
- * be fully populated on success.
+ * fully populated on success.
  *
  * Return: 0 on success, non-zero on failure
  *

src/nvme/tree.h

@@ -142,9 +142,9 @@ nvme_subsystem_t nvme_next_subsystem(nvme_host_t h, nvme_subsystem_t s);
  * @subsysnqn:	Subsystem NQN
  *
  * Lookup a &nvme_subsystem_t object in @h base on @name (if present)
- * and @subsystemnqn or create one if not found.
+ * and @subsysnqn or create one if not found.
  *
- * Return: nvme_subsystme_t object
+ * Return: nvme_subsystem_t object
  */
 nvme_subsystem_t nvme_lookup_subsystem(struct nvme_host *h,
 				       const char *name,
@@ -443,7 +443,7 @@ nvme_ns_t nvme_subsystem_next_ns(nvme_subsystem_t s, nvme_ns_t n);
 		p = nvme_namespace_next_path(n, p))
 
 /**
- * nvme_ns_get_fd() - Get associated filedescriptor
+ * nvme_ns_get_fd() - Get associated file descriptor
  * @n:	Namespace instance
  *
  * Return: File descriptor associated with @n or -1
@@ -483,10 +483,10 @@ int nvme_ns_get_meta_size(nvme_ns_t n);
 uint64_t nvme_ns_get_lba_count(nvme_ns_t n);
 
 /**
- * nvme_ns_get_lba_util() - LBA utilisation of a namespace
+ * nvme_ns_get_lba_util() - LBA utilization of a namespace
  * @n:	Namespace instance
  *
- * Return: LBA utilisation of @n
+ * Return: LBA utilization of @n
  */
 uint64_t nvme_ns_get_lba_util(nvme_ns_t n);
 
@@ -805,7 +805,7 @@ const char *nvme_ctrl_get_queue_count(nvme_ctrl_t c);
 
 /**
  * nvme_ctrl_get_serial() - Serial number of a controller
- * @c:	Conroller instance
+ * @c:	Controller instance
  *
  * Return: Serial number string of @c
  */
@@ -1019,7 +1019,7 @@ void nvme_unlink_ctrl(struct nvme_ctrl *c);
  * nvme_subsystem_get_nqn() - Retrieve NQN from subsystem
  * @s:	nvme_subsystem_t object
  *
- * Return: NQN of systemstem
+ * Return: NQN of subsystem
  */
 const char *nvme_subsystem_get_nqn(nvme_subsystem_t s);