sio.h

00001 /*
00002  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
00003  * All rights reserved. 
00004  * 
00005  * Redistribution and use in source and binary forms, with or without modification, 
00006  * are permitted provided that the following conditions are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright notice,
00009  *    this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright notice,
00011  *    this list of conditions and the following disclaimer in the documentation
00012  *    and/or other materials provided with the distribution.
00013  * 3. The name of the author may not be used to endorse or promote products
00014  *    derived from this software without specific prior written permission. 
00015  *
00016  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 
00017  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
00018  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
00019  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
00020  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
00021  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
00022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
00023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
00024  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
00025  * OF SUCH DAMAGE.
00026  *
00027  * This file is part of the lwIP TCP/IP stack.
00028  */
00029 
00030 /*
00031  * This is the interface to the platform specific serial IO module
00032  * It needs to be implemented by those platforms which need SLIP or PPP
00033  */
00034 
00035 #ifndef __SIO_H__
00036 #define __SIO_H__
00037 
00038 #include "lwip/arch.h"
00039 
00040 #ifdef __cplusplus
00041 extern "C" {
00042 #endif
00043 
00044 /* If you want to define sio_fd_t elsewhere or differently,
00045    define this in your cc.h file. */
00046 #ifndef __sio_fd_t_defined
00047 typedef void * sio_fd_t;
00048 #endif
00049 
00050 /* The following functions can be defined to something else in your cc.h file
00051    or be implemented in your custom sio.c file. */
00052 
00053 #ifndef sio_open
00054 sio_fd_t sio_open(u8_t);
00055 #endif
00056 
00057 #ifndef sio_send
00058 void sio_send(u8_t, sio_fd_t);
00059 #endif
00060 
00061 #ifndef sio_recv
00062 u8_t sio_recv(sio_fd_t);
00063 #endif
00064 
00065 #ifndef sio_read
00066 u32_t sio_read(sio_fd_t, u8_t *, u32_t);
00067 #endif
00068 
00069 #ifndef sio_write
00070 u32_t sio_write(sio_fd_t, u8_t *, u32_t);
00071 #endif
00072 
00073 #ifndef sio_read_abort
00074 void sio_read_abort(sio_fd_t);
00075 #endif
00076 
00077 #ifdef __cplusplus
00078 }
00079 #endif
00080 
00081 #endif /* __SIO_H__ */