cvmx-helper-sgmii.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 SGMII initialization, configuration, 50 * and monitoring. 51 * 52 * <hr>$Revision: 49448 $<hr> 53 */ 54#ifndef __CVMX_HELPER_SGMII_H__ 55#define __CVMX_HELPER_SGMII_H__ 56 57/** 58 * @INTERNAL 59 * Probe a SGMII interface and determine the number of ports 60 * connected to it. The SGMII interface should still be down after 61 * this call. 62 * 63 * @param interface Interface to probe 64 * 65 * @return Number of ports on the interface. Zero to disable. 66 */ 67extern int __cvmx_helper_sgmii_probe(int interface); 68 69/** 70 * @INTERNAL 71 * Bringup and enable a SGMII interface. After this call packet 72 * I/O should be fully functional. This is called with IPD 73 * enabled but PKO disabled. 74 * 75 * @param interface Interface to bring up 76 * 77 * @return Zero on success, negative on failure 78 */ 79extern int __cvmx_helper_sgmii_enable(int interface); 80 81/** 82 * @INTERNAL 83 * Return the link state of an IPD/PKO port as returned by 84 * auto negotiation. The result of this function may not match 85 * Octeon's link config if auto negotiation has changed since 86 * the last call to cvmx_helper_link_set(). 87 * 88 * @param ipd_port IPD/PKO port to query 89 * 90 * @return Link state 91 */ 92extern cvmx_helper_link_info_t __cvmx_helper_sgmii_link_get(int ipd_port); 93 94/** 95 * @INTERNAL 96 * Configure an IPD/PKO port for the specified link state. This 97 * function does not influence auto negotiation at the PHY level. 98 * The passed link state must always match the link state returned 99 * by cvmx_helper_link_get(). It is normally best to use 100 * cvmx_helper_link_autoconf() instead. 101 * 102 * @param ipd_port IPD/PKO port to configure 103 * @param link_info The new link state 104 * 105 * @return Zero on success, negative on failure 106 */ 107extern int __cvmx_helper_sgmii_link_set(int ipd_port, cvmx_helper_link_info_t link_info); 108 109/** 110 * @INTERNAL 111 * Configure a port for internal and/or external loopback. Internal loopback 112 * causes packets sent by the port to be received by Octeon. External loopback 113 * causes packets received from the wire to sent out again. 114 * 115 * @param ipd_port IPD/PKO port to loopback. 116 * @param enable_internal 117 * Non zero if you want internal loopback 118 * @param enable_external 119 * Non zero if you want external loopback 120 * 121 * @return Zero on success, negative on failure. 122 */ 123extern int __cvmx_helper_sgmii_configure_loopback(int ipd_port, int enable_internal, int enable_external); 124 125#endif 126