driver_nrf905.h

Go to the documentation of this file.

 
#ifndef DRIVER_NRF905_H
#define DRIVER_NRF905_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



typedef enum
{
    NRF905_BOOL_FALSE = 0x00,        
    NRF905_BOOL_TRUE  = 0x01,        
} nrf905_bool_t;

typedef enum
{
    NRF905_PLL_MODE_433_MHZ     = 0x00,        
    NRF905_PLL_MODE_868_915_MHZ = 0x01,        
} nrf905_pll_mode_t;

typedef enum
{
    NRF905_OUTPUT_POWER_NEGATIVE_10_DBM = 0x00,        
    NRF905_OUTPUT_POWER_NEGATIVE_2_DBM  = 0x01,        
    NRF905_OUTPUT_POWER_6_DBM          = 0x02,         
    NRF905_OUTPUT_POWER_10_DBM         = 0x03,         
} nrf905_output_power_t;

typedef enum
{
    NRF905_RX_MODE_NORMAL        = 0x00,        
    NRF905_RX_MODE_REDUCED_POWER = 0x01,        
} nrf905_rx_mode_t;

typedef enum
{
    NRF905_ADDRESS_WIDTH_1_BYTE = 0x01,        
    NRF905_ADDRESS_WIDTH_4_BYTE = 0x04,        
} nrf905_address_width_t;

typedef enum
{
    NRF905_OUTPUT_CLOCK_FREQUENCY_4MHZ   = 0x00,        
    NRF905_OUTPUT_CLOCK_FREQUENCY_2MHZ   = 0x01,        
    NRF905_OUTPUT_CLOCK_FREQUENCY_1MHZ   = 0x02,        
    NRF905_OUTPUT_CLOCK_FREQUENCY_500KHZ = 0x03,        
} nrf905_output_clock_frequency_t;

typedef enum
{
    NRF905_CRYSTAL_OSCILLATOR_FREQUENCY_4MHZ  = 0x00,        
    NRF905_CRYSTAL_OSCILLATOR_FREQUENCY_8MHZ  = 0x01,        
    NRF905_CRYSTAL_OSCILLATOR_FREQUENCY_12MHZ = 0x02,        
    NRF905_CRYSTAL_OSCILLATOR_FREQUENCY_16MHZ = 0x03,        
    NRF905_CRYSTAL_OSCILLATOR_FREQUENCY_20MHZ = 0x04,        
} nrf905_crystal_oscillator_frequency_t;

typedef enum
{
    NRF905_CRC_MODE_8  = 0x00,        
    NRF905_CRC_MODE_16 = 0x01,        
} nrf905_crc_mode_t;

typedef enum
{
    NRF905_MODE_RX = 0x00,        
    NRF905_MODE_TX = 0x01,        
} nrf905_mode_t;

typedef enum
{
    NRF905_STATUS_AM      = 0x00,        
    NRF905_STATUS_TX_DONE = 0x01,        
    NRF905_STATUS_RX_DONE = 0x02,        
} nrf905_status_t;

typedef struct nrf905_handle_s
{
    uint8_t (*ce_gpio_init)(void);                                            
    uint8_t (*ce_gpio_deinit)(void);                                          
    uint8_t (*ce_gpio_write)(uint8_t value);                                  
    uint8_t (*tx_en_gpio_init)(void);                                         
    uint8_t (*tx_en_gpio_deinit)(void);                                       
    uint8_t (*tx_en_gpio_write)(uint8_t value);                               
    uint8_t (*pwr_up_gpio_init)(void);                                        
    uint8_t (*pwr_up_gpio_deinit)(void);                                      
    uint8_t (*pwr_up_gpio_write)(uint8_t value);                              
    uint8_t (*spi_init)(void);                                                
    uint8_t (*spi_deinit)(void);                                              
    uint8_t (*spi_read)(uint8_t reg, uint8_t *buf, uint16_t len);             
    uint8_t (*spi_write)(uint8_t reg, uint8_t *buf, uint16_t len);            
    uint8_t (*spi_transmit)(uint8_t *tx, uint8_t *rx, uint16_t len);          
    void (*delay_ms)(uint32_t ms);                                            
    void (*debug_print)(const char *const fmt, ...);                          
    void (*receive_callback)(uint8_t type, uint8_t *buf, uint8_t len);        
    uint8_t inited;                                                           
    uint8_t conf[10];                                                         
    uint8_t finished;                                                         
    uint8_t mode;                                                             
} nrf905_handle_t;

