.. _sec-c-api-xnvme: ======= xnvme ======= .. _sec-c-api-xnvme-header: Header ====== .. literalinclude:: ../../include/libxnvme.h :language: c .. _sec-c-api-xnvme-enum: Enums ===== .. _sec-c-api-xnvme-enum-xnvme_enumerate_action: xnvme_enumerate_action ---------------------- .. doxygenenum:: xnvme_enumerate_action .. _sec-c-api-xnvme-enum-xnvme_pi_check_type: xnvme_pi_check_type ------------------- .. doxygenenum:: xnvme_pi_check_type .. _sec-c-api-xnvme-enum-xnvme_pi_type: xnvme_pi_type ------------- .. doxygenenum:: xnvme_pi_type .. _sec-c-api-xnvme-enum-xnvme_pr: xnvme_pr -------- .. doxygenenum:: xnvme_pr .. _sec-c-api-xnvme-enum-xnvme_retreive_opts: xnvme_retreive_opts ------------------- .. doxygenenum:: xnvme_retreive_opts .. _sec-c-api-xnvme-enum-xnvme_store_opts: xnvme_store_opts ---------------- .. doxygenenum:: xnvme_store_opts .. _sec-c-api-xnvme-struct: Structs ======= .. _sec-c-api-xnvme-struct-xnvme_be_attr: xnvme_be_attr ------------- .. doxygenstruct:: xnvme_be_attr :members: :undoc-members: .. _sec-c-api-xnvme-struct-xnvme_be_attr_list: xnvme_be_attr_list ------------------ .. doxygenstruct:: xnvme_be_attr_list :members: :undoc-members: .. _sec-c-api-xnvme-struct-xnvme_controller: xnvme_controller ---------------- .. doxygenstruct:: xnvme_controller :members: :undoc-members: .. _sec-c-api-xnvme-struct-xnvme_namespace: xnvme_namespace --------------- .. doxygenstruct:: xnvme_namespace :members: :undoc-members: .. _sec-c-api-xnvme-struct-xnvme_pi_ctx: xnvme_pi_ctx ------------ .. doxygenstruct:: xnvme_pi_ctx :members: :undoc-members: .. _sec-c-api-xnvme-struct-xnvme_pif: xnvme_pif --------- .. doxygenstruct:: xnvme_pif :members: :undoc-members: .. _sec-c-api-xnvme-struct-xnvme_subsystem: xnvme_subsystem --------------- .. doxygenstruct:: xnvme_subsystem :members: :undoc-members: .. _sec-c-api-xnvme-struct-xnvme_timer: xnvme_timer ----------- .. doxygenstruct:: xnvme_timer :members: :undoc-members: .. _sec-c-api-xnvme-func: Functions ========= .. _sec-c-api-xnvme-func-XNVME_ILOG2: XNVME_ILOG2 ----------- .. doxygenfunction:: XNVME_ILOG2 .. _sec-c-api-xnvme-func-XNVME_MAX: XNVME_MAX --------- .. doxygenfunction:: XNVME_MAX .. _sec-c-api-xnvme-func-XNVME_MIN: XNVME_MIN --------- .. doxygenfunction:: XNVME_MIN .. _sec-c-api-xnvme-func-XNVME_MIN_S64: XNVME_MIN_S64 ------------- .. doxygenfunction:: XNVME_MIN_S64 .. _sec-c-api-xnvme-func-XNVME_MIN_U64: XNVME_MIN_U64 ------------- .. doxygenfunction:: XNVME_MIN_U64 .. _sec-c-api-xnvme-func-XNVME_SIZEOF_MEMBER: XNVME_SIZEOF_MEMBER ------------------- .. doxygenfunction:: XNVME_SIZEOF_MEMBER .. _sec-c-api-xnvme-func-XNVME_SIZEOF_MEMBER: XNVME_SIZEOF_MEMBER ------------------- .. doxygenfunction:: XNVME_SIZEOF_MEMBER .. _sec-c-api-xnvme-func-xnvme_be_attr_fpr: xnvme_be_attr_fpr ----------------- .. doxygenfunction:: xnvme_be_attr_fpr .. _sec-c-api-xnvme-func-xnvme_be_attr_list_bundled: xnvme_be_attr_list_bundled -------------------------- .. doxygenfunction:: xnvme_be_attr_list_bundled .. _sec-c-api-xnvme-func-xnvme_be_attr_list_fpr: xnvme_be_attr_list_fpr ---------------------- .. doxygenfunction:: xnvme_be_attr_list_fpr .. _sec-c-api-xnvme-func-xnvme_be_attr_list_pr: xnvme_be_attr_list_pr --------------------- .. doxygenfunction:: xnvme_be_attr_list_pr .. _sec-c-api-xnvme-func-xnvme_be_attr_pr: xnvme_be_attr_pr ---------------- .. doxygenfunction:: xnvme_be_attr_pr .. _sec-c-api-xnvme-func-xnvme_controller_get_registers: xnvme_controller_get_registers ------------------------------ .. doxygenfunction:: xnvme_controller_get_registers .. _sec-c-api-xnvme-func-xnvme_controller_reset: xnvme_controller_reset ---------------------- .. doxygenfunction:: xnvme_controller_reset .. _sec-c-api-xnvme-func-xnvme_enumerate: xnvme_enumerate --------------- .. doxygenfunction:: xnvme_enumerate .. _sec-c-api-xnvme-func-xnvme_is_pow2: xnvme_is_pow2 ------------- .. doxygenfunction:: xnvme_is_pow2 .. _sec-c-api-xnvme-func-xnvme_namespace_rescan: xnvme_namespace_rescan ---------------------- .. doxygenfunction:: xnvme_namespace_rescan .. _sec-c-api-xnvme-func-xnvme_pi_ctx_init: xnvme_pi_ctx_init ----------------- .. doxygenfunction:: xnvme_pi_ctx_init .. _sec-c-api-xnvme-func-xnvme_pi_generate: xnvme_pi_generate ----------------- .. doxygenfunction:: xnvme_pi_generate .. _sec-c-api-xnvme-func-xnvme_pi_size: xnvme_pi_size ------------- .. doxygenfunction:: xnvme_pi_size .. _sec-c-api-xnvme-func-xnvme_pi_verify: xnvme_pi_verify --------------- .. doxygenfunction:: xnvme_pi_verify .. _sec-c-api-xnvme-func-xnvme_prep_adm_gfeat: xnvme_prep_adm_gfeat -------------------- .. doxygenfunction:: xnvme_prep_adm_gfeat .. _sec-c-api-xnvme-func-xnvme_prep_adm_log: xnvme_prep_adm_log ------------------ .. doxygenfunction:: xnvme_prep_adm_log .. _sec-c-api-xnvme-func-xnvme_prep_adm_sfeat: xnvme_prep_adm_sfeat -------------------- .. doxygenfunction:: xnvme_prep_adm_sfeat .. _sec-c-api-xnvme-func-xnvme_prep_nvm: xnvme_prep_nvm -------------- .. doxygenfunction:: xnvme_prep_nvm .. _sec-c-api-xnvme-func-xnvme_subsystem_reset: xnvme_subsystem_reset --------------------- .. doxygenfunction:: xnvme_subsystem_reset .. _sec-c-api-xnvme-func-xnvme_timer_bw_pr: xnvme_timer_bw_pr ----------------- .. doxygenfunction:: xnvme_timer_bw_pr .. _sec-c-api-xnvme-func-xnvme_timer_elapsed: xnvme_timer_elapsed ------------------- .. doxygenfunction:: xnvme_timer_elapsed .. _sec-c-api-xnvme-func-xnvme_timer_elapsed_msecs: xnvme_timer_elapsed_msecs ------------------------- .. doxygenfunction:: xnvme_timer_elapsed_msecs .. _sec-c-api-xnvme-func-xnvme_timer_elapsed_nsecs: xnvme_timer_elapsed_nsecs ------------------------- .. doxygenfunction:: xnvme_timer_elapsed_nsecs .. _sec-c-api-xnvme-func-xnvme_timer_elapsed_secs: xnvme_timer_elapsed_secs ------------------------ .. doxygenfunction:: xnvme_timer_elapsed_secs .. _sec-c-api-xnvme-func-xnvme_timer_elapsed_usecs: xnvme_timer_elapsed_usecs ------------------------- .. doxygenfunction:: xnvme_timer_elapsed_usecs .. _sec-c-api-xnvme-func-xnvme_timer_pr: xnvme_timer_pr -------------- .. doxygenfunction:: xnvme_timer_pr .. _sec-c-api-xnvme-func-xnvme_timer_start: xnvme_timer_start ----------------- .. doxygenfunction:: xnvme_timer_start .. _sec-c-api-xnvme-func-xnvme_timer_stop: xnvme_timer_stop ---------------- .. doxygenfunction:: xnvme_timer_stop