:orphan: .. index:: pair: group; Test API to control the local storage device .. _doxid-group__tapi__local__storage__device: Test API to control the local storage device ============================================ .. toctree:: :hidden: enum_tapi_local_storage_device_type.rst struct_tapi_local_storage_device.rst struct_tapi_local_storage_device_le.rst struct_tapi_local_storage_device_methods.rst Overview ~~~~~~~~ Functions for convenient work with storage device. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`tapi_local_storage_device` :target:`tapi_local_storage_device`; typedef :ref:`te_errno` (*:ref:`tapi_local_storage_device_method_insert`)(tapi_local_storage_device *device); typedef :ref:`te_errno` (*:ref:`tapi_local_storage_device_method_eject`)(tapi_local_storage_device *device); typedef struct :ref:`tapi_local_storage_device_methods` :ref:`tapi_local_storage_device_methods`; typedef enum :ref:`tapi_local_storage_device_type` :ref:`tapi_local_storage_device_type`; typedef struct :ref:`tapi_local_storage_device_le` :ref:`tapi_local_storage_device_le`; typedef struct tapi_local_storage_device_list :target:`tapi_local_storage_device_list`; // enums enum :ref:`tapi_local_storage_device_type`; // structs struct :ref:`tapi_local_storage_device`; struct :ref:`tapi_local_storage_device_le`; struct :ref:`tapi_local_storage_device_methods`; // global functions :ref:`SLIST_HEAD`(tapi_local_storage_device_list, :ref:`tapi_local_storage_device_le`); static void :ref:`tapi_local_storage_device_set_methods`(:ref:`tapi_local_storage_device`* device, const :ref:`tapi_local_storage_device_methods`* methods); static :ref:`te_errno` :ref:`tapi_local_storage_device_insert`(:ref:`tapi_local_storage_device`* device); static :ref:`te_errno` :ref:`tapi_local_storage_device_eject`(:ref:`tapi_local_storage_device`* device); :ref:`te_errno` :ref:`tapi_local_storage_device_list_get`(tapi_local_storage_device_list* devices); void :ref:`tapi_local_storage_device_list_free`(tapi_local_storage_device_list* devices); :ref:`te_errno` :ref:`tapi_local_storage_device_get`(const char* name, :ref:`tapi_local_storage_device`** device); void :ref:`tapi_local_storage_device_free`(:ref:`tapi_local_storage_device`* device); :ref:`te_errno` :ref:`tapi_local_storage_device_init`(const char* name, :ref:`tapi_local_storage_device`* device); void :ref:`tapi_local_storage_device_fini`(:ref:`tapi_local_storage_device`* device); .. _details-group__tapi__local__storage__device: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Functions for convenient work with storage device. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_local_storage_device_method_insert .. _doxid-group__tapi__local__storage__device_1ga2d9d61e62a72928169263ca4f9dfaa5f: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` (*tapi_local_storage_device_method_insert)(tapi_local_storage_device *device) Insert device. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device handle. .. rubric:: Returns: Status code. .. index:: pair: typedef; tapi_local_storage_device_method_eject .. _doxid-group__tapi__local__storage__device_1gaf02a9ba1460ccedbf0a314abee9606dd: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` (*tapi_local_storage_device_method_eject)(tapi_local_storage_device *device) Eject device. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device handle. .. rubric:: Returns: Status code. .. index:: pair: typedef; tapi_local_storage_device_methods .. _doxid-group__tapi__local__storage__device_1gaa1da6f19315764fb7daba6863dd898de: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_local_storage_device_methods` tapi_local_storage_device_methods Methods to operate with device. .. index:: pair: typedef; tapi_local_storage_device_type .. _doxid-group__tapi__local__storage__device_1ga2de8897a0f2923ff6947650fd6f5f7fb: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_local_storage_device_type` tapi_local_storage_device_type Devices types. .. index:: pair: typedef; tapi_local_storage_device_le .. _doxid-group__tapi__local__storage__device_1gaf270e8bbfb91f752655fb1fecc210841: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_local_storage_device_le` tapi_local_storage_device_le Devices list entry. Global Functions ---------------- .. index:: pair: function; SLIST_HEAD .. _doxid-group__tapi__local__storage__device_1ga9429eeb2b2c4b8ad13f5485fa0a6ad4f: .. ref-code-block:: cpp :class: doxyrest-title-code-block SLIST_HEAD(tapi_local_storage_device_list, :ref:`tapi_local_storage_device_le`) Head of devices list. .. index:: pair: function; tapi_local_storage_device_set_methods .. _doxid-group__tapi__local__storage__device_1gad7eef53e3f92d59265b5ee4d505c9b1d: .. ref-code-block:: cpp :class: doxyrest-title-code-block static void tapi_local_storage_device_set_methods(:ref:`tapi_local_storage_device`* device, const :ref:`tapi_local_storage_device_methods`* methods) Set methods to operate the ``device``. ``device`` should be pre-initialized with, for example, ``tapi_local_storage_device_get`` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device context. * - methods - Methods to operate the device. .. rubric:: See also: :ref:`tapi_local_storage_device_get ` .. index:: pair: function; tapi_local_storage_device_insert .. _doxid-group__tapi__local__storage__device_1ga88c01881a4856e119e67cee1deebc5c5: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_local_storage_device_insert(:ref:`tapi_local_storage_device`* device) Insert device. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device handle. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_local_storage_device_eject .. _doxid-group__tapi__local__storage__device_1ga83bb521770be13ef6efab667970b15ac: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_local_storage_device_eject(:ref:`tapi_local_storage_device`* device) Eject device. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device handle. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_local_storage_device_list_get .. _doxid-group__tapi__local__storage__device_1ga408ba0a9e025cb5251b79f1fe6810ace: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_local_storage_device_list_get(tapi_local_storage_device_list* devices) Get all devices from configurator and read them properties. List of ``devices`` should be released with ``tapi_local_storage_device_list_free`` when it is no longer needed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - devices - Devices list. .. rubric:: Returns: Status code. .. rubric:: See also: :ref:`tapi_local_storage_device_list_free ` .. index:: pair: function; tapi_local_storage_device_list_free .. _doxid-group__tapi__local__storage__device_1gad35d7818a1152b5382490cdcef2f44a5: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_local_storage_device_list_free(tapi_local_storage_device_list* devices) Release devices list that was obtained with ``tapi_local_storage_device_list_get``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - devices - Devices list. .. rubric:: See also: :ref:`tapi_local_storage_device_list_get ` .. index:: pair: function; tapi_local_storage_device_get .. _doxid-group__tapi__local__storage__device_1ga739c34b46ddfed65fa740b2b9ffab04b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_local_storage_device_get(const char* name, :ref:`tapi_local_storage_device`** device) Get a certain device info from configurator. ``device`` should be released with ``tapi_local_storage_device_free`` when it is no longer needed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - name - Device name to find. * - device - Device context. .. rubric:: Returns: Status code. .. rubric:: See also: :ref:`tapi_local_storage_device_free ` .. index:: pair: function; tapi_local_storage_device_free .. _doxid-group__tapi__local__storage__device_1ga78821933e4349932f31f12bb0ca8176b: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_local_storage_device_free(:ref:`tapi_local_storage_device`* device) Release device context that was obtained with ``tapi_local_storage_device_get``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device context. .. rubric:: See also: :ref:`tapi_local_storage_device_get ` .. index:: pair: function; tapi_local_storage_device_init .. _doxid-group__tapi__local__storage__device_1ga4eb0c286dc6294d8772a2b11011b5a2d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_local_storage_device_init(const char* name, :ref:`tapi_local_storage_device`* device) Initialize a device by information obtained from configurator. ``device`` should be released with ``tapi_local_storage_device_fini`` when it is no longer needed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - name - Device name to find. * - device - Device context. .. rubric:: Returns: Status code. .. rubric:: See also: :ref:`tapi_local_storage_device_fini ` .. index:: pair: function; tapi_local_storage_device_fini .. _doxid-group__tapi__local__storage__device_1gabd2b0f4abf35ad4b2165c68482f9481b: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_local_storage_device_fini(:ref:`tapi_local_storage_device`* device) Release device context which was initialized with ``tapi_local_storage_device_init``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device context. .. rubric:: See also: :ref:`tapi_local_storage_device_init `