lldp_ext_med.h

Go to the documentation of this file.

 
#ifndef _LLDP_EXT_MED_H
#define _LLDP_EXT_MED_H
 
//Dependencies
#include "core/net.h"
#include "lldp/lldp.h"
 
//Minimum length of hardware revision
#define LLDP_MED_MIN_INVENTORY_STRING_LEN 0
//Maximum length of hardware revision
#define LLDP_MED_MAX_INVENTORY_STRING_LEN 32
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef enum
{
   LLDP_MED_SUBTYPE_RESERVED          = 0,  
   LLDP_MED_SUBTYPE_LLDP_MED_CAP      = 1,  
   LLDP_MED_SUBTYPE_NETWORK_POLICY    = 2,  
   LLDP_MED_SUBTYPE_LOCATION_ID       = 3,  
   LLDP_MED_SUBTYPE_EXT_POWER_VIA_MDI = 4,  
   LLDP_MED_SUBTYPE_HARDWARE_REVISION = 5,  
   LLDP_MED_SUBTYPE_FIRMWARE_REVISION = 6,  
   LLDP_MED_SUBTYPE_SOFTWARE_REVISION = 7,  
   LLDP_MED_SUBTYPE_SERIAL_NUMBER     = 8,  
   LLDP_MED_SUBTYPE_MANUFACTURER_NAME = 9,  
   LLDP_MED_SUBTYPE_MODEL_NAME        = 10, 
   LLDP_MED_SUBTYPE_ASSET_ID          = 11  
} LldpMedSubtype;
 
 
typedef enum
{
   LLDP_MED_CAP                = 0x0001, 
   LLDP_MED_CAP_NETWORK_POLICY = 0x0002, 
   LLDP_MED_CAP_LOCATION       = 0x0004, 
   LLDP_MED_CAP_EXTENDED_PSE   = 0x0008, 
   LLDP_MED_CAP_EXTENDED_PD    = 0x0010, 
   LLDP_MED_CAP_INVENTORY      = 0x0020  
} LldpMedCap;
 
 
typedef enum
{
   LLDP_MED_DEVICE_TYPE_NOT_DEFINED          = 0, 
   LLDP_MED_DEVICE_TYPE_ENDPOINT_CLASS_1     = 1, 
   LLDP_MED_DEVICE_TYPE_ENDPOINT_CLASS_2     = 2, 
   LLDP_MED_DEVICE_TYPE_ENDPOINT_CLASS_3     = 3, 
   LLDP_MED_DEVICE_TYPE_NETWORK_CONNECTIVITY = 4  
} LldpMedDeviceType;
 
 
typedef enum
{
   LLDP_MED_APP_TYPE_RESERVED              = 0, 
   LLDP_MED_APP_TYPE_VOICE                 = 1, 
   LLDP_MED_APP_TYPE_VOICE_SIGNALING       = 2, 
   LLDP_MED_APP_TYPE_GUEST_VOICE           = 3, 
   LLDP_MED_APP_TYPE_GUEST_VOICE_SIGNALING = 4, 
   LLDP_MED_APP_TYPE_SOFTPHONE_VOICE       = 5, 
   LLDP_MED_APP_TYPE_VIDEO_CONFERENCING    = 6, 
   LLDP_MED_APP_TYPE_STREAMING_VIDEO       = 7, 
   LLDP_MED_APP_TYPE_VIDEO_SIGNALING       = 8  
} LldpMedAppType;
 
 
typedef enum
{
   LLDP_MED_LOCATION_DATA_FORMAT_INVALID         = 0, 
   LLDP_MED_LOCATION_DATA_FORMAT_COORD_BASED_LCI = 1, 
   LLDP_MED_LOCATION_DATA_FORMAT_CIVIC_ADDR_LCI  = 2, 
   LLDP_MED_LOCATION_DATA_FORMAT_ECS_ELIN        = 3  
} LldpMedLocationDataFormat;
 
 
typedef enum
{
   LLDP_MED_POWER_TYPE_PSE_DEVICE = 0, 
   LLDP_MED_POWER_TYPE_PD_DEVICE  = 1, 
   LLDP_MED_POWER_TYPE_RESERVED_1 = 2, 
   LLDP_MED_POWER_TYPE_RESERVED_2 = 3  
} LldpMedPowerType;
 
 
typedef enum
{
   LLDP_MED_PD_POWER_SOURCE_UNKNOWN       = 0, 
   LLDP_MED_PD_POWER_SOURCE_PSE           = 1, 
   LLDP_MED_PD_POWER_SOURCE_LOCAL         = 2, 
   LLDP_MED_PD_POWER_SOURCE_PSE_AND_LOCAL = 3, 
   LLDP_MED_PSE_POWER_SOURCE_UNKNOWN      = 0, 
   LLDP_MED_PSE_POWER_SOURCE_PRIMARY      = 1, 
   LLDP_MED_PSE_POWER_SOURCE_BACKUP       = 2, 
   LLDP_MED_PSE_POWER_SOURCE_RESERVED     = 3  
} LldpMedPowerSource;
 
 
typedef enum
{
   LLDP_MED_POWER_PRIORITY_UNKNOWN  = 0, 
   LLDP_MED_POWER_PRIORITY_CRITICAL = 1, 
   LLDP_MED_POWER_PRIORITY_HIGH     = 2, 
   LLDP_MED_POWER_PRIORITY_LOW      = 3  
} LldpMedPowerPriority;
 
 
//CodeWarrior or Win32 compiler?
#if defined(__CWCC__) || defined(_WIN32)
   #pragma pack(push, 1)
