ismrx3.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef ISMRX3_H
#define ISMRX3_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
 
#define ISMRX3_DEMOD            0x00
#define ISMRX3_AGC              0x01
#define ISMRX3_IF_CHF_SEL       0x02
#define ISMRX3_PDF_CFG          0x03
#define ISMRX3_ATH_CFG_1        0x04
#define ISMRX3_ATH_CFG_2        0x05
#define ISMRX3_ATH_CFG_3        0x06
#define ISMRX3_AFC_CFG_1        0x07
#define ISMRX3_AFC_CFG_2        0x08
#define ISMRX3_LO_CTR_FREQ_3    0x09
#define ISMRX3_LO_CTR_FREQ_2    0x0A
#define ISMRX3_LO_CTR_FREQ_1    0x0B
#define ISMRX3_PREAMBLE_CFG_1   0x0C
#define ISMRX3_PREAMBLE_WORD_1  0x0D
#define ISMRX3_PREAMBLE_WROD_2  0x0E
#define ISMRX3_RSS              0x10
#define ISMRX3_FEI              0x11
#define ISMRX3_PDF_OUT          0x12
#define ISMRX3_ISR              0x13
#define ISMRX3_CDR_CFG          0x35
#define ISMRX3_STATE_CTRL_1     0x14
#define ISMRX3_STATE_CTRL_2     0x15
#define ISMRX3_STATE_CTRL_3     0x16
#define ISMRX3_WUT_1            0x17
#define ISMRX3_WUT_2            0x18
#define ISMRX3_AFE_CTL_1        0x19
#define ISMRX3_IR_ADJUST        0x1A
#define ISMRX3_PART_NUM         0x1E
#define ISMRX3_REV_NUM          0x1F
#define ISMRX3_STATUS           0x27
 
 // ismrx3_reg
 
#define ISMRX3_MODULATION_ASK           0x01
#define ISMRX3_MODULATION_FSK           0x02
 
#define ISMRX3_FREQUENCY_MHZ_315        0x01
#define ISMRX3_FREQUENCY_MHZ_433p92     0x02
#define ISMRX3_FREQUENCY_MHZ_868p3      0x03
 
#define ISMRX3_DEVIATION_KHZ_5          0x01
#define ISMRX3_DEVIATION_KHZ_10         0x02
#define ISMRX3_DEVIATION_KHZ_40         0x03
#define ISMRX3_DEVIATION_KHZ_80         0x04
 
#define ISMRX3_DATA_RATE_KBPS_1         0x01
#define ISMRX3_DATA_RATE_KBPS_2         0x02
#define ISMRX3_DATA_RATE_KBPS_5         0x03
#define ISMRX3_DATA_RATE_KBPS_10        0x04
#define ISMRX3_DATA_RATE_KBPS_50        0x05
#define ISMRX3_DATA_RATE_KBPS_100       0x06
 
 // ismrx3_set
 
#define ISMRX3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.dat = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.pdn = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.sw = MIKROBUS( mikrobus, MIKROBUS_PWM );\
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // ismrx3_map
 // ismrx3
 
typedef struct
{
    // Output pins
    digital_out_t  pdn;     
    digital_out_t  sw;      
    // Input pins
    digital_in_t  dat;      
    digital_in_t  int_pin;  
    // Modules
    spi_master_t  spi;       
    pin_name_t  chip_select; 
    uint8_t modulation;      
    uint8_t reference_freq;  
    uint8_t freq_deviation;  
    uint8_t data_rate;       
} ismrx3_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;   
    pin_name_t  mosi;   
    pin_name_t  sck;    
    pin_name_t  cs;     
    // Additional gpio pins
    pin_name_t  dat;    
    pin_name_t  pdn;    
    pin_name_t  sw;     
    pin_name_t  int_pin;
    // static variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} ismrx3_cfg_t;
 
typedef enum
{
    ISMRX3_OK = 0,
    ISMRX3_ERROR = -1,
    ISMRX3_ERROR_BUF_LEN = -2
 
} ismrx3_return_value_t;
 
void ismrx3_cfg_setup ( ismrx3_cfg_t *cfg );
 
err_t ismrx3_init ( ismrx3_t *ctx, ismrx3_cfg_t *cfg );
 
err_t ismrx3_default_cfg ( ismrx3_t *ctx );
 
err_t ismrx3_generic_write ( ismrx3_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t ismrx3_generic_read ( ismrx3_t *ctx, uint8_t reg, uint8_t *data_out );
 
void ismrx3_reset( ismrx3_t *ctx );
 
uint8_t ismrx3_get_clk( ismrx3_t *ctx );
 
uint8_t ismrx3_get_data( ismrx3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // ISMRX3_H
 
 // ismrx3
 
// ------------------------------------------------------------------------ END