cs40l5x.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Cirrus Logic, Inc.
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_DRIVERS_HAPTICS_CS40L5X_H_
#define ZEPHYR_INCLUDE_DRIVERS_HAPTICS_CS40L5X_H_
 
#include <zephyr/drivers/gpio.h>
#include <zephyr/drivers/i2c.h>
#include <zephyr/drivers/spi.h>
#include <zephyr/drivers/haptics.h>
#include <zephyr/kernel.h>
#include <zephyr/logging/log_instance.h>
#include <sys/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


enum cs40l5x_attenuation {
        CS40L5X_ATTENUATION_7DB = -7, 
        CS40L5X_ATTENUATION_6DB,      
        CS40L5X_ATTENUATION_5DB,      
        CS40L5X_ATTENUATION_4DB,      
        CS40L5X_ATTENUATION_3DB,      
        CS40L5X_ATTENUATION_2DB,      
        CS40L5X_ATTENUATION_1DB,      
        CS40L5X_ATTENUATION_0DB,      
};

enum cs40l5x_source {
        CS40L5X_SOURCE_BUZ = HAPTICS_SOURCE_PRIV_START, 
        CS40L5X_SOURCE_RTH,                             
};

struct cs40l5x_pwle_section {
        uint16_t duration;
        uint16_t frequency;
        uint16_t level;
        uint8_t flags;
};

enum cs40l5x_trigger_edge {
        CS40L5X_RISING_EDGE,  
        CS40L5X_FALLING_EDGE, 
};

int cs40l5x_configure_buzz(const struct device *const dev, const uint32_t frequency,
                           const uint8_t level, const uint32_t duration);

int cs40l5x_configure_trigger(const struct device *const dev, const struct gpio_dt_spec *const gpio,
                              const enum haptics_source src, const union haptics_config *const cfg,
                              const enum cs40l5x_attenuation attenuation,
                              const enum cs40l5x_trigger_edge edge);

int cs40l5x_upload_pcm(const struct device *const dev, const int index, const uint16_t redc,
                       const uint16_t f0, const int8_t *const samples, const uint16_t num_samples);

int cs40l5x_upload_pwle(const struct device *const dev, const int index,
                        const struct cs40l5x_pwle_section *const sections,
                        const uint8_t num_sections);

 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_HAPTICS_CS40L5X_H_ */