mp3.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 MP3_H
#define MP3_H
 
#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_spi_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define MP3_MAP_MIKROBUS( cfg, mikrobus ) \
   cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
   cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
   cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
   cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
   cfg.dreq = MIKROBUS( mikrobus, MIKROBUS_AN ); \
   cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.dcs = MIKROBUS( mikrobus, MIKROBUS_INT )
#define MP3_WRITE_CMD               0x02
#define MP3_READ_CMD                0x03
#define MP3_BASE_ADDR               0x00
#define MP3_MODE_ADDR               0x00
#define MP3_STATUS_ADDR             0x01
#define MP3_BASS_ADDR               0x02
#define MP3_CLOCKF_ADDR             0x03
#define MP3_DECODE_TIME_ADDR        0x04
#define MP3_AUDATA_ADDR             0x05
#define MP3_WRAM_ADDR               0x06
#define MP3_WRAMADDR_ADDR           0x07
#define MP3_HDAT0_ADDR              0x08
#define MP3_HDAT1_ADDR              0x09
#define MP3_AIADDR_ADDR             0x0A
#define MP3_VOL_ADDR                0x0B
#define MP3_AICTRL0_ADDR            0x0C
#define MP3_AICTRL1_ADDR            0x0D
#define MP3_AICTRL2_ADDR            0x0E
#define MP3_AICTRL3_ADDR            0x0F
#define MP3_OK                      0
#define MP3_ERROR                  -1
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
    digital_out_t rst;
    digital_out_t dcs;
 
    // Input pins 
    digital_in_t dreq;
    
    // Modules 
    spi_master_t spi;           
    pin_name_t   chip_select;   
} mp3_t;
 
typedef struct
{
    // Communication gpio pins 
    pin_name_t miso;            
    pin_name_t mosi;            
    pin_name_t sck;             
    pin_name_t cs;              
    // Additional gpio pins 
    pin_name_t dreq;
    pin_name_t rst;
    pin_name_t dcs;
 
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} mp3_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void mp3_cfg_setup ( mp3_cfg_t *cfg );
 
err_t mp3_init ( mp3_t *ctx, mp3_cfg_t *cfg );
 
void mp3_reset( mp3_t *ctx );
 
uint8_t mp3_is_busy( mp3_t *ctx );
 
void mp3_cmd_write( mp3_t *ctx, uint8_t address, uint16_t input );
 
uint16_t mp3_cmd_read( mp3_t *ctx, uint8_t address );
 
err_t mp3_data_write( mp3_t *ctx, uint8_t input );
 
err_t mp3_data_write_32( mp3_t *ctx, uint8_t *input32 );
 
void mp3_set_volume ( mp3_t *ctx, uint8_t vol_left, uint8_t vol_right );
 
#ifdef __cplusplus
}
#endif
#endif  // _MP3_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END