2 * User-space DMA and UIO based Redrapids Pocket Change CardBus driver
4 * Copyright 2008 Vijay Kumar <vijaykumar@bravegnu.org>
6 * Licensed under GPL version 2 only.
9 #include <linux/device.h>
10 #include <linux/module.h>
11 #include <linux/pci.h>
12 #include <linux/uio_driver.h>
13 #include <linux/spinlock.h>
14 #include <linux/cdev.h>
15 #include <linux/delay.h>
16 #include <linux/sysfs.h>
17 #include <linux/poll.h>
18 #include <linux/idr.h>
19 #include <linux/interrupt.h>
20 #include <linux/init.h>
21 #include <linux/ioctl.h>
26 #include <asm/cacheflush.h>
28 #ifndef PCI_VENDOR_ID_RRAPIDS
29 #define PCI_VENDOR_ID_RRAPIDS 0x17D2
32 #ifndef PCI_DEVICE_ID_RRAPIDS_POCKET_CHANGE
33 #define PCI_DEVICE_ID_RRAPIDS_POCKET_CHANGE 0x0351
36 #define POCH_NCHANNELS 2
38 #define MAX_POCH_CARDS 8
39 #define MAX_POCH_DEVICES (MAX_POCH_CARDS * POCH_NCHANNELS)
41 #define DRV_NAME "poch"
42 #define PFX DRV_NAME ": "
45 * BAR0 Bridge Register Definitions
48 #define BRIDGE_REV_REG 0x0
49 #define BRIDGE_INT_MASK_REG 0x4
50 #define BRIDGE_INT_STAT_REG 0x8
52 #define BRIDGE_INT_ACTIVE (0x1 << 31)
53 #define BRIDGE_INT_FPGA (0x1 << 2)
54 #define BRIDGE_INT_TEMP_FAIL (0x1 << 1)
55 #define BRIDGE_INT_TEMP_WARN (0x1 << 0)
57 #define BRIDGE_FPGA_RESET_REG 0xC
59 #define BRIDGE_CARD_POWER_REG 0x10
60 #define BRIDGE_CARD_POWER_EN (0x1 << 0)
61 #define BRIDGE_CARD_POWER_PROG_DONE (0x1 << 31)
63 #define BRIDGE_JTAG_REG 0x14
64 #define BRIDGE_DMA_GO_REG 0x18
65 #define BRIDGE_STAT_0_REG 0x1C
66 #define BRIDGE_STAT_1_REG 0x20
67 #define BRIDGE_STAT_2_REG 0x24
68 #define BRIDGE_STAT_3_REG 0x28
69 #define BRIDGE_TEMP_STAT_REG 0x2C
70 #define BRIDGE_TEMP_THRESH_REG 0x30
71 #define BRIDGE_EEPROM_REVSEL_REG 0x34
72 #define BRIDGE_CIS_STRUCT_REG 0x100
73 #define BRIDGE_BOARDREV_REG 0x124
76 * BAR1 FPGA Register Definitions
79 #define FPGA_IFACE_REV_REG 0x0
80 #define FPGA_RX_BLOCK_SIZE_REG 0x8
81 #define FPGA_TX_BLOCK_SIZE_REG 0xC
82 #define FPGA_RX_BLOCK_COUNT_REG 0x10
83 #define FPGA_TX_BLOCK_COUNT_REG 0x14
84 #define FPGA_RX_CURR_DMA_BLOCK_REG 0x18
85 #define FPGA_TX_CURR_DMA_BLOCK_REG 0x1C
86 #define FPGA_RX_GROUP_COUNT_REG 0x20
87 #define FPGA_TX_GROUP_COUNT_REG 0x24
88 #define FPGA_RX_CURR_GROUP_REG 0x28
89 #define FPGA_TX_CURR_GROUP_REG 0x2C
90 #define FPGA_RX_CURR_PCI_REG 0x38
91 #define FPGA_TX_CURR_PCI_REG 0x3C
92 #define FPGA_RX_GROUP0_START_REG 0x40
93 #define FPGA_TX_GROUP0_START_REG 0xC0
94 #define FPGA_DMA_DESC_1_REG 0x140
95 #define FPGA_DMA_DESC_2_REG 0x144
96 #define FPGA_DMA_DESC_3_REG 0x148
97 #define FPGA_DMA_DESC_4_REG 0x14C
99 #define FPGA_DMA_INT_STAT_REG 0x150
100 #define FPGA_DMA_INT_MASK_REG 0x154
101 #define FPGA_DMA_INT_RX (1 << 0)
102 #define FPGA_DMA_INT_TX (1 << 1)
104 #define FPGA_RX_GROUPS_PER_INT_REG 0x158
105 #define FPGA_TX_GROUPS_PER_INT_REG 0x15C
106 #define FPGA_DMA_ADR_PAGE_REG 0x160
107 #define FPGA_FPGA_REV_REG 0x200
109 #define FPGA_ADC_CLOCK_CTL_REG 0x204
110 #define FPGA_ADC_CLOCK_CTL_OSC_EN (0x1 << 3)
111 #define FPGA_ADC_CLOCK_LOCAL_CLK (0x1 | FPGA_ADC_CLOCK_CTL_OSC_EN)
112 #define FPGA_ADC_CLOCK_EXT_SAMP_CLK 0X0
114 #define FPGA_ADC_DAC_EN_REG 0x208
115 #define FPGA_ADC_DAC_EN_DAC_OFF (0x1 << 1)
116 #define FPGA_ADC_DAC_EN_ADC_OFF (0x1 << 0)
118 #define FPGA_INT_STAT_REG 0x20C
119 #define FPGA_INT_MASK_REG 0x210
120 #define FPGA_INT_PLL_UNLOCKED (0x1 << 9)
121 #define FPGA_INT_DMA_CORE (0x1 << 8)
122 #define FPGA_INT_TX_FF_EMPTY (0x1 << 7)
123 #define FPGA_INT_RX_FF_EMPTY (0x1 << 6)
124 #define FPGA_INT_TX_FF_OVRFLW (0x1 << 3)
125 #define FPGA_INT_RX_FF_OVRFLW (0x1 << 2)
126 #define FPGA_INT_TX_ACQ_DONE (0x1 << 1)
127 #define FPGA_INT_RX_ACQ_DONE (0x1)
129 #define FPGA_RX_CTL_REG 0x214
130 #define FPGA_RX_CTL_FIFO_FLUSH (0x1 << 9)
131 #define FPGA_RX_CTL_SYNTH_DATA (0x1 << 8)
132 #define FPGA_RX_CTL_CONT_CAP (0x0 << 1)
133 #define FPGA_RX_CTL_SNAP_CAP (0x1 << 1)
135 #define FPGA_RX_ARM_REG 0x21C
137 #define FPGA_DOM_REG 0x224
138 #define FPGA_DOM_DCM_RESET (0x1 << 5)
139 #define FPGA_DOM_SOFT_RESET (0x1 << 4)
140 #define FPGA_DOM_DUAL_M_SG_DMA (0x0)
141 #define FPGA_DOM_TARGET_ACCESS (0x1)
143 #define FPGA_TX_CTL_REG 0x228
144 #define FPGA_TX_CTL_FIFO_FLUSH (0x1 << 9)
145 #define FPGA_TX_CTL_OUTPUT_ZERO (0x0 << 2)
146 #define FPGA_TX_CTL_OUTPUT_CARDBUS (0x1 << 2)
147 #define FPGA_TX_CTL_OUTPUT_ADC (0x2 << 2)
148 #define FPGA_TX_CTL_OUTPUT_SNAPSHOT (0x3 << 2)
149 #define FPGA_TX_CTL_LOOPBACK (0x1 << 0)
151 #define FPGA_ENDIAN_MODE_REG 0x22C
152 #define FPGA_RX_FIFO_COUNT_REG 0x28C
153 #define FPGA_TX_ENABLE_REG 0x298
154 #define FPGA_TX_TRIGGER_REG 0x29C
155 #define FPGA_TX_DATAMEM_COUNT_REG 0x2A8
156 #define FPGA_CAP_FIFO_REG 0x300
157 #define FPGA_TX_SNAPSHOT_REG 0x8000
160 * Channel Index Definitions
175 struct poch_group_info {
178 unsigned long user_offset;
181 struct channel_info {
184 atomic_t sys_block_size;
185 atomic_t sys_group_size;
186 atomic_t sys_group_count;
188 enum channel_dir dir;
190 unsigned long block_size;
191 unsigned long group_size;
192 unsigned long group_count;
194 /* Contains the DMA address and VM offset of each group. */
195 struct poch_group_info *groups;
197 /* Contains the header and circular buffer exported to userspace. */
198 spinlock_t group_offsets_lock;
199 struct poch_cbuf_header *header;
200 struct page *header_pg;
201 unsigned long header_size;
203 /* Last group indicated as 'complete' to user space. */
204 unsigned int transfer;
206 wait_queue_head_t wq;
209 unsigned int data_available;
210 unsigned int space_available;
213 void __iomem *bridge_iomem;
214 void __iomem *fpga_iomem;
215 spinlock_t *iomem_lock;
221 struct poch_counters counters;
222 spinlock_t counters_lock;
229 struct pci_dev *pci_dev;
230 unsigned int nchannels;
231 struct channel_info channels[POCH_NCHANNELS];
234 /* Counts the no. of channels that have been opened. On first
235 * open, the card is powered on. On last channel close, the
236 * card is powered off.
240 void __iomem *bridge_iomem;
241 void __iomem *fpga_iomem;
242 spinlock_t iomem_lock;
247 static dev_t poch_first_dev;
248 static struct class *poch_cls;
249 static DEFINE_IDR(poch_ids);
251 static ssize_t store_block_size(struct device *dev,
252 struct device_attribute *attr,
253 const char *buf, size_t count)
255 struct channel_info *channel = dev_get_drvdata(dev);
256 unsigned long block_size;
258 sscanf(buf, "%lu", &block_size);
259 atomic_set(&channel->sys_block_size, block_size);
263 static DEVICE_ATTR(block_size, S_IWUSR|S_IWGRP, NULL, store_block_size);
265 static ssize_t store_group_size(struct device *dev,
266 struct device_attribute *attr,
267 const char *buf, size_t count)
269 struct channel_info *channel = dev_get_drvdata(dev);
270 unsigned long group_size;
272 sscanf(buf, "%lu", &group_size);
273 atomic_set(&channel->sys_group_size, group_size);
277 static DEVICE_ATTR(group_size, S_IWUSR|S_IWGRP, NULL, store_group_size);
279 static ssize_t store_group_count(struct device *dev,
280 struct device_attribute *attr,
281 const char *buf, size_t count)
283 struct channel_info *channel = dev_get_drvdata(dev);
284 unsigned long group_count;
286 sscanf(buf, "%lu", &group_count);
287 atomic_set(&channel->sys_group_count, group_count);
291 static DEVICE_ATTR(group_count, S_IWUSR|S_IWGRP, NULL, store_group_count);
293 static ssize_t show_direction(struct device *dev,
294 struct device_attribute *attr, char *buf)
296 struct channel_info *channel = dev_get_drvdata(dev);
299 len = sprintf(buf, "%s\n", (channel->dir ? "tx" : "rx"));
302 static DEVICE_ATTR(dir, S_IRUSR|S_IRGRP, show_direction, NULL);
304 static unsigned long npages(unsigned long bytes)
306 if (bytes % PAGE_SIZE == 0)
307 return bytes / PAGE_SIZE;
309 return (bytes / PAGE_SIZE) + 1;
312 static ssize_t show_mmap_size(struct device *dev,
313 struct device_attribute *attr, char *buf)
315 struct channel_info *channel = dev_get_drvdata(dev);
317 unsigned long mmap_size;
318 unsigned long group_pages;
319 unsigned long header_pages;
320 unsigned long total_group_pages;
322 group_pages = npages(channel->group_size);
323 header_pages = npages(channel->header_size);
324 total_group_pages = group_pages * channel->group_count;
326 mmap_size = (header_pages + total_group_pages) * PAGE_SIZE;
327 len = sprintf(buf, "%lu\n", mmap_size);
330 static DEVICE_ATTR(mmap_size, S_IRUSR|S_IRGRP, show_mmap_size, NULL);
332 static struct device_attribute *poch_class_attrs[] = {
333 &dev_attr_block_size,
334 &dev_attr_group_size,
335 &dev_attr_group_count,
340 static void poch_channel_free_groups(struct channel_info *channel)
344 for (i = 0; i < channel->group_count; i++) {
345 struct poch_group_info *group;
348 group = &channel->groups[i];
349 order = get_order(channel->group_size);
351 __free_pages(group->pg, order);
355 static int poch_channel_alloc_groups(struct channel_info *channel)
358 unsigned long group_pages;
359 unsigned long header_pages;
361 group_pages = npages(channel->group_size);
362 header_pages = npages(channel->header_size);
364 for (i = 0; i < channel->group_count; i++) {
365 struct poch_group_info *group;
369 group = &channel->groups[i];
370 order = get_order(channel->group_size);
373 * __GFP_COMP is required here since we are going to
374 * perform non-linear mapping to userspace. For more
375 * information read the vm_insert_page() function
379 gfp_mask = GFP_KERNEL | GFP_DMA32 | __GFP_ZERO;
380 group->pg = alloc_pages(gfp_mask, order);
382 poch_channel_free_groups(channel);
386 /* FIXME: This is the physical address not the bus
387 * address! This won't work in architectures that
388 * have an IOMMU. Can we use pci_map_single() for
391 group->dma_addr = page_to_pfn(group->pg) * PAGE_SIZE;
393 (header_pages + (i * group_pages)) * PAGE_SIZE;
395 printk(KERN_INFO PFX "%ld: user_offset: 0x%lx\n", i,
402 static int channel_latch_attr(struct channel_info *channel)
404 channel->group_count = atomic_read(&channel->sys_group_count);
405 channel->group_size = atomic_read(&channel->sys_group_size);
406 channel->block_size = atomic_read(&channel->sys_block_size);
408 if (channel->group_count == 0) {
409 printk(KERN_ERR PFX "invalid group count %lu",
410 channel->group_count);
414 if (channel->group_size == 0 ||
415 channel->group_size < channel->block_size) {
416 printk(KERN_ERR PFX "invalid group size %lu",
417 channel->group_size);
421 if (channel->block_size == 0 || (channel->block_size % 8) != 0) {
422 printk(KERN_ERR PFX "invalid block size %lu",
423 channel->block_size);
427 if (channel->group_size % channel->block_size != 0) {
429 "group size should be multiple of block size");
437 * Configure DMA group registers
439 static void channel_dma_init(struct channel_info *channel)
441 void __iomem *fpga = channel->fpga_iomem;
445 unsigned int group_in_page;
450 u32 groups_per_int_reg;
453 if (channel->chno == CHNO_RX_CHANNEL) {
454 group_regs_base = FPGA_RX_GROUP0_START_REG;
455 block_size_reg = FPGA_RX_BLOCK_SIZE_REG;
456 block_count_reg = FPGA_RX_BLOCK_COUNT_REG;
457 group_count_reg = FPGA_RX_GROUP_COUNT_REG;
458 groups_per_int_reg = FPGA_RX_GROUPS_PER_INT_REG;
459 curr_pci_reg = FPGA_RX_CURR_PCI_REG;
461 group_regs_base = FPGA_TX_GROUP0_START_REG;
462 block_size_reg = FPGA_TX_BLOCK_SIZE_REG;
463 block_count_reg = FPGA_TX_BLOCK_COUNT_REG;
464 group_count_reg = FPGA_TX_GROUP_COUNT_REG;
465 groups_per_int_reg = FPGA_TX_GROUPS_PER_INT_REG;
466 curr_pci_reg = FPGA_TX_CURR_PCI_REG;
469 printk(KERN_WARNING "block_size, group_size, group_count\n");
471 * Block size is represented in no. of 64 bit transfers.
473 iowrite32(channel->block_size / 8, fpga + block_size_reg);
474 iowrite32(channel->group_size / channel->block_size,
475 fpga + block_count_reg);
476 iowrite32(channel->group_count, fpga + group_count_reg);
477 /* FIXME: Hardcoded groups per int. Get it from sysfs? */
478 iowrite32(1, fpga + groups_per_int_reg);
480 /* Unlock PCI address? Not defined in the data sheet, but used
481 * in the reference code by Redrapids.
483 iowrite32(0x1, fpga + curr_pci_reg);
485 /* The DMA address page register is shared between the RX and
486 * TX channels, so acquire lock.
488 spin_lock(channel->iomem_lock);
489 for (i = 0; i < channel->group_count; i++) {
491 group_in_page = i % 32;
493 group_reg = group_regs_base + (group_in_page * 4);
495 iowrite32(page, fpga + FPGA_DMA_ADR_PAGE_REG);
496 iowrite32(channel->groups[i].dma_addr, fpga + group_reg);
498 for (i = 0; i < channel->group_count; i++) {
500 group_in_page = i % 32;
502 group_reg = group_regs_base + (group_in_page * 4);
504 iowrite32(page, fpga + FPGA_DMA_ADR_PAGE_REG);
505 printk(KERN_INFO PFX "%ld: read dma_addr: 0x%x\n", i,
506 ioread32(fpga + group_reg));
508 spin_unlock(channel->iomem_lock);
512 static int poch_channel_alloc_header(struct channel_info *channel)
514 struct poch_cbuf_header *header = channel->header;
515 unsigned long group_offset_size;
516 unsigned long tot_group_offsets_size;
518 /* Allocate memory to hold header exported userspace */
519 group_offset_size = sizeof(header->group_offsets[0]);
520 tot_group_offsets_size = group_offset_size * channel->group_count;
521 channel->header_size = sizeof(*header) + tot_group_offsets_size;
522 channel->header_pg = alloc_pages(GFP_KERNEL | __GFP_ZERO,
523 get_order(channel->header_size));
524 if (!channel->header_pg)
527 channel->header = page_address(channel->header_pg);
532 static void poch_channel_free_header(struct channel_info *channel)
536 order = get_order(channel->header_size);
537 __free_pages(channel->header_pg, order);
540 static void poch_channel_init_header(struct channel_info *channel)
543 struct poch_group_info *groups;
546 channel->header->group_size_bytes = channel->group_size;
547 channel->header->group_count = channel->group_count;
549 spin_lock_init(&channel->group_offsets_lock);
551 group_offsets = channel->header->group_offsets;
552 groups = channel->groups;
554 for (i = 0; i < channel->group_count; i++) {
555 if (channel->dir == CHANNEL_DIR_RX)
556 group_offsets[i] = -1;
558 group_offsets[i] = groups[i].user_offset;
562 static void __poch_channel_clear_counters(struct channel_info *channel)
564 channel->counters.pll_unlock = 0;
565 channel->counters.fifo_empty = 0;
566 channel->counters.fifo_overflow = 0;
569 static int poch_channel_init(struct channel_info *channel,
570 struct poch_dev *poch_dev)
572 struct pci_dev *pdev = poch_dev->pci_dev;
573 struct device *dev = &pdev->dev;
574 unsigned long alloc_size;
577 printk(KERN_WARNING "channel_latch_attr\n");
579 ret = channel_latch_attr(channel);
583 channel->transfer = 0;
585 /* Allocate memory to hold group information. */
586 alloc_size = channel->group_count * sizeof(struct poch_group_info);
587 channel->groups = kzalloc(alloc_size, GFP_KERNEL);
588 if (!channel->groups) {
589 dev_err(dev, "error allocating memory for group info\n");
594 printk(KERN_WARNING "poch_channel_alloc_groups\n");
596 ret = poch_channel_alloc_groups(channel);
598 dev_err(dev, "error allocating groups of order %d\n",
599 get_order(channel->group_size));
600 goto out_free_group_info;
603 ret = poch_channel_alloc_header(channel);
605 dev_err(dev, "error allocating user space header\n");
606 goto out_free_groups;
609 channel->fpga_iomem = poch_dev->fpga_iomem;
610 channel->bridge_iomem = poch_dev->bridge_iomem;
611 channel->iomem_lock = &poch_dev->iomem_lock;
612 spin_lock_init(&channel->counters_lock);
614 __poch_channel_clear_counters(channel);
616 printk(KERN_WARNING "poch_channel_init_header\n");
618 poch_channel_init_header(channel);
623 poch_channel_free_groups(channel);
625 kfree(channel->groups);
630 static int poch_wait_fpga_prog(void __iomem *bridge)
632 unsigned long total_wait;
633 const unsigned long wait_period = 100;
634 /* FIXME: Get the actual timeout */
635 const unsigned long prog_timeo = 10000; /* 10 Seconds */
638 printk(KERN_WARNING "poch_wait_fpg_prog\n");
640 printk(KERN_INFO PFX "programming fpga ...\n");
644 total_wait += wait_period;
646 card_power = ioread32(bridge + BRIDGE_CARD_POWER_REG);
647 if (card_power & BRIDGE_CARD_POWER_PROG_DONE) {
648 printk(KERN_INFO PFX "programming done\n");
651 if (total_wait > prog_timeo) {
653 "timed out while programming FPGA\n");
659 static void poch_card_power_off(struct poch_dev *poch_dev)
661 void __iomem *bridge = poch_dev->bridge_iomem;
664 iowrite32(0, bridge + BRIDGE_INT_MASK_REG);
665 iowrite32(0, bridge + BRIDGE_DMA_GO_REG);
667 card_power = ioread32(bridge + BRIDGE_CARD_POWER_REG);
668 iowrite32(card_power & ~BRIDGE_CARD_POWER_EN,
669 bridge + BRIDGE_CARD_POWER_REG);
677 static void poch_card_clock_on(void __iomem *fpga)
679 /* FIXME: Get this data through sysfs? */
680 enum clk_src clk_src = CLK_SRC_ON_BOARD;
682 if (clk_src == CLK_SRC_ON_BOARD) {
683 iowrite32(FPGA_ADC_CLOCK_LOCAL_CLK | FPGA_ADC_CLOCK_CTL_OSC_EN,
684 fpga + FPGA_ADC_CLOCK_CTL_REG);
685 } else if (clk_src == CLK_SRC_EXTERNAL) {
686 iowrite32(FPGA_ADC_CLOCK_EXT_SAMP_CLK,
687 fpga + FPGA_ADC_CLOCK_CTL_REG);
691 static int poch_card_power_on(struct poch_dev *poch_dev)
693 void __iomem *bridge = poch_dev->bridge_iomem;
694 void __iomem *fpga = poch_dev->fpga_iomem;
696 iowrite32(BRIDGE_CARD_POWER_EN, bridge + BRIDGE_CARD_POWER_REG);
698 if (poch_wait_fpga_prog(bridge) != 0) {
699 poch_card_power_off(poch_dev);
703 poch_card_clock_on(fpga);
705 /* Sync to new clock, reset state machines, set DMA mode. */
706 iowrite32(FPGA_DOM_DCM_RESET | FPGA_DOM_SOFT_RESET
707 | FPGA_DOM_DUAL_M_SG_DMA, fpga + FPGA_DOM_REG);
709 /* FIXME: The time required for sync. needs to be tuned. */
715 static void poch_channel_analog_on(struct channel_info *channel)
717 void __iomem *fpga = channel->fpga_iomem;
720 spin_lock(channel->iomem_lock);
721 adc_dac_en = ioread32(fpga + FPGA_ADC_DAC_EN_REG);
722 switch (channel->chno) {
723 case CHNO_RX_CHANNEL:
724 iowrite32(adc_dac_en & ~FPGA_ADC_DAC_EN_ADC_OFF,
725 fpga + FPGA_ADC_DAC_EN_REG);
727 case CHNO_TX_CHANNEL:
728 iowrite32(adc_dac_en & ~FPGA_ADC_DAC_EN_DAC_OFF,
729 fpga + FPGA_ADC_DAC_EN_REG);
732 spin_unlock(channel->iomem_lock);
735 static int poch_open(struct inode *inode, struct file *filp)
737 struct poch_dev *poch_dev;
738 struct channel_info *channel;
739 void __iomem *bridge;
745 poch_dev = container_of(inode->i_cdev, struct poch_dev, cdev);
746 bridge = poch_dev->bridge_iomem;
747 fpga = poch_dev->fpga_iomem;
749 chno = iminor(inode) % poch_dev->nchannels;
750 channel = &poch_dev->channels[chno];
752 if (!atomic_dec_and_test(&channel->free)) {
753 atomic_inc(&channel->free);
758 usage = atomic_inc_return(&poch_dev->usage);
760 printk(KERN_WARNING "poch_card_power_on\n");
763 ret = poch_card_power_on(poch_dev);
768 printk(KERN_INFO "CardBus Bridge Revision: %x\n",
769 ioread32(bridge + BRIDGE_REV_REG));
770 printk(KERN_INFO "CardBus Interface Revision: %x\n",
771 ioread32(fpga + FPGA_IFACE_REV_REG));
773 channel->chno = chno;
774 filp->private_data = channel;
776 printk(KERN_WARNING "poch_channel_init\n");
778 ret = poch_channel_init(channel, poch_dev);
782 poch_channel_analog_on(channel);
784 printk(KERN_WARNING "channel_dma_init\n");
786 channel_dma_init(channel);
788 printk(KERN_WARNING "poch_channel_analog_on\n");
791 printk(KERN_WARNING "setting up DMA\n");
793 /* Initialize DMA Controller. */
794 iowrite32(FPGA_CAP_FIFO_REG, bridge + BRIDGE_STAT_2_REG);
795 iowrite32(FPGA_DMA_DESC_1_REG, bridge + BRIDGE_STAT_3_REG);
797 ioread32(fpga + FPGA_DMA_INT_STAT_REG);
798 ioread32(fpga + FPGA_INT_STAT_REG);
799 ioread32(bridge + BRIDGE_INT_STAT_REG);
801 /* Initialize Interrupts. FIXME: Enable temperature
802 * handling We are enabling both Tx and Rx channel
803 * interrupts here. Do we need to enable interrupts
804 * only for the current channel? Anyways we won't get
805 * the interrupt unless the DMA is activated.
807 iowrite32(BRIDGE_INT_FPGA, bridge + BRIDGE_INT_MASK_REG);
808 iowrite32(FPGA_INT_DMA_CORE
809 | FPGA_INT_PLL_UNLOCKED
810 | FPGA_INT_TX_FF_EMPTY
811 | FPGA_INT_RX_FF_EMPTY
812 | FPGA_INT_TX_FF_OVRFLW
813 | FPGA_INT_RX_FF_OVRFLW,
814 fpga + FPGA_INT_MASK_REG);
815 iowrite32(FPGA_DMA_INT_RX | FPGA_DMA_INT_TX,
816 fpga + FPGA_DMA_INT_MASK_REG);
819 if (channel->dir == CHANNEL_DIR_TX) {
820 /* Flush TX FIFO and output data from cardbus. */
821 iowrite32(FPGA_TX_CTL_FIFO_FLUSH
822 | FPGA_TX_CTL_OUTPUT_CARDBUS,
823 fpga + FPGA_TX_CTL_REG);
825 /* Flush RX FIFO and output data to cardbus. */
826 iowrite32(FPGA_RX_CTL_CONT_CAP
827 | FPGA_RX_CTL_FIFO_FLUSH,
828 fpga + FPGA_RX_CTL_REG);
831 atomic_inc(&channel->inited);
837 poch_card_power_off(poch_dev);
839 atomic_dec(&poch_dev->usage);
840 atomic_inc(&channel->free);
845 static int poch_release(struct inode *inode, struct file *filp)
847 struct channel_info *channel = filp->private_data;
848 struct poch_dev *poch_dev;
851 poch_dev = container_of(inode->i_cdev, struct poch_dev, cdev);
853 usage = atomic_dec_return(&poch_dev->usage);
855 printk(KERN_WARNING "poch_card_power_off\n");
856 poch_card_power_off(poch_dev);
859 atomic_dec(&channel->inited);
860 poch_channel_free_header(channel);
861 poch_channel_free_groups(channel);
862 kfree(channel->groups);
863 atomic_inc(&channel->free);
869 * Map the header and the group buffers, to user space.
871 static int poch_mmap(struct file *filp, struct vm_area_struct *vma)
873 struct channel_info *channel = filp->private_data;
878 unsigned long group_pages;
879 unsigned long header_pages;
880 unsigned long total_group_pages;
888 printk(KERN_WARNING "poch_mmap\n");
891 printk(KERN_WARNING PFX "page offset: %lu\n", vma->vm_pgoff);
895 group_pages = npages(channel->group_size);
896 header_pages = npages(channel->header_size);
897 total_group_pages = group_pages * channel->group_count;
899 size = vma->vm_end - vma->vm_start;
900 if (size != (header_pages + total_group_pages) * PAGE_SIZE) {
901 printk(KERN_WARNING PFX "required %lu bytes\n", size);
905 start = vma->vm_start;
907 /* FIXME: Cleanup required on failure? */
908 pg = channel->header_pg;
909 for (pg_num = 0; pg_num < header_pages; pg_num++, pg++) {
910 printk(KERN_DEBUG PFX "page_count: %d\n", page_count(pg));
911 printk(KERN_DEBUG PFX "%d: header: 0x%lx\n", pg_num, start);
912 ret = vm_insert_page(vma, start, pg);
914 printk(KERN_DEBUG "vm_insert 1 failed at %lx\n", start);
920 for (i = 0; i < channel->group_count; i++) {
921 pg = channel->groups[i].pg;
922 for (pg_num = 0; pg_num < group_pages; pg_num++, pg++) {
923 printk(KERN_DEBUG PFX "%d: group %d: 0x%lx\n",
925 ret = vm_insert_page(vma, start, pg);
927 printk(KERN_DEBUG PFX
928 "vm_insert 2 failed at %d\n", pg_num);
939 * Check whether there is some group that the user space has not
940 * consumed yet. When the user space consumes a group, it sets it to
941 * -1. Cosuming could be reading data in case of RX and filling a
942 * buffer in case of TX.
944 static int poch_channel_available(struct channel_info *channel)
948 spin_lock_irq(&channel->group_offsets_lock);
950 for (i = 0; i < channel->group_count; i++) {
951 if (channel->header->group_offsets[i] != -1) {
952 spin_unlock_irq(&channel->group_offsets_lock);
957 spin_unlock_irq(&channel->group_offsets_lock);
962 static unsigned int poch_poll(struct file *filp, poll_table *pt)
964 struct channel_info *channel = filp->private_data;
965 unsigned int ret = 0;
967 poll_wait(filp, &channel->wq, pt);
969 if (poch_channel_available(channel)) {
970 if (channel->dir == CHANNEL_DIR_RX)
971 ret = POLLIN | POLLRDNORM;
973 ret = POLLOUT | POLLWRNORM;
979 static int poch_ioctl(struct inode *inode, struct file *filp,
980 unsigned int cmd, unsigned long arg)
982 struct channel_info *channel = filp->private_data;
983 void __iomem *fpga = channel->fpga_iomem;
984 void __iomem *bridge = channel->bridge_iomem;
985 void __user *argp = (void __user *)arg;
986 struct vm_area_struct *vms;
987 struct poch_counters counters;
991 case POCH_IOC_TRANSFER_START:
992 switch (channel->chno) {
993 case CHNO_TX_CHANNEL:
994 printk(KERN_INFO PFX "ioctl: Tx start\n");
995 iowrite32(0x1, fpga + FPGA_TX_TRIGGER_REG);
996 iowrite32(0x1, fpga + FPGA_TX_ENABLE_REG);
998 /* FIXME: Does it make sense to do a DMA GO
999 * twice, once in Tx and once in Rx.
1001 iowrite32(0x1, bridge + BRIDGE_DMA_GO_REG);
1003 case CHNO_RX_CHANNEL:
1004 printk(KERN_INFO PFX "ioctl: Rx start\n");
1005 iowrite32(0x1, fpga + FPGA_RX_ARM_REG);
1006 iowrite32(0x1, bridge + BRIDGE_DMA_GO_REG);
1010 case POCH_IOC_TRANSFER_STOP:
1011 switch (channel->chno) {
1012 case CHNO_TX_CHANNEL:
1013 printk(KERN_INFO PFX "ioctl: Tx stop\n");
1014 iowrite32(0x0, fpga + FPGA_TX_ENABLE_REG);
1015 iowrite32(0x0, fpga + FPGA_TX_TRIGGER_REG);
1016 iowrite32(0x0, bridge + BRIDGE_DMA_GO_REG);
1018 case CHNO_RX_CHANNEL:
1019 printk(KERN_INFO PFX "ioctl: Rx stop\n");
1020 iowrite32(0x0, fpga + FPGA_RX_ARM_REG);
1021 iowrite32(0x0, bridge + BRIDGE_DMA_GO_REG);
1025 case POCH_IOC_GET_COUNTERS:
1026 if (access_ok(VERIFY_WRITE, argp, sizeof(struct poch_counters)))
1029 spin_lock_irq(&channel->counters_lock);
1030 counters = channel->counters;
1031 __poch_channel_clear_counters(channel);
1032 spin_unlock_irq(&channel->counters_lock);
1034 ret = copy_to_user(argp, &counters,
1035 sizeof(struct poch_counters));
1040 case POCH_IOC_SYNC_GROUP_FOR_USER:
1041 case POCH_IOC_SYNC_GROUP_FOR_DEVICE:
1042 vms = find_vma(current->mm, arg);
1044 /* Address not mapped. */
1046 if (vms->vm_file != filp)
1047 /* Address mapped from different device/file. */
1050 flush_cache_range(vms, arg, arg + channel->group_size);
1056 static struct file_operations poch_fops = {
1057 .owner = THIS_MODULE,
1059 .release = poch_release,
1060 .ioctl = poch_ioctl,
1065 static void poch_irq_dma(struct channel_info *channel)
1071 struct poch_group_info *groups;
1075 if (!atomic_read(&channel->inited))
1078 prev_transfer = channel->transfer;
1080 if (channel->chno == CHNO_RX_CHANNEL)
1081 curr_group_reg = FPGA_RX_CURR_GROUP_REG;
1083 curr_group_reg = FPGA_TX_CURR_GROUP_REG;
1085 curr_transfer = ioread32(channel->fpga_iomem + curr_group_reg);
1087 groups_done = curr_transfer - prev_transfer;
1088 /* Check wrap over, and handle it. */
1089 if (groups_done <= 0)
1090 groups_done += channel->group_count;
1092 group_offsets = channel->header->group_offsets;
1093 groups = channel->groups;
1095 spin_lock(&channel->group_offsets_lock);
1097 for (i = 0; i < groups_done; i++) {
1098 j = (prev_transfer + i) % channel->group_count;
1099 group_offsets[j] = groups[j].user_offset;
1102 spin_unlock(&channel->group_offsets_lock);
1104 channel->transfer = curr_transfer;
1106 wake_up_interruptible(&channel->wq);
1109 static irqreturn_t poch_irq_handler(int irq, void *p)
1111 struct poch_dev *poch_dev = p;
1112 void __iomem *bridge = poch_dev->bridge_iomem;
1113 void __iomem *fpga = poch_dev->fpga_iomem;
1114 struct channel_info *channel_rx = &poch_dev->channels[CHNO_RX_CHANNEL];
1115 struct channel_info *channel_tx = &poch_dev->channels[CHNO_TX_CHANNEL];
1120 bridge_stat = ioread32(bridge + BRIDGE_INT_STAT_REG);
1121 fpga_stat = ioread32(fpga + FPGA_INT_STAT_REG);
1122 dma_stat = ioread32(fpga + FPGA_DMA_INT_STAT_REG);
1124 ioread32(fpga + FPGA_DMA_INT_STAT_REG);
1125 ioread32(fpga + FPGA_INT_STAT_REG);
1126 ioread32(bridge + BRIDGE_INT_STAT_REG);
1128 if (bridge_stat & BRIDGE_INT_FPGA) {
1129 if (fpga_stat & FPGA_INT_DMA_CORE) {
1130 if (dma_stat & FPGA_DMA_INT_RX)
1131 poch_irq_dma(channel_rx);
1132 if (dma_stat & FPGA_DMA_INT_TX)
1133 poch_irq_dma(channel_tx);
1135 if (fpga_stat & FPGA_INT_PLL_UNLOCKED) {
1136 channel_tx->counters.pll_unlock++;
1137 channel_rx->counters.pll_unlock++;
1138 if (printk_ratelimit())
1139 printk(KERN_WARNING PFX "PLL unlocked\n");
1141 if (fpga_stat & FPGA_INT_TX_FF_EMPTY)
1142 channel_tx->counters.fifo_empty++;
1143 if (fpga_stat & FPGA_INT_TX_FF_OVRFLW)
1144 channel_tx->counters.fifo_overflow++;
1145 if (fpga_stat & FPGA_INT_RX_FF_EMPTY)
1146 channel_rx->counters.fifo_empty++;
1147 if (fpga_stat & FPGA_INT_RX_FF_OVRFLW)
1148 channel_rx->counters.fifo_overflow++;
1151 * FIXME: These errors should be notified through the
1152 * poll interface as POLLERR.
1155 /* Re-enable interrupts. */
1156 iowrite32(BRIDGE_INT_FPGA, bridge + BRIDGE_INT_MASK_REG);
1164 static void poch_class_dev_unregister(struct poch_dev *poch_dev, int id)
1168 struct channel_info *channel;
1171 if (poch_dev->dev == NULL)
1174 for (i = 0; i < poch_dev->nchannels; i++) {
1175 channel = &poch_dev->channels[i];
1176 devno = poch_first_dev + (id * poch_dev->nchannels) + i;
1181 nattrs = sizeof(poch_class_attrs)/sizeof(poch_class_attrs[0]);
1182 for (j = 0; j < nattrs; j++)
1183 device_remove_file(channel->dev, poch_class_attrs[j]);
1185 device_unregister(channel->dev);
1188 device_unregister(poch_dev->dev);
1191 static int __devinit poch_class_dev_register(struct poch_dev *poch_dev,
1194 struct device *dev = &poch_dev->pci_dev->dev;
1198 struct channel_info *channel;
1201 poch_dev->dev = device_create(poch_cls, &poch_dev->pci_dev->dev,
1202 MKDEV(0, 0), NULL, "poch%d", id);
1203 if (IS_ERR(poch_dev->dev)) {
1204 dev_err(dev, "error creating parent class device");
1205 ret = PTR_ERR(poch_dev->dev);
1206 poch_dev->dev = NULL;
1210 for (i = 0; i < poch_dev->nchannels; i++) {
1211 channel = &poch_dev->channels[i];
1213 devno = poch_first_dev + (id * poch_dev->nchannels) + i;
1214 channel->dev = device_create(poch_cls, poch_dev->dev, devno,
1216 if (IS_ERR(channel->dev)) {
1217 dev_err(dev, "error creating channel class device");
1218 ret = PTR_ERR(channel->dev);
1219 channel->dev = NULL;
1220 poch_class_dev_unregister(poch_dev, id);
1224 dev_set_drvdata(channel->dev, channel);
1225 nattrs = sizeof(poch_class_attrs)/sizeof(poch_class_attrs[0]);
1226 for (j = 0; j < nattrs; j++) {
1227 ret = device_create_file(channel->dev,
1228 poch_class_attrs[j]);
1230 dev_err(dev, "error creating attribute file");
1231 poch_class_dev_unregister(poch_dev, id);
1240 static int __devinit poch_pci_probe(struct pci_dev *pdev,
1241 const struct pci_device_id *pci_id)
1243 struct device *dev = &pdev->dev;
1244 struct poch_dev *poch_dev;
1245 struct uio_info *uio;
1250 poch_dev = kzalloc(sizeof(struct poch_dev), GFP_KERNEL);
1252 dev_err(dev, "error allocating priv. data memory\n");
1256 poch_dev->pci_dev = pdev;
1257 uio = &poch_dev->uio;
1259 pci_set_drvdata(pdev, poch_dev);
1261 spin_lock_init(&poch_dev->iomem_lock);
1263 poch_dev->nchannels = POCH_NCHANNELS;
1264 poch_dev->channels[CHNO_RX_CHANNEL].dir = CHANNEL_DIR_RX;
1265 poch_dev->channels[CHNO_TX_CHANNEL].dir = CHANNEL_DIR_TX;
1267 for (i = 0; i < poch_dev->nchannels; i++) {
1268 init_waitqueue_head(&poch_dev->channels[i].wq);
1269 atomic_set(&poch_dev->channels[i].free, 1);
1270 atomic_set(&poch_dev->channels[i].inited, 0);
1273 ret = pci_enable_device(pdev);
1275 dev_err(dev, "error enabling device\n");
1279 ret = pci_request_regions(pdev, "poch");
1281 dev_err(dev, "error requesting resources\n");
1285 uio->mem[0].addr = pci_resource_start(pdev, 1);
1286 if (!uio->mem[0].addr) {
1287 dev_err(dev, "invalid BAR1\n");
1292 uio->mem[0].size = pci_resource_len(pdev, 1);
1293 uio->mem[0].memtype = UIO_MEM_PHYS;
1296 uio->version = "0.0.1";
1298 ret = uio_register_device(dev, uio);
1300 dev_err(dev, "error register UIO device: %d\n", ret);
1304 poch_dev->bridge_iomem = ioremap(pci_resource_start(pdev, 0),
1305 pci_resource_len(pdev, 0));
1306 if (poch_dev->bridge_iomem == NULL) {
1307 dev_err(dev, "error mapping bridge (bar0) registers\n");
1312 poch_dev->fpga_iomem = ioremap(pci_resource_start(pdev, 1),
1313 pci_resource_len(pdev, 1));
1314 if (poch_dev->fpga_iomem == NULL) {
1315 dev_err(dev, "error mapping fpga (bar1) registers\n");
1317 goto out_bar0_unmap;
1320 ret = request_irq(pdev->irq, poch_irq_handler, IRQF_SHARED,
1321 dev->bus_id, poch_dev);
1323 dev_err(dev, "error requesting IRQ %u\n", pdev->irq);
1325 goto out_bar1_unmap;
1328 if (!idr_pre_get(&poch_ids, GFP_KERNEL)) {
1329 dev_err(dev, "error allocating memory ids\n");
1334 idr_get_new(&poch_ids, poch_dev, &id);
1335 if (id >= MAX_POCH_CARDS) {
1336 dev_err(dev, "minors exhausted\n");
1341 cdev_init(&poch_dev->cdev, &poch_fops);
1342 poch_dev->cdev.owner = THIS_MODULE;
1343 ret = cdev_add(&poch_dev->cdev,
1344 poch_first_dev + (id * poch_dev->nchannels),
1345 poch_dev->nchannels);
1347 dev_err(dev, "error register character device\n");
1348 goto out_idr_remove;
1351 ret = poch_class_dev_register(poch_dev, id);
1358 cdev_del(&poch_dev->cdev);
1360 idr_remove(&poch_ids, id);
1362 free_irq(pdev->irq, poch_dev);
1364 iounmap(poch_dev->fpga_iomem);
1366 iounmap(poch_dev->bridge_iomem);
1368 uio_unregister_device(uio);
1370 pci_release_regions(pdev);
1372 pci_disable_device(pdev);
1379 * FIXME: We are yet to handle the hot unplug case.
1381 static void poch_pci_remove(struct pci_dev *pdev)
1383 struct poch_dev *poch_dev = pci_get_drvdata(pdev);
1384 struct uio_info *uio = &poch_dev->uio;
1385 unsigned int minor = MINOR(poch_dev->cdev.dev);
1386 unsigned int id = minor / poch_dev->nchannels;
1388 poch_class_dev_unregister(poch_dev, id);
1389 cdev_del(&poch_dev->cdev);
1390 idr_remove(&poch_ids, id);
1391 free_irq(pdev->irq, poch_dev);
1392 iounmap(poch_dev->fpga_iomem);
1393 iounmap(poch_dev->bridge_iomem);
1394 uio_unregister_device(uio);
1395 pci_release_regions(pdev);
1396 pci_disable_device(pdev);
1397 pci_set_drvdata(pdev, NULL);
1398 iounmap(uio->mem[0].internal_addr);
1403 static const struct pci_device_id poch_pci_ids[] /* __devinitconst */ = {
1404 { PCI_DEVICE(PCI_VENDOR_ID_RRAPIDS,
1405 PCI_DEVICE_ID_RRAPIDS_POCKET_CHANGE) },
1409 static struct pci_driver poch_pci_driver = {
1411 .id_table = poch_pci_ids,
1412 .probe = poch_pci_probe,
1413 .remove = poch_pci_remove,
1416 static int __init poch_init_module(void)
1420 ret = alloc_chrdev_region(&poch_first_dev, 0,
1421 MAX_POCH_DEVICES, DRV_NAME);
1423 printk(KERN_ERR PFX "error allocating device no.");
1427 poch_cls = class_create(THIS_MODULE, "pocketchange");
1428 if (IS_ERR(poch_cls)) {
1429 ret = PTR_ERR(poch_cls);
1430 goto out_unreg_chrdev;
1433 ret = pci_register_driver(&poch_pci_driver);
1435 printk(KERN_ERR PFX "error register PCI device");
1436 goto out_class_destroy;
1442 class_destroy(poch_cls);
1445 unregister_chrdev_region(poch_first_dev, MAX_POCH_DEVICES);
1450 static void __exit poch_exit_module(void)
1452 pci_unregister_driver(&poch_pci_driver);
1453 class_destroy(poch_cls);
1454 unregister_chrdev_region(poch_first_dev, MAX_POCH_DEVICES);
1457 module_init(poch_init_module);
1458 module_exit(poch_exit_module);
1460 MODULE_LICENSE("GPL v2");