ptp

Author: jr1221

NetX/inc/u_nx_ethernet.h

@@ -10,6 +10,7 @@
 #include <stdint.h>
 #include <stdbool.h>
 #include "nx_api.h"
+#include "nxd_ptp_client.h"
 
 /* CONFIG */
 #define ETH_UDP_PORT	    2006 /* UDP port for communication */
@@ -31,11 +32,11 @@ typedef enum {
 
 /* These node ids are ONLY relavent to PLCA configuration.
    They are meant to be used when configuring a PHY. The IDs must be sequential, and the "0" id always indicates the network's coordinator node.
-   They have no impact on application-level IP addresses or message processing. 
-   
+   They have no impact on application-level IP addresses or message processing.
+
    For example, if you're using the LAN8670 PHY driver, you'd probably use these enum values like this:
    LAN8670_PLCA_Set_Node_Count(&lan8670, PLCA_NUM_NODES);
-   LAN8670_PLCA_Set_Node_Id(&lan8670, PLCA_VCU) // replace 'PLCA_VCU' with whatever board it is		
+   LAN8670_PLCA_Set_Node_Id(&lan8670, PLCA_VCU) // replace 'PLCA_VCU' with whatever board it is
    */
 typedef enum {
 	PLCA_TPU,		// 0. This is the PLCA coordinator node.
@@ -88,5 +89,11 @@ ethernet_message_t ethernet_create_message(uint8_t message_id, ethernet_node_t r
  */
 uint8_t ethernet_send_message(ethernet_message_t *message);
 
+/**
+ * @brief Retrieves the time from PTP stack.
+ * @return The UTC time
+ */
+NX_PTP_DATE_TIME ethernet_get_time(void);
+
 // clang-format on
-#endif /* u_nx_ethernet.h */
+#endif /* u_nx_ethernet.h */

NetX/src/u_nx_ethernet.c

@@ -1,6 +1,7 @@
 // clang-format off
 #include "u_nx_ethernet.h"
 #include "nx_stm32_eth_driver.h"
+#include "nxd_ptp_client.h"
 #include "u_nx_debug.h"
 #include "u_tx_debug.h"
 #include "nx_api.h"
@@ -15,18 +16,22 @@
 #define _IP_THREAD_PRIORITY   1
 #define _IP_NETWORK_MASK      IP_ADDRESS(255, 255, 255, 0)
 #define _UDP_QUEUE_MAXIMUM    12
+#define _PTP_THREAD_PRIORITY 2
 
 /* DEVICE INFO */
 typedef struct {
 	/* NetX Objects */
 	NX_UDP_SOCKET socket;
 	NX_PACKET_POOL packet_pool;
 	NX_IP ip;
+	NX_PTP_CLIENT ptp_client;
+	SHORT ptp_utc_offset;
 
 	/* Static memory for NetX stuff */
 	UCHAR packet_pool_memory[_PACKET_POOL_SIZE];
 	UCHAR ip_memory[_IP_THREAD_STACK_SIZE];
 	UCHAR arp_cache_memory[_ARP_CACHE_SIZE];
+	ULONG ptp_stack[2048 / sizeof(ULONG)];
 
 	/* Device config variables */
 	bool is_initialized;
@@ -37,6 +42,45 @@ typedef struct {
 } _ethernet_device_t;
 static _ethernet_device_t device = { 0 };
 
+/* Callback function. Called when a PTP event is processed. */
+// extern UINT ptp_clock_callback(NX_PTP_CLIENT *client_ptr, UINT operation,
+//         NX_PTP_TIME *time_ptr, NX_PACKET *packet_ptr,
+//         VOID *callback_data);
+
+/* Callback function. Called when a PTP event is processed. */
+static UINT _ptp_event_callback(NX_PTP_CLIENT *ptp_client_ptr, UINT event, VOID *event_data, VOID *callback_data)
+{
+  NX_PARAMETER_NOT_USED(callback_data);
+
+  switch (event)
+  {
+    case NX_PTP_CLIENT_EVENT_MASTER:
+    {
+      PRINTLN_WARNING("new MASTER clock!");
+      break;
+    }
+
+    case NX_PTP_CLIENT_EVENT_SYNC:
+    {
+      nx_ptp_client_sync_info_get((NX_PTP_CLIENT_SYNC *)event_data, NX_NULL, &device.ptp_utc_offset);
+      PRINTLN_INFO("SYNC event: utc offset=%d", device.ptp_utc_offset);
+      break;
+    }
+
+    case NX_PTP_CLIENT_EVENT_TIMEOUT:
+    {
+      PRINTLN_WARNING("Master clock TIMEOUT!");
+      break;
+    }
+    default:
+    {
+      break;
+    }
+  }
+
+  return 0;
+}
+
 /* Callback function. Called when an ethernet message is received. */
 static void _receive_message(NX_UDP_SOCKET *socket) {
     NX_PACKET *packet;
@@ -92,8 +136,9 @@ static void _receive_message(NX_UDP_SOCKET *socket) {
 /* API FUNCTIONS */
 
 uint8_t ethernet_init(ethernet_node_t node_id, DriverFunction driver, OnRecieve on_recieve) {
-    
+
     uint8_t status;
+    device.ptp_utc_offset = 0; // no offset to start
 
     /* Make sure device isn't already initialized */
     if(device.is_initialized) {
@@ -162,11 +207,11 @@ uint8_t ethernet_init(ethernet_node_t node_id, DriverFunction driver, OnRecieve
         return status;
     }
 
-    /* Set up multicast groups. 
+    /* Set up multicast groups.
     *  (This iterates through every possible node combination between 0b00000001 and 0b11111111.
     *  If any of the combinations include device.node_id, that combination gets added as a multicast group.
     *  This ensures that ethernet messages can be sent to all possible combinations of recipients.)
-    * 
+    *
     *  Note: This is probably pretty inefficient. I did it so you don't have to manually set up
     *        multicast groups any time you want to send a message to a new combination of nodes,
     *        but if this setup ends up being too slow or something, feel free to get rid of it.
@@ -181,6 +226,22 @@ uint8_t ethernet_init(ethernet_node_t node_id, DriverFunction driver, OnRecieve
         }
     }
 
+    /* Create the PTP client instance */
+    status = nx_ptp_client_create(&device.ptp_client, &device.ip, 0, &device.packet_pool,
+                           _PTP_THREAD_PRIORITY, (UCHAR *)&device.ptp_stack, sizeof(device.ptp_stack),
+                           _nx_ptp_client_soft_clock_callback, NX_NULL);
+    if(status != NX_SUCCESS) {
+        PRINTLN_ERROR("Failed to create PTP client (Status: %d/%s).", status, nx_status_toString(status));
+        return status;
+    }
+
+    /* start the PTP client */
+    status = nx_ptp_client_start(&device.ptp_client, NX_NULL, 0, 0, NX_PTP_TRANSPORT_SPECIFIC_NON_802, _ptp_event_callback, NX_NULL);
+    if(status != NX_SUCCESS) {
+        PRINTLN_ERROR("Failed to start PTP client (Status: %d/%s).", status, nx_status_toString(status));
+        return status;
+    }
+
     /* Create UDP socket for broadcasting */
     status = nx_udp_socket_create(
         &device.ip,                 // IP instance
@@ -330,7 +391,19 @@ uint8_t ethernet_send_message(ethernet_message_t *message) {
     PRINTLN_INFO("got to nx_udp_socket_send() part of send message");
 
     PRINTLN_INFO("Sent ethernet message (Recipient ID: %d, Message ID: %d, Message Contents: %d).", message->recipient_id, message->message_id, message->data);
-    PRINTLN_INFO("TX complete count: %lu", tx_complete_count);
     return U_SUCCESS;
 }
-// clang-format on
+
+NX_PTP_DATE_TIME ethernet_get_time(void) {
+    NX_PTP_TIME tm;
+    NX_PTP_DATE_TIME date;
+    /* read the PTP clock */
+    nx_ptp_client_time_get(&device.ptp_client, &tm);
+
+    /* convert PTP time to UTC date and time */
+    nx_ptp_client_utility_convert_time_to_date(&tm, 0, &date);
+
+    return date;
+}
+
+// clang-format on