dsp.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 DSP_H
#define DSP_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 DSP_SET_EFFECT_MEDIUM                     0x00
#define DSP_SET_EFFECT_CHAMBR7B                   0x01
#define DSP_SET_EFFECT_ROOM3B                     0x02
#define DSP_SET_EFFECT_CHAMBER2                   0x03
#define DSP_SET_EFFECT_REVERS3B                   0x04
#define DSP_SET_EFFECT_GATED4B                    0x05
#define DSP_SET_EFFECT_ROOM2A                     0x06
#define DSP_SET_EFFECT_SPRING3B                   0x07
#define DSP_SET_EFFECT_PHASER1                    0x08
#define DSP_SET_EFFECT_FLANGER2                   0x09
#define DSP_SET_EFFECT_DELAY7                     0x0A
#define DSP_SET_EFFECT_CHORUS4                    0x0B
#define DSP_SET_EFFECT_EARLREF4                   0x0C
#define DSP_SET_EFFECT_AMB4                       0x0D
#define DSP_SET_EFFECT_DELAY3                     0x0E
#define DSP_SET_EFFECT_DELAY1                     0x0F
 
 // effects
 
#define DSP_SET_PIN_STATE_LOW                     0x00
#define DSP_SET_PIN_STATE_HIGH                    0x01
 
 // pin_state
 
#define dsp_retval_t  uint8_t
 
#define DSP_OK                                    0x00
#define DSP_ERROR                                 0xFF
 
 // dsp_retval_t
 
 
#define DSP_MAP_MIKROBUS( cfg, mikrobus )         \
    cfg.p0 = MIKROBUS( mikrobus, MIKROBUS_AN );   \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.p1 = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.p3 = MIKROBUS( mikrobus, MIKROBUS_PWM );  \
    cfg.p2 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // dsp_map
 // dsp
 
typedef struct
{
    digital_out_t  p0;     
    digital_out_t  rst;    
    digital_out_t  p1;     
    digital_out_t  p3;     
    digital_out_t  p2;     
} dsp_t;
 
typedef struct
{
    pin_name_t  p0;       
    pin_name_t  rst;      
    pin_name_t  p1;       
    pin_name_t  p3;       
    pin_name_t  p2;       
} dsp_cfg_t;
 
void dsp_cfg_setup ( dsp_cfg_t *cfg );
 
err_t dsp_init ( dsp_t *ctx, dsp_cfg_t *cfg );
 
void dsp_default_cfg ( dsp_t *ctx );
 
void dsp_pin_set_p0 ( dsp_t *ctx, uint8_t pin_state );
 
void dsp_pin_set_p1 ( dsp_t *ctx, uint8_t pin_state );
 
void dsp_pin_set_p2 ( dsp_t *ctx, uint8_t pin_state );
 
void dsp_pin_set_p3 ( dsp_t *ctx, uint8_t pin_state );
 
void dsp_power_on ( dsp_t *ctx );
 
void dsp_reset ( dsp_t *ctx );
 
dsp_retval_t dsp_set_effect ( dsp_t *ctx, uint8_t effects );
 
#ifdef __cplusplus
}
#endif
#endif // DSP_H
 
 // dsp
 
// ------------------------------------------------------------------------ END