diff options
Diffstat (limited to 'src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-tns.h')
| -rw-r--r-- | src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-tns.h | 109 |
1 files changed, 109 insertions, 0 deletions
diff --git a/src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-tns.h b/src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-tns.h new file mode 100644 index 0000000000..89264c8604 --- /dev/null +++ b/src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-tns.h @@ -0,0 +1,109 @@ +/***********************license start*********************************** +* Copyright (c) 2003-2017 Cavium Inc. (support@cavium.com). All rights +* reserved. +* +* +* 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 Cavium Inc. 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, including technical data, may be subject to U.S. export +* control laws, including the U.S. Export Administration Act and its +* associated regulations, and may be subject to export or import +* regulations in other countries. +* +* TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" +* AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR +* WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT +* TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY +* REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT +* DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES +* OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR +* PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, +* QUIET POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK +* ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU. +***********************license end**************************************/ + +/** + * @file + * + * Thunder Network Switch interface. + * + * $Revision$ + * + * @addtogroup hal + * @{ + */ + +/** + * Initialize the TNS block to enable clocks, allow register accesses, and + * perform some basic initialization in anticipation of future packet + * processing. + * + * TNS at power-up will be in BYPASS mode where packets from the vNIC pipes + * to the BGX ports will be direct, and this will not change that. + * + * This is normally called automatically in bdk-init-main.c. + * + * @param node Node to initialize + * + * @return Zero on success, negative on failure + */ +extern int bdk_tns_initialize(bdk_node_t node) BDK_WEAK; + +/** + * Disable TNS from processing packets. After this, TNS must be fully + * initialized. The NIC and BGX blocks must already be stopped before + * calling this function. + * + * Nota Bene: In CN88XX_PASS_1 there is a bug that prevents TNS DataPath + * from draining packets. So ensure that NIC and BGX have + * also drained their packet queues. + * + * @param node + * + * @return Zero on success, negative on failure + */ +extern int bdk_tns_shutdown(bdk_node_t node); + +/** + * Set the TNS 'profile' to passthru. I.e. do the necessary writes + * to the TNS datapath and TNS sst (Search, SDE, and TxQ) registers + * to configure the TNS to allow vNIC0..vNIC7 <-> LMAC0..LMAC7 traffic + * to flow straight through TNS (although the actual enabling of using + * the TNS is done elsewhere (in traffic-gen.)) + * + * @param node Node to configure + * + * @return Zero on success, negative on failure + */ +extern int bdk_tns_profile_passthru(bdk_node_t node) BDK_WEAK; + +/** + * Set the TNS 'profile' to bgxloopback. I.e. do the necessary writes + * to the TNS datapath and TNS sst (Search, SDE, and TxQ) registers + * to configure the TNS to allow any packets received on LMAC0..LMAC7 + * (BGX ports) to be reflected back to the same port after hitting the + * TNS (although the actual enabling of using the TNS is done elsewhere + * (in traffic-gen.)) + * + * @param node Node to configure + * + * @return Zero on success, negative on failure + */ +extern int bdk_tns_profile_bgxloopback(bdk_node_t node) BDK_WEAK; + +/** @} */ |