1 //---------------------------------------------------------------------------
2 // FT1000 driver for Flarion Flash OFDM NIC Device
4 // Copyright (C) 2006 Flarion Technologies, All rights reserved.
6 // This program is free software; you can redistribute it and/or modify it
7 // under the terms of the GNU General Public License as published by the Free
8 // Software Foundation; either version 2 of the License, or (at your option) any
9 // later version. This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11 // or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 // more details. You should have received a copy of the GNU General Public
13 // License along with this program; if not, write to the
14 // Free Software Foundation, Inc., 59 Temple Place -
15 // Suite 330, Boston, MA 02111-1307, USA.
16 //---------------------------------------------------------------------------
18 // File: ft1000_chdev.c
20 // Description: Custom character device dispatch routines.
23 // 8/29/02 Whc Ported to Linux.
24 // 6/05/06 Whc Porting to Linux 2.6.9
26 //---------------------------------------------------------------------------
27 #include <linux/module.h>
28 #include <linux/kernel.h>
29 #include <linux/sched.h>
30 #include <linux/errno.h>
31 #include <linux/poll.h>
32 #include <linux/netdevice.h>
33 #include <linux/delay.h>
35 #include <linux/ioctl.h>
36 #include <linux/debugfs.h>
37 #include "ft1000_usb.h"
39 static int ft1000_flarion_cnt = 0;
41 static int ft1000_open (struct inode *inode, struct file *file);
42 static unsigned int ft1000_poll_dev(struct file *file, poll_table *wait);
43 static long ft1000_ioctl(struct file *file, unsigned int command,
44 unsigned long argument);
45 static int ft1000_release (struct inode *inode, struct file *file);
47 // List to free receive command buffer pool
48 struct list_head freercvpool;
50 // lock to arbitrate free buffer list for receive command data
51 spinlock_t free_buff_lock;
56 // Table of entry-point routines for char device
58 static const struct file_operations ft1000fops =
60 .unlocked_ioctl = ft1000_ioctl,
61 .poll = ft1000_poll_dev,
63 .release = ft1000_release,
67 //---------------------------------------------------------------------------
68 // Function: ft1000_get_buffer
78 //---------------------------------------------------------------------------
79 struct dpram_blk *ft1000_get_buffer(struct list_head *bufflist)
82 struct dpram_blk *ptr;
84 spin_lock_irqsave(&free_buff_lock, flags);
85 // Check if buffer is available
86 if ( list_empty(bufflist) ) {
87 DEBUG("ft1000_get_buffer: No more buffer - %d\n", numofmsgbuf);
92 ptr = list_entry(bufflist->next, struct dpram_blk, list);
94 //DEBUG("ft1000_get_buffer: number of free msg buffers = %d\n", numofmsgbuf);
96 spin_unlock_irqrestore(&free_buff_lock, flags);
104 //---------------------------------------------------------------------------
105 // Function: ft1000_free_buffer
115 //---------------------------------------------------------------------------
116 void ft1000_free_buffer(struct dpram_blk *pdpram_blk, struct list_head *plist)
120 spin_lock_irqsave(&free_buff_lock, flags);
121 // Put memory back to list
122 list_add_tail(&pdpram_blk->list, plist);
124 //DEBUG("ft1000_free_buffer: number of free msg buffers = %d\n", numofmsgbuf);
125 spin_unlock_irqrestore(&free_buff_lock, flags);
128 //---------------------------------------------------------------------------
129 // Function: ft1000_CreateDevice
131 // Parameters: dev - pointer to adapter object
133 // Returns: 0 if successful
135 // Description: Creates a private char device.
137 // Notes: Only called by init_module().
139 //---------------------------------------------------------------------------
140 int ft1000_create_dev(struct ft1000_usb *dev)
144 struct dentry *dir, *file;
145 struct ft1000_debug_dirs *tmp;
147 // make a new device name
148 sprintf(dev->DeviceName, "%s%d", "FT1000_", dev->CardNumber);
150 DEBUG("%s: number of instance = %d\n", __func__, ft1000_flarion_cnt);
151 DEBUG("DeviceCreated = %x\n", dev->DeviceCreated);
153 if (dev->DeviceCreated)
155 DEBUG("%s: \"%s\" already registered\n", __func__, dev->DeviceName);
160 // register the device
161 DEBUG("%s: \"%s\" debugfs device registration\n", __func__, dev->DeviceName);
163 tmp = kmalloc(sizeof(struct ft1000_debug_dirs), GFP_KERNEL);
169 dir = debugfs_create_dir(dev->DeviceName, NULL);
171 result = PTR_ERR(dir);
175 file = debugfs_create_file("device", S_IRUGO | S_IWUSR, dir,
178 result = PTR_ERR(file);
179 goto debug_file_fail;
184 tmp->int_number = dev->CardNumber;
185 list_add(&(tmp->list), &(dev->nodes.list));
187 DEBUG("%s: registered debugfs directory \"%s\"\n", __func__, dev->DeviceName);
189 // initialize application information
191 for (i=0; i<MAX_NUM_APP; i++) {
192 dev->app_info[i].nTxMsg = 0;
193 dev->app_info[i].nRxMsg = 0;
194 dev->app_info[i].nTxMsgReject = 0;
195 dev->app_info[i].nRxMsgMiss = 0;
196 dev->app_info[i].fileobject = NULL;
197 dev->app_info[i].app_id = i+1;
198 dev->app_info[i].DspBCMsgFlag = 0;
199 dev->app_info[i].NumOfMsg = 0;
200 init_waitqueue_head(&dev->app_info[i].wait_dpram_msg);
201 INIT_LIST_HEAD (&dev->app_info[i].app_sqlist);
204 dev->DeviceCreated = TRUE;
205 ft1000_flarion_cnt++;
217 //---------------------------------------------------------------------------
218 // Function: ft1000_DestroyDeviceDEBUG
220 // Parameters: dev - pointer to adapter object
222 // Description: Destroys a private char device.
224 // Notes: Only called by cleanup_module().
226 //---------------------------------------------------------------------------
227 void ft1000_destroy_dev(struct net_device *netdev)
229 struct ft1000_info *info = netdev_priv(netdev);
230 struct ft1000_usb *dev = info->priv;
232 struct dpram_blk *pdpram_blk;
233 struct dpram_blk *ptr;
234 struct list_head *pos, *q;
235 struct ft1000_debug_dirs *dir;
237 DEBUG("%s called\n", __func__);
241 if (dev->DeviceCreated)
243 ft1000_flarion_cnt--;
244 list_for_each_safe(pos, q, &dev->nodes.list) {
245 dir = list_entry(pos, struct ft1000_debug_dirs, list);
246 if (dir->int_number == dev->CardNumber) {
247 debugfs_remove(dir->file);
248 debugfs_remove(dir->dent);
253 DEBUG("%s: unregistered device \"%s\"\n", __func__,
256 // Make sure we free any memory reserve for slow Queue
257 for (i=0; i<MAX_NUM_APP; i++) {
258 while (list_empty(&dev->app_info[i].app_sqlist) == 0) {
259 pdpram_blk = list_entry(dev->app_info[i].app_sqlist.next, struct dpram_blk, list);
260 list_del(&pdpram_blk->list);
261 ft1000_free_buffer(pdpram_blk, &freercvpool);
264 wake_up_interruptible(&dev->app_info[i].wait_dpram_msg);
267 // Remove buffer allocated for receive command data
268 if (ft1000_flarion_cnt == 0) {
269 while (list_empty(&freercvpool) == 0) {
270 ptr = list_entry(freercvpool.next, struct dpram_blk, list);
271 list_del(&ptr->list);
276 dev->DeviceCreated = FALSE;
282 //---------------------------------------------------------------------------
283 // Function: ft1000_open
291 //---------------------------------------------------------------------------
292 static int ft1000_open (struct inode *inode, struct file *file)
294 struct ft1000_info *info;
295 struct ft1000_usb *dev = (struct ft1000_usb *)inode->i_private;
298 DEBUG("%s called\n", __func__);
299 num = (MINOR(inode->i_rdev) & 0xf);
300 DEBUG("ft1000_open: minor number=%d\n", num);
302 info = file->private_data = netdev_priv(dev->net);
304 DEBUG("f_owner = %p number of application = %d\n", (&file->f_owner), dev->appcnt );
306 // Check if maximum number of application exceeded
307 if (dev->appcnt > MAX_NUM_APP) {
308 DEBUG("Maximum number of application exceeded\n");
312 // Search for available application info block
313 for (i=0; i<MAX_NUM_APP; i++) {
314 if ( (dev->app_info[i].fileobject == NULL) ) {
319 // Fail due to lack of application info block
320 if (i == MAX_NUM_APP) {
321 DEBUG("Could not find an application info block\n");
326 dev->app_info[i].fileobject = &file->f_owner;
327 dev->app_info[i].nTxMsg = 0;
328 dev->app_info[i].nRxMsg = 0;
329 dev->app_info[i].nTxMsgReject = 0;
330 dev->app_info[i].nRxMsgMiss = 0;
332 nonseekable_open(inode, file);
337 //---------------------------------------------------------------------------
338 // Function: ft1000_poll_dev
346 //---------------------------------------------------------------------------
348 static unsigned int ft1000_poll_dev(struct file *file, poll_table *wait)
350 struct net_device *netdev = file->private_data;
351 struct ft1000_info *info = netdev_priv(netdev);
352 struct ft1000_usb *dev = info->priv;
355 //DEBUG("ft1000_poll_dev called\n");
356 if (ft1000_flarion_cnt == 0) {
357 DEBUG("FT1000:ft1000_poll_dev called when ft1000_flarion_cnt is zero\n");
361 // Search for matching file object
362 for (i=0; i<MAX_NUM_APP; i++) {
363 if ( dev->app_info[i].fileobject == &file->f_owner) {
364 //DEBUG("FT1000:ft1000_ioctl: Message is for AppId = %d\n", dev->app_info[i].app_id);
369 // Could not find application info block
370 if (i == MAX_NUM_APP) {
371 DEBUG("FT1000:ft1000_ioctl:Could not find application info block\n");
375 if (list_empty(&dev->app_info[i].app_sqlist) == 0) {
376 DEBUG("FT1000:ft1000_poll_dev:Message detected in slow queue\n");
377 return(POLLIN | POLLRDNORM | POLLPRI);
380 poll_wait (file, &dev->app_info[i].wait_dpram_msg, wait);
381 //DEBUG("FT1000:ft1000_poll_dev:Polling for data from DSP\n");
386 //---------------------------------------------------------------------------
387 // Function: ft1000_ioctl
395 //---------------------------------------------------------------------------
396 static long ft1000_ioctl (struct file *file, unsigned int command,
397 unsigned long argument)
399 void __user *argp = (void __user *)argument;
400 struct ft1000_info *info;
401 struct ft1000_usb *ft1000dev;
408 IOCTL_GET_VER get_ver_data;
409 IOCTL_GET_DSP_STAT get_stat_data;
410 u8 ConnectionMsg[] = {0x00,0x44,0x10,0x20,0x80,0x00,0x00,0x00,0x00,0x00,0x03,0x00,0x00,0x00,0x93,0x64,
411 0x00,0x00,0x02,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x05,0x00,0x00,0x00,0x0a,
412 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x02,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
413 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x12,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
414 0x00,0x00,0x02,0x37,0x00,0x00,0x00,0x08,0x00,0x00,0x00,0x01,0x00,0x01,0x7f,0x00,
415 0x00,0x01,0x00,0x00};
417 unsigned short ledStat=0;
418 unsigned short conStat=0;
420 //DEBUG("ft1000_ioctl called\n");
422 if (ft1000_flarion_cnt == 0) {
423 DEBUG("FT1000:ft1000_ioctl called when ft1000_flarion_cnt is zero\n");
427 //DEBUG("FT1000:ft1000_ioctl:command = 0x%x argument = 0x%8x\n", command, (u32)argument);
429 info = file->private_data;
430 ft1000dev = info->priv;
431 cmd = _IOC_NR(command);
432 //DEBUG("FT1000:ft1000_ioctl:cmd = 0x%x\n", cmd);
434 // process the command
436 case IOCTL_REGISTER_CMD:
437 DEBUG("FT1000:ft1000_ioctl: IOCTL_FT1000_REGISTER called\n");
438 result = get_user(tempword, (__u16 __user*)argp);
440 DEBUG("result = %d failed to get_user\n", result);
443 if (tempword == DSPBCMSGID) {
444 // Search for matching file object
445 for (i=0; i<MAX_NUM_APP; i++) {
446 if (ft1000dev->app_info[i].fileobject == &file->f_owner) {
447 ft1000dev->app_info[i].DspBCMsgFlag = 1;
448 DEBUG("FT1000:ft1000_ioctl:Registered for broadcast messages\n");
455 case IOCTL_GET_VER_CMD:
456 DEBUG("FT1000:ft1000_ioctl: IOCTL_FT1000_GET_VER called\n");
458 get_ver_data.drv_ver = FT1000_DRV_VER;
460 if (copy_to_user(argp, &get_ver_data, sizeof(get_ver_data)) ) {
461 DEBUG("FT1000:ft1000_ioctl: copy fault occurred\n");
466 DEBUG("FT1000:ft1000_ioctl:driver version = 0x%x\n",(unsigned int)get_ver_data.drv_ver);
471 DEBUG("FT1000:ft1000_ioctl: IOCTL_FT1000_CONNECT\n");
472 ConnectionMsg[79] = 0xfc;
473 card_send_command(ft1000dev, (unsigned short *)ConnectionMsg, 0x4c);
476 case IOCTL_DISCONNECT:
477 // Disconnect Message
478 DEBUG("FT1000:ft1000_ioctl: IOCTL_FT1000_DISCONNECT\n");
479 ConnectionMsg[79] = 0xfd;
480 card_send_command(ft1000dev, (unsigned short *)ConnectionMsg, 0x4c);
482 case IOCTL_GET_DSP_STAT_CMD:
483 //DEBUG("FT1000:ft1000_ioctl: IOCTL_FT1000_GET_DSP_STAT called\n");
484 memset(&get_stat_data, 0, sizeof(get_stat_data));
485 memcpy(get_stat_data.DspVer, info->DspVer, DSPVERSZ);
486 memcpy(get_stat_data.HwSerNum, info->HwSerNum, HWSERNUMSZ);
487 memcpy(get_stat_data.Sku, info->Sku, SKUSZ);
488 memcpy(get_stat_data.eui64, info->eui64, EUISZ);
490 if (info->ProgConStat != 0xFF) {
491 ft1000_read_dpram16(ft1000dev, FT1000_MAG_DSP_LED, (u8 *)&ledStat, FT1000_MAG_DSP_LED_INDX);
492 get_stat_data.LedStat = ntohs(ledStat);
493 DEBUG("FT1000:ft1000_ioctl: LedStat = 0x%x\n", get_stat_data.LedStat);
494 ft1000_read_dpram16(ft1000dev, FT1000_MAG_DSP_CON_STATE, (u8 *)&conStat, FT1000_MAG_DSP_CON_STATE_INDX);
495 get_stat_data.ConStat = ntohs(conStat);
496 DEBUG("FT1000:ft1000_ioctl: ConStat = 0x%x\n", get_stat_data.ConStat);
499 get_stat_data.ConStat = 0x0f;
503 get_stat_data.nTxPkts = info->stats.tx_packets;
504 get_stat_data.nRxPkts = info->stats.rx_packets;
505 get_stat_data.nTxBytes = info->stats.tx_bytes;
506 get_stat_data.nRxBytes = info->stats.rx_bytes;
507 do_gettimeofday ( &tv );
508 get_stat_data.ConTm = (u32)(tv.tv_sec - info->ConTm);
509 DEBUG("Connection Time = %d\n", (int)get_stat_data.ConTm);
510 if (copy_to_user(argp, &get_stat_data, sizeof(get_stat_data)) ) {
511 DEBUG("FT1000:ft1000_ioctl: copy fault occurred\n");
515 DEBUG("ft1000_chioctl: GET_DSP_STAT succeed\n");
517 case IOCTL_SET_DPRAM_CMD:
519 IOCTL_DPRAM_BLK *dpram_data = NULL;
520 //IOCTL_DPRAM_COMMAND dpram_command;
523 struct pseudo_hdr *ppseudo_hdr;
529 //DEBUG("FT1000:ft1000_ioctl: IOCTL_FT1000_SET_DPRAM called\n");
532 if (ft1000_flarion_cnt == 0) {
536 if (ft1000dev->DrvMsgPend) {
540 if (ft1000dev->fProvComplete == 0) {
544 ft1000dev->fAppMsgPend = 1;
546 if (info->CardReady) {
548 //DEBUG("FT1000:ft1000_ioctl: try to SET_DPRAM \n");
550 // Get the length field to see how many bytes to copy
551 result = get_user(msgsz, (__u16 __user *)argp);
552 msgsz = ntohs (msgsz);
553 //DEBUG("FT1000:ft1000_ioctl: length of message = %d\n", msgsz);
555 if (msgsz > MAX_CMD_SQSIZE) {
556 DEBUG("FT1000:ft1000_ioctl: bad message length = %d\n", msgsz);
562 dpram_data = kmalloc(msgsz + 2, GFP_KERNEL);
566 if ( copy_from_user(dpram_data, argp, msgsz+2) ) {
567 DEBUG("FT1000:ft1000_ChIoctl: copy fault occurred\n");
571 // Check if this message came from a registered application
572 for (i=0; i<MAX_NUM_APP; i++) {
573 if (ft1000dev->app_info[i].fileobject == &file->f_owner) {
577 if (i==MAX_NUM_APP) {
578 DEBUG("FT1000:No matching application fileobject\n");
585 // Check message qtype type which is the lower byte within qos_class
586 qtype = ntohs(dpram_data->pseudohdr.qos_class) & 0xff;
587 //DEBUG("FT1000_ft1000_ioctl: qtype = %d\n", qtype);
591 // Put message into Slow Queue
592 // Only put a message into the DPRAM if msg doorbell is available
593 status = ft1000_read_register(ft1000dev, &tempword, FT1000_REG_DOORBELL);
594 //DEBUG("FT1000_ft1000_ioctl: READ REGISTER tempword=%x\n", tempword);
595 if (tempword & FT1000_DB_DPRAM_TX) {
596 // Suspend for 2ms and try again due to DSP doorbell busy
598 status = ft1000_read_register(ft1000dev, &tempword, FT1000_REG_DOORBELL);
599 if (tempword & FT1000_DB_DPRAM_TX) {
600 // Suspend for 1ms and try again due to DSP doorbell busy
602 status = ft1000_read_register(ft1000dev, &tempword, FT1000_REG_DOORBELL);
603 if (tempword & FT1000_DB_DPRAM_TX) {
604 status = ft1000_read_register(ft1000dev, &tempword, FT1000_REG_DOORBELL);
605 if (tempword & FT1000_DB_DPRAM_TX) {
606 // Suspend for 3ms and try again due to DSP doorbell busy
608 status = ft1000_read_register(ft1000dev, &tempword, FT1000_REG_DOORBELL);
609 if (tempword & FT1000_DB_DPRAM_TX) {
610 DEBUG("FT1000:ft1000_ioctl:Doorbell not available\n");
620 //DEBUG("FT1000_ft1000_ioctl: finished reading register\n");
622 // Make sure we are within the limits of the slow queue memory limitation
623 if ( (msgsz < MAX_CMD_SQSIZE) && (msgsz > PSEUDOSZ) ) {
624 // Need to put sequence number plus new checksum for message
625 pmsg = (u16 *)&dpram_data->pseudohdr;
626 ppseudo_hdr = (struct pseudo_hdr *)pmsg;
628 if (total_len & 0x1) {
632 // Insert slow queue sequence number
633 ppseudo_hdr->seq_num = info->squeseqnum++;
634 ppseudo_hdr->portsrc = ft1000dev->app_info[app_index].app_id;
635 // Calculate new checksum
636 ppseudo_hdr->checksum = *pmsg++;
637 //DEBUG("checksum = 0x%x\n", ppseudo_hdr->checksum);
638 for (i=1; i<7; i++) {
639 ppseudo_hdr->checksum ^= *pmsg++;
640 //DEBUG("checksum = 0x%x\n", ppseudo_hdr->checksum);
643 ppseudo_hdr = (struct pseudo_hdr *)pmsg;
644 card_send_command(ft1000dev,(unsigned short*)dpram_data,total_len+2);
647 ft1000dev->app_info[app_index].nTxMsg++;
656 DEBUG("FT1000:ft1000_ioctl: Card not ready take messages\n");
663 case IOCTL_GET_DPRAM_CMD:
665 struct dpram_blk *pdpram_blk;
666 IOCTL_DPRAM_BLK __user *pioctl_dpram;
669 //DEBUG("FT1000:ft1000_ioctl: IOCTL_FT1000_GET_DPRAM called\n");
671 if (ft1000_flarion_cnt == 0) {
675 // Search for matching file object
676 for (i=0; i<MAX_NUM_APP; i++) {
677 if (ft1000dev->app_info[i].fileobject == &file->f_owner) {
678 //DEBUG("FT1000:ft1000_ioctl: Message is for AppId = %d\n", ft1000dev->app_info[i].app_id);
683 // Could not find application info block
684 if (i == MAX_NUM_APP) {
685 DEBUG("FT1000:ft1000_ioctl:Could not find application info block\n");
692 if (list_empty(&ft1000dev->app_info[i].app_sqlist) == 0) {
693 //DEBUG("FT1000:ft1000_ioctl:Message detected in slow queue\n");
694 spin_lock_irqsave(&free_buff_lock, flags);
695 pdpram_blk = list_entry(ft1000dev->app_info[i].app_sqlist.next, struct dpram_blk, list);
696 list_del(&pdpram_blk->list);
697 ft1000dev->app_info[i].NumOfMsg--;
698 //DEBUG("FT1000:ft1000_ioctl:NumOfMsg for app %d = %d\n", i, ft1000dev->app_info[i].NumOfMsg);
699 spin_unlock_irqrestore(&free_buff_lock, flags);
700 msglen = ntohs(*(u16 *)pdpram_blk->pbuffer) + PSEUDOSZ;
701 result = get_user(msglen, &pioctl_dpram->total_len);
704 msglen = htons(msglen);
705 //DEBUG("FT1000:ft1000_ioctl:msg length = %x\n", msglen);
706 if(copy_to_user (&pioctl_dpram->pseudohdr, pdpram_blk->pbuffer, msglen))
708 DEBUG("FT1000:ft1000_ioctl: copy fault occurred\n");
713 ft1000_free_buffer(pdpram_blk, &freercvpool);
716 //DEBUG("FT1000:ft1000_ioctl: IOCTL_FT1000_GET_DPRAM no message\n");
721 DEBUG("FT1000:ft1000_ioctl:unknown command: 0x%x\n", command);
725 ft1000dev->fAppMsgPend = 0;
729 //---------------------------------------------------------------------------
730 // Function: ft1000_release
738 //---------------------------------------------------------------------------
739 static int ft1000_release (struct inode *inode, struct file *file)
741 struct ft1000_info *info;
742 struct net_device *dev;
743 struct ft1000_usb *ft1000dev;
745 struct dpram_blk *pdpram_blk;
747 DEBUG("ft1000_release called\n");
749 dev = file->private_data;
750 info = netdev_priv(dev);
751 ft1000dev = info->priv;
753 if (ft1000_flarion_cnt == 0) {
758 // Search for matching file object
759 for (i=0; i<MAX_NUM_APP; i++) {
760 if ( ft1000dev->app_info[i].fileobject == &file->f_owner) {
761 //DEBUG("FT1000:ft1000_ioctl: Message is for AppId = %d\n", ft1000dev->app_info[i].app_id);
769 while (list_empty(&ft1000dev->app_info[i].app_sqlist) == 0) {
770 DEBUG("Remove and free memory queue up on slow queue\n");
771 pdpram_blk = list_entry(ft1000dev->app_info[i].app_sqlist.next, struct dpram_blk, list);
772 list_del(&pdpram_blk->list);
773 ft1000_free_buffer(pdpram_blk, &freercvpool);
776 // initialize application information
778 DEBUG("ft1000_chdev:%s:appcnt = %d\n", __FUNCTION__, ft1000dev->appcnt);
779 ft1000dev->app_info[i].fileobject = NULL;