v2.4.8 -> v2.4.8.1
[opensuse:kernel.git] / drivers / net / wan / sdla_ft1.c
1 /*****************************************************************************
2 * sdla_chdlc.c  WANPIPE(tm) Multiprotocol WAN Link Driver. Cisco HDLC module.
3 *
4 * Authors:      Nenad Corbic <ncorbic@sangoma.com>
5 *               Gideon Hack  
6 *
7 * Copyright:    (c) 1995-1999 Sangoma Technologies Inc.
8 *
9 *               This program is free software; you can redistribute it and/or
10 *               modify it under the terms of the GNU General Public License
11 *               as published by the Free Software Foundation; either version
12 *               2 of the License, or (at your option) any later version.
13 * ============================================================================
14 * Sep 30, 1999  Nenad Corbic    Fixed dynamic IP and route setup.
15 * Sep 23, 1999  Nenad Corbic    Added SMP support, fixed tracing 
16 * Sep 13, 1999  Nenad Corbic    Split up Port 0 and 1 into separate devices.
17 * Jun 02, 1999  Gideon Hack     Added support for the S514 adapter.
18 * Oct 30, 1998  Jaspreet Singh  Added Support for CHDLC API (HDLC STREAMING).
19 * Oct 28, 1998  Jaspreet Singh  Added Support for Dual Port CHDLC.
20 * Aug 07, 1998  David Fong      Initial version.
21 *****************************************************************************/
22
23 #include <linux/version.h>
24 #include <linux/kernel.h>       /* printk(), and other useful stuff */
25 #include <linux/stddef.h>       /* offsetof(), etc. */
26 #include <linux/errno.h>        /* return codes */
27 #include <linux/string.h>       /* inline memset(), etc. */
28 #include <linux/slab.h> /* kmalloc(), kfree() */
29 #include <linux/wanrouter.h>    /* WAN router definitions */
30 #include <linux/wanpipe.h>      /* WANPIPE common user API definitions */
31 #include <linux/if_arp.h>       /* ARPHRD_* defines */
32
33 #if defined(LINUX_2_4)
34   #include <linux/inetdevice.h>
35   #include <asm/uaccess.h>
36
37 #elif defined(LINUX_2_1)
38   #include <linux/inetdevice.h>
39   #include <asm/uaccess.h>
40
41 #else
42   #include <net/route.h>          /* Adding new route entries */
43   #include <asm/segment.h>
44   #define test_and_set_bit set_bit
45 #endif
46
47 #include <linux/in.h>           /* sockaddr_in */
48 #include <linux/inet.h> 
49 #include <linux/if.h>
50 #include <asm/byteorder.h>      /* htons(), etc. */
51 #include <linux/sdlapci.h>
52 #include <asm/io.h>
53
54 #include <linux/sdla_chdlc.h>           /* CHDLC firmware API definitions */
55
56 /****** Defines & Macros ****************************************************/
57
58 /* reasons for enabling the timer interrupt on the adapter */
59 #define TMR_INT_ENABLED_UDP     0x0001
60 #define TMR_INT_ENABLED_UPDATE  0x0002
61  
62 #define CHDLC_DFLT_DATA_LEN     1500            /* default MTU */
63 #define CHDLC_HDR_LEN           1
64
65 #define IFF_POINTTOPOINT 0x10
66
67 #define WANPIPE 0x00
68 #define API     0x01
69 #define CHDLC_API 0x01
70
71 #define PORT(x)   (x == 0 ? "PRIMARY" : "SECONDARY" )
72
73  
74 /******Data Structures*****************************************************/
75
76 /* This structure is placed in the private data area of the device structure.
77  * The card structure used to occupy the private area but now the following 
78  * structure will incorporate the card structure along with CHDLC specific data
79  */
80
81 typedef struct chdlc_private_area
82 {
83         netdevice_t     *slave;
84         sdla_t          *card;
85         int             TracingEnabled;         /* For enabling Tracing */
86         unsigned long   curr_trace_addr;        /* Used for Tracing */
87         unsigned long   start_trace_addr;
88         unsigned long   end_trace_addr;
89         unsigned long   base_addr_trace_buffer;
90         unsigned long   end_addr_trace_buffer;
91         unsigned short  number_trace_elements;
92         unsigned        available_buffer_space;
93         unsigned long   router_start_time;
94         unsigned char   route_status;
95         unsigned char   route_removed;
96         unsigned long   tick_counter;           /* For 5s timeout counter */
97         unsigned long   router_up_time;
98         u32             IP_address;             /* IP addressing */
99         u32             IP_netmask;
100         unsigned char  mc;                      /* Mulitcast support on/off */
101         unsigned short udp_pkt_lgth;            /* udp packet processing */
102         char udp_pkt_src;
103         char udp_pkt_data[MAX_LGTH_UDP_MGNT_PKT];
104         unsigned short timer_int_enabled;
105         char update_comms_stats;                /* updating comms stats */
106         //FIXME: add driver stats as per frame relay!
107
108 } chdlc_private_area_t;
109
110 /* Route Status options */
111 #define NO_ROUTE        0x00
112 #define ADD_ROUTE       0x01
113 #define ROUTE_ADDED     0x02
114 #define REMOVE_ROUTE    0x03
115
116
117 /****** Function Prototypes *************************************************/
118 /* WAN link driver entry points. These are called by the WAN router module. */
119 static int wpft1_exec (struct sdla *card, void *u_cmd, void *u_data);
120 static int chdlc_read_version (sdla_t* card, char* str);
121 static int chdlc_error (sdla_t *card, int err, CHDLC_MAILBOX_STRUCT *mb);
122
123 /****** Public Functions ****************************************************/
124
125 /*============================================================================
126  * Cisco HDLC protocol initialization routine.
127  *
128  * This routine is called by the main WANPIPE module during setup.  At this
129  * point adapter is completely initialized and firmware is running.
130  *  o read firmware version (to make sure it's alive)
131  *  o configure adapter
132  *  o initialize protocol-specific fields of the adapter data space.
133  *
134  * Return:      0       o.k.
135  *              < 0     failure.
136  */
137 int wpft1_init (sdla_t* card, wandev_conf_t* conf)
138 {
139         unsigned char port_num;
140         int err;
141
142         union
143                 {
144                 char str[80];
145                 } u;
146         volatile CHDLC_MAILBOX_STRUCT* mb;
147         CHDLC_MAILBOX_STRUCT* mb1;
148         unsigned long timeout;
149
150         /* Verify configuration ID */
151         if (conf->config_id != WANCONFIG_CHDLC) {
152                 printk(KERN_INFO "%s: invalid configuration ID %u!\n",
153                                   card->devname, conf->config_id);
154                 return -EINVAL;
155         }
156
157         /* Use primary port */
158         card->u.c.comm_port = 0;
159         
160
161         /* Initialize protocol-specific fields */
162         if(card->hw.type != SDLA_S514){
163                 card->mbox  = (void *) card->hw.dpmbase;
164         }else{ 
165                 card->mbox = (void *) card->hw.dpmbase + PRI_BASE_ADDR_MB_STRUCT;
166         }
167
168         mb = mb1 = card->mbox;
169
170         if (!card->configured){
171
172                 /* The board will place an 'I' in the return code to indicate that it is
173                 ready to accept commands.  We expect this to be completed in less
174                 than 1 second. */
175
176                 timeout = jiffies;
177                 while (mb->return_code != 'I')  /* Wait 1s for board to initialize */
178                         if ((jiffies - timeout) > 1*HZ) break;
179
180                 if (mb->return_code != 'I') {
181                         printk(KERN_INFO
182                                 "%s: Initialization not completed by adapter\n",
183                                 card->devname);
184                         printk(KERN_INFO "Please contact Sangoma representative.\n");
185                         return -EIO;
186                 }
187         }
188
189         /* Read firmware version.  Note that when adapter initializes, it
190          * clears the mailbox, so it may appear that the first command was
191          * executed successfully when in fact it was merely erased. To work
192          * around this, we execute the first command twice.
193          */
194
195         if (chdlc_read_version(card, u.str))
196                 return -EIO;
197
198         printk(KERN_INFO "%s: Running FT1 Configuration firmware v%s\n",
199                 card->devname, u.str); 
200
201         card->isr                       = NULL;
202         card->poll                      = NULL;
203         card->exec                      = &wpft1_exec;
204         card->wandev.update             = NULL;
205         card->wandev.new_if             = NULL;
206         card->wandev.del_if             = NULL;
207         card->wandev.state              = WAN_DUALPORT;
208         card->wandev.udp_port           = conf->udp_port;
209
210         card->wandev.new_if_cnt = 0;
211
212         /* This is for the ports link state */
213         card->u.c.state = WAN_DISCONNECTED;
214         
215         /* reset the number of times the 'update()' proc has been called */
216         card->u.c.update_call_count = 0;
217         
218         card->wandev.ttl = 0x7F;
219         card->wandev.interface = 0; 
220
221         card->wandev.clocking = 0;
222
223         port_num = card->u.c.comm_port;
224
225         /* Setup Port Bps */
226
227         card->wandev.bps = 0;
228
229         card->wandev.mtu = MIN_LGTH_CHDLC_DATA_CFG;
230
231         /* Set up the interrupt status area */
232         /* Read the CHDLC Configuration and obtain: 
233          *      Ptr to shared memory infor struct
234          * Use this pointer to calculate the value of card->u.c.flags !
235          */
236         mb1->buffer_length = 0;
237         mb1->command = READ_CHDLC_CONFIGURATION;
238         err = sdla_exec(mb1) ? mb1->return_code : CMD_TIMEOUT;
239         if(err != COMMAND_OK) {
240                 chdlc_error(card, err, mb1);
241                 return -EIO;
242         }
243
244         if(card->hw.type == SDLA_S514){
245                 card->u.c.flags = (void *)(card->hw.dpmbase +
246                         (((CHDLC_CONFIGURATION_STRUCT *)mb1->data)->
247                         ptr_shared_mem_info_struct));
248         }else{
249                 card->u.c.flags = (void *)(card->hw.dpmbase +
250                         (((CHDLC_CONFIGURATION_STRUCT *)mb1->data)->
251                         ptr_shared_mem_info_struct % SDLA_WINDOWSIZE));
252         }
253
254         card->wandev.state = WAN_FT1_READY;
255         printk(KERN_INFO "%s: FT1 Config Ready !\n",card->devname);
256
257         return 0;
258 }
259
260 static int wpft1_exec(sdla_t *card, void *u_cmd, void *u_data)
261 {
262         CHDLC_MAILBOX_STRUCT* mbox = card->mbox;
263         int len;
264
265         
266 #if defined(LINUX_2_1) || defined(LINUX_2_4)
267         if (copy_from_user((void*)&mbox->command, u_cmd, sizeof(ft1_exec_cmd_t))){
268                 return -EFAULT;
269         }
270
271         len = mbox->buffer_length;
272
273         if (len) {
274                 if( copy_from_user((void*)&mbox->data, u_data, len)){
275                         return -EFAULT;
276                 }
277         }
278
279         /* execute command */
280         if (!sdla_exec(mbox)){
281                 return -EIO;
282         }
283
284         /* return result */
285         if( copy_to_user(u_cmd, (void*)&mbox->command, sizeof(ft1_exec_cmd_t))){
286                 return -EFAULT;
287         }
288
289         len = mbox->buffer_length;
290
291         if (len && u_data && copy_to_user(u_data, (void*)&mbox->data, len)){
292                 return -EFAULT;
293         }
294
295 #else
296
297         if (!u_cmd || verify_area(VERIFY_WRITE, u_cmd, sizeof(ft1_exec_cmd_t))){
298                 return -EFAULT;
299         }
300
301         memcpy_fromfs((void*)&mbox->command, u_cmd, sizeof(ft1_exec_cmd_t));
302
303         len = mbox->buffer_length;
304
305         if (len) {
306                 if (!u_data || verify_area(VERIFY_READ, u_data, len))
307                         return -EFAULT;
308                 memcpy_fromfs((void*)&mbox->data, u_data, len);
309         }
310
311         /* execute command */
312         if (!sdla_exec(mbox))
313                 return -EIO;
314
315         /* return result */
316         memcpy_tofs(u_cmd, (void*)&mbox->command, sizeof(ft1_exec_cmd_t));
317         len = mbox->buffer_length;
318
319         if (len && u_data && !verify_area(VERIFY_WRITE, u_data, len)){
320                 memcpy_tofs(u_data, (void*)&mbox->data, len);
321         }
322
323 #endif
324
325         return 0;
326
327 }
328
329 /*============================================================================
330  * Read firmware code version.
331  *      Put code version as ASCII string in str. 
332  */
333 static int chdlc_read_version (sdla_t* card, char* str)
334 {
335         CHDLC_MAILBOX_STRUCT* mb = card->mbox;
336         int len;
337         char err;
338         mb->buffer_length = 0;
339         mb->command = READ_CHDLC_CODE_VERSION;
340         err = sdla_exec(mb) ? mb->return_code : CMD_TIMEOUT;
341
342         if(err != COMMAND_OK) {
343                 chdlc_error(card,err,mb);
344         }
345         else if (str) {  /* is not null */
346                 len = mb->buffer_length;
347                 memcpy(str, mb->data, len);
348                 str[len] = '\0';
349         }
350         return (err);
351 }
352
353 /*============================================================================
354  * Firmware error handler.
355  *      This routine is called whenever firmware command returns non-zero
356  *      return code.
357  *
358  * Return zero if previous command has to be cancelled.
359  */
360 static int chdlc_error (sdla_t *card, int err, CHDLC_MAILBOX_STRUCT *mb)
361 {
362         unsigned cmd = mb->command;
363
364         switch (err) {
365
366         case CMD_TIMEOUT:
367                 printk(KERN_ERR "%s: command 0x%02X timed out!\n",
368                         card->devname, cmd);
369                 break;
370
371         case S514_BOTH_PORTS_SAME_CLK_MODE:
372                 if(cmd == SET_CHDLC_CONFIGURATION) {
373                         printk(KERN_INFO
374                          "%s: Configure both ports for the same clock source\n",
375                                 card->devname);
376                         break;
377                 }
378
379         default:
380                 printk(KERN_INFO "%s: command 0x%02X returned 0x%02X!\n",
381                         card->devname, cmd, err);
382         }
383
384         return 0;
385 }
386