source: rtems-docs/c-user/config/event-record.rst @ dfe0ec0

5
Last change on this file since dfe0ec0 was dfe0ec0, checked in by Sebastian Huber <sebastian.huber@…>, on 03/18/20 at 15:50:00

c-user: Use new template for feature config opts

Try to bring all descriptions up to date. Add cross-references to
several options.

Close #3900.

  • Property mode set to 100644
File size: 1.6 KB
Line 
1.. SPDX-License-Identifier: CC-BY-SA-4.0
2
3.. Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de)
4
5Event Recording Configuration
6=============================
7
8This section describes configuration options related to the event recording.
9
10.. index:: CONFIGURE_RECORD_EXTENSIONS_ENABLED
11
12.. _CONFIGURE_RECORD_EXTENSIONS_ENABLED:
13
14CONFIGURE_RECORD_EXTENSIONS_ENABLED
15-----------------------------------
16
17CONSTANT:
18    ``CONFIGURE_RECORD_EXTENSIONS_ENABLED``
19
20OPTION TYPE:
21    This configuration option is a boolean feature define.
22
23DEFAULT CONFIGURATION:
24    If this configuration option is undefined, then the described feature is not
25    enabled.
26
27DESCRIPTION:
28    In case
29
30    * this configuration option is defined
31
32    * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
33
34    then the event record extensions are enabled.
35
36NOTES:
37    The record extensions capture thread create, start, restart, delete, switch,
38    begin, exitted and terminate events.
39
40.. index:: CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
41
42.. _CONFIGURE_RECORD_PER_PROCESSOR_ITEMS:
43
44CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
45------------------------------------
46
47CONSTANT:
48    ``CONFIGURE_RECORD_PER_PROCESSOR_ITEMS``
49
50DATA TYPE:
51    Unsigned integer (``unsigned int``).
52
53RANGE:
54    A power of two greater than or equal to 16.
55
56DEFAULT VALUE:
57    This is not defined by default.
58
59DESCRIPTION:
60    If defined, then a record item buffer of the specified item count is
61    statically allocated for each configured processor
62    (:ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>`).
63
64NOTES:
65    None.
Note: See TracBrowser for help on using the repository browser.