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 BLUEKITCHEN 24 * GMBH 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 * @title SLIP encoder/decoder 40 * 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 /* API_START */ 55 56 // ENCODER 57 58 /** 59 * @brief Initialise SLIP encoder with data 60 * @param data 61 * @param len 62 */ 63 void btstack_slip_encoder_start(const uint8_t * data, uint16_t len); 64 65 /** 66 * @brief Check if encoder has data ready 67 * @return True if data ready 68 */ 69 int btstack_slip_encoder_has_data(void); 70 71 /** 72 * @brief Get next byte from encoder 73 * @return Next bytes from encoder 74 */ 75 uint8_t btstack_slip_encoder_get_byte(void); 76 77 // DECODER 78 79 /** 80 * @brief Initialise SLIP decoder with buffer 81 * @param buffer to store received data 82 * @param max_size of buffer 83 */ 84 void btstack_slip_decoder_init(uint8_t * buffer, uint16_t max_size); 85 86 /** 87 * @brief Process received byte 88 * @param input 89 */ 90 91 void btstack_slip_decoder_process(uint8_t input); 92 93 /** 94 * @brief Get size of decoded frame 95 * @return size of frame. Size = 0 => frame not complete 96 */ 97 98 uint16_t btstack_slip_decoder_frame_size(void); 99 100 /* API_END */ 101 102 #if defined __cplusplus 103 } 104 #endif 105 106 #endif 107