cvmx-helper-rgmii.h revision 210286
1139743Simp/***********************license start*************** 243412Snewton * Copyright (c) 2003-2008 Cavium Networks (support@cavium.com). All rights 343412Snewton * reserved. 443412Snewton * 543412Snewton * 643412Snewton * Redistribution and use in source and binary forms, with or without 743412Snewton * modification, are permitted provided that the following conditions are 843412Snewton * met: 943412Snewton * 1043412Snewton * * Redistributions of source code must retain the above copyright 1143412Snewton * notice, this list of conditions and the following disclaimer. 1243412Snewton * 1343412Snewton * * Redistributions in binary form must reproduce the above 1443412Snewton * copyright notice, this list of conditions and the following 1543412Snewton * disclaimer in the documentation and/or other materials provided 1643412Snewton * with the distribution. 1743412Snewton * 1843412Snewton * * Neither the name of Cavium Networks nor the names of 1943412Snewton * its contributors may be used to endorse or promote products 2043412Snewton * derived from this software without specific prior written 2143412Snewton * permission. 2243412Snewton * 2343412Snewton * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" 2443412Snewton * AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS 2543412Snewton * OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH 2643412Snewton * RESPECT TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY 2749267Snewton * REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT 2850477Speter * DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES 2943412Snewton * OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR 3043412Snewton * PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET 3143412Snewton * POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT 3243412Snewton * OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU. 3343412Snewton * 3443412Snewton * 3543412Snewton * For any questions regarding licensing please contact marketing@caviumnetworks.com 3643412Snewton * 3743412Snewton ***********************license end**************************************/ 3843412Snewton 3943412Snewton 4043412Snewton 4143412Snewton 4243412Snewton 4343412Snewton 4443412Snewton/** 4543412Snewton * @file 4643412Snewton * 4743412Snewton * Functions for RGMII/GMII/MII initialization, configuration, 4843412Snewton * and monitoring. 4992761Salfred * 5092761Salfred * <hr>$Revision: 41586 $<hr> 5192761Salfred */ 5292761Salfred#ifndef __CVMX_HELPER_RGMII_H__ 5392761Salfred#define __CVMX_HELPER_RGMII_H__ 5492761Salfred 5592761Salfred/** 5692761Salfred * @INTERNAL 5792761Salfred * Probe RGMII ports and determine the number present 5892761Salfred * 5992761Salfred * @param interface Interface to probe 6092761Salfred * 6143412Snewton * @return Number of RGMII/GMII/MII ports (0-4). 6243412Snewton */ 63extern int __cvmx_helper_rgmii_probe(int interface); 64 65/** 66 * Put an RGMII interface in loopback mode. Internal packets sent 67 * out will be received back again on the same port. Externally 68 * received packets will echo back out. 69 * 70 * @param port IPD port number to loop. 71 */ 72extern void cvmx_helper_rgmii_internal_loopback(int port); 73 74/** 75 * @INTERNAL 76 * Configure all of the ASX, GMX, and PKO regsiters required 77 * to get RGMII to function on the supplied interface. 78 * 79 * @param interface PKO Interface to configure (0 or 1) 80 * 81 * @return Zero on success 82 */ 83extern int __cvmx_helper_rgmii_enable(int interface); 84 85/** 86 * @INTERNAL 87 * Return the link state of an IPD/PKO port as returned by 88 * auto negotiation. The result of this function may not match 89 * Octeon's link config if auto negotiation has changed since 90 * the last call to cvmx_helper_link_set(). 91 * 92 * @param ipd_port IPD/PKO port to query 93 * 94 * @return Link state 95 */ 96extern cvmx_helper_link_info_t __cvmx_helper_rgmii_link_get(int ipd_port); 97 98/** 99 * @INTERNAL 100 * Configure an IPD/PKO port for the specified link state. This 101 * function does not influence auto negotiation at the PHY level. 102 * The passed link state must always match the link state returned 103 * by cvmx_helper_link_get(). It is normally best to use 104 * cvmx_helper_link_autoconf() instead. 105 * 106 * @param ipd_port IPD/PKO port to configure 107 * @param link_info The new link state 108 * 109 * @return Zero on success, negative on failure 110 */ 111extern int __cvmx_helper_rgmii_link_set(int ipd_port, cvmx_helper_link_info_t link_info); 112 113/** 114 * @INTERNAL 115 * Configure a port for internal and/or external loopback. Internal loopback 116 * causes packets sent by the port to be received by Octeon. External loopback 117 * causes packets received from the wire to sent out again. 118 * 119 * @param ipd_port IPD/PKO port to loopback. 120 * @param enable_internal 121 * Non zero if you want internal loopback 122 * @param enable_external 123 * Non zero if you want external loopback 124 * 125 * @return Zero on success, negative on failure. 126 */ 127extern int __cvmx_helper_rgmii_configure_loopback(int ipd_port, int enable_internal, int enable_external); 128 129#endif 130