core/net/slipdev.h

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