pipewire/src/modules/module-avb/gptp.h

/* PipeWire */
/* SPDX-FileCopyrightText: Copyright © 2024 Dmitry Sharshakov <d3dx12.xx@gmail.com> */
/* SPDX-FileCopyrightText: Copyright © 2025 Nils Tonnaett <ntonnatt@ccrma.stanford.edu> */
/* SPDX-FileCopyrightText: Copyright © 2026 Alexandre Malki <alexandre.malki@kebag-logic.com> */
/* SPDX-License-Identifier: MIT */

#ifndef AVB_GPTP_H
#define AVB_GPTP_H

#include <stdbool.h>
#include <stdint.h>
#include "internal.h"

#ifdef __cplusplus
extern "C" {
#endif

#define PTP_MESSAGE_TYPE_MANAGEMENT 0x0d
#define PTP_VERSION_1588_2008_2_1 0x12
#define PTP_DEFAULT_LOG_MESSAGE_INTERVAL 127
#define PTP_MGMT_ACTION_GET 0
#define PTP_MGMT_ACTION_RESPONSE 2
#define PTP_TLV_TYPE_MGMT 0x0001
#define PTP_MGMT_ID_DEFAULT_DATA_SET 0x2000
#define PTP_MGMT_ID_PARENT_DATA_SET 0x2002
#define PTP_MGMT_ID_PORT_DATA_SET 0x2004

/**************************************************************************************/
/* IEEE 1588-2019, Sec. 15.4.1 PTP management message format - Common Fields */

struct ptp_management_msg {
/* IEEE 1588-2019, Sec. 13.3 Header */
	// 4 for major_sdo, 4 for msg_type
	uint8_t  major_sdo_id_message_type;
	// 4 for minor, 4 for major
	uint8_t  ver;
	uint16_t message_length_be;
	uint8_t  domain_number;
	uint8_t  minor_sdo_id;
	uint16_t flags_be;
	uint8_t  correction_field[8];
	uint32_t message_type_specific;
	uint8_t  clock_identity[8];
	uint16_t source_port_id_be;
	uint16_t sequence_id_be;
	uint8_t  control_field;
	uint8_t  log_message_interval;

	uint8_t  target_port_identity[8];
	uint16_t target_port_id_be;
	uint8_t  starting_boundary_hops;
	uint8_t  boundary_hops;
	uint8_t  action;
	uint8_t  reserved;
	uint16_t tlv_type_be;
	// length of data after this + 2 for management_id
	uint16_t management_message_length_be;
	uint16_t management_id_be;
} __attribute__((packed));

struct ptp_parent_data_set {
	uint8_t  parent_clock_id[8];
	uint16_t parent_port_id_be;
	uint8_t  parent_stats;
	uint8_t  reserved;
	uint16_t log_variance_be;
	int32_t  phase_change_rate_be;
	uint8_t  gm_prio1;
	uint8_t  gm_clock_class;
	uint8_t  gm_clock_accuracy;
	uint16_t gm_clock_variance_be;
	uint8_t  gm_prio2;
	uint8_t  gm_clock_id[8];
} __attribute__((packed));

/* IEEE 1588-2008 Section 15.5.1.1 defaultDS */
struct ptp_default_data_set {
	uint8_t  flags;
	uint8_t  reserved1;
	uint16_t number_ports_be;
	uint8_t  priority1;
	uint8_t  clock_class;
	uint8_t  clock_accuracy;
	uint16_t offset_scaled_log_variance_be;
	uint8_t  priority2;
	uint8_t  clock_identity[8];
	uint8_t  domain_number;
	uint8_t  reserved2;
} __attribute__((packed));

/* IEEE 1588-2008 Section 15.5.1.4 portDS */
struct ptp_port_data_set {
	uint8_t  port_clock_identity[8];
	uint16_t port_number_be;
	uint8_t  port_state;
	int8_t   log_min_delay_req_interval;
	uint8_t  peer_mean_path_delay[8];
	int8_t   log_announce_interval;
	uint8_t  announce_receipt_timeout;
	int8_t   log_sync_interval;
	uint8_t  delay_mechanism;
	int8_t   log_min_pdelay_req_interval;
	uint8_t  version_number;
} __attribute__((packed));

struct avb_gptp *avb_gptp_new(struct server *server);

bool avb_gptp_get_clock_id(const struct avb_gptp *gptp, uint64_t *clock_id_be);
bool avb_gptp_get_grandmaster_id(const struct avb_gptp *gptp, uint64_t *gm_id_be);
bool avb_gptp_is_grandmaster(const struct avb_gptp *gptp);

#ifdef __cplusplus
}
#endif

#endif /* AVB_GPTP_H */