1 /***********************license start***************
2 * Copyright (c) 2003-2008 Cavium Networks (support@cavium.com). All rights
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
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.
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
23 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
24 * AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS
25 * OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH
26 * RESPECT TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY
27 * REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT
28 * DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES
29 * OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR
30 * PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET
31 * POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT
32 * OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
35 * For any questions regarding licensing please contact marketing@caviumnetworks.com
37 ***********************license end**************************************/
47 * Functions for SPI initialization, configuration,
50 * <hr>$Revision: 41586 $<hr>
52 #ifndef __CVMX_HELPER_SPI_H__
53 #define __CVMX_HELPER_SPI_H__
57 * Probe a SPI interface and determine the number of ports
58 * connected to it. The SPI interface should still be down after
61 * @param interface Interface to probe
63 * @return Number of ports on the interface. Zero to disable.
65 extern int __cvmx_helper_spi_probe(int interface);
69 * Bringup and enable a SPI interface. After this call packet I/O
70 * should be fully functional. This is called with IPD enabled but
73 * @param interface Interface to bring up
75 * @return Zero on success, negative on failure
77 extern int __cvmx_helper_spi_enable(int interface);
81 * Return the link state of an IPD/PKO port as returned by
82 * auto negotiation. The result of this function may not match
83 * Octeon's link config if auto negotiation has changed since
84 * the last call to cvmx_helper_link_set().
86 * @param ipd_port IPD/PKO port to query
90 extern cvmx_helper_link_info_t __cvmx_helper_spi_link_get(int ipd_port);
94 * Configure an IPD/PKO port for the specified link state. This
95 * function does not influence auto negotiation at the PHY level.
96 * The passed link state must always match the link state returned
97 * by cvmx_helper_link_get(). It is normally best to use
98 * cvmx_helper_link_autoconf() instead.
100 * @param ipd_port IPD/PKO port to configure
101 * @param link_info The new link state
103 * @return Zero on success, negative on failure
105 extern int __cvmx_helper_spi_link_set(int ipd_port, cvmx_helper_link_info_t link_info);