cvmx-helper-loop.h revision 232812 
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 LOOP initialization, configuration,
50 * and monitoring.
51 *
52 * <hr>$Revision: 70030 $<hr>
53 */
54#ifndef __CVMX_HELPER_LOOP_H__
55#define __CVMX_HELPER_LOOP_H__
56
57/**
58 * @INTERNAL
59 * Probe a LOOP interface and determine the number of ports
60 * connected to it. The LOOP 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 */
67extern int __cvmx_helper_loop_probe(int interface);
68extern int __cvmx_helper_loop_enumerate(int interface);
69
70/**
71 * @INTERNAL
72 * Bringup and enable a LOOP interface. After this call packet
73 * I/O should be fully functional. This is called with IPD
74 * enabled but PKO disabled.
75 *
76 * @param interface Interface to bring up
77 *
78 * @return Zero on success, negative on failure
79 */
80extern int __cvmx_helper_loop_enable(int interface);
81
82#endif
83
84