fan.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 FAN_H
#define FAN_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS
#define FAN_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl     = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda     = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define FAN_CONFIGURATION         0x20
#define FAN_STATUS                0x24
#define FAN_STALL_STATUS          0x25
#define FAN_SPIN_STATUS           0x26
#define FAN_DRIVE_FAIL_STATUS     0x27
#define FAN_INTERRUPT_ENABLE      0x29
#define FAN_PWM_POLARITY          0x2A
#define FAN_PWM_OUTPUT_CONFIG     0x2B
#define FAN_PWM_BASE_FREQ         0x2D
#define FAN_SETTING               0x30
#define FAN_DIVIDE                0x31
#define FAN_CONFIG1               0x32
#define FAN_CONFIG2               0x33
#define FAN_GAIN                  0x35
#define FAN_SPINUP                0x36
#define FAN_MAX_STEP              0x37
#define FAN_MIN_DRIVE             0x38
#define FAN_VALID_TACH            0x39
#define FAN_FAIL_LOW              0x3A
#define FAN_FAIL_HIGH             0x3B
#define FAN_TACH_TARGET_LOW       0x3C
#define FAN_TACH_TARGET_HIGH      0x3D
#define FAN_TACH_READING_HIGH     0x3E
#define FAN_TACH_READING_LOW      0x3F
#define FAN_SOFTWARE_LOCK         0xEF
#define FAN_PRODUCT_ID            0xFD
#define FAN_MANUFACTUERE_ID       0xFE
#define FAN_REVISION              0xFF
 
#define FAN_RPM_MIN_500           0x00
#define FAN_RPM_MIN_1000          0x01
#define FAN_RPM_MIN_2000          0x02
#define FAN_RPM_MIN_4000          0x03
#define FAN_EDGE_1_POLE           0x00
#define FAN_EDGE_2_POLE           0x01
#define FAN_EDGE_3_POLE           0x02
#define FAN_EDGE_4_POLE           0x03
#define FAN_UPDATE_100MS          0x00
#define FAN_UPDATE_200MS          0x01
#define FAN_UPDATE_300MS          0x02
#define FAN_UPDATE_400MS          0x03
#define FAN_UPDATE_500MS          0x04
#define FAN_UPDATE_800MS          0x05
#define FAN_UPDATE_1200MS         0x06
#define FAN_UPDATE_1600MS         0x07
#define FAN_DERIVATIVE_NONE       0x00
#define FAN_DERIVATIVE_BASIC      0x01
#define FAN_DERIVATIVE_STEP       0x02
#define FAN_DERIVATIVE_BOTH       0x03
#define FAN_RPM_0                 0x00
#define FAN_RPM_50                0x01
#define FAN_RPM_100               0x02
#define FAN_RPM_200               0x03
#define FAN_GAIN_1X               0x00
#define FAN_GAIN_2X               0x01
#define FAN_GAIN_4X               0x02
#define FAN_GAIN_8X               0x03
#define FAN_DRIVE_CNT_DISABLED     0x0
#define FAN_DRIVE_CNT_16           0x0
#define FAN_DRIVE_CNT_32           0x0
#define FAN_DRIVE_CNT_64           0x0
#define FAN_SPINUP_30PERCENT      0x00
#define FAN_SPINUP_35PERCENT      0x01
#define FAN_SPINUP_40PERCENT      0x02
#define FAN_SPINUP_45PERCENT      0x03
#define FAN_SPINUP_50PERCENT      0x04
#define FAN_SPINUP_55PERCENT      0x05
#define FAN_SPINUP_60PERCENT      0x06
#define FAN_SPINUP_65PERCENT      0x07
#define FAN_SPINUP_250MS          0x00
#define FAN_SPINUP_500MS          0x00
#define FAN_SPINUP_1S             0x00
#define FAN_SPINUP_2S             0x00
#define EN_ALGO  ( 1 << 7 )
#define RANGE  ( 1 << 5 ) | ( 1 << 6 )
#define RANGE_BIT  5
#define EDGES  ( 1 << 3 ) | ( 1 << 4 )
#define EDGES_BIT  3
#define UPDATE  ( 1 << 0 ) | ( 1 << 1 ) | ( 1 << 2 )
#define UPDATE_BIT  0
#define EN_RAMP  ( 1 << 6 )
#define GLITCH_EN  ( 1 << 5 )
#define DER_OPT  ( 1 << 3 ) | ( 1 << 4 )
#define DER_OPT_BIT  3
#define ERR_RNG  ( 1 << 2 ) | ( 1 << 1 )
#define ERR_RNG_BIT  1
#define GAIND  ( 1 << 5 ) | ( 1 << 4 )
#define GAIND_BIT  4
#define GAINI  ( 1 << 3 ) | ( 1 << 2 )
#define GAINI_BIT  2
#define GAINP  ( 1 << 1 ) | ( 1 << 0 )
#define GAINP_BIT  0
#define NOKICK  ( 1 << 5 )
#define DRIVE_FAIL_CNT  ( 1 << 7 ) | ( 1 << 6 )
#define DRIVE_FAIL_CNT_BIT  6
#define SPIN_LVL  ( 1 << 4 ) | ( 1 << 3 ) | ( 1 << 2 )
#define SPIN_LVL_BIT  2
#define SPINUP_TIME  ( 1 << 1 ) | ( 1 << 0 )
#define SPINUP_TIME_BIT  0
#define TACH_CONSTANT 3932160
#define SEC_MIN 60
#define FAN_DEV_ADDR  0x2F
 // End group macro
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
  uint8_t  number_of_poles;
  uint8_t  number_of_edges;
  uint8_t  range;
  uint8_t  mul;
  double   frequency;
  uint8_t  fsc_mode;
  uint8_t  software_lock;
 
} fan_setup_t;
 
