Newer
Older
ubixos-old / doc / doxygen / html / ne2k_8h-source.html
@CloudNine CloudNine on 28 Apr 2004 14 KB doxygen documentation added
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Ubixos: ne2k.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.3 -->
<h1>ne2k.h</h1><div class="fragment"><pre>00001 <span class="comment">/**************************************************************************************</span>
00002 <span class="comment"> Copyright (c) 2002 The UbixOS Project</span>
00003 <span class="comment"> All rights reserved.</span>
00004 <span class="comment"></span>
00005 <span class="comment">Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</span>
00006 <span class="comment"></span>
00007 <span class="comment">Redistributions of source code must retain the above copyright notice, this list of conditions, the following disclaimer and the list of authors.</span>
00008 <span class="comment">Redistributions in binary form must reproduce the above copyright notice, this list of conditions, the following disclaimer and the list of authors</span>
00009 <span class="comment">in the documentation and/or other materials provided with the distribution. Neither the name of the UbixOS Project nor the names of its</span>
00010 <span class="comment">contributors may be used to endorse or promote products derived from this software without specific prior written permission.</span>
00011 <span class="comment"></span>
00012 <span class="comment">THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED</span>
00013 <span class="comment">WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR</span>
00014 <span class="comment">PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,</span>
00015 <span class="comment">INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE</span>
00016 <span class="comment">GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY</span>
00017 <span class="comment">OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY</span>
00018 <span class="comment">OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
00019 <span class="comment"></span>
00020 <span class="comment"> $Id$</span>
00021 <span class="comment"></span>
00022 <span class="comment">**************************************************************************************/</span>
00023 
00024 <span class="preprocessor">#ifndef _NE2K_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define _NE2K_H</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#include &lt;ubixos/types.h&gt;</span>
00028 <span class="preprocessor">#include &lt;sys/device.old.h&gt;</span>
00029 
00030 <span class="preprocessor">#define ether_addr  ether_addr_t</span>
00031 <span class="preprocessor"></span><span class="keyword">typedef</span> <span class="keyword">struct </span>dp_rcvhdr
00032 {
00033         uInt8 dr_status;                 <span class="comment">/* Copy of rsr                       */</span>
00034         uInt8 dr_next;                   <span class="comment">/* Pointer to next packet            */</span>
00035         uInt8 dr_rbcl;                   <span class="comment">/* Receive Byte Count Low            */</span>
00036         uInt8 dr_rbch;                   <span class="comment">/* Receive Byte Count High           */</span>
00037 } dp_rcvhdr_t;
00038 
00039 <span class="keyword">typedef</span> <span class="keyword">union </span>etheraddr {
00040     <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> bytes[6];             <span class="comment">/* byteorder safe initialization */</span>
00041     <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> shorts[3];           <span class="comment">/* force 2-byte alignment */</span>
00042 } ether_addr;
00043 
00044 
00045 <span class="keyword">struct </span>nicBuffer {
00046   <span class="keyword">struct </span>nicBuffer *next;
00047   <span class="keywordtype">int</span>               length;
00048   <span class="keywordtype">char</span>             *buffer;
00049   };
00050 
00051 <span class="preprocessor">#define RSR_FO         0x08</span>
00052 <span class="preprocessor"></span><span class="preprocessor">#define RSR_PRX                0x01</span>
00053 <span class="preprocessor"></span><span class="preprocessor">#define DEF_ENABLED    0x200</span>
00054 <span class="preprocessor"></span>
00055 <span class="preprocessor">#define OK      0</span>
00056 <span class="preprocessor"></span>
00057 
00058 <span class="preprocessor">#define startPage 0x4C</span>
00059 <span class="preprocessor"></span><span class="preprocessor">#define stopPage  0x80</span>
00060 <span class="preprocessor"></span>
00061 
00062 <span class="preprocessor">#define NE_CMD       0x00</span>
00063 <span class="preprocessor"></span><span class="preprocessor">#define NE_PSTART    0x01</span>
00064 <span class="preprocessor"></span><span class="preprocessor">#define NE_PSTOP     0x02</span>
00065 <span class="preprocessor"></span><span class="preprocessor">#define NE_BNRY      0x03</span>
00066 <span class="preprocessor"></span><span class="preprocessor">#define NE_TPSR      0x04</span>
00067 <span class="preprocessor"></span><span class="preprocessor">#define NE_ISR       0x07</span>
00068 <span class="preprocessor"></span><span class="preprocessor">#define NE_CURRENT   0x07</span>
00069 <span class="preprocessor"></span><span class="preprocessor">#define NE_RBCR0     0x0A</span>
00070 <span class="preprocessor"></span><span class="preprocessor">#define NE_RBCR1     0x0B</span>
00071 <span class="preprocessor"></span><span class="preprocessor">#define NE_RCR       0x0C</span>
00072 <span class="preprocessor"></span><span class="preprocessor">#define NE_TCR       0x0D</span>
00073 <span class="preprocessor"></span><span class="preprocessor">#define NE_DCR       0x0E</span>
00074 <span class="preprocessor"></span><span class="preprocessor">#define NE_IMR       0x0F</span>
00075 <span class="preprocessor"></span>
00076 
00077 <span class="preprocessor">#define NE_DCR_WTS   0x01</span>
00078 <span class="preprocessor"></span><span class="preprocessor">#define NE_DCR_LS    0x08</span>
00079 <span class="preprocessor"></span><span class="preprocessor">#define NE_DCR_AR    0x10</span>
00080 <span class="preprocessor"></span><span class="preprocessor">#define NE_DCR_FT1   0x40</span>
00081 <span class="preprocessor"></span><span class="preprocessor">#define NE_DCR_FT0   0x20</span>
00082 <span class="preprocessor"></span>
00083 
00084 
00085 <span class="preprocessor">#define E8390_STOP   0x01</span>
00086 <span class="preprocessor"></span><span class="preprocessor">#define E8390_NODMA  0x20</span>
00087 <span class="preprocessor"></span><span class="preprocessor">#define E8390_PAGE0  0x00</span>
00088 <span class="preprocessor"></span><span class="preprocessor">#define E8390_PAGE1  0x40</span>
00089 <span class="preprocessor"></span><span class="preprocessor">#define E8390_CMD    0x00</span>
00090 <span class="preprocessor"></span><span class="preprocessor">#define E8390_START  0x02</span>
00091 <span class="preprocessor"></span><span class="preprocessor">#define E8390_RREAD  0x08</span>
00092 <span class="preprocessor"></span><span class="preprocessor">#define E8390_RWRITE 0x10</span>
00093 <span class="preprocessor"></span><span class="preprocessor">#define E8390_RXOFF  0x20</span>
00094 <span class="preprocessor"></span><span class="preprocessor">#define E8390_TXOFF  0x00</span>
00095 <span class="preprocessor"></span><span class="preprocessor">#define E8390_RXCONFIG 0x04</span>
00096 <span class="preprocessor"></span><span class="preprocessor">#define E8390_TXCONFIG 0x00</span>
00097 <span class="preprocessor"></span>
00098 <span class="preprocessor">#define EN0_COUNTER0 0x0d</span>
00099 <span class="preprocessor"></span><span class="preprocessor">#define EN0_DCFG     0x0e</span>
00100 <span class="preprocessor"></span><span class="preprocessor">#define EN0_RCNTLO   0x0a</span>
00101 <span class="preprocessor"></span><span class="preprocessor">#define EN0_RCNTHI   0x0b</span>
00102 <span class="preprocessor"></span><span class="preprocessor">#define EN0_ISR      0x07</span>
00103 <span class="preprocessor"></span><span class="preprocessor">#define EN0_IMR      0x0f</span>
00104 <span class="preprocessor"></span><span class="preprocessor">#define EN0_RSARLO   0x08</span>
00105 <span class="preprocessor"></span><span class="preprocessor">#define EN0_RSARHI   0x09</span>
00106 <span class="preprocessor"></span><span class="preprocessor">#define EN0_TPSR     0x04</span>
00107 <span class="preprocessor"></span><span class="preprocessor">#define EN0_RXCR     0x0c</span>
00108 <span class="preprocessor"></span><span class="preprocessor">#define EN0_TXCR     0x0D</span>
00109 <span class="preprocessor"></span><span class="preprocessor">#define EN0_STARTPG  0x01</span>
00110 <span class="preprocessor"></span><span class="preprocessor">#define EN0_STOPPG   0x02</span>
00111 <span class="preprocessor"></span><span class="preprocessor">#define EN0_BOUNDARY 0x03</span>
00112 <span class="preprocessor"></span>
00113 <span class="preprocessor">#define EN1_PHYS     0x01</span>
00114 <span class="preprocessor"></span><span class="preprocessor">#define EN1_CURPAG   0x07</span>
00115 <span class="preprocessor"></span><span class="preprocessor">#define EN1_MULT     0x08</span>
00116 <span class="preprocessor"></span>
00117 <span class="preprocessor">#define NE1SM_START_PG 0x20</span>
00118 <span class="preprocessor"></span><span class="preprocessor">#define NE1SM_STOP_PG 0x40</span>
00119 <span class="preprocessor"></span><span class="preprocessor">#define NESM_START_PG 0x40</span>
00120 <span class="preprocessor"></span><span class="preprocessor">#define NESM_STOP_PG  0x80</span>
00121 <span class="preprocessor"></span>
00122 <span class="preprocessor">#define ENISR_ALL    0x3f</span>
00123 <span class="preprocessor"></span>
00124 <span class="preprocessor">#define ENDCFG_WTS   0x01</span>
00125 <span class="preprocessor"></span>
00126 <span class="preprocessor">#define NE_DATAPORT  0x10</span>
00127 <span class="preprocessor"></span>
00128 <span class="preprocessor">#define TX_2X_PAGES 12</span>
00129 <span class="preprocessor"></span><span class="preprocessor">#define TX_1X_PAGES 6</span>
00130 <span class="preprocessor"></span><span class="preprocessor">#define TX_PAGES (dev-&gt;priv-&gt;pingPong ? TX_2X_PAGES : TX_1X_PAGES)</span>
00131 <span class="preprocessor"></span>
00132 
00133 <span class="preprocessor">#define DP_CURR         0x7     </span><span class="comment">/* Current Page Register             */</span>
00134 <span class="preprocessor">#define DP_MAR0         0x8     </span><span class="comment">/* Multicast Address Register 0      */</span>
00135 <span class="preprocessor">#define DP_MAR1         0x9     </span><span class="comment">/* Multicast Address Register 1      */</span>
00136 <span class="preprocessor">#define DP_MAR2         0xA     </span><span class="comment">/* Multicast Address Register 2      */</span>
00137 <span class="preprocessor">#define DP_MAR3         0xB     </span><span class="comment">/* Multicast Address Register 3      */</span>
00138 <span class="preprocessor">#define DP_MAR4         0xC     </span><span class="comment">/* Multicast Address Register 4      */</span>
00139 <span class="preprocessor">#define DP_MAR5         0xD     </span><span class="comment">/* Multicast Address Register 5      */</span>
00140 <span class="preprocessor">#define DP_MAR6         0xE     </span><span class="comment">/* Multicast Address Register 6      */</span>
00141 <span class="preprocessor">#define DP_MAR7         0xF     </span><span class="comment">/* Multicast Address Register 7      */</span>
00142 
00143 <span class="preprocessor">#define DP_CNTR0        0xD     </span><span class="comment">/* Tally Counter 0                   */</span>
00144 <span class="preprocessor">#define DP_CNTR1        0xE     </span><span class="comment">/* Tally Counter 1                   */</span>
00145 <span class="preprocessor">#define DP_CNTR2        0xF     </span><span class="comment">/* Tally Counter 2                   */</span>
00146 
00147 
00148 <span class="preprocessor">#define DP_PAGESIZE     256</span>
00149 <span class="preprocessor"></span>
00150 <span class="keyword">extern</span> <span class="keywordtype">char</span> *nicPacket;
00151 <span class="keyword">extern</span> uInt32 packetLength;
00152 
00153 
00154 <span class="keywordtype">int</span> ne2kInit(uInt32);
00155 <span class="keywordtype">int</span> ne2kProbe(<span class="keywordtype">int</span>,<span class="keyword">struct</span> device *);
00156 <span class="keywordtype">int</span> ne2kDevInit(<span class="keyword">struct</span> device *);
00157 <span class="keywordtype">void</span> NS8390_init(<span class="keyword">struct</span> device *dev,<span class="keywordtype">int</span> startp);
00158 
00159 <span class="keywordtype">void</span> ne2kISR();
00160 <span class="keywordtype">void</span> ne2kHandler();
00161 
00162 <span class="keywordtype">int</span> NICtoPC(<span class="keyword">struct</span> device *dev,<span class="keywordtype">void</span> *packet,<span class="keywordtype">int</span> length,<span class="keywordtype">int</span> nic_addr);
00163 <span class="keywordtype">int</span> PCtoNIC(<span class="keyword">struct</span> device *dev,<span class="keywordtype">void</span> *packet,<span class="keywordtype">int</span> length);
00164 
00165 <span class="keyword">struct </span>nicBuffer *ne2kAllocBuffer(<span class="keywordtype">int</span>);
00166 <span class="keyword">struct </span>nicBuffer *ne2kGetBuffer();
00167 <span class="keywordtype">void</span> ne2kFreeBuffer(<span class="keyword">struct</span> nicBuffer *);
00168 
00169 <span class="preprocessor">#endif</span>
00170 <span class="preprocessor"></span>
00171 <span class="comment">/***</span>
00172 <span class="comment"> END</span>
00173 <span class="comment"> ***/</span>
00174 
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Wed Apr 28 17:49:38 2004 for Ubixos by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 > 
</a>1.3.3 </small></address>
</body>
</html>