1/***********************license start***************
  2 * Author: Cavium Networks
  3 *
  4 * Contact: support@caviumnetworks.com
  5 * This file is part of the OCTEON SDK
  6 *
  7 * Copyright (c) 2003-2008 Cavium Networks
  8 *
  9 * This file is free software; you can redistribute it and/or modify
 10 * it under the terms of the GNU General Public License, Version 2, as
 11 * published by the Free Software Foundation.
 12 *
 13 * This file is distributed in the hope that it will be useful, but
 14 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty
 15 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
 16 * NONINFRINGEMENT.  See the GNU General Public License for more
 17 * details.
 18 *
 19 * You should have received a copy of the GNU General Public License
 20 * along with this file; if not, write to the Free Software
 21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 22 * or visit http://www.gnu.org/licenses/.
 23 *
 24 * This file may also be available under a different license from Cavium.
 25 * Contact Cavium Networks for more information
 26 ***********************license end**************************************/
 27
 28/**
 29 * @file
 30 *
 31 * Functions for XAUI initialization, configuration,
 32 * and monitoring.
 33 *
 34 */
 35#ifndef __CVMX_HELPER_XAUI_H__
 36#define __CVMX_HELPER_XAUI_H__
 37
 38/**
 39 * Probe a XAUI interface and determine the number of ports
 40 * connected to it. The XAUI interface should still be down
 41 * after this call.
 42 *
 43 * @interface: Interface to probe
 44 *
 45 * Returns Number of ports on the interface. Zero to disable.
 46 */
 47extern int __cvmx_helper_xaui_probe(int interface);
 48extern int __cvmx_helper_xaui_enumerate(int interface);
 49
 50/**
 51 * Bringup and enable a XAUI interface. After this call packet
 52 * I/O should be fully functional. This is called with IPD
 53 * enabled but PKO disabled.
 54 *
 55 * @interface: Interface to bring up
 56 *
 57 * Returns Zero on success, negative on failure
 58 */
 59extern int __cvmx_helper_xaui_enable(int interface);
 60
 61/**
 62 * Return the link state of an IPD/PKO port as returned by
 63 * auto negotiation. The result of this function may not match
 64 * Octeon's link config if auto negotiation has changed since
 65 * the last call to cvmx_helper_link_set().
 66 *
 67 * @ipd_port: IPD/PKO port to query
 68 *
 69 * Returns Link state
 70 */
 71extern cvmx_helper_link_info_t __cvmx_helper_xaui_link_get(int ipd_port);
 72
 73/**
 74 * Configure an IPD/PKO port for the specified link state. This
 75 * function does not influence auto negotiation at the PHY level.
 76 * The passed link state must always match the link state returned
 77 * by cvmx_helper_link_get(). It is normally best to use
 78 * cvmx_helper_link_autoconf() instead.
 79 *
 80 * @ipd_port:  IPD/PKO port to configure
 81 * @link_info: The new link state
 82 *
 83 * Returns Zero on success, negative on failure
 84 */
 85extern int __cvmx_helper_xaui_link_set(int ipd_port,
 86				       cvmx_helper_link_info_t link_info);
 87
 88/**
 89 * Configure a port for internal and/or external loopback. Internal loopback
 90 * causes packets sent by the port to be received by Octeon. External loopback
 91 * causes packets received from the wire to sent out again.
 92 *
 93 * @ipd_port: IPD/PKO port to loopback.
 94 * @enable_internal:
 95 *                 Non zero if you want internal loopback
 96 * @enable_external:
 97 *                 Non zero if you want external loopback
 98 *
 99 * Returns Zero on success, negative on failure.
100 */
101extern int __cvmx_helper_xaui_configure_loopback(int ipd_port,
102						 int enable_internal,
103						 int enable_external);
104#endif