hwmonitor.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 HWMONITOR_H
#define HWMONITOR_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 HWMONITOR_REG_CONFIGURATION            0x00
#define HWMONITOR_REG_INT_STATUS_1             0x01
#define HWMONITOR_REG_INT_STATUS_2             0x02
#define HWMONITOR_REG_INT_MASK_1               0x03
#define HWMONITOR_REG_INT_MASK_2               0x04
#define HWMONITOR_REG_FAN_DIVISOR              0x05
#define HWMONITOR_REG_OS_T_RES_CONFIG          0x06
#define HWMONITOR_REG_CONVERSION_RATE          0x07
#define HWMONITOR_REG_CHANNEL_DISABLE          0x08
#define HWMONITOR_REG_RAM_IN_0                 0x20
#define HWMONITOR_REG_RAM_IN_1                 0x21
#define HWMONITOR_REG_RAM_IN_2                 0x22
#define HWMONITOR_REG_RAM_IN_3                 0x23
#define HWMONITOR_REG_RAM_IN_4                 0x24
#define HWMONITOR_REG_RAM_IN_5                 0x25
#define HWMONITOR_REG_RAM_IN_6                 0x26
#define HWMONITOR_REG_RAM_TEMPERATURE          0x27
#define HWMONITOR_REG_RAM_FAN_1                0x28
#define HWMONITOR_REG_RAM_FAN_2                0x29
#define HWMONITOR_REG_RAM_LIM_IN_0_H           0x2A
#define HWMONITOR_REG_RAM_LIM_IN_0_L           0x2B
#define HWMONITOR_REG_RAM_LIM_IN_1_H           0x2C
#define HWMONITOR_REG_RAM_LIM_IN_1_L           0x2D
#define HWMONITOR_REG_RAM_LIM_IN_2_H           0x2E
#define HWMONITOR_REG_RAM_LIM_IN_2_L           0x2F
#define HWMONITOR_REG_RAM_LIM_IN_3_H           0x30
#define HWMONITOR_REG_RAM_LIM_IN_3_L           0x31
#define HWMONITOR_REG_RAM_LIM_IN_4_H           0x32
#define HWMONITOR_REG_RAM_LIM_IN_4_L           0x33
#define HWMONITOR_REG_RAM_LIM_IN_5_H           0x34
#define HWMONITOR_REG_RAM_LIM_IN_5_L           0x35
#define HWMONITOR_REG_RAM_LIM_IN_6_H           0x36
#define HWMONITOR_REG_RAM_LIM_IN_6_L           0x37
#define HWMONITOR_REG_RAM_LIM_HOT_H            0x38
#define HWMONITOR_REG_RAM_LIM_HOT_L            0x39
#define HWMONITOR_REG_RAM_LIM_TEMP_H           0x3A
#define HWMONITOR_REG_RAM_LIM_TEMP_L           0x3B
#define HWMONITOR_REG_RAM_CURRENT_LIM_FUN_1    0x3C
#define HWMONITOR_REG_RAM_CURRENT_LIM_FUN_2    0x3D
#define HWMONITOR_REG_RAM_MANUFACTURE_ID       0x3E
#define HWMONITOR_REG_RAM_REVISION_ID          0x3F
 
 // hwmonitor_reg
 
#define HWMONITOR_SET_CONFIG_START_DIS         0x00
#define HWMONITOR_SET_CONFIG_START_EN          0x01
#define HWMONITOR_SET_CONFIG_INT_DIS           0x00
#define HWMONITOR_SET_CONFIG_INT_EN            0x01
#define HWMONITOR_SET_CONFIG_INT_OPEN_DRAIN    0x00
#define HWMONITOR_SET_CONFIG_INT_ACT_LOW       0x01
#define HWMONITOR_SET_CONFIG_INT_CLR_DIS       0x00
#define HWMONITOR_SET_CONFIG_INT_CLR_EN        0x01
#define HWMONITOR_SET_CONFIG_CHA_NCLR_GPI      0x00
#define HWMONITOR_SET_CONFIG_CHA_GPI           0x01
#define HWMONITOR_SET_CONFIG_GPO_LOW           0x00
#define HWMONITOR_SET_CONFIG_GPO_HIGH          0x01
#define HWMONITOR_SET_CONFIG_PWR_ON            0x00
#define HWMONITOR_SET_CONFIG_PWR_DIS           0x01
 
