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