sys/contrib/octeon-sdk/cvmx-helper-errata.h

   1 /***********************license start***************
   2  *  Copyright (c) 2003-2008 Cavium Networks (support@cavium.com). All rights
   3  *  reserved.
   4  *
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions are
   8  *  met:
   9  *
  10  *      * Redistributions of source code must retain the above copyright
  11  *        notice, this list of conditions and the following disclaimer.
  12  *
  13  *      * Redistributions in binary form must reproduce the above
  14  *        copyright notice, this list of conditions and the following
  15  *        disclaimer in the documentation and/or other materials provided
  16  *        with the distribution.
  17  *
  18  *      * Neither the name of Cavium Networks nor the names of
  19  *        its contributors may be used to endorse or promote products
  20  *        derived from this software without specific prior written
  21  *        permission.
  22  *
  23  *  TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
  24  *  AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS
  25  *  OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH
  26  *  RESPECT TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY
  27  *  REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT
  28  *  DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES
  29  *  OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR
  30  *  PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET
  31  *  POSSESSION OR CORRESPONDENCE TO DESCRIPTION.  THE ENTIRE RISK ARISING OUT
  32  *  OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
  33  *
  34  *
  35  *  For any questions regarding licensing please contact marketing@caviumnetworks.com
  36  *
  37  ***********************license end**************************************/
  38
  39
  40
  41
  42
  43
  44 /**
  45  * @file
  46  *
  47  * Fixes and workaround for Octeon chip errata. This file
  48  * contains functions called by cvmx-helper to workaround known
  49  * chip errata. For the most part, code doesn't need to call
  50  * these functions directly.
  51  *
  52  * <hr>$Revision: 41586 $<hr>
  53  */
  54 #ifndef __CVMX_HELPER_ERRATA_H__
  55 #define __CVMX_HELPER_ERRATA_H__
  56
  57 /**
  58  * @INTERNAL
  59  * Function to adjust internal IPD pointer alignments
  60  *
  61  * @return 0 on success
  62  *         !0 on failure
  63  */
  64 extern int __cvmx_helper_errata_fix_ipd_ptr_alignment(void);
  65
  66 /**
  67  * @INTERNAL
  68  * Workaround ASX setup errata with CN38XX pass1
  69  *
  70  * @param interface Interface to setup
  71  * @param port      Port to setup (0..3)
  72  * @param cpu_clock_hz
  73  *                  Chip frequency in Hertz
  74  *
  75  * @return Zero on success, negative on failure
  76  */
  77 extern int __cvmx_helper_errata_asx_pass1(int interface, int port, int cpu_clock_hz);
  78
  79 /**
  80  * This function needs to be called on all Octeon chips with
  81  * errata PKI-100.
  82  *
  83  * The Size field is 8 too large in WQE and next pointers
  84  *
  85  *  The Size field generated by IPD is 8 larger than it should
  86  *  be. The Size field is <55:40> of both:
  87  *      - WORD3 in the work queue entry, and
  88  *      - the next buffer pointer (which precedes the packet data
  89  *        in each buffer).
  90  *
  91  * @param work   Work queue entry to fix
  92  * @return Zero on success. Negative on failure
  93  */
  94 extern int cvmx_helper_fix_ipd_packet_chain(cvmx_wqe_t *work);
  95
  96 /**
  97  * Due to errata G-720, the 2nd order CDR circuit on CN52XX pass
  98  * 1 doesn't work properly. The following code disables 2nd order
  99  * CDR for the specified QLM.
 100  *
 101  * @param qlm    QLM to disable 2nd order CDR for.
 102  */
 103 extern void __cvmx_helper_errata_qlm_disable_2nd_order_cdr(int qlm);
 104
 105 #endif