]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - src/systemd/sd-lldp.h
Add SPDX license identifiers to source files under the LGPL
[thirdparty/systemd.git] / src / systemd / sd-lldp.h
index fa6ab9ad3bc69219affd819fc7bb2ad58291b25c..0a76fa63143d12c38c90dd2c195b2a4ff57f8d35 100644 (file)
@@ -1,3 +1,4 @@
+/* SPDX-License-Identifier: LGPL-2.1+ */
 #ifndef foosdlldphfoo
 #define foosdlldphfoo
 
@@ -23,6 +24,7 @@
 
 #include <inttypes.h>
 #include <net/ethernet.h>
+#include <sys/types.h>
 
 #include "sd-event.h"
 
 
 _SD_BEGIN_DECLARATIONS;
 
-typedef struct sd_lldp sd_lldp;
-typedef struct sd_lldp_neighbor sd_lldp_neighbor;
-
-#define SD_LLDP_MULTICAST_ADDR     { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x0e }
-
 /* IEEE 802.3AB Clause 9: TLV Types */
 enum {
-        SD_LLDP_TYPE_END                  =   0,
-        SD_LLDP_TYPE_CHASSIS_ID           =   1,
-        SD_LLDP_TYPE_PORT_ID              =   2,
-        SD_LLDP_TYPE_TTL                  =   3,
-        SD_LLDP_TYPE_PORT_DESCRIPTION     =   4,
-        SD_LLDP_TYPE_SYSTEM_NAME          =   5,
-        SD_LLDP_TYPE_SYSTEM_DESCRIPTION   =   6,
-        SD_LLDP_TYPE_SYSTEM_CAPABILITIES  =   7,
-        SD_LLDP_TYPE_MGMT_ADDRESS         =   8,
-        SD_LLDP_TYPE_PRIVATE              =   127,
+        SD_LLDP_TYPE_END                 = 0,
+        SD_LLDP_TYPE_CHASSIS_ID          = 1,
+        SD_LLDP_TYPE_PORT_ID             = 2,
+        SD_LLDP_TYPE_TTL                 = 3,
+        SD_LLDP_TYPE_PORT_DESCRIPTION    = 4,
+        SD_LLDP_TYPE_SYSTEM_NAME         = 5,
+        SD_LLDP_TYPE_SYSTEM_DESCRIPTION  = 6,
+        SD_LLDP_TYPE_SYSTEM_CAPABILITIES = 7,
+        SD_LLDP_TYPE_MGMT_ADDRESS        = 8,
+        SD_LLDP_TYPE_PRIVATE             = 127,
 };
 
 /* IEEE 802.3AB Clause 9.5.2: Chassis subtypes */
