Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_poe.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2019 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_poe.h
28 *
29 * @purpose PoE Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 11/05/2015
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_POE_H_INCLUDED
39 #define OPENAPI_POE_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 #define OPEN_POE_PORT_LIMIT_DOT3AF 15400
44 #define OPEN_TIMERANGE_NAME_LEN_MAX 32
45 
46 #define OPEN_MAX_POE_CARD_INFO_BUF_SIZE 128
47 #define OPEN_MAX_POE_TIMER_NAME_BUF_LEN 32
48 
50 typedef enum
51 {
52  OPEN_POE_TYPE_POE = 1,
53  OPEN_POE_TYPE_POE_PLUS = 2,
54  OPEN_POE_TYPE_PSE = 3,
55  OPEN_POE_TYPE_PSE_PLUS = 4,
56  OPEN_POE_TYPE_PD = 5,
57  OPEN_POE_TYPE_PD_PLUS = 6,
58  OPEN_POE_TYPE_UPOE = 7,
59  OPEN_POE_TYPE_BT = 8
60 } OPEN_POE_TYPE_t;
61 
63 typedef enum
64 {
65  OPEN_POE_PORT_POWER_INVALID = 0,
66  OPEN_POE_PORT_POWER_CLASS0 = 1,
67  OPEN_POE_PORT_POWER_CLASS1 = 2,
68  OPEN_POE_PORT_POWER_CLASS2 = 3,
69  OPEN_POE_PORT_POWER_CLASS3 = 4,
70  OPEN_POE_PORT_POWER_CLASS4 = 5,
71  OPEN_POE_PORT_POWER_CLASS5 = 6,
72  OPEN_POE_PORT_POWER_CLASS6 = 7,
73  OPEN_POE_PORT_POWER_CLASS7 = 8,
74  OPEN_POE_PORT_POWER_CLASS8 = 9
76 } OPEN_POE_PORT_POWER_CLASS_t;
77 
79 typedef enum
80 {
81  OPEN_POE_PORT_DETECTION_STATUS_INVALID = -1,
82  OPEN_POE_PORT_DETECTION_STATUS_DISABLED = 0,
83  OPEN_POE_PORT_DETECTION_STATUS_SEARCHING = 1,
84  OPEN_POE_PORT_DETECTION_STATUS_DELIVERING_POWER = 2,
85  OPEN_POE_PORT_DETECTION_STATUS_TEST = 3,
86  OPEN_POE_PORT_DETECTION_STATUS_FAULT = 4,
87  OPEN_POE_PORT_DETECTION_STATUS_OTHER_FAULT = 5,
88  OPEN_POE_PORT_DETECTION_STATUS_REQUESTING_POWER = 6,
89  OPEN_POE_PORT_DETECTION_STATUS_OVERLOAD = 7
90 } OPEN_POE_PORT_DETECTION_STATUS_t;
91 
93 typedef enum
94 {
95  OPEN_POE_PORT_FAULT_STATUS_NONE = 0xFF,
96  OPEN_POE_PORT_FAULT_STATUS_OVLO = 0,
97  OPEN_POE_PORT_FAULT_STATUS_MPS_ABSENT = 1,
98  OPEN_POE_PORT_FAULT_STATUS_SHORT = 2,
99  OPEN_POE_PORT_FAULT_STATUS_OVERLOAD = 3,
100  OPEN_POE_PORT_FAULT_STATUS_POWER_DENIED = 4,
101  OPEN_POE_PORT_FAULT_STATUS_THERMAL_SHUTDOWN = 5,
102  OPEN_POE_PORT_FAULT_STATUS_STARTUP_FAILURE = 6,
103  OPEN_POE_PORT_FAULT_STATUS_UVLO = 7
104 } OPEN_POE_PORT_FAULT_STATUS_t;
105 
107 typedef enum
108 {
109  OPEN_POE_SYSTEM_OPER_STATUS_ON = 1,
110  OPEN_POE_SYSTEM_OPER_STATUS_OFF = 2,
111  OPEN_POE_SYSTEM_OPER_STATUS_FAULTY = 3
112 } OPEN_POE_SYSTEM_OPER_STATUS_t;
113 
115 typedef enum
116 {
117  OPEN_POE_DETECTION_INVALID = 0,
118  OPEN_POE_DETECTION_LEGACY = 1,
119  OPEN_POE_DETECTION_4PT_DOT3AF = 2,
120  OPEN_POE_DETECTION_4PT_DOT3AF_LEG = 3,
121  OPEN_POE_DETECTION_2PT_DOT3AF = 4,
122  OPEN_POE_DETECTION_2PT_DOT3AF_LEG = 5,
123  OPEN_POE_DETECTION_NONE = 6,
124  OPEN_POE_DETECTION_DOT3BT = 7,
125  OPEN_POE_DETECTION_DOT3BT_LEG = 8,
127  OPEN_POE_DETECTION_COUNT = 9
128 } OPEN_POE_DETECTION_t;
129 
130 typedef enum
131 {
132  OPEN_POE_PRIORITY_INVALID = 0,
133  OPEN_POE_PRIORITY_LOW = 1,
134  OPEN_POE_PRIORITY_MEDIUM = 2,
135  OPEN_POE_PRIORITY_HIGH = 3,
136  OPEN_POE_PRIORITY_CRITICAL = 4,
138  OPEN_POE_PRIORITY_COUNT = 5
139 } OPEN_POE_PRIORITY_t;
140 
141 typedef enum
142 {
143  OPEN_POE_POWER_UP_MODE_INVALID =-1,
144  OPEN_POE_POWER_UP_MODE_8023AF = 0,
145  OPEN_POE_POWER_UP_MODE_HIGH_INRUSH = 1,
146  OPEN_POE_POWER_UP_MODE_PRE_8023AT = 2,
147  OPEN_POE_POWER_UP_MODE_8023AT = 3,
148  OPEN_POE_POWER_UP_MODE_UPOE = 4,
149  OPEN_POE_POWER_UP_MODE_PRE_8023BT = 5,
150  OPEN_POE_POWER_UP_MODE_TYPE3 = 6,
151  OPEN_POE_POWER_UP_MODE_8023BT = 7,
153  OPEN_POE_POWER_UP_MODE_COUNT = 8
154 } OPEN_POE_POWER_UP_MODE_t;
155 
156 typedef enum
157 {
158  OPEN_POE_LIMIT_TYPE_INVALID = 0,
159  OPEN_POE_LIMIT_TYPE_DOT3AF = 1,
160  OPEN_POE_LIMIT_TYPE_USER = 2,
161  OPEN_POE_LIMIT_TYPE_NONE = 3,
163  OPEN_POE_LIMIT_TYPE_COUNT = 4
164 } OPEN_POE_LIMIT_TYPE_t;
165 
166 
168 typedef enum
169 {
170  OPEN_POE_POWER_MGMT_INVALID = 0,
171  OPEN_POE_POWER_MGMT_STATIC = 1,
172  OPEN_POE_POWER_MGMT_DYNAMIC = 2,
173  OPEN_POE_POWER_MGMT_STATIC_PRI = 3,
174  OPEN_POE_POWER_MGMT_DYNAMIC_PRI = 4,
175  OPEN_POE_POWER_MGMT_CLASS = 5,
176 } OPEN_POE_POWER_MGMT_t;
177 
178 
179 /*****************************************************************/
194 open_error_t openapiPoeFirstInterfaceGet(openapiClientHandle_t *client_handle,
195  OPEN_POE_TYPE_t poeType, uint32_t unit,
196  uint32_t *ifNum);
197 
198 /*****************************************************************/
211 open_error_t openapiPoeIsSupported(openapiClientHandle_t *client_handle,
212  uint32_t unit, OPEN_BOOL_t *isSupported);
213 
214 /*****************************************************************/
228 open_error_t openapiPoeIsValidInterface(openapiClientHandle_t *client_handle,
229  OPEN_POE_TYPE_t poeType, uint32_t ifNum,
230  OPEN_BOOL_t *isValid);
231 
232 /*****************************************************************/
248 open_error_t openapiPoePsePortAdminEnableGet(openapiClientHandle_t *client_handle,
249  uint32_t ifNum, OPEN_CONTROL_t *adminMode);
250 
251 /*****************************************************************/
267 open_error_t openapiPoePsePortAdminEnableSet(openapiClientHandle_t *client_handle,
268  uint32_t ifNum, OPEN_CONTROL_t adminMode);
269 
270 /*****************************************************************/
287 open_error_t openapiPoePsePortPowerClassificationsGet(openapiClientHandle_t *client_handle,
288  uint32_t unit, uint32_t ifNum,
289  uint32_t *powerClass);
290 
291 /*****************************************************************/
310 open_error_t openapiPoePsePortSensorsGet(openapiClientHandle_t *client_handle,
311  uint32_t unit, uint32_t ifNum, uint32_t *power,
312  uint32_t *current, uint32_t *voltage, uint32_t *temperature);
313 
314 /*****************************************************************/
335 open_error_t openapiPoePsePortDetectionStatusGet(openapiClientHandle_t *client_handle,
336  uint32_t unit, uint32_t ifNum,
337  uint32_t *detectionStatus);
338 
339 /*****************************************************************/
353 open_error_t openapiPoePsePortErrorCodeGet(openapiClientHandle_t *client_handle,
354  uint32_t ifNum, uint32_t *errorCode);
355 
356 /*****************************************************************/
374 open_error_t openapiPoePsePortCountersGet(openapiClientHandle_t *client_handle,
375  uint32_t ifNum, uint32_t *mpsAbsentCtr,
376  uint32_t *invalidSignatureCtr, uint32_t *powerDeniedCtr,
377  uint32_t *overloadCtr, uint32_t *shortCtr);
378 
379 /*****************************************************************/
399 open_error_t openapiPoePseMainPowerMgmtModeGet(openapiClientHandle_t *client_handle,
400  uint32_t unit,
401  OPEN_POE_POWER_MGMT_t *mode);
402 
403 
404 /*****************************************************************/
420 open_error_t openapiPoePseMainPowerMgmtModeSet(openapiClientHandle_t *client_handle,
421  uint32_t unit,
422  OPEN_POE_POWER_MGMT_t mode);
423 
424 /*****************************************************************/
440 open_error_t openapiPoeFindMaxPowerLimit(openapiClientHandle_t *client_handle,
441  uint32_t unit, uint32_t ifNum,
442  uint32_t *maxPowerLimit);
443 
444 /*****************************************************************/
457 open_error_t openapiPoePseMainDetectionModeGet(openapiClientHandle_t *client_handle,
458  uint32_t unit, OPEN_POE_DETECTION_t *detectionMode);
459 
460 /*****************************************************************/
473 open_error_t openapiPoePseMainDetectionModeSet(openapiClientHandle_t *client_handle,
474  uint32_t unit, OPEN_POE_DETECTION_t detectionMode);
475 
476 /*****************************************************************/
491 open_error_t openapiPoePsePortCurPowerLimitGet(openapiClientHandle_t *client_handle,
492  uint32_t unit, uint32_t ifNum,
493  uint32_t *powerLimit);
494 
495 /*****************************************************************/
512 open_error_t openapiPoePsePortCurPowerLimitSet(openapiClientHandle_t *client_handle,
513  uint32_t unit, uint32_t ifNum,
514  uint32_t powerLimit);
515 
516 /*****************************************************************/
531 open_error_t openapiPoePsePortCurPowerPriorityGet(openapiClientHandle_t *client_handle,
532  uint32_t unit, uint32_t ifNum,
533  OPEN_POE_PRIORITY_t *powerPriority);
534 
535 /*****************************************************************/
550 open_error_t openapiPoePsePortCurPowerPrioritySet(openapiClientHandle_t *client_handle,
551  uint32_t unit, uint32_t ifNum,
552  OPEN_POE_PRIORITY_t powerPriority);
553 
554 /*****************************************************************/
570 open_error_t openapiPoePsePortDetectionModeGet(openapiClientHandle_t *client_handle,
571  uint32_t unit, uint32_t ifNum,
572  OPEN_POE_DETECTION_t *detectionMode);
573 
574 /*****************************************************************/
590 open_error_t openapiPoePsePortDetectionModeSet(openapiClientHandle_t *client_handle,
591  uint32_t unit, uint32_t ifNum,
592  OPEN_POE_DETECTION_t detectionMode);
593 
594 /*****************************************************************/
610 open_error_t openapiPoePsePortHighPowerModeGet(openapiClientHandle_t *client_handle,
611  uint32_t unit, uint32_t ifNum,
612  OPEN_CONTROL_t *highPowerMode);
613 
614 /*****************************************************************/
630 open_error_t openapiPoePsePortHighPowerModeSet(openapiClientHandle_t *client_handle,
631  uint32_t unit, uint32_t ifNum,
632  OPEN_CONTROL_t highPowerMode);
633 
634 /*****************************************************************/
650 open_error_t openapiPoePsePortPowerUpModeGet(openapiClientHandle_t *client_handle,
651  uint32_t unit, uint32_t ifNum,
652  OPEN_POE_POWER_UP_MODE_t *powerUpMode);
653 
654 /*****************************************************************/
670 open_error_t openapiPoePsePortPowerUpModeSet(openapiClientHandle_t *client_handle,
671  uint32_t unit, uint32_t ifNum,
672  OPEN_POE_POWER_UP_MODE_t powerUpMode);
673 
674 /*****************************************************************/
690 open_error_t openapiPoePsePortViolationTypeGet(openapiClientHandle_t *client_handle,
691  uint32_t unit, uint32_t ifNum,
692  OPEN_POE_LIMIT_TYPE_t *violationType);
693 
694 /*****************************************************************/
710 open_error_t openapiPoePsePortViolationTypeSet(openapiClientHandle_t *client_handle,
711  uint32_t unit, uint32_t ifNum,
712  OPEN_POE_LIMIT_TYPE_t violationType);
713 
714 /*****************************************************************/
727 open_error_t openapiPoePseMainUsageThresholdGet(openapiClientHandle_t *client_handle,
728  uint32_t unit, uint32_t *threshold);
729 
730 /*****************************************************************/
745 open_error_t openapiPoePseMainUsageThresholdSet(openapiClientHandle_t *client_handle,
746  uint32_t unit, uint32_t threshold);
747 
748 /*****************************************************************/
762 open_error_t openapiPoePseMainConsumptionPowerGet(openapiClientHandle_t *client_handle,
763  uint32_t unit,
764  uint32_t *power);
765 
766 /*****************************************************************/
782 open_error_t openapiPoeFWImageVersionGet(openapiClientHandle_t *client_handle,
783  uint32_t unit, open_buffdesc *version);
784 
785 /*****************************************************************/
799 open_error_t openapiPoePseMainOperStatusGet(openapiClientHandle_t *client_handle,
800  uint32_t unit,
801  OPEN_POE_SYSTEM_OPER_STATUS_t *status);
802 
803 /*****************************************************************/
819 open_error_t openapiPoePseThresholdPowerGet(openapiClientHandle_t *client_handle,
820  uint32_t unit,
821  uint32_t *power);
822 
823 /*****************************************************************/
839 open_error_t openapiPoePseTotalAvailablePowerGet(openapiClientHandle_t *client_handle,
840  uint32_t unit,
841  uint32_t *power);
842 
843 /*****************************************************************/
857 open_error_t openapiPoeTrapModeGet(openapiClientHandle_t *client_handle,
858  uint32_t unit, OPEN_CONTROL_t *enabled);
859 
860 /*****************************************************************/
877 open_error_t openapiPoePsePortTimerScheduleNameGet(openapiClientHandle_t *client_handle,
878  uint32_t unit, uint32_t ifNum,
879  open_buffdesc *timerName);
880 
881 /*****************************************************************/
899 open_error_t openapiPoePsePortTimerScheduleNameSet(openapiClientHandle_t *client_handle,
900  uint32_t unit, uint32_t ifNum,
901  open_buffdesc *timerName);
902 
903 /*****************************************************************/
917 open_error_t openapiPoePsePortReset(openapiClientHandle_t *client_handle,
918  uint32_t unit, uint32_t ifNum);
919 
920 /*****************************************************************/
933 open_error_t openapiPoePseMainReset(openapiClientHandle_t *client_handle,
934  uint32_t unit);
935 
936 /*****************************************************************/
950 open_error_t openapiPoePseMainAdminEnableSet(openapiClientHandle_t *client_handle,
951  uint32_t unit, OPEN_CONTROL_t adminMode);
952 
953 /*****************************************************************/
967 open_error_t openapiPoeTrapModeSet(openapiClientHandle_t *client_handle,
968  uint32_t unit, OPEN_CONTROL_t enabled);
969 
970 /*****************************************************************/
985 open_error_t openapiPoePseMainCurPowerPrioritySet(openapiClientHandle_t *client_handle,
986  uint32_t unit, OPEN_POE_PRIORITY_t powerPriority);
987 
988 /*****************************************************************/
1004 open_error_t openapiPoePseMainCurPowerLimitSet(openapiClientHandle_t *client_handle,
1005  uint32_t unit, uint32_t powerLimit);
1006 
1007 /*****************************************************************/
1021 open_error_t openapiPoePethPsePortTimerCtrlClear(openapiClientHandle_t *client_handle,
1022  uint32_t ifNum);
1023 
1024 /*****************************************************************/
1039 open_error_t openapiPoePsePortHighPowerGet(openapiClientHandle_t *client_handle,
1040  uint32_t unit, uint32_t ifNum,
1041  OPEN_CONTROL_t *highPower);
1042 
1043 #endif
1044