:orphan:

.. index:: pair: group; PCI definitions
.. _doxid-group__te__tools__te__pci:

PCI definitions
===============

.. toctree::
	:hidden:

Overview
~~~~~~~~

PCI-related constants and supplementary functions. :ref:`More...<details-group__te__tools__te__pci>`


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

	
	// global functions

	const char* :ref:`te_pci_class_id2str<doxid-group__te__tools__te__pci_1gacfe82765c56600c66637ad88cc0f334f>`(unsigned int class);
	unsigned int :ref:`te_pci_class_str2id<doxid-group__te__tools__te__pci_1ga62ed7edea919e00cee57b51565ad9d17>`(const char* label);
	const char* :ref:`te_pci_subclass_id2str<doxid-group__te__tools__te__pci_1ga161d8d70f7b2f4732ab85caff4e56d6f>`(unsigned int subclass);
	unsigned int :ref:`te_pci_subclass_str2id<doxid-group__te__tools__te__pci_1ga146edb464366e6a5c878205ba1b801e5>`(const char* label);
	const char* :ref:`te_pci_progintf_id2str<doxid-group__te__tools__te__pci_1gab716a28a59bfe90126c0563c34f3d8c1>`(unsigned int progintf);
	unsigned int :ref:`te_pci_progintf_str2id<doxid-group__te__tools__te__pci_1gac766c52a8a9cb0f556b5f728b1fd3112>`(const char* label);
	static unsigned int :ref:`te_pci_subclass2class<doxid-group__te__tools__te__pci_1ga1b7b0d2d70519c6ee418618debdf4d21>`(unsigned int subclass);
	static unsigned int :ref:`te_pci_subclass_default<doxid-group__te__tools__te__pci_1gabd59f67ae94bca4e19d6e207d798c194>`(unsigned int class);
	static unsigned int :ref:`te_pci_progintf2subclass<doxid-group__te__tools__te__pci_1ga70f30ce016565234be70b9ca03d20653>`(unsigned int progintf);
	static unsigned int :ref:`te_pci_progintf_default<doxid-group__te__tools__te__pci_1gad34cb9fdff1bef43f020ecdfce9ac55b>`(unsigned int subclass);
	static unsigned int :ref:`te_pci_progintf2class<doxid-group__te__tools__te__pci_1ga53f743f408280884f2fc74a3f3457f91>`(unsigned int progintf);

	// macros

	#define :target:`ENDDEF<doxid-group__te__tools__te__pci_1gaee74a545988e566123fe6dd982b6c89c>`(_name)
	#define :target:`ITEM<doxid-group__te__tools__te__pci_1ga89303ada1aec6ee7167c54004120019b>`(_key, _value)
	#define :target:`STARTDEF<doxid-group__te__tools__te__pci_1ga67d96375803bdae47fddfa8ae8dca05a>`(_name)

.. _details-group__te__tools__te__pci:

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

PCI-related constants and supplementary functions.

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

.. index:: pair: function; te_pci_class_id2str
.. _doxid-group__te__tools__te__pci_1gacfe82765c56600c66637ad88cc0f334f:

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

	const char* te_pci_class_id2str(unsigned int class)

Provide a string description of a PCI ``class``.

An unknown value will be treated as ``TE_PCI_CLASS_UNCLASSIFIED_DEVICE``.



.. rubric:: Parameters:

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

	*
		- class

		- class ID (see te_pci_class)



.. rubric:: Returns:

the class label

.. index:: pair: function; te_pci_class_str2id
.. _doxid-group__te__tools__te__pci_1ga62ed7edea919e00cee57b51565ad9d17:

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

	unsigned int te_pci_class_str2id(const char* label)

Provide a PCI class ID matching a given ``label``.



.. rubric:: Parameters:

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

	*
		- label

		- PCI class label

	*
		- TE_PCI_CLASS_UNCLASSIFIED_DEVICE

		- if the label is unknown



.. rubric:: Returns:

the class ID

.. index:: pair: function; te_pci_subclass_id2str
.. _doxid-group__te__tools__te__pci_1ga161d8d70f7b2f4732ab85caff4e56d6f:

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

	const char* te_pci_subclass_id2str(unsigned int subclass)

Provide a string description of a PCI ``subclass``.

