buzzer.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Carlo Caione <ccaione@baylibre.com>
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_DRIVERS_BUZZER_H_
#define ZEPHYR_INCLUDE_DRIVERS_BUZZER_H_

 
#include <errno.h>
#include <stdint.h>
 
#include <zephyr/device.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#define BUZZER_FREQ_REST 0U

#define BUZZER_VOLUME_MAX 100U

#define BUZZER_DURATION_FOREVER UINT32_MAX


typedef int (*buzzer_tone_t)(const struct device *dev, uint32_t freq_hz,
                             uint32_t duration_ms);

typedef int (*buzzer_set_volume_t)(const struct device *dev, uint8_t percent);

typedef int (*buzzer_beep_t)(const struct device *dev, uint32_t duration_ms);

typedef int (*buzzer_stop_t)(const struct device *dev);

__subsystem struct buzzer_driver_api {
        buzzer_tone_t tone;
        buzzer_set_volume_t set_volume;
        buzzer_beep_t beep;
        buzzer_stop_t stop;
};


static inline int buzzer_tone(const struct device *dev, uint32_t freq_hz,
                              uint32_t duration_ms)
{
        return DEVICE_API_GET(buzzer, dev)->tone(dev, freq_hz, duration_ms);
}

static inline int buzzer_set_volume(const struct device *dev, uint8_t percent)
{
        return DEVICE_API_GET(buzzer, dev)->set_volume(dev, percent);
}

static inline int buzzer_beep(const struct device *dev, uint32_t duration_ms)
{
        return DEVICE_API_GET(buzzer, dev)->beep(dev, duration_ms);
}

static inline int buzzer_stop(const struct device *dev)
{
        return DEVICE_API_GET(buzzer, dev)->stop(dev);
}
 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_DRIVERS_BUZZER_H_ */