@@ -63,28 +60,28 @@ enum {
 
 /* IEEE 802.3AB Clause 9.5.3: Port subtype */
 enum {
-        SD_LLDP_PORT_SUBTYPE_RESERVED           = 0,
-        SD_LLDP_PORT_SUBTYPE_INTERFACE_ALIAS    = 1,
-        SD_LLDP_PORT_SUBTYPE_PORT_COMPONENT     = 2,
-        SD_LLDP_PORT_SUBTYPE_MAC_ADDRESS        = 3,
-        SD_LLDP_PORT_SUBTYPE_NETWORK_ADDRESS    = 4,
-        SD_LLDP_PORT_SUBTYPE_INTERFACE_NAME     = 5,
-        SD_LLDP_PORT_SUBTYPE_AGENT_CIRCUIT_ID   = 6,
-        SD_LLDP_PORT_SUBTYPE_LOCALLY_ASSIGNED   = 7,
+        SD_LLDP_PORT_SUBTYPE_RESERVED         = 0,
+        SD_LLDP_PORT_SUBTYPE_INTERFACE_ALIAS  = 1,
+        SD_LLDP_PORT_SUBTYPE_PORT_COMPONENT   = 2,
+        SD_LLDP_PORT_SUBTYPE_MAC_ADDRESS      = 3,
+        SD_LLDP_PORT_SUBTYPE_NETWORK_ADDRESS  = 4,
+        SD_LLDP_PORT_SUBTYPE_INTERFACE_NAME   = 5,
+        SD_LLDP_PORT_SUBTYPE_AGENT_CIRCUIT_ID = 6,
+        SD_LLDP_PORT_SUBTYPE_LOCALLY_ASSIGNED = 7,
 };
 
 enum {
-        SD_LLDP_SYSTEM_CAPABILITIES_OTHER        = 1 << 0,
-        SD_LLDP_SYSTEM_CAPABILITIES_REPEATER     = 1 << 1,
-        SD_LLDP_SYSTEM_CAPABILITIES_BRIDGE       = 1 << 2,
-        SD_LLDP_SYSTEM_CAPABILITIES_WLAN_AP      = 1 << 3,
-        SD_LLDP_SYSTEM_CAPABILITIES_ROUTER       = 1 << 4,
-        SD_LLDP_SYSTEM_CAPABILITIES_PHONE        = 1 << 5,
-        SD_LLDP_SYSTEM_CAPABILITIES_DOCSIS       = 1 << 6,
-        SD_LLDP_SYSTEM_CAPABILITIES_STATION      = 1 << 7,
-        SD_LLDP_SYSTEM_CAPABILITIES_CVLAN        = 1 << 8,
-        SD_LLDP_SYSTEM_CAPABILITIES_SVLAN        = 1 << 9,
-        SD_LLDP_SYSTEM_CAPABILITIES_TPMR         = 1 << 10,
+        SD_LLDP_SYSTEM_CAPABILITIES_OTHER    = 1 << 0,
+        SD_LLDP_SYSTEM_CAPABILITIES_REPEATER = 1 << 1,
+        SD_LLDP_SYSTEM_CAPABILITIES_BRIDGE   = 1 << 2,
+        SD_LLDP_SYSTEM_CAPABILITIES_WLAN_AP  = 1 << 3,
+        SD_LLDP_SYSTEM_CAPABILITIES_ROUTER   = 1 << 4,
+        SD_LLDP_SYSTEM_CAPABILITIES_PHONE    = 1 << 5,
+        SD_LLDP_SYSTEM_CAPABILITIES_DOCSIS   = 1 << 6,
+        SD_LLDP_SYSTEM_CAPABILITIES_STATION  = 1 << 7,
+        SD_LLDP_SYSTEM_CAPABILITIES_CVLAN    = 1 << 8,
+        SD_LLDP_SYSTEM_CAPABILITIES_SVLAN    = 1 << 9,
+        SD_LLDP_SYSTEM_CAPABILITIES_TPMR     = 1 << 10,
 };
 
 #define SD_LLDP_SYSTEM_CAPABILITIES_ALL ((uint16_t) -1)
@@ -104,15 +101,18 @@ enum {
 #define SD_LLDP_OUI_802_3 (uint8_t[]) { 0x00, 0x12, 0x0f }
 
 enum {
-        SD_LLDP_OUI_802_1_SUBTYPE_PORT_VLAN_ID            = 1,
-        SD_LLDP_OUI_802_1_SUBTYPE_PORT_PROTOCOL_VLAN_ID   = 2,
-        SD_LLDP_OUI_802_1_SUBTYPE_VLAN_NAME               = 3,
-        SD_LLDP_OUI_802_1_SUBTYPE_PROTOCOL_IDENTITY       = 4,
-        SD_LLDP_OUI_802_1_SUBTYPE_VID_USAGE_DIGEST        = 5,
-        SD_LLDP_OUI_802_1_SUBTYPE_MANAGEMENT_VID          = 6,
-        SD_LLDP_OUI_802_1_SUBTYPE_LINK_AGGREGATION        = 7,
+        SD_LLDP_OUI_802_1_SUBTYPE_PORT_VLAN_ID          = 1,
+        SD_LLDP_OUI_802_1_SUBTYPE_PORT_PROTOCOL_VLAN_ID = 2,
+        SD_LLDP_OUI_802_1_SUBTYPE_VLAN_NAME             = 3,
+        SD_LLDP_OUI_802_1_SUBTYPE_PROTOCOL_IDENTITY     = 4,
+        SD_LLDP_OUI_802_1_SUBTYPE_VID_USAGE_DIGEST      = 5,
+        SD_LLDP_OUI_802_1_SUBTYPE_MANAGEMENT_VID        = 6,
+        SD_LLDP_OUI_802_1_SUBTYPE_LINK_AGGREGATION      = 7,
 };
 
+typedef struct sd_lldp sd_lldp;
+typedef struct sd_lldp_neighbor sd_lldp_neighbor;
+
 typedef enum sd_lldp_event {
         SD_LLDP_EVENT_ADDED     = 'a',
         SD_LLDP_EVENT_REMOVED   = 'r',
@@ -122,7 +122,8 @@ typedef enum sd_lldp_event {
 
 typedef void (*sd_lldp_callback_t)(sd_lldp *lldp, sd_lldp_event event, sd_lldp_neighbor *n, void *userdata);
 
-int sd_lldp_new(sd_lldp **ret, int ifindex);
+int sd_lldp_new(sd_lldp **ret);
+sd_lldp* sd_lldp_ref(sd_lldp *lldp);
 sd_lldp* sd_lldp_unref(sd_lldp *lldp);
 
 int sd_lldp_start(sd_lldp *lldp);
@@ -130,8 +131,10 @@ int sd_lldp_stop(sd_lldp *lldp);
 
 int sd_lldp_attach_event(sd_lldp *lldp, sd_event *event, int64_t priority);
 int sd_lldp_detach_event(sd_lldp *lldp);
+sd_event *sd_lldp_get_event(sd_lldp *lldp);
 
 int sd_lldp_set_callback(sd_lldp *lldp, sd_lldp_callback_t cb, void *userdata);
+int sd_lldp_set_ifindex(sd_lldp *lldp, int ifindex);
 
 /* Controls how much and what to store in the neighbors database */
 int sd_lldp_set_neighbors_max(sd_lldp *lldp, uint64_t n);
@@ -147,6 +150,7 @@ sd_lldp_neighbor *sd_lldp_neighbor_unref(sd_lldp_neighbor *n);
 /* Access to LLDP frame metadata */
 int sd_lldp_neighbor_get_source_address(sd_lldp_neighbor *n, struct ether_addr* address);
 int sd_lldp_neighbor_get_destination_address(sd_lldp_neighbor *n, struct ether_addr* address);
+int sd_lldp_neighbor_get_timestamp(sd_lldp_neighbor *n, clockid_t clock, uint64_t *ret);
 int sd_lldp_neighbor_get_raw(sd_lldp_neighbor *n, const void **ret, size_t *size);
 
 /* High-level, direct, parsed out field access. These fields exist at most once, hence may be queried directly. */
@@ -154,7 +158,7 @@ int sd_lldp_neighbor_get_chassis_id(sd_lldp_neighbor *n, uint8_t *type, const vo
 int sd_lldp_neighbor_get_chassis_id_as_string(sd_lldp_neighbor *n, const char **ret);
 int sd_lldp_neighbor_get_port_id(sd_lldp_neighbor *n, uint8_t *type, const void **ret, size_t *size);
 int sd_lldp_neighbor_get_port_id_as_string(sd_lldp_neighbor *n, const char **ret);
-int sd_lldp_neighbor_get_ttl(sd_lldp_neighbor *n, uint16_t *ret);
+int sd_lldp_neighbor_get_ttl(sd_lldp_neighbor *n, uint16_t *ret_sec);
 int sd_lldp_neighbor_get_system_name(sd_lldp_neighbor *n, const char **ret);
 int sd_lldp_neighbor_get_system_description(sd_lldp_neighbor *n, const char **ret);
 int sd_lldp_neighbor_get_port_description(sd_lldp_neighbor *n, const char **ret);