btaudio.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 BTAUDIO_H
#define BTAUDIO_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_uart.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define BTAUDIO_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
  cfg.rst    = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.pwr    = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.cmd    = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.frs    = MIKROBUS( mikrobus, MIKROBUS_INT ); \
  cfg.baud   = MIKROBUS( mikrobus, MIKROBUS_AN )
#define BTAUDIO_RETVAL  uint8_t
 
#define BTAUDIO_OK           0x00
#define BTAUDIO_INIT_ERROR   0xFF
#define DRV_RX_BUFFER_SIZE 600
#define DRV_TX_BUFFER_SIZE 100
#define BTAUDIO_ERR                    0x00
#define BTAUDIO_STATUS_FALSE           0x00
#define BTAUDIO_STATUS_TRUE            0x01
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
    digital_out_t pwr;
    digital_out_t cmd;
    digital_out_t baud;
    digital_out_t frs;
    
    // Modules 
 
    uart_t uart;
 
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
    char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
} btaudio_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t rx_pin;
    pin_name_t tx_pin;
    
    // Additional gpio pins 
 
    pin_name_t rst;
    pin_name_t pwr;
    pin_name_t cmd;
    pin_name_t frs;
    pin_name_t baud;
 
    // static variable 
 
    uint32_t          baud_rate;     // Clock speed.
    bool              uart_blocking;
    uart_data_bits_t  data_bit;      // Data bits.
    uart_parity_t     parity_bit;    // Parity bit.  
    uart_stop_bits_t  stop_bit;      // Stop bits.    
 
} btaudio_cfg_t;
 
typedef enum
{
    ANALOG_OUTPUT   = 0,
    I2S_OUPUT       = 1,
    S_PDIF_OUPUT    = 2,
    INTERCOM_DAC    = 3
    
} a2dp_routing_values_t;
 
typedef enum
{
    RES_24 = 0,
    RES_32 = 1
 
} bit_res_t;
 
typedef enum
{
    RATE_8K   = 0,
    RATE_32K  = 1,
    RATE_44K1 = 2,
    RATE_48K  = 3
 
} sample_rate_t;
 
typedef enum
{
    IAP_MODE    = 0,
    SPP_MODE    = 1,
    A2DP_MODE   = 2,
    HFP_MODE    = 3
 
} profile_bitmask_values;
 
typedef enum
{
    AVRCP_EK             = 0,
    RECONNECT_PWR_ON     = 1,
    DISCOVERABLE         = 2,
    AAC_APTX             = 3,
    REBOOT_DIS           = 4,
    MUTE_VOLUME          = 5,
    ENABLE_PIO4          = 6,
    DISABLE_SYS_TONES    = 7,
    PWR_OFF_P_TIMEOUT    = 8,
    RESET_PWR_OFF        = 9,
    RECONNECT_PANIC      = 10,
    ENABLE_INDICATOR     = 11,
    ENABLE_TRACK_CHANGE  = 12,
    ENABLE_PLAYBACK_TONE = 13,
    AUTO_ACCEPT          = 14
    
} extended_features_bitmask_values;
 
typedef uint8_t btaudio_error_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void btaudio_cfg_setup ( btaudio_cfg_t *cfg );
 
BTAUDIO_RETVAL btaudio_init ( btaudio_t *ctx, btaudio_cfg_t *cfg );
 
void btaudio_generic_write ( btaudio_t *ctx, char *data_buf, uint16_t len );
 
int32_t btaudio_generic_read ( btaudio_t *ctx, char *data_buf, uint16_t max_len );
 
void btaudio_set_power_on ( btaudio_t *ctx );
 
void btaudio_set_power_off ( btaudio_t *ctx );
 
void btaudio_reset ( btaudio_t *ctx );
 
void btaudio_write_byte ( btaudio_t *ctx, uint8_t input );
 
void btaudio_write_command ( btaudio_t *ctx, char *data_buf );
 
void btaudio_set_mode ( btaudio_t *ctx, uint8_t mode );
 
void btaudio_set_cmd_mode ( btaudio_t *ctx, uint8_t mode );
 
