sys/contrib/octeon-sdk/cvmx-helper-board.h

   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  * Helper functions to abstract board specific data about
  50  * network ports from the rest of the cvmx-helper files.
  51  *
  52  * <hr>$Revision: 49448 $<hr>
  53  */
  54 #ifndef __CVMX_HELPER_BOARD_H__
  55 #define __CVMX_HELPER_BOARD_H__
  56
  57 #ifdef  __cplusplus
  58 extern "C" {
  59 #endif
  60
  61
  62 typedef enum {
  63     USB_CLOCK_TYPE_REF_12,
  64     USB_CLOCK_TYPE_REF_24,
  65     USB_CLOCK_TYPE_REF_48,
  66     USB_CLOCK_TYPE_CRYSTAL_12,
  67 } cvmx_helper_board_usb_clock_types_t;
  68
  69 typedef enum {
  70     set_phy_link_flags_autoneg                  = 0x1,
  71     set_phy_link_flags_flow_control_dont_touch  = 0x0 << 1,
  72     set_phy_link_flags_flow_control_enable      = 0x1 << 1,
  73     set_phy_link_flags_flow_control_disable     = 0x2 << 1,
  74     set_phy_link_flags_flow_control_mask        = 0x3 << 1,  /* Mask for 2 bit wide flow control field */
  75 } cvmx_helper_board_set_phy_link_flags_types_t;
  76
  77
  78 /* Fake IPD port, the RGMII/MII interface may use different PHY, use this
  79    macro to return appropriate MIX address to read the PHY. */
  80 #define CVMX_HELPER_BOARD_MGMT_IPD_PORT     -10
  81
  82 /**
  83  * cvmx_override_board_link_get(int ipd_port) is a function
  84  * pointer. It is meant to allow customization of the process of
  85  * talking to a PHY to determine link speed. It is called every
  86  * time a PHY must be polled for link status. Users should set
  87  * this pointer to a function before calling any cvmx-helper
  88  * operations.
  89  */
  90 extern cvmx_helper_link_info_t (*cvmx_override_board_link_get)(int ipd_port);
  91
  92 /**
  93  * Return the MII PHY address associated with the given IPD
  94  * port. A result of -1 means there isn't a MII capable PHY
  95  * connected to this port. On chips supporting multiple MII
  96  * busses the bus number is encoded in bits <15:8>.
  97  *
  98  * This function must be modified for every new Octeon board.
  99  * Internally it uses switch statements based on the cvmx_sysinfo
 100  * data to determine board types and revisions. It relies on the
 101  * fact that every Octeon board receives a unique board type
 102  * enumeration from the bootloader.
 103  *
 104  * @param ipd_port Octeon IPD port to get the MII address for.
 105  *
 106  * @return MII PHY address and bus number or -1.
 107  */
 108 extern int cvmx_helper_board_get_mii_address(int ipd_port);
 109
 110 /**
 111  * This function as a board specific method of changing the PHY
 112  * speed, duplex, and autonegotiation. This programs the PHY and
 113  * not Octeon. This can be used to force Octeon's links to
 114  * specific settings.
 115  *
 116  * @param phy_addr  The address of the PHY to program
 117  * @param link_flags
 118  *                  Flags to control autonegotiation.  Bit 0 is autonegotiation
 119  *                  enable/disable to maintain backward compatibility.
 120  * @param link_info Link speed to program. If the speed is zero and autonegotiation
 121  *                  is enabled, all possible negotiation speeds are advertised.
 122  *
 123  * @return Zero on success, negative on failure
 124  */
 125 int cvmx_helper_board_link_set_phy(int phy_addr, cvmx_helper_board_set_phy_link_flags_types_t link_flags,
 126                                    cvmx_helper_link_info_t link_info);
 127
 128 /**
 129  * @INTERNAL
 130  * This function is the board specific method of determining an
 131  * ethernet ports link speed. Most Octeon boards have Marvell PHYs
 132  * and are handled by the fall through case. This function must be
 133  * updated for boards that don't have the normal Marvell PHYs.
 134  *
 135  * This function must be modified for every new Octeon board.
 136  * Internally it uses switch statements based on the cvmx_sysinfo
 137  * data to determine board types and revisions. It relies on the
 138  * fact that every Octeon board receives a unique board type
 139  * enumeration from the bootloader.
 140  *
 141  * @param ipd_port IPD input port associated with the port we want to get link
 142  *                 status for.
 143  *
 144  * @return The ports link status. If the link isn't fully resolved, this must
 145  *         return zero.
 146  */
 147 extern cvmx_helper_link_info_t __cvmx_helper_board_link_get(int ipd_port);
 148
 149 /**
 150  * @INTERNAL
 151  * This function is called by cvmx_helper_interface_probe() after it
 152  * determines the number of ports Octeon can support on a specific
 153  * interface. This function is the per board location to override
 154  * this value. It is called with the number of ports Octeon might
 155  * support and should return the number of actual ports on the
 156  * board.
 157  *
 158  * This function must be modified for every new Octeon board.
 159  * Internally it uses switch statements based on the cvmx_sysinfo
 160  * data to determine board types and revisions. It relies on the
 161  * fact that every Octeon board receives a unique board type
 162  * enumeration from the bootloader.
 163  *
 164  * @param interface Interface to probe
 165  * @param supported_ports
 166  *                  Number of ports Octeon supports.
 167  *
 168  * @return Number of ports the actual board supports. Many times this will
 169  *         simple be "support_ports".
 170  */
 171 extern int __cvmx_helper_board_interface_probe(int interface, int supported_ports);
 172
 173 /**
 174  * @INTERNAL
 175  * Enable packet input/output from the hardware. This function is
 176  * called after by cvmx_helper_packet_hardware_enable() to
 177  * perform board specific initialization. For most boards
 178  * nothing is needed.
 179  *
 180  * @param interface Interface to enable
 181  *
 182  * @return Zero on success, negative on failure
 183  */
 184 extern int __cvmx_helper_board_hardware_enable(int interface);
 185
 186
 187
 188
 189 /**
 190  * @INTERNAL
 191  * Gets the clock type used for the USB block based on board type.
 192  * Used by the USB code for auto configuration of clock type.
 193  *
 194  * @return USB clock type enumeration
 195  */
 196 cvmx_helper_board_usb_clock_types_t __cvmx_helper_board_usb_get_clock_type(void);
 197
 198
 199 /**
 200  * @INTERNAL
 201  * Adjusts the number of available USB ports on Octeon based on board
 202  * specifics.
 203  *
 204  * @param supported_ports expected number of ports based on chip type;
 205  *
 206  *
 207  * @return number of available usb ports, based on board specifics.
 208  *         Return value is supported_ports if function does not
 209  *         override.
 210  */
 211 int __cvmx_helper_board_usb_get_num_ports(int supported_ports);
 212
 213 #ifdef  __cplusplus
 214 }
 215 #endif
 216
 217 #endif  /* __CVMX_HELPER_BOARD_H__ */