typedef struct
{
  uint8_t  poles_cfg;
  uint8_t  edges_cfg;
  uint8_t  range_cfg;
  uint8_t  mul_cfg;
  double   frequency_cfg;
  uint8_t  mode_cfg;
  uint8_t  lock_cfg;
 
} fan_setup_cfg_t;
 
typedef struct
{
    digital_in_t  int_pin;          
    i2c_master_t  i2c;              
    uint8_t       slave_address;    
    fan_setup_t   fan_setup;        
} fan_t;
 
typedef struct
{
    pin_name_t       scl;              
    pin_name_t       sda;              
    pin_name_t       int_pin;          
    uint32_t         i2c_speed;        
    uint8_t          i2c_address;      
    fan_setup_cfg_t  fan_setup_cfg;    
} fan_cfg_t;
 
 // End type group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
#ifdef __cplusplus
extern "C"{
#endif
 
void
fan_cfg_setup ( fan_cfg_t *cfg );
 
err_t
fan_default_cfg ( fan_t *ctx );
 
err_t
fan_init ( fan_t *ctx, fan_cfg_t *cfg );
 
err_t
fan_generic_write ( fan_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t
fan_generic_read ( fan_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t
fan_write_byte ( fan_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t
fan_read_byte ( fan_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t
fan_lock_registers ( fan_t *ctx, uint8_t lock );
 
err_t
fan_device_info ( fan_t *ctx, uint8_t *info );
 
err_t
fan_set_valid_tach ( fan_t *ctx, uint16_t tach );
 
err_t
fan_get_valid_tach ( fan_t *ctx, uint16_t *data_out );
 
err_t
fan_get_driveband_fail ( fan_t *ctx, uint16_t *data_out );
 
err_t
fan_set_target_tach ( fan_t *ctx, uint16_t tach );
 
err_t
fan_get_tach ( fan_t *ctx, uint16_t *data_out );
 
err_t
fan_enable_fsc ( fan_t *ctx, uint8_t fsc );
 
err_t
fan_set_range ( fan_t *ctx, uint8_t range );
 
err_t
fan_set_edges ( fan_t *ctx, uint8_t edges );
 
err_t
fan_set_update ( fan_t *ctx, uint8_t update );
 
err_t
fan_enable_ramp ( fan_t *ctx, uint8_t ramp_control );
 
err_t
fan_enable_glitch ( fan_t *ctx, uint8_t glitch );
 
err_t
fan_set_derivative ( fan_t *ctx, uint8_t derivative );
 
err_t
fan_set_error_range ( fan_t *ctx, uint8_t error );
 
err_t
fan_set_gaind ( fan_t *ctx, uint8_t gain );
 
err_t
fan_set_drivefail ( fan_t *ctx, uint8_t count );
 
err_t
fan_enable_no_kick ( fan_t *ctx, uint8_t no_kick );
 
err_t
fan_set_spin_level ( fan_t *ctx, uint8_t spin );
 
err_t
fan_set_spin_time ( fan_t *ctx, uint8_t time );
 
err_t
fan_set_max_step ( fan_t *ctx, uint8_t step );
 
err_t
fan_set_min_drive ( fan_t *ctx, double min_drive );
 
void
fan_update_multiplier ( fan_t *ctx );
 
void
fan_set_clock ( fan_t *ctx, double freq );
 
err_t
fan_device_cfg ( fan_t *ctx, uint8_t cfg );
 
err_t
fan_get_status ( fan_t *ctx, uint8_t *data_out );
 
err_t
fan_get_stall_status ( fan_t *ctx, uint8_t *data_out );
 
err_t
fan_get_spin_status ( fan_t *ctx, uint8_t *data_out );
 
err_t
fan_get_drive_fail ( fan_t *ctx, uint8_t *data_out );
 
err_t
fan_interrupts ( fan_t *ctx, uint8_t enable );
 
err_t
fan_pwm_base ( fan_t *ctx, uint8_t freq );
 
err_t
fan_setting ( fan_t *ctx, double percentage );
 
uint8_t
fan_read_int_pin ( fan_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // FAN_H
 
 // End public_function group
 
// ------------------------------------------------------------------------- END