1/***********************license start***************
2 * Copyright (c) 2003-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 RGMII/GMII/MII initialization, configuration,
50 * and monitoring.
51 *
52 * <hr>$Revision: 70030 $<hr>
53 */
54#ifndef __CVMX_HELPER_RGMII_H__
55#define __CVMX_HELPER_RGMII_H__
56
57/**
58 * @INTERNAL
59 * Probe RGMII ports and determine the number present
60 *
61 * @param interface Interface to probe
62 *
63 * @return Number of RGMII/GMII/MII ports (0-4).
64 */
65extern int __cvmx_helper_rgmii_probe(int interface);
66static inline int __cvmx_helper_rgmii_enumerate(int interface)
67{
68	return __cvmx_helper_rgmii_probe(interface);
69}
70
71/**
72 * Put an RGMII interface in loopback mode. Internal packets sent
73 * out will be received back again on the same port. Externally
74 * received packets will echo back out.
75 *
76 * @param port   IPD port number to loop.
77 */
78extern void cvmx_helper_rgmii_internal_loopback(int port);
79
80/**
81 * @INTERNAL
82 * Configure all of the ASX, GMX, and PKO regsiters required
83 * to get RGMII to function on the supplied interface.
84 *
85 * @param interface PKO Interface to configure (0 or 1)
86 *
87 * @return Zero on success
88 */
89extern int __cvmx_helper_rgmii_enable(int interface);
90
91/**
92 * @INTERNAL
93 * Return the link state of an IPD/PKO port as returned by
94 * auto negotiation. The result of this function may not match
95 * Octeon's link config if auto negotiation has changed since
96 * the last call to cvmx_helper_link_set().
97 *
98 * @param ipd_port IPD/PKO port to query
99 *
100 * @return Link state
101 */
102extern cvmx_helper_link_info_t __cvmx_helper_rgmii_link_get(int ipd_port);
103
104/**
105 * @INTERNAL
106 * Configure an IPD/PKO port for the specified link state. This
107 * function does not influence auto negotiation at the PHY level.
108 * The passed link state must always match the link state returned
109 * by cvmx_helper_link_get(). It is normally best to use
110 * cvmx_helper_link_autoconf() instead.
111 *
112 * @param ipd_port  IPD/PKO port to configure
113 * @param link_info The new link state
114 *
115 * @return Zero on success, negative on failure
116 */
117extern int __cvmx_helper_rgmii_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
118
119/**
120 * @INTERNAL
121 * Configure a port for internal and/or external loopback. Internal loopback
122 * causes packets sent by the port to be received by Octeon. External loopback
123 * causes packets received from the wire to sent out again.
124 *
125 * @param ipd_port IPD/PKO port to loopback.
126 * @param enable_internal
127 *                 Non zero if you want internal loopback
128 * @param enable_external
129 *                 Non zero if you want external loopback
130 *
131 * @return Zero on success, negative on failure.
132 */
133extern int __cvmx_helper_rgmii_configure_loopback(int ipd_port, int enable_internal, int enable_external);
134
135#endif
136