dtmfgenerator.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 DTMFGENERATOR_H
#define DTMFGENERATOR_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"
 
#define DTMFGENERATOR_OUT_TONE_0                                    0x00
#define DTMFGENERATOR_OUT_TONE_1                                    0x01
#define DTMFGENERATOR_OUT_TONE_2                                    0x02
#define DTMFGENERATOR_OUT_TONE_3                                    0x03
#define DTMFGENERATOR_OUT_TONE_4                                    0x04
#define DTMFGENERATOR_OUT_TONE_5                                    0x05
#define DTMFGENERATOR_OUT_TONE_6                                    0x06
#define DTMFGENERATOR_OUT_TONE_7                                    0x07
#define DTMFGENERATOR_OUT_TONE_8                                    0x08
#define DTMFGENERATOR_OUT_TONE_9                                    0x09
#define DTMFGENERATOR_OUT_TONE_A                                    0x0A
#define DTMFGENERATOR_OUT_TONE_B                                    0x0B
#define DTMFGENERATOR_OUT_TONE_C                                    0x0C
#define DTMFGENERATOR_OUT_TONE_D                                    0x0D
#define DTMFGENERATOR_OUT_TONE_ASTERISK                             0x0E
#define DTMFGENERATOR_OUT_TONE_HASH                                 0x0F
#define DTMFGENERATOR_OUT_TONE_STOP                                 0x10
 
#define DTMFGENERATOR_GPIO_PIN_STATE_LOW                            0x00
#define DTMFGENERATOR_GPIO_PIN_STATE_HIGH                           0x01
 // dtmfgenerator_set
 
#define DTMFGENERATOR_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.dat = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.ce = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.clk = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // dtmfgenerator_map
 // dtmfgenerator
 
typedef struct
{
    digital_out_t  dat;     
    digital_out_t  ce;       
    digital_out_t  clk;     
} dtmfgenerator_t;
 
typedef struct
{
    pin_name_t  dat;    
    pin_name_t  ce;      
    pin_name_t  clk;    
} dtmfgenerator_cfg_t;
 
typedef enum
{
   DTMFGENERATOR_OK = 0,
   DTMFGENERATOR_ERROR = -1
 
} dtmfgenerator_return_value_t;
 
void dtmfgenerator_cfg_setup ( dtmfgenerator_cfg_t *cfg );
 
err_t dtmfgenerator_init ( dtmfgenerator_t *ctx, dtmfgenerator_cfg_t *cfg );
 
void dtmfgenerator_set_dat ( dtmfgenerator_t *ctx, uint8_t pin_state );
 
void dtmfgenerator_set_ce ( dtmfgenerator_t *ctx, uint8_t pin_state );
 
void dtmfgenerator_set_clk ( dtmfgenerator_t *ctx, uint8_t pin_state );
 
void dtmfgenerator_power_on ( dtmfgenerator_t *ctx );
 
void dtmfgenerator_transmit_out_tone ( dtmfgenerator_t *ctx, uint8_t out_tone, uint16_t delay_m_s );
 
#ifdef __cplusplus
}
#endif
#endif // DTMFGENERATOR_H
 
 // dtmfgenerator
 
// ------------------------------------------------------------------------ END