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