Linux kernel & device driver programming

Cross-Referenced Linux and Device Driver Code

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ]
Version: [ 2.6.11.8 ] [ 2.6.25 ] [ 2.6.25.8 ] [ 2.6.31.13 ] Architecture: [ i386 ]
  1 /*
  2  *   lanstreamer.h -- driver for the IBM Auto LANStreamer PCI Adapter
  3  *
  4  *  Written By: Mike Sullivan, IBM Corporation
  5  *
  6  *  Copyright (C) 1999 IBM Corporation
  7  *
  8  *  Linux driver for IBM PCI tokenring cards based on the LanStreamer MPC
  9  *  chipset. 
 10  *
 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)
 15  *
 16  *  Base Driver Skeleton:
 17  *      Written 1993-94 by Donald Becker.
 18  *
 19  *      Copyright 1993 United States Government as represented by the
 20  *      Director, National Security Agency.
 21  *
 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.                                       
 26  *                                                                           
 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.                              
 31  *                                                                           
 32  * NO WARRANTY                                                               
 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.  
 42  *                                                                           
 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             
 51  *                                                                           
 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 
 55  *                                                                           
 56  * 
 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>
 60  *
 61  */
 62 
 63 #include <linux/version.h>
 64 
 65 #if STREAMER_IOCTL && (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 66 #include <asm/ioctl.h>
 67 #define IOCTL_PRINT_RX_BUFS   SIOCDEVPRIVATE
 68 #define IOCTL_PRINT_TX_BUFS   SIOCDEVPRIVATE+1
 69 #define IOCTL_RX_CMD          SIOCDEVPRIVATE+2
 70 #define IOCTL_TX_CMD          SIOCDEVPRIVATE+3
 71 #define IOCTL_PRINT_REGISTERS SIOCDEVPRIVATE+4
 72 #define IOCTL_PRINT_BDAS      SIOCDEVPRIVATE+5
 73 #define IOCTL_SPIN_LOCK_TEST  SIOCDEVPRIVATE+6
 74 #define IOCTL_SISR_MASK       SIOCDEVPRIVATE+7
 75 #endif
 76 
 77 /* MAX_INTR - the maximum number of times we can loop
 78  * inside the interrupt function before returning
 79  * control to the OS (maximum value is 256)
 80  */
 81 #define MAX_INTR 5
 82 
 83 #define CLS 0x0C
 84 #define MLR 0x86
 85 #define LTR 0x0D
 86 
 87 #define BCTL 0x60
 88 #define BCTL_SOFTRESET (1<<15)
 89 #define BCTL_RX_FIFO_8 (1<<1)
 90 #define BCTL_TX_FIFO_8 (1<<3)
 91 
 92 #define GPR 0x4a
 93 #define GPR_AUTOSENSE (1<<2)
 94 #define GPR_16MBPS (1<<3)
 95 
 96 #define LISR 0x10
 97 #define LISR_SUM 0x12
 98 #define LISR_RUM 0x14
 99 
