Update documentations

classes.html

@@ -74,7 +74,7 @@
 <dd><a class="el" href="structblock__header.html">block_header</a></dd></dl>
 <dl class="classindex odd">
 <dt class="alphachar"><a name="letter_C">C</a></dt>
-<dd><a class="el" href="structcond.html">cond</a></dd></dl>
+<dd><a class="el" href="structcond.html">cond</a></dd><dd><a class="el" href="structcontext.html">context</a></dd><dd><a class="el" href="structcontext__fpu.html">context_fpu</a></dd></dl>
 <dl class="classindex even">
 <dt class="alphachar"><a name="letter_D">D</a></dt>
 <dd><a class="el" href="structdentry.html">dentry</a></dd><dd><a class="el" href="structdirent.html">dirent</a></dd><dd><a class="el" href="structdirstream.html">dirstream</a></dd><dd><a class="el" href="structdiv__t.html">div_t</a></dd></dl>
@@ -101,7 +101,7 @@
 <dd><a class="el" href="structreg__file.html">reg_file</a></dd></dl>
 <dl class="classindex even">
 <dt class="alphachar"><a name="letter_S">S</a></dt>
-<dd><a class="el" href="structsched__param.html">sched_param</a></dd><dd><a class="el" href="unionsem__t.html">sem_t</a></dd><dd><a class="el" href="structsemaphore.html">semaphore</a></dd><dd><a class="el" href="structsigaction.html">sigaction</a></dd><dd><a class="el" href="structsigevent.html">sigevent</a></dd><dd><a class="el" href="structsiginfo__t.html">siginfo_t</a></dd><dd><a class="el" href="unionsigval.html">sigval</a></dd><dd><a class="el" href="structslab.html">slab</a></dd><dd><a class="el" href="structstack.html">stack</a></dd><dd><a class="el" href="structstack__fpu.html">stack_fpu</a></dd><dd><a class="el" href="structstaged__handler__info.html">staged_handler_info</a></dd><dd><a class="el" href="structstat.html">stat</a></dd><dd><a class="el" href="structsuper__block.html">super_block</a></dd><dd><a class="el" href="structsyscall__info.html">syscall_info</a></dd></dl>
+<dd><a class="el" href="structsched__param.html">sched_param</a></dd><dd><a class="el" href="unionsem__t.html">sem_t</a></dd><dd><a class="el" href="structsemaphore.html">semaphore</a></dd><dd><a class="el" href="structsigaction.html">sigaction</a></dd><dd><a class="el" href="structsigevent.html">sigevent</a></dd><dd><a class="el" href="structsiginfo__t.html">siginfo_t</a></dd><dd><a class="el" href="unionsigval.html">sigval</a></dd><dd><a class="el" href="structslab.html">slab</a></dd><dd><a class="el" href="structstaged__handler__info.html">staged_handler_info</a></dd><dd><a class="el" href="structstat.html">stat</a></dd><dd><a class="el" href="structsuper__block.html">super_block</a></dd><dd><a class="el" href="structsyscall__info.html">syscall_info</a></dd></dl>
 <dl class="classindex odd">
 <dt class="alphachar"><a name="letter_T">T</a></dt>
 <dd><a class="el" href="structtask__hook.html">task_hook</a></dd><dd><a class="el" href="structtask__struct.html">task_struct</a></dd><dd><a class="el" href="structtasklet__struct.html">tasklet_struct</a></dd><dd><a class="el" href="structthread__attr.html">thread_attr</a></dd><dd><a class="el" href="structthread__info.html">thread_info</a></dd><dd><a class="el" href="structthread__once.html">thread_once</a></dd><dd><a class="el" href="structthread__stat.html">thread_stat</a></dd><dd><a class="el" href="structtimer.html">timer</a></dd><dd><a class="el" href="structtimespec.html">timespec</a></dd></dl>

dir_000010_000001.html

@@ -67,7 +67,7 @@
 </div>
 </div><!-- top -->
 <div class="contents">
