ntp_debug.c File Reference

Data logging functions for debugging purpose (NTP) More...

#include "core/net.h"
#include "ntp/ntp_debug.h"
#include "debug.h"

Go to the source code of this file.

Macros
#define	TRACE_LEVEL   NTP_TRACE_LEVEL

Functions
void	ntpDumpPacket (const NtpHeader *packet, size_t length)
	Dump NTP packet for debugging purpose. More...
void	ntpDumpExtensions (const uint8_t *extensions, size_t length)
	Dump NTP extension fields. More...
void	ntpDumpExtension (const NtpExtension *extension, size_t length)
	Dump NTP extension field. More...
void	ntpDumpNtsAeadExtension (const NtpNtsAeadExtension *extension, size_t length)
	Dump NTS Authenticator and Encrypted Extension Fields extension. More...
void	ntpDumpTimestamp (const NtpTimestamp *timestamp)
	Dump NTP timestamp. More...
const char_t *	ntpGetParamName (uint_t value, const NtpParamName *paramList, size_t paramListLen)
	Convert a parameter to string representation. More...

Variables
const NtpParamName	ntpLeapIndicatorList []
const NtpParamName	ntpVersionList []
const NtpParamName	ntpModeList []
const NtpParamName	ntpStartumList []
const NtpParamName	ntpExtensionTypeList []

Detailed Description

Data logging functions for debugging purpose (NTP)

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.4.4

Definition in file ntp_debug.c.

Macro Definition Documentation

TRACE_LEVEL

#define TRACE_LEVEL   NTP_TRACE_LEVEL

Definition at line 32 of file ntp_debug.c.

Function Documentation

ntpDumpExtension()

void ntpDumpExtension	(	const NtpExtension *	extension,
		size_t	length
	)

Dump NTP extension field.

Parameters

[in]	extension	Pointer to the extension field
[in]	length	Length of the extension field, in bytes

Definition at line 246 of file ntp_debug.c.

ntpDumpExtensions()

void ntpDumpExtensions	(	const uint8_t *	extensions,
		size_t	length
	)

Dump NTP extension fields.

Parameters

[in]	extensions	Pointer to the extension fields
[in]	length	Total length of the extension fields, in bytes

Definition at line 212 of file ntp_debug.c.

ntpDumpNtsAeadExtension()

void ntpDumpNtsAeadExtension	(	const NtpNtsAeadExtension *	extension,
		size_t	length
	)

Dump NTS Authenticator and Encrypted Extension Fields extension.

Parameters

[in]	extension	Pointer to the extension field
[in]	length	Length of the extension field, in bytes

Definition at line 295 of file ntp_debug.c.

ntpDumpPacket()

void ntpDumpPacket	(	const NtpHeader *	packet,
		size_t	length
	)

Dump NTP packet for debugging purpose.

Parameters

[in]	packet	Pointer to the NTP packet to dump
[in]	length	Length of the packet, in bytes

Definition at line 108 of file ntp_debug.c.

ntpDumpTimestamp()

void ntpDumpTimestamp

(

const NtpTimestamp *

timestamp

)

Dump NTP timestamp.

Parameters

[in]

timestamp

Pointer to the NTP timestamp

Definition at line 331 of file ntp_debug.c.

ntpGetParamName()

const char_t* ntpGetParamName	(	uint_t	value,
		const NtpParamName *	paramList,
		size_t	paramListLen
	)

Convert a parameter to string representation.

Parameters

[in]	value	Parameter value
[in]	paramList	List of acceptable parameters
[in]	paramListLen	Number of entries in the list

Returns

NULL-terminated string describing the parameter

Definition at line 348 of file ntp_debug.c.

Variable Documentation

ntpExtensionTypeList

const NtpParamName ntpExtensionTypeList[]

Initial value:

=
{
   {NTP_EXTENSION_TYPE_NO_OPERATION_REQ,        "No-Operation Request"},
   {NTP_EXTENSION_TYPE_UNIQUE_ID,               "Unique Identifier"},
   {NTP_EXTENSION_TYPE_NTS_COOKIE,              "NTS Cookie"},
   {NTP_EXTENSION_TYPE_NTS_COOKIE_PLACEHOLDER,  "NTS Cookie Placeholder"},
   {NTP_EXTENSION_TYPE_NTS_AEAD,                "NTS Authenticator and Encrypted Extension Fields"},
   {NTP_EXTENSION_TYPE_NO_OPERATION_RESP,       "No-Operation Response"},
   {NTP_EXTENSION_TYPE_NO_OPERATION_ERROR_RESP, "No-Operation Error Response"}
}

Definition at line 90 of file ntp_debug.c.

ntpLeapIndicatorList

const NtpParamName ntpLeapIndicatorList[]

Initial value:

=
{
   {NTP_LI_NO_WARNING,           "no warning"},
   {NTP_LI_LAST_MIN_HAS_61_SECS, "last minute has 61 seconds"},
   {NTP_LI_LAST_MIN_HAS_59_SECS, "last minute has 59 seconds"},
   {NTP_LI_ALARM_CONDITION,      "alarm condition"}
}

Definition at line 43 of file ntp_debug.c.

ntpModeList

const NtpParamName ntpModeList[]

Initial value:

=
{
   {NTP_MODE_SYMMETRIC_ACTIVE,  "symmetric active"},
   {NTP_MODE_SYMMETRIC_PASSIVE, "symmetric passive"},
   {NTP_MODE_CLIENT,            "client"},
   {NTP_MODE_SERVER,            "server"},
   {NTP_MODE_BROADCAST,         "broadcast"}
}

Definition at line 59 of file ntp_debug.c.

ntpStartumList

const NtpParamName ntpStartumList[]

Initial value:

=
{
   {NTP_STRATUM_KISS_OF_DEATH, "kiss-of-death message"},
   {NTP_STRATUM_PRIMARY,       "primary"},
   {NTP_STRATUM_SECONDARY_2,   "secondary"},
   {NTP_STRATUM_SECONDARY_3,   "secondary"},
   {NTP_STRATUM_SECONDARY_4,   "secondary"},
   {NTP_STRATUM_SECONDARY_5,   "secondary"},
   {NTP_STRATUM_SECONDARY_6,   "secondary"},
   {NTP_STRATUM_SECONDARY_7,   "secondary"},
   {NTP_STRATUM_SECONDARY_8,   "secondary"},
   {NTP_STRATUM_SECONDARY_9,   "secondary"},
   {NTP_STRATUM_SECONDARY_10,  "secondary"},
   {NTP_STRATUM_SECONDARY_11,  "secondary"},
   {NTP_STRATUM_SECONDARY_12,  "secondary"},
   {NTP_STRATUM_SECONDARY_13,  "secondary"},
   {NTP_STRATUM_SECONDARY_14,  "secondary"},
   {NTP_STRATUM_SECONDARY_15,  "secondary"}
}

Definition at line 69 of file ntp_debug.c.

ntpVersionList

const NtpParamName ntpVersionList[]

Initial value:

=
{
   {NTP_VERSION_3, "NTPv3"},
   {NTP_VERSION_4, "NTPv4"}
}

Definition at line 52 of file ntp_debug.c.