drv2605.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Cirrus Logic, Inc.
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_HAPTICS_DRV2605_H_
#define ZEPHYR_INCLUDE_DRIVERS_HAPTICS_DRV2605_H_
 
#include <zephyr/drivers/haptics.h>
#include <zephyr/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DRV2605_WAVEFORM_SEQUENCER_MAX 8
 
#define DRV2605_WAVEFORM_SEQUENCER_WAIT_MS(ms) (0x80 | ((ms) / 10))
 
enum drv2605_library {
        DRV2605_LIBRARY_EMPTY = 0,   
        DRV2605_LIBRARY_TS2200_A,    
        DRV2605_LIBRARY_TS2200_B,    
        DRV2605_LIBRARY_TS2200_C,    
        DRV2605_LIBRARY_TS2200_D,    
        DRV2605_LIBRARY_TS2200_E,    
        DRV2605_LIBRARY_LRA,         
};
 
enum drv2605_mode {
        DRV2605_MODE_INTERNAL_TRIGGER = 0,    
        DRV2605_MODE_EXTERNAL_EDGE_TRIGGER,   
        DRV2605_MODE_EXTERNAL_LEVEL_TRIGGER,  
        DRV2605_MODE_PWM_ANALOG_INPUT,        
        DRV2605_MODE_AUDIO_TO_VIBE,           
        DRV2605_MODE_RTP,                     
        DRV2605_MODE_DIAGNOSTICS,             
        DRV2605_MODE_AUTO_CAL,                
};
 
enum drv2605_haptics_source {
        DRV2605_HAPTICS_SOURCE_ROM,      
        DRV2605_HAPTICS_SOURCE_RTP,      
        DRV2605_HAPTICS_SOURCE_AUDIO,    
        DRV2605_HAPTICS_SOURCE_PWM,      
        DRV2605_HAPTICS_SOURCE_ANALOG,   
};
 
struct drv2605_rom_data {
        enum drv2605_mode trigger;
        enum drv2605_library library;
        uint8_t seq_regs[DRV2605_WAVEFORM_SEQUENCER_MAX];
        uint8_t overdrive_time;
        uint8_t sustain_pos_time;
        uint8_t sustain_neg_time;
        uint8_t brake_time;
};
 
struct drv2605_rtp_data {
        size_t size;
        uint32_t *rtp_hold_us;
        uint8_t *rtp_input;
};
 
union drv2605_config_data {
        struct drv2605_rom_data *rom_data;
        struct drv2605_rtp_data *rtp_data;
};
 
int drv2605_haptic_config(const struct device *dev, enum drv2605_haptics_source source,
                          const union drv2605_config_data *config_data);
 
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif