update

orix-software · Feb 4, 2024 · 39ecefc · 39ecefc
1 parent 2ec1da9
commit 39ecefc
Show file tree

Hide file tree

Showing 24 changed files with 571 additions and 17 deletions.
diff --git a/docs/api/2024.1/assembly/index.html b/docs/api/2024.1/assembly/index.html
@@ -454,6 +454,13 @@
     ch395_get_int_status_sn
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#ch395_get_ip_inf" class="md-nav__link">
+    ch395_get_ip_inf
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -755,6 +762,13 @@
     ch395_get_int_status_sn
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#ch395_get_ip_inf" class="md-nav__link">
+    ch395_get_ip_inf
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -946,7 +960,7 @@ <h2 id="ch395_check_exist">ch395_check_exist</h2>
 <p>Checks if ch395 exists</p>
 <p><strong><em>Example</em></strong></p>
 <div class="highlight"><pre><span></span><code><span class="w"> </span><span class="k">jsr</span><span class="w"> </span><span class="n">ch395_get_glob_int_status</span>
-<span class="w"> </span><span class="k">cmp</span><span class="w"> </span><span class="p">#</span><span class="mh">$AA</span>
+<span class="w"> </span><span class="k">cmp</span><span class="w"> </span><span class="p">#</span><span class="n">CH395_DETECTED</span>
 <span class="w"> </span><span class="k">beq</span><span class="w"> </span><span class="n">ch395_connected</span>
 <span class="w"> </span><span class="k">rts</span>
 <span class="nl">ch395_connected:</span>
@@ -962,6 +976,10 @@ <h2 id="ch395_check_exist">ch395_check_exist</h2>
 <h2 id="ch395_clear_recv_buf_sn">ch395_clear_recv_buf_sn</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Clear receive buffer</p>
+<p><strong><em>Example</em></strong></p>
+<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="k">lda</span><span class="w"> </span><span class="p">#</span><span class="mh">$01</span><span class="w"> </span><span class="c1">; Socket ID</span>
+<span class="w"> </span><span class="k">jsr</span><span class="w"> </span><span class="n">ch395_clear_recv_buf_sn</span>
+</code></pre></div>
 <p><strong><em>Modify</em></strong></p>
 <ul>
 <li>Accumulator </li>
@@ -970,9 +988,13 @@ <h2 id="ch395_clear_recv_buf_sn">ch395_clear_recv_buf_sn</h2>
 <h2 id="ch395_close_socket_sn">ch395_close_socket_sn</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Close socket</p>
+<p><strong><em>Example</em></strong></p>
+<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="k">lda</span><span class="w"> </span><span class="p">#</span><span class="mh">$01</span><span class="w"> </span><span class="c1">; Socket ID</span>
+<span class="w"> </span><span class="k">jsr</span><span class="w"> </span><span class="n">ch395_close_socket_sn</span>
+</code></pre></div>
 <p><strong><em>Input</em></strong></p>
 <ul>
-<li>Accumulator : The id of the socket</li>
+<li>Accumulator : The id of the socket to close</li>
 </ul>
 <p><strong><em>Modify</em></strong></p>
 <ul>
@@ -992,11 +1014,23 @@ <h2 id="ch395_dhcp_enable">ch395_dhcp_enable</h2>
 <h2 id="ch395_get_cmd_status">ch395_get_cmd_status</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Get cmd status</p>
+<p><strong><em>Example</em></strong></p>
+<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="k">jsr</span><span class="w"> </span><span class="n">ch395_get_cmd_status</span>
+<span class="w"> </span><span class="c1">; Check A for STATUS</span>
+<span class="w"> </span><span class="k">rts</span>
+</code></pre></div>
 <p><strong><em>Modify</em></strong></p>
 <ul>
 <li>Accumulator </li>
 </ul>
 <h2 id="ch395_get_dhcp_status">ch395_get_dhcp_status</h2>
+<p><strong><em>Description</em></strong></p>
+<p>Get dhcp status</p>
+<p><strong><em>Example</em></strong></p>
+<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="k">jsr</span><span class="w"> </span><span class="n">ch395_get_dhcp_status</span>
+<span class="w"> </span><span class="c1">; Check A for dhcp status</span>
+<span class="w"> </span><span class="k">rts</span>
+</code></pre></div>
 <p><strong><em>Modify</em></strong></p>
 <ul>
 <li>Accumulator </li>
@@ -1015,15 +1049,39 @@ <h2 id="ch395_get_glob_int_status">ch395_get_glob_int_status</h2>
 <h2 id="ch395_get_ic_ver">ch395_get_ic_ver</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Get ch395 firmware version</p>
