1*10465441SEvalZero /** 2*10465441SEvalZero * @file 3*10465441SEvalZero * 4*10465441SEvalZero * SLIP netif API 5*10465441SEvalZero */ 6*10465441SEvalZero 7*10465441SEvalZero /* 8*10465441SEvalZero * Copyright (c) 2001, Swedish Institute of Computer Science. 9*10465441SEvalZero * All rights reserved. 10*10465441SEvalZero * 11*10465441SEvalZero * Redistribution and use in source and binary forms, with or without 12*10465441SEvalZero * modification, are permitted provided that the following conditions 13*10465441SEvalZero * are met: 14*10465441SEvalZero * 1. Redistributions of source code must retain the above copyright 15*10465441SEvalZero * notice, this list of conditions and the following disclaimer. 16*10465441SEvalZero * 2. Redistributions in binary form must reproduce the above copyright 17*10465441SEvalZero * notice, this list of conditions and the following disclaimer in the 18*10465441SEvalZero * documentation and/or other materials provided with the distribution. 19*10465441SEvalZero * 3. Neither the name of the Institute nor the names of its contributors 20*10465441SEvalZero * may be used to endorse or promote products derived from this software 21*10465441SEvalZero * without specific prior written permission. 22*10465441SEvalZero * 23*10465441SEvalZero * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND 24*10465441SEvalZero * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25*10465441SEvalZero * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26*10465441SEvalZero * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE 27*10465441SEvalZero * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28*10465441SEvalZero * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29*10465441SEvalZero * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30*10465441SEvalZero * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31*10465441SEvalZero * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32*10465441SEvalZero * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33*10465441SEvalZero * SUCH DAMAGE. 34*10465441SEvalZero * 35*10465441SEvalZero * This file is part of the lwIP TCP/IP stack. 36*10465441SEvalZero * 37*10465441SEvalZero * Author: Adam Dunkels <[email protected]> 38*10465441SEvalZero * 39*10465441SEvalZero */ 40*10465441SEvalZero #ifndef LWIP_HDR_NETIF_SLIPIF_H 41*10465441SEvalZero #define LWIP_HDR_NETIF_SLIPIF_H 42*10465441SEvalZero 43*10465441SEvalZero #include "lwip/opt.h" 44*10465441SEvalZero #include "lwip/netif.h" 45*10465441SEvalZero 46*10465441SEvalZero /** Set this to 1 to start a thread that blocks reading on the serial line 47*10465441SEvalZero * (using sio_read()). 48*10465441SEvalZero */ 49*10465441SEvalZero #ifndef SLIP_USE_RX_THREAD 50*10465441SEvalZero #define SLIP_USE_RX_THREAD !NO_SYS 51*10465441SEvalZero #endif 52*10465441SEvalZero 53*10465441SEvalZero /** Set this to 1 to enable functions to pass in RX bytes from ISR context. 54*10465441SEvalZero * If enabled, slipif_received_byte[s]() process incoming bytes and put assembled 55*10465441SEvalZero * packets on a queue, which is fed into lwIP from slipif_poll(). 56*10465441SEvalZero * If disabled, slipif_poll() polls the serial line (using sio_tryread()). 57*10465441SEvalZero */ 58*10465441SEvalZero #ifndef SLIP_RX_FROM_ISR 59*10465441SEvalZero #define SLIP_RX_FROM_ISR 0 60*10465441SEvalZero #endif 61*10465441SEvalZero 62*10465441SEvalZero /** Set this to 1 (default for SLIP_RX_FROM_ISR) to queue incoming packets 63*10465441SEvalZero * received by slipif_received_byte[s]() as long as PBUF_POOL pbufs are available. 64*10465441SEvalZero * If disabled, packets will be dropped if more than one packet is received. 65*10465441SEvalZero */ 66*10465441SEvalZero #ifndef SLIP_RX_QUEUE 67*10465441SEvalZero #define SLIP_RX_QUEUE SLIP_RX_FROM_ISR 68*10465441SEvalZero #endif 69*10465441SEvalZero 70*10465441SEvalZero #ifdef __cplusplus 71*10465441SEvalZero extern "C" { 72*10465441SEvalZero #endif 73*10465441SEvalZero 74*10465441SEvalZero err_t slipif_init(struct netif * netif); 75*10465441SEvalZero void slipif_poll(struct netif *netif); 76*10465441SEvalZero #if SLIP_RX_FROM_ISR 77*10465441SEvalZero void slipif_process_rxqueue(struct netif *netif); 78*10465441SEvalZero void slipif_received_byte(struct netif *netif, u8_t data); 79*10465441SEvalZero void slipif_received_bytes(struct netif *netif, u8_t *data, u8_t len); 80*10465441SEvalZero #endif /* SLIP_RX_FROM_ISR */ 81*10465441SEvalZero 82*10465441SEvalZero #ifdef __cplusplus 83*10465441SEvalZero } 84*10465441SEvalZero #endif 85*10465441SEvalZero 86*10465441SEvalZero #endif /* LWIP_HDR_NETIF_SLIPIF_H */ 87*10465441SEvalZero 88