net: cdc_ncm: Reduce memory use when kernel memory low
[sfrench/cifs-2.6.git] / drivers / net / usb / smsc95xx.h
1  /***************************************************************************
2  *
3  * Copyright (C) 2007-2008 SMSC
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, see <http://www.gnu.org/licenses/>.
17  *
18  *****************************************************************************/
19
20 #ifndef _SMSC95XX_H
21 #define _SMSC95XX_H
22
23 /* Tx command words */
24 #define TX_CMD_A_DATA_OFFSET_   (0x001F0000)    /* Data Start Offset */
25 #define TX_CMD_A_FIRST_SEG_     (0x00002000)    /* First Segment */
26 #define TX_CMD_A_LAST_SEG_      (0x00001000)    /* Last Segment */
27 #define TX_CMD_A_BUF_SIZE_      (0x000007FF)    /* Buffer Size */
28
29 #define TX_CMD_B_CSUM_ENABLE    (0x00004000)    /* TX Checksum Enable */
30 #define TX_CMD_B_ADD_CRC_DIS_   (0x00002000)    /* Add CRC Disable */
31 #define TX_CMD_B_DIS_PADDING_   (0x00001000)    /* Disable Frame Padding */
32 #define TX_CMD_B_FRAME_LENGTH_  (0x000007FF)    /* Frame Length (bytes) */
33
34 /* Rx status word */
35 #define RX_STS_FF_              (0x40000000)    /* Filter Fail */
36 #define RX_STS_FL_              (0x3FFF0000)    /* Frame Length */
37 #define RX_STS_ES_              (0x00008000)    /* Error Summary */
38 #define RX_STS_BF_              (0x00002000)    /* Broadcast Frame */
39 #define RX_STS_LE_              (0x00001000)    /* Length Error */
40 #define RX_STS_RF_              (0x00000800)    /* Runt Frame */
41 #define RX_STS_MF_              (0x00000400)    /* Multicast Frame */
42 #define RX_STS_TL_              (0x00000080)    /* Frame too long */
43 #define RX_STS_CS_              (0x00000040)    /* Collision Seen */
44 #define RX_STS_FT_              (0x00000020)    /* Frame Type */
45 #define RX_STS_RW_              (0x00000010)    /* Receive Watchdog */
46 #define RX_STS_ME_              (0x00000008)    /* MII Error */
47 #define RX_STS_DB_              (0x00000004)    /* Dribbling */
48 #define RX_STS_CRC_             (0x00000002)    /* CRC Error */
49
50 /* SCSRs - System Control and Status Registers */
51 /* Device ID and Revision Register */
52 #define ID_REV                  (0x00)
53 #define ID_REV_CHIP_ID_MASK_    (0xFFFF0000)
54 #define ID_REV_CHIP_REV_MASK_   (0x0000FFFF)
55 #define ID_REV_CHIP_ID_9500_    (0x9500)
56 #define ID_REV_CHIP_ID_9500A_   (0x9E00)
57 #define ID_REV_CHIP_ID_9512_    (0xEC00)
58 #define ID_REV_CHIP_ID_9530_    (0x9530)
59 #define ID_REV_CHIP_ID_89530_   (0x9E08)
60 #define ID_REV_CHIP_ID_9730_    (0x9730)
61
62 /* Interrupt Status Register */
63 #define INT_STS                 (0x08)
64 #define INT_STS_MAC_RTO_        (0x00040000)    /* MAC Reset Time Out */
65 #define INT_STS_TX_STOP_        (0x00020000)    /* TX Stopped */
66 #define INT_STS_RX_STOP_        (0x00010000)    /* RX Stopped */
67 #define INT_STS_PHY_INT_        (0x00008000)    /* PHY Interrupt */
68 #define INT_STS_TXE_            (0x00004000)    /* Transmitter Error */
69 #define INT_STS_TDFU_           (0x00002000)    /* TX Data FIFO Underrun */
70 #define INT_STS_TDFO_           (0x00001000)    /* TX Data FIFO Overrun */
71 #define INT_STS_RXDF_           (0x00000800)    /* RX Dropped Frame */
72 #define INT_STS_GPIOS_          (0x000007FF)    /* GPIOs Interrupts */
73 #define INT_STS_CLEAR_ALL_      (0xFFFFFFFF)
74
75 /* Receive Configuration Register */
76 #define RX_CFG                  (0x0C)
77 #define RX_FIFO_FLUSH_          (0x00000001)    /* Receive FIFO Flush */
78
79 /* Transmit Configuration Register */
80 #define TX_CFG                  (0x10)
81 #define TX_CFG_ON_              (0x00000004)    /* Transmitter Enable */
82 #define TX_CFG_STOP_            (0x00000002)    /* Stop Transmitter */
83 #define TX_CFG_FIFO_FLUSH_      (0x00000001)    /* Transmit FIFO Flush */
84
85 /* Hardware Configuration Register */
86 #define HW_CFG                  (0x14)
87 #define HW_CFG_BIR_             (0x00001000)    /* Bulk In Empty Response */
88 #define HW_CFG_LEDB_            (0x00000800)    /* Activity LED 80ms Bypass */
89 #define HW_CFG_RXDOFF_          (0x00000600)    /* RX Data Offset */
90 #define HW_CFG_SBP_             (0x00000100)    /* Stall Bulk Out Pipe Dis. */
91 #define HW_CFG_IME_             (0x00000080)    /* Internal MII Visi. Enable */
92 #define HW_CFG_DRP_             (0x00000040)    /* Discard Errored RX Frame */
93 #define HW_CFG_MEF_             (0x00000020)    /* Mult. ETH Frames/USB pkt */
94 #define HW_CFG_ETC_             (0x00000010)    /* EEPROM Timeout Control */
95 #define HW_CFG_LRST_            (0x00000008)    /* Soft Lite Reset */
96 #define HW_CFG_PSEL_            (0x00000004)    /* External PHY Select */
97 #define HW_CFG_BCE_             (0x00000002)    /* Burst Cap Enable */
98 #define HW_CFG_SRST_            (0x00000001)    /* Soft Reset */
99
100 /* Receive FIFO Information Register */
101 #define RX_FIFO_INF             (0x18)
102 #define RX_FIFO_INF_USED_       (0x0000FFFF)    /* RX Data FIFO Used Space */
103
104 /* Transmit FIFO Information Register */
105 #define TX_FIFO_INF             (0x1C)
106 #define TX_FIFO_INF_FREE_       (0x0000FFFF)    /* TX Data FIFO Free Space */
107
108 /* Power Management Control Register */
109 #define PM_CTRL                 (0x20)
110 #define PM_CTL_RES_CLR_WKP_STS  (0x00000200)    /* Resume Clears Wakeup STS */
111 #define PM_CTL_RES_CLR_WKP_EN   (0x00000100)    /* Resume Clears Wkp Enables */
112 #define PM_CTL_DEV_RDY_         (0x00000080)    /* Device Ready */
113 #define PM_CTL_SUS_MODE_        (0x00000060)    /* Suspend Mode */
114 #define PM_CTL_SUS_MODE_0       (0x00000000)
115 #define PM_CTL_SUS_MODE_1       (0x00000020)
116 #define PM_CTL_SUS_MODE_2       (0x00000040)
117 #define PM_CTL_SUS_MODE_3       (0x00000060)
118 #define PM_CTL_PHY_RST_         (0x00000010)    /* PHY Reset */
119 #define PM_CTL_WOL_EN_          (0x00000008)    /* Wake On Lan Enable */
120 #define PM_CTL_ED_EN_           (0x00000004)    /* Energy Detect Enable */
121 #define PM_CTL_WUPS_            (0x00000003)    /* Wake Up Status */
122 #define PM_CTL_WUPS_NO_         (0x00000000)    /* No Wake Up Event Detected */
123 #define PM_CTL_WUPS_ED_         (0x00000001)    /* Energy Detect */
124 #define PM_CTL_WUPS_WOL_        (0x00000002)    /* Wake On Lan */
125 #define PM_CTL_WUPS_MULTI_      (0x00000003)    /* Multiple Events Occurred */
126
127 /* LED General Purpose IO Configuration Register */
128 #define LED_GPIO_CFG            (0x24)
129 #define LED_GPIO_CFG_SPD_LED    (0x01000000)    /* GPIOz as Speed LED */
130 #define LED_GPIO_CFG_LNK_LED    (0x00100000)    /* GPIOy as Link LED */
131 #define LED_GPIO_CFG_FDX_LED    (0x00010000)    /* GPIOx as Full Duplex LED */
132
133 /* General Purpose IO Configuration Register */
134 #define GPIO_CFG                (0x28)
135
136 /* Automatic Flow Control Configuration Register */
137 #define AFC_CFG                 (0x2C)
138 #define AFC_CFG_HI_             (0x00FF0000)    /* Auto Flow Ctrl High Level */
139 #define AFC_CFG_LO_             (0x0000FF00)    /* Auto Flow Ctrl Low Level */
140 #define AFC_CFG_BACK_DUR_       (0x000000F0)    /* Back Pressure Duration */
141 #define AFC_CFG_FC_MULT_        (0x00000008)    /* Flow Ctrl on Mcast Frame */
142 #define AFC_CFG_FC_BRD_         (0x00000004)    /* Flow Ctrl on Bcast Frame */
143 #define AFC_CFG_FC_ADD_         (0x00000002)    /* Flow Ctrl on Addr. Decode */
144 #define AFC_CFG_FC_ANY_         (0x00000001)    /* Flow Ctrl on Any Frame */
145 /* Hi watermark = 15.5Kb (~10 mtu pkts) */
146 /* low watermark = 3k (~2 mtu pkts) */
147 /* backpressure duration = ~ 350us */
148 /* Apply FC on any frame. */
149 #define AFC_CFG_DEFAULT         (0x00F830A1)
150
151 /* EEPROM Command Register */
152 #define E2P_CMD                 (0x30)
153 #define E2P_CMD_BUSY_           (0x80000000)    /* E2P Controller Busy */
154 #define E2P_CMD_MASK_           (0x70000000)    /* Command Mask (see below) */
155 #define E2P_CMD_READ_           (0x00000000)    /* Read Location */
156 #define E2P_CMD_EWDS_           (0x10000000)    /* Erase/Write Disable */
157 #define E2P_CMD_EWEN_           (0x20000000)    /* Erase/Write Enable */
158 #define E2P_CMD_WRITE_          (0x30000000)    /* Write Location */
159 #define E2P_CMD_WRAL_           (0x40000000)    /* Write All */
160 #define E2P_CMD_ERASE_          (0x50000000)    /* Erase Location */
161 #define E2P_CMD_ERAL_           (0x60000000)    /* Erase All */
162 #define E2P_CMD_RELOAD_         (0x70000000)    /* Data Reload */
163 #define E2P_CMD_TIMEOUT_        (0x00000400)    /* Set if no resp within 30ms */
164 #define E2P_CMD_LOADED_         (0x00000200)    /* Valid EEPROM found */
165 #define E2P_CMD_ADDR_           (0x000001FF)    /* Byte aligned address */
166
167 #define MAX_EEPROM_SIZE         (512)
168
169 /* EEPROM Data Register */
170 #define E2P_DATA                (0x34)
171 #define E2P_DATA_MASK_          (0x000000FF)    /* EEPROM Data Mask */
172
173 /* Burst Cap Register */
174 #define BURST_CAP               (0x38)
175 #define BURST_CAP_MASK_         (0x000000FF)    /* Max burst sent by the UTX */
176
177 /* Configuration Straps Status Register */
178 #define STRAP_STATUS                    (0x3C)
179 #define STRAP_STATUS_PWR_SEL_           (0x00000020) /* Device self-powered */
180 #define STRAP_STATUS_AMDIX_EN_          (0x00000010) /* Auto-MDIX Enabled */
181 #define STRAP_STATUS_PORT_SWAP_         (0x00000008) /* USBD+/USBD- Swapped */
182 #define STRAP_STATUS_EEP_SIZE_          (0x00000004) /* EEPROM Size */
183 #define STRAP_STATUS_RMT_WKP_           (0x00000002) /* Remote Wkp supported */
184 #define STRAP_STATUS_EEP_DISABLE_       (0x00000001) /* EEPROM Disabled */
185
186 /* Data Port Select Register */
187 #define DP_SEL                  (0x40)
188
189 /* Data Port Command Register */
190 #define DP_CMD                  (0x44)
191
192 /* Data Port Address Register */
193 #define DP_ADDR                 (0x48)
194
195 /* Data Port Data 0 Register */
196 #define DP_DATA0                (0x4C)
197
198 /* Data Port Data 1 Register */
199 #define DP_DATA1                (0x50)
200
201 /* General Purpose IO Wake Enable and Polarity Register */
202 #define GPIO_WAKE               (0x64)
203
204 /* Interrupt Endpoint Control Register */
205 #define INT_EP_CTL              (0x68)
206 #define INT_EP_CTL_INTEP_       (0x80000000)    /* Always TX Interrupt PKT */
207 #define INT_EP_CTL_MAC_RTO_     (0x00080000)    /* MAC Reset Time Out */
208 #define INT_EP_CTL_RX_FIFO_     (0x00040000)    /* RX FIFO Has Frame */
209 #define INT_EP_CTL_TX_STOP_     (0x00020000)    /* TX Stopped */
210 #define INT_EP_CTL_RX_STOP_     (0x00010000)    /* RX Stopped */
211 #define INT_EP_CTL_PHY_INT_     (0x00008000)    /* PHY Interrupt */
212 #define INT_EP_CTL_TXE_         (0x00004000)    /* TX Error */
213 #define INT_EP_CTL_TDFU_        (0x00002000)    /* TX Data FIFO Underrun */
214 #define INT_EP_CTL_TDFO_        (0x00001000)    /* TX Data FIFO Overrun */
215 #define INT_EP_CTL_RXDF_        (0x00000800)    /* RX Dropped Frame */
216 #define INT_EP_CTL_GPIOS_       (0x000007FF)    /* GPIOs Interrupt Enable */
217
218 /* Bulk In Delay Register (units of 16.667ns, until ~1092µs) */
219 #define BULK_IN_DLY             (0x6C)
220
221 /* MAC CSRs - MAC Control and Status Registers */
222 /* MAC Control Register */
223 #define MAC_CR                  (0x100)
224 #define MAC_CR_RXALL_           (0x80000000)    /* Receive All Mode */
225 #define MAC_CR_RCVOWN_          (0x00800000)    /* Disable Receive Own */
226 #define MAC_CR_LOOPBK_          (0x00200000)    /* Loopback Operation Mode */
227 #define MAC_CR_FDPX_            (0x00100000)    /* Full Duplex Mode */
228 #define MAC_CR_MCPAS_           (0x00080000)    /* Pass All Multicast */
229 #define MAC_CR_PRMS_            (0x00040000)    /* Promiscuous Mode */
230 #define MAC_CR_INVFILT_         (0x00020000)    /* Inverse Filtering */
231 #define MAC_CR_PASSBAD_         (0x00010000)    /* Pass Bad Frames */
232 #define MAC_CR_HFILT_           (0x00008000)    /* Hash Only Filtering Mode */
233 #define MAC_CR_HPFILT_          (0x00002000)    /* Hash/Perfect Filt. Mode */
234 #define MAC_CR_LCOLL_           (0x00001000)    /* Late Collision Control */
235 #define MAC_CR_BCAST_           (0x00000800)    /* Disable Broadcast Frames */
236 #define MAC_CR_DISRTY_          (0x00000400)    /* Disable Retry */
237 #define MAC_CR_PADSTR_          (0x00000100)    /* Automatic Pad Stripping */
238 #define MAC_CR_BOLMT_MASK       (0x000000C0)    /* BackOff Limit */
239 #define MAC_CR_DFCHK_           (0x00000020)    /* Deferral Check */
240 #define MAC_CR_TXEN_            (0x00000008)    /* Transmitter Enable */
241 #define MAC_CR_RXEN_            (0x00000004)    /* Receiver Enable */
242
243 /* MAC Address High Register */
244 #define ADDRH                   (0x104)
245
246 /* MAC Address Low Register */
247 #define ADDRL                   (0x108)
248
249 /* Multicast Hash Table High Register */
250 #define HASHH                   (0x10C)
251
252 /* Multicast Hash Table Low Register */
253 #define HASHL                   (0x110)
254
255 /* MII Access Register */
256 #define MII_ADDR                (0x114)
257 #define MII_WRITE_              (0x02)
258 #define MII_BUSY_               (0x01)
259 #define MII_READ_               (0x00) /* ~of MII Write bit */
260
261 /* MII Data Register */
262 #define MII_DATA                (0x118)
263
264 /* Flow Control Register */
265 #define FLOW                    (0x11C)
266 #define FLOW_FCPT_              (0xFFFF0000)    /* Pause Time */
267 #define FLOW_FCPASS_            (0x00000004)    /* Pass Control Frames */
268 #define FLOW_FCEN_              (0x00000002)    /* Flow Control Enable */
269 #define FLOW_FCBSY_             (0x00000001)    /* Flow Control Busy */
270
271 /* VLAN1 Tag Register */
272 #define VLAN1                   (0x120)
273
274 /* VLAN2 Tag Register */
275 #define VLAN2                   (0x124)
276
277 /* Wake Up Frame Filter Register */
278 #define WUFF                    (0x128)
279 #define LAN9500_WUFF_NUM        (4)
280 #define LAN9500A_WUFF_NUM       (8)
281
282 /* Wake Up Control and Status Register */
283 #define WUCSR                   (0x12C)
284 #define WUCSR_WFF_PTR_RST_      (0x80000000)    /* WFrame Filter Pointer Rst */
285 #define WUCSR_GUE_              (0x00000200)    /* Global Unicast Enable */
286 #define WUCSR_WUFR_             (0x00000040)    /* Wakeup Frame Received */
287 #define WUCSR_MPR_              (0x00000020)    /* Magic Packet Received */
288 #define WUCSR_WAKE_EN_          (0x00000004)    /* Wakeup Frame Enable */
289 #define WUCSR_MPEN_             (0x00000002)    /* Magic Packet Enable */
290
291 /* Checksum Offload Engine Control Register */
292 #define COE_CR                  (0x130)
293 #define Tx_COE_EN_              (0x00010000)    /* TX Csum Offload Enable */
294 #define Rx_COE_MODE_            (0x00000002)    /* RX Csum Offload Mode */
295 #define Rx_COE_EN_              (0x00000001)    /* RX Csum Offload Enable */
296
297 /* Vendor-specific PHY Definitions (via MII access) */
298 /* EDPD NLP / crossover time configuration (LAN9500A only) */
299 #define PHY_EDPD_CONFIG                 (16)
300 #define PHY_EDPD_CONFIG_TX_NLP_EN_      ((u16)0x8000)
301 #define PHY_EDPD_CONFIG_TX_NLP_1000_    ((u16)0x0000)
302 #define PHY_EDPD_CONFIG_TX_NLP_768_     ((u16)0x2000)
303 #define PHY_EDPD_CONFIG_TX_NLP_512_     ((u16)0x4000)
304 #define PHY_EDPD_CONFIG_TX_NLP_256_     ((u16)0x6000)
305 #define PHY_EDPD_CONFIG_RX_1_NLP_       ((u16)0x1000)
306 #define PHY_EDPD_CONFIG_RX_NLP_64_      ((u16)0x0000)
307 #define PHY_EDPD_CONFIG_RX_NLP_256_     ((u16)0x0400)
308 #define PHY_EDPD_CONFIG_RX_NLP_512_     ((u16)0x0800)
309 #define PHY_EDPD_CONFIG_RX_NLP_1000_    ((u16)0x0C00)
310 #define PHY_EDPD_CONFIG_EXT_CROSSOVER_  ((u16)0x0001)
311 #define PHY_EDPD_CONFIG_DEFAULT         (PHY_EDPD_CONFIG_TX_NLP_EN_ | \
312                                          PHY_EDPD_CONFIG_TX_NLP_768_ | \
313                                          PHY_EDPD_CONFIG_RX_1_NLP_)
314
315 /* Mode Control/Status Register */
316 #define PHY_MODE_CTRL_STS               (17)
317 #define MODE_CTRL_STS_EDPWRDOWN_        ((u16)0x2000)
318 #define MODE_CTRL_STS_ENERGYON_         ((u16)0x0002)
319
320 /* Control/Status Indication Register */
321 #define SPECIAL_CTRL_STS                (27)
322 #define SPECIAL_CTRL_STS_OVRRD_AMDIX_   ((u16)0x8000)
323 #define SPECIAL_CTRL_STS_AMDIX_ENABLE_  ((u16)0x4000)
324 #define SPECIAL_CTRL_STS_AMDIX_STATE_   ((u16)0x2000)
325
326 /* Interrupt Source Register */
327 #define PHY_INT_SRC                     (29)
328 #define PHY_INT_SRC_ENERGY_ON_          ((u16)0x0080)
329 #define PHY_INT_SRC_ANEG_COMP_          ((u16)0x0040)
330 #define PHY_INT_SRC_REMOTE_FAULT_       ((u16)0x0020)
331 #define PHY_INT_SRC_LINK_DOWN_          ((u16)0x0010)
332
333 /* Interrupt Mask Register */
334 #define PHY_INT_MASK                    (30)
335 #define PHY_INT_MASK_ENERGY_ON_         ((u16)0x0080)
336 #define PHY_INT_MASK_ANEG_COMP_         ((u16)0x0040)
337 #define PHY_INT_MASK_REMOTE_FAULT_      ((u16)0x0020)
338 #define PHY_INT_MASK_LINK_DOWN_         ((u16)0x0010)
339 #define PHY_INT_MASK_DEFAULT_           (PHY_INT_MASK_ANEG_COMP_ | \
340                                          PHY_INT_MASK_LINK_DOWN_)
341 /* PHY Special Control/Status Register */
342 #define PHY_SPECIAL                     (31)
343 #define PHY_SPECIAL_SPD_                ((u16)0x001C)
344 #define PHY_SPECIAL_SPD_10HALF_         ((u16)0x0004)
345 #define PHY_SPECIAL_SPD_10FULL_         ((u16)0x0014)
346 #define PHY_SPECIAL_SPD_100HALF_        ((u16)0x0008)
347 #define PHY_SPECIAL_SPD_100FULL_        ((u16)0x0018)
348
349 /* USB Vendor Requests */
350 #define USB_VENDOR_REQUEST_WRITE_REGISTER       0xA0
351 #define USB_VENDOR_REQUEST_READ_REGISTER        0xA1
352 #define USB_VENDOR_REQUEST_GET_STATS            0xA2
353
354 /* Interrupt Endpoint status word bitfields */
355 #define INT_ENP_MAC_RTO_                ((u32)BIT(18))  /* MAC Reset Time Out */
356 #define INT_ENP_TX_STOP_                ((u32)BIT(17))  /* TX Stopped */
357 #define INT_ENP_RX_STOP_                ((u32)BIT(16))  /* RX Stopped */
358 #define INT_ENP_PHY_INT_                ((u32)BIT(15))  /* PHY Interrupt */
359 #define INT_ENP_TXE_                    ((u32)BIT(14))  /* TX Error */
360 #define INT_ENP_TDFU_                   ((u32)BIT(13))  /* TX FIFO Underrun */
361 #define INT_ENP_TDFO_                   ((u32)BIT(12))  /* TX FIFO Overrun */
362 #define INT_ENP_RXDF_                   ((u32)BIT(11))  /* RX Dropped Frame */
363
364 #endif /* _SMSC95XX_H */