blob: c619359cb7febd1406d06773320f2281928d3274 [file] [log] [blame]
Saeed Bisharaff7b0472008-07-08 11:58:36 -07001/*
2 * Copyright (C) 2007, 2008, Marvell International Ltd.
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
11 * for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software Foundation,
15 * Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
16 */
17
18#ifndef MV_XOR_H
19#define MV_XOR_H
20
21#include <linux/types.h>
22#include <linux/io.h>
23#include <linux/dmaengine.h>
24#include <linux/interrupt.h>
25
26#define USE_TIMER
Thomas Petazzonib503fa02012-11-15 15:55:30 +010027#define MV_XOR_POOL_SIZE PAGE_SIZE
Saeed Bisharaff7b0472008-07-08 11:58:36 -070028#define MV_XOR_SLOT_SIZE 64
29#define MV_XOR_THRESHOLD 1
Thomas Petazzoni60d151f2012-10-29 16:54:49 +010030#define MV_XOR_MAX_CHANNELS 2
Saeed Bisharaff7b0472008-07-08 11:58:36 -070031
32#define XOR_OPERATION_MODE_XOR 0
33#define XOR_OPERATION_MODE_MEMCPY 2
Saeed Bisharaff7b0472008-07-08 11:58:36 -070034
35#define XOR_CURR_DESC(chan) (chan->mmr_base + 0x210 + (chan->idx * 4))
36#define XOR_NEXT_DESC(chan) (chan->mmr_base + 0x200 + (chan->idx * 4))
37#define XOR_BYTE_COUNT(chan) (chan->mmr_base + 0x220 + (chan->idx * 4))
38#define XOR_DEST_POINTER(chan) (chan->mmr_base + 0x2B0 + (chan->idx * 4))
39#define XOR_BLOCK_SIZE(chan) (chan->mmr_base + 0x2C0 + (chan->idx * 4))
40#define XOR_INIT_VALUE_LOW(chan) (chan->mmr_base + 0x2E0)
41#define XOR_INIT_VALUE_HIGH(chan) (chan->mmr_base + 0x2E4)
42
43#define XOR_CONFIG(chan) (chan->mmr_base + 0x10 + (chan->idx * 4))
44#define XOR_ACTIVATION(chan) (chan->mmr_base + 0x20 + (chan->idx * 4))
45#define XOR_INTR_CAUSE(chan) (chan->mmr_base + 0x30)
46#define XOR_INTR_MASK(chan) (chan->mmr_base + 0x40)
47#define XOR_ERROR_CAUSE(chan) (chan->mmr_base + 0x50)
48#define XOR_ERROR_ADDR(chan) (chan->mmr_base + 0x60)
49#define XOR_INTR_MASK_VALUE 0x3F5
50
51#define WINDOW_BASE(w) (0x250 + ((w) << 2))
52#define WINDOW_SIZE(w) (0x270 + ((w) << 2))
53#define WINDOW_REMAP_HIGH(w) (0x290 + ((w) << 2))
54#define WINDOW_BAR_ENABLE(chan) (0x240 + ((chan) << 2))
Thomas Petazzonic4b4b732012-11-22 18:16:37 +010055#define WINDOW_OVERRIDE_CTRL(chan) (0x2A0 + ((chan) << 2))
Saeed Bisharaff7b0472008-07-08 11:58:36 -070056
Thomas Petazzoni297eedb2012-11-15 15:29:53 +010057struct mv_xor_device {
Thomas Petazzoni60d151f2012-10-29 16:54:49 +010058 void __iomem *xor_base;
59 void __iomem *xor_high_base;
60 struct clk *clk;
Thomas Petazzoni1ef48a22012-11-15 15:17:05 +010061 struct mv_xor_chan *channels[MV_XOR_MAX_CHANNELS];
Saeed Bisharaff7b0472008-07-08 11:58:36 -070062};
63
64/**
65 * struct mv_xor_chan - internal representation of a XOR channel
66 * @pending: allows batching of hardware operations
Saeed Bisharaff7b0472008-07-08 11:58:36 -070067 * @lock: serializes enqueue/dequeue operations to the descriptors pool
68 * @mmr_base: memory mapped register base
69 * @idx: the index of the xor channel
70 * @chain: device chain view of the descriptors
71 * @completed_slots: slots completed by HW but still need to be acked
72 * @device: parent device
73 * @common: common dmaengine channel object members
74 * @last_used: place holder for allocation to continue from where it left off
75 * @all_slots: complete domain of slots usable by the channel
76 * @slots_allocated: records the actual size of the descriptor slot pool
77 * @irq_tasklet: bottom half where mv_xor_slot_cleanup runs
78 */
79struct mv_xor_chan {
80 int pending;
Saeed Bisharaff7b0472008-07-08 11:58:36 -070081 spinlock_t lock; /* protects the descriptor slot pool */
82 void __iomem *mmr_base;
83 unsigned int idx;
Thomas Petazzoni88eb92c2012-11-15 16:11:18 +010084 int irq;
Saeed Bisharaff7b0472008-07-08 11:58:36 -070085 enum dma_transaction_type current_type;
86 struct list_head chain;
87 struct list_head completed_slots;
Thomas Petazzoni1ef48a22012-11-15 15:17:05 +010088 dma_addr_t dma_desc_pool;
89 void *dma_desc_pool_virt;
90 size_t pool_size;
91 struct dma_device dmadev;
Thomas Petazzoni98817b92012-11-15 14:57:44 +010092 struct dma_chan dmachan;
Saeed Bisharaff7b0472008-07-08 11:58:36 -070093 struct mv_xor_desc_slot *last_used;
94 struct list_head all_slots;
95 int slots_allocated;
96 struct tasklet_struct irq_tasklet;
97#ifdef USE_TIMER
98 unsigned long cleanup_time;
99 u32 current_on_last_cleanup;
Saeed Bisharaff7b0472008-07-08 11:58:36 -0700100#endif
101};
102
103/**
104 * struct mv_xor_desc_slot - software descriptor
105 * @slot_node: node on the mv_xor_chan.all_slots list
106 * @chain_node: node on the mv_xor_chan.chain list
107 * @completed_node: node on the mv_xor_chan.completed_slots list
108 * @hw_desc: virtual address of the hardware descriptor chain
109 * @phys: hardware address of the hardware descriptor chain
110 * @group_head: first operation in a transaction
111 * @slot_cnt: total slots used in an transaction (group of operations)
112 * @slots_per_op: number of slots per operation
113 * @idx: pool index
114 * @unmap_src_cnt: number of xor sources
115 * @unmap_len: transaction bytecount
Dan Williams64203b62009-09-08 17:53:03 -0700116 * @tx_list: list of slots that make up a multi-descriptor transaction
Saeed Bisharaff7b0472008-07-08 11:58:36 -0700117 * @async_tx: support for the async_tx api
Saeed Bisharaff7b0472008-07-08 11:58:36 -0700118 * @xor_check_result: result of zero sum
119 * @crc32_result: result crc calculation
120 */
121struct mv_xor_desc_slot {
122 struct list_head slot_node;
123 struct list_head chain_node;
124 struct list_head completed_node;
125 enum dma_transaction_type type;
126 void *hw_desc;
127 struct mv_xor_desc_slot *group_head;
128 u16 slot_cnt;
129 u16 slots_per_op;
130 u16 idx;
131 u16 unmap_src_cnt;
132 u32 value;
133 size_t unmap_len;
Dan Williams64203b62009-09-08 17:53:03 -0700134 struct list_head tx_list;
Saeed Bisharaff7b0472008-07-08 11:58:36 -0700135 struct dma_async_tx_descriptor async_tx;
136 union {
137 u32 *xor_check_result;
138 u32 *crc32_result;
139 };
140#ifdef USE_TIMER
141 unsigned long arrival_time;
142 struct timer_list timeout;
143#endif
144};
145
146/* This structure describes XOR descriptor size 64bytes */
147struct mv_xor_desc {
148 u32 status; /* descriptor execution status */
149 u32 crc32_result; /* result of CRC-32 calculation */
150 u32 desc_command; /* type of operation to be carried out */
151 u32 phy_next_desc; /* next descriptor address pointer */
152 u32 byte_count; /* size of src/dst blocks in bytes */
153 u32 phy_dest_addr; /* destination block address */
154 u32 phy_src_addr[8]; /* source block addresses */
155 u32 reserved0;
156 u32 reserved1;
157};
158
159#define to_mv_sw_desc(addr_hw_desc) \
160 container_of(addr_hw_desc, struct mv_xor_desc_slot, hw_desc)
161
162#define mv_hw_desc_slot_idx(hw_desc, idx) \
163 ((void *)(((unsigned long)hw_desc) + ((idx) << 5)))
164
165#define MV_XOR_MIN_BYTE_COUNT (128)
166#define XOR_MAX_BYTE_COUNT ((16 * 1024 * 1024) - 1)
167#define MV_XOR_MAX_BYTE_COUNT XOR_MAX_BYTE_COUNT
168
169
170#endif