:orphan: .. index:: pair: group; Kernel modules configuration .. _doxid-group__tapi__conf__modules: Kernel modules configuration ============================ .. toctree:: :hidden: Overview ~~~~~~~~ Definition of API to configure kernel modules and their parameters. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions :ref:`te_errno` :ref:`tapi_cfg_module_add`(const char* ta_name, const char* mod_name, bool load); :ref:`te_errno` :ref:`tapi_cfg_module_load`(const char* ta_name, const char* mod_name); :ref:`te_errno` :ref:`tapi_cfg_module_unload`(const char* ta_name, const char* mod_name); :ref:`te_errno` :ref:`tapi_cfg_module_filename_set`(const char* ta_name, const char* mod_name, const char* filename); :ref:`te_errno` :ref:`tapi_cfg_module_param_add`(const char* ta_name, const char* mod_name, const char* param, const char* param_value); :ref:`te_errno` :ref:`tapi_cfg_module_int_param_add`(const char* ta_name, const char* mod_name, const char* param, int param_value); :ref:`te_errno` :ref:`tapi_cfg_module_params_add`(const char* ta_name, const char* mod_name, ...); :ref:`te_errno` :ref:`tapi_cfg_module_int_params_add`(const char* ta_name, const char* mod_name, ...); :ref:`te_errno` :ref:`tapi_cfg_module_param_get`(const char* ta_name, const char* mod_name, const char* param_name, char** param_value); :ref:`te_errno` :ref:`tapi_cfg_module_param_get_int`(const char* ta_name, const char* mod_name, const char* param_name, int* param_value); :ref:`te_errno` :ref:`tapi_cfg_module_add_from_ta_dir`(const char* ta_name, const char* module_name, bool load_dependencies); :ref:`te_errno` :ref:`tapi_cfg_module_add_from_ta_dir_or_fallback`(const char* ta_name, const char* module_name, bool load_dependencies); :ref:`te_errno` :ref:`tapi_cfg_module_change_finish`(const char* ta_name, const char* mod_name); :ref:`te_errno` :ref:`tapi_cfg_module_version_get`(const char* ta_name, const char* module_name, char** version); :ref:`te_errno` :ref:`tapi_cfg_module_check_devices`(const char* ta_name, const char* module_name, bool* all_grabbed); .. _details-group__tapi__conf__modules: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Definition of API to configure kernel modules and their parameters. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Global Functions ---------------- .. index:: pair: function; tapi_cfg_module_add .. _doxid-group__tapi__conf__modules_1ga62b603a71752300f25c92784a1d1f9ec: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_module_add(const char* ta_name, const char* mod_name, bool load) Add module into the list of the agent modules. Load if asked. No error is returned if module is already added or loaded. Check it beforehand if needed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Name of the agent * - mod_name - Name of the module * - load - Load it (applicable only if no parameters are needed.) .. rubric:: Returns: 0 or error .. index:: pair: function; tapi_cfg_module_load .. _doxid-group__tapi__conf__modules_1gad2f93b144428d48596223d200d788110: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_module_load(const char* ta_name, const char* mod_name) Load module with pre-configured parameters. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Name of the agent * - mod_name - Name of the module .. rubric:: Returns: 0 or error .. index:: pair: function; tapi_cfg_module_unload .. _doxid-group__tapi__conf__modules_1ga4162f048f9596700c5ff601feb10df69: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_module_unload(const char* ta_name, const char* mod_name) Unload module with pre-configured parameters. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Name of the agent * - mod_name - Name of the module .. rubric:: Returns: 0 or error .. index:: pair: function; tapi_cfg_module_filename_set .. _doxid-group__tapi__conf__modules_1ga0b21a79b65fb43b8108e1b411456715e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_module_filename_set(const char* ta_name, const char* mod_name, const char* filename) Set filename of the module to be loaded .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Name of the agent * - mod_name - Name of the module * - filename - Filesystem path .. rubric:: Returns: 0 or error .. index:: pair: function; tapi_cfg_module_param_add .. _doxid-group__tapi__conf__modules_1gab3b5597ea9d01349079e47894e829a66: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_module_param_add(const char* ta_name, const char* mod_name, const char* param, const char* param_value) Add module parameter with specified value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Name of the agent * - mod_name - Name of the module * - param - Name of the parameter * - param_value - Value of the parameter .. rubric:: Returns: 0 or error .. index:: pair: function; tapi_cfg_module_int_param_add .. _doxid-group__tapi__conf__modules_1ga19bf203d62084fba792156ae1843eb57: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_module_int_param_add(const char* ta_name, const char* mod_name, const char* param, int param_value) Add module parameter with specified integer value. Convenient wrapper around :ref:`tapi_cfg_module_param_add() `. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Name of the agent * - mod_name - Name of the module * - param - Name of the parameter * - param_value - Value of the parameter .. rubric:: Returns: 0 or error .. index:: pair: function; tapi_cfg_module_params_add .. _doxid-group__tapi__conf__modules_1ga4ea53ee89ec98e7f064ed2be757d33fc: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_module_params_add(const char* ta_name, const char* mod_name, ...) Add a number of string params that go in pairs terminated by NULL. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Name of the agent * - mod_name - Name of the module * - ... - Param name, param value, NULL list. .. rubric:: Returns: 0 or error .. index:: pair: function; tapi_cfg_module_int_params_add .. _doxid-group__tapi__conf__modules_1gabfbba201e7ba18dd03f4c10da695109f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_module_int_params_add(const char* ta_name, const char* mod_name, ...) Add a number of int params that go in pairs terminated by NULL. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Name of the agent * - mod_name - Name of the module * - ... - Param name, param value (int), NULL list. .. rubric:: Returns: 0 or error .. index:: pair: function; tapi_cfg_module_param_get .. _doxid-group__tapi__conf__modules_1ga408a12640e16260a5076a45e87abcc94: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_module_param_get(const char* ta_name, const char* mod_name, const char* param_name, char** param_value) Get value of the module parameter (as string). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Name of the agent * - mod_name - Name of the kernel module * - param_name - Name of the module parameter * - param_value - Where to save pointer to string value of the parameter (to be released by the caller) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_module_param_get_int .. _doxid-group__tapi__conf__modules_1ga8d11de77c028f8a65641265a115fd996: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_module_param_get_int(const char* ta_name, const char* mod_name, const char* param_name, int* param_value) Get value of the module parameter (as integer number). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Name of the agent * - mod_name - Name of the kernel module * - param_name - Name of the module parameter * - param_value - Where to save parameter value .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_module_add_from_ta_dir .. _doxid-group__tapi__conf__modules_1ga7414037bfdf8eb03e4e5a7b5c706cf11: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_module_add_from_ta_dir(const char* ta_name, const char* module_name, bool load_dependencies) Given a module file in a TA modules directory, insert the former. Take care of the module dependencies if required. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - The TA name * - module_name - The filename without ".ko" extension * - load_dependencies - Take care of dependencies * - Status - code. .. index:: pair: function; tapi_cfg_module_add_from_ta_dir_or_fallback .. _doxid-group__tapi__conf__modules_1gaf71b6a692298b491268a37979f322831: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_module_add_from_ta_dir_or_fallback(const char* ta_name, const char* module_name, bool load_dependencies) Same as :ref:`tapi_cfg_module_add_from_ta_dir() `, but in case of a module file absence in a TA directory, module addition falls back on loading module shipped with the currently running kernel. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - The TA name * - module_name - The filename without ".ko" extension * - load_dependencies - Take care of dependencies * - Status - code. .. index:: pair: function; tapi_cfg_module_change_finish .. _doxid-group__tapi__conf__modules_1ga62021d0c411abbbc6eb6c291a54e9639: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_module_change_finish(const char* ta_name, const char* mod_name) Finish changing a module. The resource is set to shared and other agents can access the module in shared mode. After this, module load/unload, parameters manipulation are prohibited. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Name of the agent * - mod_name - Name of the module .. index:: pair: function; tapi_cfg_module_version_get .. _doxid-group__tapi__conf__modules_1gad5944332c4fe41fa6621b075104fc18e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_module_version_get(const char* ta_name, const char* module_name, char** version) Get version of a module. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Name of the agent * - module_name - Name of the kernel module * - version - Where to save pointer to the version string (memory should be released by the caller) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_module_check_devices .. _doxid-group__tapi__conf__modules_1ga790b9332abdc6774323e945315ffb40b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_module_check_devices(const char* ta_name, const char* module_name, bool* all_grabbed) Check that all the devices related to a given module are grabbed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Name of the agent * - module_name - Name of the kernel module * - all_grabbed - Will be set to ``true`` if all devices are grabbed and to ``false`` otherwise. .. rubric:: Returns: Status code.