ntp_debug.h

Go to the documentation of this file.

/**
 * @file ntp_debug.h
 * @brief Data logging functions for debugging purpose (NTP)
 *
 * @section 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
 **/
 
#ifndef _NTP_DEBUG_H
#define _NTP_DEBUG_H
 
//Dependencies
#include "core/net.h"
#include "ntp/ntp_common.h"
#include "debug.h"
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
/**
 * @brief Parameter value/name binding
 **/
 
typedef struct
{
   uint_t value;
   const char_t *name;
} NtpParamName;
 
 
//Check current trace level
#if (NTP_TRACE_LEVEL >= TRACE_LEVEL_DEBUG)
   void ntpDumpPacket(const NtpHeader *packet, size_t length);
   void ntpDumpExtensions(const uint8_t *extension, size_t length);
#else
   #define ntpDumpPacket(packet, length)
   #define ntpDumpExtensions(extension, length)
#endif
 
void ntpDumpExtension(const NtpExtension *extension, size_t length);
 
void ntpDumpNtsAeadExtension(const NtpNtsAeadExtension *extension,
   size_t length);
 
void ntpDumpTimestamp(const NtpTimestamp *timestamp);
 
const char_t *ntpGetParamName(uint_t value, const NtpParamName *paramList,
   size_t paramListLen);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif