audio_regulator.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef _AUDIO_REGULATOR_H_
#define _AUDIO_REGULATOR_H_
 
enum audio_regulator_state {
        AUDIO_REGULATOR_STATE_UNINITIALIZED = 0,
        AUDIO_REGULATOR_STATE_INITIALIZED,
};
 
struct audio_regulator_imp_ctx;
 
struct audio_regulator_cfg;
 
struct audio_regulator_ops {
        int (*initialize)(struct audio_regulator_imp_ctx *const ctx);
 
        int (*uninitialize)(struct audio_regulator_imp_ctx *const ctx);
 
        int (*reset)(struct audio_regulator_imp_ctx *const ctx);
 
        int (*cfg_set)(struct audio_regulator_imp_ctx *const ctx,
                       struct audio_regulator_cfg const *const cfg);
 
        int (*cfg_get)(struct audio_regulator_imp_ctx const *const ctx,
                       struct audio_regulator_cfg *cfg);
 
        int (*update)(struct audio_regulator_imp_ctx *const ctx, void *const ref_val_r,
                      void *const meas_val_y, void *const control_val_u);
 
        int (*control_get)(struct audio_regulator_imp_ctx *const ctx, void *const control_val_u);
};
 
struct audio_regulator_ctx {
        /* Opaque structure to the implemented regulator context
         * The structure and the pointer must remain valid for
         * the lifetime of the instance of the module.
         */
        struct audio_regulator_imp_ctx *imp_ctx;
 
        /* Audio regulator state, that must remain valid for the
         * lifetime of the instance of the module
         */
        enum audio_regulator_state state;
 
        /* Callbacks for the regulator implementation */
        struct audio_regulator_ops cb;
};
 
int audio_regulator_init(struct audio_regulator_ctx *const ctx,
                         struct audio_regulator_imp_ctx *const imp_ctx,
                         struct audio_regulator_ops const *const imp_cb);
 
int audio_regulator_uninit(struct audio_regulator_ctx *ctx);
 
int audio_regulator_reset(struct audio_regulator_ctx *const ctx);
 
int audio_regulator_cfg_set(struct audio_regulator_ctx *const ctx,
                            struct audio_regulator_cfg const *const cfg);
 
int audio_regulator_cfg_get(struct audio_regulator_ctx const *const ctx,
                            struct audio_regulator_cfg *const cfg);
 
int audio_regulator_update_control(struct audio_regulator_ctx const *const ctx,
                                   void *const ref_val_r, void *const meas_val_y,
                                   void *const control_val_u);
 
int audio_regulator_control_get(struct audio_regulator_ctx const *const ctx,
                                void *const control_val_u);
 
#endif /* _AUDIO_REGULATOR_H_ */