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 "scic_sds_request.h"
  60
  61 #define SCIC_BUILD_DWORD(char_buffer) \
  62         (\
  63                 ((char_buffer)[0] << 24) \
  64                 | ((char_buffer)[1] << 16) \
  65                 | ((char_buffer)[2] <<  8) \
  66                 | ((char_buffer)[3]) \
  67         )
  68
  69 #define SCI_FIELD_OFFSET(type, field)   ((unsigned long)&(((type *)0)->field))
  70
  71
  72 #define sci_cb_make_physical_address(physical_addr, addr_upper, addr_lower) \
  73         ((physical_addr) = (addr_lower) | ((u64)addr_upper) << 32)
  74
  75 /**
  76  * sci_swab32_cpy - convert between scsi and scu-hardware byte format
  77  * @dest: receive the 4-byte endian swapped version of src
  78  * @src: word aligned source buffer
  79  *
  80  * scu hardware handles SSP/SMP control, response, and unidentified
  81  * frames in "big endian dword" order.  Regardless of host endian this
  82  * is always a swab32()-per-dword conversion of the standard definition,
  83  * i.e. single byte fields swapped and multi-byte fields in little-
  84  * endian
  85  */
  86 static inline void sci_swab32_cpy(void *_dest, void *_src, ssize_t word_cnt)
  87 {
  88         u32 *dest = _dest, *src = _src;
  89
  90         while (--word_cnt >= 0)
  91                 dest[word_cnt] = swab32(src[word_cnt]);
  92 }
  93
  94 void *scic_request_get_virt_addr(struct scic_sds_request *sds_request,
  95                                  dma_addr_t phys_addr);
  96
  97 dma_addr_t scic_io_request_get_dma_addr(struct scic_sds_request *sds_request,
  98                                         void *virt_addr);
  99
 100 #endif /* _SCI_UTIL_H_ */