fan8.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2021 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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 FAN8_H
#define FAN8_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#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"
 
#define FAN8_REG_TEMP_CH1                       0x00
#define FAN8_REG_TEMP_CH2                       0x01
#define FAN8_REG_CONFIG_BYTE                    0x02
#define FAN8_REG_CH1_OT_LIMIT                   0x03
#define FAN8_REG_CH2_OT_LIMIT                   0x04
#define FAN8_REG_OT_STATUS                      0x05
#define FAN8_REG_OT_MASK                        0x06
#define FAN8_REG_PWM1_START_DC                  0x07
#define FAN8_REG_PWM2_START_DC                  0x08
#define FAN8_REG_PWM1_MAX_DC                    0x09
#define FAN8_REG_PWM2_MAX_DC                    0x0A
#define FAN8_REG_PWM1_TARGET_DC                 0x0B
#define FAN8_REG_PWM2_TARGET_DC                 0x0C
#define FAN8_REG_PWM1_INSTANTANEOUS_DC          0x0D
#define FAN8_REG_PWM2_INSTANTANEOUS_DC          0x0E
#define FAN8_REG_CH1_FAN_START_TEMP             0x0F
#define FAN8_REG_CH2_FAN_START_TEMP             0x10
#define FAN8_REG_FAN_CONFIGURATION              0x11
#define FAN8_REG_DC_ROC                         0x12
#define FAN8_REG_DC_STEP_SIZE                   0x13
#define FAN8_REG_PWM_FREQ_SEL                   0x14
#define FAN8_REG_THERMISTOR_OFFSET              0x17
#define FAN8_REG_TACH1_VALUE                    0x18
#define FAN8_REG_TACH2_VALUE                    0x19
#define FAN8_REG_TACH1_LIMIT                    0x1A
#define FAN8_REG_TACH2_LIMIT                    0x1B
#define FAN8_REG_FAN_STATUS_BYTE                0x1C
#define FAN8_REG_CH1_TEMP_LSB                   0x1E
#define FAN8_REG_CH2_TEMP_LSB                   0x1F
#define FAN8_REG_DEVICE_REV                     0xFD
#define FAN8_REG_DEVICE_ID                      0xFE
#define FAN8_REG_MANUFACTURER_ID                0xFF
 
 // fan8_reg
 
#define FAN8_DEVICE_ID                          0x68
 
#define FAN8_RESET                              0x40
 
#define FAN8_FAN_CHANNEL_1                      0x01
#define FAN8_FAN_CHANNEL_2                      0x02
 
#define FAN8_FAN_CHANNEL_1                      0x01
#define FAN8_FAN_CHANNEL_2                      0x02
 
#define FAN8_TEMP_CHANNEL_1                     0x01
#define FAN8_TEMP_CHANNEL_2                     0x02
 
#define FAN8_TEMPERATURE_RESOLUTION             0.125
 
#define FAN8_MAX_DUTY_CYCLE                     240
#define FAN8_MIN_DUTY_CYCLE                     0
#define FAN8_DUTY_CYCLE_STEP_2                  2
#define FAN8_DUTY_CYCLE_STEP_4                  4
#define FAN8_DUTY_CYCLE_STEP_6                  6
#define FAN8_DUTY_CYCLE_STEP_8                  8
#define FAN8_DUTY_CYCLE_STEP_10                 10
#define FAN8_DUTY_CYCLE_STEP_12                 12
#define FAN8_DUTY_CYCLE_STEP_14                 14
#define FAN8_DUTY_CYCLE_STEP_16                 16
 
#define FAN8_CLOCK_COUNTER_FREQ                 1950
#define FAN8_SEC_PER_MIN                        60
#define FAN8_2_PULSES_PER_REVOLUTION            2
#define FAN8_MAX_TACH_VALUE                     255
 
#define FAN8_DEV_ADDR_ADD0_GND_ADD1_GND         0x18
#define FAN8_DEV_ADDR_ADD0_GND_ADD1_HIGH_Z      0x19
#define FAN8_DEV_ADDR_ADD0_GND_ADD1_VCC         0x1A
#define FAN8_DEV_ADDR_ADD0_HIGH_Z_ADD1_GND      0x29
#define FAN8_DEV_ADDR_ADD0_HIGH_Z_ADD1_HIGH_Z   0x2A
#define FAN8_DEV_ADDR_ADD0_HIGH_Z_ADD1_VCC      0x2B
#define FAN8_DEV_ADDR_ADD0_VCC_ADD1_GND         0x4C
#define FAN8_DEV_ADDR_ADD0_VCC_ADD1_HIGH_Z      0x4D
#define FAN8_DEV_ADDR_ADD0_VCC_ADD1_VCC         0x4E
 
 // fan8_set
 
#define FAN8_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.ot = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.fan_fail = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.fault = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // fan8_map
 // fan8
 
typedef struct
{
    // Input pins
    digital_in_t  ot;          
    digital_in_t  fan_fail;    
    digital_in_t  fault;       
    // Modules
    i2c_master_t i2c;          
    // I2C slave address
    uint8_t slave_address;     
} fan8_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  ot;         
    pin_name_t  fan_fail;   
    pin_name_t  fault;      
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} fan8_cfg_t;
 
typedef enum
{
    FAN8_OK = 0,
    FAN8_ERROR = -1
 
} fan8_return_value_t;
 
void fan8_cfg_setup ( fan8_cfg_t *cfg );
 
err_t fan8_init ( fan8_t *ctx, fan8_cfg_t *cfg );
 
err_t fan8_default_cfg ( fan8_t *ctx );
 
err_t fan8_write_register ( fan8_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t fan8_read_register ( fan8_t *ctx, uint8_t reg, uint8_t *data_out );
 
uint8_t fan8_check_overtemperature_indicator ( fan8_t *ctx );
 
uint8_t fan8_check_fan_fail_indicator ( fan8_t *ctx );
 
uint8_t fan8_check_fault_indicator ( fan8_t *ctx );
 
err_t fan8_check_device_id ( fan8_t *ctx );
 
err_t fan8_set_duty_cycle ( fan8_t *ctx, uint8_t fan_ch, uint8_t duty_cycle );
 
err_t fan8_measure_rpm ( fan8_t *ctx, uint8_t fan_ch, uint8_t num_pulses, uint16_t *fan_rpm );
 
err_t fan8_read_temperature ( fan8_t *ctx, uint8_t temp_ch, float *temperature );
 
err_t fan8_reset ( fan8_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // FAN8_H
 
 // fan8
 
// ------------------------------------------------------------------------ END