100 #define LISR_LIE (1<<15)
101 #define LISR_SLIM (1<<13)
102 #define LISR_SLI (1<<12)
103 #define LISR_BPEI (1<<9)
104 #define LISR_BPE (1<<8)
105 #define LISR_SRB_CMD (1<<5)
106 #define LISR_ASB_REPLY (1<<4)
107 #define LISR_ASB_FREE_REQ (1<<2)
108 #define LISR_ARB_FREE (1<<1)
109 #define LISR_TRB_FRAME (1<<0)
110 
111 #define SISR 0x16
112 #define SISR_SUM 0x18
113 #define SISR_RUM 0x1A
114 #define SISR_MASK 0x54
115 #define SISR_MASK_SUM 0x56
116 #define SISR_MASK_RUM 0x58
117 
118 #define SISR_MI (1<<15)
119 #define SISR_SERR_ERR (1<<14)
120 #define SISR_TIMER (1<<11)
121 #define SISR_LAP_PAR_ERR (1<<10)
122 #define SISR_LAP_ACC_ERR (1<<9)
123 #define SISR_PAR_ERR (1<<8)
124 #define SISR_ADAPTER_CHECK (1<<6)
125 #define SISR_SRB_REPLY (1<<5)
126 #define SISR_ASB_FREE (1<<4)
127 #define SISR_ARB_CMD (1<<3)
128 #define SISR_TRB_REPLY (1<<2)
129 
130 #define MISR_RUM 0x5A
131 #define MISR_MASK 0x5C
132 #define MISR_MASK_RUM 0x5E
133 
134 #define MISR_TX2_IDLE (1<<15)
135 #define MISR_TX2_NO_STATUS (1<<14)
136 #define MISR_TX2_HALT (1<<13)
137 #define MISR_TX2_EOF (1<<12)
138 #define MISR_TX1_IDLE (1<<11)
139 #define MISR_TX1_NO_STATUS (1<<10)
140 #define MISR_TX1_HALT (1<<9)
141 #define MISR_TX1_EOF (1<<8)
142 #define MISR_RX_NOBUF (1<<5)
143 #define MISR_RX_EOB (1<<4)
144 #define MISR_RX_NO_STATUS (1<<2)
145 #define MISR_RX_HALT (1<<1)
146 #define MISR_RX_EOF (1<<0)
147 
148 #define LAPA 0x62
149 #define LAPE 0x64
150 #define LAPD 0x66
151 #define LAPDINC 0x68
152 #define LAPWWO 0x6A
153 #define LAPWWC 0x6C
154 #define LAPCTL 0x6E
155 
156 #define TIMER 0x4E4
157 
158 #define BMCTL_SUM 0x50
159 #define BMCTL_RUM 0x52
160 #define BMCTL_TX1_DIS (1<<14)
161 #define BMCTL_TX2_DIS (1<<10)
162 #define BMCTL_RX_DIS (1<<6)
163 #define BMCTL_RX_ENABLED  (1<<5)
164 
165 #define RXLBDA  0x90
166 #define RXBDA   0x94
167 #define RXSTAT  0x98
168 #define RXDBA   0x9C
169 
170 #define TX1LFDA 0xA0
171 #define TX1FDA  0xA4
172 #define TX1STAT 0xA8
173 #define TX1DBA  0xAC
174 #define TX2LFDA 0xB0
175 #define TX2FDA  0xB4
176 #define TX2STAT 0xB8
177 #define TX2DBA  0xBC
178 
179 #define STREAMER_IO_SPACE 256
180 
181 #define SRB_COMMAND_SIZE 50
182 
183 #define STREAMER_MAX_ADAPTERS 8 /* 0x08 __MODULE_STRING can't hand 0xnn */
184 
185 /* Defines for LAN STATUS CHANGE reports */
186 #define LSC_SIG_LOSS 0x8000
187 #define LSC_HARD_ERR 0x4000
188 #define LSC_SOFT_ERR 0x2000
189 #define LSC_TRAN_BCN 0x1000
190 #define LSC_LWF      0x0800
191 #define LSC_ARW      0x0400
192 #define LSC_FPE      0x0200
193 #define LSC_RR       0x0100
194 #define LSC_CO       0x0080
195 #define LSC_SS       0x0040
196 #define LSC_RING_REC 0x0020
197 #define LSC_SR_CO    0x0010
198 #define LSC_FDX_MODE 0x0004
199 
200 /* Defines for OPEN ADAPTER command */
201 
202 #define OPEN_ADAPTER_EXT_WRAP (1<<15)
203 #define OPEN_ADAPTER_DIS_HARDEE (1<<14)
204 #define OPEN_ADAPTER_DIS_SOFTERR (1<<13)
205 #define OPEN_ADAPTER_PASS_ADC_MAC (1<<12)
206 #define OPEN_ADAPTER_PASS_ATT_MAC (1<<11)
207 #define OPEN_ADAPTER_ENABLE_EC (1<<10)
208 #define OPEN_ADAPTER_CONTENDER (1<<8)
209 #define OPEN_ADAPTER_PASS_BEACON (1<<7)
210 #define OPEN_ADAPTER_ENABLE_FDX (1<<6)
211 #define OPEN_ADAPTER_ENABLE_RPL (1<<5)
212 #define OPEN_ADAPTER_INHIBIT_ETR (1<<4)
213 #define OPEN_ADAPTER_INTERNAL_WRAP (1<<3)
214 
215 
216 /* Defines for SRB Commands */
217 #define SRB_CLOSE_ADAPTER 0x04
218 #define SRB_CONFIGURE_BRIDGE 0x0c
219 #define SRB_CONFIGURE_HP_CHANNEL 0x13
220 #define SRB_MODIFY_BRIDGE_PARMS 0x15
221 #define SRB_MODIFY_OPEN_OPTIONS 0x01
222 #define SRB_MODIFY_RECEIVE_OPTIONS 0x17
223 #define SRB_NO_OPERATION 0x00
224 #define SRB_OPEN_ADAPTER 0x03
225 #define SRB_READ_LOG 0x08
226 #define SRB_READ_SR_COUNTERS 0x16
227 #define SRB_RESET_GROUP_ADDRESS 0x02
228 #define SRB_RESET_TARGET_SEGMETN 0x14
229 #define SRB_SAVE_CONFIGURATION 0x1b
230 #define SRB_SET_BRIDGE_PARMS 0x09
231 #define SRB_SET_FUNC_ADDRESS 0x07
232 #define SRB_SET_GROUP_ADDRESS 0x06
233 #define SRB_SET_TARGET_SEGMENT 0x05
234 
235 /* Clear return code */
236 #define STREAMER_CLEAR_RET_CODE 0xfe
237 
238 /* ARB Commands */
239 #define ARB_RECEIVE_DATA 0x81
240 #define ARB_LAN_CHANGE_STATUS 0x84
241 
242 /* ASB Response commands */
243 #define ASB_RECEIVE_DATA 0x81
244 
245 
246 /* Streamer defaults for buffers */
247 
248 #define STREAMER_RX_RING_SIZE 16        /* should be a power of 2 */
249 /* Setting the number of TX descriptors to 1 is a workaround for an
250  * undocumented hardware problem with the lanstreamer board. Setting
251  * this to something higher may slightly increase the throughput you
252  * can get from the card, but at the risk of locking up the box. - 
253  * <yoder1@us.ibm.com>
254  */
255 #define STREAMER_TX_RING_SIZE 1 /* should be a power of 2 */
256 
257 #define PKT_BUF_SZ 4096         /* Default packet size */
258 
259 /* Streamer data structures */
260 
261 struct streamer_tx_desc {
262         __u32 forward;
263         __u32 status;
264         __u32 bufcnt_framelen;
265         __u32 buffer;
266         __u32 buflen;
267         __u32 rsvd1;
268         __u32 rsvd2;
269         __u32 rsvd3;
270 };
271 
272 struct streamer_rx_desc {
273         __u32 forward;
274         __u32 status;
275         __u32 buffer;
276         __u32 framelen_buflen;
277 };
278 
279 struct mac_receive_buffer {
280         __u16 next;
281         __u8 padding;
282         __u8 frame_status;
283         __u16 buffer_length;
284         __u8 frame_data;
285 };
286 
287 struct streamer_private {
288 
289         __u16 srb;
290         __u16 trb;
291         __u16 arb;
292         __u16 asb;
293 
294         struct streamer_private *next;
295         struct pci_dev *pci_dev;
296         __u8 __iomem *streamer_mmio;
297         char *streamer_card_name;
298  
299         spinlock_t streamer_lock;
300 
301         volatile int srb_queued;        /* True if an SRB is still posted */
302         wait_queue_head_t srb_wait;
303 
304         volatile int asb_queued;        /* True if an ASB is posted */
305 
306         volatile int trb_queued;        /* True if a TRB is posted */
307         wait_queue_head_t trb_wait;
308 
309         struct streamer_rx_desc *streamer_rx_ring;
310         struct streamer_tx_desc *streamer_tx_ring;
311         struct sk_buff *tx_ring_skb[STREAMER_TX_RING_SIZE],
312             *rx_ring_skb[STREAMER_RX_RING_SIZE];
313         int tx_ring_free, tx_ring_last_status, rx_ring_last_received,
314             free_tx_ring_entries;
315 
316         struct net_device_stats streamer_stats;
317         __u16 streamer_lan_status;
318         __u8 streamer_ring_speed;
319         __u16 pkt_buf_sz;
320         __u8 streamer_receive_options, streamer_copy_all_options,
321             streamer_message_level;
322         __u16 streamer_addr_table_addr, streamer_parms_addr;
323         __u16 mac_rx_buffer;
324         __u8 streamer_laa[6];
325 };
326 
327 struct streamer_adapter_addr_table {
328 
329         __u8 node_addr[6];
330         __u8 reserved[4];
331         __u8 func_addr[4];
332 };
333 
334 struct streamer_parameters_table {
335 
336         __u8 phys_addr[4];
337         __u8 up_node_addr[6];
338         __u8 up_phys_addr[4];
339         __u8 poll_addr[6];
340         __u16 reserved;
341         __u16 acc_priority;
342         __u16 auth_source_class;
343         __u16 att_code;
344         __u8 source_addr[6];
345         __u16 beacon_type;
346         __u16 major_vector;
347         __u16 lan_status;
348         __u16 soft_error_time;
349         __u16 reserved1;
350         __u16 local_ring;
351         __u16 mon_error;
352         __u16 beacon_transmit;
353         __u16 beacon_receive;
354         __u16 frame_correl;
355         __u8 beacon_naun[6];
356         __u32 reserved2;
357         __u8 beacon_phys[4];
358 };
359 
  This page was automatically generated by the LXR engine.