38 #ifndef OPENAPI_POE_H_INCLUDED
39 #define OPENAPI_POE_H_INCLUDED
43 #define OPEN_POE_PORT_LIMIT_DOT3AF 15400
44 #define OPEN_TIMERANGE_NAME_LEN_MAX 32
46 #define OPEN_MAX_POE_CARD_INFO_BUF_SIZE 128
47 #define OPEN_MAX_POE_TIMER_NAME_BUF_LEN 32
278 uint32_t unit, uint32_t ifNum,
279 uint32_t *powerClass);
301 uint32_t unit, uint32_t ifNum, uint32_t *power,
302 uint32_t *current, uint32_t *voltage, uint32_t *temperature);
326 uint32_t unit, uint32_t ifNum,
327 uint32_t *detectionStatus);
344 uint32_t ifNum, uint32_t *errorCode);
365 uint32_t ifNum, uint32_t *mpsAbsentCtr,
366 uint32_t *invalidSignatureCtr, uint32_t *powerDeniedCtr,
367 uint32_t *overloadCtr, uint32_t *shortCtr);
431 uint32_t unit, uint32_t ifNum,
432 uint32_t *maxPowerLimit);
482 uint32_t unit, uint32_t ifNum,
483 uint32_t *powerLimit);
503 uint32_t unit, uint32_t ifNum,
504 uint32_t powerLimit);
522 uint32_t unit, uint32_t ifNum,
541 uint32_t unit, uint32_t ifNum,
561 uint32_t unit, uint32_t ifNum,
581 uint32_t unit, uint32_t ifNum,
601 uint32_t unit, uint32_t ifNum,
621 uint32_t unit, uint32_t ifNum,
641 uint32_t unit, uint32_t ifNum,
661 uint32_t unit, uint32_t ifNum,
681 uint32_t unit, uint32_t ifNum,
701 uint32_t unit, uint32_t ifNum,
718 uint32_t unit, uint32_t *threshold);
736 uint32_t unit, uint32_t threshold);
868 uint32_t unit, uint32_t ifNum,
890 uint32_t unit, uint32_t ifNum,
908 uint32_t unit, uint32_t ifNum);
995 uint32_t unit, uint32_t powerLimit);
1030 uint32_t unit, uint32_t ifNum,
Static with Port Priority.
open_error_t openapiPoePsePortHighPowerModeSet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_CONTROL_t highPowerMode)
Sets interface ability to provide POE high power.
OPEN_POE_SYSTEM_OPER_STATUS_t
PoE main operational status code.
open_error_t openapiPoePseMainDetectionModeGet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_POE_DETECTION_t *detectionMode)
Gets detection mode of a given unit.
open_error_t openapiPoePsePortSensorsGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, uint32_t *power, uint32_t *current, uint32_t *voltage, uint32_t *temperature)
Gets Interface port output power, current(milliamp), voltage drawn by device and temperature(degree c...
open_error_t openapiPoeFirstInterfaceGet(openapiClientHandle_t *client_handle, OPEN_POE_TYPE_t poeType, uint32_t unit, uint32_t *ifNum)
Get the PoE first interface number.
open_error_t openapiPoePsePortPowerUpModeGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_POWER_UP_MODE_t *powerUpMode)
Gets interface ability of power up.
open_error_t openapiPoePsePortDetectionStatusGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, uint32_t *detectionStatus)
Gets operational status of the port PD detection.
Uses 802.3af inrush , switch to 802.3at inrush immediately with out LLDP.
OPEN_POE_PORT_DETECTION_STATUS_t
PoE port detection status.
open_error_t openapiPoePsePortAdminEnableSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t adminMode)
Sets an interface's POE administrative mode.
OPEN_POE_DETECTION_t
PoE detection mode.
Dynamic with Port Priority.
open_error_t
OPEN uses these enumerators to indicate the error codes.
open_error_t openapiPoePsePortDetectionModeSet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_DETECTION_t detectionMode)
Sets port detection mode on a given interface.
open_error_t openapiPoePseMainConsumptionPowerGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *power)
Get the total power consumed for a unit.
open_error_t openapiPoePsePortHighPowerModeGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_CONTROL_t *highPowerMode)
Gets interface ability to provide POE high power.
open_error_t openapiPoePsePortHighPowerGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_CONTROL_t *highPower)
Gets interface ability to provide POE high power.
open_error_t openapiPoePsePortCountersGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *mpsAbsentCtr, uint32_t *invalidSignatureCtr, uint32_t *powerDeniedCtr, uint32_t *overloadCtr, uint32_t *shortCtr)
Gets all counters of PSE state machine.
open_error_t openapiPoePsePortViolationTypeGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_LIMIT_TYPE_t *violationType)
Gets violation type of a given interface.
open_error_t openapiPoePsePortReset(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum)
Reset PoE on a given interface.
open_error_t openapiPoePsePortCurPowerLimitSet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, uint32_t powerLimit)
Sets the current watt limit the PSE can deliver to a port.
open_error_t openapiPoePsePortDetectionModeGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_DETECTION_t *detectionMode)
Gets port detection mode of a given interface.
OPEN_POE_PORT_POWER_CLASS_t
PoE port power class.
open_error_t openapiPoePseMainPowerMgmtModeSet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_POE_POWER_MGMT_t mode)
Set the power management mode of the unit.
open_error_t openapiPoePseMainReset(openapiClientHandle_t *client_handle, uint32_t unit)
Reset PoE on all interfaces.
open_error_t openapiPoePsePortPowerUpModeSet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_POWER_UP_MODE_t powerUpMode)
Sets interface ability of power up.
open_error_t openapiPoePseThresholdPowerGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *power)
Obtain threshold power.
open_error_t openapiPoeFWImageVersionGet(openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *version)
Obtain POE Firmware Version.
open_error_t openapiPoePsePortCurPowerLimitGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, uint32_t *powerLimit)
Gets the current watt limit the PSE can deliver to a port.
open_error_t openapiPoePseMainUsageThresholdGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *threshold)
Gets usage threshold in percent.
open_error_t openapiPoePsePortCurPowerPrioritySet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_PRIORITY_t powerPriority)
Sets interface port priority value used in management algorithm.
open_error_t openapiPoeTrapModeGet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_CONTROL_t *enabled)
Determine if POE Trap Mode is enabled.
open_error_t openapiPoeIsValidInterface(openapiClientHandle_t *client_handle, OPEN_POE_TYPE_t poeType, uint32_t ifNum, OPEN_BOOL_t *isValid)
Determine if the interface is capable of supporting PoE.
open_error_t openapiPoeTrapModeSet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_CONTROL_t enabled)
Sets POE Trap Mode.
open_error_t openapiPoePsePortPowerClassificationsGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, uint32_t *powerClass)
Gets interface port terminal classification, eg.
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
open_error_t openapiPoeIsSupported(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_BOOL_t *isSupported)
Check to see if PoE is supported on this platform.
open_error_t openapiPoePsePortAdminEnableGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *adminMode)
Gets an interface's POE administrative mode.
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
open_error_t openapiPoePsePortTimerScheduleNameGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, open_buffdesc *timerName)
Get timer schedule name for a given interface.
open_error_t openapiPoePseMainCurPowerPrioritySet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_POE_PRIORITY_t powerPriority)
Sets port priority value used in management algorithm on all interfaces.
open_error_t openapiPoePethPsePortTimerCtrlClear(openapiClientHandle_t *client_handle, uint32_t ifNum)
Clear timer schedule association for the port.
open_error_t openapiPoePseMainCurPowerLimitSet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t powerLimit)
Sets the current watt limit the PSE can deliver on all interfaces.
OPEN_POE_TYPE_t
PoE types.
open_error_t openapiPoePseMainDetectionModeSet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_POE_DETECTION_t detectionMode)
Sets detection mode of a given unit.
open_error_t openapiPoePseTotalAvailablePowerGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *power)
Obtain total available power.
open_error_t openapiPoePseMainUsageThresholdSet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t threshold)
Sets usage threshold in percent.
open_error_t openapiPoePseMainPowerMgmtModeGet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_POE_POWER_MGMT_t *mode)
Get the power management mode of the unit.
open_error_t openapiPoePsePortTimerScheduleNameSet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, open_buffdesc *timerName)
Sets the timer schedule name for a given interface.
open_error_t openapiPoePsePortErrorCodeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *errorCode)
Gets Interface port error code.
open_error_t openapiPoeFindMaxPowerLimit(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, uint32_t *maxPowerLimit)
Find max power limit based on PoE/PoE+/UPoE for given unit and interface number.
Legacy PD's requiring high inrush current > 400mA.
open_error_t openapiPoePseMainAdminEnableSet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_CONTROL_t adminMode)
Sets global POE administrative mode .
open_error_t openapiPoePsePortCurPowerPriorityGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_PRIORITY_t *powerPriority)
Gets interface port priority value used in management algorithm.
OPEN_POE_PORT_FAULT_STATUS_t
PoE port error code.
open_error_t openapiPoePsePortViolationTypeSet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_LIMIT_TYPE_t violationType)
Sets violation type on a given interface.
OPEN_POE_POWER_MGMT_t
PoE Mgmt Mode.
Dynamic without Port Priority.
open_error_t openapiPoePseMainOperStatusGet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_POE_SYSTEM_OPER_STATUS_t *status)
Obtain PSE Main Operational Status.
Static without Port Priority.