speaker  2.0.0.0
Data Structures | Macros | Enumerations | Functions
speaker.h File Reference

This file contains API for Speaker Click Driver. More...

#include "drv_digital_out.h"

Go to the source code of this file.

Data Structures

struct  speaker_t
 Speaker Click context object. More...
 
struct  speaker_cfg_t
 Speaker Click configuration object. More...
 

Macros

#define SPEAKER_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  speaker_return_value_t { SPEAKER_OK = 0, SPEAKER_ERROR = -1 }
 Speaker Click return value data. More...
 

Functions

void speaker_cfg_setup (speaker_cfg_t *cfg)
 Speaker configuration object setup function. More...
 
err_t speaker_init (speaker_t *ctx, speaker_cfg_t *cfg)
 Speaker initialization function. More...
 
err_t speaker_default_cfg (speaker_t *ctx)
 Speaker default configuration function. More...
 
err_t speaker_enable_slave_amp (speaker_t *ctx)
 Speaker enables the slave amplifier function. More...
 
err_t speaker_disable_slave_amp (speaker_t *ctx)
 Speaker disables the slave amplifier function. More...
 
err_t speaker_shutdown (speaker_t *ctx)
 Speaker shutdown mode function. More...
 
err_t speaker_normal_operation (speaker_t *ctx)
 Speaker normal operation mode function. More...
 

Detailed Description

This file contains API for Speaker Click Driver.

Enumeration Type Documentation

◆ speaker_return_value_t

Speaker Click return value data.

Predefined enum values for driver return values.

Enumerator
SPEAKER_OK 
SPEAKER_ERROR