Merge tag 'docs-5.10-2' of git://git.lwn.net/linux

[linux-2.6-microblaze.git] / include / linux / ptp_classify.h

diff --git a/include/linux/ptp_classify.h b/include/linux/ptp_classify.h
index dd00fa4..c6487b7 100644 (file)
--- a/include/linux/ptp_classify.h
+++ b/include/linux/ptp_classify.h
@@ -36,7 +36,6 @@
 
 #define OFF_PTP_SOURCE_UUID    22 /* PTPv1 only */
 #define OFF_PTP_SEQUENCE_ID    30
-#define OFF_PTP_CONTROL                32 /* PTPv1 only */
 
 /* Below defines should actually be removed at some point in time. */
 #define IP6_HLEN       40
@@ -44,6 +43,30 @@
 #define OFF_IHL                14
 #define IPV4_HLEN(data) (((struct iphdr *)(data + OFF_IHL))->ihl << 2)
 
+struct clock_identity {
+       u8 id[8];
+} __packed;
+
+struct port_identity {
+       struct clock_identity   clock_identity;
+       __be16                  port_number;
+} __packed;
+
+struct ptp_header {
+       u8                      tsmt;  /* transportSpecific | messageType */
+       u8                      ver;   /* reserved          | versionPTP  */
+       __be16                  message_length;
+       u8                      domain_number;
+       u8                      reserved1;
+       u8                      flag_field[2];
+       __be64                  correction;
+       __be32                  reserved2;
+       struct port_identity    source_port_identity;
+       __be16                  sequence_id;
+       u8                      control;
+       u8                      log_message_interval;
+} __packed;
+
 #if defined(CONFIG_NET_PTP_CLASSIFY)
 /**
  * ptp_classify_raw - classify a PTP packet
@@ -57,6 +80,46 @@
  */
 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)
+{
+       u8 msgtype;
+
+       if (unlikely(type & PTP_CLASS_V1)) {
+               /* msg type is located at the control field for ptp v1 */
+               msgtype = hdr->control;
+       } else {
+               msgtype = hdr->tsmt & 0x0f;
+       }
+
+       return msgtype;
+}
+
 void __init ptp_classifier_init(void);
 #else
 static inline void ptp_classifier_init(void)
@@ -66,5 +129,18 @@ 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 0;
+}
 #endif
 #endif /* _PTP_CLASSIFY_H_ */