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
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38
59#define FAN5_RPM1_REG 0x00
60#define FAN5_RPM2_REG 0x01
61#define FAN5_FAN_FAULT1_REG 0x02
62#define FAN5_FAN_FAULT2_REG 0x03
63#define FAN5_CONFIG_REG 0x04
64#define FAN5_STATUS_REG 0x05
65#define FAN5_DUTY_CYCLE_REG 0x06
66#define FAN5_MFR_ID_REG 0x07
67#define FAN5_VER_ID_REG 0x08
68 // fan5_reg
70
85#define FAN5_CLEAR_FLT 0x80
86#define FAN5_8_BIT_RESOLUTION 0x00
87#define FAN5_9_BIT_RESOLUTION 0x40
88#define FAN5_VOUT_BASED_ON_DYTY_REG 0x20
89#define FAN5_VOUT_BASED_ON_VIN 0x00
90#define FAN5_FAN2_PPR_1 0x00
91#define FAN5_FAN2_PPR_2 0x08
92#define FAN5_FAN2_PPR_4 0x10
93#define FAN5_FAN2_PPR_8 0x18
94#define FAN5_FAN1_PPR_1 0x00
95#define FAN5_FAN1_PPR_2 0x02
96#define FAN5_FAN1_PPR_4 0x04
97#define FAN5_FAN1_PPR_8 0x06
98#define FAN5_SHUTDOWN_MODE 0x01
99#define FAN5_NORMAL_MODE 0x00
100
101#define FAN5_MAX_RPM_VALUE 12750
102
107#define FAN5_OTF_FLAG 0x20
108#define FAN5_R2CO_FLAG 0x10
109#define FAN5_R1CO_FLAG 0x08
110#define FAN5_VSTAT_FLAG 0x04
111#define FAN5_F2F_FLAG 0x02
112#define FAN5_F1F_FLAG 0x01
113
118#define FAN5_30_PER_DUTY 0x00
119#define FAN5_35_PER_DUTY 0x01
120#define FAN5_40_PER_DUTY 0x02
121#define FAN5_44_PER_DUTY 0x03
122#define FAN5_49_PER_DUTY 0x04
123#define FAN5_53_PER_DUTY 0x05
124#define FAN5_58_PER_DUTY 0x06
125#define FAN5_63_PER_DUTY 0x07
126#define FAN5_67_PER_DUTY 0x08
127#define FAN5_72_PER_DUTY 0x09
128#define FAN5_77_PER_DUTY 0x0A
129#define FAN5_81_PER_DUTY 0x0B
130#define FAN5_86_PER_DUTY 0x0C
131#define FAN5_90_PER_DUTY 0x0D
132#define FAN5_95_PER_DUTY 0x0E
133#define FAN5_100_PER_DUTY 0x0F
134
140#define FAN5_DEVICE_ADDRESS 0x1B
141 // fan5_set
143
158#define FAN5_MAP_MIKROBUS( cfg, mikrobus ) \
159 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
160 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
161 cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
162 // fan5_map // fan5
165
170typedef struct
171{
172 // Input pins
173 digital_in_t flt;
175 // Modules
176 i2c_master_t i2c;
178 // I2C slave address
181} fan5_t;
182
187typedef struct
188{
189 pin_name_t scl;
190 pin_name_t sda;
192 pin_name_t flt;
194 uint32_t i2c_speed;
195 uint8_t i2c_address;
197} fan5_cfg_t;
198
203typedef enum
204{
207 FAN5_FAULT = -2
208
210
227
241err_t fan5_init ( fan5_t *ctx, fan5_cfg_t *cfg );
242
256
271err_t fan5_generic_write ( fan5_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
272
287err_t fan5_generic_read ( fan5_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
288
302err_t fan5_reg_write ( fan5_t *ctx, uint8_t reg, uint8_t data_in );
303
317err_t fan5_reg_read ( fan5_t *ctx, uint8_t reg, uint8_t *data_out );
318
331err_t fan5_get_mfr_id( fan5_t *ctx, uint8_t *mfr_id );
332
345err_t fan5_get_rpm1 ( fan5_t *ctx, uint16_t *fan1_speed );
346
359err_t fan5_get_rpm2 ( fan5_t *ctx, uint16_t *fan2_speed );
360
373err_t fan5_set_fan_fault1 ( fan5_t *ctx, uint16_t fault1_value );
374
387err_t fan5_set_fan_fault2 ( fan5_t *ctx, uint16_t fault2_value );
388
400err_t fan5_set_duty_cycle ( fan5_t *ctx, uint8_t duty_cycle );
401
414err_t fan5_get_status_flags ( fan5_t *ctx, uint8_t *status_data );
415
427
439
451
463
464#ifdef __cplusplus
465}
466#endif
467#endif // FAN5_H
468 // fan5
470
471// ------------------------------------------------------------------------ END
fan5_return_value_t
Fan 5 Click return value data.
Definition: fan5.h:204
@ FAN5_FAULT
Definition: fan5.h:207
@ FAN5_ERROR
Definition: fan5.h:206
@ FAN5_OK
Definition: fan5.h:205
err_t fan5_set_duty_cycle(fan5_t *ctx, uint8_t duty_cycle)
Fan 5 set duty cycle.
err_t fan5_get_mfr_id(fan5_t *ctx, uint8_t *mfr_id)
Fan 5 read manufacturer identification.
err_t fan5_init(fan5_t *ctx, fan5_cfg_t *cfg)
Fan 5 initialization function.
err_t fan5_reg_write(fan5_t *ctx, uint8_t reg, uint8_t data_in)
Fan 5 I2C writing into register function.
err_t fan5_get_rpm1(fan5_t *ctx, uint16_t *fan1_speed)
Fan 5 get speed of FAN1.
err_t fan5_default_cfg(fan5_t *ctx)
Fan 5 default configuration function.
void fan5_cfg_setup(fan5_cfg_t *cfg)
Fan 5 configuration object setup function.
err_t fan5_turn_off_fans(fan5_t *ctx)
Fan 5 turn off fans.
err_t fan5_reg_read(fan5_t *ctx, uint8_t reg, uint8_t *data_out)
Fan 5 I2C reading register function.
err_t fan5_get_fault_state(fan5_t *ctx)
Fan 5 get fault state.
err_t fan5_set_fan_fault1(fan5_t *ctx, uint16_t fault1_value)
Fan 5 set FAN1 fault threshold.
err_t fan5_get_status_flags(fan5_t *ctx, uint8_t *status_data)
Fan 5 get status flags.
err_t fan5_generic_read(fan5_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Fan 5 I2C reading function.
err_t fan5_turn_on_fans(fan5_t *ctx)
Fan 5 turn on fans.
err_t fan5_generic_write(fan5_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Fan 5 I2C writing function.
err_t fan5_set_fan_fault2(fan5_t *ctx, uint16_t fault2_value)
Fan 5 set FAN2 fault threshold.
err_t fan5_get_rpm2(fan5_t *ctx, uint16_t *fan2_speed)
Fan 5 get speed of FAN2.
err_t fan5_clear_flt_flag(fan5_t *ctx)
Fan 5 clear status flags.
Fan 5 Click configuration object.
Definition: fan5.h:188
uint32_t i2c_speed
Definition: fan5.h:194
pin_name_t flt
Definition: fan5.h:192
pin_name_t scl
Definition: fan5.h:189
pin_name_t sda
Definition: fan5.h:190
uint8_t i2c_address
Definition: fan5.h:195
Fan 5 Click context object.
Definition: fan5.h:171
digital_in_t flt
Definition: fan5.h:173
i2c_master_t i2c
Definition: fan5.h:176
uint8_t slave_address
Definition: fan5.h:179