lwip/src/include/lwip/sio.h

   1 /*
   2  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without modification,
   6  * are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *    this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,
  11  *    this list of conditions and the following disclaimer in the documentation
  12  *    and/or other materials provided with the distribution.
  13  * 3. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  19  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  25  * OF SUCH DAMAGE.
  26  *
  27  * This file is part of the lwIP TCP/IP stack.
  28  */
  29
  30 /*
  31  * This is the interface to the platform specific serial IO module
  32  * It needs to be implemented by those platforms which need SLIP or PPP
  33  */
  34
  35 #include "lwip/arch.h"
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 #ifndef __sio_fd_t_defined
  42 typedef void * sio_fd_t;
  43 #endif
  44
  45 #ifndef sio_open
  46 sio_fd_t sio_open(u8_t);
  47 #endif
  48
  49 #ifndef sio_send
  50 void sio_send(u8_t, sio_fd_t);
  51 #endif
  52
  53 #ifndef sio_recv
  54 u8_t sio_recv(sio_fd_t);
  55 #endif
  56
  57 #ifndef sio_read
  58 u32_t sio_read(sio_fd_t, u8_t *, u32_t);
  59 #endif
  60
  61 #ifndef sio_write
  62 u32_t sio_write(sio_fd_t, u8_t *, u32_t);
  63 #endif
  64
  65 #ifndef sio_read_abort
  66 void sio_read_abort(sio_fd_t);
  67 #endif
  68
  69 #ifdef __cplusplus
  70 }
  71 #endif