speaker.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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 SPEAKER_H
#define SPEAKER_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
 
#define SPEAKER_MAP_MIKROBUS( cfg, mikrobus )     \
    cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_INT ); \
    cfg.sb = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // speaker_map
 // speaker
 
typedef struct
{
    digital_out_t  pwr;    
    digital_out_t  sb;     
} speaker_t;
 
typedef struct
{
    pin_name_t  pwr;      
    pin_name_t  sb;       
} speaker_cfg_t;
 
typedef enum
{
   SPEAKER_OK = 0,
   SPEAKER_ERROR = -1
 
} speaker_return_value_t;
 
void speaker_cfg_setup ( speaker_cfg_t *cfg );
 
err_t speaker_init ( speaker_t *ctx, speaker_cfg_t *cfg );
 
err_t speaker_default_cfg ( speaker_t *ctx );
 
err_t speaker_enable_slave_amp ( speaker_t *ctx );
 
err_t speaker_disable_slave_amp ( speaker_t *ctx );
 
err_t speaker_shutdown ( speaker_t *ctx );
 
err_t speaker_normal_operation ( speaker_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // SPEAKER_H
 
 // speaker
 
// ------------------------------------------------------------------------ END