typedef struct nrf905_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} nrf905_info_t;



#define DRIVER_NRF905_LINK_INIT(HANDLE, STRUCTURE)               memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_NRF905_LINK_SPI_INIT(HANDLE, FUC)                 (HANDLE)->spi_init = FUC

#define DRIVER_NRF905_LINK_SPI_DEINIT(HANDLE, FUC)               (HANDLE)->spi_deinit = FUC

#define DRIVER_NRF905_LINK_SPI_READ(HANDLE, FUC)                 (HANDLE)->spi_read = FUC

#define DRIVER_NRF905_LINK_SPI_WRITE(HANDLE, FUC)                (HANDLE)->spi_write = FUC

#define DRIVER_NRF905_LINK_SPI_TRANSMIT(HANDLE, FUC)             (HANDLE)->spi_transmit = FUC

#define DRIVER_NRF905_LINK_CE_GPIO_INIT(HANDLE, FUC)             (HANDLE)->ce_gpio_init = FUC

#define DRIVER_NRF905_LINK_CE_GPIO_DEINIT(HANDLE, FUC)           (HANDLE)->ce_gpio_deinit = FUC

#define DRIVER_NRF905_LINK_CE_GPIO_WRITE(HANDLE, FUC)            (HANDLE)->ce_gpio_write = FUC

#define DRIVER_NRF905_LINK_TX_EN_GPIO_INIT(HANDLE, FUC)          (HANDLE)->tx_en_gpio_init = FUC

#define DRIVER_NRF905_LINK_TX_EN_GPIO_DEINIT(HANDLE, FUC)        (HANDLE)->tx_en_gpio_deinit = FUC

#define DRIVER_NRF905_LINK_TX_EN_GPIO_WRITE(HANDLE, FUC)         (HANDLE)->tx_en_gpio_write = FUC

#define DRIVER_NRF905_LINK_PWR_UP_GPIO_INIT(HANDLE, FUC)         (HANDLE)->pwr_up_gpio_init = FUC

#define DRIVER_NRF905_LINK_PWR_UP_GPIO_DEINIT(HANDLE, FUC)       (HANDLE)->pwr_up_gpio_deinit = FUC

#define DRIVER_NRF905_LINK_PWR_UP_GPIO_WRITE(HANDLE, FUC)        (HANDLE)->pwr_up_gpio_write = FUC

#define DRIVER_NRF905_LINK_DELAY_MS(HANDLE, FUC)                 (HANDLE)->delay_ms = FUC

#define DRIVER_NRF905_LINK_DEBUG_PEINT(HANDLE, FUC)              (HANDLE)->debug_print = FUC

#define DRIVER_NRF905_LINK_RECEIVE_CALLBACK(HANDLE, FUC)         (HANDLE)->receive_callback = FUC



uint8_t nrf905_info(nrf905_info_t *info);

uint8_t nrf905_irq_handler(nrf905_handle_t *handle);

uint8_t nrf905_init(nrf905_handle_t *handle);

uint8_t nrf905_deinit(nrf905_handle_t *handle);

uint8_t nrf905_set_power_up(nrf905_handle_t *handle, nrf905_bool_t enable);

uint8_t nrf905_set_enable(nrf905_handle_t *handle, nrf905_bool_t enable);

uint8_t nrf905_set_mode(nrf905_handle_t *handle, nrf905_mode_t mode);

uint8_t nrf905_send(nrf905_handle_t *handle, uint8_t *buf, uint8_t len);

uint8_t nrf905_write_conf(nrf905_handle_t *handle);

uint8_t nrf905_read_conf(nrf905_handle_t *handle, uint8_t conf[10]);

uint8_t nrf905_update_conf(nrf905_handle_t *handle, uint8_t conf[10]);

uint8_t nrf905_set_tx_payload(nrf905_handle_t *handle, uint8_t *buf, uint8_t len);

uint8_t nrf905_get_tx_payload(nrf905_handle_t *handle, uint8_t *buf, uint8_t len);

uint8_t nrf905_get_rx_payload(nrf905_handle_t *handle, uint8_t *buf, uint8_t len);

