From 28ff01561af393de2afbe38df75183e8c683ce3d Mon Sep 17 00:00:00 2001 From: Adolfo Reyna Date: Fri, 26 Jun 2026 21:47:08 -0400 Subject: [PATCH] Fix mouse coordinates, sequence BLE discovery/encryption, and prevent mouse from disabling on-screen keyboard --- Devices/es3c28p/device.properties | 1 + Devices/es3c28p/es3c28p.dts | 21 + .../source/drivers/bluetooth/esp32_ble.cpp | 4 +- .../drivers/bluetooth/esp32_ble_scan.cpp | 97 ++++- .../Source/bluetooth/BluetoothHidHost.cpp | 126 ++++-- .../.component_hash | 1 + .../CHECKSUMS.json | 1 + .../CMakeLists.txt | 5 + .../lambage__esp_lcd_touch_ft6336u/README.md | 67 ++++ .../esp_lcd_touch_ft6x36.c | 358 ++++++++++++++++++ .../idf_component.yml | 12 + .../include/esp_lcd_touch_ft6x36.h | 59 +++ .../license.txt | 202 ++++++++++ 13 files changed, 912 insertions(+), 42 deletions(-) create mode 100644 components/lambage__esp_lcd_touch_ft6336u/.component_hash create mode 100644 components/lambage__esp_lcd_touch_ft6336u/CHECKSUMS.json create mode 100644 components/lambage__esp_lcd_touch_ft6336u/CMakeLists.txt create mode 100644 components/lambage__esp_lcd_touch_ft6336u/README.md create mode 100644 components/lambage__esp_lcd_touch_ft6336u/esp_lcd_touch_ft6x36.c create mode 100644 components/lambage__esp_lcd_touch_ft6336u/idf_component.yml create mode 100644 components/lambage__esp_lcd_touch_ft6336u/include/esp_lcd_touch_ft6x36.h create mode 100644 components/lambage__esp_lcd_touch_ft6336u/license.txt diff --git a/Devices/es3c28p/device.properties b/Devices/es3c28p/device.properties index 1745442d..ab8bd477 100644 --- a/Devices/es3c28p/device.properties +++ b/Devices/es3c28p/device.properties @@ -12,6 +12,7 @@ spiRam=true spiRamMode=OCT spiRamSpeed=120M tinyUsb=true +usbHostEnabled=false esptoolFlashFreq=120M bluetooth=true diff --git a/Devices/es3c28p/es3c28p.dts b/Devices/es3c28p/es3c28p.dts index e40c8b57..1a1de732 100644 --- a/Devices/es3c28p/es3c28p.dts +++ b/Devices/es3c28p/es3c28p.dts @@ -7,6 +7,7 @@ #include #include #include +#include / { compatible = "root"; @@ -56,4 +57,24 @@ pin-d3 = <&gpio0 47 GPIO_FLAG_NONE>; bus-width = <4>; }; + + usbhost0 { + compatible = "espressif,esp32-usbhost"; + status = "disabled"; + + usbhosthid0 { + compatible = "espressif,esp32-usbhost-hid"; + status = "disabled"; + }; + + usbhostmidi0 { + compatible = "espressif,esp32-usbhost-midi"; + status = "disabled"; + }; + + usbhostmsc0 { + compatible = "espressif,esp32-usbhost-msc"; + status = "disabled"; + }; + }; }; diff --git a/Platforms/platform-esp32/source/drivers/bluetooth/esp32_ble.cpp b/Platforms/platform-esp32/source/drivers/bluetooth/esp32_ble.cpp index 30bc1016..e749d3fe 100644 --- a/Platforms/platform-esp32/source/drivers/bluetooth/esp32_ble.cpp +++ b/Platforms/platform-esp32/source/drivers/bluetooth/esp32_ble.cpp @@ -815,7 +815,9 @@ static error_t api_scan_start(struct Device* device) { struct ble_gap_disc_params disc_params = {}; disc_params.passive = 0; - disc_params.filter_duplicates = 1; + disc_params.filter_duplicates = 0; + disc_params.itvl = 160; // 100 ms + disc_params.window = 160; // 100 ms uint8_t own_addr_type; ble_hs_id_infer_auto(0, &own_addr_type); diff --git a/Platforms/platform-esp32/source/drivers/bluetooth/esp32_ble_scan.cpp b/Platforms/platform-esp32/source/drivers/bluetooth/esp32_ble_scan.cpp index 554845e1..eff61293 100644 --- a/Platforms/platform-esp32/source/drivers/bluetooth/esp32_ble_scan.cpp +++ b/Platforms/platform-esp32/source/drivers/bluetooth/esp32_ble_scan.cpp @@ -21,6 +21,14 @@ constexpr auto* TAG = "esp32_ble_scan"; // Using BleCtx* (not Device*) so we avoid keeping a static Device reference. static BleCtx* s_scan_ctx = nullptr; +struct LoggedDevice { + ble_addr_t addr; + bool has_name; +}; +constexpr size_t MAX_LOGGED_DEVICES = 128; +static LoggedDevice s_logged_devices[MAX_LOGGED_DEVICES]; +static size_t s_logged_count = 0; + // ---- Scan data helpers ---- void ble_scan_clear_results(struct Device* device) { @@ -28,6 +36,8 @@ void ble_scan_clear_results(struct Device* device) { xSemaphoreTake(ctx->scan_mutex, portMAX_DELAY); ctx->scan_count = 0; memset(ctx->scan_results, 0, sizeof(ctx->scan_results)); + s_logged_count = 0; + memset(s_logged_devices, 0, sizeof(s_logged_devices)); xSemaphoreGive(ctx->scan_mutex); } @@ -49,7 +59,8 @@ int ble_gap_disc_event_handler(struct ble_gap_event* event, void* arg) { record.connected = false; struct ble_hs_adv_fields fields; - if (ble_hs_adv_parse_fields(&fields, disc.data, disc.length_data) == 0) { + bool parsed_fields = (ble_hs_adv_parse_fields(&fields, disc.data, disc.length_data) == 0); + if (parsed_fields) { if (fields.name != nullptr && fields.name_len > 0) { size_t copy_len = std::min(fields.name_len, BT_NAME_MAX); memcpy(record.name, fields.name, copy_len); @@ -57,6 +68,7 @@ int ble_gap_disc_event_handler(struct ble_gap_event* event, void* arg) { } } + bool should_publish = false; { xSemaphoreTake(ctx->scan_mutex, portMAX_DELAY); bool found = false; @@ -65,32 +77,99 @@ int ble_gap_disc_event_handler(struct ble_gap_event* event, void* arg) { // Deduplicate: merge name from SCAN_RSP without clobbering ADV_IND name if (record.name[0] != '\0') { memcpy(ctx->scan_results[i].name, record.name, BT_NAME_MAX + 1); + } else { + // If this packet doesn't have a name, keep the previously discovered name + memcpy(record.name, ctx->scan_results[i].name, BT_NAME_MAX + 1); } ctx->scan_results[i].rssi = record.rssi; found = true; + should_publish = (record.name[0] != '\0'); break; } } - if (!found && ctx->scan_count < 64) { + if (!found && record.name[0] != '\0' && ctx->scan_count < 64) { ctx->scan_results[ctx->scan_count] = record; ctx->scan_addrs[ctx->scan_count] = disc.addr; // full addr (type+val) ctx->scan_count++; + should_publish = true; } xSemaphoreGive(ctx->scan_mutex); } - struct BtEvent e = {}; - e.type = BT_EVENT_PEER_FOUND; - e.peer = record; - ble_publish_event(device, e); + // USB Serial logging for unique devices + bool logged_already = false; + size_t found_idx = 0; + for (size_t i = 0; i < s_logged_count; ++i) { + if (s_logged_devices[i].addr.type == disc.addr.type && + memcmp(s_logged_devices[i].addr.val, disc.addr.val, BT_ADDR_LEN) == 0) { + logged_already = true; + found_idx = i; + break; + } + } + + bool name_updated = false; + if (logged_already) { + if (!s_logged_devices[found_idx].has_name && record.name[0] != '\0') { + s_logged_devices[found_idx].has_name = true; + name_updated = true; + } + } + + if (!logged_already && s_logged_count < MAX_LOGGED_DEVICES) { + s_logged_devices[s_logged_count].addr = disc.addr; + s_logged_devices[s_logged_count].has_name = (record.name[0] != '\0'); + s_logged_count++; + } + + if (!logged_already || name_updated) { + char mac_str[18]; + snprintf(mac_str, sizeof(mac_str), "%02x:%02x:%02x:%02x:%02x:%02x", + disc.addr.val[5], disc.addr.val[4], disc.addr.val[3], + disc.addr.val[2], disc.addr.val[1], disc.addr.val[0]); + + char extra_info[128] = ""; + int pos = 0; + if (parsed_fields) { + if (fields.appearance_is_present) { + pos += snprintf(extra_info + pos, sizeof(extra_info) - pos, " App:0x%04x", fields.appearance); + } + if (fields.num_uuids16 > 0) { + pos += snprintf(extra_info + pos, sizeof(extra_info) - pos, " UUID16:%d", (int)fields.num_uuids16); + if (fields.uuids16 != nullptr) { + uint16_t u16 = fields.uuids16[0].value; + pos += snprintf(extra_info + pos, sizeof(extra_info) - pos, "(0x%04x)", (int)u16); + } + } + if (fields.num_uuids128 > 0) { + pos += snprintf(extra_info + pos, sizeof(extra_info) - pos, " UUID128:%d", (int)fields.num_uuids128); + } + if (fields.mfg_data_len > 0) { + pos += snprintf(extra_info + pos, sizeof(extra_info) - pos, " Mfg:%d", (int)fields.mfg_data_len); + } + } + LOG_I(TAG, "[BLE SCAN] Unique Device: MAC=%s RSSI=%d Name=%s%s%s", + mac_str, (int)record.rssi, record.name[0] ? record.name : "", + extra_info, name_updated ? " (Name Updated)" : ""); + } + + if (should_publish) { + struct BtEvent e = {}; + e.type = BT_EVENT_PEER_FOUND; + e.peer = record; + ble_publish_event(device, e); + } break; } case BLE_GAP_EVENT_DISC_COMPLETE: LOG_I(TAG, "Scan complete (reason=%d)", event->disc_complete.reason); - // Keep scan_active=true; resolveNextUnnamedPeer clears it and fires ScanFinished - // once name resolution finishes, so the UI spinner stays active throughout. - ble_resolve_next_unnamed_peer(device, 0); + ble_set_scan_active(device, false); + { + struct BtEvent e = {}; + e.type = BT_EVENT_SCAN_FINISHED; + ble_publish_event(device, e); + } break; default: diff --git a/Tactility/Source/bluetooth/BluetoothHidHost.cpp b/Tactility/Source/bluetooth/BluetoothHidHost.cpp index 542f0bb5..11b1f840 100644 --- a/Tactility/Source/bluetooth/BluetoothHidHost.cpp +++ b/Tactility/Source/bluetooth/BluetoothHidHost.cpp @@ -71,6 +71,8 @@ struct HidHostCtx { bool securityInitiated = false; bool typeResolutionDone = false; bool readyBlockFired = false; + bool encrypted = false; + bool dscsDiscovered = false; lv_indev_t* kbIndev = nullptr; lv_indev_t* mouseIndev = nullptr; lv_obj_t* mouseCursor = nullptr; @@ -187,16 +189,16 @@ static void hidHostMouseReadCb(lv_indev_t* /*indev*/, lv_indev_data_t* data) { data->point.y = (lv_coord_t)cy; break; case LV_DISPLAY_ROTATION_90: - data->point.x = (lv_coord_t)cy; - data->point.y = (lv_coord_t)(oh - cx - 1); + data->point.x = (lv_coord_t)(ow - cy - 1); + data->point.y = (lv_coord_t)cx; break; case LV_DISPLAY_ROTATION_180: data->point.x = (lv_coord_t)(ow - cx - 1); data->point.y = (lv_coord_t)(oh - cy - 1); break; case LV_DISPLAY_ROTATION_270: - data->point.x = (lv_coord_t)(ow - cy - 1); - data->point.y = (lv_coord_t)cx; + data->point.x = (lv_coord_t)cy; + data->point.y = (lv_coord_t)(oh - cx - 1); break; } } else { @@ -214,10 +216,29 @@ static void hidHostMouseReadCb(lv_indev_t* /*indev*/, lv_indev_data_t* data) { } static void hidHostHandleMouseReport(const uint8_t* data, uint16_t len) { - if (len < 3) return; - bool btn = (data[0] & 0x01) != 0; - int8_t dx = (int8_t)data[1]; - int8_t dy = (int8_t)data[2]; + int32_t dx = 0; + int32_t dy = 0; + bool btn = false; + + if (len >= 5) { + // 12-bit packed coordinate format (Logitech/high-res HID mice) + btn = (data[0] & 0x01) != 0; + + int16_t raw_x = data[2] | ((data[3] & 0x0F) << 8); + if (raw_x & 0x0800) raw_x |= 0xF000; // sign extend 12-bit to 16-bit + dx = (int16_t)raw_x; + + int16_t raw_y = (data[3] >> 4) | (data[4] << 4); + if (raw_y & 0x0800) raw_y |= 0xF000; // sign extend 12-bit to 16-bit + dy = (int16_t)raw_y; + } else if (len >= 3) { + // Standard 3-byte boot protocol + btn = (data[0] & 0x01) != 0; + dx = (int8_t)data[1]; + dy = (int8_t)data[2]; + } else { + return; + } lv_display_t* disp = lv_display_get_default(); int32_t w = disp ? lv_display_get_horizontal_resolution(disp) : 320; @@ -254,17 +275,33 @@ static void hidHostHandleMouseReport(const uint8_t* data, uint16_t len) { } } +// ---- Asynchronous coordination helpers ---- + +static void hidHostOnDscsDiscovered(HidHostCtx& ctx) { + ctx.dscsDiscovered = true; + if (ctx.encrypted) { + ctx.rptRefReadIdx = 0; + hidHostStartRptRefRead(ctx); + } else { + LOGGER.info("Descriptors discovered, waiting for encryption"); + } +} + +static void hidHostOnEncrypted(HidHostCtx& ctx) { + ctx.encrypted = true; + if (ctx.dscsDiscovered) { + ctx.rptRefReadIdx = 0; + hidHostStartRptRefRead(ctx); + } else { + LOGGER.info("Encryption established, waiting for descriptor discovery"); + } +} + // ---- Timer callback for post-encryption CCCD retry ---- static void hidEncRetryTimerCb(void* /*arg*/) { if (hid_host_ctx) { - if (!hid_host_ctx->typeResolutionDone) { - LOGGER.warn("Post-encryption delay — type resolution timed out, proceeding"); - hid_host_ctx->typeResolutionDone = true; - hid_host_ctx->subscribeIdx = 0; - } else { - LOGGER.info("Post-encryption delay complete — starting CCCD subscriptions"); - } + LOGGER.info("CCCD delay complete — starting subscriptions"); hidHostSubscribeNext(*hid_host_ctx); } } @@ -395,7 +432,12 @@ static void hidHostReadReportMap(HidHostCtx& ctx) { LOGGER.info("No Report Map char — skipping type resolution"); ctx.typeResolutionDone = true; ctx.subscribeIdx = 0; - hidHostSubscribeNext(ctx); + if (hid_enc_retry_timer) { + esp_timer_stop(hid_enc_retry_timer); + esp_timer_start_once(hid_enc_retry_timer, 500 * 1000); + } else { + hidHostSubscribeNext(ctx); + } return; } int rc = ble_gattc_read_long(ctx.connHandle, ctx.rptMapHandle, 0, @@ -419,14 +461,25 @@ static void hidHostReadReportMap(HidHostCtx& ctx) { } ctx.typeResolutionDone = true; ctx.subscribeIdx = 0; - hidHostSubscribeNext(ctx); + LOGGER.info("Type resolution complete — delaying CCCD subscriptions by 500ms"); + if (hid_enc_retry_timer) { + esp_timer_stop(hid_enc_retry_timer); + esp_timer_start_once(hid_enc_retry_timer, 500 * 1000); + } else { + hidHostSubscribeNext(ctx); + } return 0; }, nullptr); if (rc != 0) { LOGGER.warn("Report map read_long failed rc={} — skipping", rc); ctx.typeResolutionDone = true; ctx.subscribeIdx = 0; - hidHostSubscribeNext(ctx); + if (hid_enc_retry_timer) { + esp_timer_stop(hid_enc_retry_timer); + esp_timer_start_once(hid_enc_retry_timer, 500 * 1000); + } else { + hidHostSubscribeNext(ctx); + } } } @@ -479,6 +532,19 @@ static void hidHostSubscribeNext(HidHostCtx& ctx) { } getMainDispatcher().dispatch([] { if (!hid_host_ctx || hid_host_ctx->kbIndev != nullptr) return; + + bool has_keyboard = false; + for (const auto& rpt : hid_host_ctx->inputRpts) { + if (rpt.type == HidReportType::Keyboard || rpt.type == HidReportType::Unknown) { + has_keyboard = true; + break; + } + } + if (!has_keyboard) { + LOGGER.info("No keyboard reports found — skipping keyboard indev registration"); + return; + } + if (!tt::lvgl::lock(1000)) { LOGGER.warn("LVGL lock failed for kb indev"); return; } auto* kb = lv_indev_create(); lv_indev_set_type(kb, LV_INDEV_TYPE_KEYPAD); @@ -563,12 +629,10 @@ static int hidHostDscDiscCb(uint16_t conn_handle, const struct ble_gatt_error* e hidHostDscDiscCb, nullptr); if (rc != 0) { LOGGER.warn("disc_all_dscs[{}] failed rc={}", next_idx, rc); - ctx.rptRefReadIdx = 0; - hidHostStartRptRefRead(ctx); + hidHostOnDscsDiscovered(ctx); } } else { - ctx.rptRefReadIdx = 0; - hidHostStartRptRefRead(ctx); + hidHostOnDscsDiscovered(ctx); } } return 0; @@ -614,8 +678,7 @@ static int hidHostChrDiscCb(uint16_t conn_handle, const struct ble_gatt_error* e hidHostDscDiscCb, nullptr); if (rc != 0) { LOGGER.warn("disc_all_dscs[0] failed rc={}", rc); - ctx.rptRefReadIdx = 0; - hidHostStartRptRefRead(ctx); + hidHostOnDscsDiscovered(ctx); } } return 0; @@ -662,6 +725,11 @@ static int hidHostGapCb(struct ble_gap_event* event, void* /*arg*/) { if (event->connect.status == 0) { ctx.connHandle = event->connect.conn_handle; LOGGER.info("Connected (handle={})", ctx.connHandle); + + // Initiate security immediately to encrypt the link for HOGP (HID over GATT) + ble_gap_security_initiate(ctx.connHandle); + ctx.securityInitiated = true; + int rc = ble_gattc_disc_all_svcs(ctx.connHandle, hidHostSvcDiscCb, nullptr); if (rc != 0) { LOGGER.warn("disc_all_svcs failed rc={}", rc); @@ -725,14 +793,8 @@ static int hidHostGapCb(struct ble_gap_event* event, void* /*arg*/) { case BLE_GAP_EVENT_ENC_CHANGE: if (event->enc_change.conn_handle == ctx.connHandle) { if (event->enc_change.status == 0) { - LOGGER.info("Encryption established — retrying CCCD in 500ms"); - ctx.subscribeIdx = 0; - if (hid_enc_retry_timer) { - esp_timer_stop(hid_enc_retry_timer); - esp_timer_start_once(hid_enc_retry_timer, 500 * 1000); - } else { - hidHostSubscribeNext(ctx); - } + LOGGER.info("Encryption established — notifying state machine"); + hidHostOnEncrypted(ctx); } else { LOGGER.warn("Encryption failed status={}", event->enc_change.status); } diff --git a/components/lambage__esp_lcd_touch_ft6336u/.component_hash b/components/lambage__esp_lcd_touch_ft6336u/.component_hash new file mode 100644 index 00000000..95235d64 --- /dev/null +++ b/components/lambage__esp_lcd_touch_ft6336u/.component_hash @@ -0,0 +1 @@ +b581c2abc643da397b98d269bb63a6fed8f7efa94df054b00d3e333c387ddb78 \ No newline at end of file diff --git a/components/lambage__esp_lcd_touch_ft6336u/CHECKSUMS.json b/components/lambage__esp_lcd_touch_ft6336u/CHECKSUMS.json new file mode 100644 index 00000000..ef56dadb --- /dev/null +++ b/components/lambage__esp_lcd_touch_ft6336u/CHECKSUMS.json @@ -0,0 +1 @@ +{"version":"1.0","algorithm":"sha256","created_at":"2025-11-29T02:16:24.972824+00:00","files":[{"path":"CMakeLists.txt","size":115,"hash":"ddcc34d3ac2ee5238581367fc4fd5d564d568f224dc47bc7718424c96775bc57"},{"path":"README.md","size":2415,"hash":"589710be7e62dac281b4bbc1261615b77a8e8247ac7e80af867ef772508b7f5f"},{"path":"esp_lcd_touch_ft6x36.c","size":12037,"hash":"42ec067b1ebb135f75ab8eb9a73b557037e72e39a62047117353d9b00e98d369"},{"path":"idf_component.yml","size":409,"hash":"2f7bf7b2b3218704fbc383c445a162c3bf62b39eede92de824b2fec9992e5cec"},{"path":"license.txt","size":11560,"hash":"3ddf9be5c28fe27dad143a5dc76eea25222ad1dd68934a047064e56ed2fa40c5"},{"path":"include/esp_lcd_touch_ft6x36.h","size":1698,"hash":"d5c5c521ccf4784cf3aca293ff671c55786565ee9301532bb887adac4129160a"}]} \ No newline at end of file diff --git a/components/lambage__esp_lcd_touch_ft6336u/CMakeLists.txt b/components/lambage__esp_lcd_touch_ft6336u/CMakeLists.txt new file mode 100644 index 00000000..9ff66369 --- /dev/null +++ b/components/lambage__esp_lcd_touch_ft6336u/CMakeLists.txt @@ -0,0 +1,5 @@ +idf_component_register( + SRCS "esp_lcd_touch_ft6x36.c" + INCLUDE_DIRS "include" + REQUIRES "esp_lcd" +) diff --git a/components/lambage__esp_lcd_touch_ft6336u/README.md b/components/lambage__esp_lcd_touch_ft6336u/README.md new file mode 100644 index 00000000..f6f43f28 --- /dev/null +++ b/components/lambage__esp_lcd_touch_ft6336u/README.md @@ -0,0 +1,67 @@ +# ESP LCD Touch FT6x36 Controller + +[![Component Registry](https://components.espressif.com/components/espressif/esp_lcd_touch_ft6x36/badge.svg)](https://components.espressif.com/components/lambage/esp_lcd_touch_ft6x36) + +This repository is forked from https://github.com/cfscn/esp_lcd_touch_ft6x36 + +Implementation of the FT6x36 touch controller with esp_lcd_touch component. + +| Touch controller | Communication interface | Component name | Link to datasheet | +| :--------------: | :---------------------: | :------------: | :---------------: | +| FT6x36 | I2C | esp_lcd_touch_ft6x36 | [PDF](https://www.buydisplay.com/download/ic/FT6236-FT6336-FT6436L-FT6436_Datasheet.pdf) | + +[^1]: **NOTE:** This controller should work via I2C or SPI communication interface. But it was tested on HW only via I2C communication interface. + +## Add to project + +Packages from this repository are uploaded to [Espressif's component service](https://components.espressif.com/). +You can add them to your project via `idf.py add-dependancy`, e.g. +``` + idf.py add-dependency esp_lcd_touch_ft6x36==1.0.0 +``` + +Alternatively, you can create `idf_component.yml`. More is in [Espressif's documentation](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html). + +## Example use + +I2C initialization of the touch component. + +``` + esp_lcd_panel_io_i2c_config_t io_config = ESP_LCD_TOUCH_IO_I2C_FT6x36_CONFIG(); + + esp_lcd_touch_config_t tp_cfg = { + .x_max = CONFIG_LCD_HRES, + .y_max = CONFIG_LCD_VRES, + .rst_gpio_num = -1, + .int_gpio_num = -1, + .levels = { + .reset = 0, + .interrupt = 0, + }, + .flags = { + .swap_xy = 0, + .mirror_x = 0, + .mirror_y = 0, + }, + }; + + esp_lcd_touch_handle_t tp; + esp_lcd_touch_new_i2c_ft6x36(io_handle, &tp_cfg, &tp); +``` + +Read data from the touch controller and store it in RAM memory. It should be called regularly in poll. + +``` + esp_lcd_touch_read_data(tp); +``` + +Get one X and Y coordinates with strength of touch. + +``` + uint16_t touch_x[1]; + uint16_t touch_y[1]; + uint16_t touch_strength[1]; + uint8_t touch_cnt = 0; + + bool touchpad_pressed = esp_lcd_touch_get_coordinates(tp, touch_x, touch_y, touch_strength, &touch_cnt, 1); +``` diff --git a/components/lambage__esp_lcd_touch_ft6336u/esp_lcd_touch_ft6x36.c b/components/lambage__esp_lcd_touch_ft6336u/esp_lcd_touch_ft6x36.c new file mode 100644 index 00000000..e0b692c3 --- /dev/null +++ b/components/lambage__esp_lcd_touch_ft6336u/esp_lcd_touch_ft6x36.c @@ -0,0 +1,358 @@ +/* + * SPDX-FileCopyrightText: 2025 CFSoft Systems (Chengdu) CO LTD + * + * SPDX-License-Identifier: Apache-2.0 + */ + +#include +#include +#include "freertos/FreeRTOS.h" +#include "freertos/task.h" +#include "esp_system.h" +#include "esp_err.h" +#include "esp_log.h" +#include "esp_check.h" +#include "driver/gpio.h" +#include "esp_lcd_panel_io.h" +#include "esp_lcd_touch.h" + +static const char *TAG = "FT6x36"; + +/* Registers */ +#define FT62XX_G_FT5201ID 0xA8 // FocalTech's panel ID +#define FT62XX_REG_NUMTOUCHES 0x02 // Number of touch points + +#define FT62XX_NUM_X 0x33 // Touch X position +#define FT62XX_NUM_Y 0x34 // Touch Y position + +#define FT62XX_REG_MODE 0x00 // Device mode, either WORKING or FACTORY +#define FT62XX_REG_READDATA 0x00 // Read data from register +#define FT62XX_REG_CALIBRATE 0x02 // Calibrate mode +#define FT62XX_REG_WORKMODE 0x00 // Work mode +#define FT62XX_REG_FACTORYMODE 0x40 // Factory mode +#define FT62XX_REG_THRESHHOLD 0x80 // Threshold for touch detection +#define FT62XX_REG_POINTRATE 0x88 // Point rate +#define FT62XX_REG_FIRMVERS 0xA6 // Firmware version +#define FT62XX_REG_CHIPID 0xA3 // Chip selecting +#define FT62XX_REG_VENDID 0xA8 // FocalTech's panel ID + +#define FT62XX_VENDID 0x11 // FocalTech's panel ID +#define FT6336_VENDID 0x88 // FocalTech's panel ID +#define FT6206_CHIPID 0x06 // Chip selecting +#define FT3236_CHIPID 0x33 // Chip selecting +#define FT6236_CHIPID 0x36 // Chip selecting +#define FT6236U_CHIPID 0x64 // Chip selecting +#define FT6336U_CHIPID 0x64 // Chip selecting + +#define FT62XX_DEFAULT_THRESHOLD 128 // Default threshold for touch detection + +/******************************************************************************* + * Function definitions + *******************************************************************************/ +static esp_err_t esp_lcd_touch_ft6x36_read_data(esp_lcd_touch_handle_t tp); +static bool esp_lcd_touch_ft6x36_get_xy(esp_lcd_touch_handle_t tp, uint16_t *x, uint16_t *y, uint16_t *strength, uint8_t *point_num, uint8_t max_point_num); +static esp_err_t esp_lcd_touch_ft6x36_del(esp_lcd_touch_handle_t tp); + +/* I2C read */ +static esp_err_t touch_ft6x36_i2c_write(esp_lcd_touch_handle_t tp, uint8_t reg, uint8_t data); +static esp_err_t touch_ft6x36_i2c_read(esp_lcd_touch_handle_t tp, uint8_t reg, uint8_t *data, uint8_t len); + +/* FT6x36 init */ +static esp_err_t touch_ft6x36_init(esp_lcd_touch_handle_t tp); +/* FT6x36 reset */ +static esp_err_t touch_ft6x36_reset(esp_lcd_touch_handle_t tp); + +/******************************************************************************* + * Public API functions + *******************************************************************************/ + +esp_err_t esp_lcd_touch_new_i2c_ft6x36(const esp_lcd_panel_io_handle_t io, const esp_lcd_touch_config_t *config, esp_lcd_touch_handle_t *out_touch) +{ + esp_err_t ret = ESP_OK; + + assert(config != NULL); + assert(out_touch != NULL); + + /* Prepare main structure */ + esp_lcd_touch_handle_t esp_lcd_touch_ft6x36 = heap_caps_calloc(1, sizeof(esp_lcd_touch_t), MALLOC_CAP_DEFAULT); + ESP_GOTO_ON_FALSE(esp_lcd_touch_ft6x36, ESP_ERR_NO_MEM, err, TAG, "no mem for FT6x36 controller"); + + /* Communication interface */ + esp_lcd_touch_ft6x36->io = io; + + /* Only supported callbacks are set */ + esp_lcd_touch_ft6x36->read_data = esp_lcd_touch_ft6x36_read_data; + esp_lcd_touch_ft6x36->get_xy = esp_lcd_touch_ft6x36_get_xy; + esp_lcd_touch_ft6x36->del = esp_lcd_touch_ft6x36_del; + + /* Mutex */ + esp_lcd_touch_ft6x36->data.lock.owner = portMUX_FREE_VAL; + + /* Save config */ + memcpy(&esp_lcd_touch_ft6x36->config, config, sizeof(esp_lcd_touch_config_t)); + + /* Prepare pin for touch interrupt */ + if (esp_lcd_touch_ft6x36->config.int_gpio_num != GPIO_NUM_NC) + { + const gpio_config_t int_gpio_config = { + .mode = GPIO_MODE_INPUT, + .intr_type = (esp_lcd_touch_ft6x36->config.levels.interrupt ? GPIO_INTR_POSEDGE : GPIO_INTR_NEGEDGE), + .pin_bit_mask = BIT64(esp_lcd_touch_ft6x36->config.int_gpio_num)}; + ret = gpio_config(&int_gpio_config); + ESP_GOTO_ON_ERROR(ret, err, TAG, "GPIO config failed"); + + /* Register interrupt callback */ + if (esp_lcd_touch_ft6x36->config.interrupt_callback) + { + esp_lcd_touch_register_interrupt_callback(esp_lcd_touch_ft6x36, esp_lcd_touch_ft6x36->config.interrupt_callback); + } + } + + /* Prepare pin for touch controller reset */ + if (esp_lcd_touch_ft6x36->config.rst_gpio_num != GPIO_NUM_NC) + { + const gpio_config_t rst_gpio_config = { + .mode = GPIO_MODE_OUTPUT, + .pin_bit_mask = BIT64(esp_lcd_touch_ft6x36->config.rst_gpio_num)}; + ret = gpio_config(&rst_gpio_config); + ESP_GOTO_ON_ERROR(ret, err, TAG, "GPIO config failed"); + } + + /* Reset controller */ + ret = touch_ft6x36_reset(esp_lcd_touch_ft6x36); + ESP_GOTO_ON_ERROR(ret, err, TAG, "FT6x36 reset failed"); + + /* Init controller */ + ret = touch_ft6x36_init(esp_lcd_touch_ft6x36); + ESP_GOTO_ON_ERROR(ret, err, TAG, "FT6x36 init failed"); + + *out_touch = esp_lcd_touch_ft6x36; + +err: + if (ret != ESP_OK) + { + ESP_LOGE(TAG, "Error (0x%x)! Touch controller FT6x36 initialization failed!", ret); + if (esp_lcd_touch_ft6x36) + { + esp_lcd_touch_ft6x36_del(esp_lcd_touch_ft6x36); + } + } + + return ret; +} + +static esp_err_t esp_lcd_touch_ft6x36_read_data(esp_lcd_touch_handle_t tp) +{ + esp_err_t err; + uint8_t data[16]; + uint8_t points, touches; + size_t i = 0; + + assert(tp != NULL); + + /* Read number of touched points */ + err = touch_ft6x36_i2c_read(tp, FT62XX_REG_NUMTOUCHES, &points, 1); + ESP_RETURN_ON_ERROR(err, TAG, "I2C read error!"); + + if (points > 2 || points == 0) + { + return ESP_OK; + } + + /* Number of touched points */ + points = (points > CONFIG_ESP_LCD_TOUCH_MAX_POINTS ? CONFIG_ESP_LCD_TOUCH_MAX_POINTS : points); + + err = touch_ft6x36_i2c_read(tp, FT62XX_REG_READDATA, data, 16); + ESP_RETURN_ON_ERROR(err, TAG, "I2C read error!"); + + /* Number of touched points */ + touches = data[0x02]; + + /* Check if the number of touched points is correct */ + if (points != touches) + { + return ESP_OK; + } + + portENTER_CRITICAL(&tp->data.lock); + + /* Number of touched points */ + tp->data.points = points; + + /* Fill all coordinates */ + for (i = 0; i < points; i++) + { + tp->data.coords[i].x = ((data[0x03 + i * 6] & 0x0F) << 8) | data[0x04 + i * 6]; + tp->data.coords[i].y = ((data[0x05 + i * 6] & 0x0F) << 8) | data[0x06 + i * 6]; + } + + portEXIT_CRITICAL(&tp->data.lock); + + return ESP_OK; +} + +static bool esp_lcd_touch_ft6x36_get_xy(esp_lcd_touch_handle_t tp, uint16_t *x, uint16_t *y, uint16_t *strength, uint8_t *point_num, uint8_t max_point_num) +{ + assert(tp != NULL); + assert(x != NULL); + assert(y != NULL); + assert(point_num != NULL); + assert(max_point_num > 0); + + portENTER_CRITICAL(&tp->data.lock); + + /* Count of points */ + *point_num = (tp->data.points > max_point_num ? max_point_num : tp->data.points); + + for (size_t i = 0; i < *point_num; i++) + { + x[i] = tp->data.coords[i].x; + y[i] = tp->data.coords[i].y; + + if (strength) + { + strength[i] = tp->data.coords[i].strength; + } + } + + /* Invalidate */ + tp->data.points = 0; + + portEXIT_CRITICAL(&tp->data.lock); + + return (*point_num > 0); +} + +static esp_err_t esp_lcd_touch_ft6x36_del(esp_lcd_touch_handle_t tp) +{ + assert(tp != NULL); + + /* Reset GPIO pin settings */ + if (tp->config.int_gpio_num != GPIO_NUM_NC) + { + gpio_reset_pin(tp->config.int_gpio_num); + if (tp->config.interrupt_callback) + { + gpio_isr_handler_remove(tp->config.int_gpio_num); + } + } + + /* Reset GPIO pin settings */ + if (tp->config.rst_gpio_num != GPIO_NUM_NC) + { + gpio_reset_pin(tp->config.rst_gpio_num); + } + + free(tp); + + return ESP_OK; +} + +/******************************************************************************* + * Private API function + *******************************************************************************/ + +static esp_err_t touch_ft6x36_init(esp_lcd_touch_handle_t tp) +{ + esp_err_t ret = ESP_OK; + uint8_t vend_id, chip_id, firm_vers, point_rate, thresh, reg_val; + + assert(tp != NULL); + + /* Read vendor ID */ + ESP_RETURN_ON_ERROR(touch_ft6x36_i2c_read(tp, FT62XX_REG_VENDID, &vend_id, 1), TAG, "Read vendor ID error"); + + /* Read chip ID */ + ESP_RETURN_ON_ERROR(touch_ft6x36_i2c_read(tp, FT62XX_REG_CHIPID, &chip_id, 1), TAG, "Read chip ID error"); + + /* Read firmware version */ + ESP_RETURN_ON_ERROR(touch_ft6x36_i2c_read(tp, FT62XX_REG_FIRMVERS, &firm_vers, 1), TAG, "Read firmware version error"); + + /* Read point rate */ + ESP_RETURN_ON_ERROR(touch_ft6x36_i2c_read(tp, FT62XX_REG_POINTRATE, &point_rate, 1), TAG, "Read point rate error"); + + /* Read threshold */ + ESP_RETURN_ON_ERROR(touch_ft6x36_i2c_read(tp, FT62XX_REG_THRESHHOLD, &thresh, 1), TAG, "Read threshold error"); + + /* Print out the values */ + ESP_LOGI(TAG, "Vend ID: 0x%02X", vend_id); + ESP_LOGI(TAG, "Chip ID: 0x%02X", chip_id); + ESP_LOGI(TAG, "Firm V: %d", firm_vers); + ESP_LOGI(TAG, "Point Rate Hz: %d", point_rate); + ESP_LOGI(TAG, "Thresh: %d", thresh); + + /* Dump all registers */ + ESP_LOGI(TAG, "Dumping all registers:"); + for (int16_t i = 0; i < 0x10; i++) + { + /* Read register */ + if (touch_ft6x36_i2c_read(tp, i, ®_val, 1) == ESP_OK) + { + ESP_LOGI(TAG, "I2C $%02X = 0x%02X", i, reg_val); + } + else + { + ESP_LOGE(TAG, "Failed to read register 0x%02X", i); + } + } + + /* Check if the values are valid */ + if (vend_id != FT62XX_VENDID && vend_id != FT6336_VENDID) + { + ESP_LOGE(TAG, "Invalid vendor ID: 0x%02X", vend_id); + return ESP_FAIL; + } + + /* Check if the chip ID is supported */ + if (chip_id != FT6206_CHIPID && chip_id != FT6236_CHIPID && chip_id != FT6236U_CHIPID && chip_id != FT6336U_CHIPID && chip_id != FT3236_CHIPID) + { + ESP_LOGE(TAG, "Unsupported chip ID: 0x%02X", chip_id); + return ESP_FAIL; + } + + /* Set to work mode */ + ret |= touch_ft6x36_i2c_write(tp, FT62XX_REG_MODE, FT62XX_REG_WORKMODE); + + /* Set threshold */ + ret |= touch_ft6x36_i2c_write(tp, FT62XX_REG_THRESHHOLD, FT62XX_DEFAULT_THRESHOLD); + + /* Set point rate */ + ret |= touch_ft6x36_i2c_write(tp, FT62XX_REG_POINTRATE, 0x0E); + + return ret; +} + +/* Reset controller */ +static esp_err_t touch_ft6x36_reset(esp_lcd_touch_handle_t tp) +{ + assert(tp != NULL); + + if (tp->config.rst_gpio_num != GPIO_NUM_NC) + { + ESP_RETURN_ON_ERROR(gpio_set_level(tp->config.rst_gpio_num, tp->config.levels.reset), TAG, "GPIO set level error!"); + vTaskDelay(pdMS_TO_TICKS(20)); + ESP_RETURN_ON_ERROR(gpio_set_level(tp->config.rst_gpio_num, !tp->config.levels.reset), TAG, "GPIO set level error!"); + vTaskDelay(pdMS_TO_TICKS(500)); + } + + return ESP_OK; +} + +static esp_err_t touch_ft6x36_i2c_write(esp_lcd_touch_handle_t tp, uint8_t reg, uint8_t data) +{ + assert(tp != NULL); + + // *INDENT-OFF* + /* Write data */ + return esp_lcd_panel_io_tx_param(tp->io, reg, (uint8_t[]){data}, 1); + // *INDENT-ON* +} + +static esp_err_t touch_ft6x36_i2c_read(esp_lcd_touch_handle_t tp, uint8_t reg, uint8_t *data, uint8_t len) +{ + assert(tp != NULL); + assert(data != NULL); + + /* Read data */ + return esp_lcd_panel_io_rx_param(tp->io, reg, data, len); +} diff --git a/components/lambage__esp_lcd_touch_ft6336u/idf_component.yml b/components/lambage__esp_lcd_touch_ft6336u/idf_component.yml new file mode 100644 index 00000000..fad4bf34 --- /dev/null +++ b/components/lambage__esp_lcd_touch_ft6336u/idf_component.yml @@ -0,0 +1,12 @@ +dependencies: + esp_lcd_touch: + public: true + version: ^1.0.4 + idf: '>=4.4.2' +description: ESP LCD Touch FT6x36 - touch controller FT6x36 +repository: git://github.com/lambage/esp_lcd_touch_ft6x36.git +repository_info: + commit_sha: c2772def5d1168bb3ba85c1334dd07ea99b977ec + path: components/esp_lcd_touch_ft6x36 +url: https://github.com/espressif/esp-bsp/tree/master/components/lcd_touch +version: 1.0.8 diff --git a/components/lambage__esp_lcd_touch_ft6336u/include/esp_lcd_touch_ft6x36.h b/components/lambage__esp_lcd_touch_ft6336u/include/esp_lcd_touch_ft6x36.h new file mode 100644 index 00000000..312b8346 --- /dev/null +++ b/components/lambage__esp_lcd_touch_ft6336u/include/esp_lcd_touch_ft6x36.h @@ -0,0 +1,59 @@ +/* + * SPDX-FileCopyrightText: 2025 CFSoft Systems (Chengdu) CO LTD + * + * SPDX-License-Identifier: Apache-2.0 + */ + +/** + * @file + * @brief ESP LCD touch: FT6x36 + */ + +#pragma once + +#include "esp_lcd_touch.h" + +#ifdef __cplusplus +extern "C" +{ +#endif + + /** + * @brief Create a new FT6x36 touch driver + * + * @note The I2C communication should be initialized before use this function. + * + * @param io LCD/Touch panel IO handle + * @param config: Touch configuration + * @param out_touch: Touch instance handle + * @return + * - ESP_OK on success + * - ESP_ERR_NO_MEM if there is no memory for allocating main structure + */ + esp_err_t esp_lcd_touch_new_i2c_ft6x36(const esp_lcd_panel_io_handle_t io, const esp_lcd_touch_config_t *config, esp_lcd_touch_handle_t *out_touch); + +/** + * @brief I2C address of the FT6x36 controller + * + */ +#define ESP_LCD_TOUCH_IO_I2C_FT6x36_ADDRESS (0x38) + +/** + * @brief Touch IO configuration structure + * + */ +#define ESP_LCD_TOUCH_IO_I2C_FT6x36_CONFIG() \ + { \ + .dev_addr = ESP_LCD_TOUCH_IO_I2C_FT6x36_ADDRESS, \ + .control_phase_bytes = 1, \ + .dc_bit_offset = 0, \ + .lcd_cmd_bits = 8, \ + .flags = \ + { \ + .disable_control_phase = 1, \ + } \ + } + +#ifdef __cplusplus +} +#endif diff --git a/components/lambage__esp_lcd_touch_ft6336u/license.txt b/components/lambage__esp_lcd_touch_ft6336u/license.txt new file mode 100644 index 00000000..75b52484 --- /dev/null +++ b/components/lambage__esp_lcd_touch_ft6336u/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.