workbench/devs/networks/e1000/e1000.h

   1 #ifndef _E1000_H_
   2 #define _E1000_H_
   3 /*
   4  * $Id$
   5  */
   6 /*
   7     This program is free software; you can redistribute it and/or modify
   8     it under the terms of the GNU General Public License as published by
   9     the Free Software Foundation; either version 2 of the License, or
  10     (at your option) any later version.
  11
  12     This program is distributed in the hope that it will be useful, but
  13     WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15     General Public License for more details.
  16
  17     You should have received a copy of the GNU General Public License
  18     along with this program; if not, write to the Free Software
  19     Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20     MA 02111-1307, USA.
  21 */
  22
  23 #include <aros/debug.h>
  24
  25 #include <aros/io.h>
  26
  27 #include <exec/types.h>
  28 #include <exec/libraries.h>
  29 #include <exec/semaphores.h>
  30 #include <exec/devices.h>
  31 #include <exec/interrupts.h>
  32 #include <dos/bptr.h>
  33
  34 #include <devices/timer.h>
  35 #include <devices/sana2.h>
  36 #include <devices/sana2specialstats.h>
  37
  38 #include <proto/exec.h>
  39 #include <proto/oop.h>
  40
  41 #include <oop/oop.h>
  42
  43 #include <hidd/pci.h>
  44
  45 #include LC_LIBDEFS_FILE
  46
  47 typedef BOOL bool;
  48 typedef UBYTE u8;
  49 typedef UWORD u16;
  50 typedef ULONG u32;
  51 typedef LONG s32;
  52 typedef UQUAD u64;
  53
  54 typedef UQUAD __le64;
  55 typedef ULONG __le32;
  56 typedef UWORD __le16;
  57
  58 #define false FALSE
  59 #define true TRUE
  60
  61 #define __iomem volatile
  62
  63 #define e1000_TASK_NAME "%s.task"
  64 #define e1000_PORT_NAME "%s.port"
  65
  66 struct e1000Base
  67 {
  68     struct Device            e1kb_Device;
  69
  70     OOP_Object               *e1kb_PCI;
  71     OOP_AttrBase             e1kb_PCIDeviceAttrBase;
  72
  73     ULONG                    e1kb_UnitCount;
  74     struct List              e1kb_Units;
  75 };
  76
  77 struct e1000Startup
  78 {
  79     struct MsgPort           *e1ksm_SyncPort;
  80     struct e1000Unit        *e1ksm_Unit;
  81 };
  82
  83 #undef HiddPCIDeviceAttrBase
  84 #define HiddPCIDeviceAttrBase   (LIBBASE->e1kb_PCIDeviceAttrBase)
  85
  86 enum {
  87     WRITE_QUEUE,
  88     ADOPT_QUEUE,
  89     EVENT_QUEUE,
  90     GENERAL_QUEUE,
  91     REQUEST_QUEUE_COUNT
  92 };
  93
  94 struct Opener
  95 {
  96     struct MinNode  node;
  97     struct MsgPort  read_port;
  98     BOOL            (*rx_function)(APTR, APTR, ULONG);
  99     BOOL            (*tx_function)(APTR, APTR, ULONG);
 100     struct Hook     *filter_hook;
 101     struct MinList  initial_stats;
 102 };
 103
 104 struct TypeStats
 105 {
 106     struct MinNode node;
 107     ULONG packet_type;
 108     struct Sana2PacketTypeStats stats;
 109 };
 110
 111
 112 struct TypeTracker
 113 {
 114     struct MinNode node;
 115     ULONG packet_type;
 116     struct Sana2PacketTypeStats stats;
 117     ULONG user_count;
 118 };
 119
 120
 121 struct AddressRange
 122 {
 123     struct MinNode node;
 124     ULONG add_count;
 125     UBYTE lower_bound[6];
 126     UBYTE upper_bound[6];
 127 };
 128
 129 /* Standard interface flags (netdevice->flags). */
 130 #define IFF_UP          0x1             /* interface is up              */
 131 #define IFF_BROADCAST   0x2             /* broadcast address valid      */
 132 #define IFF_DEBUG       0x4             /* turn on debugging            */
 133 #define IFF_LOOPBACK    0x8             /* is a loopback net            */
 134 #define IFF_POINTOPOINT 0x10            /* interface is has p-p link    */
 135 #define IFF_NOTRAILERS  0x20            /* avoid use of trailers        */
 136 #define IFF_RUNNING     0x40            /* resources allocated          */
 137 #define IFF_NOARP       0x80            /* no ARP protocol              */
 138 #define IFF_PROMISC     0x100           /* receive all packets          */
 139 #define IFF_ALLMULTI    0x200           /* receive all multicast packets*/
 140
 141 #define IFF_MASTER      0x400           /* master of a load balancer    */
 142 #define IFF_SLAVE       0x800           /* slave of a load balancer     */
 143
 144 #define IFF_MULTICAST   0x1000          /* Supports multicast           */
 145
 146 #define IFF_VOLATILE    (IFF_LOOPBACK|IFF_POINTOPOINT|IFF_BROADCAST|IFF_MASTER|IFF_SLAVE|IFF_RUNNING)
 147
 148 #define IFF_PORTSEL     0x2000          /* can set media type           */
 149 #define IFF_AUTOMEDIA   0x4000          /* auto media select active     */
 150 #define IFF_DYNAMIC     0x8000          /* dialup device with changing addresses*/
 151 #define IFF_SHARED      0x10000         /* interface may be shared */
 152 #define IFF_CONFIGURED  0x20000         /* interface already configured */
 153
 154 /*
 155  *      We tag multicasts with these structures.
 156  */
 157
 158 #define MAX_ADDR_LEN    32
 159
 160 struct dev_mc_list
 161 {
 162     struct dev_mc_list      *next;
 163     UBYTE                   dmi_addr[MAX_ADDR_LEN];
 164     unsigned char           dmi_addrlen;
 165     int                     dmi_users;
 166     int                     dmi_gusers;
 167 };
 168
 169 #define pci_name(unit)  (unit->e1ku_name)
 170
 171 /* ENET defines */
 172
 173 #define HZ                  1000000
 174 #define ETH_DATA_LEN        1500
 175
 176 #define ETH_ADDRESSSIZE     6
 177 #define ETH_HEADERSIZE      14
 178 #define ETH_CRCSIZE         4
 179 #define ETH_MTU             (ETH_DATA_LEN)
 180 #define ETH_MAXPACKETSIZE   ((ETH_HEADERSIZE) + (ETH_MTU) + (ETH_CRCSIZE))
 181
 182 #define ETH_PACKET_DEST     0
 183 #define ETH_PACKET_SOURCE   6
 184 #define ETH_PACKET_TYPE     12
 185 #define ETH_PACKET_IEEELEN  12
 186 #define ETH_PACKET_SNAPTYPE 20
 187 #define ETH_PACKET_DATA     14
 188 #define ETH_PACKET_CRC      (ETH_PACKET_DATA + ETH_MTU)
 189
 190 #define RXTX_ALLOC_BUFSIZE  (ETH_MAXPACKETSIZE + 26)
 191
 192 #define TX_LIMIT_STOP   63
 193 #define TX_LIMIT_START  62
 194
 195 struct eth_frame {
 196     UBYTE eth_packet_dest[6];
 197     UBYTE eth_packet_source[6];
 198     UWORD eth_packet_type;
 199     UBYTE eth_packet_data[ETH_MTU];
 200     UBYTE eth_packet_crc[4];
 201     UBYTE eth_pad[RXTX_ALLOC_BUFSIZE - ETH_MAXPACKETSIZE];
 202 } __attribute__((packed));
 203 #define eth_packet_ieeelen eth_packet_type
 204
 205 /* Media selection options. */
 206 enum {
 207         IF_PORT_UNKNOWN = 0,
 208         IF_PORT_10BASE2,
 209         IF_PORT_10BASET,
 210         IF_PORT_AUI,
 211         IF_PORT_100BASET,
 212         IF_PORT_100BASETX,
 213         IF_PORT_100BASEFX
 214 };
 215
 216 /* These flag bits are private to the generic network queueing
 217  * layer, they may not be explicitly referenced by any other
 218  * code.
 219  */
 220
 221 enum netdev_state_t
 222 {
 223         __LINK_STATE_XOFF=0,
 224         __LINK_STATE_START,
 225         __LINK_STATE_PRESENT,
 226         __LINK_STATE_SCHED,
 227         __LINK_STATE_NOCARRIER,
 228         __LINK_STATE_RX_SCHED,
 229         __LINK_STATE_LINKWATCH_PENDING
 230 };
 231
 232 #include "e1000_hw.h"
 233
 234 struct e1000_buffer {
 235     APTR buffer;
 236         APTR dma;
 237         UWORD length;
 238         UWORD next_to_watch;
 239 };
 240
 241 struct e1000_rx_buffer {
 242     APTR buffer;
 243         APTR dma;
 244 };
 245
 246 struct e1000_tx_ring {
 247         /* pointer to the descriptor ring memory */
 248         struct e1000_tx_desc *desc;
 249         /* physical address of the descriptor ring */
 250         APTR dma;
 251         /* length of descriptor ring in bytes */
 252         ULONG size;
 253         /* number of descriptors in the ring */
 254         ULONG count;
 255         /* next descriptor to associate a buffer with */
 256         unsigned int next_to_use;
 257         /* next descriptor to check for DD status bit */
 258         unsigned int next_to_clean;
 259         struct e1000_buffer *buffer_info;
 260
 261         UWORD tdh;
 262         UWORD tdt;
 263 };
 264
 265 struct e1000_rx_ring {
 266         /* pointer to the descriptor ring memory */
 267         struct e1000_rx_desc *desc;
 268         /* physical address of the descriptor ring */
 269         APTR dma;
 270         /* length of descriptor ring in bytes */
 271         ULONG size;
 272         /* number of descriptors in the ring */
 273         ULONG count;
 274         /* next descriptor to associate a buffer with */
 275         unsigned int next_to_use;
 276         /* next descriptor to check for DD status bit */
 277         unsigned int next_to_clean;
 278         struct e1000_rx_buffer *buffer_info;
 279
 280         UWORD rdh;
 281         UWORD rdt;
 282 };
 283
 284 void handle_request(LIBBASETYPEPTR, struct IOSana2Req *);
 285
 286 #endif /* _E1000_H_ */