fan5  2.1.0.0
fan5.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef FAN5_H
29 #define FAN5_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
73 #define FAN5_RPM1_REG 0x00
74 #define FAN5_RPM2_REG 0x01
75 #define FAN5_FAN_FAULT1_REG 0x02
76 #define FAN5_FAN_FAULT2_REG 0x03
77 #define FAN5_CONFIG_REG 0x04
78 #define FAN5_STATUS_REG 0x05
79 #define FAN5_DUTY_CYCLE_REG 0x06
80 #define FAN5_MFR_ID_REG 0x07
81 #define FAN5_VER_ID_REG 0x08
82  // fan5_reg
84 
99 #define FAN5_CLEAR_FLT 0x80
100 #define FAN5_8_BIT_RESOLUTION 0x00
101 #define FAN5_9_BIT_RESOLUTION 0x40
102 #define FAN5_VOUT_BASED_ON_DYTY_REG 0x20
103 #define FAN5_VOUT_BASED_ON_VIN 0x00
104 #define FAN5_FAN2_PPR_1 0x00
105 #define FAN5_FAN2_PPR_2 0x08
106 #define FAN5_FAN2_PPR_4 0x10
107 #define FAN5_FAN2_PPR_8 0x18
108 #define FAN5_FAN1_PPR_1 0x00
109 #define FAN5_FAN1_PPR_2 0x02
110 #define FAN5_FAN1_PPR_4 0x04
111 #define FAN5_FAN1_PPR_8 0x06
112 #define FAN5_SHUTDOWN_MODE 0x01
113 #define FAN5_NORMAL_MODE 0x00
114 
115 #define FAN5_MAX_RPM_VALUE 12750
116 
121 #define FAN5_OTF_FLAG 0x20
122 #define FAN5_R2CO_FLAG 0x10
123 #define FAN5_R1CO_FLAG 0x08
124 #define FAN5_VSTAT_FLAG 0x04
125 #define FAN5_F2F_FLAG 0x02
126 #define FAN5_F1F_FLAG 0x01
127 
132 #define FAN5_30_PER_DUTY 0x00
133 #define FAN5_35_PER_DUTY 0x01
134 #define FAN5_40_PER_DUTY 0x02
135 #define FAN5_44_PER_DUTY 0x03
136 #define FAN5_49_PER_DUTY 0x04
137 #define FAN5_53_PER_DUTY 0x05
138 #define FAN5_58_PER_DUTY 0x06
139 #define FAN5_63_PER_DUTY 0x07
140 #define FAN5_67_PER_DUTY 0x08
141 #define FAN5_72_PER_DUTY 0x09
142 #define FAN5_77_PER_DUTY 0x0A
143 #define FAN5_81_PER_DUTY 0x0B
144 #define FAN5_86_PER_DUTY 0x0C
145 #define FAN5_90_PER_DUTY 0x0D
146 #define FAN5_95_PER_DUTY 0x0E
147 #define FAN5_100_PER_DUTY 0x0F
148 
154 #define FAN5_DEVICE_ADDRESS 0x1B
155  // fan5_set
157 
172 #define FAN5_MAP_MIKROBUS( cfg, mikrobus ) \
173  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
174  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
175  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
176  // fan5_map // fan5
179 
184 typedef struct
185 {
186  // Input pins
187  digital_in_t flt;
189  // Modules
190  i2c_master_t i2c;
192  // I2C slave address
193  uint8_t slave_address;
195 } fan5_t;
196 
201 typedef struct
202 {
203  pin_name_t scl;
204  pin_name_t sda;
206  pin_name_t flt;
208  uint32_t i2c_speed;
209  uint8_t i2c_address;
211 } fan5_cfg_t;
212 
217 typedef enum
218 {
219  FAN5_OK = 0,
221  FAN5_FAULT = -2
222 
224 
241 
255 err_t fan5_init ( fan5_t *ctx, fan5_cfg_t *cfg );
256 
269 err_t fan5_default_cfg ( fan5_t *ctx );
270 
285 err_t fan5_generic_write ( fan5_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
286 
301 err_t fan5_generic_read ( fan5_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
302 
316 err_t fan5_reg_write ( fan5_t *ctx, uint8_t reg, uint8_t data_in );
317 
331 err_t fan5_reg_read ( fan5_t *ctx, uint8_t reg, uint8_t *data_out );
332 
345 err_t fan5_get_mfr_id( fan5_t *ctx, uint8_t *mfr_id );
346 
359 err_t fan5_get_rpm1 ( fan5_t *ctx, uint16_t *fan1_speed );
360 
373 err_t fan5_get_rpm2 ( fan5_t *ctx, uint16_t *fan2_speed );
374 
387 err_t fan5_set_fan_fault1 ( fan5_t *ctx, uint16_t fault1_value );
388 
401 err_t fan5_set_fan_fault2 ( fan5_t *ctx, uint16_t fault2_value );
402 
414 err_t fan5_set_duty_cycle ( fan5_t *ctx, uint8_t duty_cycle );
415 
428 err_t fan5_get_status_flags ( fan5_t *ctx, uint8_t *status_data );
429 
441 
453 
464 err_t fan5_turn_on_fans ( fan5_t *ctx );
465 
476 err_t fan5_turn_off_fans ( fan5_t *ctx );
477 
478 #ifdef __cplusplus
479 }
480 #endif
481 #endif // FAN5_H
482  // fan5
484 
485 // ------------------------------------------------------------------------ END
FAN5_OK
@ FAN5_OK
Definition: fan5.h:219
fan5_generic_read
err_t fan5_generic_read(fan5_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Fan 5 I2C reading function.
fan5_get_status_flags
err_t fan5_get_status_flags(fan5_t *ctx, uint8_t *status_data)
Fan 5 get status flags.
fan5_set_duty_cycle
err_t fan5_set_duty_cycle(fan5_t *ctx, uint8_t duty_cycle)
Fan 5 set duty cycle.
fan5_init
err_t fan5_init(fan5_t *ctx, fan5_cfg_t *cfg)
Fan 5 initialization function.
fan5_turn_on_fans
err_t fan5_turn_on_fans(fan5_t *ctx)
Fan 5 turn on fans.
fan5_return_value_t
fan5_return_value_t
Fan 5 Click return value data.
Definition: fan5.h:218
fan5_set_fan_fault1
err_t fan5_set_fan_fault1(fan5_t *ctx, uint16_t fault1_value)
Fan 5 set FAN1 fault threshold.
fan5_t::slave_address
uint8_t slave_address
Definition: fan5.h:193
fan5_t
Fan 5 Click context object.
Definition: fan5.h:185
fan5_reg_read
err_t fan5_reg_read(fan5_t *ctx, uint8_t reg, uint8_t *data_out)
Fan 5 I2C reading register function.
fan5_get_rpm2
err_t fan5_get_rpm2(fan5_t *ctx, uint16_t *fan2_speed)
Fan 5 get speed of FAN2.
fan5_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: fan5.h:208
fan5_get_fault_state
err_t fan5_get_fault_state(fan5_t *ctx)
Fan 5 get fault state.
fan5_cfg_t::i2c_address
uint8_t i2c_address
Definition: fan5.h:209
fan5_set_fan_fault2
err_t fan5_set_fan_fault2(fan5_t *ctx, uint16_t fault2_value)
Fan 5 set FAN2 fault threshold.
fan5_reg_write
err_t fan5_reg_write(fan5_t *ctx, uint8_t reg, uint8_t data_in)
Fan 5 I2C writing into register function.
fan5_cfg_t
Fan 5 Click configuration object.
Definition: fan5.h:202
fan5_get_rpm1
err_t fan5_get_rpm1(fan5_t *ctx, uint16_t *fan1_speed)
Fan 5 get speed of FAN1.
fan5_cfg_setup
void fan5_cfg_setup(fan5_cfg_t *cfg)
Fan 5 configuration object setup function.
fan5_t::i2c
i2c_master_t i2c
Definition: fan5.h:190
fan5_cfg_t::flt
pin_name_t flt
Definition: fan5.h:206
fan5_get_mfr_id
err_t fan5_get_mfr_id(fan5_t *ctx, uint8_t *mfr_id)
Fan 5 read manufacturer identification.
fan5_default_cfg
err_t fan5_default_cfg(fan5_t *ctx)
Fan 5 default configuration function.
fan5_t::flt
digital_in_t flt
Definition: fan5.h:187
FAN5_ERROR
@ FAN5_ERROR
Definition: fan5.h:220
fan5_cfg_t::scl
pin_name_t scl
Definition: fan5.h:203
fan5_generic_write
err_t fan5_generic_write(fan5_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Fan 5 I2C writing function.
fan5_cfg_t::sda
pin_name_t sda
Definition: fan5.h:204
fan5_clear_flt_flag
err_t fan5_clear_flt_flag(fan5_t *ctx)
Fan 5 clear status flags.
fan5_turn_off_fans
err_t fan5_turn_off_fans(fan5_t *ctx)
Fan 5 turn off fans.
FAN5_FAULT
@ FAN5_FAULT
Definition: fan5.h:221