mrf24j40.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Neo Nenaco <neo@nenaco.de>
 * Copyright (C) 2017 Koen Zandberg <koen@bergzand.net>
 *
 * 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 MRF24J40_H
#define MRF24J40_H
 
#include <stdint.h>
 
#include "board.h"
#include "periph/spi.h"
#include "periph/gpio.h"
#include "net/netdev.h"
#include "net/netdev/ieee802154.h"
#include "net/gnrc/nettype.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define MRF24J40_PSEUDO_STATE_IDLE      (0x01)      
#define MRF24J40_PSEUDO_STATE_SLEEP     (0x02)      
#define MRF24J40_PSEUDO_STATE_RESET     (0x04)      
#define MRF24J40_OPT_CSMA               (0x0100)    
#define MRF24J40_OPT_PROMISCUOUS        (0x0200)    
#define MRF24J40_OPT_PRELOADING         (0x0400)    
#define MRF24J40_OPT_TELL_TX_START      (0x0800)    
#define MRF24J40_OPT_TELL_TX_END        (0x1000)    
#define MRF24J40_OPT_TELL_RX_START      (0x2000)    
#define MRF24J40_OPT_TELL_RX_END        (0x4000)    
#define MRF24J40_OPT_REQ_AUTO_ACK       (0x8000)    
#define MRF24J40_TASK_TX_DONE           (0x01)      
#define MRF24J40_TASK_TX_READY          (0x02)      
#define MRF24J40_TASK_RX_READY          (0x04)      
#define MRF24J40_MAX_FRAME_RETRIES      (3U)        
#if defined(DOXYGEN)
#define CONFIG_MRF24J40_USE_EXT_PA_LNA
#endif
 
#if defined(DOXYGEN)
#define CONFIG_MRF24J40_TEST_SPI_CONNECTION
#endif
 
typedef struct mrf24j40_params {
    spi_t spi;              
    spi_clk_t spi_clk;      
    spi_cs_t cs_pin;        
    gpio_t int_pin;         
    gpio_t reset_pin;       
} mrf24j40_params_t;
 
typedef struct {
    netdev_ieee802154_t netdev;             
    /*  device specific fields  */
    mrf24j40_params_t params;               
    uint8_t state;                          
    uint8_t idle_state;                     
    uint8_t tx_frame_len;                   
    uint8_t header_len;                     
    uint8_t fcf_low;                        
    uint8_t pending;                        
    uint8_t irq_flag;                       
    uint8_t tx_retries;                     
} mrf24j40_t;
 
void mrf24j40_setup(mrf24j40_t *dev, const mrf24j40_params_t *params, uint8_t index);
 
int mrf24j40_reset(mrf24j40_t *dev);
 
bool mrf24j40_cca(mrf24j40_t *dev, int8_t *rssi);
 
uint16_t mrf24j40_get_addr_short(mrf24j40_t *dev);
 
void mrf24j40_set_addr_short(mrf24j40_t *dev, uint16_t addr);
 
void mrf24j40_get_addr_long(mrf24j40_t *dev, uint8_t *addr);
 
void mrf24j40_set_addr_long(mrf24j40_t *dev, const uint8_t *addr);
 
uint8_t mrf24j40_get_chan(mrf24j40_t *dev);
 
void mrf24j40_set_chan(mrf24j40_t *dev, uint8_t chan);
 
uint16_t mrf24j40_get_pan(mrf24j40_t *dev);
 
void mrf24j40_set_pan(mrf24j40_t *dev, uint16_t pan);
 
int16_t mrf24j40_get_txpower(mrf24j40_t *dev);
 
void mrf24j40_set_txpower(mrf24j40_t *dev, int16_t txpower);
 
uint8_t mrf24j40_get_csma_max_retries(mrf24j40_t *dev);
 
void mrf24j40_set_csma_max_retries(mrf24j40_t *dev, int8_t retries);
 
void mrf24j40_set_csma_backoff_exp(mrf24j40_t *dev, uint8_t min, uint8_t max);
 
int8_t mrf24j40_get_cca_threshold(mrf24j40_t *dev);
 
void mrf24j40_set_cca_threshold(mrf24j40_t *dev, int8_t value);
 
void mrf24j40_set_option(mrf24j40_t *dev, uint16_t option, bool state);
 
void mrf24j40_set_state(mrf24j40_t *dev, uint8_t state);
 
void mrf24j40_set_turbo(mrf24j40_t *dev, bool enable);
 
bool mrf24j40_get_turbo(mrf24j40_t *dev);
 
void mrf24j40_sleep(mrf24j40_t *dev);
 
void mrf24j40_assert_sleep(mrf24j40_t *dev);
 
void mrf24j40_assert_awake(mrf24j40_t *dev);
 
void mrf24j40_reset_state_machine(mrf24j40_t *dev);
 
void mrf24j40_software_reset(mrf24j40_t *dev);
 
int8_t mrf24j40_dbm_from_reg(uint8_t value);
 
void mrf24j40_tx_prepare(mrf24j40_t *dev);
 
size_t mrf24j40_tx_load(mrf24j40_t *dev, uint8_t *data, size_t len,
                        size_t offset);
 
void mrf24j40_tx_exec(mrf24j40_t *dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* MRF24J40_H */