-<h3>arch &rarr; include Relation</h3><table class="dirtab"><tr class="dirtab"><th class="dirtab">File in kernel/arch</th><th class="dirtab">Includes file in include</th></tr><tr class="dirtab"><td class="dirtab"><b>stm32f4_irq.c</b></td><td class="dirtab"><a class="el" href="dir_2ae24886e77657f82343b4b0154efdc1.html">kernel</a>&#160;/&#160;<a class="el" href="kernel_8h.html">kernel.h</a></td></tr><tr class="dirtab"><td class="dirtab"><b>stm32f4_irq.c</b></td><td class="dirtab"><a class="el" href="dir_7c40e03ac1dfef8b430578d46da2b8fd.html">arch</a>&#160;/&#160;<a class="el" href="port_8h.html">port.h</a></td></tr><tr class="dirtab"><td class="dirtab"><b>stm32f4_irq.c</b></td><td class="dirtab"><a class="el" href="dir_0cd883e7e907ffc60ee3d9c3d6623812.html">tenok</a>&#160;/&#160;<a class="el" href="stdio_8h.html">stdio.h</a></td></tr><tr class="dirtab"><td class="dirtab"><b>stm32f4_irq.c</b></td><td class="dirtab"><a class="el" href="dir_2ae24886e77657f82343b4b0154efdc1.html">kernel</a>&#160;/&#160;<a class="el" href="tty_8h.html">tty.h</a></td></tr></table></div><!-- contents -->
+<h3>arch &rarr; include Relation</h3><table class="dirtab"><tr class="dirtab"><th class="dirtab">File in kernel/arch</th><th class="dirtab">Includes file in include</th></tr><tr class="dirtab"><td class="dirtab"><b>stm32f4_irq.c</b></td><td class="dirtab"><a class="el" href="dir_2ae24886e77657f82343b4b0154efdc1.html">kernel</a>&#160;/&#160;<a class="el" href="interrupt_8h.html">interrupt.h</a></td></tr><tr class="dirtab"><td class="dirtab"><b>stm32f4_irq.c</b></td><td class="dirtab"><a class="el" href="dir_2ae24886e77657f82343b4b0154efdc1.html">kernel</a>&#160;/&#160;<a class="el" href="kernel_8h.html">kernel.h</a></td></tr><tr class="dirtab"><td class="dirtab"><b>stm32f4_irq.c</b></td><td class="dirtab"><a class="el" href="dir_7c40e03ac1dfef8b430578d46da2b8fd.html">arch</a>&#160;/&#160;<a class="el" href="port_8h.html">port.h</a></td></tr><tr class="dirtab"><td class="dirtab"><b>stm32f4_irq.c</b></td><td class="dirtab"><a class="el" href="dir_2ae24886e77657f82343b4b0154efdc1.html">kernel</a>&#160;/&#160;<a class="el" href="printk_8h.html">printk.h</a></td></tr><tr class="dirtab"><td class="dirtab"><b>stm32f4_irq.c</b></td><td class="dirtab"><a class="el" href="dir_0cd883e7e907ffc60ee3d9c3d6623812.html">tenok</a>&#160;/&#160;<a class="el" href="stdio_8h.html">stdio.h</a></td></tr><tr class="dirtab"><td class="dirtab"><b>v7m_port.c</b></td><td class="dirtab"><a class="el" href="dir_2ae24886e77657f82343b4b0154efdc1.html">kernel</a>&#160;/&#160;<a class="el" href="kernel_8h.html">kernel.h</a></td></tr><tr class="dirtab"><td class="dirtab"><b>v7m_port.c</b></td><td class="dirtab"><a class="el" href="dir_7c40e03ac1dfef8b430578d46da2b8fd.html">arch</a>&#160;/&#160;<a class="el" href="port_8h.html">port.h</a></td></tr><tr class="dirtab"><td class="dirtab"><b>v7m_port.c</b></td><td class="dirtab"><a class="el" href="dir_2ae24886e77657f82343b4b0154efdc1.html">kernel</a>&#160;/&#160;<a class="el" href="printk_8h.html">printk.h</a></td></tr></table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1

dir_4a04b9aac4eefdd334a78e565f4616f2.html

@@ -78,7 +78,7 @@
 <map name="adir__4a04b9aac4eefdd334a78e565f4616f2__dep" id="adir__4a04b9aac4eefdd334a78e565f4616f2__dep">
 <area shape="rect" href="dir_4a04b9aac4eefdd334a78e565f4616f2.html" title="arch" alt="" coords="27,52,99,100"/>
 <area shape="rect" href="dir_d44c64559bbebec7f509842c48db8b23.html" title="include" alt="" coords="27,148,99,196"/>
-<area shape="rect" href="dir_000010_000001.html" title="4" alt="" coords="66,122,76,137"/>
+<area shape="rect" href="dir_000010_000001.html" title="8" alt="" coords="66,122,76,137"/>
 <area shape="rect" href="dir_dc43877d82dd332f9fb2071fcca799d6.html" title="kernel" alt="" coords="16,16,109,111"/>
 </map>
 </div>

