mp32  2.0.0.0
mp32.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 MP32_H
36 #define MP32_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_uart.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define MP32_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
57 
64 #define MP32_RETVAL uint8_t
65 
66 #define MP32_OK 0x00
67 #define MP32_INIT_ERROR 0xFF
68 
74 #define DRV_RX_BUFFER_SIZE 200
75 #define DRV_TX_BUFFER_SIZE 50
76 
82 #define MP32_NUM_CMD_BYTES 8
83 #define MP32_TIMEOUT 1000
84 #define MP32_MAX_VOL 0x1E
85 
91 #define MP32_CMD_START_CODE 0x7E
92 #define MP32_CMD_END_CODE 0xEF
93 #define MP32_VERSION_CODE 0xFF
94 #define MP32_FDBK_CODE_ON 0x01
95 #define MP32_FDBK_CODE_OFF 0x00
96 
102 #define MP32_PLAY_NEXT_SONG 0x01
103 #define MP32_PLAY_PREV_SONG 0x02
104 #define MP32_PLAY_SPEC_TRACK 0x03
105 #define MP32_SET_VOL_UP 0x04
106 #define MP32_SET_VOL_DOWN 0x05
107 #define MP32_SET_VOL_VALUE 0x06
108 #define MP32_SET_EQUALIZER 0x07
109 #define MP32_REP_CURR_TRACK 0x08
110 #define MP32_SET_DEV 0x09
111 #define MP32_ENTER_STDBY_MODE 0x0A
112 #define MP32_RESET 0x0C
113 #define MP32_PLAY 0x0D
114 #define MP32_PAUSE 0x0E
115 #define MP32_PLAY_SONG_SPEC 0x0F
116 #define MP32_SET_ALL_LOOP 0x11
117 #define MP32_PLAY_SONG_MP3 0x12
118 #define MP32_PLAY_SONG_ADV 0x13
119 #define MP32_SET_SONG_NAME 0x14
120 #define MP32_ADD_LOOP_TRACK 0x15
121 #define MP32_STOP 0x16
122 #define MP32_SET_LOOP_FOL 0x17
123 #define MP32_SET_SHUF_ALL 0x18
124 #define MP32_REP_SINGLE 0x19
125 #define MP32_SET_SHUF_FOL 0x28
126 
132 #define MP32_EQ_NORMAL 0x00
133 #define MP32_EQ_POP 0x01
134 #define MP32_EQ_ROCK 0x02
135 #define MP32_EQ_JAZZ 0x03
136 #define MP32_EQ_CLASSIC 0x04
137 #define MP32_EQ_BASS 0x05
138 
144 #define MP32_U_DISK 0x01
145 #define MP32_SDCARD 0x02
146 
152 #define MP32_STOP_LOOP 0x00
153 #define MP32_START_LOOP 0x01
154 
160 #define MP32_DISABLE 0x00
161 #define MP32_ENABLE 0x01
162  // End group macro
165 // --------------------------------------------------------------- PUBLIC TYPES
173 typedef struct
174 {
175  // Output pins
176 
177  digital_out_t rst;
178 
179  // Modules
180 
181  uart_t uart;
182 
183  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
184  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
185 
186 } mp32_t;
187 
191 typedef struct
192 {
193  // Communication gpio pins
194 
195  pin_name_t rx_pin;
196  pin_name_t tx_pin;
197 
198  // Additional gpio pins
199 
200  pin_name_t rst;
201 
202 
203  // static variable
204 
205  uint32_t baud_rate; // Clock speed.
207  uart_data_bits_t data_bit; // Data bits.
208  uart_parity_t parity_bit; // Parity bit.
209  uart_stop_bits_t stop_bit; // Stop bits.
210 
211 } mp32_cfg_t;
212 
216 typedef uint8_t mp32_error_t;
217  // End types group
219 
220 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
221 
227 #ifdef __cplusplus
228 extern "C"{
229 #endif
230 
240 
249 
256 void mp32_generic_write ( mp32_t *ctx, char *data_buf, uint16_t len );
257 
265 int32_t mp32_generic_read ( mp32_t *ctx, char *data_buf, uint16_t max_len );
266 
274 void mp32_hw_reset ( mp32_t *ctx );
275 
286 void mp32_rx_cmd ( mp32_t *ctx, uint8_t *rd_data, uint8_t len );
287 
298 void mp32_tx_cmd ( mp32_t *ctx, uint8_t cmd, uint16_t spec_data );
299 
307 void mp32_sw_reset ( mp32_t *ctx );
308 
317 void mp32_play_specific ( mp32_t *ctx, uint16_t track_index );
318 
326 void mp32_play_mode ( mp32_t *ctx );
327 
335 void mp32_pause_mode ( mp32_t *ctx );
336 
344 void mp32_stop_mode ( mp32_t *ctx );
345 
355 void mp32_set_volume ( mp32_t *ctx, uint8_t perc );
356 
364 void mp32_volume_up ( mp32_t *ctx );
365 
373 void mp32_volume_down ( mp32_t *ctx );
374 
382 void mp32_play_next ( mp32_t *ctx );
383 
392 
402 void mp32_set_eq ( mp32_t *ctx, uint8_t eq );
403 
412 
420 void mp32_set_device ( mp32_t *ctx, uint8_t device );
421 
430 
441 void mp32_play_spec_in_fol ( mp32_t *ctx, uint8_t fol_inx, uint8_t track_inx );
442 
454 void mp32_loop_all ( mp32_t *ctx, uint8_t loop_mode );
455 
464 void mp32_play_fol ( mp32_t *ctx, uint8_t fol_inx );
465 
474 void mp32_loop_fol ( mp32_t *ctx, uint8_t fol_inx );
475 
483 void mp32_random_all ( mp32_t *ctx );
484 
485 // Loop Repeat a current song
497 void mp32_loop ( mp32_t *ctx, uint8_t state );
498 
499 #ifdef __cplusplus
500 }
501 #endif
502 #endif // _MP32_H_
503  // End public_function group
506 
507 // ------------------------------------------------------------------------- END
mp32_cfg_t::tx_pin
pin_name_t tx_pin
Definition: mp32.h:196
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: mp32.h:74
mp32_loop_fol
void mp32_loop_fol(mp32_t *ctx, uint8_t fol_inx)
Loop folder function.
mp32_stop_mode
void mp32_stop_mode(mp32_t *ctx)
Stop mode function.
mp32_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: mp32.h:208
mp32_cfg_t::rx_pin
pin_name_t rx_pin
Definition: mp32.h:195
mp32_t::rst
digital_out_t rst
Definition: mp32.h:177
mp32_sw_reset
void mp32_sw_reset(mp32_t *ctx)
Software reset function.
mp32_rx_cmd
void mp32_rx_cmd(mp32_t *ctx, uint8_t *rd_data, uint8_t len)
Received response data function.
mp32_error_t
uint8_t mp32_error_t
Error type.
Definition: mp32.h:216
mp32_cfg_t::rst
pin_name_t rst
Definition: mp32.h:200
mp32_set_device
void mp32_set_device(mp32_t *ctx, uint8_t device)
Set device function.
mp32_t
Click ctx object definition.
Definition: mp32.h:174
mp32_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: mp32.h:209
mp32_play_previous
void mp32_play_previous(mp32_t *ctx)
Play previous command function.
mp32_play_next
void mp32_play_next(mp32_t *ctx)
Play previous command function.
mp32_cfg_t::uart_blocking
bool uart_blocking
Definition: mp32.h:206
mp32_set_eq
void mp32_set_eq(mp32_t *ctx, uint8_t eq)
Set equalizer mode function.
mp32_generic_write
void mp32_generic_write(mp32_t *ctx, char *data_buf, uint16_t len)
Generic write function.
mp32_volume_up
void mp32_volume_up(mp32_t *ctx)
Volume up function.
mp32_hw_reset
void mp32_hw_reset(mp32_t *ctx)
Reset the device function.
mp32_volume_down
void mp32_volume_down(mp32_t *ctx)
Play next command function.
mp32_t::uart
uart_t uart
Definition: mp32.h:181
mp32_cfg_t::baud_rate
uint32_t baud_rate
Definition: mp32.h:205
mp32_play_spec_in_fol
void mp32_play_spec_in_fol(mp32_t *ctx, uint8_t fol_inx, uint8_t track_inx)
Specify a certain folder and play tracks inside function.
mp32_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: mp32.h:207
mp32_loop
void mp32_loop(mp32_t *ctx, uint8_t state)
Repeat a current song function.
mp32_repeat_current
void mp32_repeat_current(mp32_t *ctx)
Repeat current mode function.
mp32_generic_read
int32_t mp32_generic_read(mp32_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: mp32.h:75
mp32_cfg_setup
void mp32_cfg_setup(mp32_cfg_t *cfg)
Config Object Initialization function.
mp32_play_mode
void mp32_play_mode(mp32_t *ctx)
Play mode function.
mp32_pause_mode
void mp32_pause_mode(mp32_t *ctx)
Pause mode function.
mp32_init
MP32_RETVAL mp32_init(mp32_t *ctx, mp32_cfg_t *cfg)
Initialization function.
mp32_loop_all
void mp32_loop_all(mp32_t *ctx, uint8_t loop_mode)
Play specific in loop mode function.
MP32_RETVAL
#define MP32_RETVAL
Definition: mp32.h:64
mp32_play_specific
void mp32_play_specific(mp32_t *ctx, uint16_t track_index)
Play specific function.
mp32_random_all
void mp32_random_all(mp32_t *ctx)
Random Play function.
mp32_play_fol
void mp32_play_fol(mp32_t *ctx, uint8_t fol_inx)
Play folder function.
mp32_tx_cmd
void mp32_tx_cmd(mp32_t *ctx, uint8_t cmd, uint16_t spec_data)
Write command function.
mp32_set_volume
void mp32_set_volume(mp32_t *ctx, uint8_t perc)
Set Volume function.
mp32_set_low_power_mode
void mp32_set_low_power_mode(mp32_t *ctx)
Set Low power mode function.
mp32_cfg_t
Click configuration structure definition.
Definition: mp32.h:192