Webserver+3d print
« Back to documentation index
ppp.c File Reference
PPP (Point-to-Point Protocol)
More...
Go to the source code of this file.
void pppGetDefaultSettings (PppSettings *settings) Initialize settings with default values. error_t pppInit (PppContext *context, const PppSettings *settings) PPP initialization. error_t pppSetTimeout (NetInterface *interface, systime_t timeout) Set timeout value for blocking operations. error_t pppSetAuthInfo (NetInterface *interface, const char_t *username, const char_t *password) Set PPP authentication information. bool_t pppCheckPassword (NetInterface *interface, const char_t *password) Password verification. error_t pppSendAtCommand (NetInterface *interface, const char_t *data) Send AT command. error_t pppReceiveAtCommand (NetInterface *interface, char_t *data, size_t size) Wait for an incoming AT command. error_t pppConnect (NetInterface *interface) Establish a PPP connection. error_t pppClose (NetInterface *interface) Close a PPP connection. void pppTick (NetInterface *interface) PPP timer handler. void pppProcessFrame (NetInterface *interface, uint8_t *frame, size_t length) Process an incoming PPP frame. error_t pppSendFrame (NetInterface *interface, NetBuffer *buffer, size_t offset, uint16_t protocol) Send a PPP frame. size_t pppParseFrameHeader (const uint8_t *frame, size_t length, uint16_t *protocol) Parse PPP frame header. uint16_t pppCalcFcs (const uint8_t *data, size_t length) FCS calculation. uint16_t pppCalcFcsEx (const NetBuffer *buffer, size_t offset, size_t length) Calculate FCS over a multi-part buffer. NetBuffer * pppAllocBuffer (size_t length, size_t *offset) Allocate a buffer to hold a PPP frame.
Detailed Description
PPP (Point-to-Point Protocol)
Copyright (C) 2010-2017 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: 1.7.6 Definition in file ppp.c .
Function Documentation
NetBuffer * pppAllocBuffer (
size_t
length ,
size_t *
offset
)
Allocate a buffer to hold a PPP frame.
Parameters:
[in] length Desired payload length [out] offset Offset to the first byte of the payload
Returns: The function returns a pointer to the newly allocated buffer. If the system is out of resources, NULL is returned Definition at line 1263 of file ppp.c .
uint16_t pppCalcFcs
(
const uint8_t *
data ,
size_t
length
)
FCS calculation.
Parameters:
[in] data Pointer to the data over which to calculate the FCS [in] length Number of bytes to process
Returns: Resulting FCS value Definition at line 1178 of file ppp.c .
uint16_t pppCalcFcsEx
(
const NetBuffer *
buffer ,
size_t
offset ,
size_t
length
)
Calculate FCS over a multi-part buffer.
Parameters:
[in] buffer Pointer to the multi-part buffer [in] offset Offset from the beginning of the buffer [in] length Number of bytes to process
Returns: Resulting FCS value Definition at line 1206 of file ppp.c .
bool_t pppCheckPassword
(
NetInterface *
interface ,
const char_t *
password
)
Password verification.
Parameters:
[in] interface Underlying network interface [in] password NULL-terminated string containing the password to be checked
Returns: TRUE if the password is valid, else FALSE Definition at line 269 of file ppp.c .
error_t pppClose (
NetInterface *
interface )
Close a PPP connection.
Parameters:
[in] interface Underlying network interface
Returns: Error code Definition at line 725 of file ppp.c .
error_t pppConnect (
NetInterface *
interface )
Establish a PPP connection.
Parameters:
[in] interface Underlying network interface
Returns: Error code Definition at line 457 of file ppp.c .
Initialize settings with default values.
Parameters:
[out] settings Structure that contains PPP settings
Definition at line 94 of file ppp.c .
PPP initialization.
Parameters:
[in] context Pointer to the PPP context [in] settings PPP specific settings
Returns: Error code Definition at line 120 of file ppp.c .
size_t pppParseFrameHeader
(
const uint8_t *
frame ,
size_t
length ,
uint16_t *
protocol
)
Parse PPP frame header.
Parameters:
[in] frame Pointer to the PPP frame [in] length Length of the frame, in bytes [out] protocol Value of the Protocol field
Returns: If the PPP header was successfully parsed, the function returns the size of the PPP header, in bytes. If a parsing error occurred, zero is returned Definition at line 1106 of file ppp.c .
void pppProcessFrame
(
NetInterface *
interface ,
uint8_t *
frame ,
size_t
length
)
Process an incoming PPP frame.
Parameters:
[in] interface Underlying network interface [in] frame Incoming PPP frame to process [in] length Total frame length
Definition at line 887 of file ppp.c .
error_t pppReceiveAtCommand (
NetInterface *
interface ,
char_t *
data ,
size_t
size
)
Wait for an incoming AT command.
Parameters:
[in] interface Underlying network interface [out] data Buffer where to store the incoming AT command [in] size Size of the buffer, in bytes
Returns: Error code Definition at line 379 of file ppp.c .
error_t pppSendAtCommand (
NetInterface *
interface ,
const char_t *
data
)
Send AT command.
Parameters:
[in] interface Underlying network interface [in] data NULL-terminated string that contains the AT command to be sent
Returns: Error code Definition at line 316 of file ppp.c .
error_t pppSendFrame (
NetInterface *
interface ,
NetBuffer * buffer ,
size_t
offset ,
uint16_t
protocol
)
Send a PPP frame.
Parameters:
[in] interface Underlying network interface [in] buffer Multi-part buffer containing the data [in] offset Offset to the first data byte [in] protocol Protocol field value
Returns: Error code Definition at line 1004 of file ppp.c .
error_t pppSetAuthInfo (
NetInterface *
interface ,
const char_t *
username ,
const char_t *
password
)
Set PPP authentication information.
Parameters:
[in] interface Underlying network interface [in] username NULL-terminated string containing the user name to be used [in] password NULL-terminated string containing the password to be used
Returns: Error code Definition at line 231 of file ppp.c .
error_t pppSetTimeout (
NetInterface *
interface ,
systime_t
timeout
)
Set timeout value for blocking operations.
Parameters:
[in] interface Underlying network interface [in] timeout Maximum time to wait
Returns: Error code Definition at line 195 of file ppp.c .
void pppTick
(
NetInterface *
interface )
PPP timer handler.
This routine must be periodically called by the TCP/IP stack to manage retransmissions
Parameters:
[in] interface Underlying network interface
Definition at line 844 of file ppp.c .
Sergey Pastor
1.7.2