sys/contrib/octeon-sdk/cvmx-helper-spi.h

   1 /***********************license start***************
   2  *  Copyright (c) 2003-2008 Cavium Networks (support@cavium.com). All rights
   3  *  reserved.
   4  *
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions are
   8  *  met:
   9  *
  10  *      * Redistributions of source code must retain the above copyright
  11  *        notice, this list of conditions and the following disclaimer.
  12  *
  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.
  17  *
  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
  21  *        permission.
  22  *
  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.
  33  *
  34  *
  35  *  For any questions regarding licensing please contact marketing@caviumnetworks.com
  36  *
  37  ***********************license end**************************************/
  38
  39
  40
  41
  42
  43
  44 /**
  45  * @file
  46  *
  47  * Functions for SPI initialization, configuration,
  48  * and monitoring.
  49  *
  50  * <hr>$Revision: 41586 $<hr>
  51  */
  52 #ifndef __CVMX_HELPER_SPI_H__
  53 #define __CVMX_HELPER_SPI_H__
  54
  55 /**
  56  * @INTERNAL
  57  * Probe a SPI interface and determine the number of ports
  58  * connected to it. The SPI interface should still be down after
  59  * this call.
  60  *
  61  * @param interface Interface to probe
  62  *
  63  * @return Number of ports on the interface. Zero to disable.
  64  */
  65 extern int __cvmx_helper_spi_probe(int interface);
  66
  67 /**
  68  * @INTERNAL
  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
  71  * PKO disabled.
  72  *
  73  * @param interface Interface to bring up
  74  *
  75  * @return Zero on success, negative on failure
  76  */
  77 extern int __cvmx_helper_spi_enable(int interface);
  78
  79 /**
  80  * @INTERNAL
  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().
  85  *
  86  * @param ipd_port IPD/PKO port to query
  87  *
  88  * @return Link state
  89  */
  90 extern cvmx_helper_link_info_t __cvmx_helper_spi_link_get(int ipd_port);
  91
  92 /**
  93  * @INTERNAL
  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.
  99  *
 100  * @param ipd_port  IPD/PKO port to configure
 101  * @param link_info The new link state
 102  *
 103  * @return Zero on success, negative on failure
 104  */
 105 extern int __cvmx_helper_spi_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
 106
 107 #endif