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

   1 /***********************license start***************
   2  * Copyright (c) 2003-2010  Cavium Inc. (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 Inc. 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  * This Software, including technical data, may be subject to U.S. export  control
  24  * laws, including the U.S. Export Administration Act and its  associated
  25  * regulations, and may be subject to export or import  regulations in other
  26  * countries.
  27
  28  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
  29  * AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR
  30  * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
  31  * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR
  32  * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM
  33  * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE,
  34  * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF
  35  * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR
  36  * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE  RISK ARISING OUT OF USE OR
  37  * PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
  38  ***********************license end**************************************/
  39
  40
  41
  42
  43
  44
  45
  46 /**
  47  * @file
  48  *
  49  * Functions for SPI initialization, configuration,
  50  * and monitoring.
  51  *
  52  * <hr>$Revision: 70030 $<hr>
  53  */
  54 #ifndef __CVMX_HELPER_SPI_H__
  55 #define __CVMX_HELPER_SPI_H__
  56
  57 /**
  58  * @INTERNAL
  59  * Probe a SPI interface and determine the number of ports
  60  * connected to it. The SPI interface should still be down after
  61  * this call.
  62  *
  63  * @param interface Interface to probe
  64  *
  65  * @return Number of ports on the interface. Zero to disable.
  66  */
  67 extern int __cvmx_helper_spi_probe(int interface);
  68 extern int __cvmx_helper_spi_enumerate(int interface);
  69
  70 /**
  71  * @INTERNAL
  72  * Bringup and enable a SPI interface. After this call packet I/O
  73  * should be fully functional. This is called with IPD enabled but
  74  * PKO disabled.
  75  *
  76  * @param interface Interface to bring up
  77  *
  78  * @return Zero on success, negative on failure
  79  */
  80 extern int __cvmx_helper_spi_enable(int interface);
  81
  82 /**
  83  * @INTERNAL
  84  * Return the link state of an IPD/PKO port as returned by
  85  * auto negotiation. The result of this function may not match
  86  * Octeon's link config if auto negotiation has changed since
  87  * the last call to cvmx_helper_link_set().
  88  *
  89  * @param ipd_port IPD/PKO port to query
  90  *
  91  * @return Link state
  92  */
  93 extern cvmx_helper_link_info_t __cvmx_helper_spi_link_get(int ipd_port);
  94
  95 /**
  96  * @INTERNAL
  97  * Configure an IPD/PKO port for the specified link state. This
  98  * function does not influence auto negotiation at the PHY level.
  99  * The passed link state must always match the link state returned
 100  * by cvmx_helper_link_get(). It is normally best to use
 101  * cvmx_helper_link_autoconf() instead.
 102  *
 103  * @param ipd_port  IPD/PKO port to configure
 104  * @param link_info The new link state
 105  *
 106  * @return Zero on success, negative on failure
 107  */
 108 extern int __cvmx_helper_spi_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
 109
 110 #endif