currentlimit7  2.0.0.0
currentlimit7.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 CURRENTLIMIT7_H
29 #define CURRENTLIMIT7_H
30 
31 #ifdef __cplusplus
32 extern "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 CURRENTLIMIT7_CMD_NOP 0x00
60 #define CURRENTLIMIT7_CMD_WRITE_RDAC 0x04
61 #define CURRENTLIMIT7_CMD_READ_RDAC 0x08
62 #define CURRENTLIMIT7_CMD_STORE_WIPER 0x0C
63 #define CURRENTLIMIT7_CMD_SW_RESET 0x10
64 #define CURRENTLIMIT7_CMD_READ_CONTENTS 0x14
65 #define CURRENTLIMIT7_CMD_READ_MEMORY 0x18
66 #define CURRENTLIMIT7_CMD_WRITE_MEMORY 0x1C
67 #define CURRENTLIMIT7_CMD_READ_CTRL 0x20
68 #define CURRENTLIMIT7_CMD_SW_SHUTDOWN 0x24
69  // currentlimit7_cmd
71 
86 #define CURRENTLIMIT7_OP_0_CURRENT_LIMIT_260_mA 260
87 #define CURRENTLIMIT7_OP_0_CURRENT_LIMIT_280_mA 280
88 #define CURRENTLIMIT7_OP_0_CURRENT_LIMIT_330_mA 330
89 #define CURRENTLIMIT7_OP_0_CURRENT_LIMIT_450_mA 450
90 #define CURRENTLIMIT7_OP_0_CURRENT_LIMIT_510_mA 510
91 #define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_510_mA 510
92 #define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_625_mA 625
93 #define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_860_mA 860
94 #define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_1320_mA 1320
95 #define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_1450_mA 1450
96 #define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_1550_mA 1550
97 #define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_1750_mA 1750
98 #define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_2020_mA 2020
99 #define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_2260_mA 2260
100 #define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_2500_mA 2500
101 
106 #define CURRENTLIMIT7_SET_SHUTDOWN_BIT_MASK 0x01
107 #define CURRENTLIMIT7_SET_NORMAL_MODE 0x00
108 #define CURRENTLIMIT7_SET_SHUTDOWN_MODE 0x01
109 #define CURRENTLIMIT7_SET_ENABLE_WRITE_MEMORY 0x0002
110 
115 #define CURRENTLIMIT7_OP_MODE_500_mA_2500_mA 0x00
116 #define CURRENTLIMIT7_OP_MODE_250_mA_500_mA 0x01
117 
123 #define CURRENTLIMIT7_SET_DEV_ADDR_0 0x2E
124 #define CURRENTLIMIT7_SET_DEV_ADDR_1 0x2C
125  // currentlimit7_set
127 
142 #define CURRENTLIMIT7_MAP_MIKROBUS( cfg, mikrobus ) \
143  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
144  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
145  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
146  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
147  cfg.flg = MIKROBUS( mikrobus, MIKROBUS_INT )
148  // currentlimit7_map // currentlimit7
151 
156 typedef struct
157 {
158  // Output pins
159  digital_out_t en;
160  digital_out_t rst;
162  // Input pins
163  digital_in_t flg;
165  // Modules
166  i2c_master_t i2c;
168  // I2C slave address
169  uint8_t slave_address;
172 
177 typedef struct
178 {
179  pin_name_t scl;
180  pin_name_t sda;
182  pin_name_t en;
183  pin_name_t rst;
184  pin_name_t flg;
186  uint32_t i2c_speed;
187  uint8_t i2c_address;
190 
195 typedef enum
196 {
199 
201 
218 
234 
249 
263 err_t currentlimit7_set_slave_address ( currentlimit7_t *ctx, uint16_t slave_address );
264 
280 
295 
310 
325 err_t currentlimit7_generic_write ( currentlimit7_t *ctx, uint8_t cmd, uint16_t data_byte );
326 
342 err_t currentlimit7_generic_read ( currentlimit7_t *ctx, uint8_t cmd, uint16_t data_byte, uint16_t *data_out );
343 
359 
375 err_t currentlimit7_write_rdac ( currentlimit7_t *ctx, uint16_t data_in );
376 
392 err_t currentlimit7_read_rdac ( currentlimit7_t *ctx, uint16_t *data_out );
393 
409 
425 
442 err_t currentlimit7_next_frame_read ( currentlimit7_t *ctx, uint8_t wiper_location, uint16_t *data_out );
443 
460 err_t currentlimit7_read_memory ( currentlimit7_t *ctx, uint8_t wiper_location, uint16_t *data_out );
461 
477 err_t currentlimit7_operating_mode ( currentlimit7_t *ctx, uint8_t mode );
478 
494 err_t currentlimit7_set_digi_pot ( currentlimit7_t *ctx, uint16_t wiper_pos );
495 
511 err_t currentlimit7_set_resistance ( currentlimit7_t *ctx, uint32_t res_ohm );
512 
531 err_t currentlimit7_set_current_limit ( currentlimit7_t *ctx, uint8_t op_mode, uint16_t current_limit_ma );
532 
548 
549 
550 
551 #ifdef __cplusplus
552 }
553 #endif
554 #endif // CURRENTLIMIT7_H
555  // currentlimit7
557 
558 // ------------------------------------------------------------------------ END
currentlimit7_set_current_limit
err_t currentlimit7_set_current_limit(currentlimit7_t *ctx, uint8_t op_mode, uint16_t current_limit_ma)
Current Limit 7 set current limit function.
currentlimit7_t::i2c
i2c_master_t i2c
Definition: currentlimit7.h:166
currentlimit7_next_frame_read
err_t currentlimit7_next_frame_read(currentlimit7_t *ctx, uint8_t wiper_location, uint16_t *data_out)
Current Limit 7 next frame read function.
currentlimit7_return_value_t
currentlimit7_return_value_t
Current Limit 7 Click return value data.
Definition: currentlimit7.h:196
currentlimit7_set_slave_address
err_t currentlimit7_set_slave_address(currentlimit7_t *ctx, uint16_t slave_address)
Current Limit 7 set I2C Slave address.
currentlimit7_generic_write
err_t currentlimit7_generic_write(currentlimit7_t *ctx, uint8_t cmd, uint16_t data_byte)
Current Limit 7 I2C writing function.
currentlimit7_cfg_t::flg
pin_name_t flg
Definition: currentlimit7.h:184
currentlimit7_cfg_t::rst
pin_name_t rst
Definition: currentlimit7.h:183
currentlimit7_cfg_t::i2c_address
uint8_t i2c_address
Definition: currentlimit7.h:187
currentlimit7_write_rdac
err_t currentlimit7_write_rdac(currentlimit7_t *ctx, uint16_t data_in)
Current Limit 7 write RDAC function.
currentlimit7_cfg_t::sda
pin_name_t sda
Definition: currentlimit7.h:180
currentlimit7_cfg_t::en
pin_name_t en
Definition: currentlimit7.h:182
currentlimit7_default_cfg
err_t currentlimit7_default_cfg(currentlimit7_t *ctx)
Current Limit 7 default configuration function.
currentlimit7_set_disable
err_t currentlimit7_set_disable(currentlimit7_t *ctx)
Current Limit 7 disable the device function.
currentlimit7_read_memory
err_t currentlimit7_read_memory(currentlimit7_t *ctx, uint8_t wiper_location, uint16_t *data_out)
Current Limit 7 read memory function.
CURRENTLIMIT7_ERROR
@ CURRENTLIMIT7_ERROR
Definition: currentlimit7.h:198
currentlimit7_t::slave_address
uint8_t slave_address
Definition: currentlimit7.h:169
currentlimit7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: currentlimit7.h:186
currentlimit7_set_resistance
err_t currentlimit7_set_resistance(currentlimit7_t *ctx, uint32_t res_ohm)
Current Limit 7 set resistance function.
currentlimit7_operating_mode
err_t currentlimit7_operating_mode(currentlimit7_t *ctx, uint8_t mode)
Current Limit 7 set operating mode function.
currentlimit7_t::flg
digital_in_t flg
Definition: currentlimit7.h:163
currentlimit7_cfg_t::scl
pin_name_t scl
Definition: currentlimit7.h:179
currentlimit7_generic_read
err_t currentlimit7_generic_read(currentlimit7_t *ctx, uint8_t cmd, uint16_t data_byte, uint16_t *data_out)
Current Limit 7 I2C reading function.
currentlimit7_hw_reset
err_t currentlimit7_hw_reset(currentlimit7_t *ctx)
Current Limit 7 hardware reset function.
currentlimit7_t::en
digital_out_t en
Definition: currentlimit7.h:159
currentlimit7_cfg_setup
void currentlimit7_cfg_setup(currentlimit7_cfg_t *cfg)
Current Limit 7 configuration object setup function.
currentlimit7_read_rdac
err_t currentlimit7_read_rdac(currentlimit7_t *ctx, uint16_t *data_out)
Current Limit 7 read RDAC function.
currentlimit7_t
Current Limit 7 Click context object.
Definition: currentlimit7.h:157
currentlimit7_store_wiper
err_t currentlimit7_store_wiper(currentlimit7_t *ctx)
Current Limit 7 store wiper function.
currentlimit7_set_digi_pot
err_t currentlimit7_set_digi_pot(currentlimit7_t *ctx, uint16_t wiper_pos)
Current Limit 7 set DIGI POT function.
currentlimit7_cfg_t
Current Limit 7 Click configuration object.
Definition: currentlimit7.h:178
currentlimit7_get_fault
uint8_t currentlimit7_get_fault(currentlimit7_t *ctx)
Current Limit 7 get fault function.
currentlimit7_init
err_t currentlimit7_init(currentlimit7_t *ctx, currentlimit7_cfg_t *cfg)
Current Limit 7 initialization function.
CURRENTLIMIT7_OK
@ CURRENTLIMIT7_OK
Definition: currentlimit7.h:197
currentlimit7_enable_write
err_t currentlimit7_enable_write(currentlimit7_t *ctx)
Current Limit 7 enable write function.
currentlimit7_set_enable
err_t currentlimit7_set_enable(currentlimit7_t *ctx)
Current Limit 7 enable the device function.
currentlimit7_t::rst
digital_out_t rst
Definition: currentlimit7.h:160
currentlimit7_sw_reset
err_t currentlimit7_sw_reset(currentlimit7_t *ctx)
Current Limit 7 software reset function.