+<p><strong><em>Example</em></strong></p>
+<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="k">jsr</span><span class="w"> </span><span class="n">ch395_get_ic_ver</span>
+<span class="w"> </span><span class="c1">; Check A for version</span>
+<span class="w"> </span><span class="k">rts</span>
+</code></pre></div>
 <p><strong><em>Modify</em></strong></p>
 <ul>
 <li>Accumulator </li>
 </ul>
 <h2 id="ch395_get_int_status_sn">ch395_get_int_status_sn</h2>
+<p><strong><em>Description</em></strong></p>
+<p>Check interrupt socket status</p>
+<p><strong><em>Example</em></strong></p>
+<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="k">lda</span><span class="w"> </span><span class="p">#</span><span class="n">CH395_SOCKET1</span><span class="w"> </span><span class="c1">; Check socket 1</span>
+<span class="w"> </span><span class="k">jsr</span><span class="w"> </span><span class="n">ch395_get_int_status_sn</span>
+<span class="w"> </span><span class="c1">; Check interrupt type</span>
+<span class="w"> </span><span class="k">rts</span>
+</code></pre></div>
+<p><strong><em>Modify</em></strong></p>
+<ul>
+<li>Accumulator </li>
+<li>X Register </li>
+</ul>
+<p><strong><em>Returns</em></strong></p>
+<ul>
+<li>Accumulator : Status of selected socket</li>
+</ul>
+<h2 id="ch395_get_ip_inf">ch395_get_ip_inf</h2>
 <p><strong><em>Modify</em></strong></p>
 <ul>
 <li>Accumulator </li>
 <li>X Register </li>
+<li>Y Register </li>
 </ul>
 <h2 id="ch395_get_mac_adress">ch395_get_mac_adress</h2>
 <p><strong><em>Modify</em></strong></p>
@@ -1076,11 +1134,23 @@ <h2 id="ch395_get_socket_status_sn">ch395_get_socket_status_sn</h2>
 <li>Accumulator </li>
 </ul>
 <h2 id="ch395_init">ch395_init</h2>
+<p><strong><em>Description</em></strong></p>
+<p>Initialize ch395</p>
 <p><strong><em>Modify</em></strong></p>
 <ul>
 <li>Accumulator </li>
 </ul>
 <h2 id="ch395_open_socket_sn">ch395_open_socket_sn</h2>
+<p><strong><em>Description</em></strong></p>
+<p>Open socket from arg</p>
+<p><strong><em>Input</em></strong></p>
+<ul>
+<li>Accumulator : Socket id</li>
+</ul>
+<p><strong><em>Modify</em></strong></p>
+<ul>
+<li>Y Register </li>
+</ul>
 <h2 id="ch395_read_recv_buf_sn">ch395_read_recv_buf_sn</h2>
 <h2 id="ch395_reset_all">ch395_reset_all</h2>
 <p><strong><em>Description</em></strong></p>
@@ -1096,7 +1166,17 @@ <h2 id="ch395_retran_period">ch395_retran_period</h2>
 <div class="highlight"><pre><span></span><code><span class="w"> </span><span class="k">lda</span><span class="w"> </span><span class="p">#</span><span class="mh">$FF</span>
 <span class="w"> </span><span class="k">ldx</span><span class="w"> </span><span class="p">#</span><span class="mh">$FF</span>
 <span class="w"> </span><span class="k">jsr</span><span class="w"> </span><span class="n">ch395_retran_period</span>
+<span class="w"> </span><span class="k">rts</span>
 </code></pre></div>
+<p><strong><em>Input</em></strong></p>
+<ul>
+<li>Accumulator : Period </li>
+<li>X Register : Period </li>
+</ul>
+<p><strong><em>Modify</em></strong></p>
+<ul>
+<li>Y Register </li>
+</ul>
 <h2 id="ch395_set_des_port_sn">ch395_set_des_port_sn</h2>
 <h2 id="ch395_set_fun_para">ch395_set_fun_para</h2>
 <p><strong><em>Input</em></strong></p>
@@ -1134,7 +1214,7 @@ <h2 id="ch395_write_send_buf_sn">ch395_write_send_buf_sn</h2></div>
   <small>
 
       Last update:
-      2024-02-03
+      2024-02-04
 
   </small>
 </div>

