Merge pull request #6721 from dhalbert/i2c-target

Change I2C terminology from "peripheral" to "target"

Author: dhalbert

docs/porting.rst

@@ -71,7 +71,7 @@ as a natural "TODO" list. An example minimal build list is shown below:
     CIRCUITPY_SDCARDIO = 0
     CIRCUITPY_FRAMEBUFFERIO = 0
     CIRCUITPY_FREQUENCYIO = 0
-    CIRCUITPY_I2CPERIPHERAL = 0
+    CIRCUITPY_I2CTARGET = 0
     # Requires SPI, PulseIO (stub ok):
     CIRCUITPY_DISPLAYIO = 0
 

locale/circuitpython.pot

@@ -398,12 +398,14 @@ msgstr ""
 msgid "All CAN peripherals are in use"
 msgstr ""
 
-#: ports/espressif/common-hal/busio/I2C.c
-#: ports/espressif/common-hal/i2cperipheral/I2CPeripheral.c
-#: ports/nrf/common-hal/busio/I2C.c
+#: ports/espressif/common-hal/busio/I2C.c ports/nrf/common-hal/busio/I2C.c
 msgid "All I2C peripherals are in use"
 msgstr ""
 
+#: ports/espressif/common-hal/i2ctarget/I2CTarget.c
+msgid "All I2C targets are in use"
+msgstr ""
+
 #: ports/espressif/common-hal/countio/Counter.c
 #: ports/espressif/common-hal/frequencyio/FrequencyIn.c
 #: ports/espressif/common-hal/rotaryio/IncrementalEncoder.c
@@ -1589,7 +1591,7 @@ msgstr ""
 msgid "Only one TouchAlarm can be set in deep sleep."
 msgstr ""
 
-#: ports/espressif/common-hal/i2cperipheral/I2CPeripheral.c
+#: ports/espressif/common-hal/i2ctarget/I2CTarget.c
 msgid "Only one address is allowed"
 msgstr ""
 
@@ -2319,11 +2321,11 @@ msgstr ""
 msgid "a bytes-like object is required"
 msgstr ""
 
-#: shared-bindings/i2cperipheral/I2CPeripheral.c
+#: shared-bindings/i2ctarget/I2CTarget.c
 msgid "address out of bounds"
 msgstr ""
 
-#: shared-bindings/i2cperipheral/I2CPeripheral.c
+#: shared-bindings/i2ctarget/I2CTarget.c
 msgid "addresses is empty"
 msgstr ""
 
@@ -2515,7 +2517,7 @@ msgstr ""
 msgid "can't cancel self"
 msgstr ""
 
-#: py/obj.c py/objint.c shared-bindings/i2cperipheral/I2CPeripheral.c
+#: py/obj.c py/objint.c shared-bindings/i2ctarget/I2CTarget.c
 #: shared-module/adafruit_pixelbuf/PixelBuf.c
 msgid "can't convert %q to %q"
 msgstr ""

ports/atmel-samd/boards/pewpew_lcd/mpconfigboard.mk

@@ -33,7 +33,7 @@ CIRCUITPY_BLEIO = 0
 CIRCUITPY_BUSDEVICE = 0
 CIRCUITPY_FRAMEBUFFERIO = 0
 CIRCUITPY_FREQUENCYIO = 0
-CIRCUITPY_I2CPERIPHERAL = 0
+CIRCUITPY_I2CTARGET = 0
 CIRCUITPY_MSGPACK = 0
 CIRCUITPY_NEOPIXEL_WRITE = 0
 CIRCUITPY_NVM = 0

ports/atmel-samd/boards/pewpew_m4/mpconfigboard.mk

@@ -18,7 +18,7 @@ CIRCUITPY_AUDIOPWMIO = 0
 CIRCUITPY_BITBANGIO = 0
 CIRCUITPY_BITBANG_APA102 = 0
 CIRCUITPY_FREQUENCYIO = 0
