Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_cable_status.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_cable_status.h
28 *
29 * @purpose Cable Test Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 10/29/2016
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_CABLE_STATUS_H_INCLUDED
39 #define OPENAPI_CABLE_STATUS_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 typedef enum
44 {
45  OPEN_CABLE_STATUS_UNTESTED = 0,
46  OPEN_CABLE_STATUS_TEST_FAIL = 1,
47  OPEN_CABLE_STATUS_NORMAL = 2,
48  OPEN_CABLE_STATUS_OPEN = 3,
49  OPEN_CABLE_STATUS_SHORT = 4,
50  OPEN_CABLE_STATUS_OPENSHORT = 5,
51  OPEN_CABLE_STATUS_CROSSTALK = 6,
52  OPEN_CABLE_STATUS_NOCABLE = 7,
54 } OPEN_CABLE_STATUS_t;
55 
56 /******************************************************************************/
81 open_error_t openapiCableStatusGet(openapiClientHandle_t *client_handle, uint32_t ifNum,
82  OPEN_CABLE_STATUS_t *cableStatus, uint32_t *lengthKnown,
83  uint32_t *shortestLength, uint32_t *longestLength,
84  uint32_t *cableFailureLength);
85 
86 #endif /* OPENAPI_CABLE_STATUS_H_INCLUDED */
87