190 lines
6.2 KiB
C
190 lines
6.2 KiB
C
/****************************************************************************
|
|
* net/utils/utils.h
|
|
*
|
|
* Copyright (C) 2014 Gregory Nutt. All rights reserved.
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
* 3. Neither the name NuttX nor the names of its contributors may be
|
|
* used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
|
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
|
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __NET_UTILS_UTILS_H
|
|
#define __NET_UTILS_UTILS_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
#ifdef __cplusplus
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
struct net_driver_s; /* Forward reference */
|
|
struct timeval; /* Forward reference */
|
|
|
|
/****************************************************************************
|
|
* Function: net_lockinitialize
|
|
*
|
|
* Description:
|
|
* Initialize the locking facility
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_NET_NOINTS
|
|
void net_lockinitialize(void);
|
|
#else
|
|
# define net_lockinitialize()
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Function: net_dsec2timeval
|
|
*
|
|
* Description:
|
|
* Convert a decisecond value to a struct timeval. Needed by getsockopt()
|
|
* to report timeout values.
|
|
*
|
|
* Parameters:
|
|
* dsec The decisecond value to convert
|
|
* tv The struct timeval to receive the converted value
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
* Assumptions:
|
|
*
|
|
****************************************************************************/
|
|
|
|
void net_dsec2timeval(uint16_t dsec, FAR struct timeval *tv);
|
|
|
|
/****************************************************************************
|
|
* Function: net_dsec2tick
|
|
*
|
|
* Description:
|
|
* Convert a decisecond value to a system clock ticks. Used by IGMP logic.
|
|
*
|
|
* Parameters:
|
|
* dsec The decisecond value to convert
|
|
*
|
|
* Returned Value:
|
|
* The decisecond value expressed as system clock ticks
|
|
*
|
|
****************************************************************************/
|
|
|
|
unsigned int net_dsec2tick(int dsec);
|
|
|
|
/****************************************************************************
|
|
* Function: net_timeval2dsec
|
|
*
|
|
* Description:
|
|
* Convert a struct timeval to deciseconds. Needed by setsockopt() to
|
|
* save new timeout values.
|
|
*
|
|
* Parameters:
|
|
* tv The struct timeval to convert
|
|
*
|
|
* Returned Value:
|
|
* The converted value
|
|
*
|
|
* Assumptions:
|
|
*
|
|
****************************************************************************/
|
|
|
|
unsigned int net_timeval2dsec(FAR struct timeval *tv);
|
|
|
|
/****************************************************************************
|
|
* Name: tcp_chksum
|
|
*
|
|
* Description:
|
|
* Calculate the TCP checksum of the packet in d_buf and d_appdata.
|
|
*
|
|
* The TCP checksum is the Internet checksum of data contents of the
|
|
* TCP segment, and a pseudo-header as defined in RFC793.
|
|
*
|
|
* Note: The d_appdata pointer that points to the packet data may
|
|
* point anywhere in memory, so it is not possible to simply calculate
|
|
* the Internet checksum of the contents of the d_buf buffer.
|
|
*
|
|
* Returned Value:
|
|
* The TCP checksum of the TCP segment in d_buf and pointed to by
|
|
* d_appdata.
|
|
*
|
|
****************************************************************************/
|
|
|
|
uint16_t tcp_chksum(FAR struct net_driver_s *dev);
|
|
|
|
/****************************************************************************
|
|
* Name: udp_chksum
|
|
*
|
|
* Description:
|
|
* Calculate the UDP checksum of the packet in d_buf and d_appdata.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_NET_UDP_CHECKSUMS
|
|
uint16_t udp_chksum(FAR struct net_driver_s *dev);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: icmp_chksum
|
|
*
|
|
* Description:
|
|
* Calculate the checksum of the ICMP message
|
|
*
|
|
****************************************************************************/
|
|
|
|
uint16_t icmp_chksum(FAR struct net_driver_s *dev, int len);
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __NET_UTILS_UTILS_H */
|