cvmx-helper-xaui.h 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  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. * @file
  29. *
  30. * Functions for XAUI initialization, configuration,
  31. * and monitoring.
  32. *
  33. */
  34. #ifndef __CVMX_HELPER_XAUI_H__
  35. #define __CVMX_HELPER_XAUI_H__
  36. /**
  37. * Probe a XAUI interface and determine the number of ports
  38. * connected to it. The XAUI interface should still be down
  39. * after this call.
  40. *
  41. * @interface: Interface to probe
  42. *
  43. * Returns Number of ports on the interface. Zero to disable.
  44. */
  45. extern int __cvmx_helper_xaui_probe(int interface);
  46. extern int __cvmx_helper_xaui_enumerate(int interface);
  47. /**
  48. * Bringup and enable a XAUI interface. After this call packet
  49. * I/O should be fully functional. This is called with IPD
  50. * enabled but PKO disabled.
  51. *
  52. * @interface: Interface to bring up
  53. *
  54. * Returns Zero on success, negative on failure
  55. */
  56. extern int __cvmx_helper_xaui_enable(int interface);
  57. /**
  58. * Return the link state of an IPD/PKO port as returned by
  59. * auto negotiation. The result of this function may not match
  60. * Octeon's link config if auto negotiation has changed since
  61. * the last call to cvmx_helper_link_set().
  62. *
  63. * @ipd_port: IPD/PKO port to query
  64. *
  65. * Returns Link state
  66. */
  67. extern union cvmx_helper_link_info __cvmx_helper_xaui_link_get(int ipd_port);
  68. /**
  69. * Configure an IPD/PKO port for the specified link state. This
  70. * function does not influence auto negotiation at the PHY level.
  71. * The passed link state must always match the link state returned
  72. * by cvmx_helper_link_get().
  73. *
  74. * @ipd_port: IPD/PKO port to configure
  75. * @link_info: The new link state
  76. *
  77. * Returns Zero on success, negative on failure
  78. */
  79. extern int __cvmx_helper_xaui_link_set(int ipd_port,
  80. union cvmx_helper_link_info link_info);
  81. #endif