dtmfdecoder  2.0.0.0
dtmfdecoder.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef DTMFDECODER_H
29 #define DTMFDECODER_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
69 #define DTMFDECODER_CMD_BYTE_INPUT 0x00
70 #define DTMFDECODER_CMD_BYTE_OUTPUT 0x01
71 #define DTMFDECODER_CMD_BYTE_POL_INV 0x02
72 #define DTMFDECODER_CMD_BYTE_CONFIG 0x03
73  // dtmfdecoder_cmd
75 
91 #define DTMFDECODER_SET_DEV_ADDR 0x41
92  // dtmfdecoder_set
94 
109 #define DTMFDECODER_MAP_MIKROBUS( cfg, mikrobus ) \
110  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
111  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
112  cfg.pwd = MIKROBUS( mikrobus, MIKROBUS_CS ); \
113  cfg.inh = MIKROBUS( mikrobus, MIKROBUS_RST ); \
114  cfg.std = MIKROBUS( mikrobus, MIKROBUS_INT )
115  // dtmfdecoder_map // dtmfdecoder
118 
123 typedef struct
124 {
125  // Output pins
126 
127  digital_out_t pwd;
128  digital_out_t inh;
130  // Input pins
131 
132  digital_in_t std;
134  // Modules
135 
136  i2c_master_t i2c;
138  // I2C slave address
139 
140  uint8_t slave_address;
142 } dtmfdecoder_t;
143 
148 typedef struct
149 {
150  pin_name_t scl;
151  pin_name_t sda;
153  pin_name_t pwd;
154  pin_name_t inh;
155  pin_name_t std;
157  uint32_t i2c_speed;
158  uint8_t i2c_address;
161 
166 typedef enum
167 {
169  DTMFDECODER_ERROR = -1
170 
172 
191 
209 
223 
241 err_t dtmfdecoder_generic_write ( dtmfdecoder_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
242 
260 err_t dtmfdecoder_generic_read ( dtmfdecoder_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
261 
273 
285 
297 
309 
322 
336 
337 #ifdef __cplusplus
338 }
339 #endif
340 #endif // DTMFDECODER_H
341  // dtmfdecoder
343 
344 // ------------------------------------------------------------------------ END
dtmfdecoder_init
err_t dtmfdecoder_init(dtmfdecoder_t *ctx, dtmfdecoder_cfg_t *cfg)
DTMF Decoder initialization function.
dtmfdecoder_cfg_t::inh
pin_name_t inh
Definition: dtmfdecoder.h:154
dtmfdecoder_tone_read
uint8_t dtmfdecoder_tone_read(dtmfdecoder_t *ctx)
DTMF Decoder read tone function.
dtmfdecoder_t::std
digital_in_t std
Definition: dtmfdecoder.h:132
dtmfdecoder_cfg_setup
void dtmfdecoder_cfg_setup(dtmfdecoder_cfg_t *cfg)
DTMF Decoder configuration object setup function.
dtmfdecoder_generic_write
err_t dtmfdecoder_generic_write(dtmfdecoder_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
DTMF Decoder I2C writing function.
dtmfdecoder_delayed_steering_check
uint8_t dtmfdecoder_delayed_steering_check(dtmfdecoder_t *ctx)
DTMF Decoder check delayed steering function.
dtmfdecoder_default_cfg
void dtmfdecoder_default_cfg(dtmfdecoder_t *ctx)
DTMF Decoder default configuration function.
dtmfdecoder_inhibit_on
void dtmfdecoder_inhibit_on(dtmfdecoder_t *ctx)
DTMF Decoder inhibit on function.
dtmfdecoder_cfg_t::pwd
pin_name_t pwd
Definition: dtmfdecoder.h:153
dtmfdecoder_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: dtmfdecoder.h:157
dtmfdecoder_t::pwd
digital_out_t pwd
Definition: dtmfdecoder.h:127
dtmfdecoder_inhibit_off
void dtmfdecoder_inhibit_off(dtmfdecoder_t *ctx)
DTMF Decoder inhibit off function.
dtmfdecoder_powerdown_on
void dtmfdecoder_powerdown_on(dtmfdecoder_t *ctx)
DTMF Decoder power down on function.
dtmfdecoder_cfg_t
DTMF Decoder Click configuration object.
Definition: dtmfdecoder.h:149
dtmfdecoder_t::slave_address
uint8_t slave_address
Definition: dtmfdecoder.h:140
dtmfdecoder_cfg_t::sda
pin_name_t sda
Definition: dtmfdecoder.h:151
DTMFDECODER_ERROR
@ DTMFDECODER_ERROR
Definition: dtmfdecoder.h:169
dtmfdecoder_t::inh
digital_out_t inh
Definition: dtmfdecoder.h:128
dtmfdecoder_powerdown_off
void dtmfdecoder_powerdown_off(dtmfdecoder_t *ctx)
DTMF Decoder power down off function.
dtmfdecoder_generic_read
err_t dtmfdecoder_generic_read(dtmfdecoder_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
DTMF Decoder I2C reading function.
dtmfdecoder_t
DTMF Decoder Click context object.
Definition: dtmfdecoder.h:124
dtmfdecoder_return_value_t
dtmfdecoder_return_value_t
DTMF Decoder Click return value data.
Definition: dtmfdecoder.h:167
dtmfdecoder_t::i2c
i2c_master_t i2c
Definition: dtmfdecoder.h:136
dtmfdecoder_cfg_t::scl
pin_name_t scl
Definition: dtmfdecoder.h:150
dtmfdecoder_cfg_t::std
pin_name_t std
Definition: dtmfdecoder.h:155
DTMFDECODER_OK
@ DTMFDECODER_OK
Definition: dtmfdecoder.h:168
dtmfdecoder_cfg_t::i2c_address
uint8_t i2c_address
Definition: dtmfdecoder.h:158