headphoneamp3  2.1.0.0
Data Structures | Macros | Enumerations | Functions
headphoneamp3.h File Reference

This file contains API for Headphone AMP 3 Click Driver. More...

#include "mikrosdk_version.h"
#include "drv_digital_out.h"
#include "drv_digital_in.h"

Go to the source code of this file.

Data Structures

struct  headphoneamp3_t
 Headphone AMP 3 Click context object. More...
 
struct  headphoneamp3_cfg_t
 Headphone AMP 3 Click configuration object. More...
 

Macros

#define HEADPHONEAMP3_ENABLE   0x01
 Headphone AMP 3 description setting. More...
 
#define HEADPHONEAMP3_DISABLE   0x00
 
#define HEADPHONEAMP3_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  headphoneamp3_return_value_t { HEADPHONEAMP3_OK = 0, HEADPHONEAMP3_ERROR = -1 }
 Headphone AMP 3 Click return value data. More...
 

Functions

void headphoneamp3_cfg_setup (headphoneamp3_cfg_t *cfg)
 Headphone AMP 3 configuration object setup function. More...
 
err_t headphoneamp3_init (headphoneamp3_t *ctx, headphoneamp3_cfg_t *cfg)
 Headphone AMP 3 initialization function. More...
 
void headphoneamp3_default_cfg (headphoneamp3_t *ctx)
 Headphone AMP 3 default configuration function. More...
 
void headphoneamp3_enable_power (headphoneamp3_t *ctx, uint8_t state)
 Headphone AMP 3 power pin setting function. More...
 
void headphoneamp3_enable_amp (headphoneamp3_t *ctx, uint8_t state)
 Headphone AMP 3 amp pin setting function. More...
 

Detailed Description

This file contains API for Headphone AMP 3 Click Driver.

Enumeration Type Documentation

◆ headphoneamp3_return_value_t

Headphone AMP 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
HEADPHONEAMP3_OK 
HEADPHONEAMP3_ERROR