get:
Show a patch.

patch:
Update a patch.

put:
Update a patch.

GET /api/patches/130012/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 130012,
    "url": "http://patches.dpdk.org/api/patches/130012/?format=api",
    "web_url": "http://patches.dpdk.org/project/dpdk/patch/20230809050700.271534-4-simei.su@intel.com/",
    "project": {
        "id": 1,
        "url": "http://patches.dpdk.org/api/projects/1/?format=api",
        "name": "DPDK",
        "link_name": "dpdk",
        "list_id": "dev.dpdk.org",
        "list_email": "dev@dpdk.org",
        "web_url": "http://core.dpdk.org",
        "scm_url": "git://dpdk.org/dpdk",
        "webscm_url": "http://git.dpdk.org/dpdk",
        "list_archive_url": "https://inbox.dpdk.org/dev",
        "list_archive_url_format": "https://inbox.dpdk.org/dev/{}",
        "commit_url_format": ""
    },
    "msgid": "<20230809050700.271534-4-simei.su@intel.com>",
    "list_archive_url": "https://inbox.dpdk.org/dev/20230809050700.271534-4-simei.su@intel.com",
    "date": "2023-08-09T05:07:00",
    "name": "[3/3] examples/ptpclient: add frequency adjustment support",
    "commit_ref": null,
    "pull_url": null,
    "state": "changes-requested",
    "archived": true,
    "hash": "b826a213c0054762a8dec34a9119366e7a3560a5",
    "submitter": {
        "id": 1298,
        "url": "http://patches.dpdk.org/api/people/1298/?format=api",
        "name": "Simei Su",
        "email": "simei.su@intel.com"
    },
    "delegate": {
        "id": 319,
        "url": "http://patches.dpdk.org/api/users/319/?format=api",
        "username": "fyigit",
        "first_name": "Ferruh",
        "last_name": "Yigit",
        "email": "ferruh.yigit@amd.com"
    },
    "mbox": "http://patches.dpdk.org/project/dpdk/patch/20230809050700.271534-4-simei.su@intel.com/mbox/",
    "series": [
        {
            "id": 29137,
            "url": "http://patches.dpdk.org/api/series/29137/?format=api",
            "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=29137",
            "date": "2023-08-09T05:06:57",
            "name": "add frequency adjustment support for PTP timesync",
            "version": 1,
            "mbox": "http://patches.dpdk.org/series/29137/mbox/"
        }
    ],
    "comments": "http://patches.dpdk.org/api/patches/130012/comments/",
    "check": "fail",
    "checks": "http://patches.dpdk.org/api/patches/130012/checks/",
    "tags": {},
    "related": [],
    "headers": {
        "Return-Path": "<dev-bounces@dpdk.org>",
        "X-Original-To": "patchwork@inbox.dpdk.org",
        "Delivered-To": "patchwork@inbox.dpdk.org",
        "Received": [
            "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id B540743014;\n\tWed,  9 Aug 2023 06:59:10 +0200 (CEST)",
            "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 71C6743268;\n\tWed,  9 Aug 2023 06:58:56 +0200 (CEST)",
            "from mgamail.intel.com (mgamail.intel.com [192.55.52.151])\n by mails.dpdk.org (Postfix) with ESMTP id 80E5543267\n for <dev@dpdk.org>; Wed,  9 Aug 2023 06:58:54 +0200 (CEST)",
            "from fmsmga003.fm.intel.com ([10.253.24.29])\n by fmsmga107.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 08 Aug 2023 21:58:54 -0700",
            "from unknown (HELO npg-dpdk-simeisu-cvl-119d218.sh.intel.com)\n ([10.67.119.108])\n by FMSMGA003.fm.intel.com with ESMTP; 08 Aug 2023 21:58:51 -0700"
        ],
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple;\n d=intel.com; i=@intel.com; q=dns/txt; s=Intel;\n t=1691557134; x=1723093134;\n h=from:to:cc:subject:date:message-id:in-reply-to: references;\n bh=KRlg7pr+RoaXhsnmNvs/0BZvHyNQERlkHZx41naT2/A=;\n b=mQc1A0W4xSVhSeyLj2o5wfRk71/QYIxd3MQbEQ5zOcKTjKEfKoJVovb3\n 2AUrCtFt7Xo6VfaNTeweixe0ys58vksu22+C71IRRP+lppkLyPWF4e3eP\n Fvo8qm8eUPVtjB2njEtoabaXfvCh2kyQJiLXaKUIXTMNwp4JTpwQxYiFx\n dXK62ohRX1S0Qmnm29COLmEiL6ZCCvTq4vpl6Nsfs+pC3YyXm3Jrk9VnL\n eaUxSjQJ3XjtFEQEMNOVRJb9ofteAPf8O1pwthDLYu8WT6AhewFRScPXQ\n aYpXFHHTAUkxQoatCq2ZONlIUxjHUGQEjOa7PQd6lymaTJsQ9j7wb2HBY A==;",
        "X-IronPort-AV": [
            "E=McAfee;i=\"6600,9927,10795\"; a=\"351329524\"",
            "E=Sophos;i=\"6.01,158,1684825200\"; d=\"scan'208\";a=\"351329524\"",
            "E=McAfee;i=\"6600,9927,10795\"; a=\"821684816\"",
            "E=Sophos;i=\"6.01,158,1684825200\"; d=\"scan'208\";a=\"821684816\""
        ],
        "X-ExtLoop1": "1",
        "From": "Simei Su <simei.su@intel.com>",
        "To": "thomas@monjalon.net, ferruh.yigit@amd.com, andrew.rybchenko@oktetlabs.ru,\n kirill.rybalchenko@intel.com, qi.z.zhang@intel.com",
        "Cc": "dev@dpdk.org,\n\twenjun1.wu@intel.com,\n\tSimei Su <simei.su@intel.com>",
        "Subject": "[PATCH 3/3] examples/ptpclient: add frequency adjustment support",
        "Date": "Wed,  9 Aug 2023 13:07:00 +0800",
        "Message-Id": "<20230809050700.271534-4-simei.su@intel.com>",
        "X-Mailer": "git-send-email 2.9.5",
        "In-Reply-To": "<20230809050700.271534-1-simei.su@intel.com>",
        "References": "<20230809050700.271534-1-simei.su@intel.com>",
        "X-BeenThere": "dev@dpdk.org",
        "X-Mailman-Version": "2.1.29",
        "Precedence": "list",
        "List-Id": "DPDK patches and discussions <dev.dpdk.org>",
        "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>",
        "List-Archive": "<http://mails.dpdk.org/archives/dev/>",
        "List-Post": "<mailto:dev@dpdk.org>",
        "List-Help": "<mailto:dev-request@dpdk.org?subject=help>",
        "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>",
        "Errors-To": "dev-bounces@dpdk.org"
    },
    "content": "This patch applys PI servo algorithm to leverage frequency adjustment\nAPI to improve PTP timesync accuracy.\n\nThe command for starting ptpclient with PI algorithm is:\n./build/examples/dpdk-ptpclient -a 0000:81:00.0 -c 1 -n 3 -- -T 0 -p 0x1\n--controller=pi\n\nSigned-off-by: Simei Su <simei.su@intel.com>\nSigned-off-by: Wenjun Wu <wenjun1.wu@intel.com>\n---\n examples/ptpclient/ptpclient.c | 178 +++++++++++++++++++++++++++++++++++++----\n 1 file changed, 161 insertions(+), 17 deletions(-)",
    "diff": "diff --git a/examples/ptpclient/ptpclient.c b/examples/ptpclient/ptpclient.c\nindex 74a1bf5..55b63be 100644\n--- a/examples/ptpclient/ptpclient.c\n+++ b/examples/ptpclient/ptpclient.c\n@@ -43,6 +43,28 @@\n #define KERNEL_TIME_ADJUST_LIMIT  20000\n #define PTP_PROTOCOL             0x88F7\n \n+#define KP 0.7\n+#define KI 0.3\n+\n+enum servo_state {\n+\tSERVO_UNLOCKED,\n+\tSERVO_JUMP,\n+\tSERVO_LOCKED,\n+};\n+\n+struct pi_servo {\n+\tdouble offset[2];\n+\tdouble local[2];\n+\tdouble drift;\n+\tint count;\n+};\n+\n+enum controller_mode {\n+\tMODE_NONE,\n+\tMODE_PI,\n+\tMAX_ALL\n+} mode;\n+\n struct rte_mempool *mbuf_pool;\n uint32_t ptp_enabled_port_mask;\n uint8_t ptp_enabled_port_nb;\n@@ -132,6 +154,9 @@ struct ptpv2_data_slave_ordinary {\n \tuint8_t ptpset;\n \tuint8_t kernel_time_set;\n \tuint16_t current_ptp_port;\n+\tint64_t master_offset;\n+\tint64_t path_delay;\n+\tstruct pi_servo *servo;\n };\n \n static struct ptpv2_data_slave_ordinary ptp_data;\n@@ -290,36 +315,44 @@ print_clock_info(struct ptpv2_data_slave_ordinary *ptp_data)\n \t\t\tptp_data->tstamp3.tv_sec,\n \t\t\t(ptp_data->tstamp3.tv_nsec));\n \n-\tprintf(\"\\nT4 - Master Clock.  %lds %ldns \",\n+\tprintf(\"\\nT4 - Master Clock.  %lds %ldns\\n\",\n \t\t\tptp_data->tstamp4.tv_sec,\n \t\t\t(ptp_data->tstamp4.tv_nsec));\n \n-\tprintf(\"\\nDelta between master and slave clocks:%\"PRId64\"ns\\n\",\n+\tif (mode == MODE_NONE) {\n+\t\tprintf(\"\\nDelta between master and slave clocks:%\"PRId64\"ns\\n\",\n \t\t\tptp_data->delta);\n \n-\tclock_gettime(CLOCK_REALTIME, &sys_time);\n-\trte_eth_timesync_read_time(ptp_data->current_ptp_port, &net_time);\n+\t\tclock_gettime(CLOCK_REALTIME, &sys_time);\n+\t\trte_eth_timesync_read_time(ptp_data->current_ptp_port,\n+\t\t\t\t\t   &net_time);\n \n-\ttime_t ts = net_time.tv_sec;\n+\t\ttime_t ts = net_time.tv_sec;\n \n-\tprintf(\"\\n\\nComparison between Linux kernel Time and PTP:\");\n+\t\tprintf(\"\\n\\nComparison between Linux kernel Time and PTP:\");\n \n-\tprintf(\"\\nCurrent PTP Time: %.24s %.9ld ns\",\n+\t\tprintf(\"\\nCurrent PTP Time: %.24s %.9ld ns\",\n \t\t\tctime(&ts), net_time.tv_nsec);\n \n-\tnsec = (int64_t)timespec64_to_ns(&net_time) -\n+\t\tnsec = (int64_t)timespec64_to_ns(&net_time) -\n \t\t\t(int64_t)timespec64_to_ns(&sys_time);\n-\tptp_data->new_adj = ns_to_timeval(nsec);\n+\t\tptp_data->new_adj = ns_to_timeval(nsec);\n+\n+\t\tgettimeofday(&ptp_data->new_adj, NULL);\n \n-\tgettimeofday(&ptp_data->new_adj, NULL);\n+\t\ttime_t tp = ptp_data->new_adj.tv_sec;\n \n-\ttime_t tp = ptp_data->new_adj.tv_sec;\n+\t\tprintf(\"\\nCurrent SYS Time: %.24s %.6ld ns\",\n+\t\t\tctime(&tp), ptp_data->new_adj.tv_usec);\n \n-\tprintf(\"\\nCurrent SYS Time: %.24s %.6ld ns\",\n-\t\t\t\tctime(&tp), ptp_data->new_adj.tv_usec);\n+\t\tprintf(\"\\nDelta between PTP and Linux Kernel time:%\"PRId64\"ns\\n\",\n+\t\t\tnsec);\n+\t}\n \n-\tprintf(\"\\nDelta between PTP and Linux Kernel time:%\"PRId64\"ns\\n\",\n-\t\t\t\tnsec);\n+\tif (mode == MODE_PI) {\n+\t\tprintf(\"path delay: %\"PRId64\"ns\\n\", ptp_data->path_delay);\n+\t\tprintf(\"master offset: %\"PRId64\"ns\\n\", ptp_data->master_offset);\n+\t}\n \n \tprintf(\"[Ctrl+C to quit]\\n\");\n \n@@ -405,6 +438,76 @@ parse_fup(struct ptpv2_data_slave_ordinary *ptp_data)\n \t\t(((uint64_t)ntohs(origin_tstamp->sec_msb)) << 32);\n }\n \n+static double\n+pi_sample(struct pi_servo *s, double offset, double local_ts,\n+\t  enum servo_state *state)\n+{\n+\tdouble ppb = 0.0;\n+\n+\tswitch (s->count) {\n+\tcase 0:\n+\t\ts->offset[0] = offset;\n+\t\ts->local[0] = local_ts;\n+\t\t*state = SERVO_UNLOCKED;\n+\t\ts->count = 1;\n+\t\tbreak;\n+\tcase 1:\n+\t\ts->offset[1] = offset;\n+\t\ts->local[1] = local_ts;\n+\t\t*state = SERVO_UNLOCKED;\n+\t\ts->count = 2;\n+\t\tbreak;\n+\tcase 2:\n+\t\ts->drift += (s->offset[1] - s->offset[0]) /\n+\t\t\t(s->local[1] - s->local[0]);\n+\t\t*state = SERVO_UNLOCKED;\n+\t\ts->count = 3;\n+\t\tbreak;\n+\tcase 3:\n+\t\t*state = SERVO_JUMP;\n+\t\ts->count = 4;\n+\t\tbreak;\n+\tcase 4:\n+\t\ts->drift += KI * offset;\n+\t\tppb = KP * offset + s->drift;\n+\t\t*state = SERVO_LOCKED;\n+\t\tbreak;\n+\t}\n+\n+\treturn ppb;\n+}\n+\n+static void\n+ptp_adjust_freq(struct ptpv2_data_slave_ordinary *ptp_data)\n+{\n+\tuint64_t t1_ns, t2_ns;\n+\tdouble adj_freq;\n+\tenum servo_state state = SERVO_UNLOCKED;\n+\n+\tt1_ns = timespec64_to_ns(&ptp_data->tstamp1);\n+\tt2_ns = timespec64_to_ns(&ptp_data->tstamp2);\n+\tptp_data->master_offset = t2_ns - t1_ns - ptp_data->path_delay;\n+\tif (!ptp_data->path_delay)\n+\t\treturn;\n+\n+\tadj_freq = pi_sample(ptp_data->servo, ptp_data->master_offset,\n+\t\t\t     t2_ns, &state);\n+\tswitch (state) {\n+\tcase SERVO_UNLOCKED:\n+\t\tbreak;\n+\tcase SERVO_JUMP:\n+\t\trte_eth_timesync_adjust_time(ptp_data->portid,\n+\t\t\t\t\t     -ptp_data->master_offset);\n+\t\tt1_ns = 0;\n+\t\tt2_ns = 0;\n+\t\tbreak;\n+\tcase SERVO_LOCKED:\n+\t\trte_eth_timesync_adjust_fine(ptp_data->portid,\n+\t\t\t\t\t     -(long)(adj_freq * 65.536));\n+\t\tbreak;\n+\t}\n+}\n+\n static void\n send_delay_request(struct ptpv2_data_slave_ordinary *ptp_data)\n {\n@@ -536,6 +639,21 @@ update_kernel_time(void)\n \n }\n \n+static void\n+clock_path_delay(struct ptpv2_data_slave_ordinary *ptp_data)\n+{\n+\tuint64_t t1_ns, t2_ns, t3_ns, t4_ns;\n+\tint64_t pd;\n+\n+\tt1_ns = timespec64_to_ns(&ptp_data->tstamp1);\n+\tt2_ns = timespec64_to_ns(&ptp_data->tstamp2);\n+\tt3_ns = timespec64_to_ns(&ptp_data->tstamp3);\n+\tt4_ns = timespec64_to_ns(&ptp_data->tstamp4);\n+\n+\tpd = (t2_ns - t3_ns) + (t4_ns - t1_ns);\n+\tptp_data->path_delay = pd / 2;\n+}\n+\n /*\n  * Parse the DELAY_RESP message.\n  */\n@@ -560,6 +678,9 @@ parse_drsp(struct ptpv2_data_slave_ordinary *ptp_data)\n \t\t\t\t((uint64_t)ntohl(rx_tstamp->sec_lsb)) |\n \t\t\t\t(((uint64_t)ntohs(rx_tstamp->sec_msb)) << 32);\n \n+\t\t\tif (mode == MODE_PI)\n+\t\t\t\tclock_path_delay(ptp_data);\n+\n \t\t\tptp_data->current_ptp_port = ptp_data->portid;\n \n \t\t\t/* Update kernel time if enabled in app parameters. */\n@@ -608,11 +729,14 @@ parse_ptp_frames(uint16_t portid, struct rte_mbuf *m) {\n \t\t\tbreak;\n \t\tcase FOLLOW_UP:\n \t\t\tparse_fup(&ptp_data);\n+\t\t\tif (mode == MODE_PI)\n+\t\t\t\tptp_adjust_freq(&ptp_data);\n \t\t\tsend_delay_request(&ptp_data);\n \t\t\tbreak;\n \t\tcase DELAY_RESP:\n \t\t\tparse_drsp(&ptp_data);\n-\t\t\tptp_adjust_time(&ptp_data);\n+\t\t\tif (mode == MODE_NONE)\n+\t\t\t\tptp_adjust_time(&ptp_data);\n \t\t\tprint_clock_info(&ptp_data);\n \t\t\tbreak;\n \t\tdefault:\n@@ -709,7 +833,10 @@ ptp_parse_args(int argc, char **argv)\n \tchar **argvopt;\n \tint option_index;\n \tchar *prgname = argv[0];\n-\tstatic struct option lgopts[] = { {NULL, 0, 0, 0} };\n+\tstatic struct option lgopts[] = {\n+\t\t{\"controller\", 1, 0, 0},\n+\t\t{NULL, 0, 0, 0}\n+\t};\n \n \targvopt = argv;\n \n@@ -737,6 +864,11 @@ ptp_parse_args(int argc, char **argv)\n \n \t\t\tptp_data.kernel_time_set = ret;\n \t\t\tbreak;\n+\t\tcase 0:\n+\t\t\tif (!strcmp(lgopts[option_index].name, \"controller\"))\n+\t\t\t\tif (!strcmp(optarg, \"pi\"))\n+\t\t\t\t\tmode = MODE_PI;\n+\t\t\tbreak;\n \n \t\tdefault:\n \t\t\tprint_usage(prgname);\n@@ -780,6 +912,15 @@ main(int argc, char *argv[])\n \t\trte_exit(EXIT_FAILURE, \"Error with PTP initialization\\n\");\n \t/* >8 End of parsing specific arguments. */\n \n+\tif (mode == MODE_PI) {\n+\t\tptp_data.servo = malloc(sizeof(*(ptp_data.servo)));\n+\t\tif (!ptp_data.servo)\n+\t\t\trte_exit(EXIT_FAILURE, \"no memory for servo\\n\");\n+\n+\t\tptp_data.servo->drift = 0;\n+\t\tptp_data.servo->count = 0;\n+\t}\n+\n \t/* Check that there is an even number of ports to send/receive on. */\n \tnb_ports = rte_eth_dev_count_avail();\n \n@@ -819,6 +960,9 @@ main(int argc, char *argv[])\n \t/* Call lcore_main on the main core only. */\n \tlcore_main();\n \n+\tif (mode == MODE_PI)\n+\t\tfree(ptp_data.servo);\n+\n \t/* clean up the EAL */\n \trte_eal_cleanup();\n \n",
    "prefixes": [
        "3/3"
    ]
}