git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/uIP_Demo_Rowley_ARM7/uip/slipdev.h

   1 /**\r
   2  * \addtogroup slip\r
   3  * @{\r
   4  */\r
   5 \r
   6 /**\r
   7  * \file\r
   8  * SLIP header file.\r
   9  * \author Adam Dunkels <adam@dunkels.com>\r
  10  */\r
  11 \r
  12 /*\r
  13  * Copyright (c) 2001, Adam Dunkels.\r
  14  * All rights reserved. \r
  15  *\r
  16  * Redistribution and use in source and binary forms, with or without \r
  17  * modification, are permitted provided that the following conditions \r
  18  * are met: \r
  19  * 1. Redistributions of source code must retain the above copyright \r
  20  *    notice, this list of conditions and the following disclaimer. \r
  21  * 2. Redistributions in binary form must reproduce the above copyright \r
  22  *    notice, this list of conditions and the following disclaimer in the \r
  23  *    documentation and/or other materials provided with the distribution. \r
  24  * 3. The name of the author may not be used to endorse or promote\r
  25  *    products derived from this software without specific prior\r
  26  *    written permission.  \r
  27  *\r
  28  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS\r
  29  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
  30  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
  31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY\r
  32  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE\r
  34  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
  35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,\r
  36  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\r
  37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\r
  38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  \r
  39  *\r
  40  * This file is part of the uIP TCP/IP stack.\r
  41  *\r
  42  * $Id: slipdev.h,v 1.1.2.3 2003/10/06 22:42:51 adam Exp $\r
  43  *\r
  44  */\r
  45 \r
  46 #ifndef __SLIPDEV_H__\r
  47 #define __SLIPDEV_H__\r
  48 \r
  49 #include "uip.h"\r
  50 \r
  51 /**\r
  52  * Put a character on the serial device.\r
  53  *\r
  54  * This function is used by the SLIP implementation to put a character\r
  55  * on the serial device. It must be implemented specifically for the\r
  56  * system on which the SLIP implementation is to be run.\r
  57  *\r
  58  * \param c The character to be put on the serial device.\r
  59  */\r
  60 void slipdev_char_put(u8_t c);\r
  61 \r
  62 /**\r
  63  * Poll the serial device for a character.\r
  64  *\r
  65  * This function is used by the SLIP implementation to poll the serial\r
  66  * device for a character. It must be implemented specifically for the\r
  67  * system on which the SLIP implementation is to be run.\r
  68  *\r
  69  * The function should return immediately regardless if a character is\r
  70  * available or not. If a character is available it should be placed\r
  71  * at the memory location pointed to by the pointer supplied by the\r
  72  * arguement c.\r
  73  *\r
  74  * \param c A pointer to a byte that is filled in by the function with\r
  75  * the received character, if available.\r
  76  *\r
  77  * \retval 0 If no character is available.\r
  78  * \retval Non-zero If a character is available.\r
  79  */\r
  80 u8_t slipdev_char_poll(u8_t *c);\r
  81 \r
  82 void slipdev_init(void);\r
  83 void slipdev_send(void);\r
  84 u16_t slipdev_poll(void);\r
  85 \r
  86 #endif /* __SLIPDEV_H__ */\r
  87 \r
  88 /** @} */\r