fan5.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 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 FAN5_H
#define FAN5_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 FAN5_RPM1_REG                   0x00
#define FAN5_RPM2_REG                   0x01
#define FAN5_FAN_FAULT1_REG             0x02
#define FAN5_FAN_FAULT2_REG             0x03
#define FAN5_CONFIG_REG                 0x04
#define FAN5_STATUS_REG                 0x05
#define FAN5_DUTY_CYCLE_REG             0x06
#define FAN5_MFR_ID_REG                 0x07
#define FAN5_VER_ID_REG                 0x08
 
 // fan5_reg
 
#define FAN5_CLEAR_FLT                  0x80
#define FAN5_8_BIT_RESOLUTION           0x00
#define FAN5_9_BIT_RESOLUTION           0x40
#define FAN5_VOUT_BASED_ON_DYTY_REG     0x20
#define FAN5_VOUT_BASED_ON_VIN          0x00
#define FAN5_FAN2_PPR_1                 0x00
#define FAN5_FAN2_PPR_2                 0x08
#define FAN5_FAN2_PPR_4                 0x10
#define FAN5_FAN2_PPR_8                 0x18
#define FAN5_FAN1_PPR_1                 0x00
#define FAN5_FAN1_PPR_2                 0x02
#define FAN5_FAN1_PPR_4                 0x04
#define FAN5_FAN1_PPR_8                 0x06
#define FAN5_SHUTDOWN_MODE              0x01
#define FAN5_NORMAL_MODE                0x00
 
#define FAN5_MAX_RPM_VALUE              12750
 
#define FAN5_OTF_FLAG                   0x20
#define FAN5_R2CO_FLAG                  0x10
#define FAN5_R1CO_FLAG                  0x08
#define FAN5_VSTAT_FLAG                 0x04
#define FAN5_F2F_FLAG                   0x02
#define FAN5_F1F_FLAG                   0x01
 
#define FAN5_30_PER_DUTY                0x00
#define FAN5_35_PER_DUTY                0x01
#define FAN5_40_PER_DUTY                0x02
#define FAN5_44_PER_DUTY                0x03
#define FAN5_49_PER_DUTY                0x04
#define FAN5_53_PER_DUTY                0x05
#define FAN5_58_PER_DUTY                0x06
#define FAN5_63_PER_DUTY                0x07
#define FAN5_67_PER_DUTY                0x08
#define FAN5_72_PER_DUTY                0x09
#define FAN5_77_PER_DUTY                0x0A
#define FAN5_81_PER_DUTY                0x0B
#define FAN5_86_PER_DUTY                0x0C
#define FAN5_90_PER_DUTY                0x0D
#define FAN5_95_PER_DUTY                0x0E
#define FAN5_100_PER_DUTY               0x0F
 
#define FAN5_DEVICE_ADDRESS             0x1B
 
 // fan5_set
 
#define FAN5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // fan5_map
 // fan5
 
typedef struct
{
    // Input pins
    digital_in_t flt;           
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} fan5_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t flt;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} fan5_cfg_t;
 
typedef enum
{
    FAN5_OK = 0,
    FAN5_ERROR = -1,
    FAN5_FAULT = -2
 
} fan5_return_value_t;
 
void fan5_cfg_setup ( fan5_cfg_t *cfg );
 
err_t fan5_init ( fan5_t *ctx, fan5_cfg_t *cfg );
 
err_t fan5_default_cfg ( fan5_t *ctx );
 
err_t fan5_generic_write ( fan5_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t fan5_generic_read ( fan5_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t fan5_reg_write ( fan5_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t fan5_reg_read ( fan5_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t fan5_get_mfr_id( fan5_t *ctx, uint8_t *mfr_id );
 
err_t fan5_get_rpm1 ( fan5_t *ctx, uint16_t *fan1_speed );
 
err_t fan5_get_rpm2 ( fan5_t *ctx, uint16_t *fan2_speed );
 
err_t fan5_set_fan_fault1 ( fan5_t *ctx, uint16_t fault1_value );
 
err_t fan5_set_fan_fault2 ( fan5_t *ctx, uint16_t fault2_value );
 
err_t fan5_set_duty_cycle ( fan5_t *ctx, uint8_t duty_cycle );
 
err_t fan5_get_status_flags (  fan5_t *ctx, uint8_t *status_data );
 
err_t fan5_get_fault_state ( fan5_t *ctx );
 
err_t fan5_clear_flt_flag ( fan5_t *ctx );
 
err_t fan5_turn_on_fans ( fan5_t *ctx );
 
err_t fan5_turn_off_fans ( fan5_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // FAN5_H
 
 // fan5
 
// ------------------------------------------------------------------------ END