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