Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.13.1.2
openapi_green_ethernet.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2023 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_green_ethernet.h
28 *
29 * @purpose Green Ethernet API
30 *
31 * @component OpEN
32 *
33 * @create 05/31/2023
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_GREEN_ETHERNET_H
39 #define OPENAPI_GREEN_ETHERNET_H
40 
41 typedef enum
42 {
43  OPEN_GREENETHR_ADMIN_DOWN,
44  OPEN_GREENETHR_FIBER_PORT,
45  OPEN_GREENETHR_LINK_UP,
46  OPEN_GREENETHR_LINK_DOWN,
47  OPEN_GREENETHR_LONG_CABLE,
48  OPEN_GREENETHR_SHORT_CABLE,
49  OPEN_GREENETHR_UNKWN_CABLE_LEN,
50  OPEN_GREENETHR_NO_ENERGY,
51  OPEN_GREENETHR_FORCED,
52  OPEN_GREENETHR_NOT1GIG,
53  OPEN_GREENETHR_NOT_ATTACHED,
54  OPEN_GREENETHR_INVALID_VAL,
55 } OPEN_GREEN_ETH_OPER_STATUS_t;
56 
57 
58 /*****************************************************************/
72 open_error_t openapiGreenEthrValidIntfFirstGet(openapiClientHandle_t *client_handle,
73  uint32_t *intIfNum);
74 
75 /*****************************************************************/
90 open_error_t openapiGreenEthrValidIntfNextGet(openapiClientHandle_t *client_handle,
91  uint32_t prevIfNum,
92  uint32_t *intIfNum);
93 
94 /*****************************************************************/
109 open_error_t openapiGreenEthrIsValidIntfType(openapiClientHandle_t *client_handle,
110  uint32_t intIfNum,
111  OPEN_BOOL_t *valid);
112 
113 /*****************************************************************/
128 open_error_t openapiGreenEthrIsIntfEEECapable(openapiClientHandle_t *client_handle,
129  uint32_t intIfNum,
130  OPEN_BOOL_t *valid);
131 
132 /*****************************************************************/
148 open_error_t openapiGreenEthrEnergyDetectModeSet(openapiClientHandle_t *client_handle,
149  uint32_t intIfNum,
150  OPEN_CONTROL_t mode);
151 
152 /*****************************************************************/
168 open_error_t openapiGreenEthrShrtRchAutoModeSet(openapiClientHandle_t *client_handle,
169  uint32_t intIfNum,
170  OPEN_BOOL_t mode);
171 
172 /*****************************************************************/
188 open_error_t openapiGreenEthrShrtRchForceModeSet(openapiClientHandle_t *client_handle,
189  uint32_t intIfNum,
190  OPEN_BOOL_t mode);
191 
192 /*****************************************************************/
208 open_error_t openapiGreenEthrEnergyDetectAdminModeGet(openapiClientHandle_t *client_handle,
209  uint32_t intIfNum,
210  OPEN_CONTROL_t *mode);
211 
212 /*****************************************************************/
228 open_error_t openapiGreenEthrShrtRchAutoAdminModeGet(openapiClientHandle_t *client_handle,
229  uint32_t intIfNum,
230  OPEN_BOOL_t *mode);
231 
232 /*****************************************************************/
248 open_error_t openapiGreenEthrShrtRchForceAdminModeGet(openapiClientHandle_t *client_handle,
249  uint32_t intIfNum,
250  OPEN_BOOL_t *mode);
251 
252 /*****************************************************************/
269 open_error_t openapiGreenEthrEnergyDetectOprStatusGet(openapiClientHandle_t *client_handle,
270  uint32_t intIfNum,
271  OPEN_BOOL_t *oprStatus,
272  OPEN_GREEN_ETH_OPER_STATUS_t *reason);
273 
274 /*****************************************************************/
291 open_error_t openapiGreenEthrShrtRchOprStatusGet(openapiClientHandle_t *client_handle,
292  uint32_t intIfNum,
293  OPEN_BOOL_t *oprStatus,
294  OPEN_GREEN_ETH_OPER_STATUS_t *reason);
295 
296 /*****************************************************************/
313 open_error_t openapiGreenEthrEnergyDetectOprStatusStrGet(openapiClientHandle_t *client_handle,
314  uint32_t intIfNum,
315  OPEN_BOOL_t *oprStatus,
316  open_buffdesc *reasonStr);
317 
318 /*****************************************************************/
335 open_error_t openapiGreenEthrShrtRchOprStatusStrGet(openapiClientHandle_t *client_handle,
336  uint32_t intIfNum,
337  OPEN_BOOL_t *oprStatus,
338  open_buffdesc *bufd);
339 
340 /*****************************************************************/
355 open_error_t openapiGreenEthrGlobalEnergyDetectModeGet(openapiClientHandle_t *client_handle,
356  OPEN_CONTROL_t *adminMode);
357 
358 /*****************************************************************/
373 open_error_t openapiGreenEthrGlobalEnergyDetectModeSet(openapiClientHandle_t *client_handle,
374  OPEN_CONTROL_t adminMode);
375 
376 /*****************************************************************/
391 open_error_t openapiGreenEthrGlobalShortReachModeGet(openapiClientHandle_t *client_handle,
392  OPEN_CONTROL_t *adminMode);
393 
394 /*****************************************************************/
409 open_error_t openapiGreenEthrGlobalShortReachModeSet(openapiClientHandle_t *client_handle,
410  OPEN_CONTROL_t adminMode);
411 #endif /* OPENAPI_GREEN_ETHERNET_H */
412 
OPEN_GREENETHR_UNKWN_CABLE_LEN
Unknown cable length.
Definition: openapi_green_ethernet.h:49
OPEN_GREENETHR_NOT1GIG
Not 1 gig.
Definition: openapi_green_ethernet.h:52
OPEN_GREENETHR_ADMIN_DOWN
Admin down.
Definition: openapi_green_ethernet.h:43
openapiGreenEthrEnergyDetectOprStatusGet
open_error_t openapiGreenEthrEnergyDetectOprStatusGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *oprStatus, OPEN_GREEN_ETH_OPER_STATUS_t *reason)
Get the energy-detect operational status and reason.
OPEN_GREENETHR_NOT_ATTACHED
Not attached.
Definition: openapi_green_ethernet.h:53
openapiGreenEthrGlobalShortReachModeSet
open_error_t openapiGreenEthrGlobalShortReachModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
Set the global auto short reach administrative mode.
OPEN_GREENETHR_NO_ENERGY
No energy.
Definition: openapi_green_ethernet.h:50
openapiGreenEthrValidIntfFirstGet
open_error_t openapiGreenEthrValidIntfFirstGet(openapiClientHandle_t *client_handle, uint32_t *intIfNum)
Get the first interface that is valid for green ethernet.
openapiGreenEthrEnergyDetectOprStatusStrGet
open_error_t openapiGreenEthrEnergyDetectOprStatusStrGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *oprStatus, open_buffdesc *reasonStr)
Get the energy-detect operational status and reason.
open_error_t
open_error_t
OPEN uses these enumerators to indicate the error codes.
Definition: openapi_common.h:64
openapiGreenEthrGlobalShortReachModeGet
open_error_t openapiGreenEthrGlobalShortReachModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
Get the global auto short reach administrative mode.
openapiGreenEthrGlobalEnergyDetectModeGet
open_error_t openapiGreenEthrGlobalEnergyDetectModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
Get the global energy detect administrative mode.
OPEN_GREENETHR_LONG_CABLE
Long cable.
Definition: openapi_green_ethernet.h:47
open_buffdesc
Definition: openapi_common.h:138
openapiClientHandle_s
Definition: openapi_common.h:131
OPEN_GREENETHR_FORCED
Forced.
Definition: openapi_green_ethernet.h:51
openapiGreenEthrShrtRchAutoModeSet
open_error_t openapiGreenEthrShrtRchAutoModeSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t mode)
Set the short-reach auto mode.
openapiGreenEthrShrtRchForceAdminModeGet
open_error_t openapiGreenEthrShrtRchForceAdminModeGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *mode)
Get the short-reach force admin mode.
openapiGreenEthrValidIntfNextGet
open_error_t openapiGreenEthrValidIntfNextGet(openapiClientHandle_t *client_handle, uint32_t prevIfNum, uint32_t *intIfNum)
Get the next interface that is valid for green ethernet.
OPEN_CONTROL_t
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
Definition: openapi_common.h:163
OPEN_BOOL_t
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
Definition: openapi_common.h:179
openapiGreenEthrEnergyDetectAdminModeGet
open_error_t openapiGreenEthrEnergyDetectAdminModeGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t *mode)
Get the energy detect admin mode.
OPEN_GREENETHR_LINK_UP
Link up.
Definition: openapi_green_ethernet.h:45
openapiGreenEthrIsValidIntfType
open_error_t openapiGreenEthrIsValidIntfType(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *valid)
Determine if the interface is valid for green ethernet operation.
openapiGreenEthrIsIntfEEECapable
open_error_t openapiGreenEthrIsIntfEEECapable(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *valid)
Determine if the interface is EEE capable.
OPEN_GREENETHR_INVALID_VAL
Invalid val.
Definition: openapi_green_ethernet.h:54
openapiGreenEthrShrtRchOprStatusStrGet
open_error_t openapiGreenEthrShrtRchOprStatusStrGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *oprStatus, open_buffdesc *bufd)
Get the short-reach operational status and reason.
openapiGreenEthrShrtRchForceModeSet
open_error_t openapiGreenEthrShrtRchForceModeSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t mode)
Set the short-reach into force mode.
openapiGreenEthrShrtRchAutoAdminModeGet
open_error_t openapiGreenEthrShrtRchAutoAdminModeGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *mode)
Get the short-reach auto admin mode.
OPEN_GREENETHR_LINK_DOWN
Link down.
Definition: openapi_green_ethernet.h:46
OPEN_GREENETHR_SHORT_CABLE
Short cable.
Definition: openapi_green_ethernet.h:48
openapiGreenEthrGlobalEnergyDetectModeSet
open_error_t openapiGreenEthrGlobalEnergyDetectModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
Set the global energy detect administrative mode.
OPEN_GREENETHR_FIBER_PORT
Fiber port.
Definition: openapi_green_ethernet.h:44
OPEN_GREEN_ETH_OPER_STATUS_t
OPEN_GREEN_ETH_OPER_STATUS_t
Definition: openapi_green_ethernet.h:41
openapiGreenEthrShrtRchOprStatusGet
open_error_t openapiGreenEthrShrtRchOprStatusGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *oprStatus, OPEN_GREEN_ETH_OPER_STATUS_t *reason)
Get the short-reach operational status and reason.
openapiGreenEthrEnergyDetectModeSet
open_error_t openapiGreenEthrEnergyDetectModeSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t mode)
Set the energy-detect mode.