update

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

Hide file tree

Showing 16 changed files with 300 additions and 36 deletions.
diff --git a/docs/api/2024.1/assembly/index.html b/docs/api/2024.1/assembly/index.html
@@ -944,6 +944,13 @@
 <h2 id="ch395_check_exist">ch395_check_exist</h2>
 <p><strong><em>Description</em></strong></p>
 <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">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>
+</code></pre></div>
 <p><strong><em>Modify</em></strong></p>
 <ul>
 <li>Accumulator </li>
@@ -995,10 +1002,16 @@ <h2 id="ch395_get_dhcp_status">ch395_get_dhcp_status</h2>
 <li>Accumulator </li>
 </ul>
 <h2 id="ch395_get_glob_int_status">ch395_get_glob_int_status</h2>
+<p><strong><em>Description</em></strong></p>
+<p>Get General interrupt Status</p>
 <p><strong><em>Modify</em></strong></p>
 <ul>
 <li>Accumulator </li>
 </ul>
+<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="c1">; check accumulator to get interrupts states</span>
+</code></pre></div>
 <h2 id="ch395_get_ic_ver">ch395_get_ic_ver</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Get ch395 firmware version</p>
@@ -1020,12 +1033,33 @@ <h2 id="ch395_get_mac_adress">ch395_get_mac_adress</h2>
 <li>Y Register </li>
 </ul>
 <h2 id="ch395_get_phy_status">ch395_get_phy_status</h2>
+<p><strong><em>Modify</em></strong></p>
+<ul>
+<li>Accumulator </li>
+</ul>
 <h2 id="ch395_get_recv_len_sn">ch395_get_recv_len_sn</h2>
+<p><strong><em>Description</em></strong></p>
+<p>Get the length received from 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 1</span>
+<span class="w"> </span><span class="k">jsr</span><span class="w"> </span><span class="n">ch395_get_recv_len_sn</span>
+<span class="w"> </span><span class="c1">; check A and X for length received</span>
+<span class="nl">ch395_connected:</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>
+<p>Accumulator : The length</p>
+</li>
+<li>
+<p>X Register : The length</p>
+</li>
+</ul>
 <h2 id="ch395_get_remot_ipp_sn">ch395_get_remot_ipp_sn</h2>
 <p><strong><em>Modify</em></strong></p>
 <ul>
@@ -1079,6 +1113,8 @@ <h2 id="ch395_set_ip_addr">ch395_set_ip_addr</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Set ip addr</p>
 <h2 id="ch395_set_ip_addr_sn">ch395_set_ip_addr_sn</h2>
+<p><strong><em>Description</em></strong></p>
+<p>Set Socket Ip address to connect with</p>
 <h2 id="ch395_set_ipraw_pro_sn">ch395_set_ipraw_pro_sn</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Set ipraw protocol on socket</p>

diff --git a/docs/api/2024.1/c/index.html b/docs/api/2024.1/c/index.html
@@ -430,6 +430,13 @@
     oid ch395_close_socket_sn(unsigned char ID_SOCKET)
   </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">
@@ -475,8 +482,8 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#void-ch395_set_ip_addr_snunsigned-char-ip_addrunsigned-char-id_socket" class="md-nav__link">
-    void ch395_set_ip_addr_sn(unsigned char ip_addr[],unsigned char ID_SOCKET)
+  <a href="#void-ch395_set_ip_addr_snunsigned-char-ip_addr-unsigned-char-id_socket" class="md-nav__link">
+    void ch395_set_ip_addr_sn(unsigned char ip_addr[], unsigned char ID_SOCKET)
   </a>
 
 </li>
@@ -564,6 +571,13 @@
     oid ch395_close_socket_sn(unsigned char ID_SOCKET)
   </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">
@@ -609,8 +623,8 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#void-ch395_set_ip_addr_snunsigned-char-ip_addrunsigned-char-id_socket" class="md-nav__link">
-    void ch395_set_ip_addr_sn(unsigned char ip_addr[],unsigned char ID_SOCKET)
+  <a href="#void-ch395_set_ip_addr_snunsigned-char-ip_addr-unsigned-char-id_socket" class="md-nav__link">
+    void ch395_set_ip_addr_sn(unsigned char ip_addr[], unsigned char ID_SOCKET)
   </a>
 
 </li>
@@ -652,10 +666,15 @@ <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-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>
 <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>
 <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_open_socket_snunsigned-char-id_socket">void ch395_open_socket_sn(unsigned char ID_SOCKET)</h2>
 <h2 id="void-ch395_reset_all">void ch395_reset_all()</h2>
@@ -664,7 +683,7 @@ <h2 id="void-ch395_reset_all">void ch395_reset_all()</h2>
 <h2 id="void-ch395_set_fun_paraunsigned-char-flag">void ch395_set_fun_para(unsigned char flag)</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Set ip addr</p>
