lldp.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2017 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_LLDP_H_
#define ZEPHYR_INCLUDE_NET_LLDP_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define LLDP_TLV_GET_LENGTH(type_length)        (type_length & BIT_MASK(9))
#define LLDP_TLV_GET_TYPE(type_length)          ((uint8_t)(type_length >> 9))
 
/* LLDP Definitions */
 
/* According to the spec, End of LLDPDU TLV value is constant. */
#define NET_LLDP_END_LLDPDU_VALUE 0x0000
 
/*
 * For the Chassis ID TLV Value, if subtype is a MAC address then we must
 * use values from CONFIG_NET_LLDP_CHASSIS_ID_MAC0 through
 * CONFIG_NET_LLDP_CHASSIS_ID_MAC5. If not, we use CONFIG_NET_LLDP_CHASSIS_ID.
 *
 * FIXME: implement a similar scheme for subtype 5 (network address).
 */
#if defined(CONFIG_NET_LLDP_CHASSIS_ID_SUBTYPE)
#if (CONFIG_NET_LLDP_CHASSIS_ID_SUBTYPE == 4)
#define NET_LLDP_CHASSIS_ID_VALUE               \
        {                                       \
          CONFIG_NET_LLDP_CHASSIS_ID_MAC0,      \
          CONFIG_NET_LLDP_CHASSIS_ID_MAC1,      \
          CONFIG_NET_LLDP_CHASSIS_ID_MAC2,      \
          CONFIG_NET_LLDP_CHASSIS_ID_MAC3,      \
          CONFIG_NET_LLDP_CHASSIS_ID_MAC4,      \
          CONFIG_NET_LLDP_CHASSIS_ID_MAC5       \
        }
 
#define NET_LLDP_CHASSIS_ID_VALUE_LEN (6)
#else
#define NET_LLDP_CHASSIS_ID_VALUE CONFIG_NET_LLDP_CHASSIS_ID
#define NET_LLDP_CHASSIS_ID_VALUE_LEN (sizeof(CONFIG_NET_LLDP_CHASSIS_ID) - 1)
#endif
#else
#define NET_LLDP_CHASSIS_ID_VALUE 0
#define NET_LLDP_CHASSIS_ID_VALUE_LEN 0
#endif
 
/*
 * For the Port ID TLV Value, if subtype is a MAC address then we must
 * use values from CONFIG_NET_LLDP_PORT_ID_MAC0 through
 * CONFIG_NET_LLDP_PORT_ID_MAC5. If not, we use CONFIG_NET_LLDP_PORT_ID.
 *
 * FIXME: implement a similar scheme for subtype 4 (network address).
 */
#if defined(CONFIG_NET_LLDP_PORT_ID_SUBTYPE)
#if (CONFIG_NET_LLDP_PORT_ID_SUBTYPE == 3)
#define NET_LLDP_PORT_ID_VALUE          \
        {                               \
          CONFIG_NET_LLDP_PORT_ID_MAC0, \
          CONFIG_NET_LLDP_PORT_ID_MAC1, \
          CONFIG_NET_LLDP_PORT_ID_MAC2, \
          CONFIG_NET_LLDP_PORT_ID_MAC3, \
          CONFIG_NET_LLDP_PORT_ID_MAC4, \
          CONFIG_NET_LLDP_PORT_ID_MAC5  \
        }
 
#define NET_LLDP_PORT_ID_VALUE_LEN (6)
#else
#define NET_LLDP_PORT_ID_VALUE CONFIG_NET_LLDP_PORT_ID
#define NET_LLDP_PORT_ID_VALUE_LEN (sizeof(CONFIG_NET_LLDP_PORT_ID) - 1)
#endif
#else
#define NET_LLDP_PORT_ID_VALUE 0
#define NET_LLDP_PORT_ID_VALUE_LEN 0
#endif
 
/*
 * TLVs Length.
 * Note that TLVs that have a subtype must have a byte added to their length.
 */
#define NET_LLDP_CHASSIS_ID_TLV_LEN (NET_LLDP_CHASSIS_ID_VALUE_LEN + 1)
#define NET_LLDP_PORT_ID_TLV_LEN (NET_LLDP_PORT_ID_VALUE_LEN + 1)
#define NET_LLDP_TTL_TLV_LEN (2)
 
/*
 * Time to Live value.
 * Calculate based on section 9.2.5.22 from LLDP spec.
 *
 * FIXME: when the network interface is about to be ‘disabled’ TTL shall be set
 * to zero so LLDP Rx agents can invalidate the entry related to this node.
 */
#if defined(CONFIG_NET_LLDP_TX_INTERVAL) && defined(CONFIG_NET_LLDP_TX_HOLD)
#define NET_LLDP_TTL \
        MIN((CONFIG_NET_LLDP_TX_INTERVAL * CONFIG_NET_LLDP_TX_HOLD) + 1, 65535)
#endif
 
 
struct net_if;
 
enum net_lldp_tlv_type {
        LLDP_TLV_END_LLDPDU          = 0, 
        LLDP_TLV_CHASSIS_ID          = 1, 
        LLDP_TLV_PORT_ID             = 2, 
        LLDP_TLV_TTL                 = 3, 
        LLDP_TLV_PORT_DESC           = 4, 
        LLDP_TLV_SYSTEM_NAME         = 5, 
        LLDP_TLV_SYSTEM_DESC         = 6, 
        LLDP_TLV_SYSTEM_CAPABILITIES = 7, 
        LLDP_TLV_MANAGEMENT_ADDR     = 8, 
        /* Types 9 - 126 are reserved. */
        LLDP_TLV_ORG_SPECIFIC       = 127, 
};
 
struct net_lldp_chassis_tlv {
        uint16_t type_length;
        uint8_t subtype;
        uint8_t value[NET_LLDP_CHASSIS_ID_VALUE_LEN];
} __packed;
 
struct net_lldp_port_tlv {
        uint16_t type_length;
        uint8_t subtype;
        uint8_t value[NET_LLDP_PORT_ID_VALUE_LEN];
} __packed;
 
struct net_lldp_time_to_live_tlv {
        uint16_t type_length;
        uint16_t ttl;
} __packed;
 
struct net_lldpdu {
        struct net_lldp_chassis_tlv chassis_id; 
        struct net_lldp_port_tlv port_id;       
        struct net_lldp_time_to_live_tlv ttl;   
} __packed;
 
int net_lldp_config(struct net_if *iface, const struct net_lldpdu *lldpdu);
 
int net_lldp_config_optional(struct net_if *iface, const uint8_t *tlv,
                             size_t len);
 
void net_lldp_init(void);
 
typedef enum net_verdict (*net_lldp_recv_cb_t)(struct net_if *iface,
                                               struct net_pkt *pkt);
 
int net_lldp_register_callback(struct net_if *iface, net_lldp_recv_cb_t cb);
 
enum net_verdict net_lldp_recv(struct net_if *iface, struct net_pkt *pkt);
 
#if defined(CONFIG_NET_LLDP)
int net_lldp_set_lldpdu(struct net_if *iface);
#else
#define net_lldp_set_lldpdu(iface)
#endif
 
#if defined(CONFIG_NET_LLDP)
void net_lldp_unset_lldpdu(struct net_if *iface);
#else
#define net_lldp_unset_lldpdu(iface)
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_LLDP_H_ */