radiostation.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 RADIOSTATION_H
#define RADIOSTATION_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_i2c_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define RADIOSTATION_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl     = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda     = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.rst     = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.sen     = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define RADIOSTATION_RETVAL  uint8_t
 
#define RADIOSTATION_OK           0x00
#define RADIOSTATION_INIT_ERROR   0xFF
#define RADIOSTATION_SLAVE_ADDR0                          0x11              // If SEN = 0
#define RADIOSTATION_SLAVE_ADDR1                          0x63              // If SEN = 1
#define RADIOSTATION_CTS                                  0x80
#define RADIOSTATION_ERR                                  0x40
#define RADIOSTATION_RDSINT                               0x04
#define RADIOSTATION_ASQINT                               0x02
#define RADIOSTATION_STCINT                               0x01
// Power Up Settings
#define RADIOSTATION_CTS_INTERRUPT_ENABLE                 0x04
#define RADIOSTATION_GPO2_OUTPUT_ENABLE                   0x02
#define RADIOSTATION_PATCH_ENABLE                         0x01
 
// Set Tune Frequency Possible Arguments
#define RADIOSTATION_MIN_TUNE_FREQ                        7600
#define RADIOSTATION_MAX_TUNE_FREQ                        10800
#define RADIOSTATION_MIN_STEP                             5
#define  RADIOSTATION_PROP_GPO_IEN                        0x0001
#define  RADIOSTATION_GPO_IEN_ASQREP                      0x0200
#define  RADIOSTATION_GPO_IEN_STCREP                      0x0100
#define  RADIOSTATION_GPO_IEN_CTSIEN                      0x0080
#define  RADIOSTATION_GPO_IEN_ERRIEN                      0x0040
#define  RADIOSTATION_GPO_IEN_RDSIEN                      0x0004
#define  RADIOSTATION_GPO_IEN_ASQIEN                      0x0002
#define  RADIOSTATION_GPO_IEN_STCIENP                     0x0001
 
#define RADIOSTATION_PROP_REFCLK_FREQ                     0x0201    // Value Range: 31130 to 34406
 
#define RADIOSTATION_PROP_REFCLK_PRESCALE                 0x0202    // Value Range: 1 to 4095
#define RADIOSTATION_REFCLK_PRESCALE_RCLK                 0x0000 & 0x1000
#define RADIOSTATION_REFCLK_PRESCALE_DCLK                 0x1000 & 0x1000
 
#define RADIOSTATION_PROP_TX_COMPONENT_ENABLE             0x2100
#define RADIOSTATION_TX_COMPONENT_ENABLE_RDS              0x0004
#define RADIOSTATION_TX_COMPONENT_ENABLE_LEFT_MINUS_RIGHT 0x0002
#define RADIOSTATION_TX_COMPONENT_ENABLE_PILOT_TONE       0x0001
 
#define RADIOSTATION_PROP_TX_AUDIO_DEVIATION              0x2101    // Value Range: 0 to 9000
 
#define RADIOSTATION_PROP_TX_PILOT_DEVIATION              0x2102    // Value Range: 0 to 9000
 
#define RADIOSTATION_PROP_TX_LINE_INPUT_LEVEL             0x2104
#define RADIOSTATION_TX_LINE_INPUT_LEVEL_LIATTEN_1        0x0000 & 0x3000
#define RADIOSTATION_TX_LINE_INPUT_LEVEL_LIATTEN_2        0x1000 & 0x3000
#define RADIOSTATION_TX_LINE_INPUT_LEVEL_LIATTEN_3        0x2000 & 0x3000
#define RADIOSTATION_TX_LINE_INPUT_LEVEL_LIATTEN_4        0x3000 & 0x3000
#define RADIOSTATION_TX_LINE_INPUT_LEVEL_MAX_LILEVEL      636 & 0x03FF
 
#define RADIOSTATION_PROP_TX_LINE_INPUT_MUTE              0x2105
#define RADIOSTATION_TX_LINE_INPUT_MUTE_R                 0x0001
#define RADIOSTATION_TX_LINE_INPUT_MUTE_L                 0x0002
 
#define RADIOSTATION_PROP_TX_PREEMPHASIS                  0x2106
#define RADIOSTATION_TX_PREEMPHASIS_75                    0x0000
#define RADIOSTATION_TX_PREEMPHASIS_50                    0x0001
#define RADIOSTATION_TX_PREEMPHASIS_DISABLED              0x0002
 
#define RADIOSTATION_PROP_TX_PILOT_FREQUENCY              0x2107    // Value Range: 0 to 19000
 
#define RADIOSTATION_PROP_TX_ACOMP_ENABLE                 0x2200
#define RADIOSTATION_TX_ACOMP_ENABLE_LIMITEN              0x0002
#define RADIOSTATION_TX_ACOMP_ENABLE_ACEN                 0x0001
 
#define RADIOSTATION_PROP_TX_ACOMP_THRESHOLD              0x2201    // Value Range: �40 to 0
 
#define RADIOSTATION_PROP_TX_ACOMP_ATTACK_TIME            0x2202
#define RADIOSTATION_TX_ACOMP_ATTACK_TIME_0_5_MS          0x0000
#define RADIOSTATION_TX_ACOMP_ATTACK_TIME_1_0_MS          0x0001
#define RADIOSTATION_TX_ACOMP_ATTACK_TIME_1_5_MS          0x0002
#define RADIOSTATION_TX_ACOMP_ATTACK_TIME_2_0_MS          0x0003
#define RADIOSTATION_TX_ACOMP_ATTACK_TIME_2_5_MS          0x0004
#define RADIOSTATION_TX_ACOMP_ATTACK_TIME_3_0_MS          0x0005
#define RADIOSTATION_TX_ACOMP_ATTACK_TIME_3_5_MS          0x0006
#define RADIOSTATION_TX_ACOMP_ATTACK_TIME_4_0_MS          0x0007
#define RADIOSTATION_TX_ACOMP_ATTACK_TIME_4_5_MS          0x0008
#define RADIOSTATION_TX_ACOMP_ATTACK_TIME_5_0_MS          0x0009
 