uint8_t nrf905_set_tx_address(nrf905_handle_t *handle, uint8_t *addr, uint8_t len);

uint8_t nrf905_get_tx_address(nrf905_handle_t *handle, uint8_t *addr, uint8_t len);

uint8_t nrf905_channel_config(nrf905_handle_t *handle, uint16_t freq, nrf905_pll_mode_t mode, nrf905_output_power_t power);

uint8_t nrf905_get_status(nrf905_handle_t *handle, uint8_t *status);

uint8_t nrf905_set_frequency(nrf905_handle_t *handle, uint16_t freq);

uint8_t nrf905_get_frequency(nrf905_handle_t *handle, uint16_t *freq);

uint8_t nrf905_frequency_convert_to_register(nrf905_handle_t *handle, float mhz, uint16_t *reg);

uint8_t nrf905_frequency_convert_to_data(nrf905_handle_t *handle, uint16_t reg, float *mhz);

uint8_t nrf905_set_pll_mode(nrf905_handle_t *handle, nrf905_pll_mode_t mode);

uint8_t nrf905_get_pll_mode(nrf905_handle_t *handle, nrf905_pll_mode_t *mode);

uint8_t nrf905_set_output_power(nrf905_handle_t *handle, nrf905_output_power_t output_power);

uint8_t nrf905_get_output_power(nrf905_handle_t *handle, nrf905_output_power_t *output_power);

uint8_t nrf905_set_rx_mode(nrf905_handle_t *handle, nrf905_rx_mode_t mode);

uint8_t nrf905_get_rx_mode(nrf905_handle_t *handle, nrf905_rx_mode_t *mode);

uint8_t nrf905_set_auto_retransmit(nrf905_handle_t *handle, nrf905_bool_t enable);

uint8_t nrf905_get_auto_retransmit(nrf905_handle_t *handle, nrf905_bool_t *enable);

uint8_t nrf905_set_rx_address_width(nrf905_handle_t *handle, nrf905_address_width_t width);

uint8_t nrf905_get_rx_address_width(nrf905_handle_t *handle, nrf905_address_width_t *width);

uint8_t nrf905_set_tx_address_width(nrf905_handle_t *handle, nrf905_address_width_t width);

uint8_t nrf905_get_tx_address_width(nrf905_handle_t *handle, nrf905_address_width_t *width);

uint8_t nrf905_set_rx_payload_width(nrf905_handle_t *handle, uint8_t width);

uint8_t nrf905_get_rx_payload_width(nrf905_handle_t *handle, uint8_t *width);

uint8_t nrf905_set_tx_payload_width(nrf905_handle_t *handle, uint8_t width);

uint8_t nrf905_get_tx_payload_width(nrf905_handle_t *handle, uint8_t *width);

uint8_t nrf905_set_rx_address(nrf905_handle_t *handle, uint8_t addr[4]);

uint8_t nrf905_get_rx_address(nrf905_handle_t *handle, uint8_t addr[4]);

uint8_t nrf905_set_output_clock_frequency(nrf905_handle_t *handle, nrf905_output_clock_frequency_t freq);

uint8_t nrf905_get_output_clock_frequency(nrf905_handle_t *handle, nrf905_output_clock_frequency_t *freq);

uint8_t nrf905_set_output_clock(nrf905_handle_t *handle, nrf905_bool_t enable);

uint8_t nrf905_get_output_clock(nrf905_handle_t *handle, nrf905_bool_t *enable);

uint8_t nrf905_set_crystal_oscillator_frequency(nrf905_handle_t *handle, nrf905_crystal_oscillator_frequency_t freq);

uint8_t nrf905_get_crystal_oscillator_frequency(nrf905_handle_t *handle, nrf905_crystal_oscillator_frequency_t *freq);

uint8_t nrf905_set_crc(nrf905_handle_t *handle, nrf905_bool_t enable);

uint8_t nrf905_get_crc(nrf905_handle_t *handle, nrf905_bool_t *enable);

uint8_t nrf905_set_crc_mode(nrf905_handle_t *handle, nrf905_crc_mode_t mode);

uint8_t nrf905_get_crc_mode(nrf905_handle_t *handle, nrf905_crc_mode_t *mode);



uint8_t nrf905_set_reg(nrf905_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t nrf905_get_reg(nrf905_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif