Merge pull request #684 from espressif/feat/esp_io_expander_pi4ioe5v6408-

feat(io_expander): Added new IO expander PI4OE5V6408

Author: espzav

.github/workflows/upload_component.yml

@@ -93,6 +93,7 @@ jobs:
             components/io_expander/esp_io_expander_tca9554
             components/io_expander/esp_io_expander_tca95xx_16bit
             components/io_expander/esp_io_expander_ht8574
+            components/io_expander/esp_io_expander_pi4ioe5v6408
           namespace: "espressif"
           api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}
           dry_run: ${{ github.ref_name != 'master' || github.repository_owner != 'espressif' }}

components/io_expander/.build-test-rules.yml

@@ -21,3 +21,11 @@ components/io_expander/esp_io_expander_tca9554:
   disable:
     - if: IDF_VERSION < "5.2.0"
       reason: Requires I2C Driver-NG which was introduced in v5.2
+
+components/io_expander/esp_io_expander_pi4ioe5v6408:
+  depends_filepatterns:
+    - "components/io_expander/esp_io_expander/**"
+    - "components/io_expander/esp_io_expander_pi4ioe5v6408/**"
+  disable:
+    - if: IDF_VERSION < "5.2.0"
+      reason: Requires I2C Driver-NG which was introduced in v5.2

components/io_expander/esp_io_expander/README.md

@@ -6,10 +6,22 @@ This componnent is main esp_io_expander component which defines main functions a
 
 ## Supported features
 
+### From v1.0
+
 - [x] Set an IO's direction
 - [x] Get an IO's direction
 - [x] Set an IO's output level
 - [x] Get an IO's input level
 - [x] Show all IOs' status
+
+### From v1.1
+
+- [x] Set an IO's output mode (Push Pull / Open Drain)
+- [x] Set an IO's Pull-up / Pull-down state
+
+### Future
+
 - [ ] Interrupt mode
 
+
+

components/io_expander/esp_io_expander/esp_io_expander.c

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2015-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -23,6 +23,9 @@ typedef enum {
     REG_INPUT = 0,
     REG_OUTPUT,
     REG_DIRECTION,
+    REG_HIGHZ,
+    REG_PULLUP_EN,
+    REG_PULLUP_SEL,
 } reg_type_t;
 
 static char *TAG = "io_expander";
@@ -126,6 +129,76 @@ esp_err_t esp_io_expander_get_level(esp_io_expander_handle_t handle, uint32_t pi
     return ESP_OK;
 }
 
