nts_debug.h
Go to the documentation of this file.
1 /**
2  * @file nts_debug.h
3  * @brief Data logging functions for debugging purpose (NTS)
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.4
29  **/
30 
31 #ifndef _NTS_DEBUG_H
32 #define _NTS_DEBUG_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "nts/nts_common.h"
37 #include "debug.h"
38 
39 //C++ guard
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 
45 /**
46  * @brief Parameter value/name binding
47  **/
48 
49 typedef struct
50 {
52  const char_t *name;
53 } NtsParamName;
54 
55 
56 //Check current trace level
57 #if (NTS_TRACE_LEVEL >= TRACE_LEVEL_DEBUG)
58  void ntsDumpNtsKeRecords(const uint8_t *records, size_t length);
59  void ntsDumpNtsKeRecord(const NtsKeRecord *record, size_t length);
60 #else
61  #define ntsDumpNtsKeRecords(records, length)
62  #define ntsDumpNtsKeRecord(record, length)
63 #endif
64 
65 void ntsDumpNtsNextProtoNegoRecord(const uint8_t *body, size_t length);
66 void ntsDumpAeadAlgoNegoRecord(const uint8_t *body, size_t length);
67 void ntsDumpNtpv4ServerNegoRecord(const uint8_t *body, size_t length);
68 void ntsDumpNtpv4PortNegoRecord(const uint8_t *body, size_t length);
69 void ntsDumpErrorRecord(const uint8_t *body, size_t length);
70 void ntsDumpWarningRecord(const uint8_t *body, size_t length);
71 
72 const char_t *ntsGetParamName(uint_t value, const NtsParamName *paramList,
73  size_t paramListLen);
74 
75 //C++ guard
76 #ifdef __cplusplus
77 }
78 #endif
79 
80 #endif
void ntsDumpNtsKeRecords(const uint8_t *records, size_t length)
Dump NTS-KE records.
Definition: nts_debug.c:83
const char_t * name
Definition: nts_debug.h:52
void ntsDumpNtsNextProtoNegoRecord(const uint8_t *body, size_t length)
Dump NTS Next Protocol Negotiation record.
Definition: nts_debug.c:204
void ntsDumpNtpv4PortNegoRecord(const uint8_t *body, size_t length)
Dump NTPv4 Port Negotiation record.
Definition: nts_debug.c:341
void ntsDumpNtsKeRecord(const NtsKeRecord *record, size_t length)
Dump NTS-KE record.
Definition: nts_debug.c:121
uint_t value
Definition: nts_debug.h:51
void ntsDumpErrorRecord(const uint8_t *body, size_t length)
Dump Error record.
Definition: nts_debug.c:233
void ntsDumpWarningRecord(const uint8_t *body, size_t length)
Dump Warning record.
Definition: nts_debug.c:262
Parameter value/name binding.
Definition: nts_debug.h:50
void ntsDumpAeadAlgoNegoRecord(const uint8_t *body, size_t length)
Dump AEAD Algorithm Negotiation record.
Definition: nts_debug.c:286
uint8_t length
Definition: tcp.h:368
char char_t
Definition: compiler_port.h:48
const char_t * ntsGetParamName(uint_t value, const NtsParamName *paramList, size_t paramListLen)
Convert a parameter to string representation.
Definition: nts_debug.c:366
NtsKeRecord
Definition: nts_common.h:107
uint8_t value[]
Definition: tcp.h:369
void ntsDumpNtpv4ServerNegoRecord(const uint8_t *body, size_t length)
Dump NTPv4 Server Negotiation record.
Definition: nts_debug.c:315
Definitions common to NTS client and server.
unsigned int uint_t
Definition: compiler_port.h:50
TCP/IP stack core.
uint8_t body[]
Definition: nts_common.h:106
Debugging facilities.