drivers/dma/mv_xor.h

   1 /*
   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
  27 #define MV_XOR_POOL_SIZE                PAGE_SIZE
  28 #define MV_XOR_SLOT_SIZE                64
  29 #define MV_XOR_THRESHOLD                1
  30 #define MV_XOR_MAX_CHANNELS             2
  31
  32 /* Values for the XOR_CONFIG register */
  33 #define XOR_OPERATION_MODE_XOR          0
  34 #define XOR_OPERATION_MODE_MEMCPY       2
  35 #define XOR_DESCRIPTOR_SWAP             BIT(14)
  36
  37 #define XOR_CURR_DESC(chan)     (chan->mmr_base + 0x210 + (chan->idx * 4))
  38 #define XOR_NEXT_DESC(chan)     (chan->mmr_base + 0x200 + (chan->idx * 4))
  39 #define XOR_BYTE_COUNT(chan)    (chan->mmr_base + 0x220 + (chan->idx * 4))
  40 #define XOR_DEST_POINTER(chan)  (chan->mmr_base + 0x2B0 + (chan->idx * 4))
  41 #define XOR_BLOCK_SIZE(chan)    (chan->mmr_base + 0x2C0 + (chan->idx * 4))
  42 #define XOR_INIT_VALUE_LOW(chan)        (chan->mmr_base + 0x2E0)
  43 #define XOR_INIT_VALUE_HIGH(chan)       (chan->mmr_base + 0x2E4)
  44
  45 #define XOR_CONFIG(chan)        (chan->mmr_base + 0x10 + (chan->idx * 4))
  46 #define XOR_ACTIVATION(chan)    (chan->mmr_base + 0x20 + (chan->idx * 4))
  47 #define XOR_INTR_CAUSE(chan)    (chan->mmr_base + 0x30)
  48 #define XOR_INTR_MASK(chan)     (chan->mmr_base + 0x40)
  49 #define XOR_ERROR_CAUSE(chan)   (chan->mmr_base + 0x50)
  50 #define XOR_ERROR_ADDR(chan)    (chan->mmr_base + 0x60)
  51 #define XOR_INTR_MASK_VALUE     0x3F5
  52
  53 #define WINDOW_BASE(w)          (0x250 + ((w) << 2))
  54 #define WINDOW_SIZE(w)          (0x270 + ((w) << 2))
  55 #define WINDOW_REMAP_HIGH(w)    (0x290 + ((w) << 2))
  56 #define WINDOW_BAR_ENABLE(chan) (0x240 + ((chan) << 2))
  57 #define WINDOW_OVERRIDE_CTRL(chan)      (0x2A0 + ((chan) << 2))
  58
  59 struct mv_xor_device {
  60         void __iomem         *xor_base;
  61         void __iomem         *xor_high_base;
  62         struct clk           *clk;
  63         struct mv_xor_chan   *channels[MV_XOR_MAX_CHANNELS];
  64 };
  65
  66 /**
  67  * struct mv_xor_chan - internal representation of a XOR channel
  68  * @pending: allows batching of hardware operations
  69  * @lock: serializes enqueue/dequeue operations to the descriptors pool
  70  * @mmr_base: memory mapped register base
  71  * @idx: the index of the xor channel
  72  * @chain: device chain view of the descriptors
  73  * @completed_slots: slots completed by HW but still need to be acked
  74  * @device: parent device
  75  * @common: common dmaengine channel object members
  76  * @last_used: place holder for allocation to continue from where it left off
  77  * @all_slots: complete domain of slots usable by the channel
  78  * @slots_allocated: records the actual size of the descriptor slot pool
  79  * @irq_tasklet: bottom half where mv_xor_slot_cleanup runs
  80  */
  81 struct mv_xor_chan {
  82         int                     pending;
  83         spinlock_t              lock; /* protects the descriptor slot pool */
  84         void __iomem            *mmr_base;
  85         unsigned int            idx;
  86         int                     irq;
  87         enum dma_transaction_type       current_type;
  88         struct list_head        chain;
  89         struct list_head        completed_slots;
  90         dma_addr_t              dma_desc_pool;
  91         void                    *dma_desc_pool_virt;
  92         size_t                  pool_size;
  93         struct dma_device       dmadev;
  94         struct dma_chan         dmachan;
  95         struct mv_xor_desc_slot *last_used;
  96         struct list_head        all_slots;
  97         int                     slots_allocated;
  98         struct tasklet_struct   irq_tasklet;
  99 #ifdef USE_TIMER
 100         unsigned long           cleanup_time;
 101         u32                     current_on_last_cleanup;
 102 #endif
 103 };
 104
 105 /**
 106  * struct mv_xor_desc_slot - software descriptor
 107  * @slot_node: node on the mv_xor_chan.all_slots list
 108  * @chain_node: node on the mv_xor_chan.chain list
 109  * @completed_node: node on the mv_xor_chan.completed_slots list
 110  * @hw_desc: virtual address of the hardware descriptor chain
 111  * @phys: hardware address of the hardware descriptor chain
 112  * @group_head: first operation in a transaction
 113  * @slot_cnt: total slots used in an transaction (group of operations)
 114  * @slots_per_op: number of slots per operation
 115  * @idx: pool index
 116  * @unmap_src_cnt: number of xor sources
 117  * @unmap_len: transaction bytecount
 118  * @tx_list: list of slots that make up a multi-descriptor transaction
 119  * @async_tx: support for the async_tx api
 120  * @xor_check_result: result of zero sum
 121  * @crc32_result: result crc calculation
 122  */
 123 struct mv_xor_desc_slot {
 124         struct list_head        slot_node;
 125         struct list_head        chain_node;
 126         struct list_head        completed_node;
 127         enum dma_transaction_type       type;
 128         void                    *hw_desc;
 129         struct mv_xor_desc_slot *group_head;
 130         u16                     slot_cnt;
 131         u16                     slots_per_op;
 132         u16                     idx;
 133         u16                     unmap_src_cnt;
 134         u32                     value;
 135         size_t                  unmap_len;
 136         struct list_head        tx_list;
 137         struct dma_async_tx_descriptor  async_tx;
 138         union {
 139                 u32             *xor_check_result;
 140                 u32             *crc32_result;
 141         };
 142 #ifdef USE_TIMER
 143         unsigned long           arrival_time;
 144         struct timer_list       timeout;
 145 #endif
 146 };
 147
 148 /*
 149  * This structure describes XOR descriptor size 64bytes. The
 150  * mv_phy_src_idx() macro must be used when indexing the values of the
 151  * phy_src_addr[] array. This is due to the fact that the 'descriptor
 152  * swap' feature, used on big endian systems, swaps descriptors data
 153  * within blocks of 8 bytes. So two consecutive values of the
 154  * phy_src_addr[] array are actually swapped in big-endian, which
 155  * explains the different mv_phy_src_idx() implementation.
 156  */
 157 #if defined(__LITTLE_ENDIAN)
 158 struct mv_xor_desc {
 159         u32 status;             /* descriptor execution status */
 160         u32 crc32_result;       /* result of CRC-32 calculation */
 161         u32 desc_command;       /* type of operation to be carried out */
 162         u32 phy_next_desc;      /* next descriptor address pointer */
 163         u32 byte_count;         /* size of src/dst blocks in bytes */
 164         u32 phy_dest_addr;      /* destination block address */
 165         u32 phy_src_addr[8];    /* source block addresses */
 166         u32 reserved0;
 167         u32 reserved1;
 168 };
 169 #define mv_phy_src_idx(src_idx) (src_idx)
 170 #else
 171 struct mv_xor_desc {
 172         u32 crc32_result;       /* result of CRC-32 calculation */
 173         u32 status;             /* descriptor execution status */
 174         u32 phy_next_desc;      /* next descriptor address pointer */
 175         u32 desc_command;       /* type of operation to be carried out */
 176         u32 phy_dest_addr;      /* destination block address */
 177         u32 byte_count;         /* size of src/dst blocks in bytes */
 178         u32 phy_src_addr[8];    /* source block addresses */
 179         u32 reserved1;
 180         u32 reserved0;
 181 };
 182 #define mv_phy_src_idx(src_idx) (src_idx ^ 1)
 183 #endif
 184
 185 #define to_mv_sw_desc(addr_hw_desc)             \
 186         container_of(addr_hw_desc, struct mv_xor_desc_slot, hw_desc)
 187
 188 #define mv_hw_desc_slot_idx(hw_desc, idx)       \
 189         ((void *)(((unsigned long)hw_desc) + ((idx) << 5)))
 190
 191 #define MV_XOR_MIN_BYTE_COUNT   (128)
 192 #define XOR_MAX_BYTE_COUNT      ((16 * 1024 * 1024) - 1)
 193 #define MV_XOR_MAX_BYTE_COUNT   XOR_MAX_BYTE_COUNT
 194
 195
 196 #endif