2 * lanstreamer.h -- driver for the IBM Auto LANStreamer PCI Adapter
4 * Written By: Mike Sullivan, IBM Corporation
6 * Copyright (C) 1999 IBM Corporation
8 * Linux driver for IBM PCI tokenring cards based on the LanStreamer MPC
11 * This driver is based on the olympic driver for IBM PCI TokenRing cards (Pit/Pit-Phy/Olympic
12 * chipsets) written by:
13 * 1999 Peter De Schrijver All Rights Reserved
14 * 1999 Mike Phillips (phillim@amtrak.com)
16 * Base Driver Skeleton:
17 * Written 1993-94 by Donald Becker.
19 * Copyright 1993 United States Government as represented by the
20 * Director, National Security Agency.
22 * This program is free software; you can redistribute it and/or modify
23 * it under the terms of the GNU General Public License as published by
24 * the Free Software Foundation; either version 2 of the License, or
25 * (at your option) any later version.
27 * This program is distributed in the hope that it will be useful,
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 * GNU General Public License for more details.
33 * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
34 * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
35 * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
36 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
37 * solely responsible for determining the appropriateness of using and
38 * distributing the Program and assumes all risks associated with its
39 * exercise of rights under this Agreement, including but not limited to
40 * the risks and costs of program errors, damage to or loss of data,
41 * programs or equipment, and unavailability or interruption of operations.
43 * DISCLAIMER OF LIABILITY
44 * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
45 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
47 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
48 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
49 * USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
50 * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
52 * You should have received a copy of the GNU General Public License
53 * along with this program; if not, write to the Free Software
54 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
57 * 12/10/99 - Alpha Release 0.1.0
58 * First release to the public
59 * 08/15/01 - Added ioctl() definitions and others - Kent Yoder <yoder1@us.ibm.com>
63 #if STREAMER_IOCTL && (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
64 #include <asm/ioctl.h>
65 #define IOCTL_PRINT_RX_BUFS SIOCDEVPRIVATE
66 #define IOCTL_PRINT_TX_BUFS SIOCDEVPRIVATE+1
67 #define IOCTL_RX_CMD SIOCDEVPRIVATE+2
68 #define IOCTL_TX_CMD SIOCDEVPRIVATE+3
69 #define IOCTL_PRINT_REGISTERS SIOCDEVPRIVATE+4
70 #define IOCTL_PRINT_BDAS SIOCDEVPRIVATE+5
71 #define IOCTL_SPIN_LOCK_TEST SIOCDEVPRIVATE+6
72 #define IOCTL_SISR_MASK SIOCDEVPRIVATE+7
75 /* MAX_INTR - the maximum number of times we can loop
76 * inside the interrupt function before returning
77 * control to the OS (maximum value is 256)
86 #define BCTL_SOFTRESET (1<<15)
87 #define BCTL_RX_FIFO_8 (1<<1)
88 #define BCTL_TX_FIFO_8 (1<<3)
91 #define GPR_AUTOSENSE (1<<2)
92 #define GPR_16MBPS (1<<3)
98 #define LISR_LIE (1<<15)
99 #define LISR_SLIM (1<<13)
100 #define LISR_SLI (1<<12)
101 #define LISR_BPEI (1<<9)
102 #define LISR_BPE (1<<8)
103 #define LISR_SRB_CMD (1<<5)
104 #define LISR_ASB_REPLY (1<<4)
105 #define LISR_ASB_FREE_REQ (1<<2)
106 #define LISR_ARB_FREE (1<<1)
107 #define LISR_TRB_FRAME (1<<0)
110 #define SISR_SUM 0x18
111 #define SISR_RUM 0x1A
112 #define SISR_MASK 0x54
113 #define SISR_MASK_SUM 0x56
114 #define SISR_MASK_RUM 0x58
116 #define SISR_MI (1<<15)
117 #define SISR_SERR_ERR (1<<14)
118 #define SISR_TIMER (1<<11)
119 #define SISR_LAP_PAR_ERR (1<<10)
120 #define SISR_LAP_ACC_ERR (1<<9)
121 #define SISR_PAR_ERR (1<<8)
122 #define SISR_ADAPTER_CHECK (1<<6)
123 #define SISR_SRB_REPLY (1<<5)
124 #define SISR_ASB_FREE (1<<4)
125 #define SISR_ARB_CMD (1<<3)
126 #define SISR_TRB_REPLY (1<<2)
128 #define MISR_RUM 0x5A
129 #define MISR_MASK 0x5C
130 #define MISR_MASK_RUM 0x5E
132 #define MISR_TX2_IDLE (1<<15)
133 #define MISR_TX2_NO_STATUS (1<<14)
134 #define MISR_TX2_HALT (1<<13)
135 #define MISR_TX2_EOF (1<<12)
136 #define MISR_TX1_IDLE (1<<11)
137 #define MISR_TX1_NO_STATUS (1<<10)
138 #define MISR_TX1_HALT (1<<9)
139 #define MISR_TX1_EOF (1<<8)
140 #define MISR_RX_NOBUF (1<<5)
141 #define MISR_RX_EOB (1<<4)
142 #define MISR_RX_NO_STATUS (1<<2)
143 #define MISR_RX_HALT (1<<1)
144 #define MISR_RX_EOF (1<<0)
156 #define BMCTL_SUM 0x50
157 #define BMCTL_RUM 0x52
158 #define BMCTL_TX1_DIS (1<<14)
159 #define BMCTL_TX2_DIS (1<<10)
160 #define BMCTL_RX_DIS (1<<6)
161 #define BMCTL_RX_ENABLED (1<<5)
177 #define STREAMER_IO_SPACE 256
179 #define SRB_COMMAND_SIZE 50
181 #define STREAMER_MAX_ADAPTERS 8 /* 0x08 __MODULE_STRING can't hand 0xnn */
183 /* Defines for LAN STATUS CHANGE reports */
184 #define LSC_SIG_LOSS 0x8000
185 #define LSC_HARD_ERR 0x4000
186 #define LSC_SOFT_ERR 0x2000
187 #define LSC_TRAN_BCN 0x1000
188 #define LSC_LWF 0x0800
189 #define LSC_ARW 0x0400
190 #define LSC_FPE 0x0200
191 #define LSC_RR 0x0100
192 #define LSC_CO 0x0080
193 #define LSC_SS 0x0040
194 #define LSC_RING_REC 0x0020
195 #define LSC_SR_CO 0x0010
196 #define LSC_FDX_MODE 0x0004
198 /* Defines for OPEN ADAPTER command */
200 #define OPEN_ADAPTER_EXT_WRAP (1<<15)
201 #define OPEN_ADAPTER_DIS_HARDEE (1<<14)
202 #define OPEN_ADAPTER_DIS_SOFTERR (1<<13)
203 #define OPEN_ADAPTER_PASS_ADC_MAC (1<<12)
204 #define OPEN_ADAPTER_PASS_ATT_MAC (1<<11)
205 #define OPEN_ADAPTER_ENABLE_EC (1<<10)
206 #define OPEN_ADAPTER_CONTENDER (1<<8)
207 #define OPEN_ADAPTER_PASS_BEACON (1<<7)
208 #define OPEN_ADAPTER_ENABLE_FDX (1<<6)
209 #define OPEN_ADAPTER_ENABLE_RPL (1<<5)
210 #define OPEN_ADAPTER_INHIBIT_ETR (1<<4)
211 #define OPEN_ADAPTER_INTERNAL_WRAP (1<<3)
214 /* Defines for SRB Commands */
215 #define SRB_CLOSE_ADAPTER 0x04
216 #define SRB_CONFIGURE_BRIDGE 0x0c
217 #define SRB_CONFIGURE_HP_CHANNEL 0x13
218 #define SRB_MODIFY_BRIDGE_PARMS 0x15
219 #define SRB_MODIFY_OPEN_OPTIONS 0x01
220 #define SRB_MODIFY_RECEIVE_OPTIONS 0x17
221 #define SRB_NO_OPERATION 0x00
222 #define SRB_OPEN_ADAPTER 0x03
223 #define SRB_READ_LOG 0x08
224 #define SRB_READ_SR_COUNTERS 0x16
225 #define SRB_RESET_GROUP_ADDRESS 0x02
226 #define SRB_RESET_TARGET_SEGMETN 0x14
227 #define SRB_SAVE_CONFIGURATION 0x1b
228 #define SRB_SET_BRIDGE_PARMS 0x09
229 #define SRB_SET_FUNC_ADDRESS 0x07
230 #define SRB_SET_GROUP_ADDRESS 0x06
231 #define SRB_SET_TARGET_SEGMENT 0x05
233 /* Clear return code */
234 #define STREAMER_CLEAR_RET_CODE 0xfe
237 #define ARB_RECEIVE_DATA 0x81
238 #define ARB_LAN_CHANGE_STATUS 0x84
240 /* ASB Response commands */
241 #define ASB_RECEIVE_DATA 0x81
244 /* Streamer defaults for buffers */
246 #define STREAMER_RX_RING_SIZE 16 /* should be a power of 2 */
247 /* Setting the number of TX descriptors to 1 is a workaround for an
248 * undocumented hardware problem with the lanstreamer board. Setting
249 * this to something higher may slightly increase the throughput you
250 * can get from the card, but at the risk of locking up the box. -
251 * <yoder1@us.ibm.com>
253 #define STREAMER_TX_RING_SIZE 1 /* should be a power of 2 */
255 #define PKT_BUF_SZ 4096 /* Default packet size */
257 /* Streamer data structures */
259 struct streamer_tx_desc {
262 __u32 bufcnt_framelen;
270 struct streamer_rx_desc {
274 __u32 framelen_buflen;
277 struct mac_receive_buffer {
285 struct streamer_private {
292 struct streamer_private *next;
293 struct pci_dev *pci_dev;
295 char *streamer_card_name;
297 spinlock_t streamer_lock;
299 volatile int srb_queued; /* True if an SRB is still posted */
300 wait_queue_head_t srb_wait;
302 volatile int asb_queued; /* True if an ASB is posted */
304 volatile int trb_queued; /* True if a TRB is posted */
305 wait_queue_head_t trb_wait;
307 struct streamer_rx_desc *streamer_rx_ring;
308 struct streamer_tx_desc *streamer_tx_ring;
309 struct sk_buff *tx_ring_skb[STREAMER_TX_RING_SIZE],
310 *rx_ring_skb[STREAMER_RX_RING_SIZE];
311 int tx_ring_free, tx_ring_last_status, rx_ring_last_received,
312 free_tx_ring_entries;
314 struct net_device_stats streamer_stats;
315 __u16 streamer_lan_status;
316 __u8 streamer_ring_speed;
318 __u8 streamer_receive_options, streamer_copy_all_options,
319 streamer_message_level;
320 __u16 streamer_addr_table_addr, streamer_parms_addr;
322 __u8 streamer_laa[6];
325 struct streamer_adapter_addr_table {
332 struct streamer_parameters_table {
335 __u8 up_node_addr[6];
336 __u8 up_phys_addr[4];
340 __u16 auth_source_class;
346 __u16 soft_error_time;
350 __u16 beacon_transmit;
351 __u16 beacon_receive;