diff --git a/components/io_expander/esp_io_expander_ch422g/CMakeLists.txt b/components/io_expander/esp_io_expander_ch422g/CMakeLists.txt new file mode 100644 index 000000000..c00581594 --- /dev/null +++ b/components/io_expander/esp_io_expander_ch422g/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_ch422g.c" INCLUDE_DIRS "include" REQUIRES ${req}) diff --git a/components/io_expander/esp_io_expander_ch422g/README.md b/components/io_expander/esp_io_expander_ch422g/README.md new file mode 100644 index 000000000..e64cb9b96 --- /dev/null +++ b/components/io_expander/esp_io_expander_ch422g/README.md @@ -0,0 +1,63 @@ +# ESP IO Expander Chip CH422G + +Implementation of the CH422G io expander chip with esp_io_expander component. + +| Chip | Communication interface | Component name | Link to datasheet | +| :--------------: | :---------------------: | :------------: | :---------------: | +| CH422G | I2C | esp_io_expander_ch422g | [datasheet](https://files.waveshare.com/wiki/common/CH422DS1_EN.pdf) | + +Currently only support bidirectional I/O pins. General purposes pins OC3-OC0 are not supported. +Chip limitations dictates that all bidirectional I/O pins are either input or output, they cannot be controlled individually. + +## Add to project + +Packages from this repository are uploaded to [Espressif's component service](https://components.espressif.com/). +You can add them to your project via `idf.py add-dependency`, e.g. +``` + idf.py add-dependency esp_io_expander_ch422g==1.0.0 +``` + +Alternatively, you can create `idf_component.yml`. More is in [Espressif's documentation](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html). + +## Example use + +Creation of the i2c bus. + +```c + i2c_master_bus_handle_t i2c_handle = NULL; + const i2c_master_bus_config_t bus_config = { + .i2c_port = I2C_NUM_0, + .sda_io_num = 47, + .scl_io_num = 48, + .clk_source = I2C_CLK_SRC_DEFAULT, + }; + i2c_new_master_bus(&bus_config, &i2c_handle); +``` + +Creation of the component. + +```c + esp_io_expander_handle_t io_expander = NULL; + esp_io_expander_new_i2c_ch422g(i2c_handle, &io_expander); +``` + +Print all pins's status to the log: + +```c + esp_io_expander_print_state(io_expander); +``` + +Set pin 0 and pin 1 with output direction and low level: + +```c + esp_io_expander_set_dir(io_expander, IO_EXPANDER_ALL_PINS, IO_EXPANDER_OUTPUT); + esp_io_expander_set_level(io_expander, IO_EXPANDER_PIN_NUM_0 | IO_EXPANDER_PIN_NUM_1, 0); +``` + +Set pin 2 and pin 3 with input direction: + +```c + uint32_t pin_levels = 0; + esp_io_expander_set_dir(io_expander, IO_EXPANDER_ALL_PINS, IO_EXPANDER_INPUT); + esp_io_expander_get_level(io_expander, IO_EXPANDER_PIN_NUM_2 | IO_EXPANDER_PIN_NUM_3, &pin_levels); +``` diff --git a/components/io_expander/esp_io_expander_ch422g/esp_io_expander_ch422g.c b/components/io_expander/esp_io_expander_ch422g/esp_io_expander_ch422g.c new file mode 100644 index 000000000..0010a8646 --- /dev/null +++ b/components/io_expander/esp_io_expander_ch422g/esp_io_expander_ch422g.c @@ -0,0 +1,188 @@ +/* + * SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2025 Frédéric Nadeau + * + * SPDX-License-Identifier: Apache-2.0 + */ + +#include +#include +#include +#include "esp_bit_defs.h" +#include "esp_check.h" +#include "esp_log.h" +#include "esp_io_expander.h" +#include "esp_io_expander_ch422g.h" + +/* I2C communication related */ +#define I2C_TIMEOUT_MS (1000) +#define I2C_CLK_SPEED (400000) + +#define IO_COUNT (8) + +/* Register address */ +#define GENERAL_PURPOSE_OUTPUT_ADDR (0x24) +#define SET_IO_ADDR (0x38) +#define READ_IO_ADDR (0x26) + +/* Default register value on power-up */ +#define DIR_REG_DEFAULT_VAL (0xFF) +#define OUT_REG_DEFAULT_VAL (0x00) + +/** + * @brief Device Structure Type + * + */ +typedef struct { + esp_io_expander_t base; + i2c_master_dev_handle_t i2c_gpo_handle; + i2c_master_dev_handle_t i2c_set_io_handle; + i2c_master_dev_handle_t i2c_read_io_handle; + struct { + uint8_t direction; + uint8_t output; + } regs; +} esp_io_expander_ch422g_t; + +static const char *TAG = "ch422g"; + +static esp_err_t read_input_reg(esp_io_expander_handle_t handle, uint32_t *value); +static esp_err_t write_output_reg(esp_io_expander_handle_t handle, uint32_t value); +static esp_err_t read_output_reg(esp_io_expander_handle_t handle, uint32_t *value); +static esp_err_t write_direction_reg(esp_io_expander_handle_t handle, uint32_t value); +static esp_err_t read_direction_reg(esp_io_expander_handle_t handle, uint32_t *value); +static esp_err_t reset(esp_io_expander_t *handle); +static esp_err_t del(esp_io_expander_t *handle); + +esp_err_t esp_io_expander_new_i2c_ch422g(i2c_master_bus_handle_t i2c_bus, esp_io_expander_handle_t *handle_ret) +{ + ESP_RETURN_ON_FALSE(handle_ret != NULL, ESP_ERR_INVALID_ARG, TAG, "Invalid handle_ret"); + + // Allocate memory for driver object + esp_io_expander_ch422g_t *ch422g = (esp_io_expander_ch422g_t *)calloc(1, sizeof(esp_io_expander_ch422g_t)); + ESP_RETURN_ON_FALSE(ch422g != NULL, ESP_ERR_NO_MEM, TAG, "Malloc failed"); + + // Add new I2C device + esp_err_t ret = ESP_OK; + const i2c_device_config_t i2c_dev_cfg1 = { + .device_address = GENERAL_PURPOSE_OUTPUT_ADDR, + .scl_speed_hz = I2C_CLK_SPEED, + }; + ESP_GOTO_ON_ERROR(i2c_master_bus_add_device(i2c_bus, &i2c_dev_cfg1, &ch422g->i2c_gpo_handle), err, TAG, "Add new I2C device (GENERAL_PURPOSE_OUTPUT_ADDR) failed"); + + const i2c_device_config_t i2c_dev_cfg2 = { + .device_address = SET_IO_ADDR, + .scl_speed_hz = I2C_CLK_SPEED, + }; + ESP_GOTO_ON_ERROR(i2c_master_bus_add_device(i2c_bus, &i2c_dev_cfg2, &ch422g->i2c_set_io_handle), err, TAG, "Add new I2C device (SET_IO_ADDR) failed"); + + const i2c_device_config_t i2c_dev_cfg3 = { + .device_address = READ_IO_ADDR, + .scl_speed_hz = I2C_CLK_SPEED, + }; + ESP_GOTO_ON_ERROR(i2c_master_bus_add_device(i2c_bus, &i2c_dev_cfg3, &ch422g->i2c_read_io_handle), err, TAG, "Add new I2C device (READ_IO_ADDR) failed"); + + ch422g->base.config.io_count = IO_COUNT; + ch422g->base.config.flags.dir_out_bit_zero = 0; + ch422g->base.read_input_reg = read_input_reg; + ch422g->base.write_output_reg = write_output_reg; + ch422g->base.read_output_reg = read_output_reg; + ch422g->base.write_direction_reg = write_direction_reg; + ch422g->base.read_direction_reg = read_direction_reg; + ch422g->base.del = del; + ch422g->base.reset = reset; + + /* Reset configuration and register status */ + ESP_GOTO_ON_ERROR(reset(&ch422g->base), err, TAG, "Reset failed"); + + *handle_ret = &ch422g->base; + return ESP_OK; +err: + if (ch422g->i2c_gpo_handle) + i2c_master_bus_rm_device(ch422g->i2c_gpo_handle); + if (ch422g->i2c_set_io_handle) + i2c_master_bus_rm_device(ch422g->i2c_set_io_handle); + if (ch422g->i2c_read_io_handle) + i2c_master_bus_rm_device(ch422g->i2c_read_io_handle); + + free(ch422g); + return ret; +} + +static esp_err_t read_input_reg(esp_io_expander_handle_t handle, uint32_t *value) +{ + esp_io_expander_ch422g_t *ch422g = (esp_io_expander_ch422g_t *)__containerof(handle, esp_io_expander_ch422g_t, base); + + uint8_t temp = 0; + ESP_RETURN_ON_ERROR(i2c_master_receive(ch422g->i2c_read_io_handle, &temp, sizeof(temp), I2C_TIMEOUT_MS), TAG, "Read input reg failed"); + *value = temp; + return ESP_OK; +} + +static esp_err_t write_output_reg(esp_io_expander_handle_t handle, uint32_t value) +{ + esp_io_expander_ch422g_t *ch422g = (esp_io_expander_ch422g_t *)__containerof(handle, esp_io_expander_ch422g_t, base); + value &= 0xff; + + uint8_t data[] = {value}; + ESP_RETURN_ON_ERROR(i2c_master_transmit(ch422g->i2c_set_io_handle, data, sizeof(data), I2C_TIMEOUT_MS), TAG, "Write output reg failed"); + ch422g->regs.output = value; + return ESP_OK; +} + +static esp_err_t read_output_reg(esp_io_expander_handle_t handle, uint32_t *value) +{ + esp_io_expander_ch422g_t *ch422g = (esp_io_expander_ch422g_t *)__containerof(handle, esp_io_expander_ch422g_t, base); + + *value = ch422g->regs.output; + return ESP_OK; +} + +static esp_err_t write_direction_reg(esp_io_expander_handle_t handle, uint32_t value) +{ + esp_io_expander_ch422g_t *ch422g = (esp_io_expander_ch422g_t *)__containerof(handle, esp_io_expander_ch422g_t, base); + value &= 0xff; + + /* CH422G limitation: all bidirectional I/Os must be inputs or outputs together. + * Accept only 0x00 (all inputs) or 0xFF (all outputs) and reject mixed masks. + */ + if (value != 0x00 && value != 0xFF) { + ESP_LOGE(TAG, "Invalid direction mask 0x%02" PRIx32 ", CH422G only supports all-input (0x00) or all-output (0xFF)", value); + return ESP_ERR_INVALID_ARG; + } + uint8_t data[] = {0x00}; + if (value == 0xFF) { + /* Any non-zero config means 'all outputs' for the device; use 0x01 as per datasheet/README. */ + data[0] = 0x01; + } + ESP_RETURN_ON_ERROR(i2c_master_transmit(ch422g->i2c_gpo_handle, data, sizeof(data), I2C_TIMEOUT_MS), TAG, "Write direction reg failed"); + /* Cache the logical direction as a full mask for higher layers: 0x00 = all in, 0xFF = all out. */ + ch422g->regs.direction = (value == 0x00) ? 0x00 : 0xFF; + return ESP_OK; +} + +static esp_err_t read_direction_reg(esp_io_expander_handle_t handle, uint32_t *value) +{ + esp_io_expander_ch422g_t *ch422g = (esp_io_expander_ch422g_t *)__containerof(handle, esp_io_expander_ch422g_t, base); + + *value = ch422g->regs.direction; + return ESP_OK; +} + +static esp_err_t reset(esp_io_expander_t *handle) +{ + ESP_RETURN_ON_ERROR(write_direction_reg(handle, DIR_REG_DEFAULT_VAL), TAG, "Write dir reg failed"); + ESP_RETURN_ON_ERROR(write_output_reg(handle, OUT_REG_DEFAULT_VAL), TAG, "Write output reg failed"); + return ESP_OK; +} + +static esp_err_t del(esp_io_expander_t *handle) +{ + esp_io_expander_ch422g_t *ch422g = (esp_io_expander_ch422g_t *)__containerof(handle, esp_io_expander_ch422g_t, base); + + ESP_RETURN_ON_ERROR(i2c_master_bus_rm_device(ch422g->i2c_gpo_handle), TAG, "Remove I2C device (GENERAL_PURPOSE_OUTPUT_ADDR) failed"); + ESP_RETURN_ON_ERROR(i2c_master_bus_rm_device(ch422g->i2c_set_io_handle), TAG, "Remove I2C device (SET_IO_ADDR) failed"); + ESP_RETURN_ON_ERROR(i2c_master_bus_rm_device(ch422g->i2c_read_io_handle), TAG, "Remove I2C device (READ_IO_ADDR) failed"); + free(ch422g); + return ESP_OK; +} diff --git a/components/io_expander/esp_io_expander_ch422g/idf_component.yml b/components/io_expander/esp_io_expander_ch422g/idf_component.yml new file mode 100644 index 000000000..22ee11bd7 --- /dev/null +++ b/components/io_expander/esp_io_expander_ch422g/idf_component.yml @@ -0,0 +1,8 @@ +version: "1.0.1" +description: ESP IO Expander - CH422G +url: https://github.com/espressif/esp-bsp/tree/master/components/io_expander/esp_io_expander_ch422g +dependencies: + idf: ">=5.2" + esp_io_expander: + version: "^1.0.1" + public: true \ No newline at end of file diff --git a/components/io_expander/esp_io_expander_ch422g/include/esp_io_expander_ch422g.h b/components/io_expander/esp_io_expander_ch422g/include/esp_io_expander_ch422g.h new file mode 100644 index 000000000..722fec99e --- /dev/null +++ b/components/io_expander/esp_io_expander_ch422g/include/esp_io_expander_ch422g.h @@ -0,0 +1,40 @@ +/* + * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2025 Frédéric Nadeau + * + * SPDX-License-Identifier: Apache-2.0 + */ + +/** + * @file + * @brief ESP IO expander: CH422G + */ + +#pragma once + +#include +#include "esp_err.h" +#include "driver/i2c_master.h" +#include "esp_io_expander.h" + +#ifdef __cplusplus +extern "C" { +#endif + +#define IO_EXPANDER_ALL_PINS (IO_EXPANDER_PIN_NUM_0 | IO_EXPANDER_PIN_NUM_1 | IO_EXPANDER_PIN_NUM_2 | IO_EXPANDER_PIN_NUM_3 | \ + IO_EXPANDER_PIN_NUM_4 | IO_EXPANDER_PIN_NUM_5 | IO_EXPANDER_PIN_NUM_6 | IO_EXPANDER_PIN_NUM_7) + +/** + * @brief Create a CH422G IO expander object + * + * @param[in] i2c_bus I2C bus handle. Obtained from `i2c_new_master_bus()` + * @param[out] handle_ret Handle to created IO expander object + * + * @return + * - ESP_OK: Success, otherwise returns ESP_ERR_xxx + */ +esp_err_t esp_io_expander_new_i2c_ch422g(i2c_master_bus_handle_t i2c_bus, esp_io_expander_handle_t *handle_ret); + +#ifdef __cplusplus +} +#endif diff --git a/components/io_expander/esp_io_expander_ch422g/license.txt b/components/io_expander/esp_io_expander_ch422g/license.txt new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/components/io_expander/esp_io_expander_ch422g/license.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/components/io_expander/esp_io_expander_ch422g/test_apps/CMakeLists.txt b/components/io_expander/esp_io_expander_ch422g/test_apps/CMakeLists.txt new file mode 100644 index 000000000..38adf011d --- /dev/null +++ b/components/io_expander/esp_io_expander_ch422g/test_apps/CMakeLists.txt @@ -0,0 +1,6 @@ +# The following lines of boilerplate have to be in your project's CMakeLists +# in this exact order for cmake to work correctly +cmake_minimum_required(VERSION 3.5) +set(COMPONENTS main) +include($ENV{IDF_PATH}/tools/cmake/project.cmake) +project(test_app_ch422g) diff --git a/components/io_expander/esp_io_expander_ch422g/test_apps/main/CMakeLists.txt b/components/io_expander/esp_io_expander_ch422g/test_apps/main/CMakeLists.txt new file mode 100644 index 000000000..3f3dd1359 --- /dev/null +++ b/components/io_expander/esp_io_expander_ch422g/test_apps/main/CMakeLists.txt @@ -0,0 +1,4 @@ +idf_component_register( + SRCS "test_app_ch422g.c" + REQUIRES unity + ) diff --git a/components/io_expander/esp_io_expander_ch422g/test_apps/main/idf_component.yml b/components/io_expander/esp_io_expander_ch422g/test_apps/main/idf_component.yml new file mode 100644 index 000000000..6ec3c35e2 --- /dev/null +++ b/components/io_expander/esp_io_expander_ch422g/test_apps/main/idf_component.yml @@ -0,0 +1,6 @@ +## IDF Component Manager Manifest File +dependencies: + idf: ">=5.2" + esp_io_expander_ch422g: + version: "*" + override_path: "../../../esp_io_expander_ch422g" diff --git a/components/io_expander/esp_io_expander_ch422g/test_apps/main/test_app_ch422g.c b/components/io_expander/esp_io_expander_ch422g/test_apps/main/test_app_ch422g.c new file mode 100644 index 000000000..e156f8f5b --- /dev/null +++ b/components/io_expander/esp_io_expander_ch422g/test_apps/main/test_app_ch422g.c @@ -0,0 +1,131 @@ +/* + * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2025 Frédéric Nadeau + * + * SPDX-License-Identifier: Apache-2.0 + */ + +#include +#include "freertos/FreeRTOS.h" +#include "freertos/task.h" +#include "unity.h" +#include "unity_test_runner.h" +#include "unity_test_utils_memory.h" +#include "esp_system.h" +#include "esp_log.h" +#include "driver/i2c_master.h" +#include "esp_io_expander_ch422g.h" + +// Pinout for ESP32-S3-Touch-LCD-4.3 +#define I2C_MASTER_SCL_IO 9 /*!< gpio number for I2C master clock */ +#define I2C_MASTER_SDA_IO 8 /*!< gpio number for I2C master data */ +#define I2C_MASTER_NUM I2C_NUM_1 /*!< I2C port number for master dev */ +/*!< I2C address of slave dev */ + +#define TEST_LOOP_CNT 10 +#define TEST_LOOP_DELAY_MS 500 +#define TEST_OUTPUT_PINS (IO_EXPANDER_PIN_NUM_2) + +static const char *TAG = "ch422g test"; +static esp_io_expander_handle_t io_expander = NULL; +static i2c_master_bus_handle_t i2c_handle = NULL; + +static void i2c_bus_init(void) +{ + const i2c_master_bus_config_t bus_config = { + .i2c_port = I2C_MASTER_NUM, + .sda_io_num = I2C_MASTER_SDA_IO, + .scl_io_num = I2C_MASTER_SCL_IO, + .clk_source = I2C_CLK_SRC_DEFAULT, + }; + + esp_err_t ret = i2c_new_master_bus(&bus_config, &i2c_handle); + TEST_ASSERT_EQUAL_MESSAGE(ESP_OK, ret, "I2C install returned error"); +} + +static void i2c_bus_deinit(void) +{ + esp_err_t ret = i2c_del_master_bus(i2c_handle); + TEST_ASSERT_EQUAL_MESSAGE(ESP_OK, ret, "I2C uninstall returned error"); +} + +static void i2c_dev_ch422g_init(void) +{ + esp_err_t ret = esp_io_expander_new_i2c_ch422g(i2c_handle, &io_expander); + TEST_ASSERT_EQUAL_MESSAGE(ESP_OK, ret, "CH422G create returned error"); +} + +static void i2c_dev_ch422g_deinit(void) +{ + esp_err_t ret = esp_io_expander_del(io_expander); + TEST_ASSERT_EQUAL_MESSAGE(ESP_OK, ret, "CH422G delete returned error"); +} + +TEST_CASE("IO expander ch422g test", "[ch422g]") +{ + i2c_bus_init(); + i2c_dev_ch422g_init(); + + esp_err_t ret; + /* Test output level function */ + ret = esp_io_expander_set_dir(io_expander, TEST_OUTPUT_PINS, IO_EXPANDER_OUTPUT); + TEST_ASSERT_EQUAL(ESP_OK, ret); + // Print state + ret = esp_io_expander_print_state(io_expander); + TEST_ASSERT_EQUAL(ESP_OK, ret); + for (int i = 0; i < TEST_LOOP_CNT; i++) { + // Set level to 0 + ESP_LOGI(TAG, "Set level to 0"); + ret = esp_io_expander_set_level(io_expander, TEST_OUTPUT_PINS, 0); + TEST_ASSERT_EQUAL(ESP_OK, ret); + vTaskDelay(pdMS_TO_TICKS(TEST_LOOP_DELAY_MS / 2)); + // Set level to 1 + ESP_LOGI(TAG, "Set level to 1"); + ret = esp_io_expander_set_level(io_expander, TEST_OUTPUT_PINS, 1); + TEST_ASSERT_EQUAL(ESP_OK, ret); + vTaskDelay(pdMS_TO_TICKS(TEST_LOOP_DELAY_MS / 2)); + } + + i2c_dev_ch422g_deinit(); + i2c_bus_deinit(); + vTaskDelay(10); // Give FreeRTOS some time to free its resources +} + +#define TEST_MEMORY_LEAK_THRESHOLD (500) + +void setUp(void) +{ + unity_utils_set_leak_level(TEST_MEMORY_LEAK_THRESHOLD); + unity_utils_record_free_mem(); +} + +void tearDown(void) +{ + unity_utils_evaluate_leaks(); +} + +void app_main(void) +{ + /** + * ______ __ __ __ __ ______ ______ ______ + * / \ | \ | \| \ | \ / \ / \ / \ + *| $$$$$$\| $$ | $$| $$ | $$| $$$$$$\| $$$$$$\| $$$$$$\ + *| $$ \$$| $$__| $$| $$__| $$ \$$__| $$ \$$__| $$| $$ __\$$ + *| $$ | $$ $$| $$ $$ / $$ / $$| $$| \ + *| $$ __ | $$$$$$$$ \$$$$$$$$| $$$$$$ | $$$$$$ | $$ \$$$$ + *| $$__/ \| $$ | $$ | $$| $$_____ | $$_____ | $$__| $$ + * \$$ $$| $$ | $$ | $$| $$ \| $$ \ \$$ $$ + * \$$$$$$ \$$ \$$ \$$ \$$$$$$$$ \$$$$$$$$ \$$$$$$ + * + */ + printf(" ______ __ __ __ __ ______ ______ ______\r\n"); + printf(" / \\ | \\ | \\| \\ | \\ / \\ / \\ / \\\r\n"); + printf("| $$$$$$\\| $$ | $$| $$ | $$| $$$$$$\\| $$$$$$\\| $$$$$$\\\r\n"); + printf("| $$ \\$$| $$__| $$| $$__| $$ \\$$__| $$ \\$$__| $$| $$ __\\$$\r\n"); + printf("| $$ | $$ $$| $$ $$ / $$ / $$| $$| \\\r\n"); + printf("| $$ __ | $$$$$$$$ \\$$$$$$$$| $$$$$$ | $$$$$$ | $$ \\$$$$\r\n"); + printf("| $$__/ \\| $$ | $$ | $$| $$_____ | $$_____ | $$__| $$\r\n"); + printf(" \\$$ $$| $$ | $$ | $$| $$ \\| $$ \\ \\$$ $$\r\n"); + printf(" \\$$$$$$ \\$$ \\$$ \\$$ \\$$$$$$$$ \\$$$$$$$$ \\$$$$$$\r\n"); + unity_run_menu(); +} diff --git a/components/io_expander/esp_io_expander_ch422g/test_apps/sdkconfig.defaults b/components/io_expander/esp_io_expander_ch422g/test_apps/sdkconfig.defaults new file mode 100644 index 000000000..521790c36 --- /dev/null +++ b/components/io_expander/esp_io_expander_ch422g/test_apps/sdkconfig.defaults @@ -0,0 +1,3 @@ +CONFIG_ESP_TASK_WDT_EN=n +CONFIG_FREERTOS_HZ=1000 +CONFIG_FREERTOS_TIMER_TASK_STACK_DEPTH=4096