1/***********************license start***************
2 * Copyright (c) 2010  Cavium Inc. (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 Inc. 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 INC. 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 * Functions for ILK initialization, configuration,
50 * and monitoring.
51 *
52 * <hr>$Revision: 41586 $<hr>
53 */
54#ifndef __CVMX_HELPER_ILK_H__
55#define __CVMX_HELPER_ILK_H__
56
57extern int __cvmx_helper_ilk_enumerate(int interface);
58
59/**
60 * @INTERNAL
61 * Probe a ILK interface and determine the number of ports
62 * connected to it. The ILK interface should still be down after
63 * this call.
64 *
65 * @param interface Interface to probe
66 *
67 * @return Number of ports on the interface. Zero to disable.
68 */
69extern int __cvmx_helper_ilk_probe(int interface);
70
71/**
72 * @INTERNAL
73 * Bringup and enable a ILK interface. After this call packet
74 * I/O should be fully functional. This is called with IPD
75 * enabled but PKO disabled.
76 *
77 * @param interface Interface to bring up
78 *
79 * @return Zero on success, negative on failure
80 */
81extern int __cvmx_helper_ilk_enable(int interface);
82
83/**
84 * @INTERNAL
85 * Return the link state of an IPD/PKO port as returned by ILK link status.
86 *
87 * @param ipd_port IPD/PKO port to query
88 *
89 * @return Link state
90 */
91extern cvmx_helper_link_info_t __cvmx_helper_ilk_link_get(int ipd_port);
92
93/**
94 * @INTERNAL
95 * Configure an IPD/PKO port for the specified link state. This
96 * function does not influence auto negotiation at the PHY level.
97 * The passed link state must always match the link state returned
98 * by cvmx_helper_link_get(). It is normally best to use
99 * cvmx_helper_link_autoconf() instead.
100 *
101 * @param ipd_port  IPD/PKO port to configure
102 * @param link_info The new link state
103 *
104 * @return Zero on success, negative on failure
105 */
106extern int __cvmx_helper_ilk_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
107
108extern void __cvmx_helper_ilk_show_stats (void);
109#endif
110
111