dir_4a04b9aac4eefdd334a78e565f4616f2_dep.map

@@ -1,6 +1,6 @@
 <map id="kernel/arch" name="kernel/arch">
 <area shape="rect" id="node1" href="dir_4a04b9aac4eefdd334a78e565f4616f2.html" title="arch" alt="" coords="27,52,99,100"/>
 <area shape="rect" id="node2" href="dir_d44c64559bbebec7f509842c48db8b23.html" title="include" alt="" coords="27,148,99,196"/>
-<area shape="rect" id="edge1-headlabel" href="dir_000010_000001.html" title="4" alt="" coords="66,122,76,137"/>
+<area shape="rect" id="edge1-headlabel" href="dir_000010_000001.html" title="8" alt="" coords="66,122,76,137"/>
 <area shape="rect" id="clust1" href="dir_dc43877d82dd332f9fb2071fcca799d6.html" title="kernel" alt="" coords="16,16,109,111"/>
 </map>

dir_4a04b9aac4eefdd334a78e565f4616f2_dep.md5

@@ -1 +1 @@
-7527160e70c3eda0e02023ca01588fad
+c58a261db9a0522c5bf0550dcaff4e43

dir_dc43877d82dd332f9fb2071fcca799d6.html

@@ -78,7 +78,7 @@
 <map name="adir__dc43877d82dd332f9fb2071fcca799d6__dep" id="adir__dc43877d82dd332f9fb2071fcca799d6__dep">
 <area shape="rect" href="dir_4a04b9aac4eefdd334a78e565f4616f2.html" title="arch" alt="" coords="219,27,291,75"/>
 <area shape="rect" href="dir_d44c64559bbebec7f509842c48db8b23.html" title="include" alt="" coords="123,123,195,171"/>
-<area shape="rect" href="dir_000010_000001.html" title="4" alt="" coords="196,109,206,123"/>
+<area shape="rect" href="dir_000010_000001.html" title="8" alt="" coords="196,109,206,123"/>
 <area shape="rect" href="dir_8d4fa0f4a82327c9ebbcec4f28c3f560.html" title="fs" alt="" coords="123,27,195,75"/>
 <area shape="rect" href="dir_000011_000001.html" title="31" alt="" coords="158,97,176,112"/>
 <area shape="rect" href="dir_b1e57d24e944d662f3ea8849fcb08ace.html" title="mm" alt="" coords="27,27,99,75"/>

dir_dc43877d82dd332f9fb2071fcca799d6_dep.map

@@ -1,7 +1,7 @@
 <map id="kernel" name="kernel">
 <area shape="rect" id="node2" href="dir_4a04b9aac4eefdd334a78e565f4616f2.html" title="arch" alt="" coords="219,27,291,75"/>
 <area shape="rect" id="node5" href="dir_d44c64559bbebec7f509842c48db8b23.html" title="include" alt="" coords="123,123,195,171"/>
-<area shape="rect" id="edge3-headlabel" href="dir_000010_000001.html" title="4" alt="" coords="196,109,206,123"/>
+<area shape="rect" id="edge3-headlabel" href="dir_000010_000001.html" title="8" alt="" coords="196,109,206,123"/>
 <area shape="rect" id="node3" href="dir_8d4fa0f4a82327c9ebbcec4f28c3f560.html" title="fs" alt="" coords="123,27,195,75"/>
 <area shape="rect" id="edge2-headlabel" href="dir_000011_000001.html" title="31" alt="" coords="158,97,176,112"/>
 <area shape="rect" id="node4" href="dir_b1e57d24e944d662f3ea8849fcb08ace.html" title="mm" alt="" coords="27,27,99,75"/>

dir_dc43877d82dd332f9fb2071fcca799d6_dep.md5

@@ -1 +1 @@
-c856501dbe8dad3d58344f856d48e05b
+fd041132ae38d98fa10569c5bf71826b

fs_8h_source.html

@@ -201,7 +201,7 @@
 <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="preprocessor">#endif</span></div>
 <div class="ttc" id="adirent_8h_html"><div class="ttname"><a href="dirent_8h.html">dirent.h</a></div></div>
 <div class="ttc" id="afcntl_8h_html_adcb60598073f6f9cbb0091ef6768fa5c"><div class="ttname"><a href="fcntl_8h.html#adcb60598073f6f9cbb0091ef6768fa5c">open</a></div><div class="ttdeci">int open(const char *pathname, int flags)</div><div class="ttdoc">Open the file specified by pathname.</div><div class="ttdef"><b>Definition:</b> fcntl.c:13</div></div>