-CIRCUITPY_I2CPERIPHERAL = 0
+CIRCUITPY_I2CTARGET = 0
 CIRCUITPY_NEOPIXEL_WRITE = 0
 CIRCUITPY_PARALLELDISPLAY = 0
 CIRCUITPY_PIXELBUF = 0

ports/atmel-samd/boards/ugame10/mpconfigboard.mk

@@ -22,7 +22,7 @@ CIRCUITPY_AUDIOBUSIO = 0
 CIRCUITPY_BITBANGIO = 0
 CIRCUITPY_BITMAPTOOLS = 0
 CIRCUITPY_FREQUENCYIO = 0
-CIRCUITPY_I2CPERIPHERAL = 0
+CIRCUITPY_I2CTARGET = 0
 CIRCUITPY_NEOPIXEL_WRITE = 0
 CIRCUITPY_PARALLELDISPLAY = 0
 CIRCUITPY_PIXELBUF = 0

ports/atmel-samd/boards/winterbloom_big_honking_button/mpconfigboard.mk

@@ -23,7 +23,7 @@ CIRCUITPY_AUDIOBUSIO = 0
 CIRCUITPY_BLEIO = 0
 CIRCUITPY_DISPLAYIO = 0
 CIRCUITPY_KEYPAD = 0
-CIRCUITPY_I2CPERIPHERAL = 0
+CIRCUITPY_I2CTARGET = 0
 CIRCUITPY_TOUCHIO = 0
 CIRCUITPY_RGBMATRIX = 0
 CIRCUITPY_PS2IO = 0

ports/atmel-samd/boards/winterbloom_sol/mpconfigboard.mk

@@ -22,7 +22,7 @@ CIRCUITPY_BLEIO_HCI = 0
 CIRCUITPY_DISPLAYIO = 0
 CIRCUITPY_FRAMEBUFFERIO = 0
 CIRCUITPY_KEYPAD = 0
-CIRCUITPY_I2CPERIPHERAL = 0
+CIRCUITPY_I2CTARGET = 0
 CIRCUITPY_TOUCHIO = 0
 CIRCUITPY_RGBMATRIX = 0
 CIRCUITPY_PS2IO = 0

ports/atmel-samd/common-hal/i2cperipheral/__init__.c

@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "shared-bindings/i2cperipheral/I2CPeripheral.h"
+#include "shared-bindings/i2ctarget/I2CTarget.h"
 #include "shared-bindings/microcontroller/Pin.h"
 #include "common-hal/busio/I2C.h"
 
@@ -36,7 +36,7 @@
 #include "hal/include/hal_gpio.h"
 #include "peripherals/samd/sercom.h"
 
