amfm2.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 AMFM2_H
#define AMFM2_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_i2c_master.h"
 
#define AMFM2_CMD_POWER_UP                    0x01
#define AMFM2_CMD_GET_REV                     0x10
#define AMFM2_CMD_POWER_DOWN                  0x11
#define AMFM2_CMD_SET_PROPERTY                0x12
#define AMFM2_CMD_GET_PROPERTY                0x13
#define AMFM2_CMD_GET_INT_STATUS              0x14
#define AMFM2_CMD_PATCH_ARGS                  0x15
#define AMFM2_CMD_PATCH_DATA                  0x16
#define AMFM2_CMD_TX_TUNE_FREQ                0x30
#define AMFM2_CMD_TX_TUNE_POWER               0x31
#define AMFM2_CMD_TX_TUNE_MEASURE             0x32
#define AMFM2_CMD_TX_TUNE_STATUS              0x33
#define AMFM2_CMD_TX_ASQ_STATUS               0x34
#define AMFM2_CMD_TX_RDS_BUFF                 0x35
#define AMFM2_CMD_TX_TX_RDS_PS                0x36
#define AMFM2_CMD_GPIO_CTL                    0x80
#define AMFM2_CMD_GPIO_SET                    0x81
 
#define AMFM2_CMD_AM_TUNE_FREQ                0x40
#define AMFM2_CMD_AM_SEEK_START               0x41
#define AMFM2_CMD_AM_TUNE_STATUS              0x42
#define AMFM2_CMD_AM_RSQ_STATUS               0x43
#define AMFM2_CMD_AM_AGC_STATUS               0x47
#define AMFM2_CMD_AM_AGC_OVERRIDE             0x48
 
#define AMFM2_CMD_FM_TUNE_FREQ                0x20
#define AMFM2_CMD_FM_SEEK_START               0x21
#define AMFM2_CMD_FM_TUNE_STATUS              0x22
#define AMFM2_CMD_FM_RSQ_STATUS               0x23
#define AMFM2_CMD_FM_RDS_STATUS               0x24
#define AMFM2_CMD_FM_AGC_STATUS               0x27
#define AMFM2_CMD_FM_AGC_OVERRIDE             0x28
 
 // amfm2_cmd
 
#define AMFM2_RSP_STATUS_CTS                  0x80
#define AMFM2_RSP_STATUS_ERROR                0x40
#define AMFM2_RSP_STATUS_RDSINT               0x04
#define AMFM2_RSP_STATUS_ASQINT               0x02
#define AMFM2_RSP_STATUS_STCINT               0x01
 
#define AMFM2_PWRUP_ARG_CTSIEN                0x80
#define AMFM2_PWRUP_ARG_GPO2OEN               0x40
#define AMFM2_PWRUP_ARG_PATCH                 0x20
#define AMFM2_PWRUP_ARG_XOSCEN                0x10
#define AMFM2_PWRUP_ARG_FUNC_FMRECEIVE        0x00
#define AMFM2_PWRUP_ARG_FUNC_QUERYLIBID       0x0F
#define AMFM2_PWRUP_ARG_OPMODE_ANALOGOUT      0x05
#define AMFM2_PWRUP_ARG_OPMODE_DIGITALOUT     0x0B
#define AMFM2_PWRUP_ARG_OPMODE_DIGITALOUTS    0xB0
#define AMFM2_FMTUNEFREQ_ARG_FREEZE           0x02
#define AMFM2_FMTUNEFREQ_ARG_FAST             0x01
#define AMFM2_FMSEEKSTART_ARG_SEEKUP          0x08
#define AMFM2_FMSEEKSTART_ARG_WRAP            0x04
#define AMFM2_FMTUNESTATUS_ARG_CANCEL         0x02
#define AMFM2_FMTUNESTATUS_ARG_INTACK         0x01
#define AMFM2_FMRSQSTATUS_ARG_INTACK          0x01
#define AMFM2_FMRDSSTATUS_ARG_STATUSONLY      0x04
#define AMFM2_FMRDSSTATUS_ARG_MTFIFO          0x02
#define AMFM2_FMRDSSTATUS_ARG_INTACK          0x01
#define AMFM2_FMAGCOVERRIDE_ARG_RFAGCDIS      0x01
#define AMFM2_GPIOCTL_ARG_GPO3OEN             0x08
#define AMFM2_GPIOCTL_ARG_GPO2OEN             0x04
#define AMFM2_GPIOCTL_ARG_GPO1OEN             0x02
#define AMFM2_GPIOSET_ARG_GPO3LEVEL           0x08
#define AMFM2_GPIOSET_ARG_GPO2LEVEL           0x04
#define AMFM2_GPIOSET_ARG_GPO1LEVEL           0x02
 
