305 lines
12 KiB
C
305 lines
12 KiB
C
/****************************************************************************
|
|
* net/devif/devif.h
|
|
*
|
|
* Copyright (C) 2007-2009, 2013-2014 Gregory Nutt. All rights reserved.
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
|
*
|
|
* This logic was leveraged from uIP which also has a BSD-style license:
|
|
*
|
|
* Author Adam Dunkels <adam@dunkels.com>
|
|
* Copyright (c) 2001-2003, Adam Dunkels.
|
|
* All rights reserved.
|
|
*
|
|
* 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. The name of the author may not be used to endorse or promote
|
|
* products derived from this software without specific prior
|
|
* written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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_DEVIF_DEVIF_H
|
|
#define _NET_DEVIF_DEVIF_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
#ifdef CONFIG_NET
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include <errno.h>
|
|
#include <arch/irq.h>
|
|
|
|
#include <nuttx/net/arp.h>
|
|
#include <nuttx/net/ip.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
/* The following flags may be set in the set of flags before calling the
|
|
* application callback. The UIP_ACKDATA, UIP_NEWDATA, and UIP_CLOSE flags
|
|
* may be set at the same time, whereas the others are mutually exclusive.
|
|
*
|
|
* UIP_ACKDATA IN: Signifies that the outstanding data was ACKed and
|
|
* the application should send out new data instead
|
|
* of retransmitting the last data (TCP only)
|
|
* OUT: Input state must be preserved on output.
|
|
* UIP_NEWDATA IN: Set to indicate that the peer has sent us new data.
|
|
* OUT: Cleared (only) by the application logic to indicate
|
|
* that the new data was consumed, suppressing further
|
|
* attempts to process the new data.
|
|
* UIP_SNDACK IN: Not used; always zero
|
|
* OUT: Set by the application if the new data was consumed
|
|
* and an ACK should be sent in the response. (TCP only)
|
|
* UIP_REXMIT IN: Tells the application to retransmit the data that
|
|
* was last sent. (TCP only)
|
|
* OUT: Not used
|
|
* UIP_POLL IN: Used for polling the application. This is provided
|
|
* periodically from the drivers to support (1) timed
|
|
* operations, and (2) to check if the application has
|
|
* data that it wants to send
|
|
* OUT: Not used
|
|
* UIP_BACKLOG IN: There is a new connection in the backlog list set
|
|
* up by the listen() command. (TCP only)
|
|
* OUT: Not used
|
|
* UIP_CLOSE IN: The remote host has closed the connection, thus the
|
|
* connection has gone away. (TCP only)
|
|
* OUT: The application signals that it wants to close the
|
|
* connection. (TCP only)
|
|
* UIP_ABORT IN: The remote host has aborted the connection, thus the
|
|
* connection has gone away. (TCP only)
|
|
* OUT: The application signals that it wants to abort the
|
|
* connection. (TCP only)
|
|
* UIP_CONNECTED IN: We have got a connection from a remote host and have
|
|
* set up a new connection for it, or an active connection
|
|
* has been successfully established. (TCP only)
|
|
* OUT: Not used
|
|
* UIP_TIMEDOUT IN: The connection has been aborted due to too many
|
|
* retransmissions. (TCP only)
|
|
* OUT: Not used
|
|
* UIP_ECHOREPLY IN: An ICMP Echo Reply has been received. Used to support
|
|
* ICMP ping from applications. (ICMP only)
|
|
* OUT: Cleared (only) by the application logic to indicate
|
|
* that the reply was processed, suppressing further
|
|
* attempts to process the reply.
|
|
*/
|
|
|
|
#define UIP_ACKDATA (1 << 0)
|
|
#define UIP_NEWDATA (1 << 1)
|
|
#define UIP_SNDACK (1 << 2)
|
|
#define UIP_REXMIT (1 << 3)
|
|
#define UIP_POLL (1 << 4)
|
|
#define UIP_BACKLOG (1 << 5)
|
|
#define UIP_CLOSE (1 << 6)
|
|
#define UIP_ABORT (1 << 7)
|
|
#define UIP_CONNECTED (1 << 8)
|
|
#define UIP_TIMEDOUT (1 << 9)
|
|
#define UIP_ECHOREPLY (1 << 10)
|
|
|
|
#define UIP_CONN_EVENTS (UIP_CLOSE|UIP_ABORT|UIP_CONNECTED|UIP_TIMEDOUT)
|
|
|
|
/****************************************************************************
|
|
* Public Type Definitions
|
|
****************************************************************************/
|
|
|
|
/* Describes a device interface callback
|
|
*
|
|
* flink - Supports a singly linked list
|
|
* event - Provides the address of the callback function entry point.
|
|
* pvconn is a pointer to one of struct tcp_conn_s or struct
|
|
* udp_conn_s.
|
|
* priv - Holds a reference to application specific data that will
|
|
* provided
|
|
* flags - Set by the application to inform the lower layer which flags
|
|
* were and were not handled by the callback.
|
|
*/
|
|
|
|
struct net_driver_s; /* Forward reference */
|
|
struct devif_callback_s
|
|
{
|
|
FAR struct devif_callback_s *flink;
|
|
uint16_t (*event)(FAR struct net_driver_s *dev, FAR void *pvconn,
|
|
FAR void *pvpriv, uint16_t flags);
|
|
FAR void *priv;
|
|
uint16_t flags;
|
|
};
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
extern const net_ipaddr_t g_alloneaddr;
|
|
extern const net_ipaddr_t g_allzeroaddr;
|
|
|
|
/* Increasing number used for the IP ID field. */
|
|
|
|
extern uint16_t g_ipid;
|
|
|
|
/* Reassembly timer (units: deci-seconds) */
|
|
|
|
#if UIP_REASSEMBLY && !defined(CONFIG_NET_IPv6)
|
|
extern uint8_t g_reassembly_timer;
|
|
#endif
|
|
|
|
/* List of applications waiting for ICMP ECHO REPLY */
|
|
|
|
#if defined(CONFIG_NET_ICMP) && defined(CONFIG_NET_ICMP_PING)
|
|
extern struct devif_callback_s *g_echocallback;
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
#ifdef __cplusplus
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: devif_initialize
|
|
*
|
|
* Description:
|
|
* Perform initialization of the network device interface layer
|
|
*
|
|
* Parameters:
|
|
* None
|
|
*
|
|
* Return:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
void devif_initialize(void);
|
|
|
|
/****************************************************************************
|
|
* Function: devif_callback_init
|
|
*
|
|
* Description:
|
|
* Configure the pre-allocated callback structures into a free list.
|
|
* This is called internally as part of uIP initialization and should not
|
|
* be accessed from the application or socket layer.
|
|
*
|
|
* Assumptions:
|
|
* This function is called with interrupts disabled.
|
|
*
|
|
****************************************************************************/
|
|
|
|
void devif_callback_init(void);
|
|
|
|
/****************************************************************************
|
|
* Function: devif_callback_alloc
|
|
*
|
|
* Description:
|
|
* Allocate a callback container from the free list.
|
|
* This is called internally as part of uIP initialization and should not
|
|
* be accessed from the application or socket layer.
|
|
*
|
|
* Assumptions:
|
|
* This function is called with interrupts disabled.
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct devif_callback_s *devif_callback_alloc(FAR struct devif_callback_s **list);
|
|
|
|
/****************************************************************************
|
|
* Function: devif_callback_free
|
|
*
|
|
* Description:
|
|
* Return a callback container to the free list.
|
|
* This is called internally as part of uIP initialization and should not
|
|
* be accessed from the application or socket layer.
|
|
*
|
|
* Assumptions:
|
|
* This function is called with interrupts disabled.
|
|
*
|
|
****************************************************************************/
|
|
|
|
void devif_callback_free(FAR struct devif_callback_s *cb,
|
|
FAR struct devif_callback_s **list);
|
|
|
|
/****************************************************************************
|
|
* Function: devif_callback_execute
|
|
*
|
|
* Description:
|
|
* Execute a list of callbacks.
|
|
* This is called internally as part of uIP initialization and should not
|
|
* be accessed from the application or socket layer.
|
|
*
|
|
* Assumptions:
|
|
* This function is called with interrupts disabled.
|
|
*
|
|
****************************************************************************/
|
|
|
|
uint16_t devif_callback_execute(FAR struct net_driver_s *dev, FAR void *pvconn,
|
|
uint16_t flags, FAR struct devif_callback_s *list);
|
|
|
|
/****************************************************************************
|
|
* Send data on the current connection.
|
|
*
|
|
* This function is used to send out a single segment of TCP
|
|
* data. Only applications that have been invoked by uIP for event
|
|
* processing can send data.
|
|
*
|
|
* The amount of data that actually is sent out after a call to this
|
|
* function is determined by the maximum amount of data TCP allows. uIP
|
|
* will automatically crop the data so that only the appropriate
|
|
* amount of data is sent. The function tcp_mss() can be used to query
|
|
* uIP for the amount of data that actually will be sent.
|
|
*
|
|
* Note: This function does not guarantee that the sent data will
|
|
* arrive at the destination. If the data is lost in the network, the
|
|
* application will be invoked with the UIP_REXMIT flag set. The
|
|
* application will then have to resend the data using this function.
|
|
*
|
|
* data A pointer to the data which is to be sent.
|
|
*
|
|
* len The maximum amount of data bytes to be sent.
|
|
*
|
|
****************************************************************************/
|
|
|
|
void devif_send(FAR struct net_driver_s *dev, FAR const void *buf, int len);
|
|
|
|
#ifdef CONFIG_NET_IOB
|
|
struct iob_s;
|
|
void devif_iob_send(FAR struct net_driver_s *dev, FAR struct iob_s *buf,
|
|
unsigned int len, unsigned int offset);
|
|
#endif
|
|
|
|
#ifdef CONFIG_NET_PKT
|
|
void devif_pkt_send(FAR struct net_driver_s *dev, FAR const void *buf,
|
|
unsigned int len);
|
|
#endif
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* CONFIG_NET */
|
|
#endif /* _NET_DEVIF_DEVIF_H */
|