1 /*        $NetBSD: if_ievar.h,v 1.17 2021/10/24 20:00:11 andvar Exp $ */
2 
3 /*
4  * Machine-dependent glue for the Intel Ethernet (ie) driver.
5  */
6 
7 #define   MXFRAMES  128       /* max number of frames to allow for receive */
8 #define   MXRXBUF   192       /* max number of buffers to allocate */
9 #define   IE_RBUF_SIZE        256       /* size of each buffer, MUST BE POWER OF TWO */
10 #define   NTXBUF              2         /* number of transmit buffer/command pairs */
11 #define   IE_TBUF_SIZE        (3*512)   /* length of transmit buffer */
12 
13 enum ie_hardware {
14           IE_VME,                       /* multibus to VME ie card */
15           IE_OBIO,            /* on board */
16           IE_VME3E,           /* sun 3e VME card */
17           IE_UNKNOWN
18 };
19 
20 /*
21  * Ethernet status, per interface.
22  *
23  * hardware addresses/sizes to know (all KVA):
24  *   sc_iobase = base of chip's 24 bit address space
25  *   sc_maddr  = base address of chip RAM as stored in ie_base of iscp
26  *   sc_msize  = size of chip's RAM
27  *   sc_reg    = address of card dependent registers
28  *
29  * the chip uses two types of pointers: 16 bit and 24 bit
30  *   16 bit pointers are offsets from sc_maddr/ie_base
31  *      KVA(16 bit offset) = offset + sc_maddr
32  *   24 bit pointers are offset from sc_iobase in KVA
33  *      KVA(24 bit address) = address + sc_iobase
34  *
35  * on the vme/multibus we have the page map to control where ram appears
36  * in the address space.   we choose to have RAM start at 0 in the
37  * 24 bit address space.   this means that sc_iobase == sc_maddr!
38  * to get the physical address of the board's RAM you must take the
39  * top 12 bits of the physical address of the register address
40  * and or in the 4 bits from the status word as bits 17-20 (remember that
41  * the board ignores the chip's top 4 address lines).
42  * For example:
43  *   if the register is @ 0xffe88000, then the top 12 bits are 0xffe00000.
44  *   to get the 4 bits from the status word just do status & IEVME_HADDR.
45  *   suppose the value is "4".   Then just shift it left 16 bits to get
46  *   it into bits 17-20 (e.g. 0x40000).    Then or it to get the
47  *   address of RAM (in our example: 0xffe40000).   see the attach routine!
48  *
49  * In the onboard ie interface, the 24 bit address space is hardwired
50  * to be 0xff000000 -> 0xffffffff of KVA.   this means that sc_iobase
51  * will be 0xff000000.   sc_maddr will be where ever we allocate RAM
52  * in KVA.    note that since the SCP is at a fixed address it means
53  * that we have to use some memory at a fixed KVA for the SCP.
54  * The Sun PROM leaves a page for us at the end of KVA space.
55  */
56 struct ie_softc {
57           device_t sc_dev;    /* device structure */
58 
59           struct ethercom sc_ethercom;/* system ethercom structure */
60 #define   sc_if     sc_ethercom.ec_if             /* network-visible interface */
61 
62           /* XXX: This is used only during attach. */
63           uint8_t sc_addr[ETHER_ADDR_LEN];
64           uint8_t sc_pad1[2];
65 
66           int     sc_debug;   /* See IEDEBUG */
67 
68           /* card dependent functions: */
69           void    (*reset_586)(struct ie_softc *);
70           void    (*chan_attn)(struct ie_softc *);
71           void    (*run_586)  (struct ie_softc *);
72           void      *(*sc_memcpy)(void *, const void *, size_t);
73           void      *(*sc_memset)(void *, int, size_t);
74 
75           void *sc_iobase;    /* KVA of base of 24bit addr space */
76           void *sc_maddr;     /* KVA of base of chip's RAM */
77           u_int   sc_msize;   /* how much RAM we have/use */
78           void *sc_reg;                 /* KVA of card's register */
79 
80           enum ie_hardware hard_type;   /* card type */
81 
82           int     want_mcsetup;         /* flag for multicast setup */
83           u_short     promisc;          /* are we in promisc mode? */
84 
85           int ntxbuf;       /* number of tx frames/buffers */
86           int nframes;      /* number of recv frames in use */
87           int nrxbuf;       /* number of recv buffs in use */
88 
89           /*
90            * pointers to the 3 major control structures
91            */
92           volatile struct ie_sys_conf_ptr *scp;
93           volatile struct ie_int_sys_conf_ptr *iscp;
94           volatile struct ie_sys_ctl_block *scb;
95 
96           /*
97            * pointer and size of a block of KVA where the buffers
98            * are to be allocated from
99            */
100           uint8_t *buf_area;
101           int     buf_area_sz;
102 
103           /*
104            * Transmit commands, descriptors, and buffers
105            */
106           volatile struct ie_xmit_cmd *xmit_cmds[NTXBUF];
107           volatile struct ie_xmit_buf *xmit_buffs[NTXBUF];
108           char *xmit_cbuffs[NTXBUF];
109           int xmit_busy;
110           int xmit_free;
111           int xchead, xctail;
112 
113           /*
114            * Receive frames, descriptors, and buffers
115            */
116           volatile struct ie_recv_frame_desc *rframes[MXFRAMES];
117           volatile struct ie_recv_buf_desc *rbuffs[MXRXBUF];
118           char *cbuffs[MXRXBUF];
119           int     rfhead, rftail, rbhead, rbtail;
120 
121           /* Multi-cast stuff */
122           int     mcast_count;
123           struct ie_en_addr mcast_addrs[MAXMCAST + 1];
124 };
125 
126 
127 extern void    ie_attach(struct ie_softc *);
128 extern int  ie_intr(void *);
129