void btaudio_set_factory_defaults ( btaudio_t *ctx );
 
void btaudio_get_all_settings ( btaudio_t *ctx );
 
void btaudio_set_audio_output( btaudio_t *ctx, a2dp_routing_values_t setting, 
                                               bit_res_t bit_res, 
                                               sample_rate_t sample_rate );
 
uint8_t btaudio_set_device_name ( btaudio_t *ctx, uint8_t *name );
 
uint8_t btaudio_set_automatic_shutdown ( btaudio_t *ctx, uint16_t seconds );
 
void btaudio_set_extended_features ( btaudio_t *ctx, extended_features_bitmask_values ext_features );
 
void btaudio_set_authentication ( btaudio_t *ctx, uint8_t authentication );
 
uint8_t btaudio_set_service_class_device( btaudio_t *ctx, uint8_t *sc_device );
 
void btaudio_set_discovery_mask ( btaudio_t *ctx, uint8_t discovery_mask );
 
uint8_t btaudio_set_security_pin ( btaudio_t *ctx, uint8_t *security_pin );
 
void btaudio_set_speaker_gain_lvl ( btaudio_t *ctx, uint8_t speaker_gain_lvl );
 
void btaudio_set_toneain_lvl ( btaudio_t *ctx, uint8_t tone_gain_lvl );
 
void btaudio_get_basic_settings ( btaudio_t *ctx );
 
void btaudio_get_reg_settings ( btaudio_t *ctx, char cmd );
 
void btaudio_get_battery_status ( btaudio_t *ctx );
 
void btaudio_get_help ( btaudio_t *ctx );
 
void btaudio_get_firmware_version ( btaudio_t *ctx );
 
void btaudio_toggle_local_echo ( btaudio_t *ctx );
 
uint8_t btaudio_toggle_discoverable ( btaudio_t *ctx, uint8_t discoverable );
 
uint8_t btaudio_answer_keyboard ( btaudio_t *ctx, uint8_t answer );
 
void btaudio_dfu_mode ( btaudio_t *ctx );
 
uint8_t btaudio_call_phone_number ( btaudio_t *ctx, char *p_number );
 
void btaudio_show_track_metadata ( btaudio_t *ctx );
 
void btaudio_dial_last_phone_number ( btaudio_t *ctx );
 
void btaudio_increase_volume ( btaudio_t *ctx );
 
void btaudio_decrease_volume ( btaudio_t *ctx );
 
void btaudio_next_track ( btaudio_t *ctx );
 
void btaudio_previous_track ( btaudio_t *ctx );
 
void btaudio_pause_play_track ( btaudio_t *ctx );
 
void btaudio_enable_voice_commands ( btaudio_t *ctx );
 
void btaudio_get_gpio_dirr ( btaudio_t *ctx );
 
void btaudio_get_gpio_level ( btaudio_t *ctx );
 
void btaudio_disconnect_current_connection ( btaudio_t *ctx, profile_bitmask_values profile );
 
uint8_t btaudio_mute_hold_call ( btaudio_t *ctx, uint8_t mute );
 
void btaudio_reboot ( btaudio_t *ctx );
 
void btaudio_display_caller_id ( btaudio_t *ctx );
 
void btaudio_reset_prev_paired_devices ( btaudio_t *ctx );
 
void btaudio_query_connection_status ( btaudio_t *ctx );
 
void btaudio_reconnect_most_recent ( btaudio_t *ctx );
 
void btaudio_accept_call ( btaudio_t *ctx );
 
void btaudio_reject_call ( btaudio_t *ctx );
 
void btaudio_userBusy( btaudio_t *ctx );
 
void btaudio_accept_held_call ( btaudio_t *ctx );
 
void btaudio_set_hold_accept_incoming ( btaudio_t *ctx );
 
void btaudio_add_held_call ( btaudio_t *ctx );
 
void btaudio_cnnct_two_calls ( btaudio_t *ctx );
 
void btaudio_transfer_active_calls ( btaudio_t *ctx );
 
uint8_t btaudio_interrupt ( btaudio_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _BTAUDIO_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END