arch/mips/include/asm/octeon/cvmx-helper-board.h

   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  *
  30  * Helper functions to abstract board specific data about
  31  * network ports from the rest of the cvmx-helper files.
  32  *
  33  */
  34 #ifndef __CVMX_HELPER_BOARD_H__
  35 #define __CVMX_HELPER_BOARD_H__
  36
  37 #include "cvmx-helper.h"
  38
  39 typedef enum {
  40         set_phy_link_flags_autoneg = 0x1,
  41         set_phy_link_flags_flow_control_dont_touch = 0x0 << 1,
  42         set_phy_link_flags_flow_control_enable = 0x1 << 1,
  43         set_phy_link_flags_flow_control_disable = 0x2 << 1,
  44         set_phy_link_flags_flow_control_mask = 0x3 << 1,        /* Mask for 2 bit wide flow control field */
  45 } cvmx_helper_board_set_phy_link_flags_types_t;
  46
  47 /*
  48  * Fake IPD port, the RGMII/MII interface may use different PHY, use
  49  * this macro to return appropriate MIX address to read the PHY.
  50  */
  51 #define CVMX_HELPER_BOARD_MGMT_IPD_PORT     -10
  52
  53 /**
  54  * cvmx_override_board_link_get(int ipd_port) is a function
  55  * pointer. It is meant to allow customization of the process of
  56  * talking to a PHY to determine link speed. It is called every
  57  * time a PHY must be polled for link status. Users should set
  58  * this pointer to a function before calling any cvmx-helper
  59  * operations.
  60  */
  61 extern cvmx_helper_link_info_t(*cvmx_override_board_link_get) (int ipd_port);
  62
  63 /**
  64  * Return the MII PHY address associated with the given IPD
  65  * port. A result of -1 means there isn't a MII capable PHY
  66  * connected to this port. On chips supporting multiple MII
  67  * busses the bus number is encoded in bits <15:8>.
  68  *
  69  * This function must be modifed for every new Octeon board.
  70  * Internally it uses switch statements based on the cvmx_sysinfo
  71  * data to determine board types and revisions. It relys on the
  72  * fact that every Octeon board receives a unique board type
  73  * enumeration from the bootloader.
  74  *
  75  * @ipd_port: Octeon IPD port to get the MII address for.
  76  *
  77  * Returns MII PHY address and bus number or -1.
  78  */
  79 extern int cvmx_helper_board_get_mii_address(int ipd_port);
  80
  81 /**
  82  * This function as a board specific method of changing the PHY
  83  * speed, duplex, and autonegotiation. This programs the PHY and
  84  * not Octeon. This can be used to force Octeon's links to
  85  * specific settings.
  86  *
  87  * @phy_addr:  The address of the PHY to program
  88  * @link_flags:
  89  *                  Flags to control autonegotiation.  Bit 0 is autonegotiation
  90  *                  enable/disable to maintain backware compatibility.
  91  * @link_info: Link speed to program. If the speed is zero and autonegotiation
  92  *                  is enabled, all possible negotiation speeds are advertised.
  93  *
  94  * Returns Zero on success, negative on failure
  95  */
  96 int cvmx_helper_board_link_set_phy(int phy_addr,
  97                                    cvmx_helper_board_set_phy_link_flags_types_t
  98                                    link_flags,
  99                                    cvmx_helper_link_info_t link_info);
 100
 101 /**
 102  * This function is the board specific method of determining an
 103  * ethernet ports link speed. Most Octeon boards have Marvell PHYs
 104  * and are handled by the fall through case. This function must be
 105  * updated for boards that don't have the normal Marvell PHYs.
 106  *
 107  * This function must be modifed for every new Octeon board.
 108  * Internally it uses switch statements based on the cvmx_sysinfo
 109  * data to determine board types and revisions. It relys on the
 110  * fact that every Octeon board receives a unique board type
 111  * enumeration from the bootloader.
 112  *
 113  * @ipd_port: IPD input port associated with the port we want to get link
 114  *                 status for.
 115  *
 116  * Returns The ports link status. If the link isn't fully resolved, this must
 117  *         return zero.
 118  */
 119 extern cvmx_helper_link_info_t __cvmx_helper_board_link_get(int ipd_port);
 120
 121 /**
 122  * This function is called by cvmx_helper_interface_probe() after it
 123  * determines the number of ports Octeon can support on a specific
 124  * interface. This function is the per board location to override
 125  * this value. It is called with the number of ports Octeon might
 126  * support and should return the number of actual ports on the
 127  * board.
 128  *
 129  * This function must be modifed for every new Octeon board.
 130  * Internally it uses switch statements based on the cvmx_sysinfo
 131  * data to determine board types and revisions. It relys on the
 132  * fact that every Octeon board receives a unique board type
 133  * enumeration from the bootloader.
 134  *
 135  * @interface: Interface to probe
 136  * @supported_ports:
 137  *                  Number of ports Octeon supports.
 138  *
 139  * Returns Number of ports the actual board supports. Many times this will
 140  *         simple be "support_ports".
 141  */
 142 extern int __cvmx_helper_board_interface_probe(int interface,
 143                                                int supported_ports);
 144
 145 /**
 146  * Enable packet input/output from the hardware. This function is
 147  * called after by cvmx_helper_packet_hardware_enable() to
 148  * perform board specific initialization. For most boards
 149  * nothing is needed.
 150  *
 151  * @interface: Interface to enable
 152  *
 153  * Returns Zero on success, negative on failure
 154  */
 155 extern int __cvmx_helper_board_hardware_enable(int interface);
 156
 157 #endif /* __CVMX_HELPER_BOARD_H__ */