1210284Sjmallett/***********************license start*************** 2232812Sjmallett * Copyright (c) 2003-2010 Cavium Inc. (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 18232812Sjmallett * * Neither the name of Cavium Inc. 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" 29232812Sjmallett * AND WITH ALL FAULTS AND CAVIUM INC. 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 79243470Sjmallett #elif defined(CVMX_BUILD_FOR_FREEBSD_KERNEL) 80243470Sjmallett void cvmx_dvprintf(const char *, va_list); 81243470Sjmallett void cvmx_dprintf(const char *, ...) __attribute__ ((format(printf, 1, 2))); 82210284Sjmallett #else 83210284Sjmallett #define cvmx_dprintf printf 84215990Sjmallett #define cvmx_dvprintf vprintf 85210284Sjmallett #endif 86210284Sjmallett#else 87215990Sjmallett static inline void cvmx_dvprintf(const char *format, va_list ap) 88215990Sjmallett { 89215990Sjmallett /* Prints are disbled, do nothing */ 90215990Sjmallett } 91215990Sjmallett 92210284Sjmallett static inline void cvmx_dprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))); 93210284Sjmallett static inline void cvmx_dprintf(const char *format, ...) 94210284Sjmallett { 95210284Sjmallett /* Prints are disbled, do nothing */ 96210284Sjmallett } 97210284Sjmallett#endif 98210284Sjmallett 99215990Sjmallett#define CAST64(v) ((long long)(long)(v)) // use only when 'v' is a pointer 100210284Sjmallett#define CASTPTR(type, v) ((type *)(long)(v)) 101210284Sjmallett#define CVMX_CACHE_LINE_SIZE (128) // In bytes 102210284Sjmallett#define CVMX_CACHE_LINE_MASK (CVMX_CACHE_LINE_SIZE - 1) // In bytes 103210284Sjmallett#define CVMX_CACHE_LINE_ALIGNED __attribute__ ((aligned (CVMX_CACHE_LINE_SIZE))) 104210284Sjmallett 105210284Sjmallett/** 106210284Sjmallett * This macro spins on a field waiting for it to reach a value. It 107210284Sjmallett * is common in code to need to wait for a specific field in a CSR 108210284Sjmallett * to match a specific value. Conceptually this macro expands to: 109210284Sjmallett * 110210284Sjmallett * 1) read csr at "address" with a csr typedef of "type" 111210284Sjmallett * 2) Check if ("type".s."field" "op" "value") 112210284Sjmallett * 3) If #2 isn't true loop to #1 unless too much time has passed. 113210284Sjmallett */ 114210284Sjmallett#define CVMX_WAIT_FOR_FIELD64(address, type, field, op, value, timeout_usec)\ 115210284Sjmallett ({int result; \ 116210284Sjmallett do { \ 117215990Sjmallett uint64_t done = cvmx_clock_get_count(CVMX_CLOCK_CORE) + (uint64_t)timeout_usec * \ 118215990Sjmallett cvmx_clock_get_rate(CVMX_CLOCK_CORE) / 1000000; \ 119210284Sjmallett type c; \ 120210284Sjmallett while (1) \ 121210284Sjmallett { \ 122210284Sjmallett c.u64 = cvmx_read_csr(address); \ 123210284Sjmallett if ((c.s.field) op (value)) { \ 124210284Sjmallett result = 0; \ 125210284Sjmallett break; \ 126215990Sjmallett } else if (cvmx_clock_get_count(CVMX_CLOCK_CORE) > done) { \ 127210284Sjmallett result = -1; \ 128210284Sjmallett break; \ 129210284Sjmallett } else \ 130210284Sjmallett cvmx_wait(100); \ 131210284Sjmallett } \ 132210284Sjmallett } while (0); \ 133210284Sjmallett result;}) 134210284Sjmallett 135232812Sjmallett#define CVMX_BUILD_ASSERT_ZERO(e) (sizeof(struct {int __static_assert:(e)?1:-1;})) 136232812Sjmallett#define CVMX_BUILD_ASSERT(condition) ((void)CVMX_BUILD_ASSERT_ZERO(condition)) 137232812Sjmallett 138210284Sjmallett/** 139210284Sjmallett * Builds a bit mask given the required size in bits. 140210284Sjmallett * 141210284Sjmallett * @param bits Number of bits in the mask 142210284Sjmallett * @return The mask 143210284Sjmallett */ 144210284Sjmallettstatic inline uint64_t cvmx_build_mask(uint64_t bits) 145210284Sjmallett{ 146210284Sjmallett return ~((~0x0ull) << bits); 147210284Sjmallett} 148210284Sjmallett 149210284Sjmallett 150210284Sjmallett/** 151210284Sjmallett * Builds a memory address for I/O based on the Major and Sub DID. 152210284Sjmallett * 153210284Sjmallett * @param major_did 5 bit major did 154210284Sjmallett * @param sub_did 3 bit sub did 155210284Sjmallett * @return I/O base address 156210284Sjmallett */ 157210284Sjmallettstatic inline uint64_t cvmx_build_io_address(uint64_t major_did, uint64_t sub_did) 158210284Sjmallett{ 159210284Sjmallett return ((0x1ull << 48) | (major_did << 43) | (sub_did << 40)); 160210284Sjmallett} 161210284Sjmallett 162210284Sjmallett 163210284Sjmallett/** 164210284Sjmallett * Perform mask and shift to place the supplied value into 165210284Sjmallett * the supplied bit rage. 166210284Sjmallett * 167210284Sjmallett * Example: cvmx_build_bits(39,24,value) 168210284Sjmallett * <pre> 169210284Sjmallett * 6 5 4 3 3 2 1 170210284Sjmallett * 3 5 7 9 1 3 5 7 0 171210284Sjmallett * +-------+-------+-------+-------+-------+-------+-------+------+ 172210284Sjmallett * 000000000000000000000000___________value000000000000000000000000 173210284Sjmallett * </pre> 174210284Sjmallett * 175210284Sjmallett * @param high_bit Highest bit value can occupy (inclusive) 0-63 176210284Sjmallett * @param low_bit Lowest bit value can occupy inclusive 0-high_bit 177210284Sjmallett * @param value Value to use 178210284Sjmallett * @return Value masked and shifted 179210284Sjmallett */ 180210284Sjmallettstatic inline uint64_t cvmx_build_bits(uint64_t high_bit, uint64_t low_bit, uint64_t value) 181210284Sjmallett{ 182210284Sjmallett return ((value & cvmx_build_mask(high_bit - low_bit + 1)) << low_bit); 183210284Sjmallett} 184210284Sjmallett 185210284Sjmallett 186210284Sjmallett/** 187210284Sjmallett * Return the number of cores available in the chip 188210284Sjmallett * 189210284Sjmallett * @return 190210284Sjmallett */ 191210284Sjmallettstatic inline uint32_t cvmx_octeon_num_cores(void) 192210284Sjmallett{ 193232812Sjmallett uint32_t ciu_fuse = (uint32_t)cvmx_read_csr(CVMX_CIU_FUSE) & 0xffffffffull; 194210284Sjmallett return cvmx_pop(ciu_fuse); 195210284Sjmallett} 196210284Sjmallett 197210284Sjmallett 198210284Sjmallett/** 199210284Sjmallett * Return true if Octeon is CN36XX 200210284Sjmallett * 201210284Sjmallett * @return 202210284Sjmallett */ 203210284Sjmallettstatic inline int cvmx_octeon_model_CN36XX(void) 204210284Sjmallett{ 205210284Sjmallett return(OCTEON_IS_MODEL(OCTEON_CN38XX) 206210284Sjmallett &&cvmx_fuse_read(264)); 207210284Sjmallett} 208210284Sjmallett 209210284Sjmallett 210210284Sjmallett#ifdef __cplusplus 211210284Sjmallett} 212210284Sjmallett#endif 213210284Sjmallett 214210284Sjmallett#endif /* __CVMX_UTILS_H__ */ 215210284Sjmallett 216