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