mrf24j40.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2017 Neo Nenaco <neo@nenaco.de>
 * SPDX-FileCopyrightText: 2017 Koen Zandberg <koen@bergzand.net>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#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"
#include "net/ieee802154/radio.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_TASK_TX_DONE           (0x01)      
#define MRF24J40_TASK_TX_READY          (0x02)      
#define MRF24J40_TASK_RX_READY          (0x04)      
 
#define MRF24J40_MAX_FRAME_RETRIES      (3U)        
 
#define MRF24J40_MAX_MINBE              (3U)        
#define MRF24J40_MIN_TXPOWER            (-36)       
#define MRF24J40_MAX_TXPOWER            (0)         


#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 {
    /*  device specific fields  */
    const mrf24j40_params_t *params;        
    uint8_t fcf_low;                        
    uint8_t pending;                        
    bool tx_pending;                        
} mrf24j40_t;

int mrf24j40_reset(mrf24j40_t *dev);

void mrf24j40_set_addr_short(mrf24j40_t *dev, uint16_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);

void mrf24j40_set_txpower(mrf24j40_t *dev, int16_t txpower);

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);

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);

void mrf24j40_sleep(mrf24j40_t *dev);

void mrf24j40_wake_up(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);

void mrf24j40_radio_irq_handler(void *dev);

int mrf24j40_init(mrf24j40_t *dev, const mrf24j40_params_t *params, ieee802154_dev_t *hal,
                   gpio_cb_t cb, void *ctx);
 
#ifdef __cplusplus
}
#endif