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