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

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

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

/**
 * \defgroup uiparch Функции uIP, специфичные для архитектуры
 * @{
 *
 * Функции в модуле, который привязан к архитектуре, для ускоренного
 * вычисления контрольной суммы IP и 32-битных сложений.
 *
 * Вычисление контрольной суммы IP - наиболее затратная по вычислениям
 * операция в стеке TCP/IP, поэтому её имеет смысл переписать на
 * эффективном ассемблере. Назначание модуля uip-arch - позволить
 * реализовать функции контрольной суммы на ассемблере, привязанном
 * к архитектуре.
 *
 */

/**
 * \file
 * Декларирование функций, специфичных для архитектуры.
 * \author Adam Dunkels <adam@dunkels.com>
 */

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

#ifndef __UIP_ARCH_H__
#define __UIP_ARCH_H__

#include "uip.h"

/**
 * Выполнение 32-разрядного сложения.
 *
 * ПОскольку не все архитектуры, для которых предназначена uIP,
 * имеют встроенную 32-битную арифметику, uIP использует внешнюю функцию
 * на языке C для выполнения 32-битных прибавлений, требуемых в обработке
 * протоколов TCP. Эта функция должна сложить 2 аргумента, и поместить
 * результат в глобальную переменную uip_acc32.
 *
 * \note 32-битное целое указывается параметром op32, и результат в
 * переменной uip_acc32 с сетевым порядком байт (big endian, старший байт
 * идет первым, младший последним).
 *
 * \param op32 Указатель на 4-байтный массив, представляющий 32-битное
 * целое число с сетевым порядком байт (big endian).
 *
 * \param op16 16-битное целое с порядком байт хоста.
 */
void uip_add32(u8_t *op32, u16_t op16);

/**
 * Вычисление контрольной суммы Internet от данных буфера.
 *
 * Контрольная сумма Internet является дополнением до единицы от суммы
 * с дополнением до единицы всех 16-битных слов в буфере.
 *
 * См. RFC1071.
 *
 * \note Эта функция не вызывается в текущей версии uIP, но будущие
 * версии могут её использовать.
 *
 * \param buf Указатель на буфер, от которого будет вычисляться
 * контрольная сумма.
 *
 * \param len Длина буфера, от данных которого вычисляется контрольная
 * сумма.
 *
 * \return Контрольная сумма Internet буфера.
 */
u16_t uip_chksum(u16_t *buf, u16_t len);

/**
 * Вычисляет контрольную сумму заголовка IP от заголовка пакета, который
 * находится в uip_buf.
 *
 * Контрольная сумма заголовка является контрольной суммой Internet
 * от 20 байт заголовка IP.
 *
 * \return Контрольная сумма заголовка IP от заголовка IP, который находится
 * в буфере uip_buf.
 */
u16_t uip_ipchksum(void);

/**
 * Вычисление контрольной суммы TCP пакета, находящегося в uip_buf
 * и uip_appdata.
 *
 * Контрольная сумма TCP является контрольной суммой Internet от содержимого
 * данных сегмента TCP и псевдозаголовка, определенного в RFC793.
 *
 * \note uip_appdata является указателем, указывающим на данные пакета,
 * и он может указывать на любое место в памяти, так что нельзя просто 
 * вычислить контрольную сумму Internet от содержимого буфера uip_buf.
 *
 * \return Контрольная сумма TCP сегмента TCP, находящегося в uip_buf,
 * в том месте, на которое указывает uip_appdata.
 */
u16_t uip_tcpchksum(void);

u16_t uip_udpchksum(void);

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

#endif /* __UIP_ARCH_H__ */