haptic.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * Permission is hereby granted, free of charge, to any person 
 * obtaining a copy of this software and associated documentation 
 * files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, 
 * publish, distribute, sublicense, and/or sell copies of the Software, 
 * and to permit persons to whom the Software is furnished to do so, 
 * subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be 
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE 
 * OR OTHER DEALINGS IN THE SOFTWARE. 
 */
// ----------------------------------------------------------------------------
 
#ifndef HAPTIC_H
#define HAPTIC_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_pwm.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define HAPTIC_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
#define HAPTIC_RETVAL  uint8_t
 
#define HAPTIC_OK           0x00
#define HAPTIC_INIT_ERROR   0xFF
#define HAPTIC_I2C_ADDRESS                                          0x5A
#define HAPTIC_REG_STATUS                                           0x00
#define HAPTIC_REG_MODE                                             0x01
#define HAPTIC_REG_RTPIN                                            0x02
#define HAPTIC_REG_LIBRARY                                          0x03
#define HAPTIC_REG_WAVESEQ1                                         0x04
#define HAPTIC_REG_WAVESEQ2                                         0x05
#define HAPTIC_REG_WAVESEQ3                                         0x06
#define HAPTIC_REG_WAVESEQ4                                         0x07
#define HAPTIC_REG_WAVESEQ5                                         0x08
#define HAPTIC_REG_WAVESEQ6                                         0x09
#define HAPTIC_REG_WAVESEQ7                                         0x0A
#define HAPTIC_REG_WAVESEQ8                                         0x0B
 
#define HAPTIC_REG_GO                                               0x0C
#define HAPTIC_REG_OVERDRIVE                                        0x0D
#define HAPTIC_REG_SUSTAINPOS                                       0x0E
#define HAPTIC_REG_SUSTAINNEG                                       0x0F
#define HAPTIC_REG_BREAK                                            0x10
#define HAPTIC_REG_AUDIOCTRL                                        0x11
#define HAPTIC_REG_AUDIOMININ                                       0x12
#define HAPTIC_REG_AUDIOMAXIN                                       0x13
#define HAPTIC_REG_AUDIOMINOUT                                      0x14
#define HAPTIC_REG_AUDIOMAXOUT                                      0x15
#define HAPTIC_REG_RATEDV                                           0x16
#define HAPTIC_REG_CLAMPV                                           0x17
#define HAPTIC_REG_AUTOCALCOMP                                      0x18
#define HAPTIC_REG_AUTOCALEMF                                       0x19
#define HAPTIC_REG_FEEDBACK                                         0x1A
#define HAPTIC_REG_CONTROL1                                         0x1B
#define HAPTIC_REG_CONTROL2                                         0x1C
#define HAPTIC_REG_CONTROL3                                         0x1D
#define HAPTIC_REG_CONTROL4                                         0x1E
#define HAPTIC_REG_VBAT                                             0x21
#define HAPTIC_REG_LRARESON                                         0x22
#define HAPTIC_MODE_INTTRIG                                         0x00
#define HAPTIC_MODE_EXTTRIGEDGE                                     0x01
#define HAPTIC_MODE_EXTTRIGLVL                                      0x02
#define HAPTIC_MODE_PWMANALOG                                       0x03
#define HAPTIC_MODE_AUDIOVIBE                                       0x04
#define HAPTIC_MODE_REALTIME                                        0x05
#define HAPTIC_MODE_DIAGNOS                                         0x06
#define HAPTIC_MODE_AUTOCAL                                         0x07
#define HAPTIC_DEFAULT_MIN_INPUT                                    0x19
#define HAPTIC_DEFAULT_MAX_INPUT                                    0xFF
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t cs;
    
    // Modules 
 
    i2c_master_t i2c;
    pwm_t pwm;
 
    // ctx variable 
 
    uint8_t slave_address;
    uint32_t  pwm_freq;
 
} haptic_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    pin_name_t pwm;
    
    // Additional gpio pins 
 
    pin_name_t cs;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
    uint32_t  dev_pwm_freq;
 
} haptic_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void haptic_cfg_setup ( haptic_cfg_t *cfg );
 
HAPTIC_RETVAL haptic_init ( haptic_t *ctx, haptic_cfg_t *cfg );
 
void haptic_generic_write ( haptic_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void haptic_generic_read ( haptic_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void haptic_enable (  haptic_t *ctx );
 
void haptic_disable ( haptic_t *ctx );
 
void haptic_write_byte (  haptic_t *ctx, uint8_t reg_address, uint8_t write_data );
 
uint8_t haptic_read_byte ( haptic_t *ctx, uint8_t reg_address );
 
void haptic_set_mode ( haptic_t *ctx, uint8_t sel_mode );
 
void haptic_soft_reset ( haptic_t *ctx );
 
uint8_t haptic_get_status ( haptic_t *ctx );
 
void haptic_set_rtp_input ( haptic_t *ctx, uint8_t input );
 
void haptic_set_state_hi ( haptic_t *ctx );
 
uint8_t haptic_set_library ( haptic_t *ctx, uint8_t library );
 
void haptic_start_motor ( haptic_t *ctx );
 
void haptic_set_overdrive_offset ( haptic_t *ctx, uint8_t temp_data );
 
void haptic_set_sustain_offset_positive ( haptic_t *ctx, uint8_t temp_data );
 
void haptic_set_sustain_offset_negative ( haptic_t *ctx, uint8_t temp_data );
 
void haptic_set_brake_time_offset ( haptic_t *ctx, uint8_t temp_data );
 
void haptic_set_audio_minimum_input ( haptic_t *ctx, uint8_t temp_data );
 
void haptic_set_audio_maximum_input ( haptic_t *ctx, uint8_t temp_data );
 
void haptic_set_audio_minimum_output ( haptic_t *ctx, uint8_t temp_data );
 
void haptic_set_audio_maximum_output ( haptic_t *ctx, uint8_t temp_data );
 
void haptic_set_rated_voltage ( haptic_t *ctx, uint8_t temp_data );
 
void haptic_set_overdrive_clamp_voltage ( haptic_t *ctx, uint8_t temp_data );
 
uint8_t haptic_set_audio_peak_time ( haptic_t *ctx, uint8_t temp_data );
 
uint8_t haptic_set_audio_low_pass_filter ( haptic_t *ctx, uint8_t temp_data );
 
uint8_t haptic_get_calibration_result_comp ( haptic_t *ctx );
 
uint8_t haptic_get_calibration_result_emf ( haptic_t *ctx );
 
uint8_t haptic_get_supply_voltage_value ( haptic_t *ctx );
 
uint8_t haptic_get_lra_resonance_period ( haptic_t *ctx );
 
void haptic_set_to_erm_mode ( haptic_t *ctx );
 
void haptic_set_to_lra_mode ( haptic_t *ctx );
 
uint8_t haptic_setBrakeFactor( haptic_t *ctx, uint8_t brake_factor );
 
uint8_t haptic_set_loop_gain ( haptic_t *ctx, uint8_t gain );
 
void haptic_set_input_to_analog ( haptic_t *ctx );
 
void haptic_set_input_to_pwm ( haptic_t *ctx );
 
void haptic_set_sequence ( haptic_t *ctx, uint8_t temp_data );
 
void haptic_enable_ac_coulping ( haptic_t *ctx );
 
void haptic_set_duty_cycle ( haptic_t *ctx, float duty_cycle );
 
void haptic_pwm_stop ( haptic_t *ctx );
 
void haptic_pwm_start ( haptic_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _HAPTIC_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END