bee.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 BEE_H
#define BEE_H
 
#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"
#include "spi_specifics.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define BEE_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.wa = MIKROBUS( mikrobus, MIKROBUS_AN ); \
   cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define BEE_OK                      0
#define BEE_ERROR                  -1
#define BEE_RXMCR                   0x00
#define BEE_PANIDL                  0x01
#define BEE_PANIDH                  0x02
#define BEE_SADRL                   0x03
#define BEE_SADRH                   0x04
#define BEE_EADR0                   0x05
#define BEE_EADR1                   0x06
#define BEE_EADR2                   0x07
#define BEE_EADR3                   0x08
#define BEE_EADR4                   0x09
#define BEE_EADR5                   0x0A
#define BEE_EADR6                   0x0B
#define BEE_EADR7                   0x0C
#define BEE_RXFLUSH                 0x0D
#define BEE_ORDER                   0x10
#define BEE_TXMCR                   0x11
#define BEE_ACKTMOUT                0x12
#define BEE_ESLOTG1                 0x13
#define BEE_SYMTICKL                0x14
#define BEE_SYMTICKH                0x15
#define BEE_PACON0                  0x16
#define BEE_PACON1                  0x17
#define BEE_PACON2                  0x18
#define BEE_TXBCON0                 0x1A
#define BEE_TXNCON                  0x1B
#define BEE_TXG1CON                 0x1C
#define BEE_TXG2CON                 0x1D
#define BEE_ESLOTG23                0x1E
#define BEE_ESLOTG45                0x1F
#define BEE_ESLOTG67                0x20
#define BEE_TXPEND                  0x21
#define BEE_WAKECON                 0x22
#define BEE_FRMOFFSET               0x23
#define BEE_TXSTAT                  0x24
#define BEE_TXBCON1                 0x25
#define BEE_GATECLK                 0x26
#define BEE_TXTIME                  0x27
#define BEE_HSYMTMRL                0x28
#define BEE_HSYMTMRH                0x29
#define BEE_SOFTRST                 0x2A
#define BEE_SECCON0                 0x2C
#define BEE_SECCON1                 0x2D
#define BEE_TXSTBL                  0x2E
#define BEE_RXSR                    0x30
#define BEE_INTSTAT                 0x31
#define BEE_INTCON_M                0x32
#define BEE_GPIO                    0x33
#define BEE_TRISGPIO                0x34
#define BEE_SLPACK                  0x35
#define BEE_RFCTL                   0x36
#define BEE_SECCR2                  0x37
#define BEE_BBREG0                  0x38
#define BEE_BBREG1                  0x39
#define BEE_BBREG2                  0x3A
#define BEE_BBREG3                  0x3B
#define BEE_BBREG4                  0x3C
#define BEE_BBREG6                  0x3E
#define BEE_CCAEDTH                 0x3F
#define BEE_RFCON0                  0x0200
#define BEE_RFCON1                  0x0201
#define BEE_RFCON2                  0x0202
#define BEE_RFCON3                  0x0203
#define BEE_RFCON5                  0x0205
#define BEE_RFCON6                  0x0206
#define BEE_RFCON7                  0x0207
#define BEE_RFCON8                  0x0208
#define BEE_SLPCAL0                 0x0209
#define BEE_SLPCAL1                 0x020A
#define BEE_SLPCAL2                 0x020B
#define BEE_RFSTATE                 0x020F
#define BEE_RSSI                    0x0210
#define BEE_SLPCON0                 0x0211
#define BEE_SLPCON1                 0x0220
#define BEE_WAKETIMEL               0x0222
#define BEE_WAKETIMEH               0x0223
#define BEE_REMCNTL                 0x0224
#define BEE_REMCNTH                 0x0225
#define BEE_MAINCNT0                0x0226
#define BEE_MAINCNT1                0x0227
#define BEE_MAINCNT2                0x0228
#define BEE_MAINCNT3                0x0229
#define BEE_ASSOEADR0               0x0230
#define BEE_ASSOEADR1               0x0231
#define BEE_ASSOEADR2               0x0232
#define BEE_ASSOEADR3               0x0233
#define BEE_ASSOEADR4               0x0234
#define BEE_ASSOEADR5               0x0235
#define BEE_ASSOEADR6               0x0236
#define BEE_ASSOEADR7               0x0237
#define BEE_ASSOSADR0               0x0238
#define BEE_ASSOSADR1               0x0239
#define BEE_UPNONCE0                0x0240
#define BEE_UPNONCE1                0x0241
#define BEE_UPNONCE2                0x0242
#define BEE_UPNONCE3                0x0243
#define BEE_UPNONCE4                0x0244
#define BEE_UPNONCE5                0x0245
#define BEE_UPNONCE6                0x0246
#define BEE_UPNONCE7                0x0247
#define BEE_UPNONCE8                0x0248
#define BEE_UPNONCE9                0x0249
#define BEE_UPNONCE10               0x024A
#define BEE_UPNONCE11               0x024B
#define BEE_UPNONCE12               0x024C
#define BEE_RX_FIFO                 0x0300
#define BEE_DATA_LENGHT             6
#define BEE_HEADER_LENGHT           11
#define BEE_SET_DATA_SAMPLE_EDGE    SET_SPI_DATA_SAMPLE_EDGE
#define BEE_SET_DATA_SAMPLE_MIDDLE  SET_SPI_DATA_SAMPLE_MIDDLE
 
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
    digital_out_t wa;
    digital_out_t rst;
 
    // Input pins 
    digital_in_t int_pin;
    
    // Modules 
    spi_master_t spi;
    pin_name_t chip_select;
 
} bee_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 wa;
    pin_name_t rst;
    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;
 
} bee_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void bee_cfg_setup ( bee_cfg_t *cfg );
 
