dsp
2.0.0.0
|
API for configuring and manipulating DSP Click driver. More...
Modules | |
DSP MikroBUS Map | |
MikroBUS pin mapping of DSP Click driver. | |
Effects | |
Pin_state | |
Dsp_retval_t | |
Functions | |
void | dsp_cfg_setup (dsp_cfg_t *cfg) |
DSP configuration object setup function. More... | |
err_t | dsp_init (dsp_t *ctx, dsp_cfg_t *cfg) |
DSP initialization function. More... | |
void | dsp_default_cfg (dsp_t *ctx) |
DSP default configuration function. More... | |
void | dsp_pin_set_p0 (dsp_t *ctx, uint8_t pin_state) |
DSP P0 pin setting function. More... | |
void | dsp_pin_set_p1 (dsp_t *ctx, uint8_t pin_state) |
DSP P1 pin setting function. More... | |
void | dsp_pin_set_p2 (dsp_t *ctx, uint8_t pin_state) |
DSP P2 pin setting function. More... | |
void | dsp_pin_set_p3 (dsp_t *ctx, uint8_t pin_state) |
DSP P3 pin setting function. More... | |
void | dsp_power_on (dsp_t *ctx) |
DSP power on the device function. More... | |
void | dsp_reset (dsp_t *ctx) |
DSP reset the device function. More... | |
dsp_retval_t | dsp_set_effect (dsp_t *ctx, uint8_t effects) |
DSP reverb and multi-effects setting function. More... | |
API for configuring and manipulating DSP Click driver.
void dsp_cfg_setup | ( | dsp_cfg_t * | cfg | ) |
DSP configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See dsp_cfg_t object definition for detailed explanation. |
void dsp_default_cfg | ( | dsp_t * | ctx | ) |
DSP default configuration function.
This function executes a default configuration of DSP click board.
[in] | ctx | : Click context object. See dsp_t object definition for detailed explanation. |
DSP initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See dsp_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See dsp_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.void dsp_pin_set_p0 | ( | dsp_t * | ctx, |
uint8_t | pin_state | ||
) |
DSP P0 pin setting function.
This function sets the P0 pin state to the desired level DSP click board.
[in] | ctx | : Click context object. See dsp_t object definition for detailed explanation. |
[in] | pin_state | :
|
void dsp_pin_set_p1 | ( | dsp_t * | ctx, |
uint8_t | pin_state | ||
) |
DSP P1 pin setting function.
This function sets the P1 pin state to the desired level DSP click board.
[in] | ctx | : Click context object. See dsp_t object definition for detailed explanation. |
[in] | pin_state | :
|
void dsp_pin_set_p2 | ( | dsp_t * | ctx, |
uint8_t | pin_state | ||
) |
DSP P2 pin setting function.
This function sets the P2 pin state to the desired level DSP click board.
[in] | ctx | : Click context object. See dsp_t object definition for detailed explanation. |
[in] | pin_state | :
|
void dsp_pin_set_p3 | ( | dsp_t * | ctx, |
uint8_t | pin_state | ||
) |
DSP P3 pin setting function.
This function sets the P3 pin state to the desired level DSP click board.
[in] | ctx | : Click context object. See dsp_t object definition for detailed explanation. |
[in] | pin_state | :
|
void dsp_power_on | ( | dsp_t * | ctx | ) |
DSP power on the device function.
This function executes power-up of the device of DSP click board.
[in] | ctx | : Click context object. See dsp_t object definition for detailed explanation. |
void dsp_reset | ( | dsp_t * | ctx | ) |
DSP reset the device function.
This function executes a hardware reset of DSP click board.
[in] | ctx | : Click context object. See dsp_t object definition for detailed explanation. |
dsp_retval_t dsp_set_effect | ( | dsp_t * | ctx, |
uint8_t | effects | ||
) |
DSP reverb and multi-effects setting function.
This function sets the reverb and multi-effects of DSP click board.
[in] | ctx | : Click context object. See dsp_t object definition for detailed explanation. |
[in] | effects | : The number of the desired effect ( from 0 to 15 )
|
0x00
( DSP_OK ) - Ok, 0xFF
( DSP_ERROR ) - Error.