git.sur5r.net Git - freertos/blob - Demo/Common/ethernet/FreeRTOS-uIP/uiplib.h

   1 /**\r
   2  * \file\r
   3  * Various uIP library functions.\r
   4  * \author\r
   5  * Adam Dunkels <adam@sics.se>\r
   6  *\r
   7  */\r
   8 \r
   9 /*\r
  10  * Copyright (c) 2002, Adam Dunkels.\r
  11  * All rights reserved.\r
  12  *\r
  13  * Redistribution and use in source and binary forms, with or without\r
  14  * modification, are permitted provided that the following conditions\r
  15  * are met:\r
  16  * 1. Redistributions of source code must retain the above copyright\r
  17  *    notice, this list of conditions and the following disclaimer.\r
  18  * 2. Redistributions in binary form must reproduce the above\r
  19  *    copyright notice, this list of conditions and the following\r
  20  *    disclaimer in the documentation and/or other materials provided\r
  21  *    with the distribution.\r
  22  * 3. The name of the author may not be used to endorse or promote\r
  23  *    products derived from this software without specific prior\r
  24  *    written permission.\r
  25  *\r
  26  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS\r
  27  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
  28  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY\r
  30  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE\r
  32  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
  33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,\r
  34  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\r
  35  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\r
  36  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  37  *\r
  38  * This file is part of the uIP TCP/IP stack\r
  39  *\r
  40  * $Id: uiplib.h,v 1.1 2006/06/07 09:15:19 adam Exp $\r
  41  *\r
  42  */\r
  43 #ifndef __UIPLIB_H__\r
  44 #define __UIPLIB_H__\r
  45 \r
  46 /**\r
  47  * \addtogroup uipconvfunc\r
  48  * @{\r
  49  */\r
  50 \r
  51 /**\r
  52  * Convert a textual representation of an IP address to a numerical representation.\r
  53  *\r
  54  * This function takes a textual representation of an IP address in\r
  55  * the form a.b.c.d and converts it into a 4-byte array that can be\r
  56  * used by other uIP functions.\r
  57  *\r
  58  * \param addrstr A pointer to a string containing the IP address in\r
  59  * textual form.\r
  60  *\r
  61  * \param addr A pointer to a 4-byte array that will be filled in with\r
  62  * the numerical representation of the address.\r
  63  *\r
  64  * \retval 0 If the IP address could not be parsed.\r
  65  * \retval Non-zero If the IP address was parsed.\r
  66  */\r
  67 unsigned char uiplib_ipaddrconv(char *addrstr, unsigned char *addr);\r
  68 \r
  69 /** @} */\r
  70 \r
  71 #endif /* __UIPLIB_H__ */\r