c2x5wamp.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright (c) 2019, MikroElektronika - www.mikroe.com
 * All rights reserved.
 *
 * 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 C2X5WAMP_H
#define C2X5WAMP_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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define C2X5WAMP_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.gn0= MIKROBUS( mikrobus, MIKROBUS_AN ); \
  cfg.gn1= MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.stb= MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.mute= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.dia= MIKROBUS( mikrobus, MIKROBUS_INT );
#define C2X5WAMP_RETVAL  uint8_t
 
#define C2X5WAMP_OK           0x00
#define C2X5WAMP_INIT_ERROR   0xFF
#define C2X5WAMP_MODE_STANDBY                                     0x00
#define C2X5WAMP_MODE_MUTE                                        0x01
#define C2X5WAMP_MODE_PLAY                                        0x02
#define C2X5WAMP_GAIN_20DB                                        0x00
#define C2X5WAMP_GAIN_26DB                                        0x01
#define C2X5WAMP_GAIN_30DB                                        0x02
#define C2X5WAMP_GAIN_32DB                                        0x03
#define C2X5WAMP_RESULT_ERROR                                     0x00
#define C2X5WAMP_RESULT_OK                                        0x01
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t gn0;
    digital_out_t gn1;
    digital_out_t stb;
    digital_out_t mute;
 
    // Input pins 
 
    digital_in_t dia;
 
} c2x5wamp_t;
 
typedef struct
{
    // Additional gpio pins 
 
    pin_name_t gn0;
    pin_name_t gn1;
    pin_name_t stb;
    pin_name_t mute;
    pin_name_t dia;
 
} c2x5wamp_cfg_t;
 
 // End types group
// ------------------------------------------------------------------ CONSTANTS
 // End constants group
// ------------------------------------------------------------------ VARIABLES
 // End variable group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void c2x5wamp_cfg_setup ( c2x5wamp_cfg_t *cfg );
 
C2X5WAMP_RETVAL c2x5wamp_init ( c2x5wamp_t *ctx, c2x5wamp_cfg_t *cfg );
 
void c2x5wamp_default_cfg ( c2x5wamp_t *ctx );
 
uint8_t c2x5wamp_set_mode ( c2x5wamp_t *ctx, uint8_t select_mode );
 
uint8_t c2x5wamp_set_gain ( c2x5wamp_t *ctx, uint8_t select_gain );
 
uint8_t c2x5wamp_check_input ( c2x5wamp_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _C2X5WAMP_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END