diff --git a/.github/workflows/upload_component.yml b/.github/workflows/upload_component.yml index 15b470576..ae8f38965 100644 --- a/.github/workflows/upload_component.yml +++ b/.github/workflows/upload_component.yml @@ -50,6 +50,7 @@ jobs: components/display/tools/esp_lv_fs; components/display/tools/esp_mmap_assets; components/elf_loader; + components/expander/io_expander/mcp23017; components/extended_vfs; components/gprof; components/i2c_bus; diff --git a/.gitlab/ci/build.yml b/.gitlab/ci/build.yml index 50fc505d8..2c1d14dfa 100644 --- a/.gitlab/ci/build.yml +++ b/.gitlab/ci/build.yml @@ -1169,6 +1169,14 @@ build_components_display_tools_esp_mmap_assets_test_apps: variables: EXAMPLE_DIR: components/display/tools/esp_mmap_assets/test_apps +build_components_expander_io_expander_mcp23017_test_apps: + extends: + - .build_examples_template + - .rules:build:components_expander_io_expander_mcp23017_test_apps + - .build_idf_active_release_version + variables: + EXAMPLE_DIR: components/expander/io_expander/mcp23017/test_apps + build_components_keyboard_button_test_apps: extends: - .build_examples_template diff --git a/.gitlab/ci/rules.yml b/.gitlab/ci/rules.yml index 1076c058a..799b2ddc5 100644 --- a/.gitlab/ci/rules.yml +++ b/.gitlab/ci/rules.yml @@ -150,6 +150,7 @@ .patterns-components_expander_io_expander_mcp23017: &patterns-components_expander_io_expander_mcp23017 - "components/expander/io_expander/mcp23017/**/*" + - "tools/cmake_utilities/package_manager.cmake" .patterns-components_extended_vfs: &patterns-components_extended_vfs - "components/extended_vfs/**/*" @@ -1894,7 +1895,7 @@ - <<: *if-dev-push changes: *patterns-components_keyboard_button -.rules:build:components_expander_io_expander_mcp23017_test: +.rules:build:components_expander_io_expander_mcp23017_test_apps: rules: - <<: *if-protected - <<: *if-label-build diff --git a/README.md b/README.md index e5de36e80..1937c176b 100644 --- a/README.md +++ b/README.md @@ -113,6 +113,7 @@ The registered components in ESP-IoT-Solution are listed below: | [led_indicator](https://components.espressif.com/components/espressif/led_indicator) | [![Component Registry](https://components.espressif.com/components/espressif/led_indicator/badge.svg)](https://components.espressif.com/components/espressif/led_indicator) | | [lightbulb_driver](https://components.espressif.com/components/espressif/lightbulb_driver) | [![Component Registry](https://components.espressif.com/components/espressif/lightbulb_driver/badge.svg)](https://components.espressif.com/components/espressif/lightbulb_driver) | | [lis2dh12](https://components.espressif.com/components/espressif/lis2dh12) | [![Component Registry](https://components.espressif.com/components/espressif/lis2dh12/badge.svg)](https://components.espressif.com/components/espressif/lis2dh12) | +| [mcp23017](https://components.espressif.com/components/espressif/mcp23017) | [![Component Registry](https://components.espressif.com/components/espressif/mcp23017/badge.svg)](https://components.espressif.com/components/espressif/mcp23017) | | [mvh3004d](https://components.espressif.com/components/espressif/mvh3004d) | [![Component Registry](https://components.espressif.com/components/espressif/mvh3004d/badge.svg)](https://components.espressif.com/components/espressif/mvh3004d) | | [ntc_driver](https://components.espressif.com/components/espressif/ntc_driver) | [![Component Registry](https://components.espressif.com/components/espressif/ntc_driver/badge.svg)](https://components.espressif.com/components/espressif/ntc_driver) | | [openai](https://components.espressif.com/components/espressif/openai) | [![Component Registry](https://components.espressif.com/components/espressif/openai/badge.svg)](https://components.espressif.com/components/espressif/openai) | diff --git a/README_CN.md b/README_CN.md index 2b617c2ae..2551f2f6e 100644 --- a/README_CN.md +++ b/README_CN.md @@ -113,6 +113,7 @@ ESP-IoT-Solution 中注册的组件如下: | [led_indicator](https://components.espressif.com/components/espressif/led_indicator) | [![Component Registry](https://components.espressif.com/components/espressif/led_indicator/badge.svg)](https://components.espressif.com/components/espressif/led_indicator) | | [lightbulb_driver](https://components.espressif.com/components/espressif/lightbulb_driver) | [![Component Registry](https://components.espressif.com/components/espressif/lightbulb_driver/badge.svg)](https://components.espressif.com/components/espressif/lightbulb_driver) | | [lis2dh12](https://components.espressif.com/components/espressif/lis2dh12) | [![Component Registry](https://components.espressif.com/components/espressif/lis2dh12/badge.svg)](https://components.espressif.com/components/espressif/lis2dh12) | +| [mcp23017](https://components.espressif.com/components/espressif/mcp23017) | [![Component Registry](https://components.espressif.com/components/espressif/mcp23017/badge.svg)](https://components.espressif.com/components/espressif/mcp23017) | | [mvh3004d](https://components.espressif.com/components/espressif/mvh3004d) | [![Component Registry](https://components.espressif.com/components/espressif/mvh3004d/badge.svg)](https://components.espressif.com/components/espressif/mvh3004d) | | [ntc_driver](https://components.espressif.com/components/espressif/ntc_driver) | [![Component Registry](https://components.espressif.com/components/espressif/ntc_driver/badge.svg)](https://components.espressif.com/components/espressif/ntc_driver) | | [openai](https://components.espressif.com/components/espressif/openai) | [![Component Registry](https://components.espressif.com/components/espressif/openai/badge.svg)](https://components.espressif.com/components/espressif/openai) | diff --git a/components/.build-rules.yml b/components/.build-rules.yml index 568c9c0b0..7ff2cd3a7 100644 --- a/components/.build-rules.yml +++ b/components/.build-rules.yml @@ -155,6 +155,10 @@ components/display/tools/esp_lv_decoder/test_apps: - if: IDF_TARGET in ["esp32","esp32s2","esp32s3"] and (IDF_VERSION_MAJOR == 5 and IDF_VERSION_MINOR == 0) - if: IDF_TARGET in ["esp32","esp32s2","esp32s3","esp32c3","esp32c6", "esp32p4"] and (IDF_VERSION_MAJOR == 5 and IDF_VERSION_MINOR == 1) +components/expander/io_expander/mcp23017/test_apps: + enable: + - if: INCLUDE_DEFAULT == 1 + components/keyboard_button/test_apps: enable: - if: INCLUDE_DEFAULT == 1 diff --git a/components/expander/io_expander/mcp23017/CHANGELOG.md b/components/expander/io_expander/mcp23017/CHANGELOG.md new file mode 100644 index 000000000..b1cf02dc3 --- /dev/null +++ b/components/expander/io_expander/mcp23017/CHANGELOG.md @@ -0,0 +1,7 @@ +# ChangeLog + +## v0.1.0 - 2025-1-6 + +### Enhancements: + +* Initial version. \ No newline at end of file diff --git a/components/expander/io_expander/mcp23017/CMakeLists.txt b/components/expander/io_expander/mcp23017/CMakeLists.txt index 1be2f798b..0d49126e0 100644 --- a/components/expander/io_expander/mcp23017/CMakeLists.txt +++ b/components/expander/io_expander/mcp23017/CMakeLists.txt @@ -1,3 +1,5 @@ idf_component_register(SRCS "mcp23017.c" - INCLUDE_DIRS include - REQUIRES i2c_bus) + INCLUDE_DIRS include) + +include(package_manager) +cu_pkg_define_version(${CMAKE_CURRENT_LIST_DIR}) diff --git a/components/expander/io_expander/mcp23017/idf_component.yml b/components/expander/io_expander/mcp23017/idf_component.yml new file mode 100644 index 000000000..b47841b2b --- /dev/null +++ b/components/expander/io_expander/mcp23017/idf_component.yml @@ -0,0 +1,14 @@ +version: "0.1.0" +description: MCP23017 I/O Expander Driver +url: https://github.com/espressif/esp-iot-solution/tree/master/components/expander/io_expander/mcp23017 +repository: https://github.com/espressif/esp-iot-solution.git +documentation: https://docs.espressif.com/projects/esp-iot-solution/en/latest/others/io_expander.html +issues: https://github.com/espressif/esp-iot-solution/issues + +dependencies: + espressif/i2c_bus: "1.1.*" + idf: ">=4.0" + cmake_utilities: "0.*" +sbom: + supplier: 'Organization: Espressif Systems (Shanghai) CO LTD' + originator: 'Organization: Espressif Systems (Shanghai) CO LTD' diff --git a/components/expander/io_expander/mcp23017/license.txt b/components/expander/io_expander/mcp23017/license.txt new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/components/expander/io_expander/mcp23017/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/expander/io_expander/mcp23017/mcp23017.c b/components/expander/io_expander/mcp23017/mcp23017.c index 0129e78f0..eafade0cc 100644 --- a/components/expander/io_expander/mcp23017/mcp23017.c +++ b/components/expander/io_expander/mcp23017/mcp23017.c @@ -143,7 +143,7 @@ esp_err_t mcp23017_read(mcp23017_handle_t dev, uint8_t reg_start_addr, esp_err_t mcp23017_set_pullup(mcp23017_handle_t dev, uint16_t pins) { uint8_t data[] = { MCP23017_PORT_A_BYTE(pins), MCP23017_PORT_B_BYTE(pins) }; - return mcp23017_write(dev, MCP23017_REG_GPIOA, sizeof(data), data); //set REG_GPIOA(); REG_GPIOB(); + return mcp23017_write(dev, MCP23017_REG_GPPUA, sizeof(data), data); //set REG_GPPUA(); REG_GPPUB(); } esp_err_t mcp23017_interrupt_en(mcp23017_handle_t dev, uint16_t pins, diff --git a/components/expander/io_expander/mcp23017/test/CMakeLists.txt b/components/expander/io_expander/mcp23017/test/CMakeLists.txt deleted file mode 100644 index f375b9040..000000000 --- a/components/expander/io_expander/mcp23017/test/CMakeLists.txt +++ /dev/null @@ -1,3 +0,0 @@ -idf_component_register(SRCS "mcp23017_test.c" - INCLUDE_DIRS . - REQUIRES unity bus mcp23017) diff --git a/components/expander/io_expander/mcp23017/test_apps/CMakeLists.txt b/components/expander/io_expander/mcp23017/test_apps/CMakeLists.txt new file mode 100644 index 000000000..8f1207c7c --- /dev/null +++ b/components/expander/io_expander/mcp23017/test_apps/CMakeLists.txt @@ -0,0 +1,8 @@ +# 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(EXTRA_COMPONENT_DIRS "$ENV{IDF_PATH}/tools/unit-test-app/components") + +include($ENV{IDF_PATH}/tools/cmake/project.cmake) +project(mcp23017_test) diff --git a/components/expander/io_expander/mcp23017/test_apps/main/CMakeLists.txt b/components/expander/io_expander/mcp23017/test_apps/main/CMakeLists.txt new file mode 100644 index 000000000..ec40829d7 --- /dev/null +++ b/components/expander/io_expander/mcp23017/test_apps/main/CMakeLists.txt @@ -0,0 +1,2 @@ +idf_component_register(SRC_DIRS "." + PRIV_INCLUDE_DIRS ".") diff --git a/components/expander/io_expander/mcp23017/test_apps/main/idf_component.yml b/components/expander/io_expander/mcp23017/test_apps/main/idf_component.yml new file mode 100644 index 000000000..e5d801fab --- /dev/null +++ b/components/expander/io_expander/mcp23017/test_apps/main/idf_component.yml @@ -0,0 +1,4 @@ +dependencies: + mcp23017: + version: "*" + override_path: "../../../mcp23017" diff --git a/components/expander/io_expander/mcp23017/test/mcp23017_test.c b/components/expander/io_expander/mcp23017/test_apps/main/mcp23017_test.c similarity index 64% rename from components/expander/io_expander/mcp23017/test/mcp23017_test.c rename to components/expander/io_expander/mcp23017/test_apps/main/mcp23017_test.c index 819aa019b..be45c9d8a 100644 --- a/components/expander/io_expander/mcp23017/test/mcp23017_test.c +++ b/components/expander/io_expander/mcp23017/test_apps/main/mcp23017_test.c @@ -5,18 +5,22 @@ */ #include +#include "freertos/FreeRTOS.h" +#include "freertos/task.h" #include "unity.h" #include "mcp23017.h" #include "i2c_bus.h" #include "esp_log.h" -#define I2C_MASTER_SCL_IO 21 /*!< gpio number for I2C master clock IO21*/ -#define I2C_MASTER_SDA_IO 22 /*!< gpio number for I2C master data IO15*/ -#define I2C_MASTER_NUM I2C_NUM_1 /*!< I2C port number for master dev */ +#define I2C_MASTER_SCL_IO 1 /*!< gpio number for I2C master clock IO1*/ +#define I2C_MASTER_SDA_IO 2 /*!< gpio number for I2C master data IO2*/ +#define I2C_MASTER_NUM I2C_NUM_0 /*!< I2C port number for master dev */ #define I2C_MASTER_TX_BUF_DISABLE 0 /*!< I2C master do not need buffer */ #define I2C_MASTER_RX_BUF_DISABLE 0 /*!< I2C master do not need buffer */ #define I2C_MASTER_FREQ_HZ 100000 /*!< I2C master clock frequency */ +#define TEST_MEMORY_LEAK_THRESHOLD (-400) + static i2c_bus_handle_t i2c_bus = NULL; static mcp23017_handle_t device = NULL; @@ -73,3 +77,33 @@ TEST_CASE("Device mcp23017 test, connect A-B port together", "[mcp23017][iot][de mcp23017_test_read_write(); mcp23017_test_deinit(); } + +static size_t before_free_8bit; +static size_t before_free_32bit; + +static void check_leak(size_t before_free, size_t after_free, const char *type) +{ + ssize_t delta = after_free - before_free; + printf("MALLOC_CAP_%s: Before %u bytes free, After %u bytes free (delta %d)\n", type, before_free, after_free, delta); + TEST_ASSERT_MESSAGE(delta >= TEST_MEMORY_LEAK_THRESHOLD, "memory leak"); +} + +void setUp(void) +{ + before_free_8bit = heap_caps_get_free_size(MALLOC_CAP_8BIT); + before_free_32bit = heap_caps_get_free_size(MALLOC_CAP_32BIT); +} + +void tearDown(void) +{ + size_t after_free_8bit = heap_caps_get_free_size(MALLOC_CAP_8BIT); + size_t after_free_32bit = heap_caps_get_free_size(MALLOC_CAP_32BIT); + check_leak(before_free_8bit, after_free_8bit, "8BIT"); + check_leak(before_free_32bit, after_free_32bit, "32BIT"); +} + +void app_main(void) +{ + printf("MCP23017 TEST \n"); + unity_run_menu(); +} diff --git a/components/expander/io_expander/mcp23017/test_apps/sdkconfig.defaults b/components/expander/io_expander/mcp23017/test_apps/sdkconfig.defaults new file mode 100644 index 000000000..3778471bc --- /dev/null +++ b/components/expander/io_expander/mcp23017/test_apps/sdkconfig.defaults @@ -0,0 +1,9 @@ +# For IDF 5.0 +CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ_240=y +CONFIG_FREERTOS_HZ=1000 +CONFIG_ESP_TASK_WDT_EN=n + +# For IDF4.4 +CONFIG_ESP32S2_DEFAULT_CPU_FREQ_240=y +CONFIG_ESP32S3_DEFAULT_CPU_FREQ_240=y +CONFIG_ESP_TASK_WDT=n