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 #include <hidd/irq.h>
  45
  46 #include LC_LIBDEFS_FILE
  47
  48 typedef BOOL bool;
  49 typedef UBYTE u8;
  50 typedef UWORD u16;
  51 typedef ULONG u32;
  52 typedef LONG s32;
  53 typedef UQUAD u64;
  54
  55 #define __iomem volatile
  56
  57 #define e1000_TASK_NAME "%s.task"
  58 #define e1000_PORT_NAME "%s.port"
  59
  60 struct e1000Base
  61 {
  62     struct Device            e1kb_Device;
  63
  64     OOP_Object               *e1kb_PCI;
  65     OOP_AttrBase             e1kb_PCIDeviceAttrBase;
  66
  67     ULONG                    e1kb_UnitCount;
  68     struct List              e1kb_Units;
  69 };
  70
  71 struct e1000Startup
  72 {
  73     struct MsgPort           *e1ksm_SyncPort;
  74     struct e1000Unit        *e1ksm_Unit;
  75 };
  76
  77 #undef HiddPCIDeviceAttrBase
  78 #define HiddPCIDeviceAttrBase   (LIBBASE->e1kb_PCIDeviceAttrBase)
  79
  80 enum {
  81     WRITE_QUEUE,
  82     ADOPT_QUEUE,
  83     EVENT_QUEUE,
  84     GENERAL_QUEUE,
  85     REQUEST_QUEUE_COUNT
  86 };
  87
  88 struct Opener
  89 {
  90     struct MinNode  node;
  91     struct MsgPort  read_port;
  92     BOOL            (*rx_function)(APTR, APTR, ULONG);
  93     BOOL            (*tx_function)(APTR, APTR, ULONG);
  94     struct Hook     *filter_hook;
  95     struct MinList  initial_stats;
  96 };
  97
  98 struct TypeStats
  99 {
 100     struct MinNode node;
 101     ULONG packet_type;
 102     struct Sana2PacketTypeStats stats;
 103 };
 104
 105
 106 struct TypeTracker
 107 {
 108     struct MinNode node;
 109     ULONG packet_type;
 110     struct Sana2PacketTypeStats stats;
 111     ULONG user_count;
 112 };
 113
 114
 115 struct AddressRange
 116 {
 117     struct MinNode node;
 118     ULONG add_count;
 119     ULONG lower_bound_left;
 120     ULONG upper_bound_left;
 121     UWORD lower_bound_right;
 122     UWORD upper_bound_right;
 123 };
 124
 125 /* Standard interface flags (netdevice->flags). */
 126 #define IFF_UP          0x1             /* interface is up              */
 127 #define IFF_BROADCAST   0x2             /* broadcast address valid      */
 128 #define IFF_DEBUG       0x4             /* turn on debugging            */
 129 #define IFF_LOOPBACK    0x8             /* is a loopback net            */
 130 #define IFF_POINTOPOINT 0x10            /* interface is has p-p link    */
 131 #define IFF_NOTRAILERS  0x20            /* avoid use of trailers        */
 132 #define IFF_RUNNING     0x40            /* resources allocated          */
 133 #define IFF_NOARP       0x80            /* no ARP protocol              */
 134 #define IFF_PROMISC     0x100           /* receive all packets          */
 135 #define IFF_ALLMULTI    0x200           /* receive all multicast packets*/
 136
 137 #define IFF_MASTER      0x400           /* master of a load balancer    */
 138 #define IFF_SLAVE       0x800           /* slave of a load balancer     */
 139
 140 #define IFF_MULTICAST   0x1000          /* Supports multicast           */
 141
 142 #define IFF_VOLATILE    (IFF_LOOPBACK|IFF_POINTOPOINT|IFF_BROADCAST|IFF_MASTER|IFF_SLAVE|IFF_RUNNING)
 143
 144 #define IFF_PORTSEL     0x2000          /* can set media type           */
 145 #define IFF_AUTOMEDIA   0x4000          /* auto media select active     */
 146 #define IFF_DYNAMIC     0x8000          /* dialup device with changing addresses*/
 147 #define IFF_SHARED      0x10000         /* interface may be shared */
 148 #define IFF_CONFIGURED  0x20000         /* interface already configured */
 149
 150 /*
 151  *      We tag multicasts with these structures.
 152  */
 153
 154 #define MAX_ADDR_LEN    32
 155
 156 struct dev_mc_list
 157 {
 158     struct dev_mc_list      *next;
 159     UBYTE                   dmi_addr[MAX_ADDR_LEN];
 160     unsigned char           dmi_addrlen;
 161     int                     dmi_users;
 162     int                     dmi_gusers;
 163 };
 164
 165 #define pci_name(unit)  (unit->e1ku_name)
 166
 167 /* ENET defines */
 168
 169 #define HZ                  1000000
 170 #define ETH_DATA_LEN        1500
 171
 172 #define ETH_ADDRESSSIZE     6
 173 #define ETH_HEADERSIZE      14
 174 #define ETH_CRCSIZE         4
 175 #define ETH_MTU             (ETH_DATA_LEN)
 176 #define ETH_MAXPACKETSIZE   ((ETH_HEADERSIZE) + (ETH_MTU) + (ETH_CRCSIZE))
 177
 178 #define ETH_PACKET_DEST     0
 179 #define ETH_PACKET_SOURCE   6
 180 #define ETH_PACKET_TYPE     12
 181 #define ETH_PACKET_IEEELEN  12
 182 #define ETH_PACKET_SNAPTYPE 20
 183 #define ETH_PACKET_DATA     14
 184 #define ETH_PACKET_CRC      (ETH_PACKET_DATA + ETH_MTU)
 185
 186 #define RXTX_ALLOC_BUFSIZE  (ETH_MAXPACKETSIZE + 26)
 187
 188 #define TX_LIMIT_STOP   63
 189 #define TX_LIMIT_START  62
 190
 191 struct eth_frame {
 192     UBYTE eth_packet_dest[6];
 193     UBYTE eth_packet_source[6];
 194     UWORD eth_packet_type;
 195     UBYTE eth_packet_data[ETH_MTU];
 196     UBYTE eth_packet_crc[4];
 197     UBYTE eth_pad[RXTX_ALLOC_BUFSIZE - ETH_MAXPACKETSIZE];
 198 } __attribute__((packed));
 199 #define eth_packet_ieeelen eth_packet_type
 200
 201 /* Media selection options. */
 202 enum {
 203         IF_PORT_UNKNOWN = 0,
 204         IF_PORT_10BASE2,
 205         IF_PORT_10BASET,
 206         IF_PORT_AUI,
 207         IF_PORT_100BASET,
 208         IF_PORT_100BASETX,
 209         IF_PORT_100BASEFX
 210 };
 211
 212 /* These flag bits are private to the generic network queueing
 213  * layer, they may not be explicitly referenced by any other
 214  * code.
 215  */
 216
 217 enum netdev_state_t
 218 {
 219         __LINK_STATE_XOFF=0,
 220         __LINK_STATE_START,
 221         __LINK_STATE_PRESENT,
 222         __LINK_STATE_SCHED,
 223         __LINK_STATE_NOCARRIER,
 224         __LINK_STATE_RX_SCHED,
 225         __LINK_STATE_LINKWATCH_PENDING
 226 };
 227
 228 #include "e1000_hw.h"
 229
 230 struct e1000_buffer {
 231     APTR buffer;
 232         APTR dma;
 233         UWORD length;
 234         UWORD next_to_watch;
 235 };
 236
 237 struct e1000_rx_buffer {
 238     APTR buffer;
 239         APTR dma;
 240 };
 241
 242 struct e1000_tx_ring {
 243         /* pointer to the descriptor ring memory */
 244         struct e1000_tx_desc *desc;
 245         /* physical address of the descriptor ring */
 246         APTR dma;
 247         /* length of descriptor ring in bytes */
 248         ULONG size;
 249         /* number of descriptors in the ring */
 250         ULONG count;
 251         /* next descriptor to associate a buffer with */
 252         unsigned int next_to_use;
 253         /* next descriptor to check for DD status bit */
 254         unsigned int next_to_clean;
 255         struct e1000_buffer *buffer_info;
 256
 257         UWORD tdh;
 258         UWORD tdt;
 259 };
 260
 261 struct e1000_rx_ring {
 262         /* pointer to the descriptor ring memory */
 263         struct e1000_rx_desc *desc;
 264         /* physical address of the descriptor ring */
 265         APTR dma;
 266         /* length of descriptor ring in bytes */
 267         ULONG size;
 268         /* number of descriptors in the ring */
 269         ULONG count;
 270         /* next descriptor to associate a buffer with */
 271         unsigned int next_to_use;
 272         /* next descriptor to check for DD status bit */
 273         unsigned int next_to_clean;
 274         struct e1000_buffer *buffer_info;
 275
 276         UWORD rdh;
 277         UWORD rdt;
 278 };
 279
 280 void handle_request(LIBBASETYPEPTR, struct IOSana2Req *);
 281
 282 #endif /* _E1000_H_ */