Device migrations, driver migrations and more (#575)

This commit is contained in:
Ken Van Hoeylandt
2026-07-20 23:43:17 +02:00
committed by GitHub
parent 2d768ef3a1
commit 2fbc44466a
221 changed files with 8824 additions and 3652 deletions
+11
View File
@@ -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(axs5106-module
SRCS ${SOURCE_FILES}
INCLUDE_DIRS include/
REQUIRES TactilityKernel
)
@@ -0,0 +1,195 @@
Apache License
==============
_Version 2.0, January 2004_
_&lt;<http://www.apache.org/licenses/>&gt;_
### 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.
+12
View File
@@ -0,0 +1,12 @@
# AXS5106 touch controller
A driver for the `AXS5106` I2C capacitive touch controller, used on the Waveshare ESP32-S3-Touch-LCD-1.47.
Ported from the `esp_lcd_touch_axs5106` component bundled with Waveshare's official ESP-IDF factory demo firmware
for this board (`ESP32-S3-Touch-LCD-1.47-Demo/ESP-IDF/01_factory/components/esp_lcd_touch_axs5106/esp_lcd_touch_axs5106.c`,
downloadable from https://www.waveshare.com/wiki/ESP32-S3-Touch-LCD-1.47) - not a standalone repo.
The original license was also Apache v2.0
Supports up to 2 touch points.
License: [Apache v2.0](LICENSE-Apache-2.0.md)
@@ -0,0 +1,53 @@
description: AXS5106 capacitive touch controller
include: ["i2c-device.yaml"]
compatible: "axs,axs5106"
bus: i2c
properties:
x-max:
type: int
required: true
description: Maximum X coordinate reported by the controller (typically the panel's horizontal resolution)
y-max:
type: int
required: true
description: Maximum Y coordinate reported by the controller (typically the panel's vertical resolution)
swap-xy:
type: boolean
default: false
description: Swap the X and Y axes
mirror-x:
type: boolean
default: false
description: Mirror the X axis
mirror-y:
type: boolean
default: false
description: Mirror the Y axis
pin-reset:
type: phandles
default: GPIO_PIN_SPEC_NONE
description: Reset GPIO pin
pin-interrupt:
type: phandles
default: GPIO_PIN_SPEC_NONE
description: Interrupt GPIO pin
reset-active-high:
type: boolean
default: false
description: Whether the reset pin is active high
interrupt-active-high:
type: boolean
default: false
description: Whether the interrupt pin is active high
transmit-timeout:
type: int
default: 100
description: Timeout (ms) for the register-address write half of a read transaction
receive-timeout:
type: int
default: 100
description: Timeout (ms) for the data-read half of a read transaction
+3
View File
@@ -0,0 +1,3 @@
dependencies:
- TactilityKernel
bindings: bindings
@@ -0,0 +1,14 @@
// SPDX-License-Identifier: Apache-2.0
#pragma once
#include <tactility/module.h>
#ifdef __cplusplus
extern "C" {
#endif
extern struct Module axs5106_module;
#ifdef __cplusplus
}
#endif
@@ -0,0 +1,7 @@
// SPDX-License-Identifier: Apache-2.0
#pragma once
#include <tactility/bindings/bindings.h>
#include <drivers/axs5106.h>
DEFINE_DEVICETREE(axs5106, struct Axs5106Config)
@@ -0,0 +1,34 @@
// SPDX-License-Identifier: Apache-2.0
#pragma once
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
#include <stdbool.h>
#include <tactility/drivers/gpio.h>
struct Axs5106Config {
uint8_t address;
uint16_t x_max;
uint16_t y_max;
bool swap_xy;
bool mirror_x;
bool mirror_y;
struct GpioPinSpec pin_reset;
struct GpioPinSpec pin_interrupt;
bool reset_active_high;
bool interrupt_active_high;
// Timeout (ms) for the register-address write half of a read, and for the data-read half,
// done as two separate I2C transactions - matches the vendor factory demo's
// i2c_master_transmit()/i2c_master_receive() split (each with its own 100ms timeout),
// rather than a single combined write-then-read transaction.
uint32_t transmit_timeout_ms;
uint32_t receive_timeout_ms;
};
#ifdef __cplusplus
}
#endif
+245
View File
@@ -0,0 +1,245 @@
// SPDX-License-Identifier: Apache-2.0
#include <drivers/axs5106.h>
#include <axs5106_module.h>
#include <tactility/check.h>
#include <tactility/device.h>
#include <tactility/driver.h>
#include <tactility/drivers/gpio_controller.h>
#include <tactility/drivers/gpio_descriptor.h>
#include <tactility/drivers/i2c_controller.h>
#include <tactility/drivers/pointer.h>
#include <tactility/error.h>
#include <tactility/log.h>
#include <freertos/FreeRTOS.h>
#include <freertos/task.h>
#include <cstdlib>
constexpr auto* TAG = "AXS5106";
#define GET_CONFIG(device) (static_cast<const Axs5106Config*>((device)->config))
// Register map and read/reset logic ported from the vendor factory demo
// (ESP32-S3-Touch-LCD-1.47-Demo/ESP-IDF/01_factory/components/esp_lcd_touch_axs5106), which talks
// to the chip directly over I2C rather than through esp_lcd_panel_io/esp_lcd_touch - that indirection
// is what the previous version of this driver used, and reads through it consistently failed with
// ESP_FAIL on real hardware.
static constexpr uint8_t REG_TOUCH_POINTS = 0x01;
static constexpr uint8_t TOUCH_DATA_LEN = 14;
static constexpr uint8_t MAX_POINTS = 2;
struct Axs5106Internal {
GpioDescriptor* reset_descriptor;
bool swap_xy;
bool mirror_x;
bool mirror_y;
uint8_t point_count;
uint16_t x[MAX_POINTS];
uint16_t y[MAX_POINTS];
};
// region Driver lifecycle
// Matches the vendor demo's touch_axs5106_reset(): pulse the reset pin active for 10ms, then
// release it for 10ms before any I2C traffic. No separate init step follows - the vendor demo's
// touch_axs5106_init() is a no-op too.
static error_t reset_pulse(GpioDescriptor* descriptor, bool active_high) {
bool idle_level = !active_high;
bool ok = gpio_descriptor_set_flags(descriptor, GPIO_FLAG_DIRECTION_OUTPUT) == ERROR_NONE;
ok = ok && gpio_descriptor_set_level(descriptor, active_high) == ERROR_NONE;
vTaskDelay(pdMS_TO_TICKS(10));
ok = ok && gpio_descriptor_set_level(descriptor, idle_level) == ERROR_NONE;
vTaskDelay(pdMS_TO_TICKS(10));
return ok ? ERROR_NONE : ERROR_RESOURCE;
}
static error_t start(Device* device) {
auto* parent = device_get_parent(device);
check(device_get_type(parent) == &I2C_CONTROLLER_TYPE);
const auto* config = GET_CONFIG(device);
auto* internal = static_cast<Axs5106Internal*>(malloc(sizeof(Axs5106Internal)));
if (internal == nullptr) {
return ERROR_OUT_OF_MEMORY;
}
internal->reset_descriptor = nullptr;
internal->swap_xy = config->swap_xy;
internal->mirror_x = config->mirror_x;
internal->mirror_y = config->mirror_y;
internal->point_count = 0;
if (config->pin_reset.gpio_controller != nullptr) {
internal->reset_descriptor = gpio_descriptor_acquire(config->pin_reset.gpio_controller, config->pin_reset.pin, GPIO_OWNER_GPIO);
if (internal->reset_descriptor == nullptr) {
LOG_E(TAG, "Failed to acquire reset pin");
free(internal);
return ERROR_RESOURCE;
}
if (reset_pulse(internal->reset_descriptor, config->reset_active_high) != ERROR_NONE) {
LOG_E(TAG, "Failed to pulse reset pin");
gpio_descriptor_release(internal->reset_descriptor);
free(internal);
return ERROR_RESOURCE;
}
}
device_set_driver_data(device, internal);
return ERROR_NONE;
}
static error_t stop(Device* device) {
auto* internal = static_cast<Axs5106Internal*>(device_get_driver_data(device));
if (internal->reset_descriptor != nullptr) {
gpio_descriptor_release(internal->reset_descriptor);
}
free(internal);
device_set_driver_data(device, nullptr);
return ERROR_NONE;
}
// endregion
// region PointerApi
static error_t axs5106_read_data(Device* device, TickType_t) {
auto* internal = static_cast<Axs5106Internal*>(device_get_driver_data(device));
const auto* config = GET_CONFIG(device);
auto* parent = device_get_parent(device);
// Matches the vendor demo's touch_axs5106_i2c_read(): the register address write and the
// data read are two separate transactions (i2c_master_transmit() then i2c_master_receive()),
// not a single write-then-read transaction with a repeated start.
uint8_t reg = REG_TOUCH_POINTS;
error_t error = i2c_controller_write(parent, config->address, &reg, 1, pdMS_TO_TICKS(config->transmit_timeout_ms));
if (error != ERROR_NONE) {
return error;
}
uint8_t data[TOUCH_DATA_LEN];
error = i2c_controller_read(parent, config->address, data, sizeof(data), pdMS_TO_TICKS(config->receive_timeout_ms));
if (error != ERROR_NONE) {
return error;
}
uint8_t points = data[1] & 0x0F;
if (points > MAX_POINTS) {
points = MAX_POINTS;
}
internal->point_count = points;
for (uint8_t i = 0; i < points; i++) {
internal->y[i] = static_cast<uint16_t>(((data[4 + i * 6] & 0x0F) << 8) | data[5 + i * 6]);
internal->x[i] = static_cast<uint16_t>(((data[2 + i * 6] & 0x0F) << 8) | data[3 + i * 6]);
}
return ERROR_NONE;
}
static bool axs5106_get_touched_points(Device* device, uint16_t* x, uint16_t* y, uint16_t* strength, uint8_t* point_count, uint8_t max_point_count) {
auto* internal = static_cast<Axs5106Internal*>(device_get_driver_data(device));
const auto* config = GET_CONFIG(device);
uint8_t count = internal->point_count;
if (count > max_point_count) {
count = max_point_count;
}
// Order matches esp_lcd_touch's own software coordinate adjustment (mirror X, mirror Y,
// then swap) so behavior lines up with the other touch modules in this codebase.
for (uint8_t i = 0; i < count; i++) {
uint16_t point_x = internal->x[i];
uint16_t point_y = internal->y[i];
if (internal->mirror_x) {
point_x = config->x_max - point_x;
}
if (internal->mirror_y) {
point_y = config->y_max - point_y;
}
if (internal->swap_xy) {
uint16_t tmp = point_x;
point_x = point_y;
point_y = tmp;
}
x[i] = point_x;
y[i] = point_y;
if (strength != nullptr) {
strength[i] = 0;
}
LOG_I(TAG, "%d, %d", point_x, point_y);
}
*point_count = count;
return count > 0;
}
static error_t axs5106_set_swap_xy(Device* device, bool swap) {
auto* internal = static_cast<Axs5106Internal*>(device_get_driver_data(device));
internal->swap_xy = swap;
return ERROR_NONE;
}
static error_t axs5106_get_swap_xy(Device* device, bool* swap) {
auto* internal = static_cast<Axs5106Internal*>(device_get_driver_data(device));
*swap = internal->swap_xy;
return ERROR_NONE;
}
static error_t axs5106_set_mirror_x(Device* device, bool mirror) {
auto* internal = static_cast<Axs5106Internal*>(device_get_driver_data(device));
internal->mirror_x = mirror;
return ERROR_NONE;
}
static error_t axs5106_get_mirror_x(Device* device, bool* mirror) {
auto* internal = static_cast<Axs5106Internal*>(device_get_driver_data(device));
*mirror = internal->mirror_x;
return ERROR_NONE;
}
static error_t axs5106_set_mirror_y(Device* device, bool mirror) {
auto* internal = static_cast<Axs5106Internal*>(device_get_driver_data(device));
internal->mirror_y = mirror;
return ERROR_NONE;
}
static error_t axs5106_get_mirror_y(Device* device, bool* mirror) {
auto* internal = static_cast<Axs5106Internal*>(device_get_driver_data(device));
*mirror = internal->mirror_y;
return ERROR_NONE;
}
// endregion
static const PointerApi axs5106_pointer_api = {
// Unsupported (null per PointerApi's contract): neither the vendor demo nor the original
// esp_lcd_touch component implements a sleep mode for this chip.
.enter_sleep = nullptr,
.exit_sleep = nullptr,
.read_data = axs5106_read_data,
.get_touched_points = axs5106_get_touched_points,
.set_swap_xy = axs5106_set_swap_xy,
.get_swap_xy = axs5106_get_swap_xy,
.set_mirror_x = axs5106_set_mirror_x,
.get_mirror_x = axs5106_get_mirror_x,
.set_mirror_y = axs5106_set_mirror_y,
.get_mirror_y = axs5106_get_mirror_y,
};
Driver axs5106_driver = {
.name = "axs5106",
.compatible = (const char*[]) { "axs,axs5106", nullptr },
.start_device = start,
.stop_device = stop,
.api = &axs5106_pointer_api,
.device_type = &POINTER_TYPE,
.owner = &axs5106_module,
.internal = nullptr
};
+32
View File
@@ -0,0 +1,32 @@
// SPDX-License-Identifier: Apache-2.0
#include <tactility/check.h>
#include <tactility/driver.h>
#include <tactility/module.h>
extern "C" {
extern Driver axs5106_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(&axs5106_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(&axs5106_driver) == ERROR_NONE);
return ERROR_NONE;
}
Module axs5106_module = {
.name = "axs5106",
.start = start,
.stop = stop,
.symbols = nullptr,
.internal = nullptr
};
} // extern "C"