Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
Macros | Enumerations | Functions
openapi_poe.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Macros

#define OPEN_MAX_POE_CARD_INFO_BUF_SIZE   128
 
#define OPEN_MAX_POE_TIMER_NAME_BUF_LEN   32
 
#define OPEN_POE_PORT_LIMIT_DOT3AF   15400
 
#define OPEN_TIMERANGE_NAME_LEN_MAX   32
 

Enumerations

enum  OPEN_POE_DETECTION_t {
  OPEN_POE_DETECTION_INVALID = 0, OPEN_POE_DETECTION_LEGACY = 1, OPEN_POE_DETECTION_4PT_DOT3AF = 2, OPEN_POE_DETECTION_4PT_DOT3AF_LEG = 3,
  OPEN_POE_DETECTION_2PT_DOT3AF = 4, OPEN_POE_DETECTION_2PT_DOT3AF_LEG = 5, OPEN_POE_DETECTION_NONE = 6, OPEN_POE_DETECTION_DOT3BT = 7,
  OPEN_POE_DETECTION_DOT3BT_LEG = 8, OPEN_POE_DETECTION_COUNT = 9
}
 PoE detection mode. More...
 
enum  OPEN_POE_LIMIT_TYPE_t {
  OPEN_POE_LIMIT_TYPE_INVALID = 0, OPEN_POE_LIMIT_TYPE_DOT3AF = 1, OPEN_POE_LIMIT_TYPE_USER = 2, OPEN_POE_LIMIT_TYPE_NONE = 3,
  OPEN_POE_LIMIT_TYPE_COUNT = 4
}
 
enum  OPEN_POE_PORT_DETECTION_STATUS_t {
  OPEN_POE_PORT_DETECTION_STATUS_INVALID = -1, OPEN_POE_PORT_DETECTION_STATUS_DISABLED = 0, OPEN_POE_PORT_DETECTION_STATUS_SEARCHING = 1, OPEN_POE_PORT_DETECTION_STATUS_DELIVERING_POWER = 2,
  OPEN_POE_PORT_DETECTION_STATUS_TEST = 3, OPEN_POE_PORT_DETECTION_STATUS_FAULT = 4, OPEN_POE_PORT_DETECTION_STATUS_OTHER_FAULT = 5, OPEN_POE_PORT_DETECTION_STATUS_REQUESTING_POWER = 6,
  OPEN_POE_PORT_DETECTION_STATUS_OVERLOAD = 7
}
 PoE port detection status. More...
 
enum  OPEN_POE_PORT_FAULT_STATUS_t {
  OPEN_POE_PORT_FAULT_STATUS_NONE = 0xFF, OPEN_POE_PORT_FAULT_STATUS_OVLO = 0, OPEN_POE_PORT_FAULT_STATUS_MPS_ABSENT = 1, OPEN_POE_PORT_FAULT_STATUS_SHORT = 2,
  OPEN_POE_PORT_FAULT_STATUS_OVERLOAD = 3, OPEN_POE_PORT_FAULT_STATUS_POWER_DENIED = 4, OPEN_POE_PORT_FAULT_STATUS_THERMAL_SHUTDOWN = 5, OPEN_POE_PORT_FAULT_STATUS_STARTUP_FAILURE = 6,
  OPEN_POE_PORT_FAULT_STATUS_UVLO = 7
}
 PoE port error code. More...
 
enum  OPEN_POE_PORT_POWER_CLASS_t {
  OPEN_POE_PORT_POWER_INVALID = 0, OPEN_POE_PORT_POWER_CLASS0 = 1, OPEN_POE_PORT_POWER_CLASS1 = 2, OPEN_POE_PORT_POWER_CLASS2 = 3,
  OPEN_POE_PORT_POWER_CLASS3 = 4, OPEN_POE_PORT_POWER_CLASS4 = 5, OPEN_POE_PORT_POWER_CLASS5 = 6, OPEN_POE_PORT_POWER_CLASS6 = 7,
  OPEN_POE_PORT_POWER_CLASS7 = 8, OPEN_POE_PORT_POWER_CLASS8 = 9
}
 PoE port power class. More...
 
enum  OPEN_POE_POWER_MGMT_t {
  OPEN_POE_POWER_MGMT_INVALID = 0, OPEN_POE_POWER_MGMT_STATIC = 1, OPEN_POE_POWER_MGMT_DYNAMIC = 2, OPEN_POE_POWER_MGMT_STATIC_PRI = 3,
  OPEN_POE_POWER_MGMT_DYNAMIC_PRI = 4, OPEN_POE_POWER_MGMT_CLASS = 5
}
 PoE Mgmt Mode. More...
 