#define AMFM2_SET_VOLUME_MUTE                 0
#define AMFM2_SET_VOLUME_MAX                  63
 
#define AMFM2_PROP_GPOIEN_H                   0x00
#define AMFM2_PROP_GPOIEN_L                   0x01
#define AMFM2_PROP_DIGITALOUTFORMAT_H         0x01
#define AMFM2_PROP_DIGITALOUTFORMAT_L         0x02
#define AMFM2_PROP_DIGITALOUTSAMPLERATE_H     0x01
#define AMFM2_PROP_DIGITALOUTSAMPLERATE_L     0x04
#define AMFM2_PROP_REFCLKFREQ_H               0x02
#define AMFM2_PROP_REFCLKFREQ_L               0x01
#define AMFM2_PROP_REFCLKPRESCALE_H           0x02
#define AMFM2_PROP_REFCLKPRESCALE_L           0x02
#define AMFM2_PROP_RXVOLUME_H                 0x40
#define AMFM2_PROP_RXVOLUME_L                 0x00
#define AMFM2_PROP_RXHMUTE_H                  0x40
#define AMFM2_PROP_RXHMUTE_L                  0x01
 
#define AMFM2_PROP_FMDEEMPHASIS_H             0x11
#define AMFM2_PROP_FMDEEMPHASIS_L             0x00
#define AMFM2_PROP_AMDEEMPHASIS_H             0x31
#define AMFM2_PROP_AMDEEMPHASIS_L             0x00
#define AMFM2_PROP_FMCHANFILTER_H             0x11
#define AMFM2_PROP_FMCHANFILTER_L             0x02
#define AMFM2_PROP_AMCHANFILTER_H             0x31
#define AMFM2_PROP_AMCHANFILTER_L             0x02
#define AMFM2_PROP_AMRSQINTS_H                0x32
#define AMFM2_PROP_AMRSQINTS_L                0x00
#define AMFM2_PROP_AMNBRATE_H                 0x39
#define AMFM2_PROP_AMNBRATE_L                 0x02
#define AMFM2_PROP_AMNBIIRFILTER_H            0x39
#define AMFM2_PROP_AMNBIIRFILTER_L            0x03
#define AMFM2_PROP_AMNBDELAY_H                0x39
#define AMFM2_PROP_AMNBDELAY_L                0x04
 
#define AMFM2_PROP_FMBLENDSTEREOTHS_H         0x11
#define AMFM2_PROP_FMBLENDSTEREOTHS_L         0x05
#define AMFM2_PROP_FMBLENDMONOTHS_H           0x11
#define AMFM2_PROP_FMBLENDMONOTHS_L           0x06
#define AMFM2_PROP_FMNBDETECTTHS_H            0x19
#define AMFM2_PROP_FMNBDETECTTHS_L            0x00
#define AMFM2_PROP_FMNBINTERVAL_H             0x19
#define AMFM2_PROP_FMNBINTERVAL_L             0x01
#define AMFM2_PROP_FMNBRATE_H                 0x19
#define AMFM2_PROP_FMNBRATE_L                 0x02
#define AMFM2_PROP_FMNBIIRFILTER_H            0x19
#define AMFM2_PROP_FMNBIIRFILTER_L            0x03
#define AMFM2_PROP_FMNBDELAY_H                0x19
#define AMFM2_PROP_FMNBDELAY_L                0x04
 
#define AMFM2_PROPVALH_RSQREP                 0x08
#define AMFM2_PROPVALH_RDSREP                 0x04
#define AMFM2_PROPVALH_STCREP                 0x01
#define AMFM2_PROPVALL_CTSIEN                 0x80
#define AMFM2_PROPVALL_ERRIEN                 0x40
#define AMFM2_PROPVALL_RSQIEN                 0x08
#define AMFM2_PROPVALL_RDSIEN                 0x04
#define AMFM2_PROPVALL_STCIEN                 0x01
#define AMFM2_PROPVALL_OFALL                  0x80
#define AMFM2_PROPVALL_LMUTE                  0x02
#define AMFM2_PROPVALL_RMUTE                  0x01
 
