ethos.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2015 Kaspar Schleiser <kaspar@schleiser.de>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once


 
#include <stdbool.h>
 
#include "periph/uart.h"
#include "net/netdev.h"
#include "tsrb.h"
#include "mutex.h"
#include "kernel_defines.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* if using ethos + stdio, use STDIO_UART values unless overridden */
#if IS_USED(MODULE_ETHOS_STDIO) || defined(DOXYGEN)
#include "stdio_uart.h"
#ifndef ETHOS_UART
#define ETHOS_UART     STDIO_UART_DEV
#endif

#ifndef ETHOS_BAUDRATE
#define ETHOS_BAUDRATE STDIO_UART_BAUDRATE
#endif
#else
#ifndef ETHOS_UART
#if IS_USED(MODULE_USBUS_CDC_ACM)
#define ETHOS_UART     UART_DEV(0)
#else
#define ETHOS_UART     UART_DEV(1)
#endif
#endif
#ifndef ETHOS_BAUDRATE
#define ETHOS_BAUDRATE 115200
#endif
#endif

#define ETHOS_FRAME_DELIMITER           (0x7E)
#define ETHOS_ESC_CHAR                  (0x7D)
#define ETHOS_FRAME_TYPE_DATA           (0x0)
#define ETHOS_FRAME_TYPE_TEXT           (0x1)
#define ETHOS_FRAME_TYPE_HELLO          (0x2)
#define ETHOS_FRAME_TYPE_HELLO_REPLY    (0x3)

typedef enum {
    WAIT_FRAMESTART,
    IN_FRAME,
    IN_ESCAPE
} line_state_t;

typedef struct {
    netdev_t netdev;        
    uart_t uart;            
    uint8_t mac_addr[6];    
    uint8_t remote_mac_addr[6]; 
    tsrb_t inbuf;           
    line_state_t state;     
    unsigned frametype;     
    mutex_t out_mutex;      
} ethos_t;

typedef struct {
    uart_t uart;            
    uint32_t baudrate;      
} ethos_params_t;

void ethos_setup(ethos_t *dev, const ethos_params_t *params, uint8_t index,
                 void *inbuf, size_t inbuf_size);

void ethos_send_frame(ethos_t *dev, const uint8_t *data, size_t len, unsigned frame_type);
 
#ifdef __cplusplus
}
#endif