From c35deb2625efc877b3a0d03d5654e27232b2d101 Mon Sep 17 00:00:00 2001
From: Damien George
Date: Wed, 16 Sep 2020 13:30:48 +1000
Subject: extmod/machine_i2c: Rename type to SoftI2C and add custom print
 method.

Also rename machine_i2c_type to mp_machine_soft_i2c_type.  These changes
make it clear that it's a soft-I2C implementation, and match SoftSPI.

Signed-off-by: Damien George <damien@micropython.org>
---
 extmod/machine_i2c.c | 17 ++++++++++++-----
 extmod/machine_i2c.h |  3 ++-
 2 files changed, 14 insertions(+), 6 deletions(-)

(limited to 'extmod')

diff --git a/extmod/machine_i2c.c b/extmod/machine_i2c.c
index c804cf570..8aad001f1 100644
--- a/extmod/machine_i2c.c
+++ b/extmod/machine_i2c.c
@@ -302,6 +302,12 @@ STATIC int mp_machine_i2c_writeto(mp_obj_base_t *self, uint16_t addr, const uint
 /******************************************************************************/
 // MicroPython bindings for I2C
 
+STATIC void mp_machine_soft_i2c_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
+    mp_machine_soft_i2c_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    mp_printf(print, "SoftI2C(scl=" MP_HAL_PIN_FMT ", sda=" MP_HAL_PIN_FMT ", freq=%u)",
+        mp_hal_pin_name(self->scl), mp_hal_pin_name(self->sda), 500000 / self->us_delay);
+}
+
 STATIC void machine_i2c_obj_init_helper(machine_i2c_obj_t *self, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     enum { ARG_scl, ARG_sda, ARG_freq, ARG_timeout };
     static const mp_arg_t allowed_args[] = {
@@ -318,7 +324,7 @@ STATIC void machine_i2c_obj_init_helper(machine_i2c_obj_t *self, size_t n_args,
     mp_hal_i2c_init(self, args[ARG_freq].u_int);
 }
 
-STATIC mp_obj_t machine_i2c_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args) {
+STATIC mp_obj_t mp_machine_soft_i2c_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args) {
     // check the id argument, if given
     if (n_args > 0) {
         if (args[0] != MP_OBJ_NEW_SMALL_INT(-1)) {
@@ -336,7 +342,7 @@ STATIC mp_obj_t machine_i2c_make_new(const mp_obj_type_t *type, size_t n_args, s
 
     // create new soft I2C object
     machine_i2c_obj_t *self = m_new_obj(machine_i2c_obj_t);
-    self->base.type = &machine_i2c_type;
+    self->base.type = &mp_machine_soft_i2c_type;
     mp_map_t kw_args;
     mp_map_init_fixed_table(&kw_args, n_kw, args + n_args);
     machine_i2c_obj_init_helper(self, n_args, args, &kw_args);
@@ -700,10 +706,11 @@ STATIC const mp_machine_i2c_p_t mp_machine_soft_i2c_p = {
     .transfer = mp_machine_soft_i2c_transfer,
 };
 
-const mp_obj_type_t machine_i2c_type = {
+const mp_obj_type_t mp_machine_soft_i2c_type = {
     { &mp_type_type },
-    .name = MP_QSTR_I2C,
-    .make_new = machine_i2c_make_new,
+    .name = MP_QSTR_SoftI2C,
+    .print = mp_machine_soft_i2c_print,
+    .make_new = mp_machine_soft_i2c_make_new,
     .protocol = &mp_machine_soft_i2c_p,
     .locals_dict = (mp_obj_dict_t *)&mp_machine_soft_i2c_locals_dict,
 };
diff --git a/extmod/machine_i2c.h b/extmod/machine_i2c.h
index f951c1f21..9723069d5 100644
--- a/extmod/machine_i2c.h
+++ b/extmod/machine_i2c.h
@@ -27,6 +27,7 @@
 #define MICROPY_INCLUDED_EXTMOD_MACHINE_I2C_H
 
 #include "py/obj.h"
+#include "py/mphal.h"
 
 #define MP_MACHINE_I2C_FLAG_READ (0x01) // if not set then it's a write
 #define MP_MACHINE_I2C_FLAG_STOP (0x02)
@@ -56,7 +57,7 @@ typedef struct _mp_machine_soft_i2c_obj_t {
     mp_hal_pin_obj_t sda;
 } mp_machine_soft_i2c_obj_t;
 
-extern const mp_obj_type_t machine_i2c_type;
+extern const mp_obj_type_t mp_machine_soft_i2c_type;
 extern const mp_obj_dict_t mp_machine_soft_i2c_locals_dict;
 
 int mp_machine_i2c_transfer_adaptor(mp_obj_base_t *self, uint16_t addr, size_t n, mp_machine_i2c_buf_t *bufs, unsigned int flags);
-- 
cgit v1.2.3