diff --git a/docs/api/2024.1/c/index.html b/docs/api/2024.1/c/index.html
@@ -430,13 +430,27 @@
     oid ch395_close_socket_sn(unsigned char ID_SOCKET)
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#unsigned-char-ch395_get_dhcp_status" class="md-nav__link">
+    unsigned char ch395_get_dhcp_status();
+  </a>
+
 </li>
 
         <li class="md-nav__item">
   <a href="#unsigned-int-ch395_get_glob_int_status" class="md-nav__link">
     unsigned int ch395_get_glob_int_status();
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#unsigned-char-ch395_get_ic_ver" class="md-nav__link">
+    unsigned char ch395_get_ic_ver();
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -458,13 +472,27 @@
     unsigned int ch395_get_socket_status_sn(unsigned char ID_SOCKET);
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#void-ch395_init" class="md-nav__link">
+    void ch395_init();
+  </a>
+
 </li>
 
         <li class="md-nav__item">
   <a href="#void-ch395_open_socket_snunsigned-char-id_socket" class="md-nav__link">
     void ch395_open_socket_sn(unsigned char ID_SOCKET)
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#void-ch395_read_recv_buf_snunsigned-char-buffer-unsigned-int-lengthunsigned-char-id_socket" class="md-nav__link">
+    void ch395_read_recv_buf_sn(unsigned char *buffer, unsigned int length,unsigned char ID_SOCKET);
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -571,13 +599,27 @@
     oid ch395_close_socket_sn(unsigned char ID_SOCKET)
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#unsigned-char-ch395_get_dhcp_status" class="md-nav__link">
+    unsigned char ch395_get_dhcp_status();
+  </a>
+
 </li>
 
         <li class="md-nav__item">
   <a href="#unsigned-int-ch395_get_glob_int_status" class="md-nav__link">
     unsigned int ch395_get_glob_int_status();
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#unsigned-char-ch395_get_ic_ver" class="md-nav__link">
+    unsigned char ch395_get_ic_ver();
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -599,13 +641,27 @@
     unsigned int ch395_get_socket_status_sn(unsigned char ID_SOCKET);
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#void-ch395_init" class="md-nav__link">
+    void ch395_init();
+  </a>
+
 </li>
 
         <li class="md-nav__item">
   <a href="#void-ch395_open_socket_snunsigned-char-id_socket" class="md-nav__link">
     void ch395_open_socket_sn(unsigned char ID_SOCKET)
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#void-ch395_read_recv_buf_snunsigned-char-buffer-unsigned-int-lengthunsigned-char-id_socket" class="md-nav__link">
+    void ch395_read_recv_buf_sn(unsigned char *buffer, unsigned int length,unsigned char ID_SOCKET);
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -666,17 +722,27 @@ <h2 id="void-ch395_clear_recv_buf_snunsigned-char-id_socket">void ch395_clear_re
 <h2 id="oid-ch395_close_socket_snunsigned-char-id_socket">oid ch395_close_socket_sn(unsigned char ID_SOCKET)</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Close socket</p>
+<h2 id="unsigned-char-ch395_get_dhcp_status">unsigned char ch395_get_dhcp_status();</h2>
+<p><strong><em>Description</em></strong></p>
+<p>Get dhcp status</p>
 <h2 id="unsigned-int-ch395_get_glob_int_status">unsigned int ch395_get_glob_int_status();</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Get General interrupt Status</p>
+<h2 id="unsigned-char-ch395_get_ic_ver">unsigned char ch395_get_ic_ver();</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Get ch395 firmware version</p>
 <h2 id="unsigned-char-ch395_get_int_status_snunsigned-char-id_socket">unsigned char ch395_get_int_status_sn(unsigned char ID_SOCKET);</h2>
+<p><strong><em>Description</em></strong></p>
+<p>Check interrupt socket status</p>
 <h2 id="void-ch395_get_recv_len_snunsigned-char-id_socket">void ch395_get_recv_len_sn(unsigned char ID_SOCKET)</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Get the length received from socket</p>
 <h2 id="unsigned-int-ch395_get_socket_status_snunsigned-char-id_socket">unsigned int ch395_get_socket_status_sn(unsigned char ID_SOCKET);</h2>
+<h2 id="void-ch395_init">void ch395_init();</h2>
+<p><strong><em>Description</em></strong></p>
+<p>Initialize ch395</p>
 <h2 id="void-ch395_open_socket_snunsigned-char-id_socket">void ch395_open_socket_sn(unsigned char ID_SOCKET)</h2>
+<h2 id="void-ch395_read_recv_buf_snunsigned-char-buffer-unsigned-int-lengthunsigned-char-id_socket">void ch395_read_recv_buf_sn(unsigned char *buffer, unsigned int length,unsigned char ID_SOCKET);</h2>
 <h2 id="void-ch395_reset_all">void ch395_reset_all()</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Reset ch395</p>
@@ -694,7 +760,7 @@ <h2 id="_1"></h2></div>
   <small>
 
       Last update:
-      2024-02-03
+      2024-02-04
 
   </small>
 </div>