ppp_debug.h File Reference

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

#include "core/net.h"
#include "ppp/ppp.h"
#include "ppp/lcp.h"
#include "ppp/ipcp.h"
#include "debug.h"

Go to the source code of this file.

Functions
error_t	pppDumpPacket (const PppPacket *packet, size_t length, PppProtocol protocol)
	Dump LCP/NCP packet for debugging purpose. More...
error_t	lcpDumpPacket (const PppPacket *packet, size_t length)
	Dump LCP packet for debugging purpose. More...
error_t	ncpDumpPacket (const PppPacket *packet, size_t length, PppProtocol protocol)
	Dump NCP packet for debugging purpose. More...
error_t	papDumpPacket (const PppPacket *packet, size_t length)
	Dump PAP packet for debugging purpose. More...
error_t	chapDumpPacket (const PppPacket *packet, size_t length)
	Dump CHAP packet for debugging purpose. More...
error_t	lcpDumpOptions (const PppOption *option, size_t length)
	Dump LCP options for debugging purpose. More...
error_t	ipcpDumpOptions (const PppOption *option, size_t length)
	Dump IPCP options for debugging purpose. More...
error_t	ipv6cpDumpOptions (const PppOption *option, size_t length)
	Dump IPV6CP options for debugging purpose. More...

Detailed Description

Data logging functions for debugging purpose (PPP)

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 ppp_debug.h.

Function Documentation

chapDumpPacket()

error_t chapDumpPacket	(	const PppPacket *	packet,
		size_t	length
	)

Dump CHAP packet for debugging purpose.

Parameters

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

Returns

Error code

Definition at line 608 of file ppp_debug.c.

ipcpDumpOptions()

error_t ipcpDumpOptions	(	const PppOption *	option,
		size_t	length
	)

Dump IPCP options for debugging purpose.

Parameters

[in]	option	Pointer to the option list
[in]	length	Length of the option list, in bytes

Returns

Error code

Definition at line 800 of file ppp_debug.c.

ipv6cpDumpOptions()

error_t ipv6cpDumpOptions	(	const PppOption *	option,
		size_t	length
	)

Dump IPV6CP options for debugging purpose.

Parameters

[in]	option	Pointer to the option list
[in]	length	Length of the option list, in bytes

Returns

Error code

Definition at line 880 of file ppp_debug.c.

lcpDumpOptions()

error_t lcpDumpOptions	(	const PppOption *	option,
		size_t	length
	)

Dump LCP options for debugging purpose.

Parameters

[in]	option	Pointer to the option list
[in]	length	Length of the option list, in bytes

Returns

Error code

Definition at line 721 of file ppp_debug.c.

lcpDumpPacket()

error_t lcpDumpPacket	(	const PppPacket *	packet,
		size_t	length
	)

Dump LCP packet for debugging purpose.

Parameters

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

Returns

Error code

Definition at line 188 of file ppp_debug.c.

ncpDumpPacket()

error_t ncpDumpPacket	(	const PppPacket *	packet,
		size_t	length,
		PppProtocol	protocol
	)

Dump NCP packet for debugging purpose.

Parameters

[in]	packet	Pointer to the NCP packet
[in]	length	Length of the packet, in bytes
[in]	protocol	Protocol field

Returns

Error code

Definition at line 350 of file ppp_debug.c.

papDumpPacket()

error_t papDumpPacket	(	const PppPacket *	packet,
		size_t	length
	)

Dump PAP packet for debugging purpose.

Parameters

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

Returns

Error code

Definition at line 484 of file ppp_debug.c.

pppDumpPacket()

error_t pppDumpPacket	(	const PppPacket *	packet,
		size_t	length,
		PppProtocol	protocol
	)

Dump LCP/NCP packet for debugging purpose.

Parameters

[in]	packet	Pointer to the LCP packet
[in]	length	Length of the packet, in bytes
[in]	protocol	Protocol field

Returns

Error code

Definition at line 143 of file ppp_debug.c.