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 2021/06/10 16:59:37 UTC
[incubator-nuttx-website] branch asf-site updated: Publishing web:
9ffd1f116b5230ce5b4c4266125dbb3e9db3fc8e docs:
9d0da9818cc8ce14a34141cb087580a1d64c113e
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 7857474 Publishing web: 9ffd1f116b5230ce5b4c4266125dbb3e9db3fc8e docs: 9d0da9818cc8ce14a34141cb087580a1d64c113e
7857474 is described below
commit 785747403986096ac64c64c51e3b5f78b8bb5c9a
Author: Nathan <59...@users.noreply.github.com>
AuthorDate: Thu Jun 10 16:57:07 2021 +0000
Publishing web: 9ffd1f116b5230ce5b4c4266125dbb3e9db3fc8e docs: 9d0da9818cc8ce14a34141cb087580a1d64c113e
---
content/docs/10.0.0/index.html | 2 +-
content/docs/10.0.1/index.html | 2 +-
content/docs/10.1.0/index.html | 2 +-
.../docs/latest/_sources/reference/os/iob.rst.txt | 29 ++-
content/docs/latest/genindex.html | 2 +
content/docs/latest/index.html | 2 +-
content/docs/latest/objects.inv | Bin 32868 -> 32927 bytes
content/docs/latest/reference/os/iob.html | 23 +-
content/docs/latest/searchindex.js | 2 +-
content/feed.xml | 4 +-
content/releases/9.1.0/index.html | 246 +++++++++++++++++++++
11 files changed, 291 insertions(+), 23 deletions(-)
diff --git a/content/docs/10.0.0/index.html b/content/docs/10.0.0/index.html
index da885e7..ae2dbe1 100644
--- a/content/docs/10.0.0/index.html
+++ b/content/docs/10.0.0/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 32-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: 10 June 21 at 00:05</p>
+<p>Last Updated: 10 June 21 at 16:54</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/10.0.1/index.html b/content/docs/10.0.1/index.html
index 181611c..7afaf0c 100644
--- a/content/docs/10.0.1/index.html
+++ b/content/docs/10.0.1/index.html
@@ -213,7 +213,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 32-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: 10 June 21 at 00:05</p>
+<p>Last Updated: 10 June 21 at 16:55</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/10.1.0/index.html b/content/docs/10.1.0/index.html
index 13320dc..ea0bf5b 100644
--- a/content/docs/10.1.0/index.html
+++ b/content/docs/10.1.0/index.html
@@ -213,7 +213,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: 10 June 21 at 00:06</p>
+<p>Last Updated: 10 June 21 at 16:55</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/_sources/reference/os/iob.rst.txt b/content/docs/latest/_sources/reference/os/iob.rst.txt
index c4d9e46..b962c5c 100644
--- a/content/docs/latest/_sources/reference/os/iob.rst.txt
+++ b/content/docs/latest/_sources/reference/os/iob.rst.txt
@@ -164,6 +164,7 @@ Public Function Prototypes
- :c:func:`iob_remove_queue()`
- :c:func:`iob_peek_queue()`
- :c:func:`iob_free_queue()`
+ - :c:func:`iob_free_queue_qentry()`
- :c:func:`iob_copyin()`
- :c:func:`iob_trycopyin()`
- :c:func:`iob_copyout()`
@@ -191,13 +192,15 @@ Public Function Prototypes
buffer at the head of the free list without waiting for a buffer
to become free.
-.. c:function:: FAR struct iob_s *iob_free(FAR struct iob_s *iob);
+.. c:function:: FAR struct iob_s *iob_free(FAR struct iob_s *iob, \
+ enum iob_user_e producerid);
Free the I/O buffer at the head of a buffer chain
returning it to the free list. The link to the next I/O buffer in
the chain is return.
-.. c:function:: void iob_free_chain(FAR struct iob_s *iob);
+.. c:function:: void iob_free_chain(FAR struct iob_s *iob, \
+ enum iob_user_e producerid);
Free an entire buffer chain, starting at the
beginning of the I/O buffer chain
@@ -231,10 +234,16 @@ Public Function Prototypes
:return: Returns a reference to the I/O buffer chain at
the head of the queue.
-.. c:function:: void iob_free_queue(FAR struct iob_queue_s *qhead);
+.. c:function:: void iob_free_queue(FAR struct iob_queue_s *qhead, \
+ enum iob_user_e producerid);
Free an entire queue of I/O buffer chains.
+.. c:function:: void iob_free_queue_qentry(FAR struct iob_s *iob, \
+ FAR struct iob_queue_s *iobq);
+
+ Free an iob entire queue of I/O buffer chains.
+
.. c:function:: int iob_copyin(FAR struct iob_s *iob, FAR const uint8_t *src, \
unsigned int len, unsigned int offset, bool throttled);
@@ -265,14 +274,15 @@ Public Function Prototypes
Concatenate iob_s chain iob2 to iob1.
-.. c:function:: FAR struct iob_s *iob_trimhead(FAR struct iob_s *iob, unsigned int trimlen)
+.. c:function:: FAR struct iob_s *iob_trimhead(FAR struct iob_s *iob, \
+ unsigned int trimlen, enum iob_user_e producerid)
Remove bytes from the beginning of an I/O chain.
Emptied I/O buffers are freed and, hence, the beginning of the
chain may change.
.. c:function:: FAR struct iob_s *iob_trimhead_queue(FAR struct iob_queue_s *qhead, \
- unsigned int trimlen);
+ unsigned int trimlen, enum iob_user_e producerid);
Remove bytes from the beginning of an I/O chain
at the head of the queue. Emptied I/O buffers are freed and,
@@ -285,19 +295,22 @@ Public Function Prototypes
:return: The new iob at the head of the queue is
returned.
-.. c:function:: FAR struct iob_s *iob_trimtail(FAR struct iob_s *iob, unsigned int trimlen);
+.. c:function:: FAR struct iob_s *iob_trimtail(FAR struct iob_s *iob, \
+ unsigned int trimlen, enum iob_user_e producerid);
Remove bytes from the end of an I/O chain.
Emptied I/O buffers are freed NULL will be returned in the special
case where the entry I/O buffer chain is freed.
-.. c:function:: FAR struct iob_s *iob_pack(FAR struct iob_s *iob);
+.. c:function:: FAR struct iob_s *iob_pack(FAR struct iob_s *iob, \
+ enum iob_user_e producerid);
Pack all data in the I/O buffer chain so that the
data offset is zero and all but the final buffer in the chain are
filled. Any emptied buffers at the end of the chain are freed.
-.. c:function:: int iob_contig(FAR struct iob_s *iob, unsigned int len);
+.. c:function:: int iob_contig(FAR struct iob_s *iob, unsigned int len, \
+ enum iob_user_e producerid);
Ensure that there is ``len`` bytes of contiguous
space at the beginning of the I/O buffer chain starting at
diff --git a/content/docs/latest/genindex.html b/content/docs/latest/genindex.html
index 9b20977..4049685 100644
--- a/content/docs/latest/genindex.html
+++ b/content/docs/latest/genindex.html
@@ -544,6 +544,8 @@
</li>
<li><a href="reference/os/iob.html#c.iob_free_queue">iob_free_queue (C function)</a>
</li>
+ <li><a href="reference/os/iob.html#c.iob_free_queue_qentry">iob_free_queue_qentry (C function)</a>
+</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference/os/iob.html#c.iob_initialize">iob_initialize (C function)</a>
diff --git a/content/docs/latest/index.html b/content/docs/latest/index.html
index f5d73f1..7f4b14f 100644
--- a/content/docs/latest/index.html
+++ b/content/docs/latest/index.html
@@ -214,7 +214,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: 10 June 21 at 00:06</p>
+<p>Last Updated: 10 June 21 at 16:55</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 db0eb83..75a3bd7 100644
Binary files a/content/docs/latest/objects.inv and b/content/docs/latest/objects.inv differ
diff --git a/content/docs/latest/reference/os/iob.html b/content/docs/latest/reference/os/iob.html
index 3e653ed..ad1641c 100644
--- a/content/docs/latest/reference/os/iob.html
+++ b/content/docs/latest/reference/os/iob.html
@@ -391,6 +391,7 @@ module.</p>
<li><p><a class="reference internal" href="#c.iob_remove_queue" title="iob_remove_queue"><code class="xref c c-func docutils literal notranslate"><span class="pre">iob_remove_queue()</span></code></a></p></li>
<li><p><a class="reference internal" href="#c.iob_peek_queue" title="iob_peek_queue"><code class="xref c c-func docutils literal notranslate"><span class="pre">iob_peek_queue()</span></code></a></p></li>
<li><p><a class="reference internal" href="#c.iob_free_queue" title="iob_free_queue"><code class="xref c c-func docutils literal notranslate"><span class="pre">iob_free_queue()</span></code></a></p></li>
+<li><p><a class="reference internal" href="#c.iob_free_queue_qentry" title="iob_free_queue_qentry"><code class="xref c c-func docutils literal notranslate"><span class="pre">iob_free_queue_qentry()</span></code></a></p></li>
<li><p><a class="reference internal" href="#c.iob_copyin" title="iob_copyin"><code class="xref c c-func docutils literal notranslate"><span class="pre">iob_copyin()</span></code></a></p></li>
<li><p><a class="reference internal" href="#c.iob_trycopyin" title="iob_trycopyin"><code class="xref c c-func docutils literal notranslate"><span class="pre">iob_trycopyin()</span></code></a></p></li>
<li><p><a class="reference internal" href="#c.iob_copyout" title="iob_copyout"><code class="xref c c-func docutils literal notranslate"><span class="pre">iob_copyout()</span></code></a></p></li>
@@ -427,7 +428,7 @@ to become free.</p>
<dl class="c function">
<dt id="c.iob_free">
-<span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">iob_free</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><em><span class="pre">iob</span></em><span class="sig-paren">)</span><span class="pre">;</span><a cl [...]
+<span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">iob_free</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><em><span class="pre">iob</span></em>, <em class="property"><span class="pre">enum</span></em> <span [...]
<dd><p>Free the I/O buffer at the head of a buffer chain
returning it to the free list. The link to the next I/O buffer in
the chain is return.</p>
@@ -435,7 +436,7 @@ the chain is return.</p>
<dl class="c function">
<dt id="c.iob_free_chain">
-<span class="pre">void</span> <code class="sig-name descname"><span class="pre">iob_free_chain</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><em><span class="pre">iob</span></em><span class="sig-paren">)</span><span class="pre">;</span><a class="headerlink" href="#c.iob_free_chain" title="Permalink to this definition">¶</a><br /></dt>
+<span class="pre">void</span> <code class="sig-name descname"><span class="pre">iob_free_chain</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><em><span class="pre">iob</span></em>, <em class="property"><span class="pre">enum</span></em> <span class="pre">iob_user_e</span> <em><span class="pre">producerid</span></em><span class="sig-paren">)</span>< [...]
<dd><p>Free an entire buffer chain, starting at the
beginning of the I/O buffer chain</p>
</dd></dl>
@@ -485,11 +486,17 @@ the head of the queue.</p>
<dl class="c function">
<dt id="c.iob_free_queue">
-<span class="pre">void</span> <code class="sig-name descname"><span class="pre">iob_free_queue</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_queue_s</span> <span class="pre">*</span><em><span class="pre">qhead</span></em><span class="sig-paren">)</span><span class="pre">;</span><a class="headerlink" href="#c.iob_free_queue" title="Permalink to this definition">¶</a><br /></dt>
+<span class="pre">void</span> <code class="sig-name descname"><span class="pre">iob_free_queue</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_queue_s</span> <span class="pre">*</span><em><span class="pre">qhead</span></em>, <em class="property"><span class="pre">enum</span></em> <span class="pre">iob_user_e</span> <em><span class="pre">producerid</span></em><span class="sig-paren">) [...]
<dd><p>Free an entire queue of I/O buffer chains.</p>
</dd></dl>
<dl class="c function">
+<dt id="c.iob_free_queue_qentry">
+<span class="pre">void</span> <code class="sig-name descname"><span class="pre">iob_free_queue_qentry</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><em><span class="pre">iob</span></em>, <span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_queue_s</span> <span class="pre">*</span><em><span cl [...]
+<dd><p>Free an iob entire queue of I/O buffer chains.</p>
+</dd></dl>
+
+<dl class="c function">
<dt id="c.iob_copyin">
<span class="pre">int</span> <code class="sig-name descname"><span class="pre">iob_copyin</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><em><span class="pre">iob</span></em>, <span class="pre">FAR</span> <em class="property"><span class="pre">const</span></em> <span class="pre">uint8_t</span> <span class="pre">*</span><em><span class="pre">src</sp [...]
<dd><p>Copy data <code class="docutils literal notranslate"><span class="pre">len</span></code> bytes from a user buffer into
@@ -528,7 +535,7 @@ actual number of bytes copied out.</p>
<dl class="c function">
<dt id="c.iob_trimhead">
-<span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">iob_trimhead</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><em><span class="pre">iob</span></em>, <span class="pre">unsigned</span> <span class="pre">int</ [...]
+<span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">iob_trimhead</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><em><span class="pre">iob</span></em>, <span class="pre">unsigned</span> <span class="pre">int</ [...]
<dd><p>Remove bytes from the beginning of an I/O chain.
Emptied I/O buffers are freed and, hence, the beginning of the
chain may change.</p>
@@ -536,7 +543,7 @@ chain may change.</p>
<dl class="c function">
<dt id="c.iob_trimhead_queue">
-<span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">iob_trimhead_queue</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_queue_s</span> <span class="pre">*</span><em><span class="pre">qhead</span></em>, <span class="pre">unsigned</span> <span cla [...]
+<span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">iob_trimhead_queue</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_queue_s</span> <span class="pre">*</span><em><span class="pre">qhead</span></em>, <span class="pre">unsigned</span> <span cla [...]
<dd><p>Remove bytes from the beginning of an I/O chain
at the head of the queue. Emptied I/O buffers are freed and,
hence, the head of the queue may change.</p>
@@ -553,7 +560,7 @@ returned.</p>
<dl class="c function">
<dt id="c.iob_trimtail">
-<span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">iob_trimtail</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><em><span class="pre">iob</span></em>, <span class="pre">unsigned</span> <span class="pre">int</ [...]
+<span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">iob_trimtail</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><em><span class="pre">iob</span></em>, <span class="pre">unsigned</span> <span class="pre">int</ [...]
<dd><p>Remove bytes from the end of an I/O chain.
Emptied I/O buffers are freed NULL will be returned in the special
case where the entry I/O buffer chain is freed.</p>
@@ -561,7 +568,7 @@ case where the entry I/O buffer chain is freed.</p>
<dl class="c function">
<dt id="c.iob_pack">
-<span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">iob_pack</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><em><span class="pre">iob</span></em><span class="sig-paren">)</span><span class="pre">;</span><a cl [...]
+<span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">iob_pack</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><em><span class="pre">iob</span></em>, <em class="property"><span class="pre">enum</span></em> <span [...]
<dd><p>Pack all data in the I/O buffer chain so that the
data offset is zero and all but the final buffer in the chain are
filled. Any emptied buffers at the end of the chain are freed.</p>
@@ -569,7 +576,7 @@ filled. Any emptied buffers at the end of the chain are freed.</p>
<dl class="c function">
<dt id="c.iob_contig">
-<span class="pre">int</span> <code class="sig-name descname"><span class="pre">iob_contig</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><em><span class="pre">iob</span></em>, <span class="pre">unsigned</span> <span class="pre">int</span> <em><span class="pre">len</span></em><span class="sig-paren">)</span><span class="pre">;</span><a class="header [...]
+<span class="pre">int</span> <code class="sig-name descname"><span class="pre">iob_contig</span></code><span class="sig-paren">(</span><span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">iob_s</span> <span class="pre">*</span><em><span class="pre">iob</span></em>, <span class="pre">unsigned</span> <span class="pre">int</span> <em><span class="pre">len</span></em>, <em class="property"><span class="pre">enum</span></em> <span class="pre [...]
<dd><p>Ensure that there is <code class="docutils literal notranslate"><span class="pre">len</span></code> bytes of contiguous
space at the beginning of the I/O buffer chain starting at
<code class="docutils literal notranslate"><span class="pre">iob</span></code>.</p>
diff --git a/content/docs/latest/searchindex.js b/content/docs/latest/searchindex.js
index 507a5a4..48c9ff4 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","components/binfmt","components/drivers/block/index","components/drivers/character/analog","components/drivers/character/can","components/drivers/character/foc","components/drivers/character/index","components/drivers/character [...]
\ 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","components/binfmt","components/drivers/block/index","components/drivers/character/analog","components/drivers/character/can","components/drivers/character/foc","components/drivers/character/index","components/drivers/character [...]
\ No newline at end of file
diff --git a/content/feed.xml b/content/feed.xml
index 02b469f..92fb574 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>Thu, 10 Jun 2021 00:08:10 +0000</pubDate>
- <lastBuildDate>Thu, 10 Jun 2021 00:08:10 +0000</lastBuildDate>
+ <pubDate>Thu, 10 Jun 2021 16:57:06 +0000</pubDate>
+ <lastBuildDate>Thu, 10 Jun 2021 16:57:06 +0000</lastBuildDate>
<generator>Jekyll v3.8.5</generator>
<item>
diff --git a/content/releases/9.1.0/index.html b/content/releases/9.1.0/index.html
index 058c8d3..00e784c 100644
--- a/content/releases/9.1.0/index.html
+++ b/content/releases/9.1.0/index.html
@@ -539,6 +539,252 @@ a build breakage.</li>
</li>
</ul>
</li>
+ <li>
+ <p>Compatibility Concerns – Changes to Build System:</p>
+
+ <p>If you are building NuttX for a custom board, you may need to make
+some of the following changes in build-related files for your board:</p>
+
+ <ul>
+ <li>
+ <p>Rename EXTRADEFINES to EXTRAFLAGS</p>
+
+ <p>In your custom board’s scripts/Make.defs file, rename EXTRADEFINES to
+EXTRAFLAGS.</p>
+
+ <p>For example, these lines:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>CFLAGS = $(ARCHCFLAGS) $(ARCHWARNINGS) $(ARCHOPTIMIZATION) $(ARCHCPUFLAGS) $(ARCHINCLUDES) $(ARCHDEFINES) $(EXTRADEFINES) -pipe
+...
+CXXFLAGS = $(ARCHCXXFLAGS) $(ARCHWARNINGSXX) $(ARCHOPTIMIZATION) $(ARCHCPUFLAGS) $(ARCHXXINCLUDES) $(ARCHDEFINES) $(EXTRADEFINES) -pipe
+...
+CPPFLAGS = $(ARCHINCLUDES) $(ARCHDEFINES) $(EXTRADEFINES)
+</code></pre></div> </div>
+
+ <p>would change as follows:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>CFLAGS = $(ARCHCFLAGS) $(ARCHWARNINGS) $(ARCHOPTIMIZATION) $(ARCHCPUFLAGS) $(ARCHINCLUDES) $(ARCHDEFINES) $(EXTRAFLAGS) -pipe
+...
+CXXFLAGS = $(ARCHCXXFLAGS) $(ARCHWARNINGSXX) $(ARCHOPTIMIZATION) $(ARCHCPUFLAGS) $(ARCHXXINCLUDES) $(ARCHDEFINES) $(EXTRAFLAGS) -pipe
+...
+CPPFLAGS = $(ARCHINCLUDES) $(ARCHDEFINES) $(EXTRAFLAGS)
+</code></pre></div> </div>
+
+ <p>See git commit # 459ad9937377a42785692098ff0d73baaa9551e6 in the main
+NuttX repository.</p>
+
+ <p>If you forget to do this, memory allocations on the heap probably won’t
+work and your user tasks won’t start.</p>
+
+ <p>To see why, tools/Config.mk assigns a value to KDEFINE such that the
+preprocessor symbol <strong>KERNEL</strong> will be defined when certain source
+files are compiled. KDEFINE is passed to nested invocations of ‘make’
+as EXTRAFLAGS. If your board’s scripts/Make.defs still attempts to use
+EXTRADEFINES, the preprocessor symbol <strong>KERNEL</strong> will not be defined in
+some of the places that it should be. Suppose you’re building a FLAT
+build. In this case, include/nuttx/mm/mm.h will not define
+MM_KERNEL_USRHEAP_INIT like it should, which will cause nx_start.c not
+to call up_allocate_heap() at startup. Therefore, any attempt to
+allocate memory on the heap will fail.</p>
+ </li>
+ <li>
+ <p>Rename src/Makefile to src/Make.defs and Modify</p>
+
+ <p>This item pertains only to custom boards that are developed in- tree,
+meaning under the NuttX boards/ subdirectory. Out-of-tree boards are
+not affected.</p>
+
+ <p>If your custom board directory is in-tree and in a board family that
+uses a ‘boards/ARCH/FAMILY/common’ directory (such as
+boards/arm/stm32/common, boards/arm/cxd56xx/common, etc), then you’ll
+need to make two minor changes to your custom board’s src/Makefile:</p>
+
+ <p>(1) Rename it from src/Makefile to src/Make.defs, and</p>
+
+ <p>(2) Near the end of that file, replace this line, which usually
+ appears at the end:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>include $(TOPDIR)/boards/Board.mk
+</code></pre></div> </div>
+
+ <p>with these three lines:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>DEPPATH += --dep-path board
+VPATH += :board
+CFLAGS += $(shell $(INCDIR) $(INCDIROPT) "$(CC)" $(TOPDIR)$(DELIM)arch$(DELIM)$(CONFIG_ARCH)$(DELIM)src$(DELIM)board$(DELIM)board)
+</code></pre></div> </div>
+
+ <p>See git commit # 6ca46520df38854bf660f9be54957cceede39ded in the main
+NuttX repository.</p>
+
+ <p>If you forget to do this, ‘make’ will report an error, “no rule to make
+libboard.a,” and the build will fail.</p>
+ </li>
+ <li>
+ <p>Rename WINTOOL to CONFIG_CYGWIN_WINTOOL</p>
+
+ <p>In your custom board’s scripts/Make.defs file, rename any instances of
+WINTOOL to CONFIG_CYGWIN_WINTOOL.</p>
+
+ <p>For example, change this line:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>ifeq ($(WINTOOL),y)
+</code></pre></div> </div>
+
+ <p>to this:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>ifeq ($(CONFIG_CYGWIN_WINTOOL),y)
+</code></pre></div> </div>
+
+ <p>See git commit # bd656888f26c92e8832f0e76b395a5ece7704530 in the main
+NuttX repository.</p>
+ </li>
+ <li>
+ <p>Remove INCDIROPT</p>
+
+ <p>In your custom board’s src/Make.defs file, remove INCDIROPT from CFLAGS.</p>
+
+ <p>For example, change this line:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>CFLAGS += $(shell $(INCDIR) $(INCDIROPT) "$(CC)" $(TOPDIR)$(DELIM)arch$(DELIM)$(CONFIG_ARCH)$(DELIM)src$(DELIM)board$(DELIM)board)
+</code></pre></div> </div>
+
+ <p>to this:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>CFLAGS += $(shell $(INCDIR) "$(CC)" $(TOPDIR)$(DELIM)arch$(DELIM)$(CONFIG_ARCH)$(DELIM)src$(DELIM)board$(DELIM)board)
+</code></pre></div> </div>
+
+ <p>This option, which resolves to -w when CONFIG_CYGWIN_WINTOOL is
+configured, is now appended to INCDIR in tools/Config.mk.</p>
+
+ <p>See git commit # 5eae32577e5d5226e5d3027c169eeb369f83f77d in the main
+NuttX repository.</p>
+ </li>
+ <li>
+ <p>Remove Unnecessary Variables</p>
+
+ <p>In your custom board’s scripts/Make.defs file, It is no longer
+necessary to define the following variables unless your build requires
+that you assign special values to them:</p>
+
+ <ul>
+ <li>DIRLINK</li>
+ <li>DIRUNLINK</li>
+ <li>MKDEP</li>
+ <li>ASMEXT</li>
+ <li>OBJEXT</li>
+ <li>LIBEXT</li>
+ <li>EXEEXT</li>
+ </ul>
+
+ <p>These variables have been refactored into tools/Config.mk.</p>
+
+ <p>See these git commits in the main NuttX repository:
+9ec9431706fd0eb7c4c4410d84dafff68ff31366 (DIRLINK and DIRUNLINK),
+8b42ee421a41214093c0238e479d73a1099b0e82 (MKDEP), and
+567962bd6263bf8809fb63c739f6ec668c69c416 (ASMEXT, OBJEXT, LIBEXT, EXEEXT)</p>
+ </li>
+ <li>
+ <p>Change ${TOPDIR} to $(TOPDIR)</p>
+
+ <p>In your custom board’s scripts/Make.defs file, it is recommended to
+change ${TOPDIR} to $(TOPDIR) for consistency (change curly braces to
+parenthesis).</p>
+
+ <p>See git commit # faf3c0254bb63af89f9eb59beefacb4cba26dd9 in the main
+NuttX repository.</p>
+ </li>
+ <li>
+ <p>Remove Workaround For Missing $(TOPDIR)/Make.defs</p>
+
+ <p>In src/Make.defs or src/Makefile for your custom board or custom apps,
+the workaround for missing $(TOPDIR)/.config and/or
+$(TOPDIR)/Make.defs is no longer needed. To remove the workaround,
+delete the minus sign in front of include .config. This is now handled
+in the main Makefile and, if those files are missing, will print an
+error message with hint to run tools/configure.sh <target>.</target></p>
+
+ <p>Change this line, located near the top of the file:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>-include $(TOPDIR)/Make.defs
+</code></pre></div> </div>
+
+ <p>to this:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>include $(TOPDIR)/Make.defs
+</code></pre></div> </div>
+
+ <p>See git commit # 1a95cce1a3c3ed8b04d1d86b7bd744352cca45a2 in the main
+NuttX repository, and git commit</p>
+ <h1 id="ead498a7883a654b1d542da94a5fab3ce163361e-in-the-apps-repository">ead498a7883a654b1d542da94a5fab3ce163361e in the apps repository.</h1>
+ </li>
+ <li>
+ <p>Simplify ARCHINCLUDES and ARCHXXINCLUDES</p>
+
+ <p>In your custom board’s scripts/Make.defs, ARCHINCLUDES and
+ARCHXXINCLUDES can be defined without maintaining two different
+versions conditioned upon CONFIG_CYGWIN_WINTOOL (renamed from WINTOOL).
+Replace syntax similar to the following:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>ifeq ($(CONFIG_CYGWIN_WINTOOL),y)
+# Windows-native toolchains
+ ARCHINCLUDES = -I. -isystem "${shell cygpath -w $(TOPDIR)$(DELIM)include}"
+ ARCHXXINCLUDES = -I. -isystem "${shell cygpath -w $(TOPDIR)$(DELIM)include}" -isystem "${shell cygpath -w $(TOPDIR)$(DELIM)include$(DELIM)cxx}"
+else
+# Linux/Cygwin-native toolchain
+ ARCHINCLUDES = -I. -isystem $(TOPDIR)$(DELIM)include
+ ARCHXXINCLUDES = -I. -isystem $(TOPDIR)$(DELIM)include -isystem $(TOPDIR)$(DELIM)include$(DELIM)cxx
+endif
+</code></pre></div> </div>
+
+ <p>with syntax similar to:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>ARCHINCLUDES += ${shell $(INCDIR) -s "$(CC)" $(TOPDIR)$(DELIM)include}
+ARCHXXINCLUDES += ${shell $(INCDIR) -s "$(CC)" $(TOPDIR)$(DELIM)include}
+ARCHXXINCLUDES += ${shell $(INCDIR) -s "$(CC)" $(TOPDIR)$(DELIM)include$(DELIM)cxx}
+INCDIR is defined in tools/Config.mk and resolves to a shell script or batch file that constructs the appropriate command line argument string to specify include directories for your compiler.
+</code></pre></div> </div>
+
+ <p>See git commit # 7e5b0f81e93c7e879ce8434d57e8bf4e2319c1c0 in the main
+NuttX repository.</p>
+ </li>
+ <li>
+ <p>Simplify Board Directory Handling With BOARD_DIR</p>
+
+ <p>In your custom board’s Make.defs or Makefile, when setting up build
+variables containing paths inside your board directory, a new variable
+BOARD_DIR has been introduced that simplifies the syntax:</p>
+
+ <p>Replace syntax like this:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$(TOPDIR)$(DELIM)boards$(DELIM)$(CONFIG_ARCH)$(DELIM)$(CONFIG_ARCH_CHIP)$(DELIM)$(CONFIG_ARCH_BOARD)
+</code></pre></div> </div>
+
+ <p>with this variable:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$(BOARD_DIR)
+</code></pre></div> </div>
+
+ <p>For example, change this:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>ARCHSCRIPT = -T$(TOPDIR)$(DELIM)boards$(DELIM)$(CONFIG_ARCH)$(DELIM)$(CONFIG_ARCH_CHIP)$(DELIM)$(CONFIG_ARCH_BOARD)$(DELIM)scripts$(DELIM)$(LDSCRIPT)
+</code></pre></div> </div>
+
+ <p>to this much simpler syntax:</p>
+
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>ARCHSCRIPT = -T$(BOARD_DIR)$(DELIM)scripts$(DELIM)$(LDSCRIPT)
+</code></pre></div> </div>
+
+ <p>You may find the old syntax being used for variables like ARCHSCRIPT,
+LDELFFLAGS, LINKCMDTEMPLATE, SCRIPTDIR, USER_LDSCRIPT, or others.</p>
+
+ <p>BOARD_DIR is defined in tools/Config.mk.</p>
+
+ <p>See git commit # e83c1400b65c65cbdf59c5abcf2ae368f540faef in the main
+NuttX repository.</p>
+ </li>
+ </ul>
+ </li>
</ul>
</div>