cc110x.h

Go to the documentation of this file.

/*
 * Copyright (C) 2013 INRIA
 *               2014 Freie Universität Berlin
 *               2015 Kaspar Schleiser <kaspar@schleiser.de>
 *               2018,2019 Otto-von-Guericke-Universität Magdeburg
 *
 * 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.
 */
 
#ifndef CC110X_H
#define CC110X_H
 
#include <stdint.h>
 
#include "cc1xxx_common.h"
#include "mutex.h"
#include "net/gnrc/nettype.h"
#include "net/netdev.h"
#include "periph/adc.h"
#include "periph/gpio.h"
#include "periph/spi.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define CC110X_MAX_FRAME_SIZE           0xFF
 
#define CC110X_MAX_PAYLOAD_SIZE         (CC110X_MAX_FRAME_SIZE - CC1XXX_HEADER_SIZE)
 
#define CC110X_MAX_CHANNELS             8
 
#ifdef MODULE_GNRC_SIXLOWPAN
#define CC110X_DEFAULT_PROTOCOL         (GNRC_NETTYPE_SIXLOWPAN)
#else
#define CC110X_DEFAULT_PROTOCOL         (GNRC_NETTYPE_UNDEF)
#endif
 
#ifndef CONFIG_CC110X_DEFAULT_CHANNEL
#define CONFIG_CC110X_DEFAULT_CHANNEL      (0U)
#endif
typedef enum {
    CC110X_STATE_IDLE               = 0x00,   
    CC110X_STATE_FRAME_READY        = 0x08,
    CC110X_STATE_OFF                = 0x10,
    CC110X_STATE_RX_MODE            = 0x01,   
    CC110X_STATE_RECEIVING          = 0x09,
    CC110X_STATE_TX_MODE            = 0x02,   
    CC110X_STATE_TX_COMPLETING      = 0x0A,
    CC110X_STATE_FSTXON             = 0x03,   
    CC110X_STATE_CALIBRATE          = 0x04,   
    CC110X_STATE_SETTLING           = 0x05,   
    CC110X_STATE_RXFIFO_OVERFLOW    = 0x06,   
    CC110X_STATE_TXFIFO_UNDERFLOW   = 0x07,   
} cc110x_state_t;
 
typedef enum {
    CC110X_TX_POWER_MINUS_30_DBM,                   
    CC110X_TX_POWER_MINUS_20_DBM,                   
    CC110X_TX_POWER_MINUS_15_DBM,                   
    CC110X_TX_POWER_MINUS_10_DBM,                   
    CC110X_TX_POWER_0_DBM,                          
    CC110X_TX_POWER_PLUS_5_DBM,                     
    CC110X_TX_POWER_PLUS_7_DBM,                     
    CC110X_TX_POWER_PLUS_10_DBM,                    
    CC110X_TX_POWER_NUMOF,                          
} cc110x_tx_power_t;
 
typedef struct {
    uint8_t data[8]; 
} cc110x_patable_t;
 
typedef struct {
    uint8_t base_freq[3]; 
    uint8_t fsctrl1;
    uint8_t mdmcfg4;
    uint8_t mdmcfg3;
    uint8_t deviatn;
} cc110x_config_t;
 
typedef struct {
    uint8_t map[CC110X_MAX_CHANNELS]; 
} cc110x_chanmap_t;
 
typedef struct {
    const cc110x_patable_t *patable;  
    const cc110x_config_t *config;
    const cc110x_chanmap_t *channels;   
    spi_t spi;                          
    spi_clk_t spi_clk;                  
    spi_cs_t cs;                        
    gpio_t gdo0;                        
    gpio_t gdo2;                        
} cc110x_params_t;
 
typedef struct {
    char fscal1[CC110X_MAX_CHANNELS];
    char fscal2;    
    char fscal3;    
} cc110x_fs_calibration_t;
 
typedef struct __attribute__((packed)) {
    uint8_t len;            
    uint8_t data[CC110X_MAX_FRAME_SIZE];
    uint8_t pos;
} cc110x_framebuf_t;
 
typedef struct {
    netdev_t netdev;                    
    uint8_t addr;                       
    /* Keep above in sync with cc1xx_t members, as they must overlap! */
    cc110x_state_t state;               
    cc110x_tx_power_t tx_power;         
    uint8_t channel;                    
    /* Struct packing:  addr, state, tx_power and channel add up to 32 bit */
    const cc110x_chanmap_t *channels;   
    cc110x_params_t params;             
    cc110x_framebuf_t buf;              
    cc1xxx_rx_info_t rx_info;
    cc110x_fs_calibration_t fscal;
    mutex_t isr_signal;
    uint8_t rssi_offset;                
} cc110x_t;
 
int cc110x_setup(cc110x_t *dev, const cc110x_params_t *params, uint8_t index);
 
int cc110x_apply_config(cc110x_t *dev, const cc110x_config_t *conf,
                        const cc110x_chanmap_t *chanmap, uint8_t channel);
 
int cc110x_full_calibration(cc110x_t *dev);
 
int cc110x_set_channel(cc110x_t *dev, uint8_t channel);
 
int cc110x_set_tx_power(cc110x_t *dev, cc110x_tx_power_t power);
 
int cc110x_wakeup(cc110x_t *dev);
 
void cc110x_sleep(cc110x_t *dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* CC110X_H */