dose.h

Go to the documentation of this file.

/*
 * Copyright (C) 2019 Juergen Fitschen <me@jue.yt>
 *
 * This file is subject to the terms and conditions of the GNU Lesser General
 * Public License v2.1. See the file LICENSE in the top level directory for more
 * details.
 */
 
#pragma once

 
#include "chunked_ringbuffer.h"
#include "periph/uart.h"
#include "periph/gpio.h"
#include "net/netdev.h"
#include "net/ethernet.h"
#include "net/eui48.h"
#include "bitarithm.h"
#include "mutex.h"
#include "ztimer.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define DOSE_OCTET_END  (0xFF)     
#define DOSE_OCTET_ESC  (0xFE)     

typedef enum {
    DOSE_STATE_INIT    = 0x00,     
    DOSE_STATE_BLOCKED = 0x01,     
    DOSE_STATE_IDLE    = 0x02,     
    DOSE_STATE_RECV    = 0x03,     
    DOSE_STATE_SEND    = 0x04,     
    DOSE_STATE_STANDBY = 0x05,     
    DOSE_STATE_SLEEP   = 0x06,     
    DOSE_STATE_ANY     = 0x0F      
} dose_state_t;

typedef enum {
    DOSE_SIGNAL_NONE   = 0x00,    
    DOSE_SIGNAL_INIT   = 0x10,    
    DOSE_SIGNAL_GPIO   = 0x20,    
    DOSE_SIGNAL_UART   = 0x30,    
    DOSE_SIGNAL_ZTIMER = 0x40,    
    DOSE_SIGNAL_SEND   = 0x50,    
    DOSE_SIGNAL_END    = 0x60     
} dose_signal_t;

#define DOSE_FLAG_RECV_BUF_DIRTY (BIT0)     
#define DOSE_FLAG_END_RECEIVED   (BIT1)     
#define DOSE_FLAG_ESC_RECEIVED   (BIT2)     
#define DOSE_FLAG_SEND_PENDING   (BIT3)     

#define DOSE_OPT_PROMISCUOUS     (BIT0)     

#ifndef CONFIG_DOSE_TIMEOUT_BYTES
#define CONFIG_DOSE_TIMEOUT_BYTES   (50)
#endif
 
#define DOSE_FRAME_CRC_LEN          (2)     

#ifndef CONFIG_DOSE_RX_BUF_LEN
#define CONFIG_DOSE_RX_BUF_LEN (ETHERNET_FRAME_LEN + DOSE_FRAME_CRC_LEN)
#endif

#if DOXYGEN
#define DOSE_TIMER_DEV              TIMER_DEV(…)
#endif

typedef struct {
    netdev_t netdev;                        
    eui48_t mac_addr;                       
    uint8_t opts;                           
    dose_state_t state;                     
    mutex_t state_mtx;                      
    uint8_t recv_buf[CONFIG_DOSE_RX_BUF_LEN]; 
    chunk_ringbuf_t rb;                     
                                            /* Written to from interrupts (with irq_disable */
                                            /* to prevent any simultaneous writes),         */
                                            /* consumed exclusively in the network stack's  */
                                            /* loop at _isr.                                */
#if defined(MODULE_DOSE_WATCHDOG) || DOXYGEN
    void *recv_buf_ptr_last;                
#endif
#if !defined(MODULE_PERIPH_UART_RXSTART_IRQ) || DOXYGEN
    gpio_t sense_pin;                       
#endif
    gpio_t standby_pin;                     
    ztimer_t timeout;                       
    uint32_t timeout_base;                  
    uart_t uart;                            
    uint8_t uart_octet;                     
    uint8_t flags;                          
} dose_t;

typedef struct {
    uart_t uart;                            
#if !defined(MODULE_PERIPH_UART_RXSTART_IRQ) || DOXYGEN
    gpio_t sense_pin;                       
#endif
    gpio_t standby_pin;                     
    uint32_t baudrate;                      
} dose_params_t;

void dose_setup(dose_t *dev, const dose_params_t *params, uint8_t index);
 
#ifdef __cplusplus
}
#endif