/****************************************************************************
* net/devif/devif_poll.c
*
* Copyright (C) 2007-2010, 2012, 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.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#ifdef CONFIG_NET
#include <debug.h>
#include <nuttx/net/netconfig.h>
#include <nuttx/net/netdev.h>
#include "devif/devif.h"
#include "arp/arp.h"
#include "tcp/tcp.h"
#include "udp/udp.h"
#include "pkt/pkt.h"
#include "icmp/icmp.h"
#include "igmp/igmp.h"
/****************************************************************************
* Private Data
****************************************************************************/
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Function: devif_poll_pkt_connections
*
* Description:
* Poll all packet connections for available packets to send.
*
* Assumptions:
* This function is called from the MAC device driver and may be called from
* the timer interrupt/watchdog handle level.
*
****************************************************************************/
#ifdef CONFIG_NET_PKT
static int devif_poll_pkt_connections(FAR struct net_driver_s *dev,
devif_poll_callback_t callback)
{
FAR struct pkt_conn_s *pkt_conn = NULL;
int bstop = 0;
/* Traverse all of the allocated packet connections and perform the poll action */
while (!bstop && (pkt_conn = pkt_nextconn(pkt_conn)))
{
/* Perform the packet TX poll */
pkt_poll(dev, pkt_conn);
/* Call back into the driver */
bstop = callback(dev);
}
return bstop;
}
#endif /* CONFIG_NET_PKT */
/****************************************************************************
* Function: devif_poll_icmp
*
* Description:
* Poll all UDP connections for available packets to send.
*
* Assumptions:
* This function is called from the MAC device driver and may be called from
* the timer interrupt/watchdog handle level.
*
****************************************************************************/
#if defined(CONFIG_NET_ICMP) && defined(CONFIG_NET_ICMP_PING)
static inline int devif_poll_icmp(FAR struct net_driver_s *dev,
devif_poll_callback_t callback)
{
/* Perform the UDP TX poll */
icmp_poll(dev);
/* Call back into the driver */
return callback(dev);
}
#endif /* CONFIG_NET_ICMP && CONFIG_NET_ICMP_PING */
/****************************************************************************
* Function: devif_poll_igmp
*
* Description:
* Poll all IGMP connections for available packets to send.
*
* Assumptions:
* This function is called from the MAC device driver and may be called from
* the timer interrupt/watchdog handle level.
*
****************************************************************************/
#ifdef CONFIG_NET_IGMP
static inline int devif_poll_igmp(FAR struct net_driver_s *dev,
devif_poll_callback_t callback)
{
/* Perform the IGMP TX poll */
igmp_poll(dev);
/* Call back into the driver */
return callback(dev);
}
#endif /* CONFIG_NET_IGMP */
/****************************************************************************
* Function: devif_poll_udp_connections
*
* Description:
* Poll all UDP connections for available packets to send.
*
* Assumptions:
* This function is called from the MAC device driver and may be called
* from the timer interrupt/watchdog handle level.
*
****************************************************************************/
#ifdef CONFIG_NET_UDP
static int devif_poll_udp_connections(FAR struct net_driver_s *dev,
devif_poll_callback_t callback)
{
FAR struct udp_conn_s *conn = NULL;
int bstop = 0;
/* Traverse all of the allocated UDP connections and perform the poll action */
while (!bstop && (conn = udp_nextconn(conn)))
{
/* Perform the UDP TX poll */
udp_poll(dev, conn);
/* Call back into the driver */
bstop = callback(dev);
}
return bstop;
}
#endif /* CONFIG_NET_UDP */
/****************************************************************************
* Function: devif_poll_tcp_connections
*
* Description:
* Poll all UDP connections for available packets to send.
*
* Assumptions:
* This function is called from the MAC device driver and may be called
* from the timer interrupt/watchdog handle level.
*
****************************************************************************/
#ifdef CONFIG_NET_TCP
static inline int devif_poll_tcp_connections(FAR struct net_driver_s *dev,
devif_poll_callback_t callback)
{
FAR struct tcp_conn_s *conn = NULL;
int bstop = 0;
/* Traverse all of the active TCP connections and perform the poll action */
while (!bstop && (conn = tcp_nextconn(conn)))
{
/* Perform the TCP TX poll */
tcp_poll(dev, conn);
/* Call back into the driver */
bstop = callback(dev);
}
return bstop;
}
#else
# define devif_poll_tcp_connections(dev, callback) (0)
#endif
/****************************************************************************
* Function: devif_poll_tcp_timer
*
* Description:
* The TCP timer has expired. Update TCP timing state in each active,
* TCP connection.
*
* Assumptions:
* This function is called from the MAC device driver and may be called from
* the timer interrupt/watchdog handle level.
*
****************************************************************************/
#ifdef CONFIG_NET_TCP
static inline int devif_poll_tcp_timer(FAR struct net_driver_s *dev,
devif_poll_callback_t callback, int hsec)
{
FAR struct tcp_conn_s *conn = NULL;
int bstop = 0;
/* Traverse all of the active TCP connections and perform the poll action */
while (!bstop && (conn = tcp_nextconn(conn)))
{
/* Perform the TCP timer poll */
tcp_timer(dev, conn, hsec);
/* Call back into the driver */
bstop = callback(dev);
}
return bstop;
}
#else
# define devif_poll_tcp_timer(dev, callback, hsec) (0)
#endif
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Function: devif_poll
*
* Description:
* This function will traverse each active uIP connection structure and
* will perform TCP and UDP polling operations. devif_poll() may be called
* asynchronously with the network driver can accept another outgoing
* packet.
*
* This function will call the provided callback function for every active
* connection. Polling will continue until all connections have been polled
* or until the user-supplied function returns a non-zero value (which it
* should do only if it cannot accept further write data).
*
* When the callback function is called, there may be an outbound packet
* waiting for service in the uIP packet buffer, and if so the d_len field
* is set to a value larger than zero. The device driver should then send
* out the packet.
*
* Assumptions:
* This function is called from the MAC device driver and may be called
* from the timer interrupt/watchdog handle level.
*
****************************************************************************/
int devif_poll(FAR struct net_driver_s *dev, devif_poll_callback_t callback)
{
int bstop;
/* Traverse all of the active packet connections and perform the poll
* action.
*/
#ifdef CONFIG_NET_ARP_SEND
/* Check for pending ARP requests */
bstop = arp_poll(dev, callback);
if (!bstop)
#endif
#ifdef CONFIG_NET_PKT
{
/* Check for pending packet socket transfer */
bstop = devif_poll_pkt_connections(dev, callback);
}
if (!bstop)
#endif
#ifdef CONFIG_NET_IGMP
{
/* Check for pending IGMP messages */
bstop = devif_poll_igmp(dev, callback);
}
if (!bstop)
#endif
#ifdef CONFIG_NET_TCP
{
/* Traverse all of the active TCP connections and perform the poll
* action.
*/
bstop = devif_poll_tcp_connections(dev, callback);
}
if (!bstop)
#endif
#ifdef CONFIG_NET_UDP
{
/* Traverse all of the allocated UDP connections and perform
* the poll action
*/
bstop = devif_poll_udp_connections(dev, callback);
}
if (!bstop)
#endif
#if defined(CONFIG_NET_ICMP) && defined(CONFIG_NET_ICMP_PING)
{
/* Traverse all of the tasks waiting to send an ICMP ECHO request. */
bstop = devif_poll_icmp(dev, callback);
}
if (!bstop)
#endif
{
/* Nothing more to do */
}
return bstop;
}
/****************************************************************************
* Function: devif_timer
*
* Description:
* These function will traverse each active uIP connection structure and
* perform TCP timer operations (and UDP polling operations). The Ethernet
* driver MUST implement logic to periodically call devif_timer().
*
* This function will call the provided callback function for every active
* connection. Polling will continue until all connections have been polled
* or until the user-supplied function returns a non-zero value (which it
* should do only if it cannot accept further write data).
*
* When the callback function is called, there may be an outbound packet
* waiting for service in the uIP packet buffer, and if so the d_len field
* is set to a value larger than zero. The device driver should then send
* out the packet.
*
* Assumptions:
* This function is called from the MAC device driver and may be called from
* the timer interrupt/watchdog handle level.
*
****************************************************************************/
int devif_timer(FAR struct net_driver_s *dev, devif_poll_callback_t callback,
int hsec)
{
int bstop;
/* Increment the timer used by the IP reassembly logic */
#if defined(CONFIG_NET_TCP_REASSEMBLY) && !defined(CONFIG_NET_IPv6)
if (g_reassembly_timer != 0 &&
g_reassembly_timer < CONFIG_NET_TCP_REASS_MAXAGE)
{
g_reassembly_timer += hsec;
}
#endif
/* Traverse all of the active packet connections and perform the poll
* action.
*/
#ifdef CONFIG_NET_ARP_SEND
/* Check for pending ARP requests */
bstop = arp_poll(dev, callback);
if (!bstop)
#endif
#ifdef CONFIG_NET_PKT
{
/* Check for pending packet socket transfer */
bstop = devif_poll_pkt_connections(dev, callback);
}
if (!bstop)
#endif
#ifdef CONFIG_NET_IGMP
{
/* Check for pending IGMP messages */
bstop = devif_poll_igmp(dev, callback);
}
if (!bstop)
#endif
#ifdef CONFIG_NET_TCP
{
/* Traverse all of the active TCP connections and perform the
* timer action.
*/
bstop = devif_poll_tcp_timer(dev, callback, hsec);
}
if (!bstop)
#endif
#ifdef CONFIG_NET_UDP
{
/* Traverse all of the allocated UDP connections and perform
* the timer action.
*/
bstop = devif_poll_udp_connections(dev, callback);
}
if (!bstop)
#endif
#if defined(CONFIG_NET_ICMP) && defined(CONFIG_NET_ICMP_PING)
{
/* Traverse all of the tasks waiting to send an ICMP ECHO request. */
bstop = devif_poll_icmp(dev, callback);
}
if (!bstop)
#endif
{
/* Nothing to do */
}
return bstop;
}
#endif /* CONFIG_NET */
