brushless14  2.0.0.0
brushless14.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 BRUSHLESS14_H
29 #define BRUSHLESS14_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 #include "drv_pwm.h"
49 
70 #define BRUSHLESS14_DAC_REG_CONFIG 0x01
71 #define BRUSHLESS14_DAC_REG_STATUS_TRIGGER 0x02
72 #define BRUSHLESS14_DAC_REG_BRDCAST 0x03
73 #define BRUSHLESS14_DAC_REG_DAC_A_DATA 0x08
74 #define BRUSHLESS14_DAC_REG_DAC_B_DATA 0x09
75 #define BRUSHLESS14_DAC_REG_DAC_C_DATA 0x0A
76 #define BRUSHLESS14_DAC_REG_DAC_D_DATA 0x0B
77 #define BRUSHLESS14_DAC_REG_DAC_E_DATA 0x0C
78 #define BRUSHLESS14_DAC_REG_DAC_F_DATA 0x0D
79 #define BRUSHLESS14_DAC_REG_DAC_G_DATA 0x0E
80 #define BRUSHLESS14_DAC_REG_DAC_H_DATA 0x0F
81 
82 #define BRUSHLESS14_PE_REG_INPUT_PORT 0x00
83 #define BRUSHLESS14_PE_REG_OUTPUT_PORT 0x01
84 #define BRUSHLESS14_PE_REG_POLARITY 0x02
85 #define BRUSHLESS14_PE_REG_CONFIGURATION 0x03
86  // brushless14_reg
88 
103 #define BRUSHLESS14_DAC_ID 0x0500
104 
110 #define BRUSHLESS14_EXPANDER_SLAVE_ADDR 0x73
111 #define BRUSHLESS14_DAC_SLAVE_ADDR 0x48
112 
117 #define BRUSHLESS14_DEF_FREQ 5000
118  // brushless14_set
120 
135 #define BRUSHLESS14_MAP_MIKROBUS( cfg, mikrobus ) \
136  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
137  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
138  cfg.dir = MIKROBUS( mikrobus, MIKROBUS_RST ); \
139  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
140  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
141  // brushless14_map // brushless14
144 
149 typedef struct
150 {
151  // Output pins
152  digital_out_t dir;
154  // Input pins
155  digital_in_t int_pin;
157  // Modules
158  i2c_master_t i2c;
159  pwm_t pwm;
161  // I2C slave address
162  uint8_t slave_address;
163  // ctx variable
164  uint32_t pwm_freq;
166 } brushless14_t;
167 
172 typedef struct
173 {
174  pin_name_t scl;
175  pin_name_t sda;
176  pin_name_t pwm;
178  pin_name_t dir;
179  pin_name_t int_pin;
181  uint32_t i2c_speed;
182  uint8_t i2c_address;
183  uint32_t dev_pwm_freq;
186 
191 typedef enum
192 {
194  BRUSHLESS14_ERROR = -1
195 
197 
214 
229 
244 
256 err_t brushless14_set_duty_cycle ( brushless14_t *ctx, float duty_cycle );
257 
269 
281 
294 err_t brushless14_dac_write ( brushless14_t *ctx, uint8_t reg, uint16_t in_data );
295 
308 err_t brushless14_dac_read ( brushless14_t *ctx, uint8_t reg, uint16_t *out_data );
309 
321 err_t brushless14_set_adj0 ( brushless14_t *ctx, uint16_t m_voltage );
322 
334 err_t brushless14_set_adj1 ( brushless14_t *ctx, uint16_t m_voltage );
335 
347 err_t brushless14_set_adj2 ( brushless14_t *ctx, uint16_t m_voltage );
348 
360 err_t brushless14_set_adj3 ( brushless14_t *ctx, uint16_t m_voltage );
361 
373 err_t brushless14_set_fpwm ( brushless14_t *ctx, uint16_t m_voltage );
374 
386 err_t brushless14_set_la ( brushless14_t *ctx, uint16_t m_voltage );
387 
400 err_t brushless14_port_expander_write ( brushless14_t *ctx, uint8_t reg, uint8_t in_data );
401 
414 err_t brushless14_port_expander_read ( brushless14_t *ctx, uint8_t reg, uint8_t *out_data );
415 
427 err_t brushless14_set_slop ( brushless14_t *ctx, uint8_t state );
428 
440 err_t brushless14_set_rot ( brushless14_t *ctx, uint8_t state );
441 
453 err_t brushless14_set_fst ( brushless14_t *ctx, uint8_t state );
454 
466 err_t brushless14_set_sel_adj ( brushless14_t *ctx, uint8_t state );
467 
479 err_t brushless14_set_lap ( brushless14_t *ctx, uint8_t state );
480 
492 err_t brushless14_get_fg_out ( brushless14_t *ctx, uint8_t *state );
493 
505 err_t brushless14_get_ld_out ( brushless14_t *ctx, uint8_t *state );
506 
515 
524 void brushless14_set_dir ( brushless14_t *ctx, uint8_t state );
525 
526 #ifdef __cplusplus
527 }
528 #endif
529 #endif // BRUSHLESS14_H
530  // brushless14
532 
533 // ------------------------------------------------------------------------ END
brushless14_t::pwm
pwm_t pwm
Definition: brushless14.h:159
brushless14_pwm_stop
err_t brushless14_pwm_stop(brushless14_t *ctx)
Brushless 14 stop PWM module.
brushless14_default_cfg
err_t brushless14_default_cfg(brushless14_t *ctx)
Brushless 14 default configuration function.
brushless14_cfg_t::scl
pin_name_t scl
Definition: brushless14.h:174
brushless14_set_rot
err_t brushless14_set_rot(brushless14_t *ctx, uint8_t state)
Set rotation speed of lead angle switching.
brushless14_set_fpwm
err_t brushless14_set_fpwm(brushless14_t *ctx, uint16_t m_voltage)
Set PWM frequency select input.
BRUSHLESS14_OK
@ BRUSHLESS14_OK
Definition: brushless14.h:193
brushless14_t::slave_address
uint8_t slave_address
Definition: brushless14.h:162
brushless14_cfg_t
Brushless 14 Click configuration object.
Definition: brushless14.h:173
brushless14_cfg_t::sda
pin_name_t sda
Definition: brushless14.h:175
brushless14_set_dir
void brushless14_set_dir(brushless14_t *ctx, uint8_t state)
Set dirrection pin state.
brushless14_set_adj3
err_t brushless14_set_adj3(brushless14_t *ctx, uint16_t m_voltage)
Set Adjusted input 3.
brushless14_cfg_t::i2c_address
uint8_t i2c_address
Definition: brushless14.h:182
brushless14_cfg_t::pwm
pin_name_t pwm
Definition: brushless14.h:176
brushless14_t::dir
digital_out_t dir
Definition: brushless14.h:152
brushless14_set_slop
err_t brushless14_set_slop(brushless14_t *ctx, uint8_t state)
Set soft switching select.
brushless14_get_int
uint8_t brushless14_get_int(brushless14_t *ctx)
Get port expadner interrupt.
brushless14_t::int_pin
digital_in_t int_pin
Definition: brushless14.h:155
brushless14_cfg_setup
void brushless14_cfg_setup(brushless14_cfg_t *cfg)
Brushless 14 configuration object setup function.
brushless14_port_expander_read
err_t brushless14_port_expander_read(brushless14_t *ctx, uint8_t reg, uint8_t *out_data)
Port expander reading function.
brushless14_port_expander_write
err_t brushless14_port_expander_write(brushless14_t *ctx, uint8_t reg, uint8_t in_data)
Port expander write function.
brushless14_dac_read
err_t brushless14_dac_read(brushless14_t *ctx, uint8_t reg, uint16_t *out_data)
DAC reading function.
brushless14_set_adj2
err_t brushless14_set_adj2(brushless14_t *ctx, uint16_t m_voltage)
Set Adjusted input 2.
brushless14_set_la
err_t brushless14_set_la(brushless14_t *ctx, uint16_t m_voltage)
Set lead angle setting input.
brushless14_pwm_start
err_t brushless14_pwm_start(brushless14_t *ctx)
Brushless 14 start PWM module.
brushless14_get_fg_out
err_t brushless14_get_fg_out(brushless14_t *ctx, uint8_t *state)
Get rotation speed.
brushless14_t
Brushless 14 Click context object.
Definition: brushless14.h:150
brushless14_set_fst
err_t brushless14_set_fst(brushless14_t *ctx, uint8_t state)
Set forced commutation frequency select.
brushless14_set_duty_cycle
err_t brushless14_set_duty_cycle(brushless14_t *ctx, float duty_cycle)
Brushless 14 sets PWM duty cycle.
brushless14_dac_write
err_t brushless14_dac_write(brushless14_t *ctx, uint8_t reg, uint16_t in_data)
DAC write function.
brushless14_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: brushless14.h:181
BRUSHLESS14_ERROR
@ BRUSHLESS14_ERROR
Definition: brushless14.h:194
brushless14_set_sel_adj
err_t brushless14_set_sel_adj(brushless14_t *ctx, uint8_t state)
Set PWM duty function setting.
brushless14_set_adj1
err_t brushless14_set_adj1(brushless14_t *ctx, uint16_t m_voltage)
Set Adjusted input 1.
brushless14_get_ld_out
err_t brushless14_get_ld_out(brushless14_t *ctx, uint8_t *state)
Get lock detection signal.
brushless14_cfg_t::int_pin
pin_name_t int_pin
Definition: brushless14.h:179
brushless14_return_value_t
brushless14_return_value_t
Brushless 14 Click return value data.
Definition: brushless14.h:192
brushless14_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: brushless14.h:183
brushless14_cfg_t::dir
pin_name_t dir
Definition: brushless14.h:178
brushless14_t::pwm_freq
uint32_t pwm_freq
Definition: brushless14.h:164
brushless14_set_adj0
err_t brushless14_set_adj0(brushless14_t *ctx, uint16_t m_voltage)
Set Adjusted input 0.
brushless14_init
err_t brushless14_init(brushless14_t *ctx, brushless14_cfg_t *cfg)
Brushless 14 initialization function.
brushless14_t::i2c
i2c_master_t i2c
Definition: brushless14.h:158
brushless14_set_lap
err_t brushless14_set_lap(brushless14_t *ctx, uint8_t state)
Set overlapping commutation select.