cvmx-helper-rgmii.h revision 210284
1/***********************license start*************** 2 * Copyright (c) 2003-2008 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 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" 24 * AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS 25 * OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH 26 * RESPECT TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY 27 * REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT 28 * DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES 29 * OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR 30 * PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET 31 * POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT 32 * OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU. 33 * 34 * 35 * For any questions regarding licensing please contact marketing@caviumnetworks.com 36 * 37 ***********************license end**************************************/ 38 39 40 41 42 43 44/** 45 * @file 46 * 47 * Functions for RGMII/GMII/MII initialization, configuration, 48 * and monitoring. 49 * 50 * <hr>$Revision: 41586 $<hr> 51 */ 52#ifndef __CVMX_HELPER_RGMII_H__ 53#define __CVMX_HELPER_RGMII_H__ 54 55/** 56 * @INTERNAL 57 * Probe RGMII ports and determine the number present 58 * 59 * @param interface Interface to probe 60 * 61 * @return Number of RGMII/GMII/MII ports (0-4). 62 */ 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