#endif
 
 
typedef __packed_struct
{
   uint16_t capabilities; //0-1
   uint8_t deviceType;    //2
} LldpMedCapTlv;
 
 
typedef __packed_struct
{
#if defined(_CPU_BIG_ENDIAN) && !defined(__ICCRX__)
   uint8_t appType;         //0
   uint8_t u : 1;           //1
   uint8_t t : 1;
   uint8_t x : 1;
   uint8_t vlanIdH : 5;
   uint8_t vlanIdL : 7;     //2
   uint8_t l2PriorityH : 1;
   uint8_t l2PriorityL : 2; //3
   uint8_t dscpValue : 6;
#else
   uint8_t appType;         //0
   uint8_t vlanIdH : 5;     //1
   uint8_t x : 1;
   uint8_t t : 1;
   uint8_t u : 1;
   uint8_t l2PriorityH : 1; //2
   uint8_t vlanIdL : 7;
   uint8_t dscpValue : 6;   //3
   uint8_t l2PriorityL : 2;
#endif
} LldpMedNetworkPolicyTlv;
 
 
typedef __packed_struct
{
   uint8_t locationDataFormat; //0-1
   uint8_t locationId[];       //2
} LldpMedLocationIdTlv;
 
 
typedef __packed_struct
{
#if defined(_CPU_BIG_ENDIAN) && !defined(__ICCRX__)
   uint8_t powerType : 2;     //0
   uint8_t powerSource : 2;
   uint8_t powerPriority : 4;
   uint16_t powerValue;       //1-2
#else
   uint8_t powerPriority : 4; //0
   uint8_t powerSource : 2;
   uint8_t powerType : 2;
   uint16_t powerValue;       //1-2
#endif
} LldpMedExtPowerViaMdiTlv;
 
 
//CodeWarrior or Win32 compiler?
#if defined(__CWCC__) || defined(_WIN32)
   #pragma pack(pop)
#endif
 
//LLDP-MED related functions
error_t lldpMedSetLocalCap(LldpAgentContext *context, uint16_t capabilities,
   LldpMedDeviceType deviceType);
 
error_t lldpMedSetLocalNetworkPolicy(LldpAgentContext *context,
   uint_t portIndex, LldpMedAppType appType, bool_t u, bool_t t,
   uint16_t vlanId, uint8_t l2Priority, uint8_t dscpValue);
 
error_t lldpMedSetLocalLocationId(LldpAgentContext *context,
   uint_t portIndex, LldpMedLocationDataFormat locationDataFormat,
   const void *locationId, size_t locationIdLen);
 
error_t lldpMedSetLocalExtPowerViaMdi(LldpAgentContext *context,
   uint_t portIndex, LldpMedPowerType powerType, LldpMedPowerSource powerSource,
   LldpMedPowerPriority powerPriority, uint16_t powerValue);
 
error_t lldpMedSetLocalHardwareRevision(LldpAgentContext *context,
   const char_t *hardwareRevision);
 
error_t lldpMedSetLocalFirmwareRevision(LldpAgentContext *context,
   const char_t *firmwareRevision);
 
error_t lldpMedSetLocalSoftwareRevision(LldpAgentContext *context,
   const char_t *softwareRevision);
 
error_t lldpMedSetLocalSerialNumber(LldpAgentContext *context,
   const char_t *serialNumber);
 
error_t lldpMedSetLocalManufacturerName(LldpAgentContext *context,
   const char_t *manufacturerName);
 
error_t lldpMedSetLocalModelName(LldpAgentContext *context,
   const char_t *modelName);
 
error_t lldpMedSetLocalAssetId(LldpAgentContext *context,
   const char_t *assetId);
 
error_t lldpMedDeleteLocalTlv(LldpAgentContext *context,
   LldpMedSubtype subtype);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif