drivers/scsi/isci/core/sci_util.h

   1 /*
   2  * This file is provided under a dual BSD/GPLv2 license.  When using or
   3  * redistributing this file, you may do so under either license.
   4  *
   5  * GPL LICENSE SUMMARY
   6  *
   7  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of version 2 of the GNU General Public License as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  21  * The full GNU General Public License is included in this distribution
  22  * in the file called LICENSE.GPL.
  23  *
  24  * BSD LICENSE
  25  *
  26  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
  27  * All rights reserved.
  28  *
  29  * Redistribution and use in source and binary forms, with or without
  30  * modification, are permitted provided that the following conditions
  31  * are met:
  32  *
  33  *   * Redistributions of source code must retain the above copyright
  34  *     notice, this list of conditions and the following disclaimer.
  35  *   * Redistributions in binary form must reproduce the above copyright
  36  *     notice, this list of conditions and the following disclaimer in
  37  *     the documentation and/or other materials provided with the
  38  *     distribution.
  39  *   * Neither the name of Intel Corporation nor the names of its
  40  *     contributors may be used to endorse or promote products derived
  41  *     from this software without specific prior written permission.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  44  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  45  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  46  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  47  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  48  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  49  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  50  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  51  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  52  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  53  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  54  */
  55
  56 #ifndef _SCI_UTIL_H_
  57 #define _SCI_UTIL_H_
  58
  59 #include "sci_types.h"
  60
  61 /**
  62  * SCIC_SWAP_DWORD() -
  63  *
  64  * Normal byte swap macro
  65  */
  66 #define SCIC_SWAP_DWORD(x) \
  67         (\
  68                 (((x) >> 24) & 0x000000FF) \
  69                 | (((x) >>  8) & 0x0000FF00) \
  70                 | (((x) <<  8) & 0x00FF0000) \
  71                 | (((x) << 24) & 0xFF000000) \
  72         )
  73
  74 #define SCIC_BUILD_DWORD(char_buffer) \
  75         (\
  76                 ((char_buffer)[0] << 24) \
  77                 | ((char_buffer)[1] << 16) \
  78                 | ((char_buffer)[2] <<  8) \
  79                 | ((char_buffer)[3]) \
  80         )
  81
  82 #define SCI_FIELD_OFFSET(type, field)   ((unsigned long)&(((type *)0)->field))
  83
  84 /**
  85  * sci_physical_address_add() -
  86  *
  87  * This macro simply performs addition on an dma_addr_t type.  The
  88  * lower u32 value is "clipped" or "wrapped" back through 0.  When this occurs
  89  * the upper 32-bits are incremented by 1.
  90  */
  91 #define sci_physical_address_add(physical_address, value) \
  92         { \
  93                 u32 lower = lower_32_bits((physical_address)); \
  94                 u32 upper = upper_32_bits((physical_address)); \
  95  \
  96                 if (lower + (value) < lower) \
  97                         upper += 1; \
  98  \
  99                 lower += (value); \
 100                 sci_cb_make_physical_address(physical_address, upper, lower); \
 101         }
 102
 103 /**
 104  * sci_physical_address_subtract() -
 105  *
 106  * This macro simply performs subtraction on an dma_addr_t type.  The
 107  * lower u32 value is "clipped" or "wrapped" back through 0.  When this occurs
 108  * the upper 32-bits are decremented by 1.
 109  */
 110 #define sci_physical_address_subtract(physical_address, value) \
 111         { \
 112                 u32 lower = lower_32_bits((physical_address)); \
 113                 u32 upper = upper_32_bits((physical_address)); \
 114  \
 115                 if (lower - (value) > lower) \
 116                         upper -= 1; \
 117  \
 118                 lower -= (value); \
 119                 sci_cb_make_physical_address(physical_address, upper, lower); \
 120         }
 121
 122 /**
 123  * scic_word_copy_with_swap() - Copy the data from source to destination and
 124  *    swap the bytes during the copy.
 125  * @destination: This parameter specifies the destination address to which the
 126  *    data is to be copied.
 127  * @source: This parameter specifies the source address from which data is to
 128  *    be copied.
 129  * @word_count: This parameter specifies the number of 32-bit words to copy and
 130  *    byte swap.
 131  *
 132  */
 133 void scic_word_copy_with_swap(
 134         u32 *destination,
 135         u32 *source,
 136         u32 word_count);
 137
 138 #endif /* _SCI_UTIL_H_ */