fan3  2.0.0.0
fan3.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef FAN3_H
36 #define FAN3_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 
55 #include "drv_i2c_master.h"
56 
57 // -------------------------------------------------------------- PUBLIC MACROS
67 #define FAN3_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
69  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
70 
76 #define FAN3_RETVAL uint8_t
77 
78 #define FAN3_OK 0x00
79 #define FAN3_INIT_ERROR 0xFF
80 
86 #define FAN3_STOPPED 0x00
87 #define FAN3_SPEED1 0x01
88 #define FAN3_SPEED2 0x02
89 #define FAN3_SPEED3 0x03
90 #define FAN3_SPEED4 0x04
91 #define FAN3_SPEED5 0x05
92 #define FAN3_SPEED6 0x06
93 #define FAN3_SPEED7 0x07
94  // End group macro
97 // --------------------------------------------------------------- PUBLIC TYPES
106 typedef struct
107 {
108  // Modules
109 
110  i2c_master_t i2c;
111 
112  // ctx variable
113 
114  uint8_t slave_address;
115 
116 } fan3_t;
117 
121 typedef struct
122 {
123  // Communication gpio pins
124 
125  pin_name_t scl;
126  pin_name_t sda;
127 
128  // static variable
129 
130  uint32_t i2c_speed;
131  uint8_t i2c_address;
132 
133 } fan3_cfg_t;
134  // End types group
136 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
137 
143 #ifdef __cplusplus
144 extern "C"{
145 #endif
146 
156 
166 
177 void fan3_generic_write ( fan3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
178 
189 void fan3_generic_read ( fan3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
190 
199 void fan3_set_speed ( fan3_t *ctx, uint8_t new_speed );
200 
201 #ifdef __cplusplus
202 }
203 #endif
204 #endif // _FAN3_H_
205  // End public_function group
208 
209 // ------------------------------------------------------------------------- END
fan3_generic_read
void fan3_generic_read(fan3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
fan3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: fan3.h:130
fan3_init
FAN3_RETVAL fan3_init(fan3_t *ctx, fan3_cfg_t *cfg)
Initialization function.
fan3_set_speed
void fan3_set_speed(fan3_t *ctx, uint8_t new_speed)
Set speed.
fan3_cfg_t::sda
pin_name_t sda
Definition: fan3.h:126
FAN3_RETVAL
#define FAN3_RETVAL
Definition: fan3.h:76
fan3_cfg_t::scl
pin_name_t scl
Definition: fan3.h:125
fan3_t
Click ctx object definition.
Definition: fan3.h:107
fan3_cfg_setup
void fan3_cfg_setup(fan3_cfg_t *cfg)
Config Object Initialization function.
fan3_cfg_t
Click configuration structure definition.
Definition: fan3.h:122
fan3_generic_write
void fan3_generic_write(fan3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
fan3_t::i2c
i2c_master_t i2c
Definition: fan3.h:110
fan3_t::slave_address
uint8_t slave_address
Definition: fan3.h:114
fan3_cfg_t::i2c_address
uint8_t i2c_address
Definition: fan3.h:131