-<div class="ttc" id="afs_8h_html_ac631d919599bc9f992d2827f18fa53c6"><div class="ttname"><a href="fs_8h.html#ac631d919599bc9f992d2827f18fa53c6">fs_print_inode_bitmap</a></div><div class="ttdeci">void fs_print_inode_bitmap(void)</div><div class="ttdef"><b>Definition:</b> fs.c:1262</div></div>
+<div class="ttc" id="afs_8h_html_ac631d919599bc9f992d2827f18fa53c6"><div class="ttname"><a href="fs_8h.html#ac631d919599bc9f992d2827f18fa53c6">fs_print_inode_bitmap</a></div><div class="ttdeci">void fs_print_inode_bitmap(void)</div><div class="ttdef"><b>Definition:</b> fs.c:1276</div></div>
 <div class="ttc" id="aioctl_8h_html_a91177f07a0156bef30f38d3d457425a5"><div class="ttname"><a href="ioctl_8h.html#a91177f07a0156bef30f38d3d457425a5">ioctl</a></div><div class="ttdeci">int ioctl(int fd, unsigned int request, unsigned long arg)</div><div class="ttdoc">Perform device-specific control.</div><div class="ttdef"><b>Definition:</b> fcntl.c:58</div></div>
 <div class="ttc" id="alist_8h_html"><div class="ttname"><a href="list_8h.html">list.h</a></div></div>
 <div class="ttc" id="astructblock__header_html"><div class="ttname"><a href="structblock__header.html">block_header</a></div><div class="ttdef"><b>Definition:</b> fs.h:47</div></div>

globals_c.html

@@ -72,6 +72,9 @@ <h3><a id="index_c"></a>- c -</h3><ul>
 <li>chdir()
 : <a class="el" href="unistd_8h.html#a03af571dfb595681bfa203c83385c07b">unistd.h</a>
 </li>
+<li>check_systick_event()
+: <a class="el" href="port_8h.html#ac929c63848dfa50ee7646e60129319ef">port.h</a>
+</li>
 <li>clock_getres()
 : <a class="el" href="tenok_2time_8h.html#a49d0147c5c0a6a7327541bfa7c694fe9">time.h</a>
 </li>

globals_func.html

@@ -92,6 +92,9 @@ <h3><a id="index_c"></a>- c -</h3><ul>
 <li>chdir()
 : <a class="el" href="unistd_8h.html#a03af571dfb595681bfa203c83385c07b">unistd.h</a>
 </li>
+<li>check_systick_event()
+: <a class="el" href="port_8h.html#ac929c63848dfa50ee7646e60129319ef">port.h</a>
+</li>
 <li>clock_getres()
 : <a class="el" href="tenok_2time_8h.html#a49d0147c5c0a6a7327541bfa7c694fe9">time.h</a>
 </li>
@@ -174,6 +177,9 @@ <h3><a id="index_g"></a>- g -</h3><ul>
 <li>get_proc_mode()
 : <a class="el" href="port_8h.html#a1317b81e79bd5830dcc6a6ff6f5502da">port.h</a>
 </li>
+<li>get_syscall_info()
+: <a class="el" href="port_8h.html#a0fb8810b4e100e106dd3a871dc2e683c">port.h</a>
+</li>
 <li>getcwd()
 : <a class="el" href="unistd_8h.html#a3284211bd28346254245c9d4fd071d7f">unistd.h</a>
 </li>

globals_g.html

@@ -69,6 +69,9 @@ <h3><a id="index_g"></a>- g -</h3><ul>
 <li>get_proc_mode()
 : <a class="el" href="port_8h.html#a1317b81e79bd5830dcc6a6ff6f5502da">port.h</a>
 </li>
+<li>get_syscall_info()
+: <a class="el" href="port_8h.html#a0fb8810b4e100e106dd3a871dc2e683c">port.h</a>
+</li>
 <li>getcwd()
 : <a class="el" href="unistd_8h.html#a3284211bd28346254245c9d4fd071d7f">unistd.h</a>
 </li>

index.html