-<h2 id="void-ch395_set_ip_addr_snunsigned-char-ip_addrunsigned-char-id_socket">void ch395_set_ip_addr_sn(unsigned char ip_addr[],unsigned char ID_SOCKET)</h2>
+<h2 id="void-ch395_set_ip_addr_snunsigned-char-ip_addr-unsigned-char-id_socket">void ch395_set_ip_addr_sn(unsigned char ip_addr[], unsigned char ID_SOCKET)</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Set ipraw protocol on socket</p>
 <h2 id="void-ch395_set_proto_type_snunsigned-char-protounsigned-char-id_socket">void ch395_set_proto_type_sn(unsigned char proto,unsigned char ID_SOCKET)</h2>

diff --git a/docs/api/assembly/index.html b/docs/api/assembly/index.html
@@ -661,6 +661,13 @@
 <h2 id="ch395_check_exist">ch395_check_exist</h2>
 <p><strong><em>Description</em></strong></p>
 <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">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>
+</code></pre></div>
 <p><strong><em>Modify</em></strong></p>
 <ul>
 <li>Accumulator </li>
@@ -712,10 +719,16 @@ <h2 id="ch395_get_dhcp_status">ch395_get_dhcp_status</h2>
 <li>Accumulator </li>
 </ul>
 <h2 id="ch395_get_glob_int_status">ch395_get_glob_int_status</h2>
+<p><strong><em>Description</em></strong></p>
+<p>Get General interrupt Status</p>
 <p><strong><em>Modify</em></strong></p>
 <ul>
 <li>Accumulator </li>
 </ul>
+<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="c1">; check accumulator to get interrupts states</span>
+</code></pre></div>
 <h2 id="ch395_get_ic_ver">ch395_get_ic_ver</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Get ch395 firmware version</p>
@@ -737,12 +750,33 @@ <h2 id="ch395_get_mac_adress">ch395_get_mac_adress</h2>
 <li>Y Register </li>
 </ul>
 <h2 id="ch395_get_phy_status">ch395_get_phy_status</h2>
+<p><strong><em>Modify</em></strong></p>
+<ul>
+<li>Accumulator </li>
+</ul>
 <h2 id="ch395_get_recv_len_sn">ch395_get_recv_len_sn</h2>
+<p><strong><em>Description</em></strong></p>
+<p>Get the length received from 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 1</span>
+<span class="w"> </span><span class="k">jsr</span><span class="w"> </span><span class="n">ch395_get_recv_len_sn</span>
+<span class="w"> </span><span class="c1">; check A and X for length received</span>
+<span class="nl">ch395_connected:</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>
+<p>Accumulator : The length</p>
+</li>
+<li>
+<p>X Register : The length</p>
+</li>
+</ul>
 <h2 id="ch395_get_remot_ipp_sn">ch395_get_remot_ipp_sn</h2>
 <p><strong><em>Modify</em></strong></p>
 <ul>
@@ -796,6 +830,8 @@ <h2 id="ch395_set_ip_addr">ch395_set_ip_addr</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Set ip addr</p>
 <h2 id="ch395_set_ip_addr_sn">ch395_set_ip_addr_sn</h2>
+<p><strong><em>Description</em></strong></p>
+<p>Set Socket Ip address to connect with</p>
 <h2 id="ch395_set_ipraw_pro_sn">ch395_set_ipraw_pro_sn</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Set ipraw protocol on socket</p>

diff --git a/docs/api/c/index.html b/docs/api/c/index.html
@@ -430,6 +430,13 @@
     oid ch395_close_socket_sn(unsigned char ID_SOCKET)
   </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">
@@ -475,8 +482,8 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#void-ch395_set_ip_addr_snunsigned-char-ip_addrunsigned-char-id_socket" class="md-nav__link">
-    void ch395_set_ip_addr_sn(unsigned char ip_addr[],unsigned char ID_SOCKET)
+  <a href="#void-ch395_set_ip_addr_snunsigned-char-ip_addr-unsigned-char-id_socket" class="md-nav__link">
+    void ch395_set_ip_addr_sn(unsigned char ip_addr[], unsigned char ID_SOCKET)
   </a>
 
 </li>
@@ -518,10 +525,15 @@ <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-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>
 <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>
 <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_open_socket_snunsigned-char-id_socket">void ch395_open_socket_sn(unsigned char ID_SOCKET)</h2>
 <h2 id="void-ch395_reset_all">void ch395_reset_all()</h2>
@@ -530,7 +542,7 @@ <h2 id="void-ch395_reset_all">void ch395_reset_all()</h2>
 <h2 id="void-ch395_set_fun_paraunsigned-char-flag">void ch395_set_fun_para(unsigned char flag)</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Set ip addr</p>
-<h2 id="void-ch395_set_ip_addr_snunsigned-char-ip_addrunsigned-char-id_socket">void ch395_set_ip_addr_sn(unsigned char ip_addr[],unsigned char ID_SOCKET)</h2>
+<h2 id="void-ch395_set_ip_addr_snunsigned-char-ip_addr-unsigned-char-id_socket">void ch395_set_ip_addr_sn(unsigned char ip_addr[], unsigned char ID_SOCKET)</h2>
 <p><strong><em>Description</em></strong></p>
 <p>Set ipraw protocol on socket</p>
 <h2 id="void-ch395_set_proto_type_snunsigned-char-protounsigned-char-id_socket">void ch395_set_proto_type_sn(unsigned char proto,unsigned char ID_SOCKET)</h2>