/* SPDX-License-Identifier: GPL-2.0-or-later */ /* * PTP 1588 support * * This file implements a BPF that recognizes PTP event messages. * * Copyright (C) 2010 OMICRON electronics GmbH */ #ifndef _PTP_CLASSIFY_H_ #define _PTP_CLASSIFY_H_ #include <linux/unaligned.h> #include <linux/ip.h> #include <linux/ktime.h> #include <linux/skbuff.h> #include <linux/udp.h> #include <net/checksum.h> #define PTP_CLASS_NONE … #define PTP_CLASS_V1 … #define PTP_CLASS_V2 … #define PTP_CLASS_VMASK … #define PTP_CLASS_IPV4 … #define PTP_CLASS_IPV6 … #define PTP_CLASS_L2 … #define PTP_CLASS_PMASK … #define PTP_CLASS_VLAN … #define PTP_CLASS_V1_IPV4 … #define PTP_CLASS_V1_IPV6 … #define PTP_CLASS_V2_IPV4 … #define PTP_CLASS_V2_IPV6 … #define PTP_CLASS_V2_L2 … #define PTP_CLASS_V2_VLAN … #define PTP_CLASS_L4 … #define PTP_MSGTYPE_SYNC … #define PTP_MSGTYPE_DELAY_REQ … #define PTP_MSGTYPE_PDELAY_REQ … #define PTP_MSGTYPE_PDELAY_RESP … #define PTP_EV_PORT … #define PTP_GEN_PORT … #define PTP_GEN_BIT … #define OFF_PTP_SOURCE_UUID … #define OFF_PTP_SEQUENCE_ID … /* PTP header flag fields */ #define PTP_FLAG_TWOSTEP … /* Below defines should actually be removed at some point in time. */ #define IP6_HLEN … #define UDP_HLEN … #define OFF_IHL … #define IPV4_HLEN(data) … struct clock_identity { … } __packed; struct port_identity { … } __packed; struct ptp_header { … } __packed; #if defined(CONFIG_NET_PTP_CLASSIFY) /** * ptp_classify_raw - classify a PTP packet * @skb: buffer * * Runs a minimal BPF dissector to classify a network packet to * determine the PTP class. In case the skb does not contain any * PTP protocol data, PTP_CLASS_NONE will be returned, otherwise * PTP_CLASS_V1_IPV{4,6}, PTP_CLASS_V2_IPV{4,6} or * PTP_CLASS_V2_{L2,VLAN}, depending on the packet content. */ unsigned int ptp_classify_raw(const struct sk_buff *skb); /** * ptp_parse_header - Get pointer to the PTP v2 header * @skb: packet buffer * @type: type of the packet (see ptp_classify_raw()) * * This function takes care of the VLAN, UDP, IPv4 and IPv6 headers. The length * is checked. * * Note, internally skb_mac_header() is used. Make sure that the @skb is * initialized accordingly. * * Return: Pointer to the ptp v2 header or NULL if not found */ struct ptp_header *ptp_parse_header(struct sk_buff *skb, unsigned int type); /** * ptp_get_msgtype - Extract ptp message type from given header * @hdr: ptp header * @type: type of the packet (see ptp_classify_raw()) * * This function returns the message type for a given ptp header. It takes care * of the different ptp header versions (v1 or v2). * * Return: The message type */ static inline u8 ptp_get_msgtype(const struct ptp_header *hdr, unsigned int type) { … } /** * ptp_check_diff8 - Computes new checksum (when altering a 64-bit field) * @old: old field value * @new: new field value * @oldsum: previous checksum * * This function can be used to calculate a new checksum when only a single * field is changed. Similar as ip_vs_check_diff*() in ip_vs.h. * * Return: Updated checksum */ static inline __wsum ptp_check_diff8(__be64 old, __be64 new, __wsum oldsum) { … } /** * ptp_header_update_correction - Update PTP header's correction field * @skb: packet buffer * @type: type of the packet (see ptp_classify_raw()) * @hdr: ptp header * @correction: new correction value * * This updates the correction field of a PTP header and updates the UDP * checksum (if UDP is used as transport). It is needed for hardware capable of * one-step P2P that does not already modify the correction field of Pdelay_Req * event messages on ingress. */ static inline void ptp_header_update_correction(struct sk_buff *skb, unsigned int type, struct ptp_header *hdr, s64 correction) { … } /** * ptp_msg_is_sync - Evaluates whether the given skb is a PTP Sync message * @skb: packet buffer * @type: type of the packet (see ptp_classify_raw()) * * This function evaluates whether the given skb is a PTP Sync message. * * Return: true if sync message, false otherwise */ bool ptp_msg_is_sync(struct sk_buff *skb, unsigned int type); void __init ptp_classifier_init(void); #else static inline void ptp_classifier_init(void) { } static inline unsigned int ptp_classify_raw(struct sk_buff *skb) { return PTP_CLASS_NONE; } static inline struct ptp_header *ptp_parse_header(struct sk_buff *skb, unsigned int type) { return NULL; } static inline u8 ptp_get_msgtype(const struct ptp_header *hdr, unsigned int type) { /* The return is meaningless. The stub function would not be * executed since no available header from ptp_parse_header. */ return PTP_MSGTYPE_SYNC; } static inline bool ptp_msg_is_sync(struct sk_buff *skb, unsigned int type) { return false; } static inline void ptp_header_update_correction(struct sk_buff *skb, unsigned int type, struct ptp_header *hdr, s64 correction) { } #endif #endif /* _PTP_CLASSIFY_H_ */
Codebase Browser
linux