+esp_err_t esp_io_expander_set_pullupdown(esp_io_expander_handle_t handle, uint32_t pin_num_mask, esp_io_expander_pullupdown_t state)
+{
+    ESP_RETURN_ON_FALSE(handle, ESP_ERR_INVALID_ARG, TAG, "Invalid handle");
+    if (pin_num_mask >= BIT64(VALID_IO_COUNT(handle))) {
+        ESP_LOGW(TAG, "Pin num mask out of range, bit higher than %d won't work", VALID_IO_COUNT(handle) - 1);
+    }
+
+    uint32_t pull_en, pull_set, pull_en_tmp, pull_set_tmp;
+    ESP_RETURN_ON_ERROR(read_reg(handle, REG_PULLUP_EN, &pull_en), TAG, "Read Pull-up enable reg failed");
+    ESP_RETURN_ON_ERROR(read_reg(handle, REG_PULLUP_SEL, &pull_set), TAG, "Read Pull-up select reg failed");
+    pull_en_tmp = pull_en;
+    pull_set_tmp = pull_set;
+
+    if ((state == IO_EXPANDER_PULL_UP && !handle->config.flags.pullup_high_bit_zero) || (state == IO_EXPANDER_PULL_DOWN && handle->config.flags.pullup_high_bit_zero)) {
+        /* 1. High level && Set 1 to output high */
+        /* 2. Low level && Set 1 to output low */
+        pull_set |= pin_num_mask;
+    } else {
+        /* 3. High level && Set 0 to output high */
+        /* 4. Low level && Set 0 to output low */
+        pull_set &= ~pin_num_mask;
+    }
+
+    /* Write to reg only when different */
+    if (pull_set != pull_set_tmp) {
+        ESP_RETURN_ON_ERROR(write_reg(handle, REG_PULLUP_SEL, pull_set), TAG, "Write Pull-up select reg failed");
+    }
+
+    if (state == IO_EXPANDER_PULL_UP || state == IO_EXPANDER_PULL_DOWN) {
+        /* Enable pull-up/pull-down */
+        pull_en |= pin_num_mask;
+    } else {
+        /* Disable pull-up/pull-down */
+        pull_en &= ~pin_num_mask;
+    }
+
+    /* Write to reg only when different */
+    if (pull_en != pull_en_tmp) {
+        ESP_RETURN_ON_ERROR(write_reg(handle, REG_PULLUP_EN, pull_en), TAG, "Write Pull-up enable reg failed");
+    }
+
+    return ESP_OK;
+}
+
+esp_err_t esp_io_expander_set_output_mode(esp_io_expander_handle_t handle, uint32_t pin_num_mask, esp_io_expander_output_mode_t mode)
+{
+    ESP_RETURN_ON_FALSE(handle, ESP_ERR_INVALID_ARG, TAG, "Invalid handle");
+    if (pin_num_mask >= BIT64(VALID_IO_COUNT(handle))) {
+        ESP_LOGW(TAG, "Pin num mask out of range, bit higher than %d won't work", VALID_IO_COUNT(handle) - 1);
+    }
+
+    bool is_highz = (mode == IO_EXPANDER_OUTPUT_MODE_OPEN_DRAIN) ? true : false;
+    uint32_t highz_reg, temp;
+    ESP_RETURN_ON_ERROR(read_reg(handle, REG_HIGHZ, &highz_reg), TAG, "Read High-Z reg failed");
+    temp = highz_reg;
+    if (is_highz) {
+        /* Open drain && Set 1 */
+        highz_reg |= pin_num_mask;
+    } else {
+        /* Push pull && Set 0  */
+        highz_reg &= ~pin_num_mask;
+    }
+    /* Write to reg only when different */
+    if (highz_reg != temp) {
+        ESP_RETURN_ON_ERROR(write_reg(handle, REG_HIGHZ, highz_reg), TAG, "Write High-Z reg failed");
+    }
+
+    return ESP_OK;
+}
+
 esp_err_t esp_io_expander_print_state(esp_io_expander_handle_t handle)
 {
     ESP_RETURN_ON_FALSE(handle, ESP_ERR_INVALID_ARG, TAG, "Invalid handle");
@@ -190,6 +263,15 @@ static esp_err_t write_reg(esp_io_expander_handle_t handle, reg_type_t reg, uint
     case REG_DIRECTION:
         ESP_RETURN_ON_FALSE(handle->write_direction_reg, ESP_ERR_NOT_SUPPORTED, TAG, "write_direction_reg isn't implemented");
         return handle->write_direction_reg(handle, value);
+    case REG_HIGHZ:
+        ESP_RETURN_ON_FALSE(handle->write_highz_reg, ESP_ERR_NOT_SUPPORTED, TAG, "write_highz_reg isn't implemented");
+        return handle->write_highz_reg(handle, value);
+    case REG_PULLUP_EN:
+        ESP_RETURN_ON_FALSE(handle->write_pullup_en_reg, ESP_ERR_NOT_SUPPORTED, TAG, "write_pullup_en_reg isn't implemented");
+        return handle->write_pullup_en_reg(handle, value);
+    case REG_PULLUP_SEL:
+        ESP_RETURN_ON_FALSE(handle->write_pullup_sel_reg, ESP_ERR_NOT_SUPPORTED, TAG, "write_pullup_sel_reg isn't implemented");
+        return handle->write_pullup_sel_reg(handle, value);
     default:
         return ESP_ERR_NOT_SUPPORTED;
     }
@@ -220,6 +302,15 @@ static esp_err_t read_reg(esp_io_expander_handle_t handle, reg_type_t reg, uint3
     case REG_DIRECTION:
         ESP_RETURN_ON_FALSE(handle->read_direction_reg, ESP_ERR_NOT_SUPPORTED, TAG, "read_direction_reg isn't implemented");
         return handle->read_direction_reg(handle, value);
+    case REG_HIGHZ:
+        ESP_RETURN_ON_FALSE(handle->read_highz_reg, ESP_ERR_NOT_SUPPORTED, TAG, "read_highz_reg isn't implemented");
+        return handle->read_highz_reg(handle, value);
+    case REG_PULLUP_EN:
+        ESP_RETURN_ON_FALSE(handle->read_pullup_en_reg, ESP_ERR_NOT_SUPPORTED, TAG, "read_pullup_en_reg isn't implemented");
+        return handle->read_pullup_en_reg(handle, value);
+    case REG_PULLUP_SEL:
+        ESP_RETURN_ON_FALSE(handle->read_pullup_sel_reg, ESP_ERR_NOT_SUPPORTED, TAG, "read_pullup_sel_reg isn't implemented");
+        return handle->read_pullup_sel_reg(handle, value);
     default:
         return ESP_ERR_NOT_SUPPORTED;
     }

components/io_expander/esp_io_expander/idf_component.yml

@@ -1,4 +1,4 @@
-version: "1.0.1"
+version: "1.1.0"
 description: ESP IO Expander - main component for using io expander chip
 url: https://github.com/espressif/esp-bsp/tree/master/components/io_expander/esp_io_expander
 dependencies:

components/io_expander/esp_io_expander/include/esp_io_expander.h

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -77,6 +77,25 @@ typedef enum {
     IO_EXPANDER_OUTPUT,         /*!< Output dircetion */
 } esp_io_expander_dir_t;
 
+/**
+ * @brief IO Expander Pin output mode
+ *
+ */
+typedef enum {
+    IO_EXPANDER_OUTPUT_MODE_PUSH_PULL,  /*!< Output High-Z = 0 */
+    IO_EXPANDER_OUTPUT_MODE_OPEN_DRAIN, /*!< Output High-Z = 1 */
+} esp_io_expander_output_mode_t;
+
+/**
+ * @brief IO Expander Pin pull-up/pull-down
+ *
+ */
+typedef enum {
+    IO_EXPANDER_PULL_NONE,  /*!< Not used pull-up/pull-down */
+    IO_EXPANDER_PULL_UP,    /*!< Set pull-up */
+    IO_EXPANDER_PULL_DOWN,  /*!< Set pull-down */
+} esp_io_expander_pullupdown_t;
+
 /**
  * @brief IO Expander Configuration Type
  *
@@ -87,6 +106,7 @@ typedef struct {
         uint8_t dir_out_bit_zero : 1;       /*!< If the direction of IO is output, the corresponding bit of the direction register is 0 */
         uint8_t input_high_bit_zero : 1;    /*!< If the input level of IO is high, the corresponding bit of the input register is 0 */
         uint8_t output_high_bit_zero : 1;   /*!< If the output level of IO is high, the corresponding bit of the output register is 0 */
+        uint8_t pullup_high_bit_zero : 1;    /*!< If the pullup/down level of IO is high, the corresponding bit of the output register is 0 */
     } flags;
     /* Don't support with interrupt mode yet, will be added soon */
 } esp_io_expander_config_t;
