]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/systemd/sd-lldp.h
Merge pull request #18990 from yuwata/network-dhcpv6-use-domains
[thirdparty/systemd.git] / src / systemd / sd-lldp.h
CommitLineData
db9ecf05 1/* SPDX-License-Identifier: LGPL-2.1-or-later */
04c01369
LP
2#ifndef foosdlldphfoo
3#define foosdlldphfoo
4
ad1ad5c8 5/***
ad1ad5c8
SS
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
10
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
18***/
19
2d93c20e 20#include <errno.h>
04c01369 21#include <inttypes.h>
71d35b6b 22#include <net/ethernet.h>
f8489763 23#include <sys/types.h>
07630cea 24
ad1ad5c8 25#include "sd-event.h"
71d35b6b 26
04c01369
LP
27#include "_sd-common.h"
28
29_SD_BEGIN_DECLARATIONS;
ad1ad5c8 30
e6a92d5e 31/* IEEE 802.1AB-2009 Clause 8: TLV Types */
6afa6767 32enum {
60ca5641
LP
33 SD_LLDP_TYPE_END = 0,
34 SD_LLDP_TYPE_CHASSIS_ID = 1,
35 SD_LLDP_TYPE_PORT_ID = 2,
36 SD_LLDP_TYPE_TTL = 3,
37 SD_LLDP_TYPE_PORT_DESCRIPTION = 4,
38 SD_LLDP_TYPE_SYSTEM_NAME = 5,
39 SD_LLDP_TYPE_SYSTEM_DESCRIPTION = 6,
40 SD_LLDP_TYPE_SYSTEM_CAPABILITIES = 7,
41 SD_LLDP_TYPE_MGMT_ADDRESS = 8,
42 SD_LLDP_TYPE_PRIVATE = 127,
6afa6767
BG
43};
44
e6a92d5e 45/* IEEE 802.1AB-2009 Clause 8.5.2: Chassis subtypes */
6afa6767
BG
46enum {
47 SD_LLDP_CHASSIS_SUBTYPE_RESERVED = 0,
48 SD_LLDP_CHASSIS_SUBTYPE_CHASSIS_COMPONENT = 1,
49 SD_LLDP_CHASSIS_SUBTYPE_INTERFACE_ALIAS = 2,
50 SD_LLDP_CHASSIS_SUBTYPE_PORT_COMPONENT = 3,
51 SD_LLDP_CHASSIS_SUBTYPE_MAC_ADDRESS = 4,
52 SD_LLDP_CHASSIS_SUBTYPE_NETWORK_ADDRESS = 5,
53 SD_LLDP_CHASSIS_SUBTYPE_INTERFACE_NAME = 6,
54 SD_LLDP_CHASSIS_SUBTYPE_LOCALLY_ASSIGNED = 7,
55};
56
e6a92d5e 57/* IEEE 802.1AB-2009 Clause 8.5.3: Port subtype */
6afa6767 58enum {
60ca5641
LP
59 SD_LLDP_PORT_SUBTYPE_RESERVED = 0,
60 SD_LLDP_PORT_SUBTYPE_INTERFACE_ALIAS = 1,
61 SD_LLDP_PORT_SUBTYPE_PORT_COMPONENT = 2,
62 SD_LLDP_PORT_SUBTYPE_MAC_ADDRESS = 3,
63 SD_LLDP_PORT_SUBTYPE_NETWORK_ADDRESS = 4,
64 SD_LLDP_PORT_SUBTYPE_INTERFACE_NAME = 5,
65 SD_LLDP_PORT_SUBTYPE_AGENT_CIRCUIT_ID = 6,
66 SD_LLDP_PORT_SUBTYPE_LOCALLY_ASSIGNED = 7,
6afa6767
BG
67};
68
e6a92d5e 69/* IEEE 802.1AB-2009 Clause 8.5.8: System capabilities */
6afa6767 70enum {
60ca5641
LP
71 SD_LLDP_SYSTEM_CAPABILITIES_OTHER = 1 << 0,
72 SD_LLDP_SYSTEM_CAPABILITIES_REPEATER = 1 << 1,
73 SD_LLDP_SYSTEM_CAPABILITIES_BRIDGE = 1 << 2,
74 SD_LLDP_SYSTEM_CAPABILITIES_WLAN_AP = 1 << 3,
75 SD_LLDP_SYSTEM_CAPABILITIES_ROUTER = 1 << 4,
76 SD_LLDP_SYSTEM_CAPABILITIES_PHONE = 1 << 5,
77 SD_LLDP_SYSTEM_CAPABILITIES_DOCSIS = 1 << 6,
78 SD_LLDP_SYSTEM_CAPABILITIES_STATION = 1 << 7,
79 SD_LLDP_SYSTEM_CAPABILITIES_CVLAN = 1 << 8,
80 SD_LLDP_SYSTEM_CAPABILITIES_SVLAN = 1 << 9,
81 SD_LLDP_SYSTEM_CAPABILITIES_TPMR = 1 << 10,
6afa6767
BG
82};
83
fd4e991d 84#define SD_LLDP_SYSTEM_CAPABILITIES_ALL UINT16_MAX
6afa6767
BG
85
86#define SD_LLDP_SYSTEM_CAPABILITIES_ALL_ROUTERS \
87 ((uint16_t) \
88 (SD_LLDP_SYSTEM_CAPABILITIES_REPEATER| \
89 SD_LLDP_SYSTEM_CAPABILITIES_BRIDGE| \
90 SD_LLDP_SYSTEM_CAPABILITIES_WLAN_AP| \
91 SD_LLDP_SYSTEM_CAPABILITIES_ROUTER| \
92 SD_LLDP_SYSTEM_CAPABILITIES_DOCSIS| \
93 SD_LLDP_SYSTEM_CAPABILITIES_CVLAN| \
94 SD_LLDP_SYSTEM_CAPABILITIES_SVLAN| \
95 SD_LLDP_SYSTEM_CAPABILITIES_TPMR))
96
6afa6767
BG
97#define SD_LLDP_OUI_802_1 (uint8_t[]) { 0x00, 0x80, 0xc2 }
98#define SD_LLDP_OUI_802_3 (uint8_t[]) { 0x00, 0x12, 0x0f }
99
f69b4ae8
SS
100#define SD_LLDP_OUI_MUD (uint8_t[]) { 0x00, 0x00, 0x5E }
101#define SD_LLDP_OUI_SUBTYPE_MUD_USAGE_DESCRIPTION 0x01
102
e6a92d5e 103/* IEEE 802.1AB-2009 Annex E */
6afa6767 104enum {
60ca5641
LP
105 SD_LLDP_OUI_802_1_SUBTYPE_PORT_VLAN_ID = 1,
106 SD_LLDP_OUI_802_1_SUBTYPE_PORT_PROTOCOL_VLAN_ID = 2,
107 SD_LLDP_OUI_802_1_SUBTYPE_VLAN_NAME = 3,
108 SD_LLDP_OUI_802_1_SUBTYPE_PROTOCOL_IDENTITY = 4,
109 SD_LLDP_OUI_802_1_SUBTYPE_VID_USAGE_DIGEST = 5,
110 SD_LLDP_OUI_802_1_SUBTYPE_MANAGEMENT_VID = 6,
111 SD_LLDP_OUI_802_1_SUBTYPE_LINK_AGGREGATION = 7,
6afa6767
BG
112};
113
dc8dc0cf
BG
114/* IEEE 802.1AB-2009 Annex F */
115enum {
116 SD_LLDP_OUI_802_3_SUBTYPE_MAC_PHY_CONFIG_STATUS = 1,
117 SD_LLDP_OUI_802_3_SUBTYPE_POWER_VIA_MDI = 2,
118 SD_LLDP_OUI_802_3_SUBTYPE_LINK_AGGREGATION = 3,
119 SD_LLDP_OUI_802_3_SUBTYPE_MAXIMUM_FRAME_SIZE = 4,
120};
121
fc6a313b
LP
122typedef struct sd_lldp sd_lldp;
123typedef struct sd_lldp_neighbor sd_lldp_neighbor;
124
2324fd3a 125typedef enum sd_lldp_event_t {
4f0e4d29
YW
126 SD_LLDP_EVENT_ADDED,
127 SD_LLDP_EVENT_REMOVED,
128 SD_LLDP_EVENT_UPDATED,
129 SD_LLDP_EVENT_REFRESHED,
130 _SD_LLDP_EVENT_MAX,
2d93c20e 131 _SD_LLDP_EVENT_INVALID = -EINVAL,
386059e1 132 _SD_ENUM_FORCE_S64(LLDP_EVENT),
2324fd3a 133} sd_lldp_event_t;
90dffb22 134
2324fd3a 135typedef void (*sd_lldp_callback_t)(sd_lldp *lldp, sd_lldp_event_t event, sd_lldp_neighbor *n, void *userdata);
49699bac 136
fc6a313b
LP
137int sd_lldp_new(sd_lldp **ret);
138sd_lldp* sd_lldp_ref(sd_lldp *lldp);
4afd3348 139sd_lldp* sd_lldp_unref(sd_lldp *lldp);
ad1ad5c8 140
ad1ad5c8
SS
141int sd_lldp_start(sd_lldp *lldp);
142int sd_lldp_stop(sd_lldp *lldp);
143
032b27f5 144int sd_lldp_attach_event(sd_lldp *lldp, sd_event *event, int64_t priority);
ad1ad5c8 145int sd_lldp_detach_event(sd_lldp *lldp);
3db2ec56 146sd_event *sd_lldp_get_event(sd_lldp *lldp);
ad1ad5c8 147
ccf86354 148int sd_lldp_set_callback(sd_lldp *lldp, sd_lldp_callback_t cb, void *userdata);
fc6a313b 149int sd_lldp_set_ifindex(sd_lldp *lldp, int ifindex);
61a9fa8f
YW
150int sd_lldp_set_ifname(sd_lldp *lldp, const char *ifname);
151const char *sd_lldp_get_ifname(sd_lldp *lldp);
4fc6de5d 152
34437b4f
LP
153/* Controls how much and what to store in the neighbors database */
154int sd_lldp_set_neighbors_max(sd_lldp *lldp, uint64_t n);
155int sd_lldp_match_capabilities(sd_lldp *lldp, uint16_t mask);
b553a6b1 156int sd_lldp_set_filter_address(sd_lldp *lldp, const struct ether_addr *address);
34437b4f
LP
157
158int sd_lldp_get_neighbors(sd_lldp *lldp, sd_lldp_neighbor ***neighbors);
159
160int sd_lldp_neighbor_from_raw(sd_lldp_neighbor **ret, const void *raw, size_t raw_size);
161sd_lldp_neighbor *sd_lldp_neighbor_ref(sd_lldp_neighbor *n);
162sd_lldp_neighbor *sd_lldp_neighbor_unref(sd_lldp_neighbor *n);
163
164/* Access to LLDP frame metadata */
165int sd_lldp_neighbor_get_source_address(sd_lldp_neighbor *n, struct ether_addr* address);
166int sd_lldp_neighbor_get_destination_address(sd_lldp_neighbor *n, struct ether_addr* address);
16fed825 167int sd_lldp_neighbor_get_timestamp(sd_lldp_neighbor *n, clockid_t clock, uint64_t *ret);
34437b4f
LP
168int sd_lldp_neighbor_get_raw(sd_lldp_neighbor *n, const void **ret, size_t *size);
169
170/* High-level, direct, parsed out field access. These fields exist at most once, hence may be queried directly. */
171int sd_lldp_neighbor_get_chassis_id(sd_lldp_neighbor *n, uint8_t *type, const void **ret, size_t *size);
172int sd_lldp_neighbor_get_chassis_id_as_string(sd_lldp_neighbor *n, const char **ret);
173int sd_lldp_neighbor_get_port_id(sd_lldp_neighbor *n, uint8_t *type, const void **ret, size_t *size);
174int sd_lldp_neighbor_get_port_id_as_string(sd_lldp_neighbor *n, const char **ret);
8a19206d 175int sd_lldp_neighbor_get_ttl(sd_lldp_neighbor *n, uint16_t *ret_sec);
34437b4f
LP
176int sd_lldp_neighbor_get_system_name(sd_lldp_neighbor *n, const char **ret);
177int sd_lldp_neighbor_get_system_description(sd_lldp_neighbor *n, const char **ret);
178int sd_lldp_neighbor_get_port_description(sd_lldp_neighbor *n, const char **ret);
f69b4ae8 179int sd_lldp_neighbor_get_mud_url(sd_lldp_neighbor *n, const char **ret);
34437b4f
LP
180int sd_lldp_neighbor_get_system_capabilities(sd_lldp_neighbor *n, uint16_t *ret);
181int sd_lldp_neighbor_get_enabled_capabilities(sd_lldp_neighbor *n, uint16_t *ret);
182
d7b34e38 183/* Low-level, iterative TLV access. This is for everything else, it iteratively goes through all available TLVs
34437b4f
LP
184 * (including the ones covered with the calls above), and allows multiple TLVs for the same fields. */
185int sd_lldp_neighbor_tlv_rewind(sd_lldp_neighbor *n);
186int sd_lldp_neighbor_tlv_next(sd_lldp_neighbor *n);
187int sd_lldp_neighbor_tlv_get_type(sd_lldp_neighbor *n, uint8_t *type);
188int sd_lldp_neighbor_tlv_is_type(sd_lldp_neighbor *n, uint8_t type);
4199f689
ZJS
189int sd_lldp_neighbor_tlv_get_oui(sd_lldp_neighbor *n, uint8_t oui[_SD_ARRAY_STATIC 3], uint8_t *subtype);
190int sd_lldp_neighbor_tlv_is_oui(sd_lldp_neighbor *n, const uint8_t oui[_SD_ARRAY_STATIC 3], uint8_t subtype);
34437b4f 191int sd_lldp_neighbor_tlv_get_raw(sd_lldp_neighbor *n, const void **ret, size_t *size);
04c01369 192
4afd3348 193_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_lldp, sd_lldp_unref);
34437b4f 194_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_lldp_neighbor, sd_lldp_neighbor_unref);
4afd3348 195
04c01369
LP
196_SD_END_DECLARATIONS;
197
198#endif