efuse4  2.1.0.0
efuse4.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 EFUSE4_H
29 #define EFUSE4_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 
69 #define EFUSE4_CMD_NOP 0x00
70 #define EFUSE4_CMD_WRITE_RDAC 0x04
71 #define EFUSE4_CMD_READ_RDAC 0x08
72 #define EFUSE4_CMD_STORE_WIPER 0x0C
73 #define EFUSE4_CMD_SW_RESET 0x10
74 #define EFUSE4_CMD_READ_CONTENTS 0x14
75 #define EFUSE4_CMD_READ_MEMORY 0x18
76 #define EFUSE4_CMD_WRITE_MEMORY 0x1C
77 #define EFUSE4_CMD_READ_CTRL 0x20
78 #define EFUSE4_CMD_SW_SHUTDOWN 0x24
79  // efuse4_com
81 
96 #define EFUSE4_SET_SHUTDOWN_BIT_MASK 0x01
97 #define EFUSE4_SET_NORMAL_MODE 0x00
98 #define EFUSE4_SET_SHUTDOWN_MODE 0x01
99 #define EFUSE4_SET_ENABLE_WRITE_MEMORY 0x0002
100 
106 #define EFUSE4_DEVICE_ADDRESS 0x2F
107  // efuse4_set
109 
124 #define EFUSE4_MAP_MIKROBUS( cfg, mikrobus ) \
125  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
126  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
127  cfg.pgd = MIKROBUS( mikrobus, MIKROBUS_AN ); \
128  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
129  cfg.dsv = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
130  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
131  // efuse4_map // efuse4
134 
139 typedef struct
140 {
141  // Output pins
142  digital_out_t rst;
143  digital_out_t dsv;
145  // Input pins
146  digital_in_t pgd;
147  digital_in_t flt;
149  // Modules
150  i2c_master_t i2c;
152  // I2C slave address
153  uint8_t slave_address;
155 } efuse4_t;
156 
161 typedef struct
162 {
163  pin_name_t scl;
164  pin_name_t sda;
166  pin_name_t pgd;
167  pin_name_t rst;
168  pin_name_t dsv;
169  pin_name_t flt;
171  uint32_t i2c_speed;
172  uint8_t i2c_address;
174 } efuse4_cfg_t;
175 
180 typedef enum
181 {
183  EFUSE4_ERROR = -1
184 
186 
191 typedef enum
192 {
200 
202 
219 
233 err_t efuse4_init ( efuse4_t *ctx, efuse4_cfg_t *cfg );
234 
252 
266 err_t efuse4_generic_write ( efuse4_t *ctx, uint8_t cmd, uint16_t data_in );
267 
282 err_t efuse4_generic_read ( efuse4_t *ctx, uint8_t cmd, uint16_t data_in, uint16_t *data_out );
283 
295 
307 
319 
331 
344 err_t efuse4_sw_reset ( efuse4_t *ctx );
345 
359 
373 err_t efuse4_write_rdac ( efuse4_t *ctx, uint16_t data_in );
374 
388 err_t efuse4_read_rdac ( efuse4_t *ctx, uint16_t *data_out );
389 
403 err_t efuse4_digi_pot_op_mode ( efuse4_t *ctx, uint8_t mode );
404 
418 
433 err_t efuse4_next_frame_read ( efuse4_t *ctx, uint8_t wiper_location, uint16_t *data_out );
434 
448 err_t efuse4_read_memory ( efuse4_t *ctx, uint16_t *data_out );
449 
463 err_t efuse4_set_digi_pot ( efuse4_t *ctx, uint16_t wiper_pos );
464 
478 err_t efuse4_set_resistance ( efuse4_t *ctx, uint32_t res_ohm );
479 
494 
506 uint8_t efuse4_fault_state ( efuse4_t *ctx );
507 
520 
521 #ifdef __cplusplus
522 }
523 #endif
524 #endif // EFUSE4_H
525  // efuse4
527 
528 // ------------------------------------------------------------------------ END
efuse4_enable_write
err_t efuse4_enable_write(efuse4_t *ctx)
eFuse 4 enable write function.
efuse4_pwr_good_state
uint8_t efuse4_pwr_good_state(efuse4_t *ctx)
eFuse 4 get power good state function.
efuse4_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: efuse4.h:171
efuse4_cfg_t
eFuse 4 Click configuration object.
Definition: efuse4.h:162
EFUSE4_CURRENT_LIMIT_670_mA
@ EFUSE4_CURRENT_LIMIT_670_mA
Definition: efuse4.h:193
efuse4_fault_state
uint8_t efuse4_fault_state(efuse4_t *ctx)
eFuse 4 get fault state function.
efuse4_next_frame_read
err_t efuse4_next_frame_read(efuse4_t *ctx, uint8_t wiper_location, uint16_t *data_out)
eFuse 4 next frame read function.
efuse4_set_disable
void efuse4_set_disable(efuse4_t *ctx)
eFuse 4 disable function.
efuse4_set_normal_mode
void efuse4_set_normal_mode(efuse4_t *ctx)
eFuse 4 set normal mode function.
efuse4_write_rdac
err_t efuse4_write_rdac(efuse4_t *ctx, uint16_t data_in)
eFuse 4 write RDAC function.
efuse4_t::i2c
i2c_master_t i2c
Definition: efuse4.h:150
efuse4_digi_pot_op_mode
err_t efuse4_digi_pot_op_mode(efuse4_t *ctx, uint8_t mode)
eFuse 4 set digital potentiometer operation mode function.
EFUSE4_CURRENT_LIMIT_750_mA
@ EFUSE4_CURRENT_LIMIT_750_mA
Definition: efuse4.h:194
efuse4_generic_write
err_t efuse4_generic_write(efuse4_t *ctx, uint8_t cmd, uint16_t data_in)
eFuse 4 I2C writing function.
efuse4_cfg_t::rst
pin_name_t rst
Definition: efuse4.h:167
efuse4_set_current_limit
err_t efuse4_set_current_limit(efuse4_t *ctx, efuse4_current_limit_t current_limit)
eFuse 4 set current limit function.
efuse4_return_value_t
efuse4_return_value_t
eFuse 4 Click return value data.
Definition: efuse4.h:181
EFUSE4_ERROR
@ EFUSE4_ERROR
Definition: efuse4.h:183
efuse4_default_cfg
err_t efuse4_default_cfg(efuse4_t *ctx)
eFuse 4 default configuration function.
efuse4_cfg_t::sda
pin_name_t sda
Definition: efuse4.h:164
efuse4_read_rdac
err_t efuse4_read_rdac(efuse4_t *ctx, uint16_t *data_out)
eFuse 4 read RDAC function.
efuse4_current_limit_t
efuse4_current_limit_t
eFuse 4 Click current limit value data.
Definition: efuse4.h:192
efuse4_sw_reset
err_t efuse4_sw_reset(efuse4_t *ctx)
eFuse 4 software reset function.
efuse4_cfg_t::pgd
pin_name_t pgd
Definition: efuse4.h:166
efuse4_t::dsv
digital_out_t dsv
Definition: efuse4.h:143
efuse4_generic_read
err_t efuse4_generic_read(efuse4_t *ctx, uint8_t cmd, uint16_t data_in, uint16_t *data_out)
eFuse 4 I2C reading function.
EFUSE4_CURRENT_LIMIT_5200_mA
@ EFUSE4_CURRENT_LIMIT_5200_mA
Definition: efuse4.h:199
efuse4_set_enable
void efuse4_set_enable(efuse4_t *ctx)
eFuse 4 enable function.
efuse4_read_memory
err_t efuse4_read_memory(efuse4_t *ctx, uint16_t *data_out)
eFuse 4 read memory function.
efuse4_t::flt
digital_in_t flt
Definition: efuse4.h:147
EFUSE4_OK
@ EFUSE4_OK
Definition: efuse4.h:182
efuse4_init
err_t efuse4_init(efuse4_t *ctx, efuse4_cfg_t *cfg)
eFuse 4 initialization function.
efuse4_cfg_t::flt
pin_name_t flt
Definition: efuse4.h:169
efuse4_set_digi_pot
err_t efuse4_set_digi_pot(efuse4_t *ctx, uint16_t wiper_pos)
eFuse 4 set digital potentiometer function.
efuse4_cfg_t::i2c_address
uint8_t i2c_address
Definition: efuse4.h:172
EFUSE4_CURRENT_LIMIT_4450_mA
@ EFUSE4_CURRENT_LIMIT_4450_mA
Definition: efuse4.h:198
efuse4_t
eFuse 4 Click context object.
Definition: efuse4.h:140
efuse4_set_resistance
err_t efuse4_set_resistance(efuse4_t *ctx, uint32_t res_ohm)
eFuse 4 set resistance function.
efuse4_cfg_t::dsv
pin_name_t dsv
Definition: efuse4.h:168
efuse4_cfg_setup
void efuse4_cfg_setup(efuse4_cfg_t *cfg)
eFuse 4 configuration object setup function.
EFUSE4_CURRENT_LIMIT_990_mA
@ EFUSE4_CURRENT_LIMIT_990_mA
Definition: efuse4.h:195
efuse4_t::pgd
digital_in_t pgd
Definition: efuse4.h:146
efuse4_cfg_t::scl
pin_name_t scl
Definition: efuse4.h:163
EFUSE4_CURRENT_LIMIT_3530_mA
@ EFUSE4_CURRENT_LIMIT_3530_mA
Definition: efuse4.h:197
efuse4_store_wiper_pos
err_t efuse4_store_wiper_pos(efuse4_t *ctx)
eFuse 4 store wiper function.
EFUSE4_CURRENT_LIMIT_2080_mA
@ EFUSE4_CURRENT_LIMIT_2080_mA
Definition: efuse4.h:196
efuse4_set_low_power_mode
void efuse4_set_low_power_mode(efuse4_t *ctx)
eFuse 4 set low power mode function.
efuse4_t::slave_address
uint8_t slave_address
Definition: efuse4.h:153
efuse4_t::rst
digital_out_t rst
Definition: efuse4.h:142