The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/dev/ic/i82586.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * Copyright (c) 1992, University of Vermont and State Agricultural College.
    3  * Copyright (c) 1992, Garrett A. Wollman.
    4  * All rights reserved.
    5  *
    6  * Redistribution and use in source and binary forms, with or without
    7  * modification, are permitted provided that the following conditions
    8  * are met:
    9  * 1. Redistributions of source code must retain the above copyright
   10  *    notice, this list of conditions and the following disclaimer.
   11  * 2. Redistributions in binary form must reproduce the above copyright
   12  *    notice, this list of conditions and the following disclaimer in the
   13  *    documentation and/or other materials provided with the distribution.
   14  * 3. All advertising materials mentioning features or use of this software
   15  *    must display the following acknowledgement:
   16  *      This product includes software developed by the University of
   17  *      Vermont and State Agricultural College and Garrett A. Wollman.
   18  * 4. Neither the name of the University nor the name of the author
   19  *    may be used to endorse or promote products derived from this software
   20  *    without specific prior written permission.
   21  *
   22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE UNIVERSITY OR AUTHOR BE LIABLE
   26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   32  * SUCH DAMAGE.
   33  *
   34  * $FreeBSD: releng/5.3/sys/dev/ic/i82586.h 112734 2003-03-28 06:27:08Z mdodd $
   35  */
   36 
   37 /*
   38  * Intel 82586 Ethernet chip
   39  * Register, bit, and structure definitions.
   40  *
   41  * Written by GAW with reference to the Clarkson Packet Driver code for this
   42  * chip written by Russ Nelson and others.
   43  */
   44 
   45 struct ie_en_addr {
   46         u_char data[6];
   47 };
   48 
   49 /*
   50  * This is the master configuration block.  It tells the hardware where all
   51  * the rest of the stuff is.
   52  */
   53 struct ie_sys_conf_ptr {
   54         u_short mbz;                    /* must be zero */
   55         u_char ie_bus_use;              /* true if 8-bit only */
   56         u_char mbz2[5];                 /* must be zero */
   57         caddr_t ie_iscp_ptr;            /* 24-bit physaddr of ISCP */
   58 };
   59 
   60 /*
   61  * Note that this is wired in hardware; the SCP is always located here, no
   62  * matter what.
   63  */
   64 #define IE_SCP_ADDR 0xfffff4
   65 
   66 /*
   67  * The tells the hardware where all the rest of the stuff is, too.
   68  * FIXME: some of these should be re-commented after we figure out their
   69  * REAL function.
   70  */
   71 struct ie_int_sys_conf_ptr {
   72         u_char ie_busy;                 /* zeroed after init */
   73         u_char mbz;
   74         u_short ie_scb_offset;          /* 16-bit physaddr of next struct */
   75         caddr_t ie_base;                /* 24-bit physaddr for all 16-bit vars */
   76 };
   77 
   78 /*
   79  * This FINALLY tells the hardware what to do and where to put it.
   80  */
   81 struct ie_sys_ctl_block {
   82         u_short ie_status;              /* status word */
   83         u_short ie_command;             /* command word */
   84         u_short ie_command_list;        /* 16-pointer to command block list */
   85         u_short ie_recv_list;           /* 16-pointer to receive frame list */
   86         u_short ie_err_crc;             /* CRC errors */
   87         u_short ie_err_align;           /* Alignment errors */
   88         u_short ie_err_resource;        /* Resource errors */
   89         u_short ie_err_overrun;         /* Overrun errors */
   90 };
   91 
   92 /* Command values */
   93 #define IE_RU_COMMAND   0x0070  /* mask for RU command */
   94 #define IE_RU_NOP       0       /* for completeness */
   95 #define IE_RU_START     0x0010  /* start receive unit command */
   96 #define IE_RU_ENABLE    0x0020  /* enable receiver command */
   97 #define IE_RU_DISABLE   0x0030  /* disable receiver command */
   98 #define IE_RU_ABORT     0x0040  /* abort current receive operation */
   99 
  100 #define IE_CU_COMMAND   0x0700  /* mask for CU command */
  101 #define IE_CU_NOP       0       /* included for completeness */
  102 #define IE_CU_START     0x0100  /* do-command command */
  103 #define IE_CU_RESUME    0x0200  /* resume a suspended cmd list */
  104 #define IE_CU_STOP      0x0300  /* SUSPEND was already taken */
  105 #define IE_CU_ABORT     0x0400  /* abort current command */
  106 
  107 #define IE_ACK_COMMAND  0xf000  /* mask for ACK command */
  108 #define IE_ACK_CX       0x8000  /* ack IE_ST_DONE */
  109 #define IE_ACK_FR       0x4000  /* ack IE_ST_RECV */
  110 #define IE_ACK_CNA      0x2000  /* ack IE_ST_ALLDONE */
  111 #define IE_ACK_RNR      0x1000  /* ack IE_ST_RNR */
  112 
  113 #define IE_ACTION_COMMAND(x) (((x) & IE_CU_COMMAND) == IE_CU_START)
  114                                 /* is this command an action command? */
  115 
  116 /* Status values */
  117 #define IE_ST_WHENCE    0xf000  /* mask for cause of interrupt */
  118 #define IE_ST_DONE      0x8000  /* command with I bit completed */
  119 #define IE_ST_RECV      0x4000  /* frame received */
  120 #define IE_ST_ALLDONE   0x2000  /* all commands completed */
  121 #define IE_ST_RNR       0x1000  /* receive not ready */
  122 
  123 #define IE_CU_STATUS    0x700   /* mask for command unit status */
  124 #define IE_CU_ACTIVE    0x200   /* command unit is active */
  125 #define IE_CU_SUSPEND   0x100   /* command unit is suspended */
  126 
  127 #define IE_RU_STATUS    0x70    /* mask for receiver unit status */
  128 #define IE_RU_SUSPEND   0x10    /* receiver is suspended */
  129 #define IE_RU_NOSPACE   0x20    /* receiver has no resources */
  130 #define IE_RU_READY     0x40    /* reveiver is ready */
  131 
  132 /*
  133  * This is filled in partially by the chip, partially by us.
  134  */
  135 struct ie_recv_frame_desc {
  136         u_short ie_fd_status;           /* status for this frame */
  137         u_short ie_fd_last;             /* end of frame list flag */
  138         u_short ie_fd_next;             /* 16-pointer to next RFD */
  139         u_short ie_fd_buf_desc;         /* 16-pointer to list of buffer desc's */
  140         struct ie_en_addr dest;         /* destination ether */
  141         struct ie_en_addr src;          /* source ether */
  142         u_short ie_length;              /* 802 length/Ether type */
  143         u_short mbz;                    /* must be zero */
  144 };
  145 
  146 #define IE_FD_LAST      0x8000  /* last rfd in list */
  147 #define IE_FD_SUSP      0x4000  /* suspend RU after receipt */
  148 
  149 #define IE_FD_COMPLETE  0x8000  /* frame is complete */
  150 #define IE_FD_BUSY      0x4000  /* frame is busy */
  151 #define IE_FD_OK        0x2000  /* frame is bad */
  152 #define IE_FD_RNR       0x0200  /* receiver out of resources here */
  153 
  154 /*
  155  * linked list of buffers...
  156  */
  157 struct ie_recv_buf_desc {
  158         u_short ie_rbd_actual;          /* status for this buffer */
  159         u_short ie_rbd_next;            /* 16-pointer to next RBD */
  160         caddr_t ie_rbd_buffer;          /* 24-pointer to buffer for this RBD */
  161         u_short ie_rbd_length;          /* length of the buffer */
  162         u_short mbz;                    /* must be zero */
  163 };
  164 
  165 #define IE_RBD_LAST     0x8000  /* last buffer */
  166 #define IE_RBD_USED     0x4000  /* this buffer has data */
  167 /*
  168  * All commands share this in common.
  169  */
  170 struct ie_cmd_common {
  171         u_short ie_cmd_status;          /* status of this command */
  172         u_short ie_cmd_cmd;             /* command word */
  173         u_short ie_cmd_link;            /* link to next command */
  174 };
  175 
  176 #define IE_STAT_COMPL   0x8000  /* command is completed */
  177 #define IE_STAT_BUSY    0x4000  /* command is running now */
  178 #define IE_STAT_OK      0x2000  /* command completed successfully */
  179 
  180 #define IE_CMD_NOP      0x0000  /* NOP */
  181 #define IE_CMD_IASETUP  0x0001  /* initial address setup */
  182 #define IE_CMD_CONFIG   0x0002  /* configure command */
  183 #define IE_CMD_MCAST    0x0003  /* multicast setup command */
  184 #define IE_CMD_XMIT     0x0004  /* transmit command */
  185 #define IE_CMD_TDR      0x0005  /* time-domain reflectometer command */
  186 #define IE_CMD_DUMP     0x0006  /* dump command */
  187 #define IE_CMD_DIAGNOSE 0x0007  /* diagnostics command */
  188 
  189 #define IE_CMD_LAST     0x8000  /* this is the last command in the list */
  190 #define IE_CMD_SUSPEND  0x4000  /* suspend CU after this command */
  191 #define IE_CMD_INTR     0x2000  /* post an interrupt after completion */
  192 
  193 /*
  194  * This is the command to transmit a frame.
  195  */
  196 struct ie_xmit_cmd {
  197         struct ie_cmd_common com;       /* common part */
  198 #define ie_xmit_status com.ie_cmd_status
  199 
  200         u_short ie_xmit_desc;           /* 16-pointer to buffer descriptor */
  201         struct ie_en_addr ie_xmit_addr; /* destination address */
  202 
  203         u_short ie_xmit_length;         /* 802.3 length/Ether type field */
  204 };
  205 
  206 #define IE_XS_MAXCOLL   0x000f  /* number of collisions during transmit */
  207 #define IE_XS_EXCMAX    0x0020  /* exceeded maximum number of collisions */
  208 #define IE_XS_SQE       0x0040  /* SQE positive */
  209 #define IE_XS_DEFERRED  0x0080  /* transmission deferred */
  210 #define IE_XS_UNDERRUN  0x0100  /* DMA underrun */
  211 #define IE_XS_LOSTCTS   0x0200  /* Lost CTS */
  212 #define IE_XS_NOCARRIER 0x0400  /* No Carrier */
  213 #define IE_XS_LATECOLL  0x0800  /* Late collision */
  214 
  215 /*
  216  * This is a buffer descriptor for a frame to be transmitted.
  217  */
  218 
  219 struct ie_xmit_buf {
  220         u_short ie_xmit_flags;          /* see below */
  221         u_short ie_xmit_next;           /* 16-pointer to next desc. */
  222         caddr_t ie_xmit_buf;            /* 24-pointer to the actual buffer */
  223 };
  224 
  225 #define IE_XMIT_LAST 0x8000     /* this TBD is the last one */
  226 /* The rest of the `flags' word is actually the length. */
  227 
  228 /*
  229  * Multicast setup command.
  230  */
  231 
  232 #define MAXMCAST 50             /* must fit in transmit buffer */
  233 
  234 struct ie_mcast_cmd {
  235         struct ie_cmd_common com;       /* common part */
  236 #define ie_mcast_status com.ie_cmd_status
  237 
  238         u_short ie_mcast_bytes; /* size (in bytes) of multicast addresses */
  239         struct ie_en_addr ie_mcast_addrs[MAXMCAST + 1]; /* space for them */
  240 };
  241 
  242 /*
  243  * Time Domain Reflectometer command.
  244  */
  245 
  246 struct ie_tdr_cmd {
  247         struct ie_cmd_common com;       /* common part */
  248 #define ie_tdr_status com.ie_cmd_status
  249 
  250         u_short ie_tdr_time;            /* error bits and time */
  251 };
  252 
  253 #define IE_TDR_SUCCESS  0x8000  /* TDR succeeded without error */
  254 #define IE_TDR_XCVR     0x4000  /* detected a transceiver problem */
  255 #define IE_TDR_OPEN     0x2000  /* detected an open */
  256 #define IE_TDR_SHORT    0x1000  /* TDR detected a short */
  257 #define IE_TDR_TIME     0x07ff  /* mask for reflection time */
  258 
  259 /*
  260  * Initial Address Setup command
  261  */
  262 struct ie_iasetup_cmd {
  263         struct ie_cmd_common com;
  264 #define ie_iasetup_status com.ie_cmd_status
  265 
  266         struct ie_en_addr ie_address;
  267 };
  268 
  269 /*
  270  * Configuration command
  271  */
  272 struct ie_config_cmd {
  273         struct ie_cmd_common com;       /* common part */
  274 #define ie_config_status com.ie_cmd_status
  275 
  276         u_char ie_config_count;         /* byte count (0x0c) */
  277         u_char ie_fifo;                 /* fifo (8) */
  278         u_char ie_save_bad;             /* save bad frames (0x40) */
  279         u_char ie_addr_len;             /* address length (0x2e) (AL-LOC == 1) */
  280         u_char ie_priority;             /* priority and backoff (0x0) */
  281         u_char ie_ifs;                  /* inter-frame spacing (0x60) */
  282         u_char ie_slot_low;             /* slot time, LSB (0x0) */
  283         u_char ie_slot_high;            /* slot time, MSN, and retries (0xf2) */
  284         u_char ie_promisc;              /* 1 if promiscuous, else 0 */
  285         u_char ie_crs_cdt;              /* CSMA/CD parameters (0x0) */
  286         u_char ie_min_len;              /* min frame length (0x40) */
  287         u_char ie_junk;                 /* stuff for 82596 (0xff) */
  288 };
  289 
  290 /*
  291  * Here are a few useful functions.  We could have done these as macros,
  292  * but since we have the inline facility, it makes sense to use that
  293  * instead.
  294  */
  295 static __inline void
  296 ie_setup_config(volatile struct ie_config_cmd *cmd,
  297                 int promiscuous, int manchester) {
  298         cmd->ie_config_count = 0x0c;
  299         cmd->ie_fifo = 8;
  300         cmd->ie_save_bad = 0x40;
  301         cmd->ie_addr_len = 0x2e;
  302         cmd->ie_priority = 0;
  303         cmd->ie_ifs = 0x60;
  304         cmd->ie_slot_low = 0;
  305         cmd->ie_slot_high = 0xf2;
  306         cmd->ie_promisc = !!promiscuous | manchester << 2;
  307         cmd->ie_crs_cdt = 0;
  308         cmd->ie_min_len = 64;
  309         cmd->ie_junk = 0xff;
  310 }
  311 
  312 static __inline void *
  313 Align(void *ptr) {
  314         uintptr_t l = (uintptr_t)ptr;
  315         l = (l + 3) & ~3L;
  316         return (void *)l;
  317 }
  318 
  319 static __inline volatile void *
  320 Alignvol(volatile void *ptr) {
  321         uintptr_t l = (uintptr_t)ptr;
  322         l = (l + 3) & ~3L;
  323         return (volatile void *)l;
  324 }
  325 
  326 #if 0
  327 static __inline void
  328 ie_ack(volatile struct ie_sys_ctl_block *scb,
  329                                   u_int mask, int unit,
  330                                   void (*ca)(int)) {
  331         scb->ie_command = scb->ie_status & mask;
  332         (*ca)(unit);
  333 }
  334 #endif

Cache object: 3662cdabbe053850453ab3dcf44af208


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.