octeon-feature.h revision 242342
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 40210284Sjmallett 41210284Sjmallett 42210284Sjmallett 43210284Sjmallett 44215990Sjmallett 45210284Sjmallett/** 46210284Sjmallett * @file 47210284Sjmallett * 48210284Sjmallett * File defining checks for different Octeon features. 49210284Sjmallett * 50210284Sjmallett * <hr>$Revision: 30468 $<hr> 51210284Sjmallett */ 52210284Sjmallett 53210284Sjmallett#ifndef __OCTEON_FEATURE_H__ 54210284Sjmallett#define __OCTEON_FEATURE_H__ 55210284Sjmallett 56210284Sjmallett#ifdef __cplusplus 57210284Sjmallettextern "C" { 58210284Sjmallett#endif 59210284Sjmallett 60232812Sjmallett/* 61232812Sjmallett * Errors 62232812Sjmallett */ 63210284Sjmalletttypedef enum 64210284Sjmallett{ 65232812Sjmallett OCTEON_FEATURE_SUCCESS = 0, 66232812Sjmallett OCTEON_FEATURE_MAP_OVERFLOW = -1, 67232812Sjmallett} octeon_feature_result_t; 68232812Sjmallett 69232812Sjmallett/* 70232812Sjmallett * Octeon models are declared after the macros in octeon-model.h with the 71232812Sjmallett * suffix _FEATURE. The individual features are declared with the 72232812Sjmallett * _FEATURE_ infix. 73232812Sjmallett */ 74232812Sjmalletttypedef enum 75232812Sjmallett{ 76232812Sjmallett /* 77232812Sjmallett * Checks on the critical path are moved to the top (8 positions) 78232812Sjmallett * so that the compiler generates one less insn than for the rest 79232812Sjmallett * of the checks. 80232812Sjmallett */ 81232812Sjmallett OCTEON_FEATURE_PKND, /**< CN68XX uses port kinds for packet interface */ 82232812Sjmallett OCTEON_FEATURE_CN68XX_WQE, /**< CN68XX has different fields in word0 - word2 */ 83232812Sjmallett 84232812Sjmallett /* 85232812Sjmallett * Features 86232812Sjmallett */ 87215990Sjmallett OCTEON_FEATURE_SAAD, /**< Octeon models in the CN5XXX family and higher support atomic add instructions to memory (saa/saad) */ 88215990Sjmallett OCTEON_FEATURE_ZIP, /**< Does this Octeon support the ZIP offload engine? */ 89215990Sjmallett OCTEON_FEATURE_CRYPTO, /**< Does this Octeon support crypto acceleration using COP2? */ 90215990Sjmallett OCTEON_FEATURE_DORM_CRYPTO, /**< Can crypto be enabled by calling cvmx_crypto_dormant_enable()? */ 91215990Sjmallett OCTEON_FEATURE_PCIE, /**< Does this Octeon support PCI express? */ 92232812Sjmallett OCTEON_FEATURE_SRIO, /**< Does this Octeon support SRIO */ 93232812Sjmallett OCTEON_FEATURE_ILK, /**< Does this Octeon support Interlaken */ 94215990Sjmallett OCTEON_FEATURE_KEY_MEMORY, /**< Some Octeon models support internal memory for storing cryptographic keys */ 95215990Sjmallett OCTEON_FEATURE_LED_CONTROLLER, /**< Octeon has a LED controller for banks of external LEDs */ 96215990Sjmallett OCTEON_FEATURE_TRA, /**< Octeon has a trace buffer */ 97215990Sjmallett OCTEON_FEATURE_MGMT_PORT, /**< Octeon has a management port */ 98215990Sjmallett OCTEON_FEATURE_RAID, /**< Octeon has a raid unit */ 99215990Sjmallett OCTEON_FEATURE_USB, /**< Octeon has a builtin USB */ 100215990Sjmallett OCTEON_FEATURE_NO_WPTR, /**< Octeon IPD can run without using work queue entries */ 101215990Sjmallett OCTEON_FEATURE_DFA, /**< Octeon has DFA state machines */ 102215990Sjmallett OCTEON_FEATURE_MDIO_CLAUSE_45, /**< Octeon MDIO block supports clause 45 transactions for 10 Gig support */ 103215990Sjmallett OCTEON_FEATURE_NPEI, /**< CN52XX and CN56XX used a block named NPEI for PCIe access. Newer chips replaced this with SLI+DPI */ 104232812Sjmallett OCTEON_FEATURE_HFA, /**< Octeon has DFA/HFA */ 105232812Sjmallett OCTEON_FEATURE_DFM, /**< Octeon has DFM */ 106232812Sjmallett OCTEON_FEATURE_CIU2, /**< Octeon has CIU2 */ 107232812Sjmallett OCTEON_FEATURE_DICI_MODE, /**< Octeon has DMA Instruction Completion Interrupt mode */ 108232812Sjmallett OCTEON_FEATURE_BIT_EXTRACTOR, /**< Octeon has Bit Select Extractor schedulor */ 109232812Sjmallett OCTEON_FEATURE_NAND, /**< Octeon has NAND */ 110232812Sjmallett OCTEON_FEATURE_MMC, /**< Octeon has built-in MMC support */ 111232812Sjmallett OCTEON_MAX_FEATURE 112210284Sjmallett} octeon_feature_t; 113210284Sjmallett 114210284Sjmallett/** 115210284Sjmallett * Determine if the current Octeon supports a specific feature. These 116210284Sjmallett * checks have been optimized to be fairly quick, but they should still 117210284Sjmallett * be kept out of fast path code. 118210284Sjmallett * 119210284Sjmallett * @param feature Feature to check for. This should always be a constant so the 120210284Sjmallett * compiler can remove the switch statement through optimization. 121210284Sjmallett * 122210284Sjmallett * @return Non zero if the feature exists. Zero if the feature does not 123210284Sjmallett * exist. 124232812Sjmallett * 125232812Sjmallett * Note: This was octeon_has_feature before the feature map and is 126232812Sjmallett * called only after model-checking is set up in octeon_feature_init(). 127210284Sjmallett */ 128232812Sjmallettstatic inline int old_octeon_has_feature(octeon_feature_t feature) 129210284Sjmallett{ 130210284Sjmallett switch (feature) 131210284Sjmallett { 132210284Sjmallett case OCTEON_FEATURE_SAAD: 133210284Sjmallett return !OCTEON_IS_MODEL(OCTEON_CN3XXX); 134210284Sjmallett 135210284Sjmallett case OCTEON_FEATURE_ZIP: 136210284Sjmallett if (OCTEON_IS_MODEL(OCTEON_CN30XX) || OCTEON_IS_MODEL(OCTEON_CN50XX) || OCTEON_IS_MODEL(OCTEON_CN52XX)) 137210284Sjmallett return 0; 138210284Sjmallett else 139215990Sjmallett return !cvmx_fuse_read(121); 140210284Sjmallett 141210284Sjmallett case OCTEON_FEATURE_CRYPTO: 142232812Sjmallett if (OCTEON_IS_MODEL(OCTEON_CN6XXX) || OCTEON_IS_MODEL(OCTEON_CNF7XXX)) { 143215990Sjmallett cvmx_mio_fus_dat2_t fus_2; 144215990Sjmallett fus_2.u64 = cvmx_read_csr(CVMX_MIO_FUS_DAT2); 145215990Sjmallett if (fus_2.s.nocrypto || fus_2.s.nomul) { 146215990Sjmallett return 0; 147215990Sjmallett } else if (!fus_2.s.dorm_crypto) { 148215990Sjmallett return 1; 149215990Sjmallett } else { 150215990Sjmallett cvmx_rnm_ctl_status_t st; 151215990Sjmallett st.u64 = cvmx_read_csr(CVMX_RNM_CTL_STATUS); 152215990Sjmallett return st.s.eer_val; 153215990Sjmallett } 154215990Sjmallett } else { 155215990Sjmallett return !cvmx_fuse_read(90); 156215990Sjmallett } 157210284Sjmallett 158215990Sjmallett case OCTEON_FEATURE_DORM_CRYPTO: 159232812Sjmallett if (OCTEON_IS_MODEL(OCTEON_CN6XXX) || OCTEON_IS_MODEL(OCTEON_CNF7XXX)) { 160215990Sjmallett cvmx_mio_fus_dat2_t fus_2; 161215990Sjmallett fus_2.u64 = cvmx_read_csr(CVMX_MIO_FUS_DAT2); 162215990Sjmallett return !fus_2.s.nocrypto && !fus_2.s.nomul && fus_2.s.dorm_crypto; 163215990Sjmallett } else { 164215990Sjmallett return 0; 165215990Sjmallett } 166215990Sjmallett 167210284Sjmallett case OCTEON_FEATURE_PCIE: 168232812Sjmallett return (OCTEON_IS_MODEL(OCTEON_CN56XX) 169232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CN52XX) 170232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CN6XXX) 171232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CNF7XXX)); 172210284Sjmallett 173215990Sjmallett case OCTEON_FEATURE_SRIO: 174232812Sjmallett return (OCTEON_IS_MODEL(OCTEON_CN63XX) || OCTEON_IS_MODEL(OCTEON_CN66XX)); 175215990Sjmallett 176232812Sjmallett case OCTEON_FEATURE_ILK: 177232812Sjmallett return (OCTEON_IS_MODEL(OCTEON_CN68XX)); 178232812Sjmallett 179210284Sjmallett case OCTEON_FEATURE_KEY_MEMORY: 180232812Sjmallett return (OCTEON_IS_MODEL(OCTEON_CN38XX) 181232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CN58XX) 182232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CN56XX) 183232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CN6XXX) 184232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CNF7XXX)); 185215990Sjmallett 186210284Sjmallett case OCTEON_FEATURE_LED_CONTROLLER: 187215990Sjmallett return OCTEON_IS_MODEL(OCTEON_CN38XX) || OCTEON_IS_MODEL(OCTEON_CN58XX) || OCTEON_IS_MODEL(OCTEON_CN56XX); 188215990Sjmallett 189210284Sjmallett case OCTEON_FEATURE_TRA: 190210284Sjmallett return !(OCTEON_IS_MODEL(OCTEON_CN30XX) || OCTEON_IS_MODEL(OCTEON_CN50XX)); 191210284Sjmallett case OCTEON_FEATURE_MGMT_PORT: 192232812Sjmallett return (OCTEON_IS_MODEL(OCTEON_CN56XX) 193232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CN52XX) 194232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CN6XXX)); 195215990Sjmallett 196210284Sjmallett case OCTEON_FEATURE_RAID: 197215990Sjmallett return OCTEON_IS_MODEL(OCTEON_CN56XX) || OCTEON_IS_MODEL(OCTEON_CN52XX) || OCTEON_IS_MODEL(OCTEON_CN6XXX); 198215990Sjmallett 199210284Sjmallett case OCTEON_FEATURE_USB: 200210284Sjmallett return !(OCTEON_IS_MODEL(OCTEON_CN38XX) || OCTEON_IS_MODEL(OCTEON_CN58XX)); 201215990Sjmallett 202210284Sjmallett case OCTEON_FEATURE_NO_WPTR: 203232812Sjmallett return ((OCTEON_IS_MODEL(OCTEON_CN56XX) 204232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CN52XX) 205232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CN6XXX) 206232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CNF7XXX)) 207232812Sjmallett && !OCTEON_IS_MODEL(OCTEON_CN56XX_PASS1_X) 208232812Sjmallett && !OCTEON_IS_MODEL(OCTEON_CN52XX_PASS1_X)); 209215990Sjmallett 210210284Sjmallett case OCTEON_FEATURE_DFA: 211210284Sjmallett if (!OCTEON_IS_MODEL(OCTEON_CN38XX) && !OCTEON_IS_MODEL(OCTEON_CN31XX) && !OCTEON_IS_MODEL(OCTEON_CN58XX)) 212210284Sjmallett return 0; 213210284Sjmallett else if (OCTEON_IS_MODEL(OCTEON_CN3020)) 214210284Sjmallett return 0; 215210284Sjmallett else 216215990Sjmallett return !cvmx_fuse_read(120); 217215990Sjmallett 218232812Sjmallett case OCTEON_FEATURE_HFA: 219232812Sjmallett if (!OCTEON_IS_MODEL(OCTEON_CN6XXX)) 220232812Sjmallett return 0; 221232812Sjmallett else 222232812Sjmallett return !cvmx_fuse_read(90); 223232812Sjmallett 224232812Sjmallett case OCTEON_FEATURE_DFM: 225232812Sjmallett if (!(OCTEON_IS_MODEL(OCTEON_CN63XX) || OCTEON_IS_MODEL(OCTEON_CN66XX))) 226232812Sjmallett return 0; 227232812Sjmallett else 228232812Sjmallett return !cvmx_fuse_read(90); 229232812Sjmallett 230210284Sjmallett case OCTEON_FEATURE_MDIO_CLAUSE_45: 231215990Sjmallett return !(OCTEON_IS_MODEL(OCTEON_CN3XXX) || OCTEON_IS_MODEL(OCTEON_CN58XX) || OCTEON_IS_MODEL(OCTEON_CN50XX)); 232215990Sjmallett 233215990Sjmallett case OCTEON_FEATURE_NPEI: 234215990Sjmallett return (OCTEON_IS_MODEL(OCTEON_CN56XX) || OCTEON_IS_MODEL(OCTEON_CN52XX)); 235232812Sjmallett 236232812Sjmallett case OCTEON_FEATURE_PKND: 237232812Sjmallett return (OCTEON_IS_MODEL(OCTEON_CN68XX)); 238232812Sjmallett 239232812Sjmallett case OCTEON_FEATURE_CN68XX_WQE: 240232812Sjmallett return (OCTEON_IS_MODEL(OCTEON_CN68XX)); 241232812Sjmallett 242232812Sjmallett case OCTEON_FEATURE_CIU2: 243232812Sjmallett return (OCTEON_IS_MODEL(OCTEON_CN68XX)); 244232812Sjmallett 245232812Sjmallett case OCTEON_FEATURE_NAND: 246232812Sjmallett return (OCTEON_IS_MODEL(OCTEON_CN52XX) 247232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CN63XX) 248232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CN66XX) 249232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CN68XX)); 250232812Sjmallett 251232812Sjmallett case OCTEON_FEATURE_DICI_MODE: 252232812Sjmallett return (OCTEON_IS_MODEL(OCTEON_CN68XX_PASS2_X) 253232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CN61XX) 254232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CNF71XX)); 255232812Sjmallett 256232812Sjmallett case OCTEON_FEATURE_BIT_EXTRACTOR: 257232812Sjmallett return (OCTEON_IS_MODEL(OCTEON_CN68XX_PASS2_X) 258232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CN61XX) 259232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CNF71XX)); 260232812Sjmallett 261232812Sjmallett case OCTEON_FEATURE_MMC: 262232812Sjmallett return (OCTEON_IS_MODEL(OCTEON_CN61XX) 263232812Sjmallett || OCTEON_IS_MODEL(OCTEON_CNF71XX)); 264232812Sjmallett default: 265232812Sjmallett break; 266210284Sjmallett } 267210284Sjmallett return 0; 268210284Sjmallett} 269210284Sjmallett 270232812Sjmallett/* 271232812Sjmallett * bit map for octeon features 272232812Sjmallett */ 273232812Sjmallett#define FEATURE_MAP_SIZE 128 274232812Sjmallettextern uint8_t octeon_feature_map[FEATURE_MAP_SIZE]; 275232812Sjmallett 276232812Sjmallett/* 277232812Sjmallett * Answer ``Is the bit for feature set in the bitmap?'' 278232812Sjmallett * @param feature 279232812Sjmallett * @return 1 when the feature is present and 0 otherwise, -1 in case of error. 280232812Sjmallett */ 281232812Sjmallett#if defined(__U_BOOT__) || defined(CVMX_BUILD_FOR_LINUX_HOST) || defined(CVMX_BUILD_FOR_TOOLCHAIN) 282232812Sjmallett#define octeon_has_feature old_octeon_has_feature 283232812Sjmallett#else 284242342Sjmallett#if defined(USE_RUNTIME_MODEL_CHECKS) || (defined(__FreeBSD__) && defined(_KERNEL)) 285232812Sjmallettstatic inline int octeon_has_feature(octeon_feature_t feature) 286232812Sjmallett{ 287232812Sjmallett int byte, bit; 288232812Sjmallett byte = feature >> 3; 289232812Sjmallett bit = feature & 0x7; 290232812Sjmallett 291232812Sjmallett if (byte >= FEATURE_MAP_SIZE) 292232812Sjmallett { 293232812Sjmallett#ifdef CVMX_BUILD_FOR_LINUX_KERNEL 294232812Sjmallett printk("ERROR: octeon_feature_map: Invalid Octeon Feature 0x%x\n", feature); 295232812Sjmallett#else 296232812Sjmallett printf("ERROR: octeon_feature_map: Invalid Octeon Feature 0x%x\n", feature); 297232812Sjmallett#endif 298232812Sjmallett return -1; 299232812Sjmallett } 300232812Sjmallett 301232812Sjmallett return (octeon_feature_map[byte] & ((1 << bit))) ? 1 : 0; 302232812Sjmallett} 303232812Sjmallett#else 304232812Sjmallett#define octeon_has_feature old_octeon_has_feature 305232812Sjmallett#endif 306232812Sjmallett#endif 307232812Sjmallett 308232812Sjmallett/* 309232812Sjmallett * initialize octeon_feature_map[] 310232812Sjmallett */ 311232812Sjmallettextern void octeon_feature_init(void); 312232812Sjmallett 313210284Sjmallett#ifdef __cplusplus 314210284Sjmallett} 315210284Sjmallett#endif 316210284Sjmallett 317210284Sjmallett#endif /* __OCTEON_FEATURE_H__ */ 318