Skip to content

Commit 2964e96

Browse files
tannewttannewt
authored
Merge pull request adafruit#5958 from dhalbert/i2c-common-hal-write-read
I2c common hal write read
2 parents 0b26dba + d0453f4 commit 2964e96

15 files changed

Lines changed: 233 additions & 114 deletions

File tree

‎locale/circuitpython.pot‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ msgstr ""
9999
msgid "%q length must be %d-%d"
100100
msgstr ""
101101

102-
#: shared-bindings/usb_hid/Device.c
102+
#: shared-bindings/busio/I2C.c shared-bindings/usb_hid/Device.c
103103
msgid "%q length must be >= 1"
104104
msgstr ""
105105

@@ -631,7 +631,7 @@ msgstr ""
631631
msgid "Buffer must be a multiple of 512 bytes"
632632
msgstr ""
633633

634-
#: shared-bindings/bitbangio/I2C.c shared-bindings/busio/I2C.c
634+
#: shared-bindings/bitbangio/I2C.c
635635
msgid "Buffer must be at least length 1"
636636
msgstr ""
637637

@@ -1616,7 +1616,7 @@ msgstr ""
16161616

16171617
#: shared-module/adafruit_bus_device/i2c_device/I2CDevice.c
16181618
#, c-format
1619-
msgid "No I2C device at address: %x"
1619+
msgid "No I2C device at address: 0x%x"
16201620
msgstr ""
16211621

16221622
#: ports/espressif/common-hal/busio/SPI.c
@@ -4069,7 +4069,10 @@ msgstr ""
40694069
#: ports/espressif/boards/unexpectedmaker_feathers2/mpconfigboard.h
40704070
#: ports/espressif/boards/unexpectedmaker_feathers2_neo/mpconfigboard.h
40714071
#: ports/espressif/boards/unexpectedmaker_feathers2_prerelease/mpconfigboard.h
4072+
#: ports/espressif/boards/unexpectedmaker_feathers3/mpconfigboard.h
4073+
#: ports/espressif/boards/unexpectedmaker_pros3/mpconfigboard.h
40724074
#: ports/espressif/boards/unexpectedmaker_tinys2/mpconfigboard.h
4075+
#: ports/espressif/boards/unexpectedmaker_tinys3/mpconfigboard.h
40734076
msgid "pressing boot button at start up.\n"
40744077
msgstr ""
40754078

‎ports/atmel-samd/boards/sensebox_mcu/mpconfigboard.mk‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ CIRCUITPY_FULL_BUILD = 0
1313
# There are many pin definitions on this board; it doesn't quite fit on very large translations.
1414
# Remove a couple of modules.
1515
CIRCUITPY_ONEWIREIO = 0
16+
CIRCUITPY_RAINBOWIO = 0

‎ports/atmel-samd/common-hal/busio/I2C.c‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ void common_hal_busio_i2c_unlock(busio_i2c_obj_t *self) {
190190
self->has_lock = false;
191191
}
192192

193-
uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
193+
STATIC uint8_t _common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
194194
const uint8_t *data, size_t len, bool transmit_stop_bit) {
195195

196196
uint16_t attempts = ATTEMPTS;
@@ -216,6 +216,11 @@ uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
216216
return MP_EIO;
217217
}
218218

