fm  2.0.0.0
fm.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef FM_H
36 #define FM_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define FM_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg.gp2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
66  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
67  cfg.sen = MIKROBUS( mikrobus, MIKROBUS_CS ); \
68  cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_INT )
69 
75 #define FM_RETVAL uint8_t
76 
77 #define FM_OK 0x00
78 #define FM_INIT_ERROR 0xFF
79 
85 #define DEFAULT_SLAVE_ADDRESS 0x10
86 
92 #define FM_DEVICE_ID 0x000E
93 #define FM_CHIP_ID 0x000F
94 #define FM_POWER_CONFIGURATION 0x0000
95 #define FM_CHANNEL 0x0001
96 #define FM_SYSTEM_CONFIGURATION_1 0x0002
97 #define FM_SYSTEM_CONFIGURATION_2 0x0003
98 #define FM_SYSTEM_CONFIGURATION_3 0x0004
99 #define FM_TEST_1 0x0005
100 #define FM_TEST_2 0x0006
101 #define FM_BOOT_CONFIGURATION 0x0007
102 #define FM_STATUS_RSSI 0x0008
103 #define FM_READ_CHANNEL 0x0009
104 #define FM_RDS_A 0x000A
105 #define FM_RDS_B 0x000B
106 #define FM_RDS_C 0x000C
107 #define FM_RDS_D 0x000D
108 
114 #define FM_SOFTMUTE_MASK 0x7FFF
115 #define FM_SOFTMUTE_ENABLE 0x0000
116 #define FM_SOFTMUTE_DISABLE 0x8000
117 
118 #define FM_MUTE_MASK 0xBFFF
119 #define FM_MUTE_ENABLE 0x0000
120 #define FM_MUTE_DISABLE 0x4000
121 
122 #define FM_STEREO_MASK 0xDFFF
123 #define FM_STEREO 0x0000
124 #define FM_FORCE_MONO 0x2000
125 
126 #define FM_RDS_MODE_MASK 0xF7FF
127 #define FM_RDS_MODE_STANDARD 0x0000
128 #define FM_RDS_MODE_VERBOSE 0x0800
129 
130 #define FM_SEEK_MODE_MASK 0xFBFF
131 #define FM_SEEK_MODE_WRAP 0x0000
132 #define FM_SEEK_MODE_STOP 0x0400
133 
134 #define FM_SEEK_DIRECTION_MASK 0xFDFF
135 #define FM_SEEK_DIRECTION_DOWN 0x0000
136 #define FM_SEEK_DIRECTION_UP 0x0200
137 
138 #define FM_SEEK_MASK 0xFEFF
139 #define FM_SEEK_DISABLE 0x0000
140 #define FM_SEEK_ENABLE 0x0100
141 
142 #define FM_POWERUP_DISABLE_MASK 0xFFBF
143 #define FM_POWERUP_DISABLE_LOW 0x0000
144 #define FM_POWERUP_DISABLE_HIGH 0x0040
145 
146 #define FM_POWERUP_ENABLE_MASK 0xFFFE
147 #define FM_POWERUP_ENABLE_LOW 0x0000
148 #define FM_POWERUP_ENABLE_HIGH 0x0001
149 
155 #define FM_TUNE_MASK 0x7FFF
156 #define FM_TUNE_DISABLE 0x0000
157 #define FM_TUNE_ENABLE 0x8000
158 
164 #define FM_RDS_INTERRUPT_MASK 0x7FFF
165 #define FM_RDS_INTERRUPT_DISABLE 0x0000
166 #define FM_RDS_INTERRUPT_ENABLE 0x8000
167 
168 #define FM_SEEK_TUNE_COMPLETE_INTERRUPT_MASK 0xBFFF
169 #define FM_SEEK_TUNE_COMPLETE_INTERRUPT_DISABLE 0x0000
170 #define FM_SEEK_TUNE_COMPLETE_INTERRUPT_ENABLE 0x4000
171 
172 #define FM_RDS_MASK 0xEFFF
173 #define FM_RDS_DISABLE 0x0000
174 #define FM_RDS_ENABLE 0x1000
175 
176 #define FM_DE_EMPHASIS_MASK 0xF7FF
177 #define FM_DE_EMPHASIS_USA 0x0000
178 #define FM_DE_EMPHASIS_EUROPE_AUSTRALIA_JAPAN 0x0800
179 
180 #define FM_AGC_MASK 0xFBFF
181 #define FM_AGC_ENABLE 0x0000
182 #define FM_AGC_DISABLE 0x0400
183 
184 #define FM_STEREO_MONO_BLEND_LEVEL_MASK 0xFF3F
185 #define FM_STEREO_MONO_BLEND_LEVEL_31_49_RSSI 0x0000
186 #define FM_STEREO_MONO_BLEND_LEVEL_37_55_RSSI 0x0040
187 #define FM_STEREO_MONO_BLEND_LEVEL_19_37_RSSI 0x0080
188 #define FM_STEREO_MONO_BLEND_LEVEL_25_43_RSSI 0x00C0
189 
190 #define FM_GPIO3_MASK 0xFFCF
191 #define FM_GPIO3_HIGH_IMPENDANCE 0x0000
192 #define FM_GPIO3_MONO_STEREO_INDICATOR 0x0001
193 #define FM_GPIO3_LOW 0x0002
194 #define FM_GPIO3_HIGH 0x0003
195 
196 #define FM_GPIO2_MASK 0xFFF3
197 #define FM_GPIO2_HIGH_IMPEDANCE 0x0000
198 #define FM_GPIO2_STC_RDS_INTERRUPT 0x0004
199 #define FM_GPIO2_LOW 0x0008
200 #define FM_GPIO2_HIGH 0x000C
201 
202 #define FM_GPIO1_MASK 0xFFFC
203 #define FM_GPIO1_HIGH_IMPEDANCE 0x0000
204 #define FM_GPIO1_RESERVED 0x0001
205 #define FM_GPIO1_LOW 0x0002
206 #define FM_GPIO1_HIGH 0x0003
207 
213 #define FM_BAND_MASK 0xFF3F
214 #define FM_BAND_USA_EUROPE_87P5_108_MHZ 0x0000
215 #define FM_BAND_JAPAN_WIDE_76_108_MHZ 0x0040
216 #define FM_BAND_JAPAN_76_90_MHZ 0x0080
217 #define FM_BAND_RESERVED 0x00C0
218 
219 #define FM_CHANNEL_SPACING_MASK 0xFFCF
220 #define FM_CHANNEL_SPACING_USA_AUSTRALIA_200_KHZ 0x0000
221 #define FM_CHANNEL_SPACING_EUROPE_JAPAN_100_KHZ 0x0010
222 #define FM_CHANNEL_SPACING_50_KHZ 0x0020
223 
229 #define FM_SOFTMUTE_ATTACK_RECOVER_RATE_MASK 0x3FFF
230 #define FM_SOFTMUTE_ATTACK_RECOVER_RATE_FASTEST 0x0000
231 #define FM_SOFTMUTE_ATTACK_RECOVER_RATE_FAST 0x4000
232 #define FM_SOFTMUTE_ATTACK_RECOVER_RATE_SLOW 0x8000
233 #define FM_SOFTMUTE_ATTACK_RECOVER_RATE_SLOWEST 0xC000
234 
235 #define FM_SOFTMUTE_ATTENUATION_MASK 0xCFFF
236 #define FM_SOFTMUTE_ATTENUATION_16_DB 0x0000
237 #define FM_SOFTMUTE_ATTENUATION_14_DB 0x1000
238 #define FM_SOFTMUTE_ATTENUATION_12_DB 0x2000
239 #define FM_SOFTMUTE_ATTENUATION_10_DB 0x3000
240 
241 #define FM_EXTENDED_VOLUME_RANGE_MASK 0xFEFF
242 #define FM_EXTENDED_VOLUME_RANGE_DISABLED 0x0000
243 #define FM_EXTENDED_VOLUME_RANGE_ENABLED 0x0100
244 
250 #define FM_CRYSTAL_OSCYLATOR_MASK 0x7FFF
251 #define FM_CRYSTAL_OSCYLATOR_DISABLE 0x0000
252 #define FM_CRYSTAL_OSCYLATOR_ENABLE 0x8000
253 
254 #define FM_AUDIO_HIGH_Z_MASK 0xBFFF
255 #define FM_AUDIO_HIGH_Z_DISABLE 0x0000
256 #define FM_AUDIO_HIGH_Z_ENABLE 0x4000
257 
263 #define FM_RDS_READY_MASK 0x8000
264 #define FM_SEEK_TUNE_COMPLETE_MASK 0x4000
265 #define FM_SEEK_FAIL_BAND_LIMIT_MASK 0x2000
266 #define FM_AFC_RAIL_MASK 0x1000
267 #define FM_RDS_SYNCHRONIZED_MASK 0x0800
268 #define FM_STEREO_MONO_INDICATOR_MASK 0x0100
269  // End group macro
272 // --------------------------------------------------------------- PUBLIC TYPES
281 typedef struct
282 {
283  // Output pins
284 
285  digital_out_t rst;
286  digital_out_t sen;
287 
288  // Input pins
289 
290  digital_in_t gp2;
291  digital_in_t gp1;
292 
293  // Modules
294 
295  i2c_master_t i2c;
296 
297  // ctx variable
298 
299  uint8_t slave_address;
300 
301 } fm_t;
302 
306 typedef struct
307 {
308  // Communication gpio pins
309 
310  pin_name_t scl;
311  pin_name_t sda;
312 
313  // Additional gpio pins
314 
315  pin_name_t gp2;
316  pin_name_t rst;
317  pin_name_t sen;
318  pin_name_t gp1;
319 
320  // static variable
321 
322  uint32_t i2c_speed;
323  uint8_t i2c_address;
324 
325 } fm_cfg_t;
326  // End types group
328 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
329 
335 #ifdef __cplusplus
336 extern "C"{
337 #endif
338 
347 void fm_cfg_setup ( fm_cfg_t *cfg );
348 
358 
366 void fm_default_cfg ( fm_t *ctx );
367 
377 void fm_generic_write ( fm_t *ctx, uint16_t *reg_buf );
378 
390 void fm_generic_read ( fm_t *ctx, uint16_t *reg_buf );
391 
405 void fm_set_bits ( uint16_t *register_buffer, uint16_t register_address, uint16_t bits_mask, uint16_t bits_value );
406 
418 uint8_t fm_set_seek_threshold ( fm_t *ctx, uint16_t seek_threshold );
419 
432 uint8_t fm_set_volume ( fm_t *ctx, uint8_t volume_level );
433 
445 uint8_t fm_set_snr_threshold ( fm_t *ctx, uint8_t snr_threshold );
446 
458 uint8_t fm_set_seek_impulse_detection_threshold ( fm_t *ctx, uint8_t impulse_detection_threshold );
459 
472 uint8_t fm_get_errors_block_a ( fm_t *ctx );
473 
483 
496 uint8_t fm_get_errors_block_b ( fm_t *ctx );
497 
510 uint8_t fm_get_errors_block_c ( fm_t *ctx );
511 
524 uint8_t fm_get_errors_block_d ( fm_t *ctx );
525 
535 
546 void fm_power_up ( fm_t *ctx );
547 
556 void fm_basic_settings ( fm_t *ctx );
557 
565 void fm_power_down ( fm_t *ctx );
566 
575 uint16_t fm_get_channel ( fm_t *ctx );
576 
585 void fm_tune_channel ( fm_t *ctx, uint16_t channel );
586 
598 uint8_t fm_tune ( fm_t *ctx, float channel_frequency );
599 
609 void fm_end_tune ( fm_t *ctx );
610 
619 void fm_seek ( fm_t *ctx );
620 
631 void fm_end_seek ( fm_t *ctx );
632 
643 uint8_t fm_volume_up ( fm_t *ctx );
644 
655 uint8_t fm_volume_down ( fm_t *ctx );
656 
664 void fm_mute_enable ( fm_t *ctx );
665 
673 void fm_mute_disable ( fm_t *ctx );
674 
683 uint8_t fm_fine_tune_up ( fm_t *ctx);
684 
692 uint8_t fm_fine_tune_down ( fm_t *ctx );
693 
702 uint8_t fm_get_int_pin ( fm_t *ctx );
703 
711 uint8_t fm_get_an_pin ( fm_t *ctx );
712 
713 #ifdef __cplusplus
714 }
715 #endif
716 #endif // _FM_H_
717  // End public_function group
720 
721 // ------------------------------------------------------------------------- END
fm_set_volume
uint8_t fm_set_volume(fm_t *ctx, uint8_t volume_level)
Setting volume value.
fm_cfg_t::gp2
pin_name_t gp2
Definition: fm.h:315
fm_power_up
void fm_power_up(fm_t *ctx)
Powering up device.
fm_set_seek_threshold
uint8_t fm_set_seek_threshold(fm_t *ctx, uint16_t seek_threshold)
Setting seek threshold value.
fm_cfg_t::sda
pin_name_t sda
Definition: fm.h:311
fm_fine_tune_up
uint8_t fm_fine_tune_up(fm_t *ctx)
Fine tunning.
fm_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: fm.h:322
fm_basic_settings
void fm_basic_settings(fm_t *ctx)
Setting basic settings.
fm_t::rst
digital_out_t rst
Definition: fm.h:285
fm_mute_disable
void fm_mute_disable(fm_t *ctx)
Disable mute.
fm_end_tune
void fm_end_tune(fm_t *ctx)
End tunning.
fm_t::gp2
digital_in_t gp2
Definition: fm.h:290
fm_get_errors_block_d
uint8_t fm_get_errors_block_d(fm_t *ctx)
Reading number of errors to be corrected.
fm_seek
void fm_seek(fm_t *ctx)
Start seeking radio station.
fm_tune
uint8_t fm_tune(fm_t *ctx, float channel_frequency)
Tunning radio station.
fm_cfg_t::i2c_address
uint8_t i2c_address
Definition: fm.h:323
fm_cfg_t
Click configuration structure definition.
Definition: fm.h:307
fm_get_errors_block_b
uint8_t fm_get_errors_block_b(fm_t *ctx)
Reading number of errors to be corrected.
fm_init
FM_RETVAL fm_init(fm_t *ctx, fm_cfg_t *cfg)
Initialization function.
fm_cfg_setup
void fm_cfg_setup(fm_cfg_t *cfg)
Config Object Initialization function.
fm_get_channel
uint16_t fm_get_channel(fm_t *ctx)
Reading CHANNEL bits.
fm_cfg_t::sen
pin_name_t sen
Definition: fm.h:317
fm_set_seek_impulse_detection_threshold
uint8_t fm_set_seek_impulse_detection_threshold(fm_t *ctx, uint8_t impulse_detection_threshold)
Setting seek impulse detection threshold value.
fm_get_channel_frequency
float fm_get_channel_frequency(fm_t *ctx)
Calculating current channel frequency.
fm_t::i2c
i2c_master_t i2c
Definition: fm.h:295
fm_end_seek
void fm_end_seek(fm_t *ctx)
End seeking.
fm_cfg_t::gp1
pin_name_t gp1
Definition: fm.h:318
FM_RETVAL
#define FM_RETVAL
Definition: fm.h:75
fm_get_int_pin
uint8_t fm_get_int_pin(fm_t *ctx)
Checking INT pin status.
fm_set_bits
void fm_set_bits(uint16_t *register_buffer, uint16_t register_address, uint16_t bits_mask, uint16_t bits_value)
Setting bits in specific register on a specific bit location.
fm_volume_down
uint8_t fm_volume_down(fm_t *ctx)
Decreasing volume level.
fm_get_received_signal_strength_indicator
uint8_t fm_get_received_signal_strength_indicator(fm_t *ctx)
Reading recived strength indicator.
fm_fine_tune_down
uint8_t fm_fine_tune_down(fm_t *ctx)
Fine tunning.
fm_t::sen
digital_out_t sen
Definition: fm.h:286
fm_mute_enable
void fm_mute_enable(fm_t *ctx)
Enable mute.
fm_get_errors_block_a
uint8_t fm_get_errors_block_a(fm_t *ctx)
Reading number of errors to be corrected.
fm_generic_read
void fm_generic_read(fm_t *ctx, uint16_t *reg_buf)
Reading all registers.
fm_cfg_t::scl
pin_name_t scl
Definition: fm.h:310
fm_default_cfg
void fm_default_cfg(fm_t *ctx)
Click Default Configuration function.
fm_t::gp1
digital_in_t gp1
Definition: fm.h:291
fm_volume_up
uint8_t fm_volume_up(fm_t *ctx)
Increasing volume level.
fm_t::slave_address
uint8_t slave_address
Definition: fm.h:299
fm_generic_write
void fm_generic_write(fm_t *ctx, uint16_t *reg_buf)
Generic write function.
fm_power_down
void fm_power_down(fm_t *ctx)
Powering down device.
fm_set_snr_threshold
uint8_t fm_set_snr_threshold(fm_t *ctx, uint8_t snr_threshold)
Setting seek SNR threshold value.
fm_get_an_pin
uint8_t fm_get_an_pin(fm_t *ctx)
Checking AN pin status.
fm_tune_channel
void fm_tune_channel(fm_t *ctx, uint16_t channel)
Setting CHANNEL bits.
fm_get_errors_block_c
uint8_t fm_get_errors_block_c(fm_t *ctx)
Reading number of errors to be corrected.
fm_cfg_t::rst
pin_name_t rst
Definition: fm.h:316
fm_t
Click ctx object definition.
Definition: fm.h:282