1230557Sjimharris/*- 2230557Sjimharris * This file is provided under a dual BSD/GPLv2 license. When using or 3230557Sjimharris * redistributing this file, you may do so under either license. 4230557Sjimharris * 5230557Sjimharris * GPL LICENSE SUMMARY 6230557Sjimharris * 7230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 8230557Sjimharris * 9230557Sjimharris * This program is free software; you can redistribute it and/or modify 10230557Sjimharris * it under the terms of version 2 of the GNU General Public License as 11230557Sjimharris * published by the Free Software Foundation. 12230557Sjimharris * 13230557Sjimharris * This program is distributed in the hope that it will be useful, but 14230557Sjimharris * WITHOUT ANY WARRANTY; without even the implied warranty of 15230557Sjimharris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16230557Sjimharris * General Public License for more details. 17230557Sjimharris * 18230557Sjimharris * You should have received a copy of the GNU General Public License 19230557Sjimharris * along with this program; if not, write to the Free Software 20230557Sjimharris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 21230557Sjimharris * The full GNU General Public License is included in this distribution 22230557Sjimharris * in the file called LICENSE.GPL. 23230557Sjimharris * 24230557Sjimharris * BSD LICENSE 25230557Sjimharris * 26230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 27230557Sjimharris * All rights reserved. 28230557Sjimharris * 29230557Sjimharris * Redistribution and use in source and binary forms, with or without 30230557Sjimharris * modification, are permitted provided that the following conditions 31230557Sjimharris * are met: 32230557Sjimharris * 33230557Sjimharris * * Redistributions of source code must retain the above copyright 34230557Sjimharris * notice, this list of conditions and the following disclaimer. 35230557Sjimharris * * Redistributions in binary form must reproduce the above copyright 36230557Sjimharris * notice, this list of conditions and the following disclaimer in 37230557Sjimharris * the documentation and/or other materials provided with the 38230557Sjimharris * distribution. 39230557Sjimharris * 40230557Sjimharris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 41230557Sjimharris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 42230557Sjimharris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 43230557Sjimharris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 44230557Sjimharris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45230557Sjimharris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 46230557Sjimharris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 47230557Sjimharris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 48230557Sjimharris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 49230557Sjimharris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 50230557Sjimharris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51230557Sjimharris * 52230557Sjimharris * $FreeBSD$ 53230557Sjimharris */ 54230557Sjimharris#ifndef _SCI_UTIL_H_ 55230557Sjimharris#define _SCI_UTIL_H_ 56230557Sjimharris 57230557Sjimharris#include <dev/isci/scil/sci_types.h> 58230557Sjimharris 59230557Sjimharris#ifndef ARRAY_SIZE 60230557Sjimharris#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) 61230557Sjimharris#endif 62230557Sjimharris 63230557Sjimharris#ifndef MIN 64230557Sjimharris#define MIN(x,y) ((x) < (y) ? (x) : (y)) 65230557Sjimharris#endif 66230557Sjimharris 67230557Sjimharris#ifndef MAX 68230557Sjimharris#define MAX(x,y) ((x) > (y) ? (x) : (y)) 69230557Sjimharris#endif 70230557Sjimharris 71230557Sjimharris/** 72230557Sjimharris * Normal byte swap macro 73230557Sjimharris */ 74230557Sjimharris#define SCIC_SWAP_DWORD(x) \ 75230557Sjimharris ( \ 76230557Sjimharris (((x) >> 24) & 0x000000FF) \ 77230557Sjimharris | (((x) >> 8) & 0x0000FF00) \ 78230557Sjimharris | (((x) << 8) & 0x00FF0000) \ 79230557Sjimharris | (((x) << 24) & 0xFF000000) \ 80230557Sjimharris ) 81230557Sjimharris 82230557Sjimharris#define SCIC_BUILD_DWORD(char_buffer) \ 83230557Sjimharris ( \ 84230557Sjimharris ((char_buffer)[0] << 24) \ 85230557Sjimharris | ((char_buffer)[1] << 16) \ 86230557Sjimharris | ((char_buffer)[2] << 8) \ 87230557Sjimharris | ((char_buffer)[3]) \ 88230557Sjimharris ) 89230557Sjimharris 90230557Sjimharris#define SCI_FIELD_OFFSET(type, field) ((POINTER_UINT)&(((type *)0)->field)) 91230557Sjimharris 92230557Sjimharris//This macro counts how many bits being set in a mask. 93230557Sjimharris#define SCI_GET_BITS_SET_COUNT(mask, set_bit_count) \ 94230557Sjimharris{ \ 95230557Sjimharris U8 index; \ 96230557Sjimharris set_bit_count = 0; \ 97230557Sjimharris for (index = 0; index < sizeof(mask)*8; index++) \ 98230557Sjimharris { \ 99230557Sjimharris if( mask & (1<<index) ) \ 100230557Sjimharris set_bit_count++; \ 101230557Sjimharris } \ 102230557Sjimharris} 103230557Sjimharris 104230557Sjimharris/** 105230557Sjimharris * This macro simply performs addition on an SCI_PHYSICAL_ADDRESS 106230557Sjimharris * type. The lower U32 value is "clipped" or "wrapped" back through 107230557Sjimharris * 0. When this occurs the upper 32-bits are incremented by 1. 108230557Sjimharris */ 109230557Sjimharris#define sci_physical_address_add(physical_address, value) \ 110230557Sjimharris{ \ 111230557Sjimharris U32 lower = sci_cb_physical_address_lower((physical_address)); \ 112230557Sjimharris U32 upper = sci_cb_physical_address_upper((physical_address)); \ 113230557Sjimharris \ 114230557Sjimharris if (lower + (value) < lower) \ 115230557Sjimharris upper += 1; \ 116230557Sjimharris \ 117230557Sjimharris lower += (value); \ 118230557Sjimharris sci_cb_make_physical_address(physical_address, upper, lower); \ 119230557Sjimharris} 120230557Sjimharris 121230557Sjimharris/** 122230557Sjimharris * This macro simply performs subtraction on an SCI_PHYSICAL_ADDRESS 123230557Sjimharris * type. The lower U32 value is "clipped" or "wrapped" back through 124230557Sjimharris * 0. When this occurs the upper 32-bits are decremented by 1. 125230557Sjimharris */ 126230557Sjimharris#define sci_physical_address_subtract(physical_address, value) \ 127230557Sjimharris{ \ 128230557Sjimharris U32 lower = sci_cb_physical_address_lower((physical_address)); \ 129230557Sjimharris U32 upper = sci_cb_physical_address_upper((physical_address)); \ 130230557Sjimharris \ 131230557Sjimharris if (lower - (value) > lower) \ 132230557Sjimharris upper -= 1; \ 133230557Sjimharris \ 134230557Sjimharris lower -= (value); \ 135230557Sjimharris sci_cb_make_physical_address(physical_address, upper, lower); \ 136230557Sjimharris} 137230557Sjimharris 138230557Sjimharris/** 139230557Sjimharris * @brief Copy the data from source to destination and swap the 140230557Sjimharris * bytes during the copy. 141230557Sjimharris * 142230557Sjimharris * @param[in] destination This parameter specifies the destination address 143230557Sjimharris * to which the data is to be copied. 144230557Sjimharris * @param[in] source This parameter specifies the source address from 145230557Sjimharris * which data is to be copied. 146230557Sjimharris * @param[in] word_count This parameter specifies the number of 32-bit words 147230557Sjimharris * to copy and byte swap. 148230557Sjimharris * 149230557Sjimharris * @return none 150230557Sjimharris */ 151230557Sjimharrisvoid scic_word_copy_with_swap( 152230557Sjimharris U32 *destination, 153230557Sjimharris U32 *source, 154230557Sjimharris U32 word_count 155230557Sjimharris); 156230557Sjimharris 157230557Sjimharris 158230557Sjimharris#define sci_ssp_get_sense_data_length(sense_data_length_buffer) \ 159230557Sjimharris SCIC_BUILD_DWORD(sense_data_length_buffer) 160230557Sjimharris 161230557Sjimharris#define sci_ssp_get_response_data_length(response_data_length_buffer) \ 162230557Sjimharris SCIC_BUILD_DWORD(response_data_length_buffer) 163230557Sjimharris 164230557Sjimharris#endif // _SCI_UTIL_H_ 165