enum  OPEN_POE_POWER_UP_MODE_t {
  OPEN_POE_POWER_UP_MODE_INVALID =-1, OPEN_POE_POWER_UP_MODE_8023AF = 0, OPEN_POE_POWER_UP_MODE_HIGH_INRUSH = 1, OPEN_POE_POWER_UP_MODE_PRE_8023AT = 2,
  OPEN_POE_POWER_UP_MODE_8023AT = 3, OPEN_POE_POWER_UP_MODE_UPOE = 4, OPEN_POE_POWER_UP_MODE_PRE_8023BT = 5, OPEN_POE_POWER_UP_MODE_TYPE3 = 6,
  OPEN_POE_POWER_UP_MODE_8023BT = 7, OPEN_POE_POWER_UP_MODE_COUNT = 8
}
 
enum  OPEN_POE_PRIORITY_t {
  OPEN_POE_PRIORITY_INVALID = 0, OPEN_POE_PRIORITY_LOW = 1, OPEN_POE_PRIORITY_MEDIUM = 2, OPEN_POE_PRIORITY_HIGH = 3,
  OPEN_POE_PRIORITY_CRITICAL = 4, OPEN_POE_PRIORITY_COUNT = 5
}
 
enum  OPEN_POE_SYSTEM_OPER_STATUS_t { OPEN_POE_SYSTEM_OPER_STATUS_ON = 1, OPEN_POE_SYSTEM_OPER_STATUS_OFF = 2, OPEN_POE_SYSTEM_OPER_STATUS_FAULTY = 3 }
 PoE main operational status code. More...
 
enum  OPEN_POE_TYPE_t {
  OPEN_POE_TYPE_POE = 1, OPEN_POE_TYPE_POE_PLUS = 2, OPEN_POE_TYPE_PSE = 3, OPEN_POE_TYPE_PSE_PLUS = 4,
  OPEN_POE_TYPE_PD = 5, OPEN_POE_TYPE_PD_PLUS = 6, OPEN_POE_TYPE_UPOE = 7, OPEN_POE_TYPE_BT = 8
}
 PoE types. More...
 

Functions

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.
 
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 openapiPoeFWImageVersionGet (openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *version)
 Obtain POE Firmware Version.
 
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 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 openapiPoePethPsePortTimerCtrlClear (openapiClientHandle_t *client_handle, uint32_t ifNum)
 Clear timer schedule association for the port.
 
open_error_t openapiPoePseMainAdminEnableSet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_CONTROL_t adminMode)
 Sets global POE administrative mode .
 
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 openapiPoePseMainCurPowerLimitSet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t powerLimit)
 Sets the current watt limit the PSE can deliver on all interfaces.
 
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 openapiPoePseMainDetectionModeGet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_POE_DETECTION_t *detectionMode)
 Gets detection mode of a given unit.
 
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 openapiPoePseMainOperStatusGet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_POE_SYSTEM_OPER_STATUS_t *status)
 Obtain PSE Main Operational Status.
 
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 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 openapiPoePseMainUsageThresholdGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *threshold)
 Gets usage threshold in percent.
 
open_error_t openapiPoePseMainUsageThresholdSet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t threshold)
 Sets usage threshold in percent.
 
open_error_t openapiPoePsePortAdminEnableGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *adminMode)
 Gets an interface's POE administrative mode.
 
open_error_t openapiPoePsePortAdminEnableSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t adminMode)
 Sets an interface's POE administrative mode.
 
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 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 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 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_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 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_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 openapiPoePsePortDetectionStatusGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, uint32_t *detectionStatus)
 Gets operational status of the port PD detection.
 
open_error_t openapiPoePsePortErrorCodeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *errorCode)
 Gets Interface port error code.
 
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 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 openapiPoePsePortHighPowerModeSet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_CONTROL_t highPowerMode)
 Sets interface ability to provide POE high power.
 
open_error_t openapiPoePsePortPowerClassificationsGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, uint32_t *powerClass)
 Gets interface port terminal classification, eg.
 
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 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 openapiPoePsePortReset (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum)
 Reset PoE on a given interface.
 
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 celsius) measured at the poe controller hardware.
 
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 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 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 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_error_t openapiPoePseThresholdPowerGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *power)
 Obtain threshold power.
 
open_error_t openapiPoePseTotalAvailablePowerGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *power)
 Obtain total available power.
 
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 openapiPoeTrapModeSet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_CONTROL_t enabled)
 Sets POE Trap Mode.