spelling: include

Part of #2256

* accelerator
* access
* acknowledge
* address
* adrfam
* aggregation
* allocated
* appearance
* associated
* asynchronously
* authority
* available
* callback
* compare
* construct
* controller
* course
* definitions
* deinitialize
* descriptor
* destroy
* device
* efficiently
* elasticity
* failure
* frequency
* function
* hdgst
* implementation
* indefinitely
* initialization
* initialize
* initiator
* interrupt
* malicious
* management
* milliseconds
* namespace
* negative
* notification
* obtained
* otherwise
* passed
* positive
* request
* responded
* semantics
* sequence
* should
* specified
* structure
* subsystem
* successful
* synchronously
* transport

Change-Id: I808876a3b4b2dc56f95cfc42bc88336cfeec4288
Signed-off-by: Josh Soref <jsoref@gmail.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/10404
Community-CI: Mellanox Build Bot
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
This commit is contained in:
Josh Soref 2021-11-24 20:40:58 -05:00 committed by Tomasz Zawadzki
parent b7876f9a63
commit 0c1fcc7705
33 changed files with 69 additions and 69 deletions

View File

@ -225,7 +225,7 @@ int spdk_accel_submit_dualcast(struct spdk_io_channel *ch, void *dst1, void *dst
/** /**
* Synchronous call to prepare a compare request into a previously initialized batch * Synchronous call to prepare a compare request into a previously initialized batch
* created with spdk_accel_batch_create(). The callback will be called when the comapre * created with spdk_accel_batch_create(). The callback will be called when the compare
* completes after the batch has been submitted by an asynchronous call to * completes after the batch has been submitted by an asynchronous call to
* spdk_accel_batch_submit(). * spdk_accel_batch_submit().
* *

View File

@ -381,7 +381,7 @@ void spdk_bdev_close(struct spdk_bdev_desc *desc);
/** /**
* Get the bdev associated with a bdev descriptor. * Get the bdev associated with a bdev descriptor.
* *
* \param desc Open block device desciptor * \param desc Open block device descriptor
* \return bdev associated with the descriptor * \return bdev associated with the descriptor
*/ */
struct spdk_bdev *spdk_bdev_desc_get_bdev(struct spdk_bdev_desc *desc); struct spdk_bdev *spdk_bdev_desc_get_bdev(struct spdk_bdev_desc *desc);
@ -592,7 +592,7 @@ bool spdk_bdev_is_md_separate(const struct spdk_bdev *bdev);
* Checks if bdev supports zoned namespace semantics. * Checks if bdev supports zoned namespace semantics.
* *
* \param bdev Block device to query. * \param bdev Block device to query.
* \return true if device supports zoned namespace sementics. * \return true if device supports zoned namespace semantics.
*/ */
bool spdk_bdev_is_zoned(const struct spdk_bdev *bdev); bool spdk_bdev_is_zoned(const struct spdk_bdev *bdev);
@ -1826,7 +1826,7 @@ void spdk_bdev_histogram_get(struct spdk_bdev *bdev, struct spdk_histogram_data
* devices exposing raw access to the physical medium (e.g. Open Channel SSD). * devices exposing raw access to the physical medium (e.g. Open Channel SSD).
* *
* \param bdev_desc Block device descriptor * \param bdev_desc Block device descriptor
* \param events Array of media mangement event descriptors * \param events Array of media management event descriptors
* \param max_events Size of the events array * \param max_events Size of the events array
* *
* \return number of events retrieved * \return number of events retrieved

View File

@ -553,7 +553,7 @@ typedef void (*spdk_bdev_io_get_buf_cb)(struct spdk_io_channel *ch, struct spdk_
* *
* \param ch The I/O channel the bdev I/O was handled on. * \param ch The I/O channel the bdev I/O was handled on.
* \param bdev_io The bdev I/O * \param bdev_io The bdev I/O
* \param aux_buf Pointer to the allocated buffer. NULL if there was a failuer such as * \param aux_buf Pointer to the allocated buffer. NULL if there was a failure such as
* the size of the buffer to allocate is greater than the permitted maximum. * the size of the buffer to allocate is greater than the permitted maximum.
*/ */
typedef void (*spdk_bdev_io_get_aux_buf_cb)(struct spdk_io_channel *ch, typedef void (*spdk_bdev_io_get_aux_buf_cb)(struct spdk_io_channel *ch,
@ -1170,7 +1170,7 @@ void spdk_bdev_part_base_hotremove(struct spdk_bdev_part_base *part_base,
* \param channel_size Channel size in bytes. * \param channel_size Channel size in bytes.
* \param ch_create_cb Called after a new channel is allocated. * \param ch_create_cb Called after a new channel is allocated.
* \param ch_destroy_cb Called upon channel deletion. * \param ch_destroy_cb Called upon channel deletion.
* \param base output parameter for the part object when operation is succssful. * \param base output parameter for the part object when operation is successful.
* *
* \return 0 if operation is successful, or suitable errno value otherwise. * \return 0 if operation is successful, or suitable errno value otherwise.
*/ */

View File

@ -305,7 +305,7 @@ void spdk_bs_unload(struct spdk_blob_store *bs, spdk_bs_op_complete cb_fn, void
/** /**
* Set a super blob on the given blobstore. * Set a super blob on the given blobstore.
* *
* This will be retrievable immediately after spdk_bs_load() on the next initializaiton. * This will be retrievable immediately after spdk_bs_load() on the next initialization.
* *
* \param bs blobstore. * \param bs blobstore.
* \param blobid The id of the blob which will be set as the super blob. * \param blobid The id of the blob which will be set as the super blob.
@ -780,7 +780,7 @@ void spdk_blob_io_readv(struct spdk_blob *blob, struct spdk_io_channel *channel,
/** /**
* Unmap 'length' io_units beginning at 'offset' io_units on the blob as unused. Unmapped * Unmap 'length' io_units beginning at 'offset' io_units on the blob as unused. Unmapped
* io_units may allow the underlying storage media to behave more effciently. * io_units may allow the underlying storage media to behave more efficiently.
* *
* \param blob Blob to unmap. * \param blob Blob to unmap.
* \param channel I/O channel used to submit requests. * \param channel I/O channel used to submit requests.

View File

@ -120,7 +120,7 @@ typedef void (*fs_send_request_fn)(fs_request_fn fn, void *arg);
/** /**
* Initialize a spdk_blobfs_opts structure to the default option values. * Initialize a spdk_blobfs_opts structure to the default option values.
* *
* \param opts spdk_blobf_opts struture to intialize. * \param opts spdk_blobf_opts structure to initialize.
*/ */
void spdk_fs_opts_init(struct spdk_blobfs_opts *opts); void spdk_fs_opts_init(struct spdk_blobfs_opts *opts);
@ -237,7 +237,7 @@ int spdk_fs_create_file(struct spdk_filesystem *fs, struct spdk_fs_thread_ctx *c
* \param ctx The thread context for this operation * \param ctx The thread context for this operation
* \param name The file name used to look up the matched file in the blobstore filesystem. * \param name The file name used to look up the matched file in the blobstore filesystem.
* \param flags This flags will be used to control the open mode. * \param flags This flags will be used to control the open mode.
* \param file It will point to the open file if sccessful or NULL otherwirse. * \param file It will point to the open file if successful or NULL otherwise.
* *
* \return 0 on success, negative errno on failure. * \return 0 on success, negative errno on failure.
*/ */

View File

@ -135,7 +135,7 @@ int spdk_conf_section_get_num(const struct spdk_conf_section *sp);
* *
* If key appears multiple times, idx1 will control which version to retrieve. * If key appears multiple times, idx1 will control which version to retrieve.
* Indices will start from the top of the configuration file at 0 and increment * Indices will start from the top of the configuration file at 0 and increment
* by one for each new apperarance. If the configuration key contains multiple * by one for each new appearance. If the configuration key contains multiple
* whitespace delimited values, idx2 controls which value is returned. The index * whitespace delimited values, idx2 controls which value is returned. The index
* begins at 0. * begins at 0.
* *

View File

@ -309,7 +309,7 @@ int spdk_memory_domain_push_data(struct spdk_memory_domain *dst_domain, void *ds
* \param src_domain_ctx User defined context * \param src_domain_ctx User defined context
* \param dst_domain Memory domain in which memory space data buffer should be translated * \param dst_domain Memory domain in which memory space data buffer should be translated
* \param dst_domain_ctx Ancillary data for dst_domain * \param dst_domain_ctx Ancillary data for dst_domain
* \param addr Addres in \b src_domain memory space * \param addr Address in \b src_domain memory space
* \param len Length of the data * \param len Length of the data
* \param result Translation result. The content of the translation result is only valid if this * \param result Translation result. The content of the translation result is only valid if this
* function returns 0. * function returns 0.

View File

@ -360,7 +360,7 @@ typedef void (spdk_mempool_obj_cb_t)(struct spdk_mempool *mp,
* SPDK_MEMPOOL_DEFAULT_CACHE_SIZE for a reasonable default, or 0 for no per-core cache. * SPDK_MEMPOOL_DEFAULT_CACHE_SIZE for a reasonable default, or 0 for no per-core cache.
* \param socket_id Socket ID to allocate memory on, or SPDK_ENV_SOCKET_ID_ANY * \param socket_id Socket ID to allocate memory on, or SPDK_ENV_SOCKET_ID_ANY
* for any socket. * for any socket.
* \param obj_init User provided object calllback initialization function. * \param obj_init User provided object callback initialization function.
* \param obj_init_arg User provided callback initialization function argument. * \param obj_init_arg User provided callback initialization function argument.
* *
* \return a pointer to the created memory pool. * \return a pointer to the created memory pool.
@ -516,7 +516,7 @@ typedef int (*thread_start_fn)(void *);
* *
* \param core The core to pin the thread to. * \param core The core to pin the thread to.
* \param fn Entry point on the new thread. * \param fn Entry point on the new thread.
* \param arg Argument apssed to thread_start_fn * \param arg Argument passed to thread_start_fn
* *
* \return 0 on success, negative errno on failure. * \return 0 on success, negative errno on failure.
*/ */
@ -1133,7 +1133,7 @@ int spdk_pci_addr_compare(const struct spdk_pci_addr *a1, const struct spdk_pci_
/** /**
* Convert a string representation of a PCI address into a struct spdk_pci_addr. * Convert a string representation of a PCI address into a struct spdk_pci_addr.
* *
* \param addr PCI adddress output on success. * \param addr PCI address output on success.
* \param bdf PCI address in domain:bus:device.function format or * \param bdf PCI address in domain:bus:device.function format or
* domain.bus.device.function format. * domain.bus.device.function format.
* *

View File

@ -57,7 +57,7 @@ extern "C" {
int spdk_env_dpdk_post_init(bool legacy_mem); int spdk_env_dpdk_post_init(bool legacy_mem);
/** /**
* Release any resources of the environment library that were alllocated with * Release any resources of the environment library that were allocated with
* spdk_env_dpdk_post_init(). After this call, no DPDK function calls may * spdk_env_dpdk_post_init(). After this call, no DPDK function calls may
* be made. It is expected that common usage of this function is to call it * be made. It is expected that common usage of this function is to call it
* just before terminating the process. * just before terminating the process.

View File

@ -77,7 +77,7 @@ struct spdk_poller;
typedef void (*spdk_app_shutdown_cb)(void); typedef void (*spdk_app_shutdown_cb)(void);
/** /**
* Signal handler fucntion. * Signal handler function.
* *
* \param signal Signal number. * \param signal Signal number.
*/ */
@ -175,7 +175,7 @@ void spdk_app_opts_init(struct spdk_app_opts *opts, size_t opts_size);
* allows start_fn to be finally called. * allows start_fn to be finally called.
* *
* This call will block until spdk_app_stop() is called. If an error * This call will block until spdk_app_stop() is called. If an error
* condition occurs during the intialization code within spdk_app_start(), * condition occurs during the initialization code within spdk_app_start(),
* this function will immediately return before invoking start_fn. * this function will immediately return before invoking start_fn.
* *
* \param opts_user Initialization options used for this application. It should not be * \param opts_user Initialization options used for this application. It should not be

View File

@ -87,7 +87,7 @@ void spdk_fd_group_destroy(struct spdk_fd_group *fgrp);
* *
* \param fgrp The fgrp to wait and process. * \param fgrp The fgrp to wait and process.
* \param timeout Specifies the number of milliseconds that will block. * \param timeout Specifies the number of milliseconds that will block.
* -1 causes indefinitedly blocking; 0 causes immediately return. * -1 causes indefinitely blocking; 0 causes immediately return.
* *
* \return the number of processed events * \return the number of processed events
* or -errno if failed * or -errno if failed

View File

@ -132,7 +132,7 @@ void spdk_idxd_set_config(uint32_t config_number, bool kernel_mode);
/** /**
* Return the max number of descriptors per batch for IDXD. * Return the max number of descriptors per batch for IDXD.
* *
* \return max number of desciptors per batch. * \return max number of descriptors per batch.
*/ */
uint32_t spdk_idxd_batch_get_max(void); uint32_t spdk_idxd_batch_get_max(void);

View File

@ -484,7 +484,7 @@ struct iscsi_bhs_text_resp {
#define ISCSI_TEXT_CONTINUE 0x40 #define ISCSI_TEXT_CONTINUE 0x40
/* datain flags */ /* datain flags */
#define ISCSI_DATAIN_ACKNOLWEDGE 0x40 #define ISCSI_DATAIN_ACKNOWLEDGE 0x40
#define ISCSI_DATAIN_OVERFLOW 0x04 #define ISCSI_DATAIN_OVERFLOW 0x04
#define ISCSI_DATAIN_UNDERFLOW 0x02 #define ISCSI_DATAIN_UNDERFLOW 0x02
#define ISCSI_DATAIN_STATUS 0x01 #define ISCSI_DATAIN_STATUS 0x01

View File

@ -280,7 +280,7 @@ int spdk_json_write_named_array_begin(struct spdk_json_write_ctx *w, const char
int spdk_json_write_named_object_begin(struct spdk_json_write_ctx *w, const char *name); int spdk_json_write_named_object_begin(struct spdk_json_write_ctx *w, const char *name);
/** /**
* Return JSON value asociated with key \c key_name. Subobjects won't be searched. * Return JSON value associated with key \c key_name. Subobjects won't be searched.
* *
* \param object JSON object to be examined * \param object JSON object to be examined
* \param key_name name of the key * \param key_name name of the key

View File

@ -97,7 +97,7 @@ typedef void (*spdk_jsonrpc_conn_closed_fn)(struct spdk_jsonrpc_server_conn *con
* Function for specific RPC method response parsing handlers. * Function for specific RPC method response parsing handlers.
* *
* \param parser_ctx context where analysis are put. * \param parser_ctx context where analysis are put.
* \param result json values responsed to this method. * \param result json values responded to this method.
* *
* \return 0 on success. * \return 0 on success.
* SPDK_JSON_PARSE_INVALID on failure. * SPDK_JSON_PARSE_INVALID on failure.
@ -154,7 +154,7 @@ struct spdk_jsonrpc_server_conn *spdk_jsonrpc_get_conn(struct spdk_jsonrpc_reque
* \note Current implementation allow only one close callback per connection. * \note Current implementation allow only one close callback per connection.
* *
* \param conn JSON RPC server connection * \param conn JSON RPC server connection
* \param cb calback function * \param cb callback function
* \param ctx argument for \c cb * \param ctx argument for \c cb
* *
* \return 0 on success, or negated errno code: * \return 0 on success, or negated errno code:
@ -169,7 +169,7 @@ int spdk_jsonrpc_conn_add_close_cb(struct spdk_jsonrpc_server_conn *conn,
* Remove registered close callback. * Remove registered close callback.
* *
* \param conn JSON RPC server connection * \param conn JSON RPC server connection
* \param cb calback function * \param cb callback function
* \param ctx argument for \c cb * \param ctx argument for \c cb
* *
* \return 0 on success, or negated errno code: * \return 0 on success, or negated errno code:
@ -319,7 +319,7 @@ int spdk_jsonrpc_client_send_request(struct spdk_jsonrpc_client *client,
* a time while no other threads are actively \c client object. * a time while no other threads are actively \c client object.
* *
* \param client JSON-RPC client. * \param client JSON-RPC client.
* \param timeout Time in miliseconds this function will block. -1 block forever, 0 don't block. * \param timeout Time in milliseconds this function will block. -1 block forever, 0 don't block.
* *
* \return If no error occurred, this function returns a non-negative number indicating how * \return If no error occurred, this function returns a non-negative number indicating how
* many ready responses can be retrieved. If an error occurred, this function returns one of * many ready responses can be retrieved. If an error occurred, this function returns one of

View File

@ -112,7 +112,7 @@ uint64_t spdk_notify_send(const char *type, const char *ctx);
* *
* \param start_idx First event index * \param start_idx First event index
* \param cb_fn User callback function. Return non-zero to break iteration. * \param cb_fn User callback function. Return non-zero to break iteration.
* \param max Maximum number of invocations of user calback function. * \param max Maximum number of invocations of user callback function.
* \param ctx User context * \param ctx User context
* \return Number of user callback invocations * \return Number of user callback invocations
*/ */

View File

@ -277,7 +277,7 @@ struct spdk_nvme_ctrlr_opts {
typedef void (*spdk_nvme_accel_completion_cb)(void *cb_arg, int status); typedef void (*spdk_nvme_accel_completion_cb)(void *cb_arg, int status);
/** /**
* Function table for the NVMe acccelerator device. * Function table for the NVMe accelerator device.
* *
* This table provides a set of APIs to allow user to leverage * This table provides a set of APIs to allow user to leverage
* accelerator functions. * accelerator functions.
@ -436,7 +436,7 @@ struct spdk_nvme_transport_id {
/** /**
* Transport service id of the NVMe-oF endpoint. For transports which use * Transport service id of the NVMe-oF endpoint. For transports which use
* IP addressing (e.g. RDMA), this field shoud be the port number. For PCIe, * IP addressing (e.g. RDMA), this field should be the port number. For PCIe,
* and FC this is always a zero length string. * and FC this is always a zero length string.
*/ */
char trsvcid[SPDK_NVMF_TRSVCID_MAX_LEN + 1]; char trsvcid[SPDK_NVMF_TRSVCID_MAX_LEN + 1];
@ -629,7 +629,7 @@ void spdk_nvme_trid_populate_transport(struct spdk_nvme_transport_id *trid,
int spdk_nvme_host_id_parse(struct spdk_nvme_host_id *hostid, const char *str); int spdk_nvme_host_id_parse(struct spdk_nvme_host_id *hostid, const char *str);
/** /**
* Parse the string representation of a transport ID tranport type into the trid struct. * Parse the string representation of a transport ID transport type into the trid struct.
* *
* \param trid The trid to write to * \param trid The trid to write to
* \param trstring Input string representation of transport type (e.g. "PCIe", "RDMA"). * \param trstring Input string representation of transport type (e.g. "PCIe", "RDMA").
@ -641,7 +641,7 @@ int spdk_nvme_transport_id_populate_trstring(struct spdk_nvme_transport_id *trid
const char *trstring); const char *trstring);
/** /**
* Parse the string representation of a transport ID tranport type. * Parse the string representation of a transport ID transport type.
* *
* \param trtype Output transport type (allocated by caller). * \param trtype Output transport type (allocated by caller).
* \param str Input string representation of transport type (e.g. "PCIe", "RDMA"). * \param str Input string representation of transport type (e.g. "PCIe", "RDMA").
@ -665,12 +665,12 @@ const char *spdk_nvme_transport_id_trtype_str(enum spdk_nvme_transport_type trty
* *
* \param adrfam Address family to convert. * \param adrfam Address family to convert.
* *
* \return static string constant describing adrfam, or NULL if adrmfam not found. * \return static string constant describing adrfam, or NULL if adrfam not found.
*/ */
const char *spdk_nvme_transport_id_adrfam_str(enum spdk_nvmf_adrfam adrfam); const char *spdk_nvme_transport_id_adrfam_str(enum spdk_nvmf_adrfam adrfam);
/** /**
* Parse the string representation of a tranport ID address family. * Parse the string representation of a transport ID address family.
* *
* \param adrfam Output address family (allocated by caller). * \param adrfam Output address family (allocated by caller).
* \param str Input string representation of address family (e.g. "IPv4", "IPv6"). * \param str Input string representation of address family (e.g. "IPv4", "IPv6").
@ -931,7 +931,7 @@ struct spdk_nvme_probe_ctx *spdk_nvme_probe_async(const struct spdk_nvme_transpo
spdk_nvme_remove_cb remove_cb); spdk_nvme_remove_cb remove_cb);
/** /**
* Proceed with attaching contollers associated with the probe context. * Proceed with attaching controllers associated with the probe context.
* *
* The probe context is one returned from a previous call to * The probe context is one returned from a previous call to
* spdk_nvme_probe_async(). Users must call this function on the * spdk_nvme_probe_async(). Users must call this function on the
@ -1096,7 +1096,7 @@ int spdk_nvme_ctrlr_reset_async(struct spdk_nvme_ctrlr *ctrlr,
struct spdk_nvme_ctrlr_reset_ctx **reset_ctx); struct spdk_nvme_ctrlr_reset_ctx **reset_ctx);
/** /**
* Proceed with resetting contoller associated with the controller reset context. * Proceed with resetting controller associated with the controller reset context.
* *
* The controller reset context is one returned from a previous call to * The controller reset context is one returned from a previous call to
* spdk_nvme_ctrlr_reset_async(). Users must call this function on the * spdk_nvme_ctrlr_reset_async(). Users must call this function on the
@ -1404,7 +1404,7 @@ struct spdk_nvme_qpair;
* Fatal Status field to 1, then reset is required to recover from such error. * Fatal Status field to 1, then reset is required to recover from such error.
* Users may detect Controller Fatal Status when timeout happens. * Users may detect Controller Fatal Status when timeout happens.
* *
* \param cb_arg Argument passed to callback funciton. * \param cb_arg Argument passed to callback function.
* \param ctrlr Opaque handle to NVMe controller. * \param ctrlr Opaque handle to NVMe controller.
* \param qpair Opaque handle to a queue pair. * \param qpair Opaque handle to a queue pair.
* \param cid Command ID. * \param cid Command ID.
@ -1522,7 +1522,7 @@ struct spdk_nvme_io_qpair_opts {
* This flag if set to true enables the creation of submission and completion queue * This flag if set to true enables the creation of submission and completion queue
* asynchronously. This mode is currently supported at PCIe layer and tracks the * asynchronously. This mode is currently supported at PCIe layer and tracks the
* qpair creation with state machine and returns to the user.Default mode is set to * qpair creation with state machine and returns to the user.Default mode is set to
* false to create io qpair synchronosuly. * false to create io qpair synchronously.
*/ */
bool async_mode; bool async_mode;
}; };
@ -1659,7 +1659,7 @@ int spdk_nvme_ctrlr_free_io_qpair(struct spdk_nvme_qpair *qpair);
* *
* The driver sets the CID. EVERYTHING else is assumed set by the caller. * The driver sets the CID. EVERYTHING else is assumed set by the caller.
* Needless to say, this is potentially extremely dangerous for both the host * Needless to say, this is potentially extremely dangerous for both the host
* (accidental/malicionus storage usage/corruption), and the device. * (accidental/malicious storage usage/corruption), and the device.
* Thus its intent is for very specific hardware testing and environment * Thus its intent is for very specific hardware testing and environment
* reproduction. * reproduction.
* *

View File

@ -59,7 +59,7 @@ bool spdk_nvme_ctrlr_is_ocssd_supported(struct spdk_nvme_ctrlr *ctrlr);
/** /**
* \brief Identify geometry of the given namespace. * \brief Identify geometry of the given namespace.
* \param ctrlr NVMe controller to query. * \param ctrlr NVMe controller to query.
* \param nsid Id of the given namesapce. * \param nsid Id of the given namespace.
* \param payload The pointer to the payload buffer. * \param payload The pointer to the payload buffer.
* \param payload_size The size of payload buffer. Shall be multiple of 4K. * \param payload_size The size of payload buffer. Shall be multiple of 4K.
* \param cb_fn Callback function to invoke when the feature has been retrieved. * \param cb_fn Callback function to invoke when the feature has been retrieved.

View File

@ -385,7 +385,7 @@ union spdk_nvme_pmrebs_register {
uint32_t raw; uint32_t raw;
struct { struct {
/** /**
* pmr elasicity buffer size units * pmr elasticity buffer size units
* 0h: Bytes * 0h: Bytes
* 1h: 1 KiB * 1h: 1 KiB
* 2h: 1 MiB * 2h: 1 MiB
@ -836,7 +836,7 @@ union spdk_nvme_feat_interrupt_coalescing {
/** Aggregation Threshold */ /** Aggregation Threshold */
uint32_t thr : 8; uint32_t thr : 8;
/** Aggregration time */ /** Aggregation time */
uint32_t time : 8; uint32_t time : 8;
uint32_t reserved : 16; uint32_t reserved : 16;
@ -1331,7 +1331,7 @@ SPDK_STATIC_ASSERT(sizeof(struct spdk_nvme_cpl) == 16, "Incorrect size");
struct spdk_nvme_dsm_range { struct spdk_nvme_dsm_range {
union { union {
struct { struct {
uint32_t af : 4; /**< access frequencey */ uint32_t af : 4; /**< access frequency */
uint32_t al : 2; /**< access latency */ uint32_t al : 2; /**< access latency */
uint32_t reserved0 : 2; uint32_t reserved0 : 2;
@ -2789,7 +2789,7 @@ struct spdk_nvme_reservation_notification_log {
}; };
SPDK_STATIC_ASSERT(sizeof(struct spdk_nvme_reservation_notification_log) == 64, "Incorrect size"); SPDK_STATIC_ASSERT(sizeof(struct spdk_nvme_reservation_notification_log) == 64, "Incorrect size");
/* Mask Registration Preempted Notificaton */ /* Mask Registration Preempted Notification */
#define SPDK_NVME_REGISTRATION_PREEMPTED_MASK (1U << 1) #define SPDK_NVME_REGISTRATION_PREEMPTED_MASK (1U << 1)
/* Mask Reservation Released Notification */ /* Mask Reservation Released Notification */
#define SPDK_NVME_RESERVATION_RELEASED_MASK (1U << 2) #define SPDK_NVME_RESERVATION_RELEASED_MASK (1U << 2)
@ -3098,7 +3098,7 @@ enum spdk_nvme_async_event_info_notice {
* Asynchronous Event Information for NVM Command Set Specific Status * Asynchronous Event Information for NVM Command Set Specific Status
*/ */
enum spdk_nvme_async_event_info_nvm_command_set { enum spdk_nvme_async_event_info_nvm_command_set {
/* Reservation Log Page Avaiable */ /* Reservation Log Page Available */
SPDK_NVME_ASYNC_EVENT_RESERVATION_LOG_AVAIL = 0x0, SPDK_NVME_ASYNC_EVENT_RESERVATION_LOG_AVAIL = 0x0,
/* Sanitize Operation Completed */ /* Sanitize Operation Completed */
SPDK_NVME_ASYNC_EVENT_SANITIZE_COMPLETED = 0x1, SPDK_NVME_ASYNC_EVENT_SANITIZE_COMPLETED = 0x1,
@ -3139,7 +3139,7 @@ struct spdk_nvme_firmware_page {
SPDK_STATIC_ASSERT(sizeof(struct spdk_nvme_firmware_page) == 512, "Incorrect size"); SPDK_STATIC_ASSERT(sizeof(struct spdk_nvme_firmware_page) == 512, "Incorrect size");
/** /**
* Asymmetric Namespace Acccess page (\ref SPDK_NVME_LOG_ASYMMETRIC_NAMESPACE_ACCESS) * Asymmetric Namespace Access page (\ref SPDK_NVME_LOG_ASYMMETRIC_NAMESPACE_ACCESS)
*/ */
struct spdk_nvme_ana_page { struct spdk_nvme_ana_page {
uint64_t change_count; uint64_t change_count;

View File

@ -385,11 +385,11 @@ typedef void (*nvmf_subsystem_destroy_cb)(void *cb_arg);
* return value is -EINPROGRESS * return value is -EINPROGRESS
* \param cpl_cb_arg Optional user context to be passed to \b cpl_cb * \param cpl_cb_arg Optional user context to be passed to \b cpl_cb
* *
* \retval 0 if sybsystem is destroyed, \b cpl_cb is not called is that case * \retval 0 if subsystem is destroyed, \b cpl_cb is not called is that case
* \retval -EINVAl if \b subsystem is a NULL pointer * \retval -EINVAl if \b subsystem is a NULL pointer
* \retval -EAGAIN if \b subsystem is not in INACTIVE state * \retval -EAGAIN if \b subsystem is not in INACTIVE state
* \retval -EALREADY if subsystem destruction is already started * \retval -EALREADY if subsystem destruction is already started
* \retval -EINPROGRESS if subsystem is destroyed asyncronously, cpl_cb will be called in that case * \retval -EINPROGRESS if subsystem is destroyed asynchronously, cpl_cb will be called in that case
*/ */
int int
spdk_nvmf_subsystem_destroy(struct spdk_nvmf_subsystem *subsystem, nvmf_subsystem_destroy_cb cpl_cb, spdk_nvmf_subsystem_destroy(struct spdk_nvmf_subsystem *subsystem, nvmf_subsystem_destroy_cb cpl_cb,
@ -795,7 +795,7 @@ uint32_t spdk_nvmf_subsystem_add_ns_ext(struct spdk_nvmf_subsystem *subsystem,
const char *ptpl_file); const char *ptpl_file);
/** /**
* Remove a namespace from a subsytem. * Remove a namespace from a subsystem.
* *
* May only be performed on subsystems in the PAUSED or INACTIVE states. * May only be performed on subsystems in the PAUSED or INACTIVE states.
* Additionally, the namespace must be paused. * Additionally, the namespace must be paused.
@ -993,7 +993,7 @@ typedef void (*spdk_nvmf_transport_destroy_done_cb)(void *cb_arg);
/** /**
* Destroy a protocol transport * Destroy a protocol transport
* *
* \param transport The transport to destory * \param transport The transport to destroy
* \param cb_fn A callback that will be called once the transport is destroyed * \param cb_fn A callback that will be called once the transport is destroyed
* \param cb_arg A context argument passed to cb_fn. * \param cb_arg A context argument passed to cb_fn.
* *

View File

@ -44,7 +44,7 @@ enum spdk_nvmf_request_exec_status {
}; };
/** /**
* Fills the identify controller attributes for the specified conroller * Fills the identify controller attributes for the specified controller
* *
* \param ctrlr The NVMe-oF controller * \param ctrlr The NVMe-oF controller
* \param cdata The filled in identify controller attributes * \param cdata The filled in identify controller attributes
@ -54,7 +54,7 @@ int spdk_nvmf_ctrlr_identify_ctrlr(struct spdk_nvmf_ctrlr *ctrlr,
struct spdk_nvme_ctrlr_data *cdata); struct spdk_nvme_ctrlr_data *cdata);
/** /**
* Fills the identify namespace attributes for the specified conroller * Fills the identify namespace attributes for the specified controller
* *
* \param ctrlr The NVMe-oF controller * \param ctrlr The NVMe-oF controller
* \param cmd The NVMe command * \param cmd The NVMe command
@ -107,7 +107,7 @@ void spdk_nvmf_set_passthru_admin_cmd(uint8_t opc, uint32_t forward_nsid);
/** /**
* Callback function that is called right before the admin command reply * Callback function that is called right before the admin command reply
* is sent back to the inititator. * is sent back to the initiator.
* *
* \param req The NVMe-oF request * \param req The NVMe-oF request
*/ */

View File

@ -273,7 +273,7 @@ struct spdk_nvmf_fc_lsdesc_conn_id {
SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_fc_lsdesc_conn_id) == 16, "size_mismatch"); SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_fc_lsdesc_conn_id) == 16, "size_mismatch");
/* /*
* LS decriptor association id * LS descriptor association id
*/ */
struct spdk_nvmf_fc_lsdesc_assoc_id { struct spdk_nvmf_fc_lsdesc_assoc_id {
FCNVME_BE32 desc_tag; FCNVME_BE32 desc_tag;
@ -302,7 +302,7 @@ struct spdk_nvmf_fc_lsdesc_cr_assoc_cmd {
SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_fc_lsdesc_cr_assoc_cmd) == 1016, "size_mismatch"); SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_fc_lsdesc_cr_assoc_cmd) == 1016, "size_mismatch");
/* /*
* LS Create Association reqeust payload * LS Create Association request payload
*/ */
struct spdk_nvmf_fc_ls_cr_assoc_rqst { struct spdk_nvmf_fc_ls_cr_assoc_rqst {
struct spdk_nvmf_fc_ls_rqst_w0 w0; struct spdk_nvmf_fc_ls_rqst_w0 w0;

View File

@ -646,7 +646,7 @@ enum spdk_nvme_tcp_term_req_fes {
struct spdk_nvme_tcp_cmd { struct spdk_nvme_tcp_cmd {
struct spdk_nvme_tcp_common_pdu_hdr common; struct spdk_nvme_tcp_common_pdu_hdr common;
struct spdk_nvme_cmd ccsqe; struct spdk_nvme_cmd ccsqe;
/**< icdoff hdgest padding + in-capsule data + ddgst (if enabled) */ /**< icdoff hdgst padding + in-capsule data + ddgst (if enabled) */
}; };
SPDK_STATIC_ASSERT(sizeof(struct spdk_nvme_tcp_cmd) == 72, "Incorrect size"); SPDK_STATIC_ASSERT(sizeof(struct spdk_nvme_tcp_cmd) == 72, "Incorrect size");
SPDK_STATIC_ASSERT(offsetof(struct spdk_nvme_tcp_cmd, ccsqe) == 8, "Incorrect offset"); SPDK_STATIC_ASSERT(offsetof(struct spdk_nvme_tcp_cmd, ccsqe) == 8, "Incorrect offset");

View File

@ -179,7 +179,7 @@ enum spdk_opal_token {
/* life cycle */ /* life cycle */
SPDK_OPAL_LIFECYCLE = 0x06, SPDK_OPAL_LIFECYCLE = 0x06,
/* Autority table */ /* Authority table */
SPDK_OPAL_AUTH_ENABLE = 0x05, SPDK_OPAL_AUTH_ENABLE = 0x05,
/* ACE table */ /* ACE table */

View File

@ -130,7 +130,7 @@ struct spdk_governor {
/** /**
* Set the current governor. * Set the current governor.
* *
* Always deinitalizes previously set governor. * Always deinitializes previously set governor.
* No governor will be set if name parameter is NULL. * No governor will be set if name parameter is NULL.
* This function should be invoked on scheduling reactor. * This function should be invoked on scheduling reactor.
* *
@ -229,7 +229,7 @@ struct spdk_scheduler {
/** /**
* Change current scheduler. If another scheduler was used prior, * Change current scheduler. If another scheduler was used prior,
* it will be deinitalized. No scheduler will be set if name parameter * it will be deinitialized. No scheduler will be set if name parameter
* is NULL. * is NULL.
* This function should be invoked from scheduling reactor. * This function should be invoked from scheduling reactor.
* *

View File

@ -255,7 +255,7 @@ bool spdk_scsi_dev_has_pending_tasks(const struct spdk_scsi_dev *dev,
const struct spdk_scsi_port *initiator_port); const struct spdk_scsi_port *initiator_port);
/** /**
* Destruct the SCSI decice. * Destruct the SCSI device.
* *
* \param dev SCSI device. * \param dev SCSI device.
* \param cb_fn Callback function. * \param cb_fn Callback function.
@ -454,7 +454,7 @@ const char *spdk_scsi_port_get_name(const struct spdk_scsi_port *port);
/** /**
* Construct a new SCSI task. * Construct a new SCSI task.
* *
* \param task SCSI task to consturct. * \param task SCSI task to construct.
* \param cpl_fn Called when the task is completed. * \param cpl_fn Called when the task is completed.
* \param free_fn Called when the task is freed * \param free_fn Called when the task is freed
*/ */

View File

@ -700,7 +700,7 @@ struct spdk_thread *spdk_io_channel_get_thread(struct spdk_io_channel *ch);
* *
* \param io_device 'fn' will be called on each channel associated with this io_device. * \param io_device 'fn' will be called on each channel associated with this io_device.
* \param fn Called on the appropriate thread for each channel associated with io_device. * \param fn Called on the appropriate thread for each channel associated with io_device.
* \param ctx Context buffer registered to spdk_io_channel_iter that can be obatined * \param ctx Context buffer registered to spdk_io_channel_iter that can be obtained
* form the function spdk_io_channel_iter_get_ctx(). * form the function spdk_io_channel_iter_get_ctx().
* \param cpl Called on the thread that spdk_for_each_channel was initially called * \param cpl Called on the thread that spdk_for_each_channel was initially called
* from when 'fn' has been called on each channel. * from when 'fn' has been called on each channel.

View File

@ -93,7 +93,7 @@ void spdk_trace_parser_cleanup(struct spdk_trace_parser *parser);
const struct spdk_trace_flags *spdk_trace_parser_get_flags(const struct spdk_trace_parser *parser); const struct spdk_trace_flags *spdk_trace_parser_get_flags(const struct spdk_trace_parser *parser);
/** /**
* Return the highest tsc out of first entries across all speicifed cores. This value can be used * Return the highest tsc out of first entries across all specified cores. This value can be used
* to select entries from the subset of time we have the data from all reactors. * to select entries from the subset of time we have the data from all reactors.
* *
* \param parser Parser object to be used. * \param parser Parser object to be used.

View File

@ -140,7 +140,7 @@ size_t spdk_iovcpy(struct iovec *siov, size_t siovcnt, struct iovec *diov, size_
/** /**
* Scan build is really pessimistic and assumes that mempool functions can * Scan build is really pessimistic and assumes that mempool functions can
* dequeue NULL buffers even if they return success. This is obviously a false * dequeue NULL buffers even if they return success. This is obviously a false
* possitive, but the mempool dequeue can be done in a DPDK inline function that * positive, but the mempool dequeue can be done in a DPDK inline function that
* we can't decorate with usual assert(buf != NULL). Instead, we'll * we can't decorate with usual assert(buf != NULL). Instead, we'll
* preinitialize the dequeued buffer array with some dummy objects. * preinitialize the dequeued buffer array with some dummy objects.
*/ */
@ -154,7 +154,7 @@ size_t spdk_iovcpy(struct iovec *siov, size_t siovcnt, struct iovec *diov, size_
} while (0) } while (0)
/** /**
* Add two sequece numbers s1 and s2 * Add two sequence numbers s1 and s2
* *
* \param s1 First sequence number * \param s1 First sequence number
* \param s2 Second sequence number * \param s2 Second sequence number

View File

@ -184,7 +184,7 @@ const struct spdk_cpuset *spdk_vhost_dev_get_cpumask(struct spdk_vhost_dev *vdev
* high IOPS this prove to be inefficient both for guest kernel that have to * high IOPS this prove to be inefficient both for guest kernel that have to
* handle a lot more IO completions and for SPDK vhost that need to make more * handle a lot more IO completions and for SPDK vhost that need to make more
* syscalls. If enabled, limit amount of events (IRQs) sent to initiator by SPDK * syscalls. If enabled, limit amount of events (IRQs) sent to initiator by SPDK
* vhost effectively coalescing couple of completions. This of cource introduce * vhost effectively coalescing couple of completions. This of course introduce
* IO latency penalty proportional to event delay time. * IO latency penalty proportional to event delay time.
* *
* Actual events delay time when is calculated according to below formula: * Actual events delay time when is calculated according to below formula:

View File

@ -148,10 +148,10 @@ void spdk_for_each_reactor(spdk_event_fn fn, void *arg1, void *arg2, spdk_event_
* *
* \param lcore CPU core index of specified reactor. * \param lcore CPU core index of specified reactor.
* \param new_in_interrupt Set interrupt mode for true, or poll mode for false. * \param new_in_interrupt Set interrupt mode for true, or poll mode for false.
* \param cb_fn This will be called on spdk application thread after setting interupt mode. * \param cb_fn This will be called on spdk application thread after setting interrupt mode.
* \param cb_arg Argument will be passed to cb_fn when called. * \param cb_arg Argument will be passed to cb_fn when called.
* *
* \return 0 on success, negtive errno on failure. * \return 0 on success, negative errno on failure.
*/ */
int spdk_reactor_set_interrupt_mode(uint32_t lcore, bool new_in_interrupt, int spdk_reactor_set_interrupt_mode(uint32_t lcore, bool new_in_interrupt,
spdk_reactor_set_interrupt_mode_cb cb_fn, void *cb_arg); spdk_reactor_set_interrupt_mode_cb cb_fn, void *cb_arg);

View File

@ -88,7 +88,7 @@
} \ } \
} }
/* DEFINE_STUB is for defining the implmentation of stubs for SPDK funcs. */ /* DEFINE_STUB is for defining the implementation of stubs for SPDK funcs. */
#define DEFINE_STUB(fn, ret, dargs, val) \ #define DEFINE_STUB(fn, ret, dargs, val) \
bool ut_ ## fn ## _mocked = true; \ bool ut_ ## fn ## _mocked = true; \
ret ut_ ## fn = val; \ ret ut_ ## fn = val; \

View File

@ -110,7 +110,7 @@
#define TRACE_RDMA_QP_DISCONNECT SPDK_TPOINT_ID(TRACE_GROUP_NVMF_RDMA, 0x10) #define TRACE_RDMA_QP_DISCONNECT SPDK_TPOINT_ID(TRACE_GROUP_NVMF_RDMA, 0x10)
#define TRACE_RDMA_QP_DESTROY SPDK_TPOINT_ID(TRACE_GROUP_NVMF_RDMA, 0x11) #define TRACE_RDMA_QP_DESTROY SPDK_TPOINT_ID(TRACE_GROUP_NVMF_RDMA, 0x11)
/* Thread tracepoint definitons */ /* Thread tracepoint definitions */
#define TRACE_THREAD_IOCH_GET SPDK_TPOINT_ID(TRACE_GROUP_THREAD, 0x0) #define TRACE_THREAD_IOCH_GET SPDK_TPOINT_ID(TRACE_GROUP_THREAD, 0x0)
#define TRACE_THREAD_IOCH_PUT SPDK_TPOINT_ID(TRACE_GROUP_THREAD, 0x1) #define TRACE_THREAD_IOCH_PUT SPDK_TPOINT_ID(TRACE_GROUP_THREAD, 0x1)