:orphan:

.. index:: pair: group; Command Handler: Symbol name and address resolver support
.. _doxid-group__rcf__ch__addr:

Command Handler: Symbol name and address resolver support
=========================================================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	
	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`rcf_ch_register_symbol_table<doxid-group__rcf__ch__addr_1ga0d714a85c01bfd0bfc54c417cdbce014>`(const :ref:`rcf_symbol_entry<doxid-structrcf__symbol__entry>`* entries);
	void* :ref:`rcf_ch_symbol_addr<doxid-group__rcf__ch__addr_1gac34f3d1f418a10609c595a3a0eff8423>`(const char* name, bool is_func);
	const char* :ref:`rcf_ch_symbol_name<doxid-group__rcf__ch__addr_1ga1d8a2b8e5ba6a29096eb9c0383ebfd33>`(const void* addr);

.. _details-group__rcf__ch__addr:

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



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

.. index:: pair: function; rcf_ch_register_symbol_table
.. _doxid-group__rcf__ch__addr_1ga0d714a85c01bfd0bfc54c417cdbce014:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` rcf_ch_register_symbol_table(const :ref:`rcf_symbol_entry<doxid-structrcf__symbol__entry>`* entries)

Register symbol table

The ``entries`` must point to a static memory, as it is not copied by the function



.. rubric:: Parameters:

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

	*
		- entries

		- An array of symbol entries, the last element must have NULL name

.. index:: pair: function; rcf_ch_symbol_addr
.. _doxid-group__rcf__ch__addr_1gac34f3d1f418a10609c595a3a0eff8423:

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

	void* rcf_ch_symbol_addr(const char* name, bool is_func)

This function may be used by Portable Commands Handler to resolve name of the variable or function to its address if rcf_ch_vread, rcf_ch_vwrite or rcf_ch_call function returns -1. In this case default command processing is performed by caller: it is assumed that variable or function are in TA address space and variable is unsigned 32 bit integer.



.. rubric:: Parameters:

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

	*
		- name

		- symbol name

	*
		- is_func

		- if ``true``, function name is required



.. rubric:: Returns:

symbol address or NULL

.. index:: pair: function; rcf_ch_symbol_name
.. _doxid-group__rcf__ch__addr_1ga1d8a2b8e5ba6a29096eb9c0383ebfd33:

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

	const char* rcf_ch_symbol_name(const void* addr)

This function may be used by Portable Commands Handler to symbol address to its name.



.. rubric:: Parameters:

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

	*
		- addr

		- symbol address



.. rubric:: Returns:

symbol name or NULL