-void common_hal_i2cperipheral_i2c_peripheral_construct(i2cperipheral_i2c_peripheral_obj_t *self,
+void common_hal_i2ctarget_i2c_target_construct(i2ctarget_i2c_target_obj_t *self,
     const mcu_pin_obj_t *scl, const mcu_pin_obj_t *sda,
     uint8_t *addresses, unsigned int num_addresses, bool smbus) {
     uint8_t sercom_index;
@@ -100,12 +100,12 @@ void common_hal_i2cperipheral_i2c_peripheral_construct(i2cperipheral_i2c_periphe
     sercom->I2CS.CTRLA.bit.ENABLE = 1;
 }
 
-bool common_hal_i2cperipheral_i2c_peripheral_deinited(i2cperipheral_i2c_peripheral_obj_t *self) {
+bool common_hal_i2ctarget_i2c_target_deinited(i2ctarget_i2c_target_obj_t *self) {
     return self->sda_pin == NO_PIN;
 }
 
-void common_hal_i2cperipheral_i2c_peripheral_deinit(i2cperipheral_i2c_peripheral_obj_t *self) {
-    if (common_hal_i2cperipheral_i2c_peripheral_deinited(self)) {
+void common_hal_i2ctarget_i2c_target_deinit(i2ctarget_i2c_target_obj_t *self) {
+    if (common_hal_i2ctarget_i2c_target_deinited(self)) {
         return;
     }
 
@@ -117,7 +117,7 @@ void common_hal_i2cperipheral_i2c_peripheral_deinit(i2cperipheral_i2c_peripheral
     self->scl_pin = NO_PIN;
 }
 
-static int i2c_peripheral_check_error(i2cperipheral_i2c_peripheral_obj_t *self, bool raise) {
+static int i2c_target_check_error(i2ctarget_i2c_target_obj_t *self, bool raise) {
     if (!self->sercom->I2CS.INTFLAG.bit.ERROR) {
         return 0;
     }
@@ -136,8 +136,8 @@ static int i2c_peripheral_check_error(i2cperipheral_i2c_peripheral_obj_t *self,
     return -err;
 }
 
-int common_hal_i2cperipheral_i2c_peripheral_is_addressed(i2cperipheral_i2c_peripheral_obj_t *self, uint8_t *address, bool *is_read, bool *is_restart) {
-    int err = i2c_peripheral_check_error(self, false);
+int common_hal_i2ctarget_i2c_target_is_addressed(i2ctarget_i2c_target_obj_t *self, uint8_t *address, bool *is_read, bool *is_restart) {
+    int err = i2c_target_check_error(self, false);
     if (err) {
         return err;
     }
@@ -154,22 +154,22 @@ int common_hal_i2cperipheral_i2c_peripheral_is_addressed(i2cperipheral_i2c_perip
 
     for (unsigned int i = 0; i < self->num_addresses; i++) {
         if (*address == self->addresses[i]) {
-            common_hal_i2cperipheral_i2c_peripheral_ack(self, true);
+            common_hal_i2ctarget_i2c_target_ack(self, true);
             return 1;
         }
     }
 
     // This should clear AMATCH, but it doesn't...
-    common_hal_i2cperipheral_i2c_peripheral_ack(self, false);
+    common_hal_i2ctarget_i2c_target_ack(self, false);
     return 0;
 }
 
-int common_hal_i2cperipheral_i2c_peripheral_read_byte(i2cperipheral_i2c_peripheral_obj_t *self, uint8_t *data) {
+int common_hal_i2ctarget_i2c_target_read_byte(i2ctarget_i2c_target_obj_t *self, uint8_t *data) {
     for (int t = 0; t < 100 && !self->sercom->I2CS.INTFLAG.reg; t++) {
         mp_hal_delay_us(10);
     }
 
-    i2c_peripheral_check_error(self, true);
+    i2c_target_check_error(self, true);
 
     if (!self->sercom->I2CS.INTFLAG.bit.DRDY ||
         self->sercom->I2CS.INTFLAG.bit.PREC ||
@@ -181,12 +181,12 @@ int common_hal_i2cperipheral_i2c_peripheral_read_byte(i2cperipheral_i2c_peripher
     return 1;
 }
 
-int common_hal_i2cperipheral_i2c_peripheral_write_byte(i2cperipheral_i2c_peripheral_obj_t *self, uint8_t data) {
+int common_hal_i2ctarget_i2c_target_write_byte(i2ctarget_i2c_target_obj_t *self, uint8_t data) {
     for (int t = 0; !self->sercom->I2CS.INTFLAG.reg && t < 100; t++) {
         mp_hal_delay_us(10);
     }
 
-    i2c_peripheral_check_error(self, true);
+    i2c_target_check_error(self, true);
 
     if (self->sercom->I2CS.INTFLAG.bit.PREC) {
         return 0;
@@ -208,12 +208,12 @@ int common_hal_i2cperipheral_i2c_peripheral_write_byte(i2cperipheral_i2c_periphe
     return 1;
 }
 
-void common_hal_i2cperipheral_i2c_peripheral_ack(i2cperipheral_i2c_peripheral_obj_t *self, bool ack) {
+void common_hal_i2ctarget_i2c_target_ack(i2ctarget_i2c_target_obj_t *self, bool ack) {
     self->sercom->I2CS.CTRLB.bit.ACKACT = !ack;
     self->sercom->I2CS.CTRLB.bit.CMD = 0x03;
 }
 
-void common_hal_i2cperipheral_i2c_peripheral_close(i2cperipheral_i2c_peripheral_obj_t *self) {
+void common_hal_i2ctarget_i2c_target_close(i2ctarget_i2c_target_obj_t *self) {
     for (int t = 0; !self->sercom->I2CS.INTFLAG.reg && t < 100; t++) {
         mp_hal_delay_us(10);
     }
@@ -223,7 +223,7 @@ void common_hal_i2cperipheral_i2c_peripheral_close(i2cperipheral_i2c_peripheral_
     }
 
     if (!self->sercom->I2CS.STATUS.bit.DIR) {
-        common_hal_i2cperipheral_i2c_peripheral_ack(self, false);
+        common_hal_i2ctarget_i2c_target_ack(self, false);
     } else {
         int i = 0;
         while (self->sercom->I2CS.INTFLAG.reg == SERCOM_I2CS_INTFLAG_DRDY) {

ports/atmel-samd/common-hal/i2cperipheral/I2CPeripheral.c renamed to ports/atmel-samd/common-hal/i2ctarget/I2CTarget.c

@@ -24,8 +24,8 @@
  * THE SOFTWARE.
  */
 
-#ifndef MICROPY_INCLUDED_ATMEL_SAMD_COMMON_HAL_BUSIO_I2C_PERIPHERAL_H
-#define MICROPY_INCLUDED_ATMEL_SAMD_COMMON_HAL_BUSIO_I2C_PERIPHERAL_H
+#ifndef MICROPY_INCLUDED_ATMEL_SAMD_COMMON_HAL_BUSIO_I2C_TARGET_H
+#define MICROPY_INCLUDED_ATMEL_SAMD_COMMON_HAL_BUSIO_I2C_TARGET_H
 
 #include "common-hal/microcontroller/Pin.h"
 #include "py/obj.h"
@@ -40,6 +40,6 @@ typedef struct {
     uint8_t scl_pin;
     uint8_t sda_pin;
     bool writing;
-} i2cperipheral_i2c_peripheral_obj_t;
+} i2ctarget_i2c_target_obj_t;
 
-#endif // MICROPY_INCLUDED_ATMEL_SAMD_COMMON_HAL_BUSIO_I2C_PERIPHERAL_H
+#endif // MICROPY_INCLUDED_ATMEL_SAMD_COMMON_HAL_BUSIO_I2C_TARGET_H

ports/atmel-samd/common-hal/i2cperipheral/I2CPeripheral.h renamed to ports/atmel-samd/common-hal/i2ctarget/I2CTarget.h

@@ -0,0 +1 @@
+// No i2ctarget module functions.

ports/atmel-samd/common-hal/i2ctarget/__init__.c

@@ -38,7 +38,7 @@ CIRCUITPY_FRAMEBUFFERIO ?= 0
 CIRCUITPY_FREQUENCYIO ?= 0
 CIRCUITPY_GETPASS ?= 0
 CIRCUITPY_GIFIO ?= 0
-CIRCUITPY_I2CPERIPHERAL ?= 0
+CIRCUITPY_I2CTARGET ?= 0
 CIRCUITPY_JSON ?= 0
 CIRCUITPY_KEYPAD ?= 0
 CIRCUITPY_MSGPACK ?= 0

ports/atmel-samd/mpconfigport.mk

@@ -9,7 +9,7 @@ CIRCUITPY_AUDIOBUSIO = 0
 CIRCUITPY_AUDIOIO = 0
 CIRCUITPY_COUNTIO = 0
 CIRCUITPY_FREQUENCYIO = 0
-CIRCUITPY_I2CPERIPHERAL = 0
+CIRCUITPY_I2CTARGET = 0
 CIRCUITPY_NVM = 0
 CIRCUITPY_PARALLELDISPLAY = 0
 CIRCUITPY_PULSEIO = 0

ports/broadcom/mpconfigport.mk

@@ -15,7 +15,7 @@ CIRCUITPY_COUNTIO = 0
 CIRCUITPY_DISPLAYIO = 0
 CIRCUITPY_FREQUENCYIO = 0
 CIRCUITPY_GNSS = 1
-CIRCUITPY_I2CPERIPHERAL = 0
+CIRCUITPY_I2CTARGET = 0
 CIRCUITPY_KEYPAD = 0
 CIRCUITPY_NEOPIXEL_WRITE = 0
 CIRCUITPY_NVM = 0

ports/cxd56/mpconfigport.mk

@@ -24,15 +24,15 @@
  * THE SOFTWARE.
  */
 
-#include "shared-bindings/i2cperipheral/I2CPeripheral.h"
+#include "shared-bindings/i2ctarget/I2CTarget.h"
 
 #include "py/mperrno.h"
 #include "py/runtime.h"
 
-#include "common-hal/i2cperipheral/I2CPeripheral.h"
+#include "common-hal/i2ctarget/I2CTarget.h"
 #include "shared-bindings/microcontroller/Pin.h"
 
-void common_hal_i2cperipheral_i2c_peripheral_construct(i2cperipheral_i2c_peripheral_obj_t *self,
+void common_hal_i2ctarget_i2c_target_construct(i2ctarget_i2c_target_obj_t *self,
     const mcu_pin_obj_t *scl, const mcu_pin_obj_t *sda,
     uint8_t *addresses, unsigned int num_addresses, bool smbus) {
     // Pins 45 and 46 are "strapping" pins that impact start up behavior. They usually need to
@@ -54,7 +54,7 @@ void common_hal_i2cperipheral_i2c_peripheral_construct(i2cperipheral_i2c_periphe
     self->i2c_num = peripherals_i2c_get_free_num();
 
     if (self->i2c_num == I2C_NUM_MAX) {
-        mp_raise_ValueError(translate("All I2C peripherals are in use"));
+        mp_raise_ValueError(translate("All I2C targets are in use"));
     }
 
     const i2c_config_t i2c_conf = {
@@ -73,20 +73,20 @@ void common_hal_i2cperipheral_i2c_peripheral_construct(i2cperipheral_i2c_periphe
         if (err == ESP_FAIL) {
             mp_raise_OSError(MP_EIO);
         } else {
-            mp_arg_error_invalid(MP_QSTR_I2CPeripheral);
+            mp_arg_error_invalid(MP_QSTR_I2CTarget);
         }
     }
 
     claim_pin(sda);
     claim_pin(scl);
 }
 
-bool common_hal_i2cperipheral_i2c_peripheral_deinited(i2cperipheral_i2c_peripheral_obj_t *self) {
+bool common_hal_i2ctarget_i2c_target_deinited(i2ctarget_i2c_target_obj_t *self) {
     return self->sda_pin == NULL;
 }
 
-void common_hal_i2cperipheral_i2c_peripheral_deinit(i2cperipheral_i2c_peripheral_obj_t *self) {
-    if (common_hal_i2cperipheral_i2c_peripheral_deinited(self)) {
+void common_hal_i2ctarget_i2c_target_deinit(i2ctarget_i2c_target_obj_t *self) {
+    if (common_hal_i2ctarget_i2c_target_deinited(self)) {
         return;
     }
 
@@ -98,29 +98,29 @@ void common_hal_i2cperipheral_i2c_peripheral_deinit(i2cperipheral_i2c_peripheral
     self->scl_pin = NULL;
 }
 
-int common_hal_i2cperipheral_i2c_peripheral_is_addressed(i2cperipheral_i2c_peripheral_obj_t *self,
+int common_hal_i2ctarget_i2c_target_is_addressed(i2ctarget_i2c_target_obj_t *self,
     uint8_t *address, bool *is_read, bool *is_restart) {
     *address = self->addresses[0];
     *is_read = true;
     *is_restart = false;
     return 1;
 }
 
-int common_hal_i2cperipheral_i2c_peripheral_read_byte(i2cperipheral_i2c_peripheral_obj_t *self, uint8_t *data) {
+int common_hal_i2ctarget_i2c_target_read_byte(i2ctarget_i2c_target_obj_t *self, uint8_t *data) {
     i2c_slave_read_buffer(self->i2c_num, data, 128, 0);
     return 1;
 }
 
-int common_hal_i2cperipheral_i2c_peripheral_write_byte(i2cperipheral_i2c_peripheral_obj_t *self, uint8_t data) {
+int common_hal_i2ctarget_i2c_target_write_byte(i2ctarget_i2c_target_obj_t *self, uint8_t data) {
     i2c_reset_tx_fifo(self->i2c_num);
     i2c_slave_write_buffer(self->i2c_num, &data, 128, 0);
     return 1;
 }
 
-void common_hal_i2cperipheral_i2c_peripheral_ack(i2cperipheral_i2c_peripheral_obj_t *self, bool ack) {
+void common_hal_i2ctarget_i2c_target_ack(i2ctarget_i2c_target_obj_t *self, bool ack) {
 
 }
 
-void common_hal_i2cperipheral_i2c_peripheral_close(i2cperipheral_i2c_peripheral_obj_t *self) {
+void common_hal_i2ctarget_i2c_target_close(i2ctarget_i2c_target_obj_t *self) {
 
 }

ports/espressif/common-hal/i2cperipheral/__init__.c

@@ -24,8 +24,8 @@
  * THE SOFTWARE.
  */
 
-#ifndef MICROPY_INCLUDED_ESPRESSIF_COMMON_HAL_BUSIO_I2C_PERIPHERAL_H
-#define MICROPY_INCLUDED_ESPRESSIF_COMMON_HAL_BUSIO_I2C_PERIPHERAL_H
+#ifndef MICROPY_INCLUDED_ESPRESSIF_COMMON_HAL_BUSIO_I2C_TARGET_H
+#define MICROPY_INCLUDED_ESPRESSIF_COMMON_HAL_BUSIO_I2C_TARGET_H
 
 #include "py/obj.h"
 #include "peripherals/i2c.h"
@@ -38,6 +38,6 @@ typedef struct {
     uint8_t num_addresses;
     const mcu_pin_obj_t *scl_pin;
     const mcu_pin_obj_t *sda_pin;
-} i2cperipheral_i2c_peripheral_obj_t;
+} i2ctarget_i2c_target_obj_t;
 
-#endif // MICROPY_INCLUDED_ESPRESSIF_COMMON_HAL_BUSIO_I2C_PERIPHERAL_H
+#endif // MICROPY_INCLUDED_ESPRESSIF_COMMON_HAL_BUSIO_I2C_TARGET_H

ports/espressif/common-hal/i2cperipheral/I2CPeripheral.c renamed to ports/espressif/common-hal/i2ctarget/I2CTarget.c

@@ -0,0 +1 @@
+// No i2ctarget module functions.

ports/espressif/common-hal/i2cperipheral/I2CPeripheral.h renamed to ports/espressif/common-hal/i2ctarget/I2CTarget.h

@@ -21,7 +21,7 @@ CIRCUITPY_FRAMEBUFFERIO ?= 1
 CIRCUITPY_FREQUENCYIO ?= 1
 CIRCUITPY_HASHLIB ?= 1
 CIRCUITPY_IMAGECAPTURE ?= 1
-CIRCUITPY_I2CPERIPHERAL ?= 1
+CIRCUITPY_I2CTARGET ?= 1
 CIRCUITPY_RGBMATRIX ?= 1
 CIRCUITPY_ROTARYIO ?= 1
 CIRCUITPY_NVM ?= 1