:orphan:

.. index:: pair: group; Kernel target
.. _doxid-group__tapi__nvme__kern__target:

Kernel target
=============

.. toctree::
	:hidden:

Overview
~~~~~~~~

API for control kernel target of NVMe Over Fabrics

Copyright (C) 2004-2022 OKTET Labs Ltd. :ref:`More...<details-group__tapi__nvme__kern__target>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_nvme_kern_target_init<doxid-group__tapi__nvme__kern__target_1ga1498eb73e716c188918aeb45fd5ecc1c>`(struct :ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target, void* opts);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_nvme_kern_target_setup<doxid-group__tapi__nvme__kern__target_1ga52bada72568a4b31b09c011576fe53d5>`(struct :ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target);
	void :ref:`tapi_nvme_kern_target_cleanup<doxid-group__tapi__nvme__kern__target_1ga734568f506edd1e0cf7910ba30f45337>`(struct :ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target);
	void :ref:`tapi_nvme_kern_target_fini<doxid-group__tapi__nvme__kern__target_1ga0748e3e2591c3cbaa6442a2bf63f3a2b>`(struct :ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target);

	// macros

	#define :ref:`TAPI_NVME_KERN_METHODS_DEFAULTS<doxid-group__tapi__nvme__kern__target_1ga8fd46630e7f9ce6d617774a422dd9430>`
	#define :ref:`TAPI_NVME_KERN_TARGET<doxid-group__tapi__nvme__kern__target_1ga26e504c4421d723f8b0479bd6e777d82>`

.. _details-group__tapi__nvme__kern__target:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

API for control kernel target of NVMe Over Fabrics

Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved.

Global Functions
----------------

.. index:: pair: function; tapi_nvme_kern_target_init
.. _doxid-group__tapi__nvme__kern__target_1ga1498eb73e716c188918aeb45fd5ecc1c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_nvme_kern_target_init(struct :ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target, void* opts)

Init kernel version implementation of target



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- target

		- Target for setup



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_nvme_kern_target_setup
.. _doxid-group__tapi__nvme__kern__target_1ga52bada72568a4b31b09c011576fe53d5:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_nvme_kern_target_setup(struct :ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target)

Setup kernel version implementation of target



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- target

		- Target for setup



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_nvme_kern_target_cleanup
.. _doxid-group__tapi__nvme__kern__target_1ga734568f506edd1e0cf7910ba30f45337:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void tapi_nvme_kern_target_cleanup(struct :ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target)

Cleanup kernel version implementation of target



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- target

		- Target for setup



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_nvme_kern_target_fini
.. _doxid-group__tapi__nvme__kern__target_1ga0748e3e2591c3cbaa6442a2bf63f3a2b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void tapi_nvme_kern_target_fini(struct :ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target)

Deinit kernel version implementation of target



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- target

		- Target for setup



.. rubric:: Returns:

Status code

Macros
------

.. index:: pair: define; TAPI_NVME_KERN_METHODS_DEFAULTS
.. _doxid-group__tapi__nvme__kern__target_1ga8fd46630e7f9ce6d617774a422dd9430:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TAPI_NVME_KERN_METHODS_DEFAULTS

Kernel target methods

.. index:: pair: define; TAPI_NVME_KERN_TARGET
.. _doxid-group__tapi__nvme__kern__target_1ga26e504c4421d723f8b0479bd6e777d82:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TAPI_NVME_KERN_TARGET

Default kernel target initialization