slipif.h

00001 /*
00002  * Copyright (c) 2001, Swedish Institute of Computer Science.
00003  * All rights reserved. 
00004  *
00005  * Redistribution and use in source and binary forms, with or without 
00006  * modification, are permitted provided that the following conditions 
00007  * are met: 
00008  * 1. Redistributions of source code must retain the above copyright 
00009  *    notice, this list of conditions and the following disclaimer. 
00010  * 2. Redistributions in binary form must reproduce the above copyright 
00011  *    notice, this list of conditions and the following disclaimer in the 
00012  *    documentation and/or other materials provided with the distribution. 
00013  * 3. Neither the name of the Institute nor the names of its contributors 
00014  *    may be used to endorse or promote products derived from this software 
00015  *    without specific prior written permission. 
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND 
00018  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
00020  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE 
00021  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
00022  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 
00023  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
00024  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
00025  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 
00026  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
00027  * SUCH DAMAGE. 
00028  *
00029  * This file is part of the lwIP TCP/IP stack.
00030  * 
00031  * Author: Adam Dunkels <adam@sics.se>
00032  *
00033  */
00034 #ifndef __NETIF_SLIPIF_H__
00035 #define __NETIF_SLIPIF_H__
00036 
00037 #include "lwip/opt.h"
00038 #include "lwip/netif.h"
00039 
00040 /** Set this to 1 to start a thread that blocks reading on the serial line
00041  * (using sio_read()).
00042  */
00043 #ifndef SLIP_USE_RX_THREAD
00044 #define SLIP_USE_RX_THREAD !NO_SYS
00045 #endif
00046 
00047 /** Set this to 1 to enable functions to pass in RX bytes from ISR context.
00048  * If enabled, slipif_received_byte[s]() process incoming bytes and put assembled
00049  * packets on a queue, which is fed into lwIP from slipif_poll().
00050  * If disabled, slipif_poll() polls the serila line (using sio_tryread()).
00051  */
00052 #ifndef SLIP_RX_FROM_ISR
00053 #define SLIP_RX_FROM_ISR 0
00054 #endif
00055 
00056 /** Set this to 1 (default for SLIP_RX_FROM_ISR) to queue incoming packets
00057  * received by slipif_received_byte[s]() as long as PBUF_POOL pbufs are available.
00058  * If disabled, packets will be dropped if more than one packet is received.
00059  */
00060 #ifndef SLIP_RX_QUEUE
00061 #define SLIP_RX_QUEUE SLIP_RX_FROM_ISR
00062 #endif
00063 
00064 #ifdef __cplusplus
00065 extern "C" {
00066 #endif
00067 
00068 err_t slipif_init(struct netif * netif);
00069 void slipif_poll(struct netif *netif);
00070 #if SLIP_RX_FROM_ISR
00071 void slipif_process_rxqueue(struct netif *netif);
00072 void slipif_received_byte(struct netif *netif, u8_t data);
00073 void slipif_received_bytes(struct netif *netif, u8_t *data, u8_t len);
00074 #endif /* SLIP_RX_FROM_ISR */
00075 
00076 #ifdef __cplusplus
00077 }
00078 #endif
00079  
00080 #endif 
00081