xbee.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2014 INRIA
 * SPDX-FileCopyrightText: 2015-2016 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
 
#include "mutex.h"
#include "periph/uart.h"
#include "periph/gpio.h"
#include "net/netdev.h"
#include "net/ieee802154.h"
#include "net/gnrc/nettype.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#ifdef MODULE_XBEE_ENCRYPTION
#define XBEE_MAX_PAYLOAD_LENGTH     (95U)
#else
#define XBEE_MAX_PAYLOAD_LENGTH     (100U)
#endif

#define XBEE_MAX_PKT_LENGTH         (115U)

#define XBEE_MAX_RESP_LENGTH        (16U)

#define XBEE_MAX_TXHDR_LENGTH       (14U)

#ifdef MODULE_GNRC_SIXLOWPAN
#define XBEE_DEFAULT_PROTOCOL       (GNRC_NETTYPE_SIXLOWPAN)
#else
#define XBEE_DEFAULT_PROTOCOL       (GNRC_NETTYPE_UNDEF)
#endif

#define XBEE_DEFAULT_PANID          (CONFIG_IEEE802154_DEFAULT_PANID)

#define XBEE_DEFAULT_CHANNEL        (CONFIG_IEEE802154_DEFAULT_CHANNEL)

#define XBEE_ADDR_FLAGS_LONG              (0x80)

typedef enum {
    XBEE_INT_STATE_IDLE,    
    XBEE_INT_STATE_SIZE1,   
    XBEE_INT_STATE_SIZE2,   
    XBEE_INT_STATE_TYPE,    
    XBEE_INT_STATE_RESP,    
    XBEE_INT_STATE_RX,      
} xbee_rx_state_t;

typedef struct {
    uart_t uart;            
    uint32_t br;            
    gpio_t pin_sleep;       
    gpio_t pin_reset;      
} xbee_params_t;

typedef struct {
    /* netdev fields */
    const struct netdev_driver *driver;     
    netdev_event_cb_t event_callback;       
    void* context;                          
    /* device driver specific fields */
    xbee_params_t p;                    
    uint8_t options;                    
    uint8_t addr_flags;                 
    uint8_t addr_short[2];              
    eui64_t addr_long;                  
    /* general variables for the UART RX state machine */
    xbee_rx_state_t int_state;          
    uint16_t int_size;                  
    /* values for the UART TX state machine */
    mutex_t tx_lock;                    
    uint8_t cmd_buf[XBEE_MAX_RESP_LENGTH];
    uint8_t tx_fid;                     
    /* buffer and synchronization for command responses */
    mutex_t resp_lock;                  
    uint8_t resp_buf[XBEE_MAX_RESP_LENGTH]; 
    uint16_t resp_count;                
    uint16_t resp_limit;                
    /* buffer and synchronization for incoming network packets */
    uint8_t rx_buf[XBEE_MAX_PKT_LENGTH];
    uint16_t rx_count;                  
    uint16_t rx_limit;                  
} xbee_t;

typedef struct {
    uint8_t addr_len;                   
    uint8_t bcast;                      
    uint8_t rssi;                       
    uint8_t src_addr[8];                
    uint8_t dst_addr[8];                
} xbee_l2hdr_t;

extern const netdev_driver_t xbee_driver;

void xbee_setup(xbee_t *dev, const xbee_params_t *params);

int xbee_build_hdr(xbee_t *dev, uint8_t *xhdr, size_t payload_len,
                   void *dst_addr, size_t addr_len);

int xbee_parse_hdr(xbee_t *dev, const uint8_t *xhdr, xbee_l2hdr_t *l2hdr);
 
#ifdef __cplusplus
}
#endif