C:/asm/STM32-ethernet/ENC28J60prj/uip-master/uip/uip_arp.h

См. документацию.

/**
 * \addtogroup uip
 * @{
 */

/**
 * \addtogroup uiparp
 * @{
 */
 
/**
 * \file
 * Макросы и определения для модуля ARP.
 * \author Adam Dunkels <adam@dunkels.com>
 */
  

/*
 * Copyright (c) 2001-2003, Adam Dunkels.
 * Все права зарезервированы. *
 * Повторное распространение, использование в исходном и двоичном виде,
 * с модификацией или без - разрешается, если выполняются следующие
 * условия:
 * 1. Распространение исходного кода должно сохранить вышеуказанную пометку
 *    копирайта, этот список условий и следующую правовую оговорку.
 * 2. Распространение исходного кода должно сохранить вышеуказанную пометку
 *    копирайта, этот список условий и следующую правовую оговорку в
 *    документации и/или других материалах, которые будут предоставлены
 *    вместе с распространяемыми материалами.
 * 3. Имя автора не может использоваться, чтобы подтвердить или продвинуть
 *    продукты, написанные с использованием этого программного обеспечения
 *    без специального на то разрешения.
 *
 * ЭТО ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ АВТОРОМ ``КАК ЕСТЬ'', БЕЗ
 * КАКОЙ-ЛИБО ЛЮБОЙ РАСШИРЕННОЙ ИЛИ ПОДРАЗУМЕВАЕМОЙ ГАРАНТИИ, ВКЛЮЧАЯ,
 * НО НЕ ОГРАНИЧИВАЯСЬ ЭТИМ, ГАРАНТИИ ВЫСОКОГО СПРОСА И ПРИГОДНОСТИ
 * ДЛЯ КОНКРЕТНОЙ ЦЕЛИ. АВТОР НИ ПРИ КАКИХ УСЛОВИЯХ НЕ ОТВЕТСТВЕНЕН
 * ЗА ЛЮБЫЕ УБЫТКИ - ПРЯМЫЕ, КОСВЕННЫЕ, СЛУЧАЙНЫЕ, СПЕЦИАЛЬНЫЕ, ОБРАЗЦОВЫЕ
 * ИЛИ ПОСЛЕДОВАТЕЛЬНЫЕ (ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ ЭТИМ, ТРЕБОВАНИЯ
 * ЗАМЕНЫ ТОВАРА ИЛИ СЕРВИСА; ПОТЕРИ ИСПОЛЬЗОВАНИЯ, ДАННЫХ ИЛИ ВЫГОДЫ;
 * ИЛИ ПРЕКРАЩЕНИЕ БИЗНЕСА), ОДНАКО ВЫЗВАННЫЕ ПО ЛЮБОЙ ТЕОРИИ ОТВЕТСТВЕННОСТИ,
 * ЛИБО В КОНТРАКТЕ, ПРЯМОЙ ОТВЕТСТВЕННОСТИ, ЛИБО В НАРУШЕНИИ ЗАКОННЫХ ПРАВ
 * (ВКЛЮЧАЯ ТАК ИЛИ ИНАЧЕ НЕБРЕЖНОСТЬ), ВОЗНИКАЮЩИЕ ВСЕГДА ИЗ ИСПОЛЬЗОВАНИЯ
 * ЭТОГО ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ, ДАЖЕ ЕСЛИ БЫЛО ПРЕДУПРЕЖДЕНИЕ О ВОЗМОЖНОСТИ
 * ТАКОГО ПОВРЕЖДЕНИЯ.
 *
 * Этот файл является частью стека uIP TCP/IP.
 *
 * $Id: uip_arp.h,v 1.5 2006/06/11 21:46:39 adam Exp $
 *
 */

#ifndef __UIP_ARP_H__
#define __UIP_ARP_H__

#include "uip.h"


extern struct uip_eth_addr uip_ethaddr;

/**
 * Заголовок Ethernet.
 */
struct uip_eth_hdr {
  struct uip_eth_addr dest;
  struct uip_eth_addr src;
  u16_t type;
};

#define UIP_ETHTYPE_ARP 0x0806
#define UIP_ETHTYPE_IP  0x0800
#define UIP_ETHTYPE_IP6 0x86dd


/* Функция uip_arp_init() должна быть вызвана перед любыми вызовами
   всех других функций ARP. */
void uip_arp_init(void);

/* Функция uip_arp_ipin() должна быть вызвана всякий раз, когда пакет
   IP поступает через из Ethernet. Эта функция обновляет таблицу ARP
   или вставляет в неё новую привязку, если в таблице её пока нет.
   Функция подразумевает, что пакет IP с заголовком Ethernet
   находится в буфере uip_buf, и длина пакета находится в переменной
   uip_len. */
/*void uip_arp_ipin(void);*/
#define uip_arp_ipin()

/* Функция uip_arp_arpin() должна быть вызвана, когда драйвером
   Ethernet был принят пакет ARP. Эта функция также подразумевает,
   что фрейм Ethernet находится в буфере uip_buf. Когда функция
   uip_arp_arpin() делает возврат, содержимое буфера uip_buf
   должно быть отправлено через Ethernet, если значение переменной
   uip_len > 0. */
void uip_arp_arpin(void);

/* Функция uip_arp_out() должна быть вызвана, когда пакет IP должнен
   быть отправлен через Ethernet. Эта функция создает заголовок
   Ethernet перед заголовком IP в буфере uip_buf. Заголовок Ethernet
   будет иметь корректный заполненный адрес назначения Ethernet MAC, 
   если в таблице ARP имеется првязка по MAC к адресу назначения IP
   (или IP адреса роутера по умолчанию). Если такая запись привязки
   в таблице ARP не найдена, то пакет IP будет перезаписан запросом
   ARP и мы полагаемся на ретрансмит TCP для пакета, который был
   перезаписан. В любом случае переменная uip_len содержит длину
   фрейма Ethernet, который должен быть передан. */
void uip_arp_out(void);

/* Функция uip_arp_timer() должна быть вызвана каждые 10 секунд. Она
   отвечает за сброс старых записей в таблице ARP. */
void uip_arp_timer(void);

/** @} */

/**
 * \addtogroup uipconffunc
 * @{
 */


/**
 * Указывает адрес Ethernet MAC.
 *
 * Коду ARP нужно знать MAC-адрес карты Ethernet, чтобы можно было
 * отвечать на запросы ARP и генерировать рабочие заголовки Ethernet.
 *
 * \note Этот макрос только указывает адрес Ethernet MAC для кода ARP.
 * Его нельзя использовать для изменения MAC-адреса карты Ethernet.
 *
 * \param eaddr Указатель на структуру uip_eth_addr, содержащую
 * адрес Ethernet MAC карты Ethernet.
 *
 * \hideinitializer
 */
#define uip_setethaddr(eaddr) do {uip_ethaddr.addr[0] = eaddr.addr[0]; \
                              uip_ethaddr.addr[1] = eaddr.addr[1];\
                              uip_ethaddr.addr[2] = eaddr.addr[2];\
                              uip_ethaddr.addr[3] = eaddr.addr[3];\
                              uip_ethaddr.addr[4] = eaddr.addr[4];\
                              uip_ethaddr.addr[5] = eaddr.addr[5];} while(0)

/** @} */
/** @} */

#endif /* __UIP_ARP_H__ */