dtmfdecoder.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 DTMFDECODER_H
#define DTMFDECODER_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 DTMFDECODER_CMD_BYTE_INPUT                     0x00
#define DTMFDECODER_CMD_BYTE_OUTPUT                    0x01
#define DTMFDECODER_CMD_BYTE_POL_INV                   0x02
#define DTMFDECODER_CMD_BYTE_CONFIG                    0x03
 
 // dtmfdecoder_cmd
 
#define DTMFDECODER_SET_DEV_ADDR  0x41
 
 // dtmfdecoder_set
 
#define DTMFDECODER_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.pwd = MIKROBUS( mikrobus, MIKROBUS_CS );  \
    cfg.inh = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.std = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // dtmfdecoder_map
 // dtmfdecoder
 
typedef struct
{
    // Output pins
 
    digital_out_t  pwd;                              
    digital_out_t  inh;                              
    // Input pins
 
    digital_in_t   std;                              
    // Modules
 
    i2c_master_t   i2c;                              
    // I2C slave address
 
    uint8_t slave_address;                           
} dtmfdecoder_t;
 
typedef struct
{
    pin_name_t  scl;                                 
    pin_name_t  sda;                                 
    pin_name_t  pwd;                                 
    pin_name_t  inh;                                 
    pin_name_t  std;                                 
    uint32_t  i2c_speed;                             
    uint8_t   i2c_address;                           
} dtmfdecoder_cfg_t;
 
typedef enum
{
    DTMFDECODER_OK = 0,
    DTMFDECODER_ERROR = -1
 
} dtmfdecoder_return_value_t;
 
void dtmfdecoder_cfg_setup ( dtmfdecoder_cfg_t *cfg );
 
err_t dtmfdecoder_init ( dtmfdecoder_t *ctx, dtmfdecoder_cfg_t *cfg );
 
void dtmfdecoder_default_cfg ( dtmfdecoder_t *ctx );
 
err_t dtmfdecoder_generic_write ( dtmfdecoder_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t dtmfdecoder_generic_read ( dtmfdecoder_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
void dtmfdecoder_inhibit_on ( dtmfdecoder_t *ctx );
 
void dtmfdecoder_inhibit_off ( dtmfdecoder_t *ctx );
 
void dtmfdecoder_powerdown_on ( dtmfdecoder_t *ctx );
 
void dtmfdecoder_powerdown_off ( dtmfdecoder_t *ctx );
 
uint8_t dtmfdecoder_delayed_steering_check ( dtmfdecoder_t *ctx );
 
uint8_t dtmfdecoder_tone_read ( dtmfdecoder_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // DTMFDECODER_H
 
 // dtmfdecoder
 
// ------------------------------------------------------------------------ END