2 * Driver for the Solos PCI ADSL2+ card, designed to support Linux by
3 * Traverse Technologies -- http://www.traverse.com.au/
4 * Xrio Limited -- http://www.xrio.com/
7 * Copyright © 2008 Traverse Technologies
8 * Copyright © 2008 Intel Corporation
10 * Authors: Nathan Williams <nathan@traverse.com.au>
11 * David Woodhouse <dwmw2@infradead.org>
12 * Treker Chen <treker@xrio.com>
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * version 2, as published by the Free Software Foundation.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
27 #include <linux/interrupt.h>
28 #include <linux/module.h>
29 #include <linux/kernel.h>
30 #include <linux/errno.h>
31 #include <linux/ioport.h>
32 #include <linux/types.h>
33 #include <linux/pci.h>
34 #include <linux/atm.h>
35 #include <linux/atmdev.h>
36 #include <linux/skbuff.h>
37 #include <linux/sysfs.h>
38 #include <linux/device.h>
39 #include <linux/kobject.h>
40 #include <linux/firmware.h>
41 #include <linux/ctype.h>
42 #include <linux/swab.h>
43 #include <linux/slab.h>
45 #define VERSION "1.04"
46 #define DRIVER_VERSION 0x01
47 #define PTAG "solos-pci"
49 #define CONFIG_RAM_SIZE 128
50 #define FLAGS_ADDR 0x7C
51 #define IRQ_EN_ADDR 0x78
53 #define IRQ_CLEAR 0x70
54 #define WRITE_FLASH 0x6C
56 #define FLASH_BLOCK 0x64
57 #define FLASH_BUSY 0x60
58 #define FPGA_MODE 0x5C
59 #define FLASH_MODE 0x58
60 #define GPIO_STATUS 0x54
61 #define DRIVER_VER 0x50
62 #define TX_DMA_ADDR(port) (0x40 + (4 * (port)))
63 #define RX_DMA_ADDR(port) (0x30 + (4 * (port)))
65 #define DATA_RAM_SIZE 32768
67 #define OLD_BUF_SIZE 4096 /* For FPGA versions <= 2*/
68 /* Old boards use ATMEL AD45DB161D flash */
69 #define ATMEL_FPGA_PAGE 528 /* FPGA flash page size*/
70 #define ATMEL_SOLOS_PAGE 512 /* Solos flash page size*/
71 #define ATMEL_FPGA_BLOCK (ATMEL_FPGA_PAGE * 8) /* FPGA block size*/
72 #define ATMEL_SOLOS_BLOCK (ATMEL_SOLOS_PAGE * 8) /* Solos block size*/
73 /* Current boards use M25P/M25PE SPI flash */
74 #define SPI_FLASH_BLOCK (256 * 64)
76 #define RX_BUF(card, nr) ((card->buffers) + (nr)*(card->buffer_size)*2)
77 #define TX_BUF(card, nr) ((card->buffers) + (nr)*(card->buffer_size)*2 + (card->buffer_size))
78 #define FLASH_BUF ((card->buffers) + 4*(card->buffer_size)*2)
80 #define RX_DMA_SIZE 2048
82 #define FPGA_VERSION(a,b) (((a) << 8) + (b))
83 #define LEGACY_BUFFERS 2
84 #define DMA_SUPPORTED 4
87 static int atmdebug = 0;
88 static int firmware_upgrade = 0;
89 static int fpga_upgrade = 0;
90 static int db_firmware_upgrade = 0;
91 static int db_fpga_upgrade = 0;
100 struct solos_skb_cb {
106 #define SKB_CB(skb) ((struct solos_skb_cb *)skb->cb)
109 #define PKT_COMMAND 1
115 void __iomem *config_regs;
116 void __iomem *buffers;
120 struct atm_dev *atmdev[4];
121 struct tasklet_struct tlet;
123 spinlock_t tx_queue_lock;
124 spinlock_t cli_queue_lock;
125 spinlock_t param_queue_lock;
126 struct list_head param_queue;
127 struct sk_buff_head tx_queue[4];
128 struct sk_buff_head cli_queue[4];
129 struct sk_buff *tx_skb[4];
130 struct sk_buff *rx_skb[4];
131 unsigned char *dma_bounce;
132 wait_queue_head_t param_wq;
133 wait_queue_head_t fw_wq;
143 struct list_head list;
146 struct sk_buff *response;
149 #define SOLOS_CHAN(atmdev) ((int)(unsigned long)(atmdev)->phy_data)
151 MODULE_AUTHOR("Traverse Technologies <support@traverse.com.au>");
152 MODULE_DESCRIPTION("Solos PCI driver");
153 MODULE_VERSION(VERSION);
154 MODULE_LICENSE("GPL");
156 MODULE_PARM_DESC(reset, "Reset Solos chips on startup");
157 MODULE_PARM_DESC(atmdebug, "Print ATM data");
158 MODULE_PARM_DESC(firmware_upgrade, "Initiate Solos firmware upgrade");
159 MODULE_PARM_DESC(fpga_upgrade, "Initiate FPGA upgrade");
160 MODULE_PARM_DESC(db_firmware_upgrade, "Initiate daughter board Solos firmware upgrade");
161 MODULE_PARM_DESC(db_fpga_upgrade, "Initiate daughter board FPGA upgrade");
162 module_param(reset, int, 0444);
163 module_param(atmdebug, int, 0644);
164 module_param(firmware_upgrade, int, 0444);
165 module_param(fpga_upgrade, int, 0444);
166 module_param(db_firmware_upgrade, int, 0444);
167 module_param(db_fpga_upgrade, int, 0444);
169 static void fpga_queue(struct solos_card *card, int port, struct sk_buff *skb,
170 struct atm_vcc *vcc);
171 static uint32_t fpga_tx(struct solos_card *);
172 static irqreturn_t solos_irq(int irq, void *dev_id);
173 static struct atm_vcc* find_vcc(struct atm_dev *dev, short vpi, int vci);
174 static int atm_init(struct solos_card *, struct device *);
175 static void atm_remove(struct solos_card *);
176 static int send_command(struct solos_card *card, int dev, const char *buf, size_t size);
177 static void solos_bh(unsigned long);
178 static int print_buffer(struct sk_buff *buf);
180 static inline void solos_pop(struct atm_vcc *vcc, struct sk_buff *skb)
185 dev_kfree_skb_any(skb);
188 static ssize_t solos_param_show(struct device *dev, struct device_attribute *attr,
191 struct atm_dev *atmdev = container_of(dev, struct atm_dev, class_dev);
192 struct solos_card *card = atmdev->dev_data;
193 struct solos_param prm;
195 struct pkt_hdr *header;
198 buflen = strlen(attr->attr.name) + 10;
200 skb = alloc_skb(sizeof(*header) + buflen, GFP_KERNEL);
202 dev_warn(&card->dev->dev, "Failed to allocate sk_buff in solos_param_show()\n");
206 header = (void *)skb_put(skb, sizeof(*header));
208 buflen = snprintf((void *)&header[1], buflen - 1,
209 "L%05d\n%s\n", current->pid, attr->attr.name);
210 skb_put(skb, buflen);
212 header->size = cpu_to_le16(buflen);
213 header->vpi = cpu_to_le16(0);
214 header->vci = cpu_to_le16(0);
215 header->type = cpu_to_le16(PKT_COMMAND);
217 prm.pid = current->pid;
219 prm.port = SOLOS_CHAN(atmdev);
221 spin_lock_irq(&card->param_queue_lock);
222 list_add(&prm.list, &card->param_queue);
223 spin_unlock_irq(&card->param_queue_lock);
225 fpga_queue(card, prm.port, skb, NULL);
227 wait_event_timeout(card->param_wq, prm.response, 5 * HZ);
229 spin_lock_irq(&card->param_queue_lock);
231 spin_unlock_irq(&card->param_queue_lock);
236 buflen = prm.response->len;
237 memcpy(buf, prm.response->data, buflen);
238 kfree_skb(prm.response);
243 static ssize_t solos_param_store(struct device *dev, struct device_attribute *attr,
244 const char *buf, size_t count)
246 struct atm_dev *atmdev = container_of(dev, struct atm_dev, class_dev);
247 struct solos_card *card = atmdev->dev_data;
248 struct solos_param prm;
250 struct pkt_hdr *header;
254 buflen = strlen(attr->attr.name) + 11 + count;
256 skb = alloc_skb(sizeof(*header) + buflen, GFP_KERNEL);
258 dev_warn(&card->dev->dev, "Failed to allocate sk_buff in solos_param_store()\n");
262 header = (void *)skb_put(skb, sizeof(*header));
264 buflen = snprintf((void *)&header[1], buflen - 1,
265 "L%05d\n%s\n%s\n", current->pid, attr->attr.name, buf);
267 skb_put(skb, buflen);
268 header->size = cpu_to_le16(buflen);
269 header->vpi = cpu_to_le16(0);
270 header->vci = cpu_to_le16(0);
271 header->type = cpu_to_le16(PKT_COMMAND);
273 prm.pid = current->pid;
275 prm.port = SOLOS_CHAN(atmdev);
277 spin_lock_irq(&card->param_queue_lock);
278 list_add(&prm.list, &card->param_queue);
279 spin_unlock_irq(&card->param_queue_lock);
281 fpga_queue(card, prm.port, skb, NULL);
283 wait_event_timeout(card->param_wq, prm.response, 5 * HZ);
285 spin_lock_irq(&card->param_queue_lock);
287 spin_unlock_irq(&card->param_queue_lock);
296 /* Sometimes it has a newline, sometimes it doesn't. */
297 if (skb->data[buflen - 1] == '\n')
300 if (buflen == 2 && !strncmp(skb->data, "OK", 2))
302 else if (buflen == 5 && !strncmp(skb->data, "ERROR", 5))
305 /* We know we have enough space allocated for this; we allocated
307 skb->data[buflen] = 0;
309 dev_warn(&card->dev->dev, "Unexpected parameter response: '%s'\n",
318 static char *next_string(struct sk_buff *skb)
321 char *this = skb->data;
323 for (i = 0; i < skb->len; i++) {
324 if (this[i] == '\n') {
326 skb_pull(skb, i + 1);
329 if (!isprint(this[i]))
336 * Status packet has fields separated by \n, starting with a version number
337 * for the information therein. Fields are....
340 * RxBitRate (version >= 1)
341 * TxBitRate (version >= 1)
342 * State (version >= 1)
343 * LocalSNRMargin (version >= 1)
344 * LocalLineAttn (version >= 1)
346 static int process_status(struct solos_card *card, int port, struct sk_buff *skb)
348 char *str, *state_str, *snr, *attn;
349 int ver, rate_up, rate_down, err;
351 if (!card->atmdev[port])
354 str = next_string(skb);
358 err = kstrtoint(str, 10, &ver);
360 dev_warn(&card->dev->dev, "Unexpected status interrupt version\n");
364 dev_warn(&card->dev->dev, "Unexpected status interrupt version %d\n",
369 str = next_string(skb);
372 if (!strcmp(str, "ERROR")) {
373 dev_dbg(&card->dev->dev, "Status packet indicated Solos error on port %d (starting up?)\n",
378 err = kstrtoint(str, 10, &rate_down);
382 str = next_string(skb);
385 err = kstrtoint(str, 10, &rate_up);
389 state_str = next_string(skb);
393 /* Anything but 'Showtime' is down */
394 if (strcmp(state_str, "Showtime")) {
395 atm_dev_signal_change(card->atmdev[port], ATM_PHY_SIG_LOST);
396 dev_info(&card->dev->dev, "Port %d: %s\n", port, state_str);
400 snr = next_string(skb);
403 attn = next_string(skb);
407 dev_info(&card->dev->dev, "Port %d: %s @%d/%d kb/s%s%s%s%s\n",
408 port, state_str, rate_down/1000, rate_up/1000,
409 snr[0]?", SNR ":"", snr, attn[0]?", Attn ":"", attn);
411 card->atmdev[port]->link_rate = rate_down / 424;
412 atm_dev_signal_change(card->atmdev[port], ATM_PHY_SIG_FOUND);
417 static int process_command(struct solos_card *card, int port, struct sk_buff *skb)
419 struct solos_param *prm;
427 if (skb->data[0] != 'L' || !isdigit(skb->data[1]) ||
428 !isdigit(skb->data[2]) || !isdigit(skb->data[3]) ||
429 !isdigit(skb->data[4]) || !isdigit(skb->data[5]) ||
430 skb->data[6] != '\n')
433 err = kstrtoint(&skb->data[1], 10, &cmdpid);
437 spin_lock_irqsave(&card->param_queue_lock, flags);
438 list_for_each_entry(prm, &card->param_queue, list) {
439 if (prm->port == port && prm->pid == cmdpid) {
442 wake_up(&card->param_wq);
447 spin_unlock_irqrestore(&card->param_queue_lock, flags);
451 static ssize_t console_show(struct device *dev, struct device_attribute *attr,
454 struct atm_dev *atmdev = container_of(dev, struct atm_dev, class_dev);
455 struct solos_card *card = atmdev->dev_data;
459 spin_lock(&card->cli_queue_lock);
460 skb = skb_dequeue(&card->cli_queue[SOLOS_CHAN(atmdev)]);
461 spin_unlock(&card->cli_queue_lock);
463 return sprintf(buf, "No data.\n");
466 memcpy(buf, skb->data, len);
472 static int send_command(struct solos_card *card, int dev, const char *buf, size_t size)
475 struct pkt_hdr *header;
477 if (size > (BUF_SIZE - sizeof(*header))) {
478 dev_dbg(&card->dev->dev, "Command is too big. Dropping request\n");
481 skb = alloc_skb(size + sizeof(*header), GFP_ATOMIC);
483 dev_warn(&card->dev->dev, "Failed to allocate sk_buff in send_command()\n");
487 header = (void *)skb_put(skb, sizeof(*header));
489 header->size = cpu_to_le16(size);
490 header->vpi = cpu_to_le16(0);
491 header->vci = cpu_to_le16(0);
492 header->type = cpu_to_le16(PKT_COMMAND);
494 memcpy(skb_put(skb, size), buf, size);
496 fpga_queue(card, dev, skb, NULL);
501 static ssize_t console_store(struct device *dev, struct device_attribute *attr,
502 const char *buf, size_t count)
504 struct atm_dev *atmdev = container_of(dev, struct atm_dev, class_dev);
505 struct solos_card *card = atmdev->dev_data;
508 err = send_command(card, SOLOS_CHAN(atmdev), buf, count);
513 struct geos_gpio_attr {
514 struct device_attribute attr;
518 #define SOLOS_GPIO_ATTR(_name, _mode, _show, _store, _offset) \
519 struct geos_gpio_attr gpio_attr_##_name = { \
520 .attr = __ATTR(_name, _mode, _show, _store), \
523 static ssize_t geos_gpio_store(struct device *dev, struct device_attribute *attr,
524 const char *buf, size_t count)
526 struct pci_dev *pdev = to_pci_dev(dev);
527 struct geos_gpio_attr *gattr = container_of(attr, struct geos_gpio_attr, attr);
528 struct solos_card *card = pci_get_drvdata(pdev);
531 if (count != 1 && (count != 2 || buf[1] != '\n'))
534 spin_lock_irq(&card->param_queue_lock);
535 data32 = ioread32(card->config_regs + GPIO_STATUS);
537 data32 |= 1 << gattr->offset;
538 iowrite32(data32, card->config_regs + GPIO_STATUS);
539 } else if (buf[0] == '0') {
540 data32 &= ~(1 << gattr->offset);
541 iowrite32(data32, card->config_regs + GPIO_STATUS);
545 spin_unlock_irq(&card->param_queue_lock);
549 static ssize_t geos_gpio_show(struct device *dev, struct device_attribute *attr,
552 struct pci_dev *pdev = to_pci_dev(dev);
553 struct geos_gpio_attr *gattr = container_of(attr, struct geos_gpio_attr, attr);
554 struct solos_card *card = pci_get_drvdata(pdev);
557 data32 = ioread32(card->config_regs + GPIO_STATUS);
558 data32 = (data32 >> gattr->offset) & 1;
560 return sprintf(buf, "%d\n", data32);
563 static ssize_t hardware_show(struct device *dev, struct device_attribute *attr,
566 struct pci_dev *pdev = to_pci_dev(dev);
567 struct geos_gpio_attr *gattr = container_of(attr, struct geos_gpio_attr, attr);
568 struct solos_card *card = pci_get_drvdata(pdev);
571 data32 = ioread32(card->config_regs + GPIO_STATUS);
572 switch (gattr->offset) {
574 /* HardwareVersion */
575 data32 = data32 & 0x1F;
578 /* HardwareVariant */
579 data32 = (data32 >> 5) & 0x0F;
582 return sprintf(buf, "%d\n", data32);
585 static DEVICE_ATTR(console, 0644, console_show, console_store);
588 #define SOLOS_ATTR_RO(x) static DEVICE_ATTR(x, 0444, solos_param_show, NULL);
589 #define SOLOS_ATTR_RW(x) static DEVICE_ATTR(x, 0644, solos_param_show, solos_param_store);
591 #include "solos-attrlist.c"
593 static SOLOS_GPIO_ATTR(GPIO1, 0644, geos_gpio_show, geos_gpio_store, 9);
594 static SOLOS_GPIO_ATTR(GPIO2, 0644, geos_gpio_show, geos_gpio_store, 10);
595 static SOLOS_GPIO_ATTR(GPIO3, 0644, geos_gpio_show, geos_gpio_store, 11);
596 static SOLOS_GPIO_ATTR(GPIO4, 0644, geos_gpio_show, geos_gpio_store, 12);
597 static SOLOS_GPIO_ATTR(GPIO5, 0644, geos_gpio_show, geos_gpio_store, 13);
598 static SOLOS_GPIO_ATTR(PushButton, 0444, geos_gpio_show, NULL, 14);
599 static SOLOS_GPIO_ATTR(HardwareVersion, 0444, hardware_show, NULL, 0);
600 static SOLOS_GPIO_ATTR(HardwareVariant, 0444, hardware_show, NULL, 1);
604 #define SOLOS_ATTR_RO(x) &dev_attr_##x.attr,
605 #define SOLOS_ATTR_RW(x) &dev_attr_##x.attr,
607 static struct attribute *solos_attrs[] = {
608 #include "solos-attrlist.c"
612 static struct attribute_group solos_attr_group = {
613 .attrs = solos_attrs,
614 .name = "parameters",
617 static struct attribute *gpio_attrs[] = {
618 &gpio_attr_GPIO1.attr.attr,
619 &gpio_attr_GPIO2.attr.attr,
620 &gpio_attr_GPIO3.attr.attr,
621 &gpio_attr_GPIO4.attr.attr,
622 &gpio_attr_GPIO5.attr.attr,
623 &gpio_attr_PushButton.attr.attr,
624 &gpio_attr_HardwareVersion.attr.attr,
625 &gpio_attr_HardwareVariant.attr.attr,
629 static struct attribute_group gpio_attr_group = {
634 static int flash_upgrade(struct solos_card *card, int chip)
636 const struct firmware *fw;
644 fw_name = "/*(DEBLOBBED)*/";
645 if (card->atmel_flash)
646 blocksize = ATMEL_FPGA_BLOCK;
648 blocksize = SPI_FLASH_BLOCK;
651 fw_name = "/*(DEBLOBBED)*/";
652 if (card->atmel_flash)
653 blocksize = ATMEL_SOLOS_BLOCK;
655 blocksize = SPI_FLASH_BLOCK;
658 if (card->fpga_version > LEGACY_BUFFERS){
659 fw_name = "/*(DEBLOBBED)*/";
660 if (card->atmel_flash)
661 blocksize = ATMEL_FPGA_BLOCK;
663 blocksize = SPI_FLASH_BLOCK;
665 dev_info(&card->dev->dev, "FPGA version doesn't support"
666 " daughter board upgrades\n");
671 if (card->fpga_version > LEGACY_BUFFERS){
672 fw_name = "/*(DEBLOBBED)*/";
673 if (card->atmel_flash)
674 blocksize = ATMEL_SOLOS_BLOCK;
676 blocksize = SPI_FLASH_BLOCK;
678 dev_info(&card->dev->dev, "FPGA version doesn't support"
679 " daughter board upgrades\n");
687 if (reject_firmware(&fw, fw_name, &card->dev->dev))
690 dev_info(&card->dev->dev, "Flash upgrade starting\n");
692 /* New FPGAs require driver version before permitting flash upgrades */
693 iowrite32(DRIVER_VERSION, card->config_regs + DRIVER_VER);
695 numblocks = fw->size / blocksize;
696 dev_info(&card->dev->dev, "Firmware size: %zd\n", fw->size);
697 dev_info(&card->dev->dev, "Number of blocks: %d\n", numblocks);
699 dev_info(&card->dev->dev, "Changing FPGA to Update mode\n");
700 iowrite32(1, card->config_regs + FPGA_MODE);
701 (void) ioread32(card->config_regs + FPGA_MODE);
703 /* Set mode to Chip Erase */
704 if(chip == 0 || chip == 2)
705 dev_info(&card->dev->dev, "Set FPGA Flash mode to FPGA Chip Erase\n");
706 if(chip == 1 || chip == 3)
707 dev_info(&card->dev->dev, "Set FPGA Flash mode to Solos Chip Erase\n");
708 iowrite32((chip * 2), card->config_regs + FLASH_MODE);
711 iowrite32(1, card->config_regs + WRITE_FLASH);
712 wait_event(card->fw_wq, !ioread32(card->config_regs + FLASH_BUSY));
714 for (offset = 0; offset < fw->size; offset += blocksize) {
717 /* Clear write flag */
718 iowrite32(0, card->config_regs + WRITE_FLASH);
720 /* Set mode to Block Write */
721 /* dev_info(&card->dev->dev, "Set FPGA Flash mode to Block Write\n"); */
722 iowrite32(((chip * 2) + 1), card->config_regs + FLASH_MODE);
724 /* Copy block to buffer, swapping each 16 bits for Atmel flash */
725 for(i = 0; i < blocksize; i += 4) {
727 if (card->atmel_flash)
728 word = swahb32p((uint32_t *)(fw->data + offset + i));
730 word = *(uint32_t *)(fw->data + offset + i);
731 if(card->fpga_version > LEGACY_BUFFERS)
732 iowrite32(word, FLASH_BUF + i);
734 iowrite32(word, RX_BUF(card, 3) + i);
737 /* Specify block number and then trigger flash write */
738 iowrite32(offset / blocksize, card->config_regs + FLASH_BLOCK);
739 iowrite32(1, card->config_regs + WRITE_FLASH);
740 wait_event(card->fw_wq, !ioread32(card->config_regs + FLASH_BUSY));
743 release_firmware(fw);
744 iowrite32(0, card->config_regs + WRITE_FLASH);
745 iowrite32(0, card->config_regs + FPGA_MODE);
746 iowrite32(0, card->config_regs + FLASH_MODE);
747 dev_info(&card->dev->dev, "Returning FPGA to Data mode\n");
751 static irqreturn_t solos_irq(int irq, void *dev_id)
753 struct solos_card *card = dev_id;
756 iowrite32(0, card->config_regs + IRQ_CLEAR);
758 /* If we're up and running, just kick the tasklet to process TX/RX */
760 tasklet_schedule(&card->tlet);
762 wake_up(&card->fw_wq);
764 return IRQ_RETVAL(handled);
767 static void solos_bh(unsigned long card_arg)
769 struct solos_card *card = (void *)card_arg;
771 uint32_t rx_done = 0;
775 * Since fpga_tx() is going to need to read the flags under its lock,
776 * it can return them to us so that we don't have to hit PCI MMIO
777 * again for the same information
779 card_flags = fpga_tx(card);
781 for (port = 0; port < card->nr_ports; port++) {
782 if (card_flags & (0x10 << port)) {
783 struct pkt_hdr _hdr, *header;
788 if (card->using_dma) {
789 skb = card->rx_skb[port];
790 card->rx_skb[port] = NULL;
792 dma_unmap_single(&card->dev->dev, SKB_CB(skb)->dma_addr,
793 RX_DMA_SIZE, DMA_FROM_DEVICE);
795 header = (void *)skb->data;
796 size = le16_to_cpu(header->size);
797 skb_put(skb, size + sizeof(*header));
798 skb_pull(skb, sizeof(*header));
802 rx_done |= 0x10 << port;
804 memcpy_fromio(header, RX_BUF(card, port), sizeof(*header));
806 size = le16_to_cpu(header->size);
807 if (size > (card->buffer_size - sizeof(*header))){
808 dev_warn(&card->dev->dev, "Invalid buffer size\n");
812 /* Use netdev_alloc_skb() because it adds NET_SKB_PAD of
813 * headroom, and ensures we can route packets back out an
814 * Ethernet interface (for example) without having to
815 * reallocate. Adding NET_IP_ALIGN also ensures that both
816 * PPPoATM and PPPoEoBR2684 packets end up aligned. */
817 skb = netdev_alloc_skb_ip_align(NULL, size + 1);
820 dev_warn(&card->dev->dev, "Failed to allocate sk_buff for RX\n");
824 memcpy_fromio(skb_put(skb, size),
825 RX_BUF(card, port) + sizeof(*header),
829 dev_info(&card->dev->dev, "Received: port %d\n", port);
830 dev_info(&card->dev->dev, "size: %d VPI: %d VCI: %d\n",
831 size, le16_to_cpu(header->vpi),
832 le16_to_cpu(header->vci));
836 switch (le16_to_cpu(header->type)) {
838 vcc = find_vcc(card->atmdev[port], le16_to_cpu(header->vpi),
839 le16_to_cpu(header->vci));
842 dev_warn(&card->dev->dev, "Received packet for unknown VPI.VCI %d.%d on port %d\n",
843 le16_to_cpu(header->vpi), le16_to_cpu(header->vci),
845 dev_kfree_skb_any(skb);
848 atm_charge(vcc, skb->truesize);
850 atomic_inc(&vcc->stats->rx);
854 if (process_status(card, port, skb) &&
856 dev_warn(&card->dev->dev, "Bad status packet of %d bytes on port %d:\n", skb->len, port);
859 dev_kfree_skb_any(skb);
863 default: /* FIXME: Not really, surely? */
864 if (process_command(card, port, skb))
866 spin_lock(&card->cli_queue_lock);
867 if (skb_queue_len(&card->cli_queue[port]) > 10) {
869 dev_warn(&card->dev->dev, "Dropping console response on port %d\n",
871 dev_kfree_skb_any(skb);
873 skb_queue_tail(&card->cli_queue[port], skb);
874 spin_unlock(&card->cli_queue_lock);
878 /* Allocate RX skbs for any ports which need them */
879 if (card->using_dma && card->atmdev[port] &&
880 !card->rx_skb[port]) {
881 /* Unlike the MMIO case (qv) we can't add NET_IP_ALIGN
882 * here; the FPGA can only DMA to addresses which are
883 * aligned to 4 bytes. */
884 struct sk_buff *skb = dev_alloc_skb(RX_DMA_SIZE);
886 SKB_CB(skb)->dma_addr =
887 dma_map_single(&card->dev->dev, skb->data,
888 RX_DMA_SIZE, DMA_FROM_DEVICE);
889 iowrite32(SKB_CB(skb)->dma_addr,
890 card->config_regs + RX_DMA_ADDR(port));
891 card->rx_skb[port] = skb;
894 dev_warn(&card->dev->dev, "Failed to allocate RX skb");
896 /* We'll have to try again later */
897 tasklet_schedule(&card->tlet);
902 iowrite32(rx_done, card->config_regs + FLAGS_ADDR);
907 static struct atm_vcc *find_vcc(struct atm_dev *dev, short vpi, int vci)
909 struct hlist_head *head;
910 struct atm_vcc *vcc = NULL;
913 read_lock(&vcc_sklist_lock);
914 head = &vcc_hash[vci & (VCC_HTABLE_SIZE -1)];
915 sk_for_each(s, head) {
917 if (vcc->dev == dev && vcc->vci == vci &&
918 vcc->vpi == vpi && vcc->qos.rxtp.traffic_class != ATM_NONE &&
919 test_bit(ATM_VF_READY, &vcc->flags))
924 read_unlock(&vcc_sklist_lock);
928 static int popen(struct atm_vcc *vcc)
930 struct solos_card *card = vcc->dev->dev_data;
932 struct pkt_hdr *header;
934 if (vcc->qos.aal != ATM_AAL5) {
935 dev_warn(&card->dev->dev, "Unsupported ATM type %d\n",
940 skb = alloc_skb(sizeof(*header), GFP_KERNEL);
943 dev_warn(&card->dev->dev, "Failed to allocate sk_buff in popen()\n");
946 header = (void *)skb_put(skb, sizeof(*header));
948 header->size = cpu_to_le16(0);
949 header->vpi = cpu_to_le16(vcc->vpi);
950 header->vci = cpu_to_le16(vcc->vci);
951 header->type = cpu_to_le16(PKT_POPEN);
953 fpga_queue(card, SOLOS_CHAN(vcc->dev), skb, NULL);
955 set_bit(ATM_VF_ADDR, &vcc->flags);
956 set_bit(ATM_VF_READY, &vcc->flags);
961 static void pclose(struct atm_vcc *vcc)
963 struct solos_card *card = vcc->dev->dev_data;
964 unsigned char port = SOLOS_CHAN(vcc->dev);
965 struct sk_buff *skb, *tmpskb;
966 struct pkt_hdr *header;
968 /* Remove any yet-to-be-transmitted packets from the pending queue */
969 spin_lock(&card->tx_queue_lock);
970 skb_queue_walk_safe(&card->tx_queue[port], skb, tmpskb) {
971 if (SKB_CB(skb)->vcc == vcc) {
972 skb_unlink(skb, &card->tx_queue[port]);
976 spin_unlock(&card->tx_queue_lock);
978 skb = alloc_skb(sizeof(*header), GFP_KERNEL);
980 dev_warn(&card->dev->dev, "Failed to allocate sk_buff in pclose()\n");
983 header = (void *)skb_put(skb, sizeof(*header));
985 header->size = cpu_to_le16(0);
986 header->vpi = cpu_to_le16(vcc->vpi);
987 header->vci = cpu_to_le16(vcc->vci);
988 header->type = cpu_to_le16(PKT_PCLOSE);
991 fpga_queue(card, port, skb, NULL);
993 if (!wait_event_timeout(card->param_wq, !skb_shared(skb), 5 * HZ))
994 dev_warn(&card->dev->dev,
995 "Timeout waiting for VCC close on port %d\n", port);
999 /* Hold up vcc_destroy_socket() (our caller) until solos_bh() in the
1000 tasklet has finished processing any incoming packets (and, more to
1001 the point, using the vcc pointer). */
1002 tasklet_unlock_wait(&card->tlet);
1004 clear_bit(ATM_VF_ADDR, &vcc->flags);
1009 static int print_buffer(struct sk_buff *buf)
1016 for (i = 0; i < len; i++){
1018 sprintf(msg, "%02X: ", i);
1020 sprintf(item,"%02X ",*(buf->data + i));
1023 sprintf(item, "\n");
1025 printk(KERN_DEBUG "%s", msg);
1029 sprintf(item, "\n");
1031 printk(KERN_DEBUG "%s", msg);
1033 printk(KERN_DEBUG "\n");
1038 static void fpga_queue(struct solos_card *card, int port, struct sk_buff *skb,
1039 struct atm_vcc *vcc)
1042 unsigned long flags;
1044 SKB_CB(skb)->vcc = vcc;
1046 spin_lock_irqsave(&card->tx_queue_lock, flags);
1047 old_len = skb_queue_len(&card->tx_queue[port]);
1048 skb_queue_tail(&card->tx_queue[port], skb);
1050 card->tx_mask |= (1 << port);
1051 spin_unlock_irqrestore(&card->tx_queue_lock, flags);
1053 /* Theoretically we could just schedule the tasklet here, but
1054 that introduces latency we don't want -- it's noticeable */
1059 static uint32_t fpga_tx(struct solos_card *card)
1061 uint32_t tx_pending, card_flags;
1062 uint32_t tx_started = 0;
1063 struct sk_buff *skb;
1064 struct atm_vcc *vcc;
1066 unsigned long flags;
1068 spin_lock_irqsave(&card->tx_lock, flags);
1070 card_flags = ioread32(card->config_regs + FLAGS_ADDR);
1072 * The queue lock is required for _writing_ to tx_mask, but we're
1073 * OK to read it here without locking. The only potential update
1074 * that we could race with is in fpga_queue() where it sets a bit
1075 * for a new port... but it's going to call this function again if
1076 * it's doing that, anyway.
1078 tx_pending = card->tx_mask & ~card_flags;
1080 for (port = 0; tx_pending; tx_pending >>= 1, port++) {
1081 if (tx_pending & 1) {
1082 struct sk_buff *oldskb = card->tx_skb[port];
1084 dma_unmap_single(&card->dev->dev, SKB_CB(oldskb)->dma_addr,
1085 oldskb->len, DMA_TO_DEVICE);
1086 card->tx_skb[port] = NULL;
1088 spin_lock(&card->tx_queue_lock);
1089 skb = skb_dequeue(&card->tx_queue[port]);
1091 card->tx_mask &= ~(1 << port);
1092 spin_unlock(&card->tx_queue_lock);
1094 if (skb && !card->using_dma) {
1095 memcpy_toio(TX_BUF(card, port), skb->data, skb->len);
1096 tx_started |= 1 << port;
1097 oldskb = skb; /* We're done with this skb already */
1098 } else if (skb && card->using_dma) {
1099 unsigned char *data = skb->data;
1100 if ((unsigned long)data & card->dma_alignment) {
1101 data = card->dma_bounce + (BUF_SIZE * port);
1102 memcpy(data, skb->data, skb->len);
1104 SKB_CB(skb)->dma_addr = dma_map_single(&card->dev->dev, data,
1105 skb->len, DMA_TO_DEVICE);
1106 card->tx_skb[port] = skb;
1107 iowrite32(SKB_CB(skb)->dma_addr,
1108 card->config_regs + TX_DMA_ADDR(port));
1114 /* Clean up and free oldskb now it's gone */
1116 struct pkt_hdr *header = (void *)oldskb->data;
1117 int size = le16_to_cpu(header->size);
1119 skb_pull(oldskb, sizeof(*header));
1120 dev_info(&card->dev->dev, "Transmitted: port %d\n",
1122 dev_info(&card->dev->dev, "size: %d VPI: %d VCI: %d\n",
1123 size, le16_to_cpu(header->vpi),
1124 le16_to_cpu(header->vci));
1125 print_buffer(oldskb);
1128 vcc = SKB_CB(oldskb)->vcc;
1131 atomic_inc(&vcc->stats->tx);
1132 solos_pop(vcc, oldskb);
1134 dev_kfree_skb_irq(oldskb);
1135 wake_up(&card->param_wq);
1139 /* For non-DMA TX, write the 'TX start' bit for all four ports simultaneously */
1141 iowrite32(tx_started, card->config_regs + FLAGS_ADDR);
1143 spin_unlock_irqrestore(&card->tx_lock, flags);
1147 static int psend(struct atm_vcc *vcc, struct sk_buff *skb)
1149 struct solos_card *card = vcc->dev->dev_data;
1150 struct pkt_hdr *header;
1154 if (pktlen > (BUF_SIZE - sizeof(*header))) {
1155 dev_warn(&card->dev->dev, "Length of PDU is too large. Dropping PDU.\n");
1156 solos_pop(vcc, skb);
1160 if (!skb_clone_writable(skb, sizeof(*header))) {
1164 if (skb_headroom(skb) < sizeof(*header))
1165 expand_by = sizeof(*header) - skb_headroom(skb);
1167 ret = pskb_expand_head(skb, expand_by, 0, GFP_ATOMIC);
1169 dev_warn(&card->dev->dev, "pskb_expand_head failed.\n");
1170 solos_pop(vcc, skb);
1175 header = (void *)skb_push(skb, sizeof(*header));
1177 /* This does _not_ include the size of the header */
1178 header->size = cpu_to_le16(pktlen);
1179 header->vpi = cpu_to_le16(vcc->vpi);
1180 header->vci = cpu_to_le16(vcc->vci);
1181 header->type = cpu_to_le16(PKT_DATA);
1183 fpga_queue(card, SOLOS_CHAN(vcc->dev), skb, vcc);
1188 static struct atmdev_ops fpga_ops = {
1200 .owner = THIS_MODULE
1203 static int fpga_probe(struct pci_dev *dev, const struct pci_device_id *id)
1207 uint8_t major_ver, minor_ver;
1209 struct solos_card *card;
1211 card = kzalloc(sizeof(*card), GFP_KERNEL);
1216 init_waitqueue_head(&card->fw_wq);
1217 init_waitqueue_head(&card->param_wq);
1219 err = pci_enable_device(dev);
1221 dev_warn(&dev->dev, "Failed to enable PCI device\n");
1225 err = dma_set_mask_and_coherent(&dev->dev, DMA_BIT_MASK(32));
1227 dev_warn(&dev->dev, "Failed to set 32-bit DMA mask\n");
1231 err = pci_request_regions(dev, "solos");
1233 dev_warn(&dev->dev, "Failed to request regions\n");
1237 card->config_regs = pci_iomap(dev, 0, CONFIG_RAM_SIZE);
1238 if (!card->config_regs) {
1239 dev_warn(&dev->dev, "Failed to ioremap config registers\n");
1241 goto out_release_regions;
1243 card->buffers = pci_iomap(dev, 1, DATA_RAM_SIZE);
1244 if (!card->buffers) {
1245 dev_warn(&dev->dev, "Failed to ioremap data buffers\n");
1247 goto out_unmap_config;
1251 iowrite32(1, card->config_regs + FPGA_MODE);
1252 data32 = ioread32(card->config_regs + FPGA_MODE);
1254 iowrite32(0, card->config_regs + FPGA_MODE);
1255 data32 = ioread32(card->config_regs + FPGA_MODE);
1258 data32 = ioread32(card->config_regs + FPGA_VER);
1259 fpga_ver = (data32 & 0x0000FFFF);
1260 major_ver = ((data32 & 0xFF000000) >> 24);
1261 minor_ver = ((data32 & 0x00FF0000) >> 16);
1262 card->fpga_version = FPGA_VERSION(major_ver,minor_ver);
1263 if (card->fpga_version > LEGACY_BUFFERS)
1264 card->buffer_size = BUF_SIZE;
1266 card->buffer_size = OLD_BUF_SIZE;
1267 dev_info(&dev->dev, "Solos FPGA Version %d.%02d svn-%d\n",
1268 major_ver, minor_ver, fpga_ver);
1270 if (fpga_ver < 37 && (fpga_upgrade || firmware_upgrade ||
1271 db_fpga_upgrade || db_firmware_upgrade)) {
1273 "FPGA too old; cannot upgrade flash. Use JTAG.\n");
1274 fpga_upgrade = firmware_upgrade = 0;
1275 db_fpga_upgrade = db_firmware_upgrade = 0;
1278 /* Stopped using Atmel flash after 0.03-38 */
1280 card->atmel_flash = 1;
1282 card->atmel_flash = 0;
1284 data32 = ioread32(card->config_regs + PORTS);
1285 card->nr_ports = (data32 & 0x000000FF);
1287 if (card->fpga_version >= DMA_SUPPORTED) {
1288 pci_set_master(dev);
1289 card->using_dma = 1;
1290 if (1) { /* All known FPGA versions so far */
1291 card->dma_alignment = 3;
1292 card->dma_bounce = kmalloc(card->nr_ports * BUF_SIZE, GFP_KERNEL);
1293 if (!card->dma_bounce) {
1294 dev_warn(&card->dev->dev, "Failed to allocate DMA bounce buffers\n");
1296 /* Fallback to MMIO doesn't work */
1297 goto out_unmap_both;
1301 card->using_dma = 0;
1302 /* Set RX empty flag for all ports */
1303 iowrite32(0xF0, card->config_regs + FLAGS_ADDR);
1306 pci_set_drvdata(dev, card);
1308 tasklet_init(&card->tlet, solos_bh, (unsigned long)card);
1309 spin_lock_init(&card->tx_lock);
1310 spin_lock_init(&card->tx_queue_lock);
1311 spin_lock_init(&card->cli_queue_lock);
1312 spin_lock_init(&card->param_queue_lock);
1313 INIT_LIST_HEAD(&card->param_queue);
1315 err = request_irq(dev->irq, solos_irq, IRQF_SHARED,
1318 dev_dbg(&card->dev->dev, "Failed to request interrupt IRQ: %d\n", dev->irq);
1319 goto out_unmap_both;
1322 iowrite32(1, card->config_regs + IRQ_EN_ADDR);
1325 flash_upgrade(card, 0);
1327 if (firmware_upgrade)
1328 flash_upgrade(card, 1);
1330 if (db_fpga_upgrade)
1331 flash_upgrade(card, 2);
1333 if (db_firmware_upgrade)
1334 flash_upgrade(card, 3);
1336 err = atm_init(card, &dev->dev);
1340 if (card->fpga_version >= DMA_SUPPORTED &&
1341 sysfs_create_group(&card->dev->dev.kobj, &gpio_attr_group))
1342 dev_err(&card->dev->dev, "Could not register parameter group for GPIOs\n");
1347 iowrite32(0, card->config_regs + IRQ_EN_ADDR);
1348 free_irq(dev->irq, card);
1349 tasklet_kill(&card->tlet);
1352 kfree(card->dma_bounce);
1353 pci_iounmap(dev, card->buffers);
1355 pci_iounmap(dev, card->config_regs);
1356 out_release_regions:
1357 pci_release_regions(dev);
1363 static int atm_init(struct solos_card *card, struct device *parent)
1367 for (i = 0; i < card->nr_ports; i++) {
1368 struct sk_buff *skb;
1369 struct pkt_hdr *header;
1371 skb_queue_head_init(&card->tx_queue[i]);
1372 skb_queue_head_init(&card->cli_queue[i]);
1374 card->atmdev[i] = atm_dev_register("solos-pci", parent, &fpga_ops, -1, NULL);
1375 if (!card->atmdev[i]) {
1376 dev_err(&card->dev->dev, "Could not register ATM device %d\n", i);
1380 if (device_create_file(&card->atmdev[i]->class_dev, &dev_attr_console))
1381 dev_err(&card->dev->dev, "Could not register console for ATM device %d\n", i);
1382 if (sysfs_create_group(&card->atmdev[i]->class_dev.kobj, &solos_attr_group))
1383 dev_err(&card->dev->dev, "Could not register parameter group for ATM device %d\n", i);
1385 dev_info(&card->dev->dev, "Registered ATM device %d\n", card->atmdev[i]->number);
1387 card->atmdev[i]->ci_range.vpi_bits = 8;
1388 card->atmdev[i]->ci_range.vci_bits = 16;
1389 card->atmdev[i]->dev_data = card;
1390 card->atmdev[i]->phy_data = (void *)(unsigned long)i;
1391 atm_dev_signal_change(card->atmdev[i], ATM_PHY_SIG_FOUND);
1393 skb = alloc_skb(sizeof(*header), GFP_KERNEL);
1395 dev_warn(&card->dev->dev, "Failed to allocate sk_buff in atm_init()\n");
1399 header = (void *)skb_put(skb, sizeof(*header));
1401 header->size = cpu_to_le16(0);
1402 header->vpi = cpu_to_le16(0);
1403 header->vci = cpu_to_le16(0);
1404 header->type = cpu_to_le16(PKT_STATUS);
1406 fpga_queue(card, i, skb, NULL);
1411 static void atm_remove(struct solos_card *card)
1415 for (i = 0; i < card->nr_ports; i++) {
1416 if (card->atmdev[i]) {
1417 struct sk_buff *skb;
1419 dev_info(&card->dev->dev, "Unregistering ATM device %d\n", card->atmdev[i]->number);
1421 sysfs_remove_group(&card->atmdev[i]->class_dev.kobj, &solos_attr_group);
1422 atm_dev_deregister(card->atmdev[i]);
1424 skb = card->rx_skb[i];
1426 dma_unmap_single(&card->dev->dev, SKB_CB(skb)->dma_addr,
1427 RX_DMA_SIZE, DMA_FROM_DEVICE);
1430 skb = card->tx_skb[i];
1432 dma_unmap_single(&card->dev->dev, SKB_CB(skb)->dma_addr,
1433 skb->len, DMA_TO_DEVICE);
1436 while ((skb = skb_dequeue(&card->tx_queue[i])))
1443 static void fpga_remove(struct pci_dev *dev)
1445 struct solos_card *card = pci_get_drvdata(dev);
1448 iowrite32(0, card->config_regs + IRQ_EN_ADDR);
1451 iowrite32(1, card->config_regs + FPGA_MODE);
1452 (void)ioread32(card->config_regs + FPGA_MODE);
1454 if (card->fpga_version >= DMA_SUPPORTED)
1455 sysfs_remove_group(&card->dev->dev.kobj, &gpio_attr_group);
1459 free_irq(dev->irq, card);
1460 tasklet_kill(&card->tlet);
1462 kfree(card->dma_bounce);
1464 /* Release device from reset */
1465 iowrite32(0, card->config_regs + FPGA_MODE);
1466 (void)ioread32(card->config_regs + FPGA_MODE);
1468 pci_iounmap(dev, card->buffers);
1469 pci_iounmap(dev, card->config_regs);
1471 pci_release_regions(dev);
1472 pci_disable_device(dev);
1477 static struct pci_device_id fpga_pci_tbl[] = {
1478 { 0x10ee, 0x0300, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0 },
1482 MODULE_DEVICE_TABLE(pci,fpga_pci_tbl);
1484 static struct pci_driver fpga_driver = {
1486 .id_table = fpga_pci_tbl,
1487 .probe = fpga_probe,
1488 .remove = fpga_remove,
1492 static int __init solos_pci_init(void)
1494 BUILD_BUG_ON(sizeof(struct solos_skb_cb) > sizeof(((struct sk_buff *)0)->cb));
1496 printk(KERN_INFO "Solos PCI Driver Version %s\n", VERSION);
1497 return pci_register_driver(&fpga_driver);
1500 static void __exit solos_pci_exit(void)
1502 pci_unregister_driver(&fpga_driver);
1503 printk(KERN_INFO "Solos PCI Driver %s Unloaded\n", VERSION);
1506 module_init(solos_pci_init);
1507 module_exit(solos_pci_exit);