system_8h.html

Freescale mcu OpenTCP-1.0.4.doc.html.zip 文档

This is highly dependant on the architecture that is used and/or possible operating system beeing used so it will be moved to some other place in the future.
<p>
For now this only globally enables interrupts 
<p>
Definition at line <a class="el" href="system_8h-source.html#l00189">189</a> of file <a class="el" href="system_8h-source.html">system.h</a>.
<p>
Referenced by <a class="el" href="timers_8c-source.html#l00194">init_timer()</a>.    </td>
  </tr>
</table>
<a name="a9" doxytag="system.h::RECEIVE_NETWORK_B"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define RECEIVE_NETWORK_B</td>
          <td class="md" valign="top">(&nbsp;</td>
&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;inNE2000again()
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This macro should be used to read data from the Ethernet controller. Procedure for doing this would be as follows: <ul>
<li> Initialize reading of data from certain address in the Ethernet controller (usually you will do that based on buf_index value of <a class="el" href="structip__frame.html">ip_frame</a>, <a class="el" href="structudp__frame.html">udp_frame</a> or <a class="el" href="structtcp__frame.html">tcp_frame</a> type of variables;  in certain special situations you can also use buf_index from  <a class="el" href="structethernet__frame.html">ethernet_frame</a> type of var. <li> Keep invoking <a class="el" href="system_8h.html#a9">RECEIVE_NETWORK_B()</a> to read one byte at a time from the ethernet controller. Take care not to read more data than actually received <li> If needed, reinitialize reading of data again and start all over again <li> When finished discard the current frame in the Ethernet controller by invoking <a class="el" href="group__periodic__functions.html#a8">NETWORK_RECEIVE_END()</a> macro </ul>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcp__client__demo_8c-example.html#a3">tcp_client_demo.c</a>, <a class="el" href="tcp__server__demo_8c-example.html#a3">tcp_server_demo.c</a>, and <a class="el" href="udp__demo_8c-example.html#a3">udp_demo.c</a>.</dl>
<p>
Definition at line <a class="el" href="system_8h-source.html#l00210">210</a> of file <a class="el" href="system_8h-source.html">system.h</a>.
<p>
Referenced by <a class="el" href="arp_8c-source.html#l00307">arp_get_response()</a>, <a class="el" href="arp_8c-source.html#l00188">arp_send_response()</a>, <a class="el" href="bootp_8c-source.html#l00335">bootpc_eventlistener()</a>, <a class="el" href="dhcpc_8c-source.html#l00568">dhcpc_eventlistener()</a>, <a class="el" href="dhcpc_8c-source.html#l00549">dhcpc_read_n_bytes()</a>, <a class="el" href="dns_8c-source.html#l00205">dns_eventlistener()</a>, <a class="el" href="arp_8c-source.html#l00116">process_arp()</a>, <a class="el" href="icmp_8c-source.html#l00097">process_icmp_in()</a>, <a class="el" href="ip_8c-source.html#l00115">process_ip_in()</a>, <a class="el" href="tcp_8c-source.html#l01250">process_tcp_in()</a>, <a class="el" href="udp_8c-source.html#l00550">process_udp_in()</a>, and <a class="el" href="tcp_8c-source.html#l02567">tcp_check_cs()</a>.    </td>
  </tr>
</table>
<a name="a10" doxytag="system.h::RECEIVE_NETWORK_BUF"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define RECEIVE_NETWORK_BUF</td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">c,         <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>d&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;inNE2000againbuf(c,d)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This macro should be used to read data from the Ethernet controller to a buffer in memory. Procedure for using this macro is the same as for using <a class="el" href="system_8h.html#a9">RECEIVE_NETWORK_B()</a> macro. 
<p>
Definition at line <a class="el" href="system_8h-source.html#l00220">220</a> of file <a class="el" href="system_8h-source.html">system.h</a>.
<p>
Referenced by <a class="el" href="icmp_8c-source.html#l00097">process_icmp_in()</a>, and <a class="el" href="tcp_8c-source.html#l02567">tcp_check_cs()</a>.    </td>
  </tr>
</table>
<a name="a11" doxytag="system.h::SEND_NETWORK_B"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define SEND_NETWORK_B</td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">c&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;outNE2000again(c)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This macro should be used to write data to Ethernet controller. Procedure for doing this would be as follows: <ul>
<li> Initialize writing of data to certain address in the Ethernet controller. Buffer space in Ethernet controller is divided among the protocols in the following way: <li> 256 byte Tx for ARP (see ARP_BUFFER ) <li> 1536 byte Tx for ICMP (see ICMP_BUF) <li> 1536 byte Tx for TCP (see TCP_BUF) <li> 1536 byte Tx for UDP (see UDP_BUF) <li> Write the data by using <a class="el" href="system_8h.html#a11">SEND_NETWORK_B()</a> macro <li> When all of the data is written instruct the Ethernet controller to send the data by calling the <a class="el" href="system_8h.html#a16">NETWORK_COMPLETE_SEND()</a> macro with number of bytes to send as a parameter </ul>

<p>
Definition at line <a class="el" href="system_8h-source.html#l00240">240</a> of file <a class="el" href="system_8h-source.html">system.h</a>.
<p>
Referenced by <a class="el" href="arp_8c-source.html#l00390">arp_send_req()</a>, <a class="el" href="arp_8c-source.html#l00188">arp_send_response()</a>, and <a class="el" href="ip_8c-source.html#l00300">process_ip_out()</a>.    </td>
  </tr>
</table>
<a name="a12" doxytag="system.h::SEND_NETWORK_BUF"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define SEND_NETWORK_BUF</td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">c,         <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>d&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;outNE2000againbuf(c,d)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This macro should be used to write data from a buffer to Ethernet controller. Usage is the same as for the <a class="el" href="system_8h.html#a11">SEND_NETWORK_B()</a> macro. 
<p>
Definition at line <a class="el" href="system_8h-source.html#l00248">248</a> of file <a class="el" href="system_8h-source.html">system.h</a>.
<p>
Referenced by <a class="el" href="ip_8c-source.html#l00300">process_ip_out()</a>.    </td>
  </tr>
</table>
<a name="a14" doxytag="system.h::NETWORK_RECEIVE_INITIALIZE"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define NETWORK_RECEIVE_INITIALIZE</td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">c&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;NE2000DMAInit_position(c)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This macro initializes reading of the received Ethernet frame from a given address in the Ethernet controller. 
<p>
Definition at line <a class="el" href="system_8h-source.html#l00270">270</a> of file <a class="el" href="system_8h-source.html">system.h</a>.
<p>
Referenced by <a class="el" href="bootp_8c-source.html#l00335">bootpc_eventlistener()</a>, <a class="el" href="arp_8c-source.html#l00116">process_arp()</a>, <a class="el" href="icmp_8c-source.html#l00097">process_icmp_in()</a>, <a class="el" href="ip_8c-source.html#l00115">process_ip_in()</a>, <a class="el" href="tcp_8c-source.html#l01250">process_tcp_in()</a>, and <a class="el" href="udp_8c-source.html#l00550">process_udp_in()</a>.    </td>
  </tr>
</table>
<a name="a16" doxytag="system.h::NETWORK_COMPLETE_SEND"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define NETWORK_COMPLETE_SEND</td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">c&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;NE2000SendFrame(c)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
After the data has been written to the Ethernet controller, use this function to instruct the Ethernet controller that data is in it's  internal buffer and should be sent. 
<p>
Definition at line <a class="el" href="system_8h-source.html#l00288">288</a> of file <a class="el" href="system_8h-source.html">system.h</a>.
<p>
Referenced by <a class="el" href="arp_8c-source.html#l00390">arp_send_req()</a>, <a class="el" href="arp_8c-source.html#l00188">arp_send_response()</a>, and <a class="el" href="ip_8c-source.html#l00300">process_ip_out()</a>.    </td>
  </tr>
</table>
<a name="a17" doxytag="system.h::NETWORK_SEND_INITIALIZE"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define NETWORK_SEND_INITIALIZE</td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">c&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;InitTransmission(c)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Use this function to initialize sending (or creating) of an Ethernet packet from a given address in the Ethernet controller. 
<p>
Definition at line <a class="el" href="system_8h-source.html#l00296">296</a> of file <a class="el" href="system_8h-source.html">system.h</a>.
<p>
Referenced by <a class="el" href="arp_8c-source.html#l00390">arp_send_req()</a>, <a class="el" href="arp_8c-source.html#l00188">arp_send_response()</a>, and <a class="el" href="ip_8c-source.html#l00300">process_ip_out()</a>.    </td>
  </tr>
</table>
<a name="a18" doxytag="system.h::NETWORK_ADD_DATALINK"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define NETWORK_ADD_DATALINK</td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">c&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;NE2000WriteEthernetHeader(c)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This implementation adds Ethernet data-link information by invoking <a class="el" href="ethernet_8c.html#a17">NE2000WriteEthernetHeader()</a> function that writes Ethernet header based on information provided (destination and source ethernet address and protocol field). 
<p>
Definition at line <a class="el" href="system_8h-source.html#l00306">306</a> of file <a class="el" href="system_8h-source.html">system.h</a>.
<p>
Referenced by <a class="el" href="arp_8c-source.html#l00390">arp_send_req()</a>, <a class="el" href="arp_8c-source.html#l00188">arp_send_response()</a>, and <a class="el" href="ip_8c-source.html#l00300">process_ip_out()</a>.    </td>
  </tr>
</table>
<hr><address style="align: right;"><small>Generated on Sun Aug 3 20:33:00 2003 for OpenTCP by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>