1210284Sjmallett/***********************license start*************** 2215990Sjmallett * Copyright (c) 2003-2010 Cavium Networks (support@cavium.com). All rights 3215990Sjmallett * reserved. 4210284Sjmallett * 5210284Sjmallett * 6215990Sjmallett * Redistribution and use in source and binary forms, with or without 7215990Sjmallett * modification, are permitted provided that the following conditions are 8215990Sjmallett * met: 9210284Sjmallett * 10215990Sjmallett * * Redistributions of source code must retain the above copyright 11215990Sjmallett * notice, this list of conditions and the following disclaimer. 12210284Sjmallett * 13215990Sjmallett * * Redistributions in binary form must reproduce the above 14215990Sjmallett * copyright notice, this list of conditions and the following 15215990Sjmallett * disclaimer in the documentation and/or other materials provided 16215990Sjmallett * with the distribution. 17215990Sjmallett 18215990Sjmallett * * Neither the name of Cavium Networks nor the names of 19215990Sjmallett * its contributors may be used to endorse or promote products 20215990Sjmallett * derived from this software without specific prior written 21215990Sjmallett * permission. 22215990Sjmallett 23215990Sjmallett * This Software, including technical data, may be subject to U.S. export control 24215990Sjmallett * laws, including the U.S. Export Administration Act and its associated 25215990Sjmallett * regulations, and may be subject to export or import regulations in other 26215990Sjmallett * countries. 27215990Sjmallett 28215990Sjmallett * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" 29215990Sjmallett * AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS OR 30215990Sjmallett * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO 31215990Sjmallett * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR 32215990Sjmallett * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM 33215990Sjmallett * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE, 34215990Sjmallett * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF 35215990Sjmallett * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR 36215990Sjmallett * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT OF USE OR 37215990Sjmallett * PERFORMANCE OF THE SOFTWARE LIES WITH YOU. 38210284Sjmallett ***********************license end**************************************/ 39210284Sjmallett 40215990Sjmallett 41210284Sjmallett/** 42210284Sjmallett * @file 43210284Sjmallett * Small utility functions and macros to ease programming of Octeon. 44210284Sjmallett * 45210284Sjmallett * <hr>$Revision: 38306 $<hr> 46210284Sjmallett*/ 47210284Sjmallett#ifndef __CVMX_UTILS_H__ 48210284Sjmallett#define __CVMX_UTILS_H__ 49210284Sjmallett 50215990Sjmallett#if !defined(__FreeBSD__) || !defined(_KERNEL) 51215990Sjmallett#include <stdarg.h> 52215990Sjmallett#endif 53215990Sjmallett 54210284Sjmallett#ifdef __cplusplus 55210284Sjmallettextern "C" { 56210284Sjmallett#endif 57210284Sjmallett 58210284Sjmallett#ifndef TRUE 59210284Sjmallett#define FALSE 0 60210284Sjmallett#define TRUE (!(FALSE)) 61210284Sjmallett#endif 62210284Sjmallett 63210284Sjmallett/* 64210284Sjmallett * The macros cvmx_likely and cvmx_unlikely use the 65210284Sjmallett * __builtin_expect GCC operation to control branch 66210284Sjmallett * probabilities for a conditional. For example, an "if" 67210284Sjmallett * statement in the code that will almost always be 68210284Sjmallett * executed should be written as "if (cvmx_likely(...))". 69210284Sjmallett * If the "else" section of an if statement is more 70210284Sjmallett * probable, use "if (cvmx_unlikey(...))". 71210284Sjmallett */ 72210284Sjmallett#define cvmx_likely(x) __builtin_expect(!!(x), 1) 73210284Sjmallett#define cvmx_unlikely(x) __builtin_expect(!!(x), 0) 74210284Sjmallett 75210284Sjmallett#if CVMX_ENABLE_DEBUG_PRINTS 76210284Sjmallett #ifdef CVMX_BUILD_FOR_LINUX_KERNEL 77210284Sjmallett #define cvmx_dprintf printk 78215990Sjmallett #define cvmx_dvprintf vprintk 79210284Sjmallett #else 80210284Sjmallett #define cvmx_dprintf printf 81215990Sjmallett #define cvmx_dvprintf vprintf 82210284Sjmallett #endif 83210284Sjmallett#else 84215990Sjmallett static inline void cvmx_dvprintf(const char *format, va_list ap) 85215990Sjmallett { 86215990Sjmallett /* Prints are disbled, do nothing */ 87215990Sjmallett } 88215990Sjmallett 89210284Sjmallett static inline void cvmx_dprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))); 90210284Sjmallett static inline void cvmx_dprintf(const char *format, ...) 91210284Sjmallett { 92210284Sjmallett /* Prints are disbled, do nothing */ 93210284Sjmallett } 94210284Sjmallett#endif 95210284Sjmallett 96215990Sjmallett#define CAST64(v) ((long long)(long)(v)) // use only when 'v' is a pointer 97210284Sjmallett#define CASTPTR(type, v) ((type *)(long)(v)) 98210284Sjmallett#define CVMX_MAX_CORES (16) 99210284Sjmallett#define CVMX_CACHE_LINE_SIZE (128) // In bytes 100210284Sjmallett#define CVMX_CACHE_LINE_MASK (CVMX_CACHE_LINE_SIZE - 1) // In bytes 101210284Sjmallett#define CVMX_CACHE_LINE_ALIGNED __attribute__ ((aligned (CVMX_CACHE_LINE_SIZE))) 102210284Sjmallett 103210284Sjmallett/** 104210284Sjmallett * This macro spins on a field waiting for it to reach a value. It 105210284Sjmallett * is common in code to need to wait for a specific field in a CSR 106210284Sjmallett * to match a specific value. Conceptually this macro expands to: 107210284Sjmallett * 108210284Sjmallett * 1) read csr at "address" with a csr typedef of "type" 109210284Sjmallett * 2) Check if ("type".s."field" "op" "value") 110210284Sjmallett * 3) If #2 isn't true loop to #1 unless too much time has passed. 111210284Sjmallett */ 112210284Sjmallett#define CVMX_WAIT_FOR_FIELD64(address, type, field, op, value, timeout_usec)\ 113210284Sjmallett ({int result; \ 114210284Sjmallett do { \ 115215990Sjmallett uint64_t done = cvmx_clock_get_count(CVMX_CLOCK_CORE) + (uint64_t)timeout_usec * \ 116215990Sjmallett cvmx_clock_get_rate(CVMX_CLOCK_CORE) / 1000000; \ 117210284Sjmallett type c; \ 118210284Sjmallett while (1) \ 119210284Sjmallett { \ 120210284Sjmallett c.u64 = cvmx_read_csr(address); \ 121210284Sjmallett if ((c.s.field) op (value)) { \ 122210284Sjmallett result = 0; \ 123210284Sjmallett break; \ 124215990Sjmallett } else if (cvmx_clock_get_count(CVMX_CLOCK_CORE) > done) { \ 125210284Sjmallett result = -1; \ 126210284Sjmallett break; \ 127210284Sjmallett } else \ 128210284Sjmallett cvmx_wait(100); \ 129210284Sjmallett } \ 130210284Sjmallett } while (0); \ 131210284Sjmallett result;}) 132210284Sjmallett 133210284Sjmallett/** 134210284Sjmallett * Builds a bit mask given the required size in bits. 135210284Sjmallett * 136210284Sjmallett * @param bits Number of bits in the mask 137210284Sjmallett * @return The mask 138210284Sjmallett */ 139210284Sjmallettstatic inline uint64_t cvmx_build_mask(uint64_t bits) 140210284Sjmallett{ 141210284Sjmallett return ~((~0x0ull) << bits); 142210284Sjmallett} 143210284Sjmallett 144210284Sjmallett 145210284Sjmallett/** 146210284Sjmallett * Builds a memory address for I/O based on the Major and Sub DID. 147210284Sjmallett * 148210284Sjmallett * @param major_did 5 bit major did 149210284Sjmallett * @param sub_did 3 bit sub did 150210284Sjmallett * @return I/O base address 151210284Sjmallett */ 152210284Sjmallettstatic inline uint64_t cvmx_build_io_address(uint64_t major_did, uint64_t sub_did) 153210284Sjmallett{ 154210284Sjmallett return ((0x1ull << 48) | (major_did << 43) | (sub_did << 40)); 155210284Sjmallett} 156210284Sjmallett 157210284Sjmallett 158210284Sjmallett/** 159210284Sjmallett * Perform mask and shift to place the supplied value into 160210284Sjmallett * the supplied bit rage. 161210284Sjmallett * 162210284Sjmallett * Example: cvmx_build_bits(39,24,value) 163210284Sjmallett * <pre> 164210284Sjmallett * 6 5 4 3 3 2 1 165210284Sjmallett * 3 5 7 9 1 3 5 7 0 166210284Sjmallett * +-------+-------+-------+-------+-------+-------+-------+------+ 167210284Sjmallett * 000000000000000000000000___________value000000000000000000000000 168210284Sjmallett * </pre> 169210284Sjmallett * 170210284Sjmallett * @param high_bit Highest bit value can occupy (inclusive) 0-63 171210284Sjmallett * @param low_bit Lowest bit value can occupy inclusive 0-high_bit 172210284Sjmallett * @param value Value to use 173210284Sjmallett * @return Value masked and shifted 174210284Sjmallett */ 175210284Sjmallettstatic inline uint64_t cvmx_build_bits(uint64_t high_bit, uint64_t low_bit, uint64_t value) 176210284Sjmallett{ 177210284Sjmallett return ((value & cvmx_build_mask(high_bit - low_bit + 1)) << low_bit); 178210284Sjmallett} 179210284Sjmallett 180210284Sjmallett 181210284Sjmallett/** 182210284Sjmallett * Return the number of cores available in the chip 183210284Sjmallett * 184210284Sjmallett * @return 185210284Sjmallett */ 186210284Sjmallettstatic inline uint32_t cvmx_octeon_num_cores(void) 187210284Sjmallett{ 188210284Sjmallett uint32_t ciu_fuse = (uint32_t)cvmx_read_csr(CVMX_CIU_FUSE) & 0xffff; 189210284Sjmallett return cvmx_pop(ciu_fuse); 190210284Sjmallett} 191210284Sjmallett 192210284Sjmallett 193210284Sjmallett/** 194210284Sjmallett * Return true if Octeon is CN36XX 195210284Sjmallett * 196210284Sjmallett * @return 197210284Sjmallett */ 198210284Sjmallettstatic inline int cvmx_octeon_model_CN36XX(void) 199210284Sjmallett{ 200210284Sjmallett return(OCTEON_IS_MODEL(OCTEON_CN38XX) 201210284Sjmallett &&cvmx_fuse_read(264)); 202210284Sjmallett} 203210284Sjmallett 204210284Sjmallett 205210284Sjmallett/** 206210284Sjmallett * @deprecated 207210284Sjmallett * Determine if Octeon supports the DFA state machines. This function is 208210284Sjmallett * deprecated, use octeon_has_feature(OCTEON_FEATURE_DFA) instead. 209210284Sjmallett * 210210284Sjmallett * @return Non zero if DFA is supported 211210284Sjmallett */ 212210284Sjmallettstatic inline int cvmx_octeon_dfa_present(void) __attribute__((deprecated)); 213210284Sjmallettstatic inline int cvmx_octeon_dfa_present(void) 214210284Sjmallett{ 215210284Sjmallett return octeon_has_feature(OCTEON_FEATURE_DFA); 216210284Sjmallett} 217210284Sjmallett 218210284Sjmallett 219210284Sjmallett/** 220210284Sjmallett * @deprecated 221210284Sjmallett * Determine if Octeon supports ZIP. This function is deprecated, use 222210284Sjmallett * octeon_has_feature(OCTEON_FEATURE_ZIP) instead. 223210284Sjmallett * 224210284Sjmallett * @return Non zero if DFA is supported 225210284Sjmallett */ 226210284Sjmallettstatic inline int cvmx_octeon_zip_present(void) __attribute__((deprecated)); 227210284Sjmallettstatic inline int cvmx_octeon_zip_present(void) 228210284Sjmallett{ 229210284Sjmallett return octeon_has_feature(OCTEON_FEATURE_ZIP); 230210284Sjmallett} 231210284Sjmallett 232210284Sjmallett 233210284Sjmallett/** 234210284Sjmallett * @deprecated 235210284Sjmallett * Determine if Octeon supports Crypto acceleration. This function is 236210284Sjmallett * deprecated, use octeon_has_feature(OCTEON_FEATURE_CRYPTO) instead. 237210284Sjmallett * 238210284Sjmallett * @return Non zero if DFA is supported 239210284Sjmallett */ 240210284Sjmallettstatic inline int cvmx_octeon_crypto_present(void) __attribute__((deprecated)); 241210284Sjmallettstatic inline int cvmx_octeon_crypto_present(void) 242210284Sjmallett{ 243210284Sjmallett return octeon_has_feature(OCTEON_FEATURE_CRYPTO); 244210284Sjmallett} 245210284Sjmallett 246210284Sjmallett 247210284Sjmallett/** 248210284Sjmallett * @deprecated 249210284Sjmallett * This function is a trival wrapper around cvmx_read64_uint64(). Use 250210284Sjmallett * cvmx_read64_uint64() instead as this function is deprecated. 251210284Sjmallett * 252210284Sjmallett * @param address 253210284Sjmallett * 254210284Sjmallett * @return 255210284Sjmallett */ 256210284Sjmallettstatic inline uint64_t cvmx_read64(uint64_t address) __attribute__((deprecated)); 257210284Sjmallettstatic inline uint64_t cvmx_read64(uint64_t address) 258210284Sjmallett{ 259210284Sjmallett return cvmx_read64_uint64(address); 260210284Sjmallett} 261210284Sjmallett 262210284Sjmallett 263210284Sjmallett/** 264210284Sjmallett * @deprecated 265210284Sjmallett * This function is a trival wrapper around cvmx_write64_uint64(). Use 266210284Sjmallett * cvmx_write64_uint64() instead as this function is deprecated. 267210284Sjmallett * 268210284Sjmallett * @param address Location to write ro 269210284Sjmallett * @param value Value to write 270210284Sjmallett * 271210284Sjmallett * @return 272210284Sjmallett */ 273210284Sjmallettstatic inline void cvmx_write64(uint64_t address, uint64_t value) __attribute__((deprecated)); 274210284Sjmallettstatic inline void cvmx_write64(uint64_t address, uint64_t value) 275210284Sjmallett{ 276210284Sjmallett cvmx_write64_uint64(address, value); 277210284Sjmallett} 278210284Sjmallett 279210284Sjmallett#ifdef __cplusplus 280210284Sjmallett} 281210284Sjmallett#endif 282210284Sjmallett 283210284Sjmallett#endif /* __CVMX_UTILS_H__ */ 284210284Sjmallett 285