:orphan:

.. index:: pair: group; Serial console parser
.. _doxid-group__te__tools__te__serial__parser:

Serial console parser
=====================

.. toctree::
	:hidden:

	struct_serial_event_t.rst
	struct_serial_parser_t.rst
	struct_serial_pattern_t.rst

Overview
~~~~~~~~

Definition of unix TA serial console parse configuring support. :ref:`More...<details-group__te__tools__te__serial__parser>`


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

	
	// typedefs

	typedef struct :ref:`serial_pattern_t<doxid-structserial__pattern__t>` :ref:`serial_pattern_t<doxid-group__te__tools__te__serial__parser_1ga2a331463f0e3f683e70cc1b5ae379654>`;
	typedef struct serial_pattern_h_t :target:`serial_pattern_h_t<doxid-group__te__tools__te__serial__parser_1ga52196f568c8421c78610d9b36d3a1cce>`;
	typedef struct :ref:`serial_event_t<doxid-structserial__event__t>` :ref:`serial_event_t<doxid-group__te__tools__te__serial__parser_1ga4bd2874cc7f11f18619b7f7c98397f34>`;
	typedef struct serial_event_h_t :target:`serial_event_h_t<doxid-group__te__tools__te__serial__parser_1gaf035c66b34ba0d7908105b0540a15a28>`;
	typedef struct :ref:`serial_parser_t<doxid-structserial__parser__t>` :ref:`serial_parser_t<doxid-group__te__tools__te__serial__parser_1ga52a82a043226bfe62ce166904c45a637>`;

	// structs

	struct :ref:`serial_event_t<doxid-structserial__event__t>`;
	struct :ref:`serial_parser_t<doxid-structserial__parser__t>`;
	struct :ref:`serial_pattern_t<doxid-structserial__pattern__t>`;

	// global functions

	:target:`SLIST_HEAD<doxid-group__te__tools__te__serial__parser_1gac140eb0a159e4a714145269a1be02bca>`(serial_pattern_h_t, :ref:`serial_pattern_t<doxid-structserial__pattern__t>`);
	:target:`SLIST_HEAD<doxid-group__te__tools__te__serial__parser_1gaf3f60e31e6785e0812b60c887e027ed2>`(serial_event_h_t, :ref:`serial_event_t<doxid-structserial__event__t>`);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`ta_unix_serial_parser_init<doxid-group__te__tools__te__serial__parser_1ga285bc00a9acd98743cc34b7ae99915e6>`(void);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`ta_unix_serial_parser_cleanup<doxid-group__te__tools__te__serial__parser_1ga508a2743b341d6c39c93da88ba07d34b>`(void);
	int :ref:`te_serial_parser<doxid-group__te__tools__te__serial__parser_1ga402d0baede6b5e333ddc6c60654f50a9>`(:ref:`serial_parser_t<doxid-structserial__parser__t>`* parser);
	int :ref:`te_serial_parser_connect<doxid-group__te__tools__te__serial__parser_1ga7fb320091554afdc15063e80a32a4edd>`(:ref:`serial_parser_t<doxid-structserial__parser__t>`* parser);

	// macros

	#define :target:`PARSER_LIST_SIZE<doxid-group__te__tools__te__serial__parser_1ga0672f5470fdca72279d2aef1528713fe>`
	#define :target:`TE_SERIAL_INTERVAL<doxid-group__te__tools__te__serial__parser_1ga2cf200a4b77c26a3acdb410bc4c10dca>`

.. _details-group__te__tools__te__serial__parser:

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

Definition of unix TA serial console parse configuring support.

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

Typedefs
--------

.. index:: pair: typedef; serial_pattern_t
.. _doxid-group__te__tools__te__serial__parser_1ga2a331463f0e3f683e70cc1b5ae379654:

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

	typedef struct :ref:`serial_pattern_t<doxid-structserial__pattern__t>` serial_pattern_t

List of the parser events

.. index:: pair: typedef; serial_event_t
.. _doxid-group__te__tools__te__serial__parser_1ga4bd2874cc7f11f18619b7f7c98397f34:

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

	typedef struct :ref:`serial_event_t<doxid-structserial__event__t>` serial_event_t

List of the parser events

.. index:: pair: typedef; serial_parser_t
.. _doxid-group__te__tools__te__serial__parser_1ga52a82a043226bfe62ce166904c45a637:

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

	typedef struct :ref:`serial_parser_t<doxid-structserial__parser__t>` serial_parser_t

List of the serial console parsers settings

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

.. index:: pair: function; ta_unix_serial_parser_init
.. _doxid-group__te__tools__te__serial__parser_1ga285bc00a9acd98743cc34b7ae99915e6:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` ta_unix_serial_parser_init(void)

Initialize serial console parser configuration



.. rubric:: Returns:

Status code

.. index:: pair: function; ta_unix_serial_parser_cleanup
.. _doxid-group__te__tools__te__serial__parser_1ga508a2743b341d6c39c93da88ba07d34b:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` ta_unix_serial_parser_cleanup(void)

Cleanup serial console parser



.. rubric:: Returns:

Status code

.. index:: pair: function; te_serial_parser
.. _doxid-group__te__tools__te__serial__parser_1ga402d0baede6b5e333ddc6c60654f50a9:

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

	int te_serial_parser(:ref:`serial_parser_t<doxid-structserial__parser__t>`* parser)

Read data from parser thread



.. rubric:: Parameters:

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

	*
		- parser

		- Pointer to the parser config structure

.. index:: pair: function; te_serial_parser_connect
.. _doxid-group__te__tools__te__serial__parser_1ga7fb320091554afdc15063e80a32a4edd:

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

	int te_serial_parser_connect(:ref:`serial_parser_t<doxid-structserial__parser__t>`* parser)

Entry point to the parser thread



.. rubric:: Parameters:

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

	*
		- parser

		- Pointer to the parser config structure