slip.h

/*
 * Copyright 2023-2025 Morse Micro
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
 
#define SLIP_RX_BUFFER_SIZE     (2000)
 
struct slip_rx_state
{
    uint8_t *buffer;        
    size_t buffer_length;   
    size_t length;          
    bool escape;            
    bool frame_started;     
};
 
#define SLIP_RX_STATE_INIT(_buffer, _buffer_length) { _buffer, _buffer_length, 0, false, false }
 
static inline void slip_rx_state_reinit(struct slip_rx_state *state,
                                        uint8_t *buffer, size_t buffer_length)
{
    state->buffer = buffer;
    state->buffer_length = buffer_length;
    state->length = 0;
    state->escape = false;
    state->frame_started = false;
}
 
enum slip_rx_status
{
    SLIP_RX_COMPLETE,       
    SLIP_RX_IN_PROGRESS,    
    SLIP_RX_BUFFER_LIMIT,   
    SLIP_RX_ERROR,          
};
 
enum slip_rx_status slip_rx(struct slip_rx_state *state, uint8_t c);
 
typedef int (*slip_transport_tx_fn)(uint8_t c, void *arg);
 
int slip_tx(slip_transport_tx_fn transport_tx_fn, void *transport_tx_arg,
            const uint8_t *packet, size_t packet_len);