+/**
+ * @file
+ * Sequential API External module
+ *
+ */
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
* @param conn the netconn over which to send data
* @param buf a netbuf containing the data to send
* @param addr the remote IP address to which to send the data
- * @param addr the remote port to which to send the data
+ * @param port the remote port to which to send the data
* @return ERR_OK if data was sent, any other err_t on error
*/
err_t
+/**
+ * @file
+ * Sequential API Internal module
+ *
+ */
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
+/**
+ * @file
+ * Error Management module
+ *
+ */
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
+/**
+ * @file
+ * Network Interface Sequential API module
+ *
+ */
+
/*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
+/**
+ * @file
+ * Sockets BSD-Like API module
+ *
+ */
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
+/**
+ * @file
+ * Sequential API Main thread module
+ *
+ */
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
/**
* @file
- *
* Dynamic Host Configuration Protocol client
+ *
*/
/*
* with this value (easy to match with a packet analyzer) */
static u32_t xid = 0xABCD0000;
-/** DHCP client state machine functions */
+/* DHCP client state machine functions */
static void dhcp_handle_ack(struct netif *netif);
static void dhcp_handle_nak(struct netif *netif);
static void dhcp_handle_offer(struct netif *netif);
static err_t dhcp_rebind(struct netif *netif);
static void dhcp_set_state(struct dhcp *dhcp, u8_t new_state);
-/** receive, unfold, parse and free incoming messages */
+/* receive, unfold, parse and free incoming messages */
static void dhcp_recv(void *arg, struct udp_pcb *pcb, struct pbuf *p, struct ip_addr *addr, u16_t port);
static err_t dhcp_unfold_reply(struct dhcp *dhcp);
static u8_t *dhcp_get_option_ptr(struct dhcp *dhcp, u8_t option_type);
static u32_t dhcp_get_option_long(u8_t *ptr);
static void dhcp_free_reply(struct dhcp *dhcp);
-/** set the DHCP timers */
+/* set the DHCP timers */
static void dhcp_timeout(struct netif *netif);
static void dhcp_t1_timeout(struct netif *netif);
static void dhcp_t2_timeout(struct netif *netif);
-/** build outgoing messages */
-/** create a DHCP request, fill in common headers */
+/* build outgoing messages */
+/* create a DHCP request, fill in common headers */
static err_t dhcp_create_request(struct netif *netif);
-/** free a DHCP request */
+/* free a DHCP request */
static void dhcp_delete_request(struct netif *netif);
-/** add a DHCP option (type, then length in bytes) */
+/* add a DHCP option (type, then length in bytes) */
static void dhcp_option(struct dhcp *dhcp, u8_t option_type, u8_t option_len);
-/** add option values */
+/* add option values */
static void dhcp_option_byte(struct dhcp *dhcp, u8_t value);
static void dhcp_option_short(struct dhcp *dhcp, u16_t value);
static void dhcp_option_long(struct dhcp *dhcp, u32_t value);
-/** always add the DHCP options trailer to end and pad */
+/* always add the DHCP options trailer to end and pad */
static void dhcp_option_trailer(struct dhcp *dhcp);
/**
+/**
+ * @file
+ * Functions common to all TCP/IPv4 modules, such as the Internet checksum and the
+ * byte order functions.
+ *
+ */
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
*
*/
-
-/* inet.c
- *
- * Functions common to all TCP/IP modules, such as the Internet checksum and the
- * byte order functions.
- *
- */
-
-
#include "lwip/opt.h"
#include "lwip/arch.h"
* Convert numeric IP address into decimal dotted ASCII representation.
* returns ptr to static buffer; not reentrant!
*
- * @paran addr ip address in network order to convert
+ * @param addr ip address in network order to convert
* @return pointer to a global static (!) buffer that holds the ASCII
* represenation of addr
*/
+/**
+ * @file
+ * Functions common to all TCP/IPv6 modules, such as the Internet checksum and the
+ * byte order functions.
+ *
+ */
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
*
*/
-
-/* inet6.c
- *
- * Functions common to all TCP/IP modules, such as the Internet checksum and the
- * byte order functions.
- *
- */
-
-
#include "lwip/opt.h"
#include "lwip/def.h"
#include "lwip/inet.h"
-
-
/* chksum:
*
* Sums up all 16 bit words in a memory portion. Also includes any odd byte.
/**
* @file
- *
* AutoIP Automatic LinkLocal IP Configuration
+ *
*/
/*
+/**
+ * @file
+ * ICMP - Internet Control Message Protocol
+ *
+ */
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
/**
* @file
- *
* IGMP - Internet Group Management Protocol
+ *
*/
/*
/**
* Send an igmp packet to a specific group.
*
- * @param the group to which to send the packet
+ * @param group the group to which to send the packet
* @param type the type of igmp packet to send
*/
void
-/* @file
- *
- * This is the IP layer implementation for incoming and outgoing IP traffic.
+/**
+ * @file
+ * This is the IPv4 layer implementation for incoming and outgoing IP traffic.
*
* @see ip_frag.c
*
*/
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
+/**
+ * @file
+ * This is the IPv4 address tools implementation.
+ *
+ */
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
-/* @file
- *
- * This is the IP packet segmentation and reassembly implementation.
+/**
+ * @file
+ * This is the IPv4 packet segmentation and reassembly implementation.
*
*/
-/** @file
- *
+/**
+ * @file
* Dynamic memory manager
*
*/
+/**
+ * @file
+ * Dynamic pool memory manager
+ *
+ */
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
* Get an element from a specific pool.
*
* @param type the pool to get an element from
+ * @param file file name calling this function
+ * @param line number of line where this function is called
*/
void *
#if MEMP_OVERFLOW_CHECK
/**
* @file
- *
* lwIP network interface abstraction
+ *
*/
/*
/**
* @file
- *
* Implementation of raw protocol PCBs for low-level handling of
* different types of protocols besides (or overriding) those
* already available in lwIP.
*
*/
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
* finds a corresponding RAW PCB and calls the corresponding receive
* callback function.
*
- * @param pbuf pbuf to be demultiplexed to a RAW PCB.
- * @param netif network interface on which the datagram was received.
- * @Return - 1 if the packet has been eaten by a RAW PCB receive
+ * @param p pbuf to be demultiplexed to a RAW PCB.
+ * @param inp network interface on which the datagram was received.
+ * @return - 1 if the packet has been eaten by a RAW PCB receive
* callback function. The caller MAY NOT not reference the
* packet any longer, and MAY NOT call pbuf_free().
* @return - 0 if packet is not eaten (pbuf is still referenced by the
*
* @param pcb the raw pcb which to send
* @param p the IP payload to send
- * @param ipaddr the destination address of the IP packet
*
*/
err_t
* Initializes sysDescr pointers.
*
* @param str if non-NULL then copy str pointer
- * @param strlen points to string length, excluding zero terminator
+ * @param len points to string length, excluding zero terminator
*/
void snmp_set_sysdesr(u8_t *str, u8_t *len)
{
* Initializes sysContact pointers,
* e.g. ptrs to non-volatile memory external to lwIP.
*
- * @param str if non-NULL then copy str pointer
- * @param strlen points to string length, excluding zero terminator
+ * @param ocstr if non-NULL then copy str pointer
+ * @param ocstrlen points to string length, excluding zero terminator
*/
void snmp_set_syscontact(u8_t *ocstr, u8_t *ocstrlen)
{
* Initializes sysName pointers,
* e.g. ptrs to non-volatile memory external to lwIP.
*
- * @param str if non-NULL then copy str pointer
- * @param strlen points to string length, excluding zero terminator
+ * @param ocstr if non-NULL then copy str pointer
+ * @param ocstrlen points to string length, excluding zero terminator
*/
void snmp_set_sysname(u8_t *ocstr, u8_t *ocstrlen)
{
* Initializes sysLocation pointers,
* e.g. ptrs to non-volatile memory external to lwIP.
*
- * @param str if non-NULL then copy str pointer
- * @param strlen points to string length, excluding zero terminator
+ * @param ocstr if non-NULL then copy str pointer
+ * @param ocstrlen points to string length, excluding zero terminator
*/
void snmp_set_syslocation(u8_t *ocstr, u8_t *ocstrlen)
{
* into index tree.
*
* @param dflt non-zero for the default rte, zero for network rte
- * @param netif points to network interface for this rte
+ * @param ni points to network interface for this rte
*
* @todo record sysuptime for _this_ route when it is installed
* (needed for ipRouteAge) in the netif.
* from index tree.
*
* @param dflt non-zero for the default rte, zero for network rte
- * @param netif points to network interface for this rte or NULL
+ * @param ni points to network interface for this rte or NULL
* for default route to be removed.
*/
void snmp_delete_iprteidx_tree(u8_t dflt, struct netif *ni)
/**
* Conversion from lwIP netif to ifIndex
* @param netif points to a netif struct
- * @param ifindex points to s32_t object sub-identifier
+ * @param ifidx points to s32_t object sub-identifier
*/
void
snmp_netiftoifindex(struct netif *netif, s32_t *ifidx)
+/**
+ * @file
+ * Statistics module
+ *
+ */
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
+/**
+ * @file
+ * lwIP Operating System abstraction
+ *
+ */
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
/**
* Wait for a semaphore with timeout (specified in ms)
*
+ * @param sem semaphore to wait
* @param timeout timeout in ms (0: wait forever)
* @return 0 on timeout, 1 otherwise
*/
/**
* @file
- *
* Transmission Control Protocol for IP
*
* This file contains common functions for the TCP implementation, such as functinos
/**
* Purges the PCB and removes it from a PCB list. Any delayed ACKs are sent first.
*
+ * @param pcblist PCB list to purge.
* @param pcb tcp_pcb to purge. The pcb itself is also deallocated!
*/
void
/**
* @file
- *
* Transmission Control Protocol, incoming traffic
*
* The input processing functions of the TCP layer.
/**
* @file
- *
* Transmission Control Protocol, outgoing traffic
*
* The output functions of TCP.
* User Datagram Protocol module
*
*/
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
*
* @param pcb the pcb for wich to set the recv callback
* @param recv function pointer of the callback function
- * @param arg additional argument to pass to the callback function
+ * @param recv_arg additional argument to pass to the callback function
*/
void
udp_recv(struct udp_pcb *pcb,
+/**
+ * @file
+ * Ethernet Interface Skeleton
+ *
+ */
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
+/**
+ * @file
+ * Loop Interface
+ *
+ */
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
+/**
+ * @file
+ * SLIP Interface
+ *
+ */
+
/*
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
* All rights reserved.
* Call the arch specific sio_open and remember
* the opened device in the state field of the netif.
*
- * @param nf the lwip network interface structure for this slipif
+ * @param netif the lwip network interface structure for this slipif
* @return ERR_OK if serial line could be opened,
* ERR_IF is serial line couldn't be opened
*
projects / pes-rpp / rpp-lwip.git / commitdiff