csp_if_kiss.h

Go to the documentation of this file.

/*
Cubesat Space Protocol - A small network-layer protocol designed for Cubesats
Copyright (C) 2012 GomSpace ApS (http://www.gomspace.com)
Copyright (C) 2012 AAUSAT3 Project (http://aausat3.space.aau.dk)

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

#ifndef _CSP_IF_KISS_H_
#define _CSP_IF_KISS_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

#include <csp/csp.h>
#include <csp/csp_interface.h>

void csp_kiss_rx(csp_iface_t * interface, uint8_t *buf, int len, void *pxTaskWoken);

typedef void (*csp_kiss_putc_f)(char buf);

typedef void (*csp_kiss_discard_f)(char c, void *pxTaskWoken);

typedef enum {
    KISS_MODE_NOT_STARTED,
    KISS_MODE_STARTED,
    KISS_MODE_ESCAPED,
    KISS_MODE_SKIP_FRAME,
} kiss_mode_e;

typedef struct csp_kiss_handle_s {
    csp_kiss_putc_f kiss_putc;
    csp_kiss_discard_f kiss_discard;
    unsigned int rx_length;
    kiss_mode_e rx_mode;
    unsigned int rx_first;
    volatile unsigned char *rx_cbuf;
    csp_packet_t * rx_packet;
} csp_kiss_handle_t;


void csp_kiss_init(csp_iface_t * csp_iface, csp_kiss_handle_t * csp_kiss_handle, csp_kiss_putc_f kiss_putc_f, csp_kiss_discard_f kiss_discard_f, const char * name);

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* _CSP_IF_KISS_H_ */

/* @} */