-
Notifications
You must be signed in to change notification settings - Fork 0
/
pca9555.c
308 lines (265 loc) · 11.4 KB
/
pca9555.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
// pca9555.c - Copyright (c) 2014-24 Andre M. Maree / KSS Technologies (Pty) Ltd.
#include "hal_platform.h"
#if (HAL_PCA9555 > 0)
#include "hal_i2c_common.h"
#include "x_errors_events.h"
#include "pca9555.h"
#include "printfx.h"
#include "syslog.h"
#include "systiming.h"
#define debugFLAG 0xF000
#define debugTIMING (debugFLAG_GLOBAL & debugFLAG & 0x1000)
#define debugTRACK (debugFLAG_GLOBAL & debugFLAG & 0x2000)
#define debugPARAM (debugFLAG_GLOBAL & debugFLAG & 0x4000)
#define debugRESULT (debugFLAG_GLOBAL & debugFLAG & 0x8000)
// ########################################## MACROS ###############################################
#define pca9555ADDR_LOW 0x20 // default with A2 A1 A0 all '0'
#define pca9555ADDR_HIGH 0x27
#define pca9555NUM_PINS 16
// ######################################## Enumerations ###########################################
enum { // Register index enumeration
pca9555_IN, // RO - INput status registers
pca9555_OUT, // WO - OUTput control registers
pca9555_POL, // WO - INput POLarity, 1=Inverted
pca9555_CFG, // Direction config 0=OUT 1=IN
pca9555_NUM,
};
// ######################################### Structures ############################################
typedef struct __attribute__((packed)) pca9555_s {
i2c_di_t * psI2C; // size = 4
union { // size = 8
u16_t Regs[pca9555_NUM];
struct __attribute__((packed)) {
u16_t Reg_IN;
u16_t Reg_OUT;
u16_t Reg_POL;
u16_t Reg_CFG;
};
};
bool f_Dirty;
} pca9555_t;
DUMB_STATIC_ASSERT(sizeof(pca9555_t) == 13);
// ######################################### Local variables #######################################
pca9555_t sPCA9555 = { 0 };
const char * const DS9555RegNames[] = { "Input", "Output", "PolInv", "Config" };
#if (buildPLTFRM == HW_AC01)
const u16_t pca9555Out = 0b0000000000000000; // all 0=OFF
const u16_t pca9555Pol = 0b0000000000000000; // all NON inverted
const u16_t pca9555Cfg = 0b0000000000000000; // all outputs
#endif
// ####################################### Local functions #########################################
static int pca9555ReadRegister(u8_t Reg) {
u8_t cChr = Reg << 1; // force to u16_t boundary 0/2/4/6
// Adding a delay of 0mS ensure that write & read operations are separately executed
return halI2C_Queue(sPCA9555.psI2C, i2cWDR_FB, &cChr, sizeof(cChr), (u8_t *) &sPCA9555.Regs[Reg], sizeof(u16_t), (i2cq_p1_t) NULL, (i2cq_p2_t) NULL);
}
static int pca9555WriteRegVal(u8_t Reg, u16_t Val) {
sPCA9555.Regs[Reg] = Val;
u8_t cBuf[3];
cBuf[0] = Reg << 1; // force to u16_t boundary 0 / 2 / 4 / 6
cBuf[1] = Val >> 8;
cBuf[2] = Val & 0xFF;
int iRV = halI2C_Queue(sPCA9555.psI2C, i2cW_FB, cBuf, sizeof(cBuf), (u8_t *) NULL, 0, (i2cq_p1_t) NULL, (i2cq_p2_t) NULL);
if (iRV == erSUCCESS && Reg == pca9555_OUT)
sPCA9555.f_Dirty = 0; // show as clean, just written
return iRV;
}
void pca9555Reset(void) {
pca9555WriteRegVal(pca9555_CFG, pca9555Cfg);
pca9555WriteRegVal(pca9555_POL, pca9555Pol);
pca9555WriteRegVal(pca9555_OUT, pca9555Out);
}
// ###################################### Global functions #########################################
void pca9555DIG_IN_Config(u8_t pin) {
IF_myASSERT(debugPARAM, pin < pca9555NUM_PINS);
if (buildPLTFRM == HW_AC01 && anySYSFLAGS(hwAC00) && pin < 8)
pin = 7 - pin; // AC01 pins 0->7 map to 7->0 on AC00
pca9555WriteRegVal(pca9555_CFG, sPCA9555.Regs[pca9555_CFG] | (1 << pin)); // 1 = Input
}
u8_t pca9555DIG_IN_GetState(u8_t pin) {
IF_myASSERT(debugPARAM, pin < pca9555NUM_PINS);
// Ensure we are reading an input pin
if (buildPLTFRM == HW_AC01 && anySYSFLAGS(hwAC00) && pin < 8)
pin = 7 - pin; // AC01 pins 0->7 map to 7->0 on AC00
IF_myASSERT(debugTRACK, (sPCA9555.Regs[pca9555_CFG] & (0x0001 << pin)) == 1);
int iRV = pca9555ReadRegister(pca9555_IN);
if (iRV == erSUCCESS)
return (sPCA9555.Regs[pca9555_IN] & (0x0001 << pin)) ? 1 : 0;
xSyslogError(__FUNCTION__, iRV);
return 0;
}
void pca9555DIG_IN_Invert(u8_t pin) {
IF_myASSERT(debugPARAM, pin < pca9555NUM_PINS);
if (buildPLTFRM == HW_AC01 && anySYSFLAGS(hwAC00) && pin < 8) pin = 7 - pin; // AC01 pins 0->7 map to 7->0 on AC00
IF_myASSERT(debugTRACK, (sPCA9555.Regs[pca9555_CFG] & (1U << pin)) == 1); // ensure INPUT pin
pca9555WriteRegVal(pca9555_POL, sPCA9555.Regs[pca9555_POL] ^ (1U << pin));
}
void pca9555DIG_OUT_Config(u8_t pin) {
IF_myASSERT(debugPARAM, pin < pca9555NUM_PINS);
if (buildPLTFRM == HW_AC01 && anySYSFLAGS(hwAC00) && pin < 8) pin = 7 - pin; // AC01 pins 0->7 map to 7->0 on AC00
pca9555WriteRegVal(pca9555_CFG, sPCA9555.Regs[pca9555_CFG] & ~(1U << pin));
}
void pca9555DIG_OUT_SetStateLazy(u8_t pin, u8_t NewState) {
IF_myASSERT(debugPARAM, pin < pca9555NUM_PINS);
if (buildPLTFRM == HW_AC01 && anySYSFLAGS(hwAC00) && pin < 8) pin = 7 - pin; // AC01 pins 0->7 map to 7->0 on AC00
IF_myASSERT(debugPARAM, (sPCA9555.Regs[pca9555_CFG] & (1 << pin)) == 0);
u8_t CurState = (sPCA9555.Regs[pca9555_OUT] & (1U << pin)) ? 1 : 0;
if (NewState != CurState) {
if (NewState == 1)
sPCA9555.Regs[pca9555_OUT] |= (1U << pin); // set to 1
else
sPCA9555.Regs[pca9555_OUT] &= ~(1U << pin); // clear to 0
sPCA9555.f_Dirty = 1; // bit just changed, show as dirty
}
}
void pca9555DIG_OUT_SetState(u8_t pin, u8_t NewState) {
pca9555DIG_OUT_SetStateLazy(pin, NewState);
if (sPCA9555.f_Dirty)
pca9555WriteRegVal(pca9555_OUT, sPCA9555.Regs[pca9555_OUT]);
}
int pca9555DIG_OUT_WriteAll(void) {
if (sPCA9555.f_Dirty) {
pca9555WriteRegVal(pca9555_OUT, sPCA9555.Regs[pca9555_OUT]);
return 1;
}
return 0;
}
int pca9555DIG_OUT_GetState(u8_t pin) {
if (buildPLTFRM == HW_AC01 && anySYSFLAGS(hwAC00) && pin < 8) pin = 7 - pin; // AC01 pins 0->7 map to 7->0 on AC00
IF_myASSERT(debugPARAM, pin < pca9555NUM_PINS && (sPCA9555.Regs[pca9555_CFG] & (1 << pin)) == 0);
return (sPCA9555.Regs[pca9555_OUT] & (1 << pin)) ? 1 : 0;
}
void pca9555DIG_OUT_Toggle(u8_t pin) {
if (buildPLTFRM == HW_AC01 && anySYSFLAGS(hwAC00) && pin < 8) pin = 7 - pin; // AC01 pins 0->7 map to 7->0 on AC00
IF_myASSERT(debugPARAM, (pin < pca9555NUM_PINS) && (sPCA9555.Regs[pca9555_CFG] & (0x0001 << pin)) == 0);
pca9555WriteRegVal(pca9555_OUT, sPCA9555.Regs[pca9555_OUT] ^ (1U << pin));
}
// ################################## Diagnostics functions ########################################
// Due to an induced reverse voltage cause by the collapsing magnetic field of the solenoid in the
// door striker or water valve it can cause the I2C bus to "hang". In order to resolve this we need
// to check that the PCA9555 can be read and that the value read back corresponds
// with the last value written. If not, FSM of I2C peripheral on the ESP32 must be reset completely
#define pcaCHECK_INTERVAL 2
u32_t pcaSuccessCount, pcaResetCount, pcaCheckInterval;
int pca9555Check(void) {
++pcaCheckInterval;
if ((pcaCheckInterval % pcaCHECK_INTERVAL) == 0)
return 0;
pca9555ReadRegister(pca9555_IN); // Time to do a check
u16_t RegInInv = sPCA9555.Reg_IN;
#if (buildPLTFRM == HW_AC01)
RegInInv = (RegInInv >> 8) | (RegInInv << 8);
#endif
if (RegInInv == sPCA9555.Reg_OUT) {
++pcaSuccessCount; // all OK, no reset required...
return 0;
}
++pcaResetCount;
u16_t ErrorBits = RegInInv ^ sPCA9555.Reg_OUT; // Determine bits that are wrong
SL_ERR("Rin=x%04X Rout=x%04X Error=x%04X (OK=%lu Err=%lu)", RegInInv,
sPCA9555.Reg_OUT, ErrorBits, pcaSuccessCount, pcaResetCount);
// general reset, reconfigure and start again...
++sPCA9555.psI2C->CFGerr;
halI2C_ErrorHandler(sPCA9555.psI2C,__FUNCTION__, ESP_ERR_INVALID_STATE); // error code chosen to force FSM reset
return 1;
}
#define pca9555TEST_INTERVAL 300
int pca9555Identify(i2c_di_t * psI2C) {
sPCA9555.psI2C = psI2C;
psI2C->Type = i2cDEV_PCA9555;
psI2C->Speed = i2cSPEED_400;
psI2C->TObus = 25;
psI2C->Test = 1;
// Step 1 - ensure all set to defaults
int iRV = pca9555WriteRegVal(pca9555_POL, 0); // default non inverted/normal
if (iRV < erSUCCESS)
return iRV;
iRV = pca9555WriteRegVal(pca9555_CFG, 0xFFFF); // default all Inputs
if (iRV < erSUCCESS)
return iRV;
// Step 2 - read all registers
for (int r = pca9555_IN; r < pca9555_NUM; ++r) {
iRV = pca9555ReadRegister(r);
if (iRV < erSUCCESS) {
return iRV;
}
}
// Step 3 - Check initial default values
if (sPCA9555.Regs[pca9555_POL] != 0 || sPCA9555.Regs[pca9555_CFG] != 0xFFFF)
return erINV_WHOAMI;
u16_t OrigOUT = sPCA9555.Regs[pca9555_OUT]; // passed phase 1, now step 4
pca9555WriteRegVal(pca9555_CFG, 0); // all OUTputs
pca9555ReadRegister(pca9555_OUT);
if (sPCA9555.Regs[pca9555_OUT] != OrigOUT)
return erINV_WHOAMI;
psI2C->IDok = 1;
psI2C->Test = 0;
return iRV;
}
int pca9555Config(i2c_di_t * psI2C) {
if (!psI2C->IDok)
return erINV_STATE;
psI2C->CFGok = 0;
xRtosClearDevice(devMASK_PCA9555);
int iRV = pca9555WriteRegVal(pca9555_CFG, pca9555Cfg); // IN vs OUT
if (iRV < erSUCCESS)
return iRV;
iRV = pca9555WriteRegVal(pca9555_POL, pca9555Pol); // Non Invert
if (iRV < erSUCCESS)
return iRV;
iRV = pca9555WriteRegVal(pca9555_OUT, pca9555Out); // All OUTputs
if (iRV < erSUCCESS)
return iRV;
psI2C->CFGok = 1;
xRtosSetDevice(devMASK_PCA9555);
// once off init....
if (!psI2C->CFGerr)
IF_SYSTIMER_INIT(debugTIMING, stPCA9555, stMICROS, "PCA9555", 200, 3200);
return iRV;
}
int pca9555Diagnostics(i2c_di_t * psI2C) {
// configure as outputs and display
wprintfx(NULL, "Default (all Outputs )status\r\n");
pca9555WriteRegVal(pca9555_CFG, 0x0000);
vTaskDelay(pdMS_TO_TICKS(pca9555TEST_INTERVAL));
// set all OFF and display
wprintfx(NULL, "All outputs (OFF) status\r\n");
pca9555WriteRegVal(pca9555_OUT, 0x0000);
vTaskDelay(pdMS_TO_TICKS(pca9555TEST_INTERVAL));
// set all ON and display
wprintfx(NULL, "All outputs (ON) status\r\n");
pca9555WriteRegVal(pca9555_OUT, 0xFFFF);
vTaskDelay(pdMS_TO_TICKS(pca9555TEST_INTERVAL));
// set all OFF and display
wprintfx(NULL, "All outputs (OFF) status\r\n");
pca9555WriteRegVal(pca9555_OUT, 0x0000);
vTaskDelay(pdMS_TO_TICKS(pca9555TEST_INTERVAL));
// set all back to inputs and display
wprintfx(NULL, "All Inputs (again) status\r\n");
pca9555WriteRegVal(pca9555_CFG, 0xFFFF);
vTaskDelay(pdMS_TO_TICKS(pca9555TEST_INTERVAL));
// Change INput to OUTput(0) and turn ON(1)
wprintfx(NULL, "Config as Outputs 1 by 1, switch ON using SetState\r\n");
for (u8_t pin = 0; pin < pca9555NUM_PINS; pin++) {
pca9555DIG_OUT_Config(pin); // default to OFF (0) after config
pca9555DIG_OUT_SetState(pin, 1);
vTaskDelay(pdMS_TO_TICKS(pca9555TEST_INTERVAL));
}
// then switch them OFF 1 by 1 using TOGGLE functionality
wprintfx(NULL, "Switch OFF 1 by 1 using TOGGLE\r\n");
for (u8_t pin = 0; pin < pca9555NUM_PINS; ++pin) {
pca9555DIG_OUT_Toggle(pin);
vTaskDelay(pdMS_TO_TICKS(pca9555TEST_INTERVAL));
}
pca9555Reset();
wprintfx(NULL, "Diagnostics completed. All LEDs = OFF !!!\r\n");
return erSUCCESS;
}
int pca9555Report(report_t * psR) {
int iRV = halI2C_DeviceReport(psR, (void *) sPCA9555.psI2C);
iRV += wprintfx(psR, "Inp=0x%04hX Out=0x%04hX Pol=0x%04hX Cfg=0x%04hx OK=%lu Fail=%lu\r\n\n",
sPCA9555.Regs[pca9555_IN], sPCA9555.Regs[pca9555_OUT], sPCA9555.Regs[pca9555_POL],
sPCA9555.Regs[pca9555_CFG], pcaSuccessCount, pcaResetCount);
return iRV;
}
#endif