#define AMFM2_DEVICE_ADDRESS_GND              0x11
#define AMFM2_DEVICE_ADDRESS_VCC              0x63
 
 // amfm2_set
 
#define AMFM2_MAP_MIKROBUS( cfg, mikrobus )       \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.ema = MIKROBUS( mikrobus, MIKROBUS_AN );  \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.gp2 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // amfm2_map
 // amfm2
 
typedef struct
{
    // Output pins
    digital_out_t ema;    
    digital_out_t rst;    
    // Input pins
    digital_in_t gp1;    
    digital_in_t gp2;    
    // Modules
    i2c_master_t i2c;    
    // I2C slave address
    uint8_t slave_address;    
} amfm2_t;
 
typedef struct
{
    pin_name_t scl;    
    pin_name_t sda;    
    pin_name_t ema;    
    pin_name_t rst;    
    pin_name_t gp1;    
    pin_name_t gp2;    
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
} amfm2_cfg_t;
 
typedef struct
{
    uint8_t  pn;          
    uint8_t  fwmajor;     
    uint8_t  fwminor;     
    uint16_t patch;       
    uint8_t  cmpmajor;    
    uint8_t  cmpminor;    
    uint8_t  chiprev;     
} amfm2_device_info_t;
 
typedef enum
{
    AMFM2_OK = 0,
    AMFM2_ERROR = -1
 
} amfm2_return_value_t;
 
void amfm2_cfg_setup ( amfm2_cfg_t *cfg );
 
err_t amfm2_init ( amfm2_t *ctx, amfm2_cfg_t *cfg );
 
err_t amfm2_default_cfg ( amfm2_t *ctx );
 
err_t amfm2_write_data ( amfm2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t amfm2_generic_read ( amfm2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void amfm2_hw_reset ( amfm2_t *ctx );
 
void amfm2_headphone_amp_enable ( amfm2_t *ctx );
 
void amfm2_headphone_amp_disable ( amfm2_t *ctx );
 
uint8_t amfm2_get_gp1 ( amfm2_t *ctx );
 
uint8_t amfm2_get_gp2 ( amfm2_t *ctx );
 
void amfm2_set_rst ( amfm2_t *ctx, uint8_t pin_state );
 
err_t amfm2_wait_rsp ( amfm2_t *ctx );
 
err_t amfm2_set_command ( amfm2_t *ctx, uint8_t cmd, uint8_t *arg, 
                          uint8_t arg_len, uint8_t *rsp, uint8_t rsp_len );
 
err_t amfm2_get_response ( amfm2_t *ctx, uint8_t *rsp, uint8_t rsp_len );
 
err_t amfm2_get_rev ( amfm2_t *ctx, amfm2_device_info_t *rev );
 
err_t amfm2_seek_station ( amfm2_t *ctx, uint8_t *rsp );
 
err_t amfm2_set_volume ( amfm2_t *ctx, uint8_t volume, uint8_t *rsp );
 
err_t amfm2_sound_off ( amfm2_t *ctx, uint8_t *rsp );
 
err_t amfm2_sound_on ( amfm2_t *ctx, uint8_t *rsp );
 
err_t amfm2_tuning_freq_up ( amfm2_t *ctx, uint8_t *rsp );
 
err_t amfm2_tuning_freq_down ( amfm2_t *ctx, uint8_t *rsp );
 
err_t amfm2_tuning_freq ( amfm2_t *ctx, float frequency, uint8_t *rsp );
 
err_t amfm2_get_tuning_freq ( amfm2_t *ctx, float *frequency );
 
err_t amfm2_check_clear_to_send ( amfm2_t *ctx );
 
err_t amfm2_check_seek_tune_complete ( amfm2_t *ctx );
 
err_t amfm2_check_status_error ( amfm2_t *ctx );
 
err_t amfm2_check_rds_interrupt ( amfm2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // AMFM2_H
 
 // amfm2
 
// ------------------------------------------------------------------------ END