Audio System + Drivers (#562)

2026-07-14 16:34:29 +10:00
parent fa4a6e255c
commit 955416dac8
137 changed files with 8847 additions and 387 deletions
@@ -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(aw9523b-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.
+
@@ -0,0 +1,15 @@
+# AW9523B I/O expander
+
+A driver for the `AW9523B` 16-bit I2C-bus I/O expander with LED driver, by Awinic.
+Exposes both 8-bit ports (P0/P1) as 16 GPIO pins (0-15, port 0 = pins 0-7, port 1 =
+pins 8-15) via the `GPIO_CONTROLLER_TYPE` API. P0 is switched to push-pull mode on
+start (every known board wiring for this chip expects push-pull output, not the
+open-drain default).
+
+It does not support pull-up/down resistors, high-impedance outputs, or interrupts;
+requesting those returns `ERROR_NOT_SUPPORTED`. LED driver functionality is not
+implemented.
+
+See https://www.awinic.com/en/productDetail/AW9523B
+
+License: [Apache v2.0](LICENSE-Apache-2.0.md)
@@ -0,0 +1,5 @@
+description: Awinic AW9523B 16-bit I2C-bus I/O expander with LED driver
+
+include: [ "i2c-device.yaml" ]
+
+compatible: "awinic,aw9523b"
@@ -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 aw9523b_module;
+
+#ifdef __cplusplus
+}
+#endif
@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: Apache-2.0
+#pragma once
+
+#include <tactility/bindings/bindings.h>
+#include <drivers/aw9523b.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+DEFINE_DEVICETREE(aw9523b, struct Aw9523bConfig)
+
+#ifdef __cplusplus
+}
+#endif
@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: Apache-2.0
+#pragma once
+
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief AW9523B GPIO expander device configuration.
+ *
+ * 16 pins total: P0_0..P0_7 map to GpioDescriptor pin numbers 0..7, P1_0..P1_7
+ * map to pin numbers 8..15. P0 defaults to open-drain per hardware reset; this
+ * driver switches P0 to push-pull mode on start (matches every known board's
+ * usage of this chip, since open-drain P0 cannot drive an active-high output
+ * without an external pull-up).
+ */
+struct Aw9523bConfig {
+    /** I2C address on the bus (typically 0x58) */
+    uint8_t address;
+};
+
+#ifdef __cplusplus
+}
+#endif
@@ -0,0 +1,183 @@
+// SPDX-License-Identifier: Apache-2.0
+#include <drivers/aw9523b.h>
+#include <aw9523b_module.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/log.h>
+
+#define TAG "AW9523B"
+
+#define GET_CONFIG(device) (static_cast<const Aw9523bConfig*>((device)->config))
+
+namespace {
+
+// Port 0: pins 0..7, Port 1: pins 8..15.
+constexpr auto AW9523B_REG_INPUT_P0 = 0x00;
+constexpr auto AW9523B_REG_INPUT_P1 = 0x01;
+constexpr auto AW9523B_REG_OUTPUT_P0 = 0x02;
+constexpr auto AW9523B_REG_OUTPUT_P1 = 0x03;
+// Configuration register: 0 = output, 1 = input (inverted vs. most other expanders).
+constexpr auto AW9523B_REG_CONFIG_P0 = 0x04;
+constexpr auto AW9523B_REG_CONFIG_P1 = 0x05;
+// Global Control Register: bit 4 selects P0 drive mode (0 = open-drain default, 1 = push-pull).
+constexpr auto AW9523B_REG_GCR = 0x11;
+constexpr uint8_t AW9523B_GCR_P0_PUSH_PULL = 1U << 4U;
+
+constexpr uint8_t portRegister(bool isPort1, uint8_t regPort0, uint8_t regPort1) {
+    return isPort1 ? regPort1 : regPort0;
+}
+
+} // namespace
+
+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;
+    }
+
+    auto address = GET_CONFIG(device)->address;
+
+    // P0 defaults to open-drain out of reset, which can't drive an active-high output
+    // without an external pull-up. Every known board wiring for this chip expects
+    // push-pull, so switch it unconditionally on start.
+    if (i2c_controller_register8_set_bits(parent, address, AW9523B_REG_GCR, AW9523B_GCR_P0_PUSH_PULL, portMAX_DELAY) != ERROR_NONE) {
+        LOG_E(TAG, "Failed to set P0 to push-pull mode");
+        return ERROR_RESOURCE;
+    }
+
+    LOG_I(TAG, "Started AW9523B device %s", device->name);
+    return gpio_controller_init_descriptors(device, 16, 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;
+    bool isPort1 = descriptor->pin >= 8;
+    uint8_t bit = 1U << (descriptor->pin % 8U);
+    uint8_t reg = portRegister(isPort1, AW9523B_REG_OUTPUT_P0, AW9523B_REG_OUTPUT_P1);
+
+    if (high) {
+        return i2c_controller_register8_set_bits(parent, address, reg, bit, portMAX_DELAY);
+    } else {
+        return i2c_controller_register8_reset_bits(parent, address, reg, 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;
+    bool isPort1 = descriptor->pin >= 8;
+    uint8_t bit = 1U << (descriptor->pin % 8U);
+    uint8_t reg = portRegister(isPort1, AW9523B_REG_INPUT_P0, AW9523B_REG_INPUT_P1);
+
+    uint8_t bits;
+    error_t err = i2c_controller_register8_get(parent, address, reg, &bits, portMAX_DELAY);
+    if (err != ERROR_NONE) {
+        return err;
+    }
+
+    *high = (bits & bit) != 0;
+    return ERROR_NONE;
+}
+
+static error_t set_flags(GpioDescriptor* descriptor, gpio_flags_t flags) {
+    auto* device = descriptor->controller;
+    auto* parent = device_get_parent(device);
+    auto address = GET_CONFIG(device)->address;
+    bool isPort1 = descriptor->pin >= 8;
+    uint8_t bit = 1U << (descriptor->pin % 8U);
+    uint8_t reg = portRegister(isPort1, AW9523B_REG_CONFIG_P0, AW9523B_REG_CONFIG_P1);
+
+    // Config register is inverted: clear the bit for output, set it for input.
+    if (flags & GPIO_FLAG_DIRECTION_OUTPUT) {
+        return i2c_controller_register8_reset_bits(parent, address, reg, bit, portMAX_DELAY);
+    } else {
+        return i2c_controller_register8_set_bits(parent, address, reg, bit, portMAX_DELAY);
+    }
+}
+
+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;
+    bool isPort1 = descriptor->pin >= 8;
+    uint8_t bit = 1U << (descriptor->pin % 8U);
+    uint8_t reg = portRegister(isPort1, AW9523B_REG_CONFIG_P0, AW9523B_REG_CONFIG_P1);
+
+    uint8_t val;
+    error_t err = i2c_controller_register8_get(parent, address, reg, &val, portMAX_DELAY);
+    if (err != ERROR_NONE) {
+        return err;
+    }
+
+    // Config register is inverted: 0 = output, 1 = input.
+    *flags = (val & bit) ? GPIO_FLAG_DIRECTION_INPUT : GPIO_FLAG_DIRECTION_OUTPUT;
+    return ERROR_NONE;
+}
+
+static error_t get_native_pin_number(GpioDescriptor* descriptor, void* pin_number) {
+    (void) descriptor;
+    (void) pin_number;
+    return ERROR_NOT_SUPPORTED;
+}
+
+static error_t add_callback(GpioDescriptor* descriptor, void (*callback)(void*), void* arg) {
+    (void) descriptor;
+    (void) callback;
+    (void) arg;
+    return ERROR_NOT_SUPPORTED;
+}
+
+static error_t remove_callback(GpioDescriptor* descriptor) {
+    (void) descriptor;
+    return ERROR_NOT_SUPPORTED;
+}
+
+static error_t enable_interrupt(GpioDescriptor* descriptor) {
+    (void) descriptor;
+    return ERROR_NOT_SUPPORTED;
+}
+
+static error_t disable_interrupt(GpioDescriptor* descriptor) {
+    (void) descriptor;
+    return ERROR_NOT_SUPPORTED;
+}
+
+const static GpioControllerApi aw9523b_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 aw9523b_driver = {
+    .name = "aw9523b",
+    .compatible = (const char*[]) { "awinic,aw9523b", nullptr },
+    .start_device = start,
+    .stop_device = stop,
+    .api = static_cast<const void*>(&aw9523b_gpio_api),
+    .device_type = &GPIO_CONTROLLER_TYPE,
+    .owner = &aw9523b_module,
+    .internal = nullptr
+};
+
+}
@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: Apache-2.0
+#include <tactility/check.h>
+#include <tactility/driver.h>
+#include <tactility/module.h>
+
+extern "C" {
+
+extern Driver aw9523b_driver;
+
+static error_t start() {
+    check(driver_construct_add(&aw9523b_driver) == ERROR_NONE);
+    return ERROR_NONE;
+}
+
+static error_t stop() {
+    check(driver_remove_destruct(&aw9523b_driver) == ERROR_NONE);
+    return ERROR_NONE;
+}
+
+Module aw9523b_module = {
+    .name = "aw9523b",
+    .start = start,
+    .stop = stop,
+    .symbols = nullptr,
+    .internal = nullptr
+};
+
+}