@@ -67,8 +67,8 @@
 <div class="title">Tenok Documentation</div>  </div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p><a class="anchor" id="md_main_page"></a> This is <a href="https://github.com/shengwen-tw/tenok">Tenok</a>, a real-time operating system (RTOS) for Robotics and the Internet of Things (IoT). It resembles various designs from Linux and maintains a small footprint for ARM Cortex-M processors. Instead of including low-level peripheral drivers as a part of the system like NuttX, Tenok adopts an approach like FreeRTOS, which treats RTOS a third-party library, and the user can choose their own favorite library of hardware abstraction layer (HAL).</p>
-<p>Tenok also offers several utilities for developing Robotic applications, including a debug visualization tool, integration of MAVLink communication protocol, and support of software-in-the-loop simulation with Gazeobo simulator. The Amis people are an indigenous tribe that originated in Taiwan, and the term "tenok" in their language means "kernel."</p>
+<div class="textblock"><p><a class="anchor" id="md_main_page"></a> The project <a href="https://github.com/shengwen-tw/tenok">Tenok</a> is a real-time operating system (RTOS) designed for robotic applications and the Internet of Things (IoT). The name originated from the language of an indigenous tribe called Amis in Taiwan, where the term "tenok" means "kernel" in their language. It resembles various designs from Linux and maintains a small code footprint for ARM Cortex-M processors. Unlike NuttX, Tenok does not implement a set of low-level hardware drivers as a part of the system but instead adopts an approach similar to FreeRTOS by treating the RTOS as a third-party library, and the user can choose their favorite library of the hardware abstraction layer (HAL).</p>
+<p>Tenok also integrates the MAVLink communication protocol and offers several utilities for robotics, including a debug visualization tool and a facility tool for supporting software-in-the-loop simulation with the Gazebo simulator.</p>
 <h2><a class="anchor" id="autotoc_md0"></a>
 Key Features</h2>
 <ul>
@@ -77,9 +77,9 @@ <h2><a class="anchor" id="autotoc_md0"></a>
 <li>Task and Thread (Task resembles UNIX process as a group of threads)</li>
 <li>Synchronization: Mutex (supports priority inheritance), Semaphore, and Spinlock</li>
 <li>Inter-Process Communication (IPC): FIFO (Named pipe), Message Queue, and Signals</li>
-<li>Kernel-space memory allocation: Buddy system and Slab allocator</li>
+<li>Kernel-space memory allocation: Buddy allocator and Slab allocator</li>
 <li>User-space memory allocation: Memory pool and First-Fit Free List</li>
-<li>Software timer</li>
+<li>Software timer and clock</li>
 <li>Built-in Shell with command completion and history saving</li>
 <li>Root and ROM file systems</li>
 <li>Real-time plotting and customizable debug messaging with metalanguage</li>
@@ -89,7 +89,7 @@ <h2><a class="anchor" id="autotoc_md0"></a>
 <h2><a class="anchor" id="autotoc_md1"></a>
 Tools</h2>
 <ul>
-<li><b>mkromfs</b>: Import files into firmware binary with <code>Tenok</code>'s romfs format</li>
+<li><b>mkromfs</b>: Import files to the firmware binary with <code>Tenok</code>'s romfs format</li>
 <li><b>msggen</b>: Convert user-defined metalanguage messages into C codes and YAML files</li>
 <li><b>rtplot</b>: For on-board data real-time plotting, where the message definitions are loaded from the auto-generated YAML files</li>
 <li><b>gazebo_bridge</b>: Message forwarding between <code>Tenok</code> (serial) and Gazebo simulator (TCP/IP)</li>
@@ -101,7 +101,7 @@ <h2><a class="anchor" id="autotoc_md2"></a>
 <li><a href="https://tenok-rtos.github.io/md_docs_2_build_and_run.html">Build and Run the Tenok</a></li>
 <li><a href="https://tenok-rtos.github.io/md_docs_3_shell.html">Interact with Tenok Shell</a></li>
 <li><a href="https://tenok-rtos.github.io/md_docs_4_gazebo.html">Run Tenok with Gazebo Simulator</a></li>
-<li><a href="https://tenok-rtos.github.io/md_docs_5_debug_link.html">Real-time Visualization with RTPlot and Debug-Link</a></li>
+<li><a href="https://tenok-rtos.github.io/md_docs_5_debug_link.html">Real-time Visualization with rtplot and debug-link</a></li>
 </ul>
 <h2><a class="anchor" id="autotoc_md3"></a>
 Resources</h2>