xref: /btstack/src/btstack_slip.h (revision df25739fc3ea5a0a90f0f5925e6461d653697d2e)
1 /*
2  * Copyright (C) 2014 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
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 copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 /*
39  *  btstack_slip.h
40  *  SLIP encoder/decoder
41  */
42 
43 #ifndef __BTSTACK_SLIP_H
44 #define __BTSTACK_SLIP_H
45 
46 #include <stdint.h>
47 
48 #if defined __cplusplus
49 extern "C" {
50 #endif
51 
52 #define BTSTACK_SLIP_SOF 0xc0
53 
54 // ENCODER
55 
56 /**
57  * @brief Initialise SLIP encoder with data
58  * @param data
59  * @param len
60  */
61 void btstack_slip_encoder_start(const uint8_t * data, uint16_t len);
62 
63 /**
64  * @brief Check if encoder has data ready
65  * @return True if data ready
66  */
67 int  btstack_slip_encoder_has_data(void);
68 
69 /**
70  * @brief Get next byte from encoder
71  * @return Next bytes from encoder
72  */
73 uint8_t btstack_slip_encoder_get_byte(void);
74 
75 // DECODER
76 
77 /**
78  * @brief Initialise SLIP decoder with buffer
79  * @param buffer to store received data
80  * @param max_size of buffer
81  */
82 void btstack_slip_decoder_init(uint8_t * buffer, uint16_t max_size);
83 
84 /**
85  * @brief Process received byte
86  * @param input
87  */
88 
89 void btstack_slip_decoder_process(uint8_t input);
90 
91 /**
92  * @brief Get size of decoded frame
93  * @return size of frame. Size = 0 => frame not complete
94  */
95 
96 uint16_t btstack_slip_decoder_frame_size(void);
97 
98 #if defined __cplusplus
99 }
100 #endif
101 
102 #endif
103