If ``subclass`` is not defined, the function will return a label for a class part as per :ref:`te_pci_class_id2str() <doxid-group__te__tools__te__pci_1gacfe82765c56600c66637ad88cc0f334f>`.



.. rubric:: Parameters:

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

	*
		- subclass

		- subclass ID (see te_pci_subclass)



.. rubric:: Returns:

the subclass label

.. index:: pair: function; te_pci_subclass_str2id
.. _doxid-group__te__tools__te__pci_1ga146edb464366e6a5c878205ba1b801e5:

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

	unsigned int te_pci_subclass_str2id(const char* label)

Provide a PCI class ID matching a given ``label``.

The function may be passed any label accepted by :ref:`te_pci_class_str2id() <doxid-group__te__tools__te__pci_1ga62ed7edea919e00cee57b51565ad9d17>`, then the shifted value of a class ID will be returned.



.. rubric:: Parameters:

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

	*
		- label

		- PCI subclass label



.. rubric:: Returns:

the subclass ID

.. index:: pair: function; te_pci_progintf_id2str
.. _doxid-group__te__tools__te__pci_1gab716a28a59bfe90126c0563c34f3d8c1:

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

	const char* te_pci_progintf_id2str(unsigned int progintf)

Provide a string description of a PCI ``progintf``.

If ``progintf`` is not defined, the function will return a label for a subclass part as per :ref:`te_pci_subclass_id2str() <doxid-group__te__tools__te__pci_1ga161d8d70f7b2f4732ab85caff4e56d6f>`.



.. rubric:: Parameters:

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

	*
		- progintf

		- programming interface ID (see te_pci_prog_interface)



.. rubric:: Returns:

the subclass label

.. index:: pair: function; te_pci_progintf_str2id
.. _doxid-group__te__tools__te__pci_1gac766c52a8a9cb0f556b5f728b1fd3112:

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

	unsigned int te_pci_progintf_str2id(const char* label)

Provide a PCI prog interface ID matching a given ``label``.

The function may be passed any label accepted by :ref:`te_pci_subclass_str2id() <doxid-group__te__tools__te__pci_1ga146edb464366e6a5c878205ba1b801e5>`, then the shifted value of a subclass ID will be returned.



.. rubric:: Parameters:

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

	*
		- label

		- PCI subclass label



.. rubric:: Returns:

the programming interface ID

.. index:: pair: function; te_pci_subclass2class
.. _doxid-group__te__tools__te__pci_1ga1b7b0d2d70519c6ee418618debdf4d21:

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

	static unsigned int te_pci_subclass2class(unsigned int subclass)

Get a class part of a PCI subclass ID.



.. rubric:: Parameters:

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

	*
		- subclass

		- PCI subclass ID



.. rubric:: Returns:

class ID

.. index:: pair: function; te_pci_subclass_default
.. _doxid-group__te__tools__te__pci_1gabd59f67ae94bca4e19d6e207d798c194:

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

	static unsigned int te_pci_subclass_default(unsigned int class)

Get a default PCI subclass from a PCI class ID.



.. rubric:: Parameters:

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

	*
		- class

		- PCI class ID



.. rubric:: Returns:

subclass ID

.. index:: pair: function; te_pci_progintf2subclass
.. _doxid-group__te__tools__te__pci_1ga70f30ce016565234be70b9ca03d20653:

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

	static unsigned int te_pci_progintf2subclass(unsigned int progintf)

Get a subclass part of a PCI programming interface ID.



.. rubric:: Parameters:

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

	*
		- progintf

		- Programming interace ID



.. rubric:: Returns:

Subclass ID

.. index:: pair: function; te_pci_progintf_default
.. _doxid-group__te__tools__te__pci_1gad34cb9fdff1bef43f020ecdfce9ac55b:

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

	static unsigned int te_pci_progintf_default(unsigned int subclass)

Get a default PCI programming interface ID from a PCI subclass ID.



.. rubric:: Parameters:

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

	*
		- subclass

		- PCI subclass ID



.. rubric:: Returns:

programming interface ID

.. index:: pair: function; te_pci_progintf2class
.. _doxid-group__te__tools__te__pci_1ga53f743f408280884f2fc74a3f3457f91:

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

	static unsigned int te_pci_progintf2class(unsigned int progintf)

Get a class part of a PCI programming interface ID.



.. rubric:: Parameters:

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

	*
		- progintf

		- Programming interace ID



.. rubric:: Returns:

Class ID