cvmx-helper-errata.h revision 215990 
1/***********************license start***************
2 * Copyright (c) 2003-2010  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 * This Software, including technical data, may be subject to U.S. export  control
24 * laws, including the U.S. Export Administration Act and its  associated
25 * regulations, and may be subject to export or import  regulations in other
26 * countries.
27
28 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
29 * AND WITH ALL FAULTS AND CAVIUM  NETWORKS MAKES NO PROMISES, REPRESENTATIONS OR
30 * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
31 * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR
32 * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM
33 * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE,
34 * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF
35 * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR
36 * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE  RISK ARISING OUT OF USE OR
37 * PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
38 ***********************license end**************************************/
39
40
41
42
43
44
45
46/**
47 * @file
48 *
49 * Fixes and workaround for Octeon chip errata. This file
50 * contains functions called by cvmx-helper to workaround known
51 * chip errata. For the most part, code doesn't need to call
52 * these functions directly.
53 *
54 * <hr>$Revision: 52004 $<hr>
55 */
56#ifndef __CVMX_HELPER_ERRATA_H__
57#define __CVMX_HELPER_ERRATA_H__
58
59/**
60 * @INTERNAL
61 * Function to adjust internal IPD pointer alignments
62 *
63 * @return 0 on success
64 *         !0 on failure
65 */
66extern int __cvmx_helper_errata_fix_ipd_ptr_alignment(void);
67
68/**
69 * This function needs to be called on all Octeon chips with
70 * errata PKI-100.
71 *
72 * The Size field is 8 too large in WQE and next pointers
73 *
74 *  The Size field generated by IPD is 8 larger than it should
75 *  be. The Size field is <55:40> of both:
76 *      - WORD3 in the work queue entry, and
77 *      - the next buffer pointer (which precedes the packet data
78 *        in each buffer).
79 *
80 * @param work   Work queue entry to fix
81 * @return Zero on success. Negative on failure
82 */
83extern int cvmx_helper_fix_ipd_packet_chain(cvmx_wqe_t *work);
84
85/**
86 * Due to errata G-720, the 2nd order CDR circuit on CN52XX pass
87 * 1 doesn't work properly. The following code disables 2nd order
88 * CDR for the specified QLM.
89 *
90 * @param qlm    QLM to disable 2nd order CDR for.
91 */
92extern void __cvmx_helper_errata_qlm_disable_2nd_order_cdr(int qlm);
93#endif
94