source: trunk/firmware/SES/Drivers/INA233/ina233.h@ 6

Last change on this file since 6 was 1, checked in by f.jahn, 3 years ago
File size: 7.0 KB
Line 
1#ifndef __INA233_H_
2#define __INA233_H_
3
4#include <stdint.h>
5
6#define INA233_ALERT_RESPONSE_ADDRESS 0x0C // Alert response slave address (0001 100)
7#define INA233_ADDRESS 0x40 // A0 and A1 are connected to GND
8#define MAX_TX_COMMAND_LEN 3 // 2+1 Comments: See INA233 manual, "Supported PMBus Commands" table, column NUMBER OF DATA BYTES
9#define MAX_RX_COMMAND_LEN 7 // 6+1 Comments: See INA233 manual, "Supported PMBus Commands" table, column NUMBER OF DATA BYTES
10
11// Commands
12
13#define INA233_COMMAND_CLEAR_FAULTS 0x03
14#define INA233_COMMAND_CLEAR_FAULTS_TX_LEN 1
15
16#define INA233_COMMAND_MFR_ID 0x99
17#define INA233_COMMAND_MFR_ID_TX_LEN 1
18#define INA233_COMMAND_MFR_ID_RX_LEN (2+1) // See INA233 manual
19
20#define INA233_COMMAND_MFR_MODEL 0x9A
21#define INA233_COMMAND_MFR_MODEL_TX_LEN 1
22#define INA233_COMMAND_MFR_MODEL_RX_LEN (6+1) // See INA233 manual
23
24#define INA233_COMMAND_MFR_REVISION 0x9B
25#define INA233_COMMAND_MFR_REVISION_TX_LEN 1
26#define INA233_COMMAND_MFR_REVISION_RX_LEN (2+1) // See INA233 manual
27
28#define INA233_COMMAND_CAPABILITY 0x19
29#define INA233_COMMAND_CAPABILITY_TX_LEN 1
30#define INA233_COMMAND_CAPABILITY_RX_LEN (1+1) // See INA233 manual
31
32#define INA233_COMMAND_READ_VIN 0x88
33#define INA233_COMMAND_READ_VIN_TX_LEN 1
34#define INA233_COMMAND_READ_VIN_RX_LEN (2+1) // See INA233 manual
35
36#define INA233_COMMAND_READ_VSHUNT 0xD1
37#define INA233_COMMAND_READ_VSHUNT_TX_LEN 1
38#define INA233_COMMAND_READ_VSHUNT_RX_LEN (2+1) // See INA233 manual
39
40#define INA233_COMMAND_MFR_ALERT_MASK 0xD2
41#define INA233_COMMAND_MFR_ALERT_MASK_READ_TX_LEN 1
42#define INA233_COMMAND_MFR_ALERT_MASK_READ_RX_LEN (1+0) // See INA233 manual
43#define INA233_COMMAND_MFR_ALERT_MASK_WRITE_TX_LEN 2
44//#define INA233_COMMAND_MFR_ALERT_MASK_WRITE_RX_LEN (1+0) // See INA233 manual
45
46#define INA233_COMMAND_MFR_ADC_CONFIG 0xD0
47#define INA233_COMMAND_MFR_ADC_CONFIG_READ_TX_LEN 1
48#define INA233_COMMAND_MFR_ADC_CONFIG_READ_RX_LEN (2+1) // See INA233 manual
49#define INA233_COMMAND_MFR_ADC_CONFIG_WRITE_TX_LEN 3
50//#define INA233_COMMAND_MFR_ADC_CONFIG_WRITE_RX_LEN (2+1) // See INA233 manual
51
52#define INA233_COMMAND_MFR_DEVICE_CONFIG 0xD5
53#define INA233_COMMAND_MFR_DEVICE_CONFIG_READ_TX_LEN 1
54#define INA233_COMMAND_MFR_DEVICE_CONFIG_READ_RX_LEN 1
55#define INA233_COMMAND_MFR_DEVICE_CONFIG_WRITE_TX_LEN 2
56
57#define INA233_COMMAND_STATUS_MFR_SPECIFIC 0x80
58#define INA233_COMMAND_STATUS_MFR_SPECIFIC_READ_TX_LEN 1
59#define INA233_COMMAND_STATUS_MFR_SPECIFIC_READ_RX_LEN 1
60#define INA233_COMMAND_STATUS_MFR_SPECIFIC_WRITE_TX_LEN 2
61
62// Masks fields
63#define INA233_ALERT_MASK_ENABLE 1
64#define INA233_ALERT_MASK_DISABLE 0
65#define INA233_ALERT_MASK_CONVERSION_READY_POSITION 7
66#define INA233_ALERT_MASK_ADC_OVERFLOW_POSITION 6
67#define INA233_ALERT_MASK_POWER_ON_RESET_POSITION 5
68#define INA233_ALERT_MASK_COMM_ERROR_POSITION 4
69#define INA233_ALERT_MASK_OVERPOWER_POSITION 3
70#define INA233_ALERT_MASK_OVERCURRENT_POSITION 2
71#define INA233_ALERT_MASK_OVERVOLTAGE_POSITION 1
72#define INA233_ALERT_MASK_UNDERVOLTAGE_POSITION 0
73
74// ADC configuration fields
75
76#define INA233_ADC_CONFIG_MODE_POSITION 0 // MODE field position in the register
77#define INA233_ADC_CONFIG_MODE_POWER_DOWN_1 0 // Power-down (or shutdown)
78#define INA233_ADC_CONFIG_MODE_SHUNT_TRIGGERED 1 // Shunt voltage, triggered
79#define INA233_ADC_CONFIG_MODE_BUS_TRIGGERED 2 // Bus voltage, triggered
80#define INA233_ADC_CONFIG_MODE_SHUNT_BUS_TRIGGERED 3 // Shunt and bus, triggered
81#define INA233_ADC_CONFIG_MODE_POWER_DOWN_2 4 // Power-down (or shutdown)
82#define INA233_ADC_CONFIG_MODE_SHUNT_CONTINUOUS 5 // Shunt voltage, continuous
83#define INA233_ADC_CONFIG_MODE_BUS_CONTINUOUS 6 // Bus voltage, continuous
84#define INA233_ADC_CONFIG_MODE_SHUNT_BUS_CONTINUOUS 7 // Shunt and bus voltage, continuous (default)
85
86#define INA233_ADC_CONFIG_VSHCT_POSITION 3 // VSHCT field position in the register
87#define INA233_ADC_CONFIG_VSHCT_140_uS 0 // SHUNT voltage conversion time 140 µs
88#define INA233_ADC_CONFIG_VSHCT_204_uS 1 // SHUNT voltage conversion time 204 µs
89#define INA233_ADC_CONFIG_VSHCT_332_uS 2 // SHUNT voltage conversion time 332 µs
90#define INA233_ADC_CONFIG_VSHCT_588_uS 3 // SHUNT voltage conversion time 588 µs
91#define INA233_ADC_CONFIG_VSHCT_1_1_mS 4 // SHUNT voltage conversion time 1.1 ms (default)
92#define INA233_ADC_CONFIG_VSHCT_2_116_mS 5 // SHUNT voltage conversion time 2.116 ms
93#define INA233_ADC_CONFIG_VSHCT_4_156_mS 6 // SHUNT voltage conversion time 4.156 ms
94#define INA233_ADC_CONFIG_VSHCT_8_244_mS 7 // SHUNT voltage conversion time 8.244 ms
95
96#define INA233_ADC_CONFIG_VBUSCT_POSITION 6 // VBUSCT field position in the register
97#define INA233_ADC_CONFIG_VBUSCT_140_uS 0 // BUS voltage conversion time 140 µs
98#define INA233_ADC_CONFIG_VBUSCT_204_uS 1 // BUS voltage conversion time 204 µs
99#define INA233_ADC_CONFIG_VBUSCT_332_uS 2 // BUS voltage conversion time 332 µs
100#define INA233_ADC_CONFIG_VBUSCT_588_uS 3 // BUS voltage conversion time 588 µs
101#define INA233_ADC_CONFIG_VBUSCT_1_1_mS 4 // BUS voltage conversion time 1.1 ms (default)
102#define INA233_ADC_CONFIG_VBUSCT_2_116_mS 5 // BUS voltage conversion time 2.116 ms
103#define INA233_ADC_CONFIG_VBUSCT_4_156_mS 6 // BUS voltage conversion time 4.156 ms
104#define INA233_ADC_CONFIG_VBUSCT_8_244_mS 7 // BUS voltage conversion time 8.244 ms
105
106#define INA233_ADC_CONFIG_AVG_POSITION 9 // AVG field position in the register
107#define INA233_ADC_CONFIG_AVG_1 0 // Number of averages 1 (default)
108#define INA233_ADC_CONFIG_AVG_4 1 // Number of averages 4
109#define INA233_ADC_CONFIG_AVG_16 2 // Number of averages 16
110#define INA233_ADC_CONFIG_AVG_64 3 // Number of averages 64
111#define INA233_ADC_CONFIG_AVG_128 4 // Number of averages 128
112#define INA233_ADC_CONFIG_AVG_256 5 // Number of averages 256
113#define INA233_ADC_CONFIG_AVG_512 6 // Number of averages 512
114#define INA233_ADC_CONFIG_AVG_1024 7 // Number of averages 1024
115
116#define INA233_ADC_CONFIG_RESERVED_POSITION 12 // Reserved field position
117#define INA233_ADC_CONFIG_RESERVED_DEFAULT 4 // Reserved filed default value
118
119#define INA233_COMMAND_RESTORE_DEFAULT_ALL 0x12
120
121int INA233_GetRealVBUS(int16_t vbus_value);
122int INA233_Get_VSHUNT_uV(int16_t vshunt_value);
123
124#endif
Note: See TracBrowser for help on using the repository browser.