Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
openapi_poe.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_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 
45 #define OPEN_MAX_POE_CARD_INFO_BUF_SIZE 128
46 
48 typedef enum
49 {
50  OPEN_POE_TYPE_POE = 1,
51  OPEN_POE_TYPE_POE_PLUS = 2,
52  OPEN_POE_TYPE_PSE = 3,
53  OPEN_POE_TYPE_PSE_PLUS = 4,
54  OPEN_POE_TYPE_PD = 5,
55  OPEN_POE_TYPE_PD_PLUS = 6,
56  OPEN_POE_TYPE_UPOE = 7
57 } OPEN_POE_TYPE_t;
58 
60 typedef enum
61 {
62  OPEN_POE_PORT_POWER_INVALID = 0,
63  OPEN_POE_PORT_POWER_CLASS0 = 1,
64  OPEN_POE_PORT_POWER_CLASS1 = 2,
65  OPEN_POE_PORT_POWER_CLASS2 = 3,
66  OPEN_POE_PORT_POWER_CLASS3 = 4,
67  OPEN_POE_PORT_POWER_CLASS4 = 5
69 } OPEN_POE_PORT_POWER_CLASS_t;
70 
72 typedef enum
73 {
74  OPEN_POE_PORT_DETECTION_STATUS_INVALID = -1,
75  OPEN_POE_PORT_DETECTION_STATUS_DISABLED = 0,
76  OPEN_POE_PORT_DETECTION_STATUS_SEARCHING = 1,
77  OPEN_POE_PORT_DETECTION_STATUS_DELIVERING_POWER = 2,
78  OPEN_POE_PORT_DETECTION_STATUS_TEST = 3,
79  OPEN_POE_PORT_DETECTION_STATUS_FAULT = 4,
80  OPEN_POE_PORT_DETECTION_STATUS_OTHER_FAULT = 5,
81  OPEN_POE_PORT_DETECTION_STATUS_REQUESTING_POWER = 6,
82  OPEN_POE_PORT_DETECTION_STATUS_OVERLOAD = 7
83 } OPEN_POE_PORT_DETECTION_STATUS_t;
84 
86 typedef enum
87 {
88  OPEN_POE_PORT_FAULT_STATUS_NONE = 0xFF,
89  OPEN_POE_PORT_FAULT_STATUS_OVLO = 0,
90  OPEN_POE_PORT_FAULT_STATUS_MPS_ABSENT = 1,
91  OPEN_POE_PORT_FAULT_STATUS_SHORT = 2,
92  OPEN_POE_PORT_FAULT_STATUS_OVERLOAD = 3,
93  OPEN_POE_PORT_FAULT_STATUS_POWER_DENIED = 4,
94  OPEN_POE_PORT_FAULT_STATUS_THERMAL_SHUTDOWN = 5,
95  OPEN_POE_PORT_FAULT_STATUS_STARTUP_FAILURE = 6,
96  OPEN_POE_PORT_FAULT_STATUS_UVLO = 7
97 } OPEN_POE_PORT_FAULT_STATUS_t;
98 
100 typedef enum
101 {
102  OPEN_POE_SYSTEM_OPER_STATUS_ON = 1,
103  OPEN_POE_SYSTEM_OPER_STATUS_OFF = 2,
104  OPEN_POE_SYSTEM_OPER_STATUS_FAULTY = 3
105 } OPEN_POE_SYSTEM_OPER_STATUS_t;
106 
108 typedef enum
109 {
110  OPEN_POE_DETECTION_INVALID = 0,
111  OPEN_POE_DETECTION_LEGACY = 1,
112  OPEN_POE_DETECTION_4PT_DOT3AF = 2,
113  OPEN_POE_DETECTION_4PT_DOT3AF_LEG = 3,
114  OPEN_POE_DETECTION_2PT_DOT3AF = 4,
115  OPEN_POE_DETECTION_2PT_DOT3AF_LEG = 5,
116  OPEN_POE_DETECTION_NONE = 6,
118  OPEN_POE_DETECTION_COUNT = 7
119 } OPEN_POE_DETECTION_t;
120 
121 typedef enum
122 {
123  OPEN_POE_PRIORITY_INVALID = 0,
124  OPEN_POE_PRIORITY_LOW = 1,
125  OPEN_POE_PRIORITY_MEDIUM = 2,
126  OPEN_POE_PRIORITY_HIGH = 3,
127  OPEN_POE_PRIORITY_CRITICAL = 4,
129  OPEN_POE_PRIORITY_COUNT = 5
130 } OPEN_POE_PRIORITY_t;
131 
132 typedef enum
133 {
134  OPEN_POE_POWER_UP_MODE_INVALID =-1,
135  OPEN_POE_POWER_UP_MODE_8023AF = 0,
136  OPEN_POE_POWER_UP_MODE_HIGH_INRUSH = 1,
137  OPEN_POE_POWER_UP_MODE_PRE_8023AT = 2,
138  OPEN_POE_POWER_UP_MODE_8023AT = 3,
139  OPEN_POE_POWER_UP_MODE_UPOE = 4,
141  OPEN_POE_POWER_UP_MODE_COUNT = 5
142 } OPEN_POE_POWER_UP_MODE_t;
143 
144 typedef enum
145 {
146  OPEN_POE_LIMIT_TYPE_INVALID = 0,
147  OPEN_POE_LIMIT_TYPE_DOT3AF = 1,
148  OPEN_POE_LIMIT_TYPE_USER = 2,
149  OPEN_POE_LIMIT_TYPE_NONE = 3,
151  OPEN_POE_LIMIT_TYPE_COUNT = 4
152 } OPEN_POE_LIMIT_TYPE_t;
153 
154 
156 typedef enum
157 {
158  OPEN_POE_POWER_MGMT_INVALID = 0,
159  OPEN_POE_POWER_MGMT_STATIC = 1,
160  OPEN_POE_POWER_MGMT_DYNAMIC = 2,
161  OPEN_POE_POWER_MGMT_STATIC_PRI = 3,
162  OPEN_POE_POWER_MGMT_DYNAMIC_PRI = 4,
163  OPEN_POE_POWER_MGMT_CLASS = 5,
164 } OPEN_POE_POWER_MGMT_t;
165 
166 
167 /*****************************************************************/
182 open_error_t openapiPoeFirstInterfaceGet(openapiClientHandle_t *client_handle,
183  OPEN_POE_TYPE_t poeType, uint32_t unit,
184  uint32_t *ifNum);
185 
186 /*****************************************************************/
199 open_error_t openapiPoeIsSupported(openapiClientHandle_t *client_handle,
200  uint32_t unit, OPEN_BOOL_t *isSupported);
201 
202 /*****************************************************************/
216 open_error_t openapiPoeIsValidInterface(openapiClientHandle_t *client_handle,
217  OPEN_POE_TYPE_t poeType, uint32_t ifNum,
218  OPEN_BOOL_t *isValid);
219 
220 /*****************************************************************/
236 open_error_t openapiPoePsePortAdminEnableGet(openapiClientHandle_t *client_handle,
237  uint32_t ifNum, OPEN_CONTROL_t *adminMode);
238 
239 /*****************************************************************/
255 open_error_t openapiPoePsePortAdminEnableSet(openapiClientHandle_t *client_handle,
256  uint32_t ifNum, OPEN_CONTROL_t adminMode);
257 
258 /*****************************************************************/
275 open_error_t openapiPoePsePortPowerClassificationsGet(openapiClientHandle_t *client_handle,
276  uint32_t unit, uint32_t ifNum,
277  uint32_t *powerClass);
278 
279 /*****************************************************************/
298 open_error_t openapiPoePsePortSensorsGet(openapiClientHandle_t *client_handle,
299  uint32_t unit, uint32_t ifNum, uint32_t *power,
300  uint32_t *current, uint32_t *voltage, uint32_t *temperature);
301 
302 /*****************************************************************/
323 open_error_t openapiPoePsePortDetectionStatusGet(openapiClientHandle_t *client_handle,
324  uint32_t unit, uint32_t ifNum,
325  uint32_t *detectionStatus);
326 
327 /*****************************************************************/
341 open_error_t openapiPoePsePortErrorCodeGet(openapiClientHandle_t *client_handle,
342  uint32_t ifNum, uint32_t *errorCode);
343 
344 /*****************************************************************/
362 open_error_t openapiPoePsePortCountersGet(openapiClientHandle_t *client_handle,
363  uint32_t ifNum, uint32_t *mpsAbsentCtr,
364  uint32_t *invalidSignatureCtr, uint32_t *powerDeniedCtr,
365  uint32_t *overloadCtr, uint32_t *shortCtr);
366 
367 /*****************************************************************/
387 open_error_t openapiPoePseMainPowerMgmtModeGet(openapiClientHandle_t *client_handle,
388  uint32_t unit,
389  OPEN_POE_POWER_MGMT_t *mode);
390 
391 
392 /*****************************************************************/
408 open_error_t openapiPoePseMainPowerMgmtModeSet(openapiClientHandle_t *client_handle,
409  uint32_t unit,
410  OPEN_POE_POWER_MGMT_t mode);
411 
412 /*****************************************************************/
428 open_error_t openapiPoeFindMaxPowerLimit(openapiClientHandle_t *client_handle,
429  uint32_t unit, uint32_t ifNum,
430  uint32_t *maxPowerLimit);
431 
432 /*****************************************************************/
445 open_error_t openapiPoePseMainDetectionModeGet(openapiClientHandle_t *client_handle,
446  uint32_t unit, OPEN_POE_DETECTION_t *detectionMode);
447 
448 /*****************************************************************/
461 open_error_t openapiPoePseMainDetectionModeSet(openapiClientHandle_t *client_handle,
462  uint32_t unit, OPEN_POE_DETECTION_t detectionMode);
463 
464 /*****************************************************************/
479 open_error_t openapiPoePsePortCurPowerLimitGet(openapiClientHandle_t *client_handle,
480  uint32_t unit, uint32_t ifNum,
481  uint32_t *powerLimit);
482 
483 /*****************************************************************/
500 open_error_t openapiPoePsePortCurPowerLimitSet(openapiClientHandle_t *client_handle,
501  uint32_t unit, uint32_t ifNum,
502  uint32_t powerLimit);
503 
504 /*****************************************************************/
519 open_error_t openapiPoePsePortCurPowerPriorityGet(openapiClientHandle_t *client_handle,
520  uint32_t unit, uint32_t ifNum,
521  OPEN_POE_PRIORITY_t *powerPriority);
522 
523 /*****************************************************************/
538 open_error_t openapiPoePsePortCurPowerPrioritySet(openapiClientHandle_t *client_handle,
539  uint32_t unit, uint32_t ifNum,
540  OPEN_POE_PRIORITY_t powerPriority);
541 
542 /*****************************************************************/
558 open_error_t openapiPoePsePortDetectionModeGet(openapiClientHandle_t *client_handle,
559  uint32_t unit, uint32_t ifNum,
560  OPEN_POE_DETECTION_t *detectionMode);
561 
562 /*****************************************************************/
578 open_error_t openapiPoePsePortDetectionModeSet(openapiClientHandle_t *client_handle,
579  uint32_t unit, uint32_t ifNum,
580  OPEN_POE_DETECTION_t detectionMode);
581 
582 /*****************************************************************/
598 open_error_t openapiPoePsePortHighPowerModeGet(openapiClientHandle_t *client_handle,
599  uint32_t unit, uint32_t ifNum,
600  OPEN_CONTROL_t *highPowerMode);
601 
602 /*****************************************************************/
618 open_error_t openapiPoePsePortHighPowerModeSet(openapiClientHandle_t *client_handle,
619  uint32_t unit, uint32_t ifNum,
620  OPEN_CONTROL_t highPowerMode);
621 
622 /*****************************************************************/
638 open_error_t openapiPoePsePortPowerUpModeGet(openapiClientHandle_t *client_handle,
639  uint32_t unit, uint32_t ifNum,
640  OPEN_POE_POWER_UP_MODE_t *powerUpMode);
641 
642 /*****************************************************************/
658 open_error_t openapiPoePsePortPowerUpModeSet(openapiClientHandle_t *client_handle,
659  uint32_t unit, uint32_t ifNum,
660  OPEN_POE_POWER_UP_MODE_t powerUpMode);
661 
662 /*****************************************************************/
678 open_error_t openapiPoePsePortViolationTypeGet(openapiClientHandle_t *client_handle,
679  uint32_t unit, uint32_t ifNum,
680  OPEN_POE_LIMIT_TYPE_t *violationType);
681 
682 /*****************************************************************/
698 open_error_t openapiPoePsePortViolationTypeSet(openapiClientHandle_t *client_handle,
699  uint32_t unit, uint32_t ifNum,
700  OPEN_POE_LIMIT_TYPE_t violationType);
701 
702 /*****************************************************************/
715 open_error_t openapiPoePseMainUsageThresholdGet(openapiClientHandle_t *client_handle,
716  uint32_t unit, uint32_t *threshold);
717 
718 /*****************************************************************/
733 open_error_t openapiPoePseMainUsageThresholdSet(openapiClientHandle_t *client_handle,
734  uint32_t unit, uint32_t threshold);
735 
736 /*****************************************************************/
750 open_error_t openapiPoePseMainConsumptionPowerGet(openapiClientHandle_t *client_handle,
751  uint32_t unit,
752  uint32_t *power);
753 
754 /*****************************************************************/
770 open_error_t openapiPoeFWImageVersionGet(openapiClientHandle_t *client_handle,
771  uint32_t unit, open_buffdesc *version);
772 
773 /*****************************************************************/
787 open_error_t openapiPoePseMainOperStatusGet(openapiClientHandle_t *client_handle,
788  uint32_t unit,
789  OPEN_POE_SYSTEM_OPER_STATUS_t *status);
790 
791 /*****************************************************************/
807 open_error_t openapiPoePseThresholdPowerGet(openapiClientHandle_t *client_handle,
808  uint32_t unit,
809  uint32_t *power);
810 
811 /*****************************************************************/
827 open_error_t openapiPoePseTotalAvailablePowerGet(openapiClientHandle_t *client_handle,
828  uint32_t unit,
829  uint32_t *power);
830 
831 /*****************************************************************/
845 open_error_t openapiPoeTrapModeGet(openapiClientHandle_t *client_handle,
846  uint32_t unit, OPEN_CONTROL_t *enabled);
847 #endif
848