From 41c5f4843b0af3f5531193ffc7def7fd8aee82d7 Mon Sep 17 00:00:00 2001 From: Ken Van Hoeylandt Date: Wed, 15 Jul 2026 08:33:39 +0200 Subject: [PATCH] Crowpanel Advance converted + TCA9534 driver --- .../CMakeLists.txt | 6 +- .../Source/Configuration.cpp | 32 --- .../Source/devices/Display.cpp | 106 ---------- .../Source/devices/Display.h | 5 - .../device.properties | 2 + .../devicetree.yaml | 3 + .../elecrow,crowpanel-advance-50.dts | 64 +++++- .../{Source => source}/module.cpp | 2 - Drivers/tca9534-module/CMakeLists.txt | 11 + Drivers/tca9534-module/LICENSE-Apache-2.0.md | 195 ++++++++++++++++++ Drivers/tca9534-module/README.md | 7 + .../tca9534-module/bindings/ti,tca9534.yaml | 5 + Drivers/tca9534-module/devicetree.yaml | 3 + .../tca9534-module/include/bindings/tca9534.h | 15 ++ .../tca9534-module/include/drivers/tca9534.h | 17 ++ .../tca9534-module/include/tca9534_module.h | 14 ++ Drivers/tca9534-module/source/module.cpp | 32 +++ Drivers/tca9534-module/source/tca9534.cpp | 169 +++++++++++++++ 18 files changed, 539 insertions(+), 149 deletions(-) delete mode 100644 Devices/elecrow-crowpanel-advance-50/Source/Configuration.cpp delete mode 100644 Devices/elecrow-crowpanel-advance-50/Source/devices/Display.cpp delete mode 100644 Devices/elecrow-crowpanel-advance-50/Source/devices/Display.h rename Devices/elecrow-crowpanel-advance-50/{Source => source}/module.cpp (88%) create mode 100644 Drivers/tca9534-module/CMakeLists.txt create mode 100644 Drivers/tca9534-module/LICENSE-Apache-2.0.md create mode 100644 Drivers/tca9534-module/README.md create mode 100644 Drivers/tca9534-module/bindings/ti,tca9534.yaml create mode 100644 Drivers/tca9534-module/devicetree.yaml create mode 100644 Drivers/tca9534-module/include/bindings/tca9534.h create mode 100644 Drivers/tca9534-module/include/drivers/tca9534.h create mode 100644 Drivers/tca9534-module/include/tca9534_module.h create mode 100644 Drivers/tca9534-module/source/module.cpp create mode 100644 Drivers/tca9534-module/source/tca9534.cpp diff --git a/Devices/elecrow-crowpanel-advance-50/CMakeLists.txt b/Devices/elecrow-crowpanel-advance-50/CMakeLists.txt index b414f6551..b82863775 100644 --- a/Devices/elecrow-crowpanel-advance-50/CMakeLists.txt +++ b/Devices/elecrow-crowpanel-advance-50/CMakeLists.txt @@ -1,7 +1,7 @@ -file(GLOB_RECURSE SOURCE_FILES Source/*.c*) +file(GLOB_RECURSE SOURCE_FILES source/*.c*) idf_component_register( SRCS ${SOURCE_FILES} - INCLUDE_DIRS "Source" - REQUIRES Tactility esp_lvgl_port RgbDisplay GT911 TCA9534 driver + INCLUDE_DIRS "source" + REQUIRES Tactility ) diff --git a/Devices/elecrow-crowpanel-advance-50/Source/Configuration.cpp b/Devices/elecrow-crowpanel-advance-50/Source/Configuration.cpp deleted file mode 100644 index 42d3e88a3..000000000 --- a/Devices/elecrow-crowpanel-advance-50/Source/Configuration.cpp +++ /dev/null @@ -1,32 +0,0 @@ -#include "devices/Display.h" - -#include -#include - -using namespace tt::hal; - -static bool initBoot() { - TCA9534_IO_EXP io_expander = { - .I2C_ADDR = 0x18, - .i2c_master_port = I2C_NUM_0, - .interrupt_pin = GPIO_NUM_NC, - .interrupt_task = nullptr - }; - - // Enable LCD backlight - set_tca9534_io_pin_direction(&io_expander, TCA9534_IO1, TCA9534_OUTPUT); - set_tca9534_io_pin_output_state(&io_expander, TCA9534_IO1, 255); - - return true; -} - -static DeviceVector createDevices() { - return { - createDisplay(), - }; -} - -extern const Configuration hardwareConfiguration = { - .initBoot = initBoot, - .createDevices = createDevices -}; diff --git a/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.cpp b/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.cpp deleted file mode 100644 index 26f9bdc78..000000000 --- a/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.cpp +++ /dev/null @@ -1,106 +0,0 @@ -#include "Display.h" - -#include -#include -#include -#include - -std::shared_ptr createTouch() { - // Note for future changes: Reset pin is 38 and interrupt pin is 18 - // or INT = NC, schematic and other info floating around is kinda conflicting... - auto* i2c = device_find_by_name("i2c0"); - check(i2c); - auto configuration = std::make_unique( - i2c, - 800, - 480 - ); - - return std::make_shared(std::move(configuration)); -} - -std::shared_ptr createDisplay() { - auto touch = createTouch(); - - constexpr uint32_t bufferPixels = 800 * 10; - - esp_lcd_rgb_panel_config_t rgb_panel_config = { - .clk_src = LCD_CLK_SRC_DEFAULT, - .timings = { - .pclk_hz = 15000000, // TODO: 21 MHz was too much and caused drift when opening wifi/SD/apps. Try something inbetween 15 and 21 MHz. - .h_res = 800, - .v_res = 480, - .hsync_pulse_width = 4, - .hsync_back_porch = 8, - .hsync_front_porch = 8, - .vsync_pulse_width = 4, - .vsync_back_porch = 8, - .vsync_front_porch = 8, - .flags = { - .hsync_idle_low = false, - .vsync_idle_low = false, - .de_idle_high = false, - .pclk_active_neg = true, - .pclk_idle_high = false - } - }, - .data_width = 16, - .bits_per_pixel = 0, - .num_fbs = 2, - .bounce_buffer_size_px = bufferPixels, - .sram_trans_align = 8, - .psram_trans_align = 64, - .hsync_gpio_num = GPIO_NUM_40, - .vsync_gpio_num = GPIO_NUM_41, - .de_gpio_num = GPIO_NUM_42 , - .pclk_gpio_num = GPIO_NUM_39, - .disp_gpio_num = GPIO_NUM_NC, - .data_gpio_nums = { - GPIO_NUM_21, // B3 - GPIO_NUM_47, // B4 - GPIO_NUM_48, // B5 - GPIO_NUM_45, // B6 - GPIO_NUM_38, // B7 - GPIO_NUM_9, // G2 - GPIO_NUM_10, // G3 - GPIO_NUM_11, // G4 - GPIO_NUM_12, // G5 - GPIO_NUM_13, // G6 - GPIO_NUM_14, // G7 - GPIO_NUM_7, // R3 - GPIO_NUM_17, // R4 - GPIO_NUM_18, // R5 - GPIO_NUM_3, // R6 - GPIO_NUM_46, // R7 - }, - .flags = { - .disp_active_low = false, - .refresh_on_demand = false, - .fb_in_psram = true, - .double_fb = true, - .no_fb = false, - .bb_invalidate_cache = false - } - }; - - RgbDisplay::BufferConfiguration buffer_config = { - .size = (800 * 480), - .useSpi = true, - .doubleBuffer = true, - .bounceBufferMode = true, - .avoidTearing = false - }; - - auto configuration = std::make_unique( - rgb_panel_config, - buffer_config, - touch, - LV_COLOR_FORMAT_RGB565, - false, - false, - false, - false - ); - - return std::make_shared(std::move(configuration)); -} diff --git a/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.h b/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.h deleted file mode 100644 index 7a9b967d1..000000000 --- a/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.h +++ /dev/null @@ -1,5 +0,0 @@ -#pragma once - -#include - -std::shared_ptr createDisplay(); diff --git a/Devices/elecrow-crowpanel-advance-50/device.properties b/Devices/elecrow-crowpanel-advance-50/device.properties index 9fa787d6a..8ef94df07 100644 --- a/Devices/elecrow-crowpanel-advance-50/device.properties +++ b/Devices/elecrow-crowpanel-advance-50/device.properties @@ -12,6 +12,8 @@ hardware.tinyUsb=true hardware.esptoolFlashFreq=120M hardware.bluetooth=true +dependencies.useDeprecatedHal=false + storage.userDataLocation=SD display.size=5" diff --git a/Devices/elecrow-crowpanel-advance-50/devicetree.yaml b/Devices/elecrow-crowpanel-advance-50/devicetree.yaml index 23c65cc58..0273223b0 100644 --- a/Devices/elecrow-crowpanel-advance-50/devicetree.yaml +++ b/Devices/elecrow-crowpanel-advance-50/devicetree.yaml @@ -1,3 +1,6 @@ dependencies: - Platforms/platform-esp32 + - Drivers/rgb-display-module + - Drivers/gt911-module + - Drivers/tca9534-module dts: elecrow,crowpanel-advance-50.dts diff --git a/Devices/elecrow-crowpanel-advance-50/elecrow,crowpanel-advance-50.dts b/Devices/elecrow-crowpanel-advance-50/elecrow,crowpanel-advance-50.dts index 7024ca43f..0be96a1ea 100644 --- a/Devices/elecrow-crowpanel-advance-50/elecrow,crowpanel-advance-50.dts +++ b/Devices/elecrow-crowpanel-advance-50/elecrow,crowpanel-advance-50.dts @@ -8,6 +8,10 @@ #include #include #include +#include +#include +#include +#include / { compatible = "root"; @@ -34,6 +38,21 @@ clock-frequency = <400000>; pin-sda = <&gpio0 15 GPIO_FLAG_NONE>; pin-scl = <&gpio0 16 GPIO_FLAG_NONE>; + + io_expander0 { + compatible = "ti,tca9534"; + reg = <0x18>; + }; + + touch0 { + // Reset pin 38 and interrupt pin 18 (or INT = NC) exist on the board but are not + // wired up here - conflicting schematic info, unverified (matches the original + // deprecated-HAL config). + compatible = "goodix,gt911"; + reg = <0x5D>; + x-max = <800>; + y-max = <480>; + }; }; spi0 { @@ -43,13 +62,56 @@ pin-mosi = <&gpio0 6 GPIO_FLAG_NONE>; pin-miso = <&gpio0 4 GPIO_FLAG_NONE>; pin-sclk = <&gpio0 5 GPIO_FLAG_NONE>; - + sdcard@0 { compatible = "espressif,esp32-sdspi"; frequency-khz = <20000>; }; }; + display_backlight { + compatible = "espressif,esp32-gpio-backlight"; + pin-backlight = <&io_expander0 1 GPIO_FLAG_NONE>; + }; + + display0 { + compatible = "espressif,esp32-rgb-display"; + horizontal-resolution = <800>; + vertical-resolution = <480>; + pixel-clock-hz = <15000000>; + hsync-pulse-width = <4>; + hsync-back-porch = <8>; + hsync-front-porch = <8>; + vsync-pulse-width = <4>; + vsync-back-porch = <8>; + vsync-front-porch = <8>; + pclk-active-neg; + num-fbs = <2>; + double-fb; + bounce-buffer-size-px = <8000>; + pin-hsync = <&gpio0 40 GPIO_FLAG_NONE>; + pin-vsync = <&gpio0 41 GPIO_FLAG_NONE>; + pin-de = <&gpio0 42 GPIO_FLAG_NONE>; + pin-pclk = <&gpio0 39 GPIO_FLAG_NONE>; + pin-data0 = <&gpio0 21 GPIO_FLAG_NONE>; // B3 + pin-data1 = <&gpio0 47 GPIO_FLAG_NONE>; // B4 + pin-data2 = <&gpio0 48 GPIO_FLAG_NONE>; // B5 + pin-data3 = <&gpio0 45 GPIO_FLAG_NONE>; // B6 + pin-data4 = <&gpio0 38 GPIO_FLAG_NONE>; // B7 + pin-data5 = <&gpio0 9 GPIO_FLAG_NONE>; // G2 + pin-data6 = <&gpio0 10 GPIO_FLAG_NONE>; // G3 + pin-data7 = <&gpio0 11 GPIO_FLAG_NONE>; // G4 + pin-data8 = <&gpio0 12 GPIO_FLAG_NONE>; // G5 + pin-data9 = <&gpio0 13 GPIO_FLAG_NONE>; // G6 + pin-data10 = <&gpio0 14 GPIO_FLAG_NONE>; // G7 + pin-data11 = <&gpio0 7 GPIO_FLAG_NONE>; // R3 + pin-data12 = <&gpio0 17 GPIO_FLAG_NONE>; // R4 + pin-data13 = <&gpio0 18 GPIO_FLAG_NONE>; // R5 + pin-data14 = <&gpio0 3 GPIO_FLAG_NONE>; // R6 + pin-data15 = <&gpio0 46 GPIO_FLAG_NONE>; // R7 + backlight = <&display_backlight>; + }; + uart0 { compatible = "espressif,esp32-uart"; port = ; diff --git a/Devices/elecrow-crowpanel-advance-50/Source/module.cpp b/Devices/elecrow-crowpanel-advance-50/source/module.cpp similarity index 88% rename from Devices/elecrow-crowpanel-advance-50/Source/module.cpp rename to Devices/elecrow-crowpanel-advance-50/source/module.cpp index e89e37654..392ea2e54 100644 --- a/Devices/elecrow-crowpanel-advance-50/Source/module.cpp +++ b/Devices/elecrow-crowpanel-advance-50/source/module.cpp @@ -3,12 +3,10 @@ extern "C" { static error_t start() { - // Empty for now return ERROR_NONE; } static error_t stop() { - // Empty for now return ERROR_NONE; } diff --git a/Drivers/tca9534-module/CMakeLists.txt b/Drivers/tca9534-module/CMakeLists.txt new file mode 100644 index 000000000..515c8f20d --- /dev/null +++ b/Drivers/tca9534-module/CMakeLists.txt @@ -0,0 +1,11 @@ +cmake_minimum_required(VERSION 3.20) + +include("${CMAKE_CURRENT_LIST_DIR}/../../Buildscripts/module.cmake") + +file(GLOB_RECURSE SOURCE_FILES "source/*.c*") + +tactility_add_module(tca9534-module + SRCS ${SOURCE_FILES} + INCLUDE_DIRS include/ + REQUIRES TactilityKernel +) diff --git a/Drivers/tca9534-module/LICENSE-Apache-2.0.md b/Drivers/tca9534-module/LICENSE-Apache-2.0.md new file mode 100644 index 000000000..f5f4b8b5e --- /dev/null +++ b/Drivers/tca9534-module/LICENSE-Apache-2.0.md @@ -0,0 +1,195 @@ +Apache License +============== + +_Version 2.0, January 2004_ +_<>_ + +### 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/Drivers/tca9534-module/README.md b/Drivers/tca9534-module/README.md new file mode 100644 index 000000000..4e02fd5cb --- /dev/null +++ b/Drivers/tca9534-module/README.md @@ -0,0 +1,7 @@ +# TCA9534 I/O expander + +A driver for the `TCA9534` 8-bit I2C-bus I/O expander by Texas Instruments. + +See https://www.ti.com/product/TCA9534 + +License: [Apache v2.0](LICENSE-Apache-2.0.md) diff --git a/Drivers/tca9534-module/bindings/ti,tca9534.yaml b/Drivers/tca9534-module/bindings/ti,tca9534.yaml new file mode 100644 index 000000000..eae87c4bd --- /dev/null +++ b/Drivers/tca9534-module/bindings/ti,tca9534.yaml @@ -0,0 +1,5 @@ +description: TI TCA9534 8-bit I2C-bus I/O expander + +include: ["i2c-device.yaml"] + +compatible: "ti,tca9534" diff --git a/Drivers/tca9534-module/devicetree.yaml b/Drivers/tca9534-module/devicetree.yaml new file mode 100644 index 000000000..a07d6f334 --- /dev/null +++ b/Drivers/tca9534-module/devicetree.yaml @@ -0,0 +1,3 @@ +dependencies: + - TactilityKernel +bindings: bindings diff --git a/Drivers/tca9534-module/include/bindings/tca9534.h b/Drivers/tca9534-module/include/bindings/tca9534.h new file mode 100644 index 000000000..d22236059 --- /dev/null +++ b/Drivers/tca9534-module/include/bindings/tca9534.h @@ -0,0 +1,15 @@ +// SPDX-License-Identifier: Apache-2.0 +#pragma once + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +DEFINE_DEVICETREE(tca9534, struct Tca9534Config) + +#ifdef __cplusplus +} +#endif diff --git a/Drivers/tca9534-module/include/drivers/tca9534.h b/Drivers/tca9534-module/include/drivers/tca9534.h new file mode 100644 index 000000000..5fc1ccf20 --- /dev/null +++ b/Drivers/tca9534-module/include/drivers/tca9534.h @@ -0,0 +1,17 @@ +// SPDX-License-Identifier: Apache-2.0 +#pragma once + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +struct Tca9534Config { + /** Address on bus */ + uint8_t address; +}; + +#ifdef __cplusplus +} +#endif diff --git a/Drivers/tca9534-module/include/tca9534_module.h b/Drivers/tca9534-module/include/tca9534_module.h new file mode 100644 index 000000000..602807c19 --- /dev/null +++ b/Drivers/tca9534-module/include/tca9534_module.h @@ -0,0 +1,14 @@ +// SPDX-License-Identifier: Apache-2.0 +#pragma once + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +extern struct Module tca9534_module; + +#ifdef __cplusplus +} +#endif diff --git a/Drivers/tca9534-module/source/module.cpp b/Drivers/tca9534-module/source/module.cpp new file mode 100644 index 000000000..96f43aa56 --- /dev/null +++ b/Drivers/tca9534-module/source/module.cpp @@ -0,0 +1,32 @@ +// SPDX-License-Identifier: Apache-2.0 +#include +#include +#include + +extern "C" { + +extern Driver tca9534_driver; + +static error_t start() { + /* We crash when construct fails, because if a single driver fails to construct, + * there is no guarantee that the previously constructed drivers can be destroyed */ + check(driver_construct_add(&tca9534_driver) == ERROR_NONE); + return ERROR_NONE; +} + +static error_t stop() { + /* We crash when destruct fails, because if a single driver fails to destruct, + * there is no guarantee that the previously destroyed drivers can be recovered */ + check(driver_remove_destruct(&tca9534_driver) == ERROR_NONE); + return ERROR_NONE; +} + +Module tca9534_module = { + .name = "tca9534", + .start = start, + .stop = stop, + .symbols = nullptr, + .internal = nullptr +}; + +} diff --git a/Drivers/tca9534-module/source/tca9534.cpp b/Drivers/tca9534-module/source/tca9534.cpp new file mode 100644 index 000000000..3fc5eb97c --- /dev/null +++ b/Drivers/tca9534-module/source/tca9534.cpp @@ -0,0 +1,169 @@ +// SPDX-License-Identifier: Apache-2.0 +#include +#include +#include +#include +#include +#include +#include +#include + +#define TAG "TCA9534" + +#define GET_CONFIG(device) (static_cast((device)->config)) + +constexpr auto TCA9534_REGISTER_INPUT = 0x00; +constexpr auto TCA9534_REGISTER_OUTPUT = 0x01; +constexpr auto TCA9534_REGISTER_POLARITY = 0x02; +constexpr auto TCA9534_REGISTER_CONFIG = 0x03; + +static error_t start(Device* device) { + auto* parent = device_get_parent(device); + if (device_get_type(parent) != &I2C_CONTROLLER_TYPE) { + LOG_E(TAG, "Parent device is not I2C"); + return ERROR_RESOURCE; + } + + return gpio_controller_init_descriptors(device, 8, nullptr); +} + +static error_t stop(Device* device) { + check(gpio_controller_deinit_descriptors(device) == ERROR_NONE); + return ERROR_NONE; +} + +extern "C" { + +static error_t set_level(GpioDescriptor* descriptor, bool high) { + auto* device = descriptor->controller; + auto* parent = device_get_parent(device); + auto address = GET_CONFIG(device)->address; + uint8_t bit = 1 << descriptor->pin; + + return high + ? i2c_controller_register8_set_bits(parent, address, TCA9534_REGISTER_OUTPUT, bit, portMAX_DELAY) + : i2c_controller_register8_reset_bits(parent, address, TCA9534_REGISTER_OUTPUT, bit, portMAX_DELAY); +} + +static error_t get_level(GpioDescriptor* descriptor, bool* high) { + auto* device = descriptor->controller; + auto* parent = device_get_parent(device); + auto address = GET_CONFIG(device)->address; + uint8_t bits; + + error_t err = i2c_controller_register8_get(parent, address, TCA9534_REGISTER_INPUT, &bits, portMAX_DELAY); + if (err != ERROR_NONE) { + return err; + } + + *high = (bits & (1 << descriptor->pin)) != 0; + return ERROR_NONE; +} + +static error_t set_flags(GpioDescriptor* descriptor, gpio_flags_t flags) { + // The TCA9534 only supports direction and polarity inversion. Pull-up/down and + // high-impedance are not present in its register map. + if (flags & (GPIO_FLAG_PULL_UP | GPIO_FLAG_PULL_DOWN | GPIO_FLAG_HIGH_IMPEDANCE)) { + return ERROR_NOT_SUPPORTED; + } + + // The polarity register only inverts what's read back from an input pin; + // set_level() still drives outputs at the raw level. Accepting ACTIVE_LOW + // on an output would silently not do what it implies. + if ((flags & GPIO_FLAG_ACTIVE_LOW) && (flags & GPIO_FLAG_DIRECTION_OUTPUT)) { + return ERROR_NOT_SUPPORTED; + } + + auto* device = descriptor->controller; + auto* parent = device_get_parent(device); + auto address = GET_CONFIG(device)->address; + uint8_t bit = 1 << descriptor->pin; + error_t err; + + // Direction: configuration bit is 1 for input, 0 for output. + if (flags & GPIO_FLAG_DIRECTION_OUTPUT) { + err = i2c_controller_register8_reset_bits(parent, address, TCA9534_REGISTER_CONFIG, bit, portMAX_DELAY); + } else { + err = i2c_controller_register8_set_bits(parent, address, TCA9534_REGISTER_CONFIG, bit, portMAX_DELAY); + } + + if (err != ERROR_NONE) { + return err; + } + + // Polarity inversion (mainly relevant for active-low inputs). + if (flags & GPIO_FLAG_ACTIVE_LOW) { + err = i2c_controller_register8_set_bits(parent, address, TCA9534_REGISTER_POLARITY, bit, portMAX_DELAY); + } else { + err = i2c_controller_register8_reset_bits(parent, address, TCA9534_REGISTER_POLARITY, bit, portMAX_DELAY); + } + + return err; +} + +static error_t get_flags(GpioDescriptor* descriptor, gpio_flags_t* flags) { + auto* device = descriptor->controller; + auto* parent = device_get_parent(device); + auto address = GET_CONFIG(device)->address; + uint8_t bit = 1 << descriptor->pin; + uint8_t val; + error_t err; + + gpio_flags_t f = GPIO_FLAG_NONE; + + err = i2c_controller_register8_get(parent, address, TCA9534_REGISTER_CONFIG, &val, portMAX_DELAY); + if (err != ERROR_NONE) return err; + f |= (val & bit) ? GPIO_FLAG_DIRECTION_INPUT : GPIO_FLAG_DIRECTION_OUTPUT; + + err = i2c_controller_register8_get(parent, address, TCA9534_REGISTER_POLARITY, &val, portMAX_DELAY); + if (err != ERROR_NONE) return err; + f |= (val & bit) ? GPIO_FLAG_ACTIVE_LOW : GPIO_FLAG_ACTIVE_HIGH; + + *flags = f; + return ERROR_NONE; +} + +static error_t get_native_pin_number(GpioDescriptor* descriptor, void* pin_number) { + return ERROR_NOT_SUPPORTED; +} + +static error_t add_callback(GpioDescriptor* descriptor, void (*callback)(void*), void* arg) { + return ERROR_NOT_SUPPORTED; +} + +static error_t remove_callback(GpioDescriptor* descriptor) { + return ERROR_NOT_SUPPORTED; +} + +static error_t enable_interrupt(GpioDescriptor* descriptor) { + return ERROR_NOT_SUPPORTED; +} + +static error_t disable_interrupt(GpioDescriptor* descriptor) { + return ERROR_NOT_SUPPORTED; +} + +const static GpioControllerApi tca9534_gpio_api = { + .set_level = set_level, + .get_level = get_level, + .set_flags = set_flags, + .get_flags = get_flags, + .get_native_pin_number = get_native_pin_number, + .add_callback = add_callback, + .remove_callback = remove_callback, + .enable_interrupt = enable_interrupt, + .disable_interrupt = disable_interrupt +}; + +Driver tca9534_driver = { + .name = "tca9534", + .compatible = (const char*[]) { "ti,tca9534", nullptr }, + .start_device = start, + .stop_device = stop, + .api = static_cast(&tca9534_gpio_api), + .device_type = &GPIO_CONTROLLER_TYPE, + .owner = &tca9534_module, + .internal = nullptr +}; + +}