cvmx-helper-spi.h 2.7 KB

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