#define HWMONITOR_SET_FAN1_MODE_COUNT          0x00
#define HWMONITOR_SET_FAN1_MODE_SENS_INPUT     0x01
#define HWMONITOR_SET_FAN2_MODE_COUNT          0x00
#define HWMONITOR_SET_FAN2_MODE_SENS_INPUT     0x02
#define HWMONITOR_SET_FAN1_CTRL_SPEED_DIV1     0x00
#define HWMONITOR_SET_FAN1_CTRL_SPEED_DIV2     0x04
#define HWMONITOR_SET_FAN1_CTRL_SPEED_DIV4     0x08
#define HWMONITOR_SET_FAN1_CTRL_SPEED_DIV8     0x0C
#define HWMONITOR_SET_FAN2_CTRL_SPEED_DIV1     0x00
#define HWMONITOR_SET_FAN2_CTRL_SPEED_DIV2     0x10
#define HWMONITOR_SET_FAN2_CTRL_SPEED_DIV4     0x20
#define HWMONITOR_SET_FAN2_CTRL_SPEED_DIV8     0x30
#define HWMONITOR_SET_MODE_OS_DISABLE          0x00
#define HWMONITOR_SET_MODE_OS_ENABLE           0x01
#define HWMONITOR_SET_MODE_RST_DISABLE         0x00
#define HWMONITOR_SET_MODE_RST_ENABLE          0x01
 
#define HWMONITOR_SET_TEMP_RES_8_bit           0x00
#define HWMONITOR_SET_TEMP_RES_11_bit          0x01
#define HWMONITOR_TEMP_RES_11_bit_BIT_MASK     0x08
 
#define HWMONITOR_SET_ALL_CH_ENABLE            0x00
#define HWMONITOR_SET_ALL_CH_DISABLE           0xFF
 
#define HWMONITOR_MANUFACTURERS_ID             0x01
#define HWMONITOR_STEPPING_DIE_REVISION_ID     0x08
 
#define HWMONITOR_IN_0                         0
#define HWMONITOR_IN_1                         1
#define HWMONITOR_IN_2                         2
#define HWMONITOR_IN_3                         3
#define HWMONITOR_IN_4                         4
#define HWMONITOR_IN_5                         5
#define HWMONITOR_IN_6                         6
#define HWMONITOR_FAN_1                        0
#define HWMONITOR_FAN_2                        1
 
#define HWMONITOR_DEVICE_ADDRESS_0             0x28
#define HWMONITOR_DEVICE_ADDRESS_1             0x29
#define HWMONITOR_DEVICE_ADDRESS_2             0x2A
#define HWMONITOR_DEVICE_ADDRESS_3             0x2B
#define HWMONITOR_DEVICE_ADDRESS_4             0x2C
#define HWMONITOR_DEVICE_ADDRESS_5             0x2D
#define HWMONITOR_DEVICE_ADDRESS_6             0x2E
#define HWMONITOR_DEVICE_ADDRESS_7             0x2F
 
 // hwmonitor_set
 
#define HWMONITOR_MAP_MIKROBUS( cfg, mikrobus )   \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // hwmonitor_map
 // hwmonitor
 
typedef struct
{
    // Output pins
    digital_out_t rst;        
    // Input pins
    digital_in_t int_pin;     
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} hwmonitor_t;
 
typedef struct
{
    pin_name_t scl;    
    pin_name_t sda;    
    pin_name_t rst;        
    pin_name_t int_pin;    
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
} hwmonitor_cfg_t;
 
typedef struct
{
    uint8_t start;          
    uint8_t int_enable;     
    uint8_t int_pol_sel;    
    uint8_t int_clear;      
    uint8_t chas_clear;     
    uint8_t gpo;            
    uint8_t init;           
} hwmonitor_config_t;
 
typedef enum
{
    HWMONITOR_OK = 0,
    HWMONITOR_ERROR = -1
 
} hwmonitor_return_value_t;
 
void hwmonitor_cfg_setup ( hwmonitor_cfg_t *cfg );
 
err_t hwmonitor_init ( hwmonitor_t *ctx, hwmonitor_cfg_t *cfg );
 
err_t hwmonitor_default_cfg ( hwmonitor_t *ctx );
 
err_t hwmonitor_generic_write ( hwmonitor_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t hwmonitor_generic_read ( hwmonitor_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void hwmonitor_reset ( hwmonitor_t *ctx );
 
err_t hwmonitor_get_config ( hwmonitor_t *ctx, hwmonitor_config_t *config );
 
err_t hwmonitor_set_config ( hwmonitor_t *ctx, hwmonitor_config_t config );
 
err_t hwmonitor_get_device_id ( hwmonitor_t *ctx, uint8_t *manufacture_id, uint8_t *revision_id );
 
err_t hwmonitor_set_temp_res ( hwmonitor_t *ctx, uint8_t temp_res );
 
err_t hwmonitor_set_ch_out ( hwmonitor_t *ctx, uint8_t ch_out );
 
err_t hwmonitor_get_temperature ( hwmonitor_t *ctx, float *temperature );
 
err_t hwmonitor_get_analog_inputs ( hwmonitor_t *ctx, uint8_t in_pos, float *voltage );
 
err_t hwmonitor_get_fan_output ( hwmonitor_t *ctx, uint8_t fan_pos, uint8_t *fan_output );
 
err_t hwmonitor_set_analog_in_limit ( hwmonitor_t *ctx, uint8_t in_pos, uint16_t upper_limit, uint16_t lower_limit );
 
uint8_t hwmonitor_get_int_pin ( hwmonitor_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // HWMONITOR_H
 
 // hwmonitor
 
// ------------------------------------------------------------------------ END