You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by gi...@apache.org on 2020/11/03 00:37:11 UTC
[incubator-nuttx-website] branch asf-site updated: Publishing web:
feb249977349f687d40e57cfe5f0d39e5c5c71f9 docs:
d987dd2f5aa5d26f814c66d01eb4509b1efb1672
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-nuttx-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new a66a761 Publishing web: feb249977349f687d40e57cfe5f0d39e5c5c71f9 docs: d987dd2f5aa5d26f814c66d01eb4509b1efb1672
a66a761 is described below
commit a66a761d4c53eea717bb3f0f7876493bd93028ad
Author: Matias <ma...@protobits.dev>
AuthorDate: Tue Nov 3 00:36:37 2020 +0000
Publishing web: feb249977349f687d40e57cfe5f0d39e5c5c71f9 docs: d987dd2f5aa5d26f814c66d01eb4509b1efb1672
---
.../components/drivers/character/note.rst.txt | 26 ++++++++++++++++
.../latest/_sources/guides/tasktraceuser.rst.txt | 19 ++++++++----
.../latest/components/drivers/character/index.html | 1 +
.../latest/components/drivers/character/note.html | 34 +++++++++++++++++++++
content/docs/latest/genindex.html | 8 +++--
content/docs/latest/guides/tasktraceuser.html | 20 ++++++++----
content/docs/latest/index.html | 2 +-
content/docs/latest/objects.inv | Bin 22123 -> 22158 bytes
content/docs/latest/searchindex.js | 2 +-
content/feed.xml | 4 +--
10 files changed, 98 insertions(+), 18 deletions(-)
diff --git a/content/docs/latest/_sources/components/drivers/character/note.rst.txt b/content/docs/latest/_sources/components/drivers/character/note.rst.txt
index cd2e942..ca27d22 100644
--- a/content/docs/latest/_sources/components/drivers/character/note.rst.txt
+++ b/content/docs/latest/_sources/components/drivers/character/note.rst.txt
@@ -180,6 +180,23 @@ Noteram Device (``/dev/note``)
The header file ``include/nuttx/note/noteram_driver.h`` provides the interface definitions of the device.
+``/dev/note`` Data Structures
+--------------------------------
+
+.. c:struct:: noteram_get_taskname_s
+
+ .. code-block:: c
+
+ struct noteram_get_taskname_s
+ {
+ pid_t pid;
+ char taskname[CONFIG_TASK_NAME_SIZE + 1];
+ };
+
+ - ``pid`` : Task ID to get the task name.
+
+ - ``taskname`` : The task name string corresponding to given pid.
+
``/dev/note`` Ioctls
--------------------
@@ -222,6 +239,15 @@ Noteram Device (``/dev/note``)
:return: If success, 0 (``OK``) is returned and the given overwriter mode is set as the current settings.
If failed, a negated ``errno`` is returned.
+.. c:macro:: NOTERAM_GETTASKNAME
+
+ Get task name string
+
+ :argument: A writable pointer to :c:struct:`noteram_get_taskname_s`
+
+ :return: If success, 0 (``OK``) is returned and the task name corresponding to given pid is stored into the given pointer.
+ If failed, a negated ``errno`` is returned.
+
Filter control APIs
===================
diff --git a/content/docs/latest/_sources/guides/tasktraceuser.rst.txt b/content/docs/latest/_sources/guides/tasktraceuser.rst.txt
index a17657f..293c3ff 100644
--- a/content/docs/latest/_sources/guides/tasktraceuser.rst.txt
+++ b/content/docs/latest/_sources/guides/tasktraceuser.rst.txt
@@ -43,19 +43,26 @@ The following configurations are configurable parameters for trace.
- Bit 2 = Enable IRQ instrumentation
- Bit 3 = Enable collecting syscall arguments
-- ``CONFIG_SCHED_INSTRUMENTATION_NOTERAM_BUFSIZE``
+- ``CONFIG_SCHED_INSTRUMENTATION_HIRES``
+
+ - If enabled, use higher resolution system timer for instrumentation.
+
+- ``CONFIG_DRIVER_NOTERAM_BUFSIZE``
- Specify the note buffer size in bytes.
Higher value can hold more note records, but consumes more kernel memory.
-- ``CONFIG_SCHED_INSTRUMENTATION_NOTERAM_DEFAULT_NOOVERWRITE``
+- ``CONFIG_DRIVER_NOTERAM_TASKNAME_BUFSIZE``
- - If enabled, stop overwriting old notes in the circular buffer when the buffer is full by default.
- This is useful to keep instrumentation data of the beginning of a system boot.
+ - Specify the task name buffer size in bytes.
+ The buffer is used to hold the name of the task during instrumentation.
+ Trace dump can find and show a task name corresponding to given pid in the instrumentation data by using this buffer.
+ If 0 is specified, this feature is disabled and trace dump shows only the name of the newly created task.
-- ``CONFIG_SCHED_INSTRUMENTATION_HIRES``
+- ``CONFIG_DRIVER_NOTERAM_DEFAULT_NOOVERWRITE``
- - If enabled, use higher resolution system timer for instrumentation.
+ - If enabled, stop overwriting old notes in the circular buffer when the buffer is full by default.
+ This is useful to keep instrumentation data of the beginning of a system boot.
After the configuration, rebuild the NuttX kernel and application.
diff --git a/content/docs/latest/components/drivers/character/index.html b/content/docs/latest/components/drivers/character/index.html
index 1bc2604..5bfd43e 100644
--- a/content/docs/latest/components/drivers/character/index.html
+++ b/content/docs/latest/components/drivers/character/index.html
@@ -302,6 +302,7 @@ documented in the following paragraphs.</p>
</li>
<li class="toctree-l2"><a class="reference internal" href="note.html#noteram-device-dev-note">Noteram Device (<code class="docutils literal notranslate"><span class="pre">/dev/note</span></code>)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="note.html#dev-note-header-files"><code class="docutils literal notranslate"><span class="pre">/dev/note</span></code> Header Files</a></li>
+<li class="toctree-l3"><a class="reference internal" href="note.html#dev-note-data-structures"><code class="docutils literal notranslate"><span class="pre">/dev/note</span></code> Data Structures</a></li>
<li class="toctree-l3"><a class="reference internal" href="note.html#dev-note-ioctls"><code class="docutils literal notranslate"><span class="pre">/dev/note</span></code> Ioctls</a></li>
</ul>
</li>
diff --git a/content/docs/latest/components/drivers/character/note.html b/content/docs/latest/components/drivers/character/note.html
index 5c51eb3..daa18d7 100644
--- a/content/docs/latest/components/drivers/character/note.html
+++ b/content/docs/latest/components/drivers/character/note.html
@@ -475,6 +475,25 @@ The device has read function to get the data and ioctl function to control the b
<div><p>The header file <code class="docutils literal notranslate"><span class="pre">include/nuttx/note/noteram_driver.h</span></code> provides the interface definitions of the device.</p>
</div></blockquote>
</div>
+<div class="section" id="dev-note-data-structures">
+<h3><code class="docutils literal notranslate"><span class="pre">/dev/note</span></code> Data Structures<a class="headerlink" href="#dev-note-data-structures" title="Permalink to this headline">¶</a></h3>
+<dl class="c struct">
+<dt id="c.noteram_get_taskname_s">
+<em class="property">struct </em><code class="sig-name descname">noteram_get_taskname_s</code><a class="headerlink" href="#c.noteram_get_taskname_s" title="Permalink to this definition">¶</a><br /></dt>
+<dd><div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">struct</span> <span class="nc">noteram_get_taskname_s</span>
+<span class="p">{</span>
+ <span class="kt">pid_t</span> <span class="n">pid</span><span class="p">;</span>
+ <span class="kt">char</span> <span class="n">taskname</span><span class="p">[</span><span class="n">CONFIG_TASK_NAME_SIZE</span> <span class="o">+</span> <span class="mi">1</span><span class="p">];</span>
+<span class="p">};</span>
+</pre></div>
+</div>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">pid</span></code> : Task ID to get the task name.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">taskname</span></code> : The task name string corresponding to given pid.</p></li>
+</ul>
+</dd></dl>
+
+</div>
<div class="section" id="dev-note-ioctls">
<h3><code class="docutils literal notranslate"><span class="pre">/dev/note</span></code> Ioctls<a class="headerlink" href="#dev-note-ioctls" title="Permalink to this headline">¶</a></h3>
<dl class="c macro">
@@ -540,6 +559,21 @@ If failed, a negated <code class="docutils literal notranslate"><span class="pre
</dl>
</dd></dl>
+<dl class="c macro">
+<dt id="c.NOTERAM_GETTASKNAME">
+<code class="sig-name descname">NOTERAM_GETTASKNAME</code><a class="headerlink" href="#c.NOTERAM_GETTASKNAME" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Get task name string</p>
+<dl class="field-list simple">
+<dt class="field-odd">Argument</dt>
+<dd class="field-odd"><p>A writable pointer to <a class="reference internal" href="#c.noteram_get_taskname_s" title="noteram_get_taskname_s"><code class="xref c c-struct docutils literal notranslate"><span class="pre">noteram_get_taskname_s</span></code></a></p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>If success, 0 (<code class="docutils literal notranslate"><span class="pre">OK</span></code>) is returned and the task name corresponding to given pid is stored into the given pointer.
+If failed, a negated <code class="docutils literal notranslate"><span class="pre">errno</span></code> is returned.</p>
+</dd>
+</dl>
+</dd></dl>
+
</div>
</div>
<div class="section" id="filter-control-apis">
diff --git a/content/docs/latest/genindex.html b/content/docs/latest/genindex.html
index b7c6c6a..f1de858 100644
--- a/content/docs/latest/genindex.html
+++ b/content/docs/latest/genindex.html
@@ -714,6 +714,8 @@
</li>
<li><a href="components/drivers/character/note.html#c.NOTERAM_CLEAR">NOTERAM_CLEAR (C macro)</a>
</li>
+ <li><a href="components/drivers/character/note.html#c.noteram_get_taskname_s">noteram_get_taskname_s (C struct)</a>
+</li>
<li><a href="components/drivers/character/note.html#c.NOTERAM_GETMODE">NOTERAM_GETMODE (C macro)</a>
</li>
<li><a href="components/drivers/character/note.html#c.NOTERAM_GETMODE.NOTERAM_MODE_OVERWRITE_DISABLE">NOTERAM_GETMODE.NOTERAM_MODE_OVERWRITE_DISABLE (C macro)</a>
@@ -722,6 +724,8 @@
</li>
<li><a href="components/drivers/character/note.html#c.NOTERAM_GETMODE.NOTERAM_MODE_OVERWRITE_OVERFLOW">NOTERAM_GETMODE.NOTERAM_MODE_OVERWRITE_OVERFLOW (C macro)</a>
</li>
+ <li><a href="components/drivers/character/note.html#c.NOTERAM_GETTASKNAME">NOTERAM_GETTASKNAME (C macro)</a>
+</li>
<li><a href="components/drivers/character/note.html#c.NOTERAM_SETMODE">NOTERAM_SETMODE (C macro)</a>
</li>
<li><a href="components/power.html#c.notify">notify (C var)</a>
@@ -814,10 +818,10 @@
</li>
<li><a href="components/nxgraphics/nxcursor.html#c.nxcursor_enable">nxcursor_enable (C function)</a>
</li>
- <li><a href="components/nxgraphics/nxcursor.html#c.nxcursor_setimage">nxcursor_setimage (C function)</a>
-</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="components/nxgraphics/nxcursor.html#c.nxcursor_setimage">nxcursor_setimage (C function)</a>
+</li>
<li><a href="components/nxgraphics/nxcursor.html#c.nxcursor_setposition">nxcursor_setposition (C function)</a>
</li>
<li><a href="components/nxgraphics/nxfonts.html#c.nxf_convert_16bpp">nxf_convert_16bpp (C function)</a>
diff --git a/content/docs/latest/guides/tasktraceuser.html b/content/docs/latest/guides/tasktraceuser.html
index 54ea23f..f6d2be1 100644
--- a/content/docs/latest/guides/tasktraceuser.html
+++ b/content/docs/latest/guides/tasktraceuser.html
@@ -254,21 +254,29 @@ If the following bits are set, the corresponding instrumentations are enabled on
</li>
</ul>
</li>
-<li><p><code class="docutils literal notranslate"><span class="pre">CONFIG_SCHED_INSTRUMENTATION_NOTERAM_BUFSIZE</span></code></p>
+<li><p><code class="docutils literal notranslate"><span class="pre">CONFIG_SCHED_INSTRUMENTATION_HIRES</span></code></p>
+<ul>
+<li><p>If enabled, use higher resolution system timer for instrumentation.</p></li>
+</ul>
+</li>
+<li><p><code class="docutils literal notranslate"><span class="pre">CONFIG_DRIVER_NOTERAM_BUFSIZE</span></code></p>
<ul>
<li><p>Specify the note buffer size in bytes.
Higher value can hold more note records, but consumes more kernel memory.</p></li>
</ul>
</li>
-<li><p><code class="docutils literal notranslate"><span class="pre">CONFIG_SCHED_INSTRUMENTATION_NOTERAM_DEFAULT_NOOVERWRITE</span></code></p>
+<li><p><code class="docutils literal notranslate"><span class="pre">CONFIG_DRIVER_NOTERAM_TASKNAME_BUFSIZE</span></code></p>
<ul>
-<li><p>If enabled, stop overwriting old notes in the circular buffer when the buffer is full by default.
-This is useful to keep instrumentation data of the beginning of a system boot.</p></li>
+<li><p>Specify the task name buffer size in bytes.
+The buffer is used to hold the name of the task during instrumentation.
+Trace dump can find and show a task name corresponding to given pid in the instrumentation data by using this buffer.
+If 0 is specified, this feature is disabled and trace dump shows only the name of the newly created task.</p></li>
</ul>
</li>
-<li><p><code class="docutils literal notranslate"><span class="pre">CONFIG_SCHED_INSTRUMENTATION_HIRES</span></code></p>
+<li><p><code class="docutils literal notranslate"><span class="pre">CONFIG_DRIVER_NOTERAM_DEFAULT_NOOVERWRITE</span></code></p>
<ul>
-<li><p>If enabled, use higher resolution system timer for instrumentation.</p></li>
+<li><p>If enabled, stop overwriting old notes in the circular buffer when the buffer is full by default.
+This is useful to keep instrumentation data of the beginning of a system boot.</p></li>
</ul>
</li>
</ul>
diff --git a/content/docs/latest/index.html b/content/docs/latest/index.html
index 7e38d35..53b418c 100644
--- a/content/docs/latest/index.html
+++ b/content/docs/latest/index.html
@@ -207,7 +207,7 @@ by following these <a class="reference internal" href="contributing/documentatio
<div class="section" id="nuttx-documentation">
<h1>NuttX Documentation<a class="headerlink" href="#nuttx-documentation" title="Permalink to this headline">¶</a></h1>
<p>NuttX is a real-time operating system (RTOS) with an emphasis on standards compliance and small footprint. Scalable from 8-bit to 64-bit microcontroller environments, the primary governing standards in NuttX are POSIX and ANSI standards. Additional standard APIs from Unix and other common RTOS’s (such as VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()).</p>
-<p>Last Updated: 02 November 20 at 00:34</p>
+<p>Last Updated: 03 November 20 at 00:34</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
diff --git a/content/docs/latest/objects.inv b/content/docs/latest/objects.inv
index 1bdaf1b..b1e4a27 100644
Binary files a/content/docs/latest/objects.inv and b/content/docs/latest/objects.inv differ
diff --git a/content/docs/latest/searchindex.js b/content/docs/latest/searchindex.js
index 69210d7..f503901 100644
--- a/content/docs/latest/searchindex.js
+++ b/content/docs/latest/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["applications/index","applications/nsh/builtin","applications/nsh/commands","applications/nsh/config","applications/nsh/customizing","applications/nsh/index","applications/nsh/installation","applications/nsh/login","applications/nsh/nsh","boards/index","components/binfmt","components/drivers/block/index","components/drivers/character/analog","components/drivers/character/can","components/drivers/character/index","components/drivers/character/keypad","components [...]
\ No newline at end of file
+Search.setIndex({docnames:["applications/index","applications/nsh/builtin","applications/nsh/commands","applications/nsh/config","applications/nsh/customizing","applications/nsh/index","applications/nsh/installation","applications/nsh/login","applications/nsh/nsh","boards/index","components/binfmt","components/drivers/block/index","components/drivers/character/analog","components/drivers/character/can","components/drivers/character/index","components/drivers/character/keypad","components [...]
\ No newline at end of file
diff --git a/content/feed.xml b/content/feed.xml
index 62dba64..5c2fd62 100644
--- a/content/feed.xml
+++ b/content/feed.xml
@@ -5,8 +5,8 @@
<description></description>
<link>/</link>
<atom:link href="/feed.xml" rel="self" type="application/rss+xml"/>
- <pubDate>Mon, 02 Nov 2020 00:36:22 +0000</pubDate>
- <lastBuildDate>Mon, 02 Nov 2020 00:36:22 +0000</lastBuildDate>
+ <pubDate>Tue, 03 Nov 2020 00:36:36 +0000</pubDate>
+ <lastBuildDate>Tue, 03 Nov 2020 00:36:36 +0000</lastBuildDate>
<generator>Jekyll v3.8.5</generator>
<item>