| /******************************************************************************* |
| Copyright (C) Marvell International Ltd. and its affiliates |
| |
| This software file (the "File") is owned and distributed by Marvell |
| International Ltd. and/or its affiliates ("Marvell") under the following |
| alternative licensing terms. Once you have made an election to distribute the |
| File under one of the following license alternatives, please (i) delete this |
| introductory statement regarding license alternatives, (ii) delete the two |
| license alternatives that you have not elected to use and (iii) preserve the |
| Marvell copyright notice above. |
| |
| ******************************************************************************** |
| Marvell Commercial License Option |
| |
| If you received this File from Marvell and you have entered into a commercial |
| license agreement (a "Commercial License") with Marvell, the File is licensed |
| to you under the terms of the applicable Commercial License. |
| |
| ******************************************************************************** |
| Marvell GPL License Option |
| |
| If you received this File from Marvell, you may opt to use, redistribute and/or |
| modify this File in accordance with the terms and conditions of the General |
| Public License Version 2, June 1991 (the "GPL License"), a copy of which is |
| available along with the File in the license.txt file or by writing to the Free |
| Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 or |
| on the worldwide web at http://www.gnu.org/licenses/gpl.txt. |
| |
| THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE IMPLIED |
| WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY |
| DISCLAIMED. The GPL License provides additional details about this warranty |
| disclaimer. |
| ******************************************************************************** |
| Marvell BSD License Option |
| |
| If you received this File from Marvell, you may opt to use, redistribute and/or |
| modify this File under the following licensing terms. |
| Redistribution and use in source and binary forms, with or without modification, |
| are permitted provided that the following conditions are met: |
| |
| * Redistributions of source code must retain the above copyright notice, |
| this list of conditions and the following disclaimer. |
| |
| * Redistributions in binary form must reproduce the above copyright |
| notice, this list of conditions and the following disclaimer in the |
| documentation and/or other materials provided with the distribution. |
| |
| * Neither the name of Marvell nor the names of its contributors may be |
| used to endorse or promote products derived from this software without |
| specific prior written permission. |
| |
| THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
| ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR |
| ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
| (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
| ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| |
| *******************************************************************************/ |
| |
| #ifndef __INCmvCommonh |
| #define __INCmvCommonh |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif /* __cplusplus */ |
| |
| #include "mvTypes.h" |
| #include "mvDeviceId.h" |
| #ifndef MV_ASMLANGUAGE |
| #include "mv802_3.h" |
| #include "mvVideo.h" |
| |
| /* The golden ration: an arbitrary value */ |
| #define MV_JHASH_GOLDEN_RATIO 0x9e3779b9 |
| |
| #define MV_JHASH_MIX(a, b, c) \ |
| { \ |
| a -= b; a -= c; a ^= (c>>13); \ |
| b -= c; b -= a; b ^= (a<<8); \ |
| c -= a; c -= b; c ^= (b>>13); \ |
| a -= b; a -= c; a ^= (c>>12); \ |
| b -= c; b -= a; b ^= (a<<16); \ |
| c -= a; c -= b; c ^= (b>>5); \ |
| a -= b; a -= c; a ^= (c>>3); \ |
| b -= c; b -= a; b ^= (a<<10); \ |
| c -= a; c -= b; c ^= (b>>15); \ |
| } |
| |
| static inline MV_U32 mv_jhash_3words(MV_U32 a, MV_U32 b, MV_U32 c, MV_U32 initval) |
| { |
| a += MV_JHASH_GOLDEN_RATIO; |
| b += MV_JHASH_GOLDEN_RATIO; |
| c += initval; |
| MV_JHASH_MIX(a, b, c); |
| |
| return c; |
| } |
| #endif |
| |
| |
| /* Swap tool */ |
| |
| /* 16bit nibble swap. For example 0x1234 -> 0x2143 */ |
| #define MV_NIBBLE_SWAP_16BIT(X) (((X&0xf) << 4) | \ |
| ((X&0xf0) >> 4) | \ |
| ((X&0xf00) << 4) | \ |
| ((X&0xf000) >> 4)) |
| |
| /* 32bit nibble swap. For example 0x12345678 -> 0x21436587 */ |
| #define MV_NIBBLE_SWAP_32BIT(X) (((X&0xf) << 4) | \ |
| ((X&0xf0) >> 4) | \ |
| ((X&0xf00) << 4) | \ |
| ((X&0xf000) >> 4) | \ |
| ((X&0xf0000) << 4) | \ |
| ((X&0xf00000) >> 4) | \ |
| ((X&0xf000000) << 4) | \ |
| ((X&0xf0000000) >> 4)) |
| |
| /* 16bit byte swap. For example 0x1234->0x3412 */ |
| #define MV_BYTE_SWAP_16BIT(X) ((((X)&0xff)<<8) | (((X)&0xff00)>>8)) |
| |
| /* 32bit byte swap. For example 0x12345678->0x78563412 */ |
| #define MV_BYTE_SWAP_32BIT(X) ((((X)&0xff)<<24) | \ |
| (((X)&0xff00)<<8) | \ |
| (((X)&0xff0000)>>8) | \ |
| (((X)&0xff000000)>>24)) |
| |
| /* 64bit byte swap. For example 0x11223344.55667788 -> 0x88776655.44332211 */ |
| #define MV_BYTE_SWAP_64BIT(X) ((l64) ((((X)&0xffULL)<<56) | \ |
| (((X)&0xff00ULL)<<40) | \ |
| (((X)&0xff0000ULL)<<24) | \ |
| (((X)&0xff000000ULL)<<8) | \ |
| (((X)&0xff00000000ULL)>>8) | \ |
| (((X)&0xff0000000000ULL)>>24) | \ |
| (((X)&0xff000000000000ULL)>>40) | \ |
| (((X)&0xff00000000000000ULL)>>56))) |
| |
| /* Endianess macros. */ |
| #if defined(MV_CPU_LE) |
| #define MV_16BIT_LE(X) (X) |
| #define MV_32BIT_LE(X) (X) |
| #define MV_64BIT_LE(X) (X) |
| #define MV_16BIT_BE(X) MV_BYTE_SWAP_16BIT(X) |
| #define MV_32BIT_BE(X) MV_BYTE_SWAP_32BIT(X) |
| #define MV_64BIT_BE(X) MV_BYTE_SWAP_64BIT(X) |
| #elif defined(MV_CPU_BE) |
| #define MV_16BIT_LE(X) MV_BYTE_SWAP_16BIT(X) |
| #define MV_32BIT_LE(X) MV_BYTE_SWAP_32BIT(X) |
| #define MV_64BIT_LE(X) MV_BYTE_SWAP_64BIT(X) |
| #define MV_16BIT_BE(X) (X) |
| #define MV_32BIT_BE(X) (X) |
| #define MV_64BIT_BE(X) (X) |
| #else |
| #error "CPU endianess isn't defined!\n" |
| #endif |
| |
| /* Bit field definitions */ |
| #define NO_BIT 0x00000000 |
| |
| /* avoid redefinition of bits */ |
| #ifndef BIT0 |
| |
| #define BIT0 0x00000001 |
| #define BIT1 0x00000002 |
| #define BIT2 0x00000004 |
| #define BIT3 0x00000008 |
| #define BIT4 0x00000010 |
| #define BIT5 0x00000020 |
| #define BIT6 0x00000040 |
| #define BIT7 0x00000080 |
| #define BIT8 0x00000100 |
| #define BIT9 0x00000200 |
| #define BIT10 0x00000400 |
| #define BIT11 0x00000800 |
| #define BIT12 0x00001000 |
| #define BIT13 0x00002000 |
| #define BIT14 0x00004000 |
| #define BIT15 0x00008000 |
| #define BIT16 0x00010000 |
| #define BIT17 0x00020000 |
| #define BIT18 0x00040000 |
| #define BIT19 0x00080000 |
| #define BIT20 0x00100000 |
| #define BIT21 0x00200000 |
| #define BIT22 0x00400000 |
| #define BIT23 0x00800000 |
| #define BIT24 0x01000000 |
| #define BIT25 0x02000000 |
| #define BIT26 0x04000000 |
| #define BIT27 0x08000000 |
| #define BIT28 0x10000000 |
| #define BIT29 0x20000000 |
| #define BIT30 0x40000000 |
| #define BIT31 0x80000000 |
| |
| #endif /* BIT0 */ |
| /* Handy sizes */ |
| #define _1K 0x00000400 |
| #define _2K 0x00000800 |
| #define _4K 0x00001000 |
| #define _8K 0x00002000 |
| #define _16K 0x00004000 |
| #define _32K 0x00008000 |
| #define _64K 0x00010000 |
| #define _128K 0x00020000 |
| #define _256K 0x00040000 |
| #define _512K 0x00080000 |
| |
| #define _1M 0x00100000 |
| #define _2M 0x00200000 |
| #define _4M 0x00400000 |
| #define _8M 0x00800000 |
| #define _16M 0x01000000 |
| #define _32M 0x02000000 |
| #define _64M 0x04000000 |
| #define _128M 0x08000000 |
| #define _256M 0x10000000 |
| #define _512M 0x20000000 |
| |
| #define _1G 0x40000000 |
| #define _2G 0x80000000 |
| |
| /* Tclock and Sys clock define */ |
| #define _100MHz 100000000 |
| #define _125MHz 125000000 |
| #define _133MHz 133333334 |
| #define _150MHz 150000000 |
| #define _160MHz 160000000 |
| #define _166MHz 166666667 |
| #define _175MHz 175000000 |
| #define _178MHz 178000000 |
| #define _183MHz 183333334 |
| #define _187MHz 187000000 |
| #define _192MHz 192000000 |
| #define _194MHz 194000000 |
| #define _200MHz 200000000 |
| #define _233MHz 233333334 |
| #define _250MHz 250000000 |
| #define _266MHz 266666667 |
| #define _300MHz 300000000 |
| |
| /* Supported clocks */ |
| #define MV_BOARD_TCLK_100MHZ 100000000 |
| #define MV_BOARD_TCLK_125MHZ 125000000 |
| #define MV_BOARD_TCLK_133MHZ 133333333 |
| #define MV_BOARD_TCLK_150MHZ 150000000 |
| #define MV_BOARD_TCLK_166MHZ 166666667 |
| #define MV_BOARD_TCLK_200MHZ 200000000 |
| #define MV_BOARD_TCLK_250MHZ 250000000 |
| |
| #define MV_BOARD_SYSCLK_100MHZ 100000000 |
| #define MV_BOARD_SYSCLK_125MHZ 125000000 |
| #define MV_BOARD_SYSCLK_133MHZ 133333333 |
| #define MV_BOARD_SYSCLK_150MHZ 150000000 |
| #define MV_BOARD_SYSCLK_166MHZ 166666667 |
| #define MV_BOARD_SYSCLK_200MHZ 200000000 |
| #define MV_BOARD_SYSCLK_233MHZ 233333333 |
| #define MV_BOARD_SYSCLK_250MHZ 250000000 |
| #define MV_BOARD_SYSCLK_267MHZ 266666667 |
| #define MV_BOARD_SYSCLK_300MHZ 300000000 |
| #define MV_BOARD_SYSCLK_333MHZ 333333334 |
| #define MV_BOARD_SYSCLK_400MHZ 400000000 |
| |
| #define MV_BOARD_REFCLK_25MHZ 25000000 |
| |
| /* For better address window table readability */ |
| #define EN MV_TRUE |
| #define DIS MV_FALSE |
| #define N_A -1 /* Not applicable */ |
| |
| /* Cache configuration options for memory (DRAM, SRAM, ... ) */ |
| |
| /* Memory uncached, HW or SW cache coherency is not needed */ |
| #define MV_UNCACHED 0 |
| /* Memory cached, HW cache coherency supported in WriteThrough mode */ |
| #define MV_CACHE_COHER_HW_WT 1 |
| /* Memory cached, HW cache coherency supported in WriteBack mode */ |
| #define MV_CACHE_COHER_HW_WB 2 |
| /* Memory cached, No HW cache coherency, Cache coherency must be in SW */ |
| #define MV_CACHE_COHER_SW 3 |
| |
| /* Macro for testing aligment. Positive if number is NOT aligned */ |
| #define MV_IS_NOT_ALIGN(number, align) ((number) & ((align) - 1)) |
| |
| /* Macro for alignment up. For example, MV_ALIGN_UP(0x0330, 0x20) = 0x0340 */ |
| #define MV_ALIGN_UP(number, align) \ |
| (((number) & ((align) - 1)) ? (((number) + (align)) & ~((align)-1)) : (number)) |
| |
| /* Macro for alignment down. For example, MV_ALIGN_UP(0x0330, 0x20) = 0x0320 */ |
| #define MV_ALIGN_DOWN(number, align) ((number) & ~((align)-1)) |
| |
| /* This macro returns absolute value */ |
| #define MV_ABS(number) (((int)(number) < 0) ? -(int)(number) : (int)(number)) |
| |
| /* Bit fields manipulation macros */ |
| |
| /* An integer word which its 'x' bit is set */ |
| #define MV_BIT_MASK(bitNum) (1 << (bitNum)) |
| |
| /* Checks wheter bit 'x' in integer word is set */ |
| #define MV_BIT_CHECK(word, bitNum) ((word) & MV_BIT_MASK(bitNum)) |
| |
| /* Clear (reset) bit 'x' in integer word (RMW - Read-Modify-Write) */ |
| #define MV_BIT_CLEAR(word, bitNum) ((word) &= ~(MV_BIT_MASK(bitNum))) |
| |
| /* Set bit 'x' in integer word (RMW) */ |
| #define MV_BIT_SET(word, bitNum) ((word) |= MV_BIT_MASK(bitNum)) |
| |
| /* Invert bit 'x' in integer word (RMW) */ |
| #define MV_BIT_INV(word, bitNum) ((word) ^= MV_BIT_MASK(bitNum)) |
| |
| /* Get the min between 'a' or 'b' */ |
| #define MV_MIN(a, b) (((a) < (b)) ? (a) : (b)) |
| |
| /* Get the max between 'a' or 'b' */ |
| #define MV_MAX(a, b) (((a) < (b)) ? (b) : (a)) |
| |
| #define mvOsDivide(num, div) \ |
| ({ \ |
| int i = 0, rem = (num); \ |
| while (rem >= (div)) { \ |
| rem -= (div); \ |
| i++; \ |
| } \ |
| (i); \ |
| }) |
| |
| #define mvOsReminder(num, div) \ |
| ({ \ |
| int rem = (num); \ |
| while (rem >= (div)) \ |
| rem -= (div); \ |
| (rem); \ |
| }) |
| |
| #define MV_MACQUAD_FMT "%2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x" |
| |
| #define MV_MACQUAD(addr) \ |
| ((unsigned char *)addr)[0], \ |
| ((unsigned char *)addr)[1], \ |
| ((unsigned char *)addr)[2], \ |
| ((unsigned char *)addr)[3], \ |
| ((unsigned char *)addr)[4], \ |
| ((unsigned char *)addr)[5] |
| |
| #define MV_IPQUAD_FMT "%u.%u.%u.%u" |
| #define MV_IPQUAD(ip) ip[0], ip[1], ip[2], ip[3] |
| |
| #define MV_IP_QUAD(ipAddr) ((ipAddr >> 24) & 0xFF), ((ipAddr >> 16) & 0xFF), \ |
| ((ipAddr >> 8) & 0xFF), ((ipAddr >> 0) & 0xFF) |
| |
| #define MV_IP6_FMT "%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x" |
| #define MV_IP6_ARG(L3) L3[0], L3[1], L3[2], L3[3], \ |
| L3[4], L3[5], L3[6], L3[7], \ |
| L3[8], L3[9], L3[10], L3[11], \ |
| L3[12], L3[13], L3[14], L3[15] |
| |
| #define MV_IS_POWER_OF_2(num) ((num != 0) && ((num & (num - 1)) == 0)) |
| |
| #define MV_GET_BIT(word, bitNum) (((word) & (1 << (bitNum))) >> (bitNum)) |
| |
| #define MV_SET_BIT(word, bitNum, bitVal) (((word) & ~(1 << (bitNum))) | (bitVal << bitNum)) |
| |
| #define MV_ARRAY_SIZE(a) ((sizeof(a)) / (sizeof(a[0]))) |
| |
| #ifndef MV_ASMLANGUAGE |
| /* mvCommon API list */ |
| |
| int mvCharToHex(char ch); |
| int mvCharToDigit(char ch); |
| |
| MV_VOID mvHexToBin(const char *pHexStr, MV_U8 *pBin, int size); |
| void mvAsciiToHex(const char *asciiStr, char *hexStr); |
| void mvBinToHex(const MV_U8 *bin, char *hexStr, int size); |
| void mvBinToAscii(const MV_U8 *bin, char *asciiStr, int size); |
| |
| MV_STATUS mvMacStrToHex(const char *macStr, MV_U8 *macHex); |
| MV_STATUS mvMacHexToStr(MV_U8 *macHex, char *macStr); |
| void mvSizePrint(MV_U32); |
| |
| MV_U32 mvLog2(MV_U32 num); |
| |
| MV_STATUS mvWinOverlapTest(MV_ADDR_WIN *pAddrWin1, MV_ADDR_WIN *pAddrWin2); |
| MV_STATUS mvWinWithinWinTest(MV_ADDR_WIN *pAddrWin1, MV_ADDR_WIN *pAddrWin2); |
| |
| #endif /* MV_ASMLANGUAGE */ |
| |
| #ifdef __cplusplus |
| } |
| #endif /* __cplusplus */ |
| |
| #endif /* __INCmvCommonh */ |