1 /*        $NetBSD: if_efreg.h,v 1.4 2008/04/28 20:23:52 martin Exp $  */
2 
3 /*-
4  * Copyright (c) 1998 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Rafal K. Boni.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * Card-specific definitions and macros for the 3Com 3C507/3C507TP
34  */
35 
36 /*
37  * Register offsets (from IOBASE)
38  */
39 
40 /* All banks */
41 #define   EF_CTRL             6         /* offset of general control register */
42 #define   EF_ICTRL  10        /* offset of intr. latch clear register */
43 #define   EF_ATTN   11        /* offset of CA register */
44 #define   EF_MEDIA  13        /* offset of ROM & xcvr config register */
45 #define   EF_MADDR  14        /* offset of shared memory config register */
46 #define   EF_IRQ              15        /* offset of IRQ configuration register */
47 
48 /* Bank 0 -- "*3COM*" signature */
49 #define EF_SIG                0         /* offset of ASCII signature -- "*3COM*" */
50 
51 /* Bank 1 -- ethernet address */
52 #define EF_ADDR               0         /* offset of card's ethernet address */
53 
54 /* Bank 2 -- card part #, revision, date of manufacture */
55 #define   EF_TYPE             0         /* offset of card part # */
56 #define   EF_TYPE_HI          0         /* offset of card part # -- high byte */
57 #define EF_TYPE_MID 1         /* offset of card part # -- middle byte */
58 #define EF_TYPE_LOW 2         /* offset of card part # -- low byte */
59 #define EF_REV                3         /* offset of card revision, in BCD */
60 #define EF_DOM_DAY  4         /* offset of date of manf: day in BCD */
61 #define EF_DOM_MY   4         /* offset of date of manf: month, year in BCD */
62 
63 /*
64  * Definitions for non-bankswitched registers
65  */
66 
67 /* General control register */
68 #define   EF_CTRL_BNK0        0x00      /* register bank 0 */
69 #define   EF_CTRL_BNK1        0x01      /* register bank 1 */
70 #define   EF_CTRL_BNK2        0x02      /* register bank 2 */
71 #define   EF_CTRL_IEN         0x04      /* interrupt enable */
72 #define   EF_CTRL_INTL        0x08      /* interrupt active latch */
73 #define   EF_CTRL_16BIT       0x10      /* bus width; clear = 8-bit, set = 16-bit */
74 #define   EF_CTRL_LOOP        0x20      /* loopback mode */
75 #define   EF_CTRL_NRST        0x80      /* turn off to reset */
76 #define   EF_CTRL_RESET       (EF_CTRL_LOOP)
77 #define   EF_CTRL_NORMAL      (EF_CTRL_NRST | EF_CTRL_IEN | EF_CTRL_BNK1)
78 
79 /* ROM & media control register */
80 #define EF_MEDIA_MASK         0x80      /* m1 = (EF_MEDIA register) & EF_MEDIA_MASK */
81 #define EF_MEDIA_SHIFT        7         /* media index = m1 >> EF_MEDIA_SHIFT */
82 
83 /* shared memory control register */
84 #define EF_MADDR_HIGH         0x20      /* memory mapping above 15Meg */
85 #define EF_MADDR_MASK         0x1c      /* m1 = (EF_MADDR register) & EF_MADDR_MASK */
86 #define EF_MADDR_SHIFT        12        /* m2 = m1 << EF_MADDR_SHIFT  */
87 #define EF_MADDR_BASE         0xc0000   /* maddr = m2 + EF_MADDR_BASE */
88 #define EF_MSIZE_MASK         0x03      /* m1 = (EF_MADDR register) & EF_MSIZE_MASK */
89 #define EF_MSIZE_STEP         16384     /* msize = (m1 + 1) * EF_MSIZE_STEP */
90 
91 /* interrupt control register */
92 #define EF_IRQ_MASK 0x0f      /* irq = (EF_IRQ register) & EF_IRQ_MASK */
93 
94 /*
95  * Definitions for Bank 0 registers
96  */
97 #define EF_SIG_LEN  6         /* signature length */
98 #define EF_SIGNATURE          "*3COM*"
99 
100 /*
101  * Definitions for Bank 1 registers
102  */
103 #define EF_ADDR_LEN 6         /* ether address length */
104 
105 /*
106  * Definitions for Bank 2 registers
107  */
108 #define EF_TYPE_LEN 3         /* card part # length */
109 
110 /*
111  * General card-specific macros and definitions
112  */
113 #define EF_IOBASE_LOW         0x200
114 #define EF_IOBASE_HIGH        0x3e0
115 #define EF_IOSIZE   16
116 
117 /*
118  * XXX: It seems that the 3C507-TP is differentiated from AUI/BNC 3C507
119  * by part numbers, but I'm not sure how accurate this test is, seeing
120  * as it's based on the sample of 3 cards I own (2AUI/BNC, 1 TP).
121  */
122 #define EF_IS_TP(type)        ((type)[EF_TYPE_MID] > 0x70)
123 
124 #define EF_CARD_BNC 0         /* regular AUI/BNC 3C507 */
125 #define EF_CARD_TP  1         /* 3C507-TP -- no AUI/BNC */
126 
127