err_t bee_init ( bee_t *ctx, bee_cfg_t *cfg );
 
void bee_generic_transfer ( bee_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf,  uint16_t rd_len );
 
void bee_write_byte_short ( bee_t *ctx, uint8_t reg_address, uint8_t write_data );
 
uint8_t bee_read_byte_short ( bee_t *ctx, uint8_t reg_address );
 
void bee_write_byte_long ( bee_t *ctx, uint16_t reg_address, uint8_t write_data );
 
uint8_t bee_read_byte_long ( bee_t *ctx, uint16_t reg_address );
 
void bee_hw_reset ( bee_t *ctx );
 
void bee_power_reset ( bee_t *ctx );
 
void bee_bb_reset ( bee_t *ctx );
 
void bee_mac_reset ( bee_t *ctx );
 
void bee_soft_reset ( bee_t *ctx );
 
void bee_rf_reset ( bee_t *ctx );
 
void bee_enable_interrupt ( bee_t *ctx );
 
void bee_set_channel ( bee_t *ctx, uint8_t n_channel );
 
void bee_set_cca_mode ( bee_t *ctx, uint8_t cca_mode );
 
void bee_set_rssi_mode ( bee_t *ctx, uint8_t rssi_mode );
 
void bee_nonbeacon_pan_coordinator_device ( bee_t *ctx );
 
void bee_nonbeacon_coordinator_device ( bee_t *ctx );
 
void bee_nonbeacon_device ( bee_t *ctx );
 
void bee_set_ack ( bee_t *ctx );
 
void bee_set_not_ack ( bee_t *ctx );
 
void bee_enable_encrypt ( bee_t *ctx );
 
void bee_disabl_encrypt ( bee_t *ctx );
 
void bee_set_ifs_recomended ( bee_t *ctx );
 
void bee_set_ifs_default ( bee_t *ctx );
 
void bee_set_reception_mode ( bee_t *ctx, uint8_t r_mode );
 
void bee_set_frame_format_filter ( bee_t *ctx, uint8_t fff_mode );
 
void bee_flush_rx_fifo_pointer ( bee_t *ctx );
 
void bee_set_short_address (  bee_t *ctx, uint8_t *short_address );
 
void bee_set_long_address ( bee_t *ctx, uint8_t *long_address );
 
void bee_set_pan_id ( bee_t *ctx, uint8_t *pan_id );
 
void bee_enable_immediate_wake_up ( bee_t *ctx );
 
void bee_hw_wake_up ( bee_t *ctx );
 
void bee_enable_pll ( bee_t *ctx );
 
void bee_disable_pll ( bee_t *ctx );
 
void bee_set_tx_power ( bee_t *ctx, uint8_t tx_power );
 
void bee_basic_init ( bee_t *ctx ); 
 
void bee_nonbeacon_init ( bee_t *ctx );
 
uint8_t bee_interrupt_activity ( bee_t *ctx );
 
void bee_start_transmit ( bee_t *ctx );
 
void bee_read_rx_fifo ( bee_t *ctx, uint8_t *rx_data );
 
void bee_write_tx_normal_fifo ( bee_t *ctx, uint16_t address_tx_normal_fifo, uint8_t *tx_data );
 
uint8_t bee_interrupt ( bee_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _BEE_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END