#define RADIOSTATION_PROP_TX_ACOMP_RELEASE_TIME           0x2203
#define RADIOSTATION_TX_ACOMP_RELEASE_TIME_100_MS         0x0000
#define RADIOSTATION_TX_ACOMP_RELEASE_TIME_200_MS         0x0001
#define RADIOSTATION_TX_ACOMP_RELEASE_TIME_350_MS         0x0002
#define RADIOSTATION_TX_ACOMP_RELEASE_TIME_525_MS         0x0003
#define RADIOSTATION_TX_ACOMP_RELEASE_TIME_1000_MS        0x0004
 
#define RADIOSTATION_PROP_TX_ACOMP_GAIN                   0x2204    // Value Range: 0 to 20
 
#define RADIOSTATION_PROP_TX_LIMITER_RELEASE_TIME         0x2205    // Value Range: 5 to 2000
 
#define RADIOSTATION_PROP_TX_ASQ_INTERRUPT_SELECT         0x2300
#define RADIOSTATION_TX_ASQ_INTERRUPT_OVERMODIEN          0x0004
#define RADIOSTATION_TX_ASQ_INTERRUPT_IALHIEN             0x0002
#define RADIOSTATION_TX_ASQ_INTERRUPT_IALLIEN             0x0001
 
#define RADIOSTATION_PROP_TX_ASQ_LEVEL_LOW                0x2301    // Value Range: -70 to 0
 
#define RADIOSTATION_PROP_TX_ASQ_LEVEL_HIGH               0x2303    // Value Range: -70 to 0
 
#define RADIOSTATION_PROP_TX_ASQ_DURATION_LOW             0x2302
 
#define RADIOSTATION_PROP_TX_ASQ_DURATION_HIGH            0x2304
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
    digital_out_t sen;
 
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
    uint16_t transmit_frequency;   // Frequency is represented in following way xxx.yy MHz 
    uint8_t status;
 
} radiostation_t;
 
typedef struct
{
    // Static variable
 
    uint8_t *params;
    uint8_t params_count;
    uint8_t *ret_vals;
    uint8_t ret_vals_count;
 
} radiostation_cmd_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t rst;
    pin_name_t sen;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    bool slave_select;
 
} radiostation_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void radiostation_cfg_setup ( radiostation_cfg_t *cfg, bool slave_select );
 
RADIOSTATION_RETVAL radiostation_init ( radiostation_t *ctx, radiostation_cfg_t *cfg );
 
void radiostation_default_cfg ( radiostation_t *ctx, radiostation_cmd_t *cmd );
 
void radiostation_write ( radiostation_t *ctx, uint8_t *data_buf, uint8_t len );
 
void radiostation_read ( radiostation_t *ctx, uint8_t *data_buf, uint8_t len );
 
uint8_t radiostation_power_up_advanced ( radiostation_t *ctx, radiostation_cmd_t *cmd, uint8_t config );
 
uint8_t radiostation_power_up ( radiostation_t *ctx, radiostation_cmd_t *cmd );
 
uint8_t radiostation_power_down ( radiostation_t *ctx, radiostation_cmd_t *cmd );
 
uint8_t radiostation_get_revision ( radiostation_t *ctx, radiostation_cmd_t *cmd, uint8_t *ret_vals );
 
uint8_t radiostation_get_revision1 ( radiostation_t *ctx, uint8_t *ret_vals );
 
uint8_t radiostation_set_tune_frequency ( radiostation_t *ctx, radiostation_cmd_t *cmd, uint16_t freq );
 
uint8_t radiostation_set_tune_power ( radiostation_t *ctx,  radiostation_cmd_t *cmd, uint8_t voltage, uint8_t capacitance );
 
uint8_t radiostation_get_tune_measure ( radiostation_t *ctx, radiostation_cmd_t *cmd, uint16_t freq, uint8_t capacitance );
 
uint8_t radiostation_get_int_status ( radiostation_t *ctx, radiostation_cmd_t *cmd ); 
 
void radiostation_busy_wait_for_stcint ( radiostation_t *ctx, radiostation_cmd_t *cmd );
 
void radiostation_busy_wait_for_asqint ( radiostation_t *ctx, radiostation_cmd_t *cmd );
 
void radiostation_busy_wait_for_rdsint ( radiostation_t *ctx, radiostation_cmd_t *cmd );
 
uint8_t radiostation_get_tune_status ( radiostation_t *ctx, radiostation_cmd_t *cmd, uint8_t clear_stc_status_bit, uint8_t *ret_vals );
 
uint8_t radiostation_get_asq_status ( radiostation_t *ctx, radiostation_cmd_t *cmd, uint8_t *ret_vals ) ;
 
uint8_t radiostation_set_property ( radiostation_t *ctx, radiostation_cmd_t *cmd, uint16_t property_id, uint16_t property_value );
 
uint16_t radiostation_get_property ( radiostation_t *ctx, radiostation_cmd_t *cmd, uint16_t property_id );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _RADIOSTATION_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END