18c2ecf20Sopenharmony_ci/***********************license start***************
28c2ecf20Sopenharmony_ci * Author: Cavium Networks
38c2ecf20Sopenharmony_ci *
48c2ecf20Sopenharmony_ci * Contact: support@caviumnetworks.com
58c2ecf20Sopenharmony_ci * This file is part of the OCTEON SDK
68c2ecf20Sopenharmony_ci *
78c2ecf20Sopenharmony_ci * Copyright (c) 2003-2008 Cavium Networks
88c2ecf20Sopenharmony_ci *
98c2ecf20Sopenharmony_ci * This file is free software; you can redistribute it and/or modify
108c2ecf20Sopenharmony_ci * it under the terms of the GNU General Public License, Version 2, as
118c2ecf20Sopenharmony_ci * published by the Free Software Foundation.
128c2ecf20Sopenharmony_ci *
138c2ecf20Sopenharmony_ci * This file is distributed in the hope that it will be useful, but
148c2ecf20Sopenharmony_ci * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty
158c2ecf20Sopenharmony_ci * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
168c2ecf20Sopenharmony_ci * NONINFRINGEMENT.  See the GNU General Public License for more
178c2ecf20Sopenharmony_ci * details.
188c2ecf20Sopenharmony_ci *
198c2ecf20Sopenharmony_ci * You should have received a copy of the GNU General Public License
208c2ecf20Sopenharmony_ci * along with this file; if not, write to the Free Software
218c2ecf20Sopenharmony_ci * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
228c2ecf20Sopenharmony_ci * or visit http://www.gnu.org/licenses/.
238c2ecf20Sopenharmony_ci *
248c2ecf20Sopenharmony_ci * This file may also be available under a different license from Cavium.
258c2ecf20Sopenharmony_ci * Contact Cavium Networks for more information
268c2ecf20Sopenharmony_ci ***********************license end**************************************/
278c2ecf20Sopenharmony_ci
288c2ecf20Sopenharmony_ci/*
298c2ecf20Sopenharmony_ci * Functions for SPI initialization, configuration,
308c2ecf20Sopenharmony_ci * and monitoring.
318c2ecf20Sopenharmony_ci */
328c2ecf20Sopenharmony_ci#ifndef __CVMX_HELPER_SPI_H__
338c2ecf20Sopenharmony_ci#define __CVMX_HELPER_SPI_H__
348c2ecf20Sopenharmony_ci
358c2ecf20Sopenharmony_ci/**
368c2ecf20Sopenharmony_ci * Probe a SPI interface and determine the number of ports
378c2ecf20Sopenharmony_ci * connected to it. The SPI interface should still be down after
388c2ecf20Sopenharmony_ci * this call.
398c2ecf20Sopenharmony_ci *
408c2ecf20Sopenharmony_ci * @interface: Interface to probe
418c2ecf20Sopenharmony_ci *
428c2ecf20Sopenharmony_ci * Returns Number of ports on the interface. Zero to disable.
438c2ecf20Sopenharmony_ci */
448c2ecf20Sopenharmony_ciextern int __cvmx_helper_spi_probe(int interface);
458c2ecf20Sopenharmony_ciextern int __cvmx_helper_spi_enumerate(int interface);
468c2ecf20Sopenharmony_ci
478c2ecf20Sopenharmony_ci/**
488c2ecf20Sopenharmony_ci * Bringup and enable a SPI interface. After this call packet I/O
498c2ecf20Sopenharmony_ci * should be fully functional. This is called with IPD enabled but
508c2ecf20Sopenharmony_ci * PKO disabled.
518c2ecf20Sopenharmony_ci *
528c2ecf20Sopenharmony_ci * @interface: Interface to bring up
538c2ecf20Sopenharmony_ci *
548c2ecf20Sopenharmony_ci * Returns Zero on success, negative on failure
558c2ecf20Sopenharmony_ci */
568c2ecf20Sopenharmony_ciextern int __cvmx_helper_spi_enable(int interface);
578c2ecf20Sopenharmony_ci
588c2ecf20Sopenharmony_ci/**
598c2ecf20Sopenharmony_ci * Return the link state of an IPD/PKO port as returned by
608c2ecf20Sopenharmony_ci * auto negotiation. The result of this function may not match
618c2ecf20Sopenharmony_ci * Octeon's link config if auto negotiation has changed since
628c2ecf20Sopenharmony_ci * the last call to cvmx_helper_link_set().
638c2ecf20Sopenharmony_ci *
648c2ecf20Sopenharmony_ci * @ipd_port: IPD/PKO port to query
658c2ecf20Sopenharmony_ci *
668c2ecf20Sopenharmony_ci * Returns Link state
678c2ecf20Sopenharmony_ci */
688c2ecf20Sopenharmony_ciextern union cvmx_helper_link_info __cvmx_helper_spi_link_get(int ipd_port);
698c2ecf20Sopenharmony_ci
708c2ecf20Sopenharmony_ci/**
718c2ecf20Sopenharmony_ci * Configure an IPD/PKO port for the specified link state. This
728c2ecf20Sopenharmony_ci * function does not influence auto negotiation at the PHY level.
738c2ecf20Sopenharmony_ci * The passed link state must always match the link state returned
748c2ecf20Sopenharmony_ci * by cvmx_helper_link_get().
758c2ecf20Sopenharmony_ci *
768c2ecf20Sopenharmony_ci * @ipd_port:  IPD/PKO port to configure
778c2ecf20Sopenharmony_ci * @link_info: The new link state
788c2ecf20Sopenharmony_ci *
798c2ecf20Sopenharmony_ci * Returns Zero on success, negative on failure
808c2ecf20Sopenharmony_ci */
818c2ecf20Sopenharmony_ciextern int __cvmx_helper_spi_link_set(int ipd_port,
828c2ecf20Sopenharmony_ci				      union cvmx_helper_link_info link_info);
838c2ecf20Sopenharmony_ci
848c2ecf20Sopenharmony_ci#endif
85