105 lines
3.7 KiB
C
105 lines
3.7 KiB
C
|
/****************************************************************************
|
||
|
|
* net/arp/arp.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_ARP_ARP_H
|
||
|
|
#define __NET_ARP_ARP_H
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Included Files
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Public Types
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Public Function Prototypes
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
#ifdef CONFIG_NET_ARP
|
||
|
|
/****************************************************************************
|
||
|
|
* Name: arp_reset
|
||
|
|
*
|
||
|
|
* Description:
|
||
|
|
* Re-initialize the ARP table.
|
||
|
|
*
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
void arp_reset(void);
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Function: arp_timer_initialize
|
||
|
|
*
|
||
|
|
* Description:
|
||
|
|
* Initialized the 10 second timer that is need by the ARP logic in order
|
||
|
|
* to age ARP address associations
|
||
|
|
*
|
||
|
|
* Parameters:
|
||
|
|
* None
|
||
|
|
*
|
||
|
|
* Returned Value:
|
||
|
|
* None
|
||
|
|
*
|
||
|
|
* Assumptions:
|
||
|
|
* Called once at system initialization time
|
||
|
|
*
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
void arp_timer_initialize(void);
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Name: arp_timer
|
||
|
|
*
|
||
|
|
* Description:
|
||
|
|
* This function performs periodic timer processing in the ARP module
|
||
|
|
* and should be called at regular intervals. The recommended interval
|
||
|
|
* is 10 seconds between the calls. It is responsible for flushing old
|
||
|
|
* entries in the ARP table.
|
||
|
|
*
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
void arp_timer(void);
|
||
|
|
|
||
|
|
#else /* CONFIG_NET_ARP */
|
||
|
|
|
||
|
|
/* If ARP is disabled, stub out all ARP interfaces */
|
||
|
|
|
||
|
|
# define arp_reset()
|
||
|
|
# define arp_timer_initialize(void)
|
||
|
|
# define arp_timer()
|
||
|
|
|
||
|
|
#endif /* CONFIG_NET_ARP */
|
||
|
|
#endif /* __UIP-NEIGHBOR_H__ */
|