219+
uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
220+
const uint8_t *data, size_t len) {
221+
return _common_hal_busio_i2c_write(self, addr, data, len, true);
222+
}
223+
219224
uint8_t common_hal_busio_i2c_read(busio_i2c_obj_t *self, uint16_t addr,
220225
uint8_t *data, size_t len) {
221226

@@ -242,6 +247,16 @@ uint8_t common_hal_busio_i2c_read(busio_i2c_obj_t *self, uint16_t addr,
242247
return MP_EIO;
243248
}
244249

250+
uint8_t common_hal_busio_i2c_write_read(busio_i2c_obj_t *self, uint16_t addr,
251+
uint8_t *out_data, size_t out_len, uint8_t *in_data, size_t in_len) {
252+
uint8_t result = _common_hal_busio_i2c_write(self, addr, out_data, out_len, false);
253+
if (result != 0) {
254+
return result;
255+
}
256+
257+
return common_hal_busio_i2c_read(self, addr, in_data, in_len);
258+
}
259+
245260
void common_hal_busio_i2c_never_reset(busio_i2c_obj_t *self) {
246261
never_reset_sercom(self->i2c_desc.device.hw);
247262

‎ports/broadcom/common-hal/busio/I2C.c‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ void common_hal_busio_i2c_deinit(busio_i2c_obj_t *self) {
124124
}
125125

126126
bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {
127-
uint8_t result = common_hal_busio_i2c_write(self, addr, NULL, 0, true);
127+
uint8_t result = common_hal_busio_i2c_write(self, addr, NULL, 0);
128128
return result == 0;
129129
}
130130

@@ -147,7 +147,7 @@ void common_hal_busio_i2c_unlock(busio_i2c_obj_t *self) {
147147

148148
// Discussion of I2C implementation is here: https://github.com/raspberrypi/linux/issues/254
149149

150-
uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
150+
STATIC uint8_t _common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
151151
const uint8_t *data, size_t len, bool transmit_stop_bit) {
152152
COMPLETE_MEMORY_READS;
153153
self->peripheral->S_b.DONE = true;
@@ -202,6 +202,11 @@ uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
202202
return 0;
203203
}
204204

205+
uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
206+
const uint8_t *data, size_t len) {
207+
return _common_hal_busio_i2c_write(self, addr, data, len, true);
208+
}
209+
205210
uint8_t common_hal_busio_i2c_read(busio_i2c_obj_t *self, uint16_t addr,
206211
uint8_t *data, size_t len) {
207212
COMPLETE_MEMORY_READS;
@@ -247,6 +252,16 @@ uint8_t common_hal_busio_i2c_read(busio_i2c_obj_t *self, uint16_t addr,
247252
return 0;
248253
}
249254

255+
uint8_t common_hal_busio_i2c_write_read(busio_i2c_obj_t *self, uint16_t addr,
256+
uint8_t *out_data, size_t out_len, uint8_t *in_data, size_t in_len) {
257+
uint8_t result = _common_hal_busio_i2c_write(self, addr, out_data, out_len, false);
258+
if (result != 0) {
259+
return result;
260+
}
261+
262+
return common_hal_busio_i2c_read(self, addr, in_data, in_len);
263+
}
264+
250265
void common_hal_busio_i2c_never_reset(busio_i2c_obj_t *self) {
251266
never_reset_i2c[self->index] = true;
252267

‎ports/cxd56/common-hal/busio/I2C.c‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {
9797
return I2C_TRANSFER(self->i2c_dev, &msg, 1) < 0 ? false : true;
9898
}
9999

100-
uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t address, const uint8_t *data, size_t len, bool stop) {
100+
STATIC uint8_t _common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t address, const uint8_t *data, size_t len, bool stop) {
101101
struct i2c_msg_s msg;
102102

103103
msg.frequency = self->frequency;
@@ -108,6 +108,11 @@ uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t address, cons
108108
return -I2C_TRANSFER(self->i2c_dev, &msg, 1);
109109
}
110110

111+
uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
112+
const uint8_t *data, size_t len) {
113+
return _common_hal_busio_i2c_write(self, addr, data, len, true);
114+
}
115+
111116
uint8_t common_hal_busio_i2c_read(busio_i2c_obj_t *self, uint16_t address, uint8_t *data, size_t len) {
112117
struct i2c_msg_s msg;
113118

@@ -119,6 +124,16 @@ uint8_t common_hal_busio_i2c_read(busio_i2c_obj_t *self, uint16_t address, uint8
119124
return -I2C_TRANSFER(self->i2c_dev, &msg, 1);
120125
}
121126

127+
uint8_t common_hal_busio_i2c_write_read(busio_i2c_obj_t *self, uint16_t addr,
128+
uint8_t *out_data, size_t out_len, uint8_t *in_data, size_t in_len) {
129+
uint8_t result = _common_hal_busio_i2c_write(self, addr, out_data, out_len, false);
130+
if (result != 0) {
131+
return result;
132+
}
133+
134+
return common_hal_busio_i2c_read(self, addr, in_data, in_len);
135+
}
136+
122137
void common_hal_busio_i2c_never_reset(busio_i2c_obj_t *self) {
123138
never_reset_pin_number(self->scl_pin->number);
124139
never_reset_pin_number(self->sda_pin->number);

‎ports/espressif/common-hal/busio/I2C.c‎

Lines changed: 33 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -136,13 +136,19 @@ void common_hal_busio_i2c_deinit(busio_i2c_obj_t *self) {
136136
self->scl_pin = NULL;
137137
}
138138

139-
bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {
139+
static esp_err_t i2c_zero_length_write(busio_i2c_obj_t *self, uint8_t addr, TickType_t timeout) {
140+
// i2c_master_write_to_device() won't do zero-length writes, so we do it by hand.
140141
i2c_cmd_handle_t cmd = i2c_cmd_link_create();
141142
i2c_master_start(cmd);
142143
i2c_master_write_byte(cmd, addr << 1, true);
143144
i2c_master_stop(cmd);
144-
esp_err_t result = i2c_master_cmd_begin(self->i2c_num, cmd, 10);
145+
esp_err_t result = i2c_master_cmd_begin(self->i2c_num, cmd, timeout);
145146
i2c_cmd_link_delete(cmd);
147+
return result;
148+
}
149+
150+
bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {
151+
esp_err_t result = i2c_zero_length_write(self, addr, 1);
146152
return result == ESP_OK;
147153
}
148154

@@ -163,45 +169,36 @@ void common_hal_busio_i2c_unlock(busio_i2c_obj_t *self) {
163169
self->has_lock = false;
164170
}
165171

166-
uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
167-
const uint8_t *data, size_t len, bool transmit_stop_bit) {
168-
i2c_cmd_handle_t cmd = i2c_cmd_link_create();
169-
i2c_master_start(cmd);
170-
i2c_master_write_byte(cmd, addr << 1, true);
171-
i2c_master_write(cmd, (uint8_t *)data, len, true);
172-
if (transmit_stop_bit) {
173-
i2c_master_stop(cmd);
172+
static uint8_t convert_esp_err(esp_err_t result) {
173+
switch (result) {
174+
case ESP_OK:
175+
return 0;
176+
case ESP_FAIL:
177+
return MP_ENODEV;
178+
case ESP_ERR_TIMEOUT:
179+
return MP_ETIMEDOUT;
180+
default:
181+
return MP_EIO;
174182
}
175-
esp_err_t result = i2c_master_cmd_begin(self->i2c_num, cmd, 100 /* wait in ticks */);
176-
i2c_cmd_link_delete(cmd);
183+
}
177184

178-
if (result == ESP_OK) {
179-
return 0;
180-
} else if (result == ESP_FAIL) {
181-
return MP_ENODEV;
182-
}
183-
return MP_EIO;
185+
uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr, const uint8_t *data, size_t len) {
186+
return convert_esp_err(len == 0
187+
? i2c_zero_length_write(self, addr, 100)
188+
: i2c_master_write_to_device(self->i2c_num, (uint8_t)addr, data, len, 100 /* wait in ticks */)
189+
);
184190
}
185191

186-
uint8_t common_hal_busio_i2c_read(busio_i2c_obj_t *self, uint16_t addr,
187-
uint8_t *data, size_t len) {
188-
i2c_cmd_handle_t cmd = i2c_cmd_link_create();
189-
i2c_master_start(cmd);
190-
i2c_master_write_byte(cmd, addr << 1 | 1, true); // | 1 to indicate read
191-
if (len > 1) {
192-
i2c_master_read(cmd, data, len - 1, 0);
193-
}
194-
i2c_master_read_byte(cmd, data + len - 1, 1);
195-
i2c_master_stop(cmd);
196-
esp_err_t result = i2c_master_cmd_begin(self->i2c_num, cmd, 100 /* wait in ticks */);
197-
i2c_cmd_link_delete(cmd);
192+
uint8_t common_hal_busio_i2c_read(busio_i2c_obj_t *self, uint16_t addr, uint8_t *data, size_t len) {
193+
return convert_esp_err(
194+
i2c_master_read_from_device(self->i2c_num, (uint8_t)addr, data, len, 100 /* wait in ticks */));
195+
}
198196

199-
if (result == ESP_OK) {
200-
return 0;
201-
} else if (result == ESP_FAIL) {
202-
return MP_ENODEV;
203-
}
204-
return MP_EIO;
197+
uint8_t common_hal_busio_i2c_write_read(busio_i2c_obj_t *self, uint16_t addr,
198+
uint8_t *out_data, size_t out_len, uint8_t *in_data, size_t in_len) {
199+
return convert_esp_err(
200+
i2c_master_write_read_device(self->i2c_num, (uint8_t)addr,
201+
out_data, out_len, in_data, in_len, 100 /* wait in ticks */));
205202
}
206203

207204
void common_hal_busio_i2c_never_reset(busio_i2c_obj_t *self) {

‎ports/mimxrt10xx/common-hal/busio/I2C.c‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ void common_hal_busio_i2c_unlock(busio_i2c_obj_t *self) {
210210
self->has_lock = false;
211211
}
212212

213-
uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
213+
STATIC uint8_t _common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
214214
const uint8_t *data, size_t len, bool transmit_stop_bit) {
215215

216216
lpi2c_master_transfer_t xfer = { 0 };
@@ -227,6 +227,11 @@ uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
227227
return MP_EIO;
228228
}
229229

230+
uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
231+
const uint8_t *data, size_t len) {
232+
return _common_hal_busio_i2c_write(self, addr, data, len, true);
233+
}
234+
230235
uint8_t common_hal_busio_i2c_read(busio_i2c_obj_t *self, uint16_t addr,
231236
uint8_t *data, size_t len) {
232237

@@ -243,3 +248,13 @@ uint8_t common_hal_busio_i2c_read(busio_i2c_obj_t *self, uint16_t addr,
243248

244249
return MP_EIO;
245250
}
251+
252+
uint8_t common_hal_busio_i2c_write_read(busio_i2c_obj_t *self, uint16_t addr,
253+
uint8_t *out_data, size_t out_len, uint8_t *in_data, size_t in_len) {
254+
uint8_t result = _common_hal_busio_i2c_write(self, addr, out_data, out_len, false);
255+
if (result != 0) {
256+
return result;
257+
}
258+
259+
return common_hal_busio_i2c_read(self, addr, in_data, in_len);
260+
}

‎ports/nrf/common-hal/busio/I2C.c‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ void common_hal_busio_i2c_unlock(busio_i2c_obj_t *self) {
238238
self->has_lock = false;
239239
}
240240

241-
uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr, const uint8_t *data, size_t len, bool stopBit) {
241+
STATIC uint8_t _common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr, const uint8_t *data, size_t len, bool stopBit) {
242242
if (len == 0) {
243243
return common_hal_busio_i2c_probe(self, addr) ? 0 : MP_ENODEV;
244244
}
@@ -266,6 +266,10 @@ uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr, const u
266266
return twi_error_to_mp(err);
267267
}
268268

269+
uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr, const uint8_t *data, size_t len) {
270+
return _common_hal_busio_i2c_write(self, addr, data, len, true);
271+
}
272+
269273
uint8_t common_hal_busio_i2c_read(busio_i2c_obj_t *self, uint16_t addr, uint8_t *data, size_t len) {
270274
if (len == 0) {
271275
return 0;
@@ -292,3 +296,13 @@ uint8_t common_hal_busio_i2c_read(busio_i2c_obj_t *self, uint16_t addr, uint8_t
292296

293297
return twi_error_to_mp(err);
294298
}
299+
300+
uint8_t common_hal_busio_i2c_write_read(busio_i2c_obj_t *self, uint16_t addr,
301+
uint8_t *out_data, size_t out_len, uint8_t *in_data, size_t in_len) {
302+
uint8_t result = _common_hal_busio_i2c_write(self, addr, out_data, out_len, false);
303+
if (result != 0) {
304+
return result;
305+
}
306+
307+
return common_hal_busio_i2c_read(self, addr, in_data, in_len);
308+
}

‎ports/raspberrypi/common-hal/busio/I2C.c‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ void common_hal_busio_i2c_deinit(busio_i2c_obj_t *self) {
145145
}
146146

147147
bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {
148-
return common_hal_busio_i2c_write(self, addr, NULL, 0, true) == 0;
148+
return common_hal_busio_i2c_write(self, addr, NULL, 0) == 0;
149149
}
150150

151151
bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {
@@ -165,7 +165,7 @@ void common_hal_busio_i2c_unlock(busio_i2c_obj_t *self) {
165165
self->has_lock = false;
166166
}
167167

168-
uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
168+
STATIC uint8_t _common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
169169
const uint8_t *data, size_t len, bool transmit_stop_bit) {
170170
if (len == 0) {
171171
// The RP2040 I2C peripheral will not perform 0 byte writes.
@@ -203,6 +203,11 @@ uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
203203
}
204204
}
205205

206+
uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t addr,
207+
const uint8_t *data, size_t len) {
208+
return _common_hal_busio_i2c_write(self, addr, data, len, true);
209+
}
210+
206211
uint8_t common_hal_busio_i2c_read(busio_i2c_obj_t *self, uint16_t addr,
207212
uint8_t *data, size_t len) {
208213
int result = i2c_read_timeout_us(self->peripheral, addr, data, len, false, BUS_TIMEOUT_US);
@@ -219,6 +224,16 @@ uint8_t common_hal_busio_i2c_read(busio_i2c_obj_t *self, uint16_t addr,
219224
}
220225
}
221226

227+
uint8_t common_hal_busio_i2c_write_read(busio_i2c_obj_t *self, uint16_t addr,
228+
uint8_t *out_data, size_t out_len, uint8_t *in_data, size_t in_len) {
229+
uint8_t result = _common_hal_busio_i2c_write(self, addr, out_data, out_len, false);
230+
if (result != 0) {
231+
return result;
232+
}
233+
234+
return common_hal_busio_i2c_read(self, addr, in_data, in_len);
235+
}
236+
222237
void common_hal_busio_i2c_never_reset(busio_i2c_obj_t *self) {
223238
never_reset_i2c[i2c_hw_index(self->peripheral)] = true;
224239

0 commit comments

Comments
 (0)