2 * Copyright (C) 2006-2007 PA Semi, Inc
4 * Common functions for DMA access on PA Semi PWRficient
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 #include <linux/init.h>
21 #include <linux/module.h>
22 #include <linux/pci.h>
25 #include <asm/pasemi_dma.h>
30 static struct pasdma_status *dma_status;
32 static void __iomem *iob_regs;
33 static void __iomem *mac_regs[6];
34 static void __iomem *dma_regs;
36 static int base_hw_irq;
38 static int num_txch, num_rxch;
40 static struct pci_dev *dma_pdev;
42 /* Bitmaps to handle allocation of channels */
44 static DECLARE_BITMAP(txch_free, MAX_TXCH);
45 static DECLARE_BITMAP(rxch_free, MAX_RXCH);
47 /* pasemi_read_iob_reg - read IOB register
48 * @reg: Register to read (offset into PCI CFG space)
50 unsigned int pasemi_read_iob_reg(unsigned int reg)
52 return in_le32(iob_regs+reg);
54 EXPORT_SYMBOL(pasemi_read_iob_reg);
56 /* pasemi_write_iob_reg - write IOB register
57 * @reg: Register to write to (offset into PCI CFG space)
58 * @val: Value to write
60 void pasemi_write_iob_reg(unsigned int reg, unsigned int val)
62 out_le32(iob_regs+reg, val);
64 EXPORT_SYMBOL(pasemi_write_iob_reg);
66 /* pasemi_read_mac_reg - read MAC register
67 * @intf: MAC interface
68 * @reg: Register to read (offset into PCI CFG space)
70 unsigned int pasemi_read_mac_reg(int intf, unsigned int reg)
72 return in_le32(mac_regs[intf]+reg);
74 EXPORT_SYMBOL(pasemi_read_mac_reg);
76 /* pasemi_write_mac_reg - write MAC register
77 * @intf: MAC interface
78 * @reg: Register to write to (offset into PCI CFG space)
79 * @val: Value to write
81 void pasemi_write_mac_reg(int intf, unsigned int reg, unsigned int val)
83 out_le32(mac_regs[intf]+reg, val);
85 EXPORT_SYMBOL(pasemi_write_mac_reg);
87 /* pasemi_read_dma_reg - read DMA register
88 * @reg: Register to read (offset into PCI CFG space)
90 unsigned int pasemi_read_dma_reg(unsigned int reg)
92 return in_le32(dma_regs+reg);
94 EXPORT_SYMBOL(pasemi_read_dma_reg);
96 /* pasemi_write_dma_reg - write DMA register
97 * @reg: Register to write to (offset into PCI CFG space)
98 * @val: Value to write
100 void pasemi_write_dma_reg(unsigned int reg, unsigned int val)
102 out_le32(dma_regs+reg, val);
104 EXPORT_SYMBOL(pasemi_write_dma_reg);
106 static int pasemi_alloc_tx_chan(enum pasemi_dmachan_type type)
111 switch (type & (TXCHAN_EVT0|TXCHAN_EVT1)) {
126 bit = find_next_bit(txch_free, MAX_TXCH, start);
129 if (!test_and_clear_bit(bit, txch_free))
135 static void pasemi_free_tx_chan(int chan)
137 BUG_ON(test_bit(chan, txch_free));
138 set_bit(chan, txch_free);
141 static int pasemi_alloc_rx_chan(void)
145 bit = find_first_bit(rxch_free, MAX_RXCH);
148 if (!test_and_clear_bit(bit, rxch_free))
154 static void pasemi_free_rx_chan(int chan)
156 BUG_ON(test_bit(chan, rxch_free));
157 set_bit(chan, rxch_free);
160 /* pasemi_dma_alloc_chan - Allocate a DMA channel
161 * @type: Type of channel to allocate
162 * @total_size: Total size of structure to allocate (to allow for more
163 * room behind the structure to be used by the client)
164 * @offset: Offset in bytes from start of the total structure to the beginning
165 * of struct pasemi_dmachan. Needed when struct pasemi_dmachan is
166 * not the first member of the client structure.
168 * pasemi_dma_alloc_chan allocates a DMA channel for use by a client. The
169 * type argument specifies whether it's a RX or TX channel, and in the case
170 * of TX channels which group it needs to belong to (if any).
172 * Returns a pointer to the total structure allocated on success, NULL
175 void *pasemi_dma_alloc_chan(enum pasemi_dmachan_type type,
176 int total_size, int offset)
179 struct pasemi_dmachan *chan;
182 BUG_ON(total_size < sizeof(struct pasemi_dmachan));
184 buf = kzalloc(total_size, GFP_KERNEL);
192 switch (type & (TXCHAN|RXCHAN)) {
194 chno = pasemi_alloc_rx_chan();
196 chan->irq = irq_create_mapping(NULL,
197 base_hw_irq + num_txch + chno);
198 chan->status = &dma_status->rx_sta[chno];
201 chno = pasemi_alloc_tx_chan(type);
203 chan->irq = irq_create_mapping(NULL, base_hw_irq + chno);
204 chan->status = &dma_status->tx_sta[chno];
208 chan->chan_type = type;
212 EXPORT_SYMBOL(pasemi_dma_alloc_chan);
214 /* pasemi_dma_free_chan - Free a previously allocated channel
215 * @chan: Channel to free
217 * Frees a previously allocated channel. It will also deallocate any
218 * descriptor ring associated with the channel, if allocated.
220 void pasemi_dma_free_chan(struct pasemi_dmachan *chan)
223 pasemi_dma_free_ring(chan);
225 switch (chan->chan_type & (RXCHAN|TXCHAN)) {
227 pasemi_free_rx_chan(chan->chno);
230 pasemi_free_tx_chan(chan->chno);
236 EXPORT_SYMBOL(pasemi_dma_free_chan);
238 /* pasemi_dma_alloc_ring - Allocate descriptor ring for a channel
239 * @chan: Channel for which to allocate
240 * @ring_size: Ring size in 64-bit (8-byte) words
242 * Allocate a descriptor ring for a channel. Returns 0 on success, errno
243 * on failure. The passed in struct pasemi_dmachan is updated with the
244 * virtual and DMA addresses of the ring.
246 int pasemi_dma_alloc_ring(struct pasemi_dmachan *chan, int ring_size)
248 BUG_ON(chan->ring_virt);
250 chan->ring_size = ring_size;
252 chan->ring_virt = dma_alloc_coherent(&dma_pdev->dev,
253 ring_size * sizeof(u64),
254 &chan->ring_dma, GFP_KERNEL);
256 if (!chan->ring_virt)
259 memset(chan->ring_virt, 0, ring_size * sizeof(u64));
263 EXPORT_SYMBOL(pasemi_dma_alloc_ring);
265 /* pasemi_dma_free_ring - Free an allocated descriptor ring for a channel
266 * @chan: Channel for which to free the descriptor ring
268 * Frees a previously allocated descriptor ring for a channel.
270 void pasemi_dma_free_ring(struct pasemi_dmachan *chan)
272 BUG_ON(!chan->ring_virt);
274 dma_free_coherent(&dma_pdev->dev, chan->ring_size * sizeof(u64),
275 chan->ring_virt, chan->ring_dma);
276 chan->ring_virt = NULL;
280 EXPORT_SYMBOL(pasemi_dma_free_ring);
282 /* pasemi_dma_start_chan - Start a DMA channel
283 * @chan: Channel to start
284 * @cmdsta: Additional CCMDSTA/TCMDSTA bits to write
286 * Enables (starts) a DMA channel with optional additional arguments.
288 void pasemi_dma_start_chan(const struct pasemi_dmachan *chan, const u32 cmdsta)
290 if (chan->chan_type == RXCHAN)
291 pasemi_write_dma_reg(PAS_DMA_RXCHAN_CCMDSTA(chan->chno),
292 cmdsta | PAS_DMA_RXCHAN_CCMDSTA_EN);
294 pasemi_write_dma_reg(PAS_DMA_TXCHAN_TCMDSTA(chan->chno),
295 cmdsta | PAS_DMA_TXCHAN_TCMDSTA_EN);
297 EXPORT_SYMBOL(pasemi_dma_start_chan);
299 /* pasemi_dma_stop_chan - Stop a DMA channel
300 * @chan: Channel to stop
302 * Stops (disables) a DMA channel. This is done by setting the ST bit in the
303 * CMDSTA register and waiting on the ACT (active) bit to clear, then
304 * finally disabling the whole channel.
306 * This function will only try for a short while for the channel to stop, if
307 * it doesn't it will return failure.
309 * Returns 1 on success, 0 on failure.
311 #define MAX_RETRIES 5000
312 int pasemi_dma_stop_chan(const struct pasemi_dmachan *chan)
317 if (chan->chan_type == RXCHAN) {
318 reg = PAS_DMA_RXCHAN_CCMDSTA(chan->chno);
319 pasemi_write_dma_reg(reg, PAS_DMA_RXCHAN_CCMDSTA_ST);
320 for (retries = 0; retries < MAX_RETRIES; retries++) {
321 sta = pasemi_read_dma_reg(reg);
322 if (!(sta & PAS_DMA_RXCHAN_CCMDSTA_ACT)) {
323 pasemi_write_dma_reg(reg, 0);
329 reg = PAS_DMA_TXCHAN_TCMDSTA(chan->chno);
330 pasemi_write_dma_reg(reg, PAS_DMA_TXCHAN_TCMDSTA_ST);
331 for (retries = 0; retries < MAX_RETRIES; retries++) {
332 sta = pasemi_read_dma_reg(reg);
333 if (!(sta & PAS_DMA_TXCHAN_TCMDSTA_ACT)) {
334 pasemi_write_dma_reg(reg, 0);
343 EXPORT_SYMBOL(pasemi_dma_stop_chan);
345 /* pasemi_dma_alloc_buf - Allocate a buffer to use for DMA
346 * @chan: Channel to allocate for
347 * @size: Size of buffer in bytes
348 * @handle: DMA handle
350 * Allocate a buffer to be used by the DMA engine for read/write,
351 * similar to dma_alloc_coherent().
353 * Returns the virtual address of the buffer, or NULL in case of failure.
355 void *pasemi_dma_alloc_buf(struct pasemi_dmachan *chan, int size,
358 return dma_alloc_coherent(&dma_pdev->dev, size, handle, GFP_KERNEL);
360 EXPORT_SYMBOL(pasemi_dma_alloc_buf);
362 /* pasemi_dma_free_buf - Free a buffer used for DMA
363 * @chan: Channel the buffer was allocated for
364 * @size: Size of buffer in bytes
365 * @handle: DMA handle
367 * Frees a previously allocated buffer.
369 void pasemi_dma_free_buf(struct pasemi_dmachan *chan, int size,
372 dma_free_coherent(&dma_pdev->dev, size, handle, GFP_KERNEL);
374 EXPORT_SYMBOL(pasemi_dma_free_buf);
376 static void *map_onedev(struct pci_dev *p, int index)
378 struct device_node *dn;
381 dn = pci_device_to_OF_node(p);
385 ret = of_iomap(dn, index);
391 /* This is hardcoded and ugly, but we have some firmware versions
392 * that don't provide the register space in the device tree. Luckily
393 * they are at well-known locations so we can just do the math here.
395 return ioremap(0xe0000000 + (p->devfn << 12), 0x2000);
398 /* pasemi_dma_init - Initialize the PA Semi DMA library
400 * This function initializes the DMA library. It must be called before
401 * any other function in the library.
403 * Returns 0 on success, errno on failure.
405 int pasemi_dma_init(void)
407 static spinlock_t init_lock = SPIN_LOCK_UNLOCKED;
408 struct pci_dev *iob_pdev;
409 struct pci_dev *pdev;
411 struct device_node *dn;
412 int i, intf, err = 0;
415 if (!machine_is(pasemi))
418 spin_lock(&init_lock);
420 /* Make sure we haven't already initialized */
424 iob_pdev = pci_get_device(PCI_VENDOR_ID_PASEMI, 0xa001, NULL);
427 printk(KERN_WARNING "Can't find I/O Bridge\n");
431 iob_regs = map_onedev(iob_pdev, 0);
433 dma_pdev = pci_get_device(PCI_VENDOR_ID_PASEMI, 0xa007, NULL);
436 printk(KERN_WARNING "Can't find DMA controller\n");
440 dma_regs = map_onedev(dma_pdev, 0);
441 base_hw_irq = virq_to_hw(dma_pdev->irq);
443 pci_read_config_dword(dma_pdev, PAS_DMA_CAP_TXCH, &tmp);
444 num_txch = (tmp & PAS_DMA_CAP_TXCH_TCHN_M) >> PAS_DMA_CAP_TXCH_TCHN_S;
446 pci_read_config_dword(dma_pdev, PAS_DMA_CAP_RXCH, &tmp);
447 num_rxch = (tmp & PAS_DMA_CAP_RXCH_RCHN_M) >> PAS_DMA_CAP_RXCH_RCHN_S;
450 for (pdev = pci_get_device(PCI_VENDOR_ID_PASEMI, 0xa006, NULL);
452 pdev = pci_get_device(PCI_VENDOR_ID_PASEMI, 0xa006, pdev))
453 mac_regs[intf++] = map_onedev(pdev, 0);
457 for (pdev = pci_get_device(PCI_VENDOR_ID_PASEMI, 0xa005, NULL);
459 pdev = pci_get_device(PCI_VENDOR_ID_PASEMI, 0xa005, pdev))
460 mac_regs[intf++] = map_onedev(pdev, 0);
464 dn = pci_device_to_OF_node(iob_pdev);
466 err = of_address_to_resource(dn, 1, &res);
468 /* Fallback for old firmware */
469 res.start = 0xfd800000;
470 res.end = res.start + 0x1000;
472 dma_status = __ioremap(res.start, res.end-res.start, 0);
473 pci_dev_put(iob_pdev);
475 for (i = 0; i < MAX_TXCH; i++)
476 __set_bit(i, txch_free);
478 for (i = 0; i < MAX_RXCH; i++)
479 __set_bit(i, rxch_free);
481 printk(KERN_INFO "PA Semi PWRficient DMA library initialized "
482 "(%d tx, %d rx channels)\n", num_txch, num_rxch);
485 spin_unlock(&init_lock);
488 EXPORT_SYMBOL(pasemi_dma_init);