@@ -165,6 +185,87 @@ struct esp_io_expander_s {
      */
     esp_err_t (*read_direction_reg)(esp_io_expander_handle_t handle, uint32_t *value);
 
+    /**
+    * @brief Write value to high impedance register (optional)
+    *
+    * @note If there are multiple high impedance registers in the device, their values should be spliced together in order to form the `value`.
+    *
+    * @param handle: IO Expander handle
+    * @param value: Register's value
+    *
+    * @return
+    *      - ESP_OK: Success, otherwise returns ESP_ERR_xxx
+    */
+    esp_err_t (*write_highz_reg)(esp_io_expander_handle_t handle, uint32_t value);
+
+    /**
+     * @brief Read value from high impedance register (optional)
+     *
+     * @note This function can be implemented by reading the physical direction register, or simply by reading a variable that record the direction value (more faster)
+     * @note If there are multiple high impedance registers in the device, their values should be spliced together in order to form the `value`.
+     *
+     * @param handle: IO Expander handle
+     * @param value: Register's value
+     *
+     * @return
+     *      - ESP_OK: Success, otherwise returns ESP_ERR_xxx
+     */
+    esp_err_t (*read_highz_reg)(esp_io_expander_handle_t handle, uint32_t *value);
+
+    /**
+    * @brief Write value to enable pullup register (optional)
+    *
+    * @note If there are multiple enable pullup registers in the device, their values should be spliced together in order to form the `value`.
+    *
+    * @param handle: IO Expander handle
+    * @param value: Register's value
+    *
+    * @return
+    *      - ESP_OK: Success, otherwise returns ESP_ERR_xxx
+    */
+    esp_err_t (*write_pullup_en_reg)(esp_io_expander_handle_t handle, uint32_t value);
+
+    /**
+     * @brief Read value from enable pullup register (optional)
+     *
+     * @note This function can be implemented by reading the physical direction register, or simply by reading a variable that record the direction value (more faster)
+     * @note If there are multiple enable pullup registers in the device, their values should be spliced together in order to form the `value`.
+     *
+     * @param handle: IO Expander handle
+     * @param value: Register's value
+     *
+     * @return
+     *      - ESP_OK: Success, otherwise returns ESP_ERR_xxx
+     */
+    esp_err_t (*read_pullup_en_reg)(esp_io_expander_handle_t handle, uint32_t *value);
+
+    /**
+     * @brief Write value to select pullup register (optional)
+     *
+     * @note If there are multiple set pullup registers in the device, their values should be spliced together in order to form the `value`.
+     *
+     * @param handle: IO Expander handle
+     * @param value: Register's value
+     *
+     * @return
+     *      - ESP_OK: Success, otherwise returns ESP_ERR_xxx
+     */
+    esp_err_t (*write_pullup_sel_reg)(esp_io_expander_handle_t handle, uint32_t value);
+
+    /**
+     * @brief Read value from select pullup register (optional)
+     *
+     * @note This function can be implemented by reading the physical direction register, or simply by reading a variable that record the direction value (more faster)
+     * @note If there are multiple set pullup registers in the device, their values should be spliced together in order to form the `value`.
+     *
+     * @param handle: IO Expander handle
+     * @param value: Register's value
+     *
+     * @return
+     *      - ESP_OK: Success, otherwise returns ESP_ERR_xxx
+     */
+    esp_err_t (*read_pullup_sel_reg)(esp_io_expander_handle_t handle, uint32_t *value);
+
     /**
      * @brief Reset the device to its initial state (mandatory)
      *
@@ -233,6 +334,36 @@ esp_err_t esp_io_expander_set_level(esp_io_expander_handle_t handle, uint32_t pi
  */
 esp_err_t esp_io_expander_get_level(esp_io_expander_handle_t handle, uint32_t pin_num_mask, uint32_t *level_mask);
 
+/**
+ * @brief Set the pull-up/pull-down of a set of target IOs
+ *
+ * @note
+ *
+ * @param handle: IO Exapnder handle
+ * @param pin_num_mask: Bitwise OR of allowed pin num with type of `esp_io_expander_pin_num_t`
+ * @param state: State of pull-up/pull-down
+ *
+ * @return
+ *      - ESP_OK: Success, otherwise returns ESP_ERR_xxx
+ */
+esp_err_t esp_io_expander_set_pullupdown(esp_io_expander_handle_t handle, uint32_t pin_num_mask, esp_io_expander_pullupdown_t state);
+
+
+/**
+ * @brief Set the output mode (High-Z) of a set of target IOs
+ *
+ * @note
+ *
+ * @param handle: IO Exapnder handle
+ * @param pin_num_mask: Bitwise OR of allowed pin num with type of `esp_io_expander_pin_num_t`
+ * @param mode: Output mode
+ *
+ * @return
+ *      - ESP_OK: Success, otherwise returns ESP_ERR_xxx
+ */
+esp_err_t esp_io_expander_set_output_mode(esp_io_expander_handle_t handle, uint32_t pin_num_mask, esp_io_expander_output_mode_t mode);
+
+
 /**
  * @brief Print the current status of each IO of the device, including direction, input level and output level
  *

components/io_expander/esp_io_expander_pi4ioe5v6408/CMakeLists.txt

@@ -0,0 +1,8 @@
+set(req)
+if("${IDF_VERSION_MAJOR}.${IDF_VERSION_MINOR}" VERSION_GREATER_EQUAL "5.2.6")
+    list(APPEND req "esp_driver_i2c")
+else()
+    list(APPEND req "driver")
+endif()
+
+idf_component_register(SRCS "esp_io_expander_pi4ioe5v6408.c" INCLUDE_DIRS "include" REQUIRES ${req})