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