From 56a159a7d5653102b5342105ace445bfe1542459 Mon Sep 17 00:00:00 2001 From: Tomas Rezucha Date: Tue, 19 Dec 2023 19:39:54 +0100 Subject: [PATCH] refactor(esp_hid): Move header files to esp_private directory esp_hidd_private.h and esp_hidh_private.h are required by components that extend esp_hid with a new transport layer, such as USB --- .../esp_private}/esp_hidd_private.h | 18 +++++------------- .../esp_private}/esp_hidh_private.h | 4 +--- components/esp_hid/src/ble_hidd.c | 4 ++-- components/esp_hid/src/ble_hidh.c | 4 ++-- components/esp_hid/src/bt_hidd.c | 4 ++-- components/esp_hid/src/bt_hidh.c | 4 ++-- components/esp_hid/src/esp_hidd.c | 4 ++-- components/esp_hid/src/esp_hidh.c | 4 ++-- components/esp_hid/src/nimble_hidd.c | 4 ++-- components/esp_hid/src/nimble_hidh.c | 4 ++-- tools/ci/check_copyright_ignore.txt | 1 - 11 files changed, 22 insertions(+), 33 deletions(-) rename components/esp_hid/{private => include/esp_private}/esp_hidd_private.h (77%) rename components/esp_hid/{private => include/esp_private}/esp_hidh_private.h (98%) diff --git a/components/esp_hid/private/esp_hidd_private.h b/components/esp_hid/include/esp_private/esp_hidd_private.h similarity index 77% rename from components/esp_hid/private/esp_hidd_private.h rename to components/esp_hid/include/esp_private/esp_hidd_private.h index abb76efc11..bac88d1e16 100644 --- a/components/esp_hid/private/esp_hidd_private.h +++ b/components/esp_hid/include/esp_private/esp_hidd_private.h @@ -1,16 +1,8 @@ -// Copyright 2017-2019 Espressif Systems (Shanghai) PTE LTD -// -// 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. +/* + * SPDX-FileCopyrightText: 2017-2024 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Apache-2.0 + */ #pragma once diff --git a/components/esp_hid/private/esp_hidh_private.h b/components/esp_hid/include/esp_private/esp_hidh_private.h similarity index 98% rename from components/esp_hid/private/esp_hidh_private.h rename to components/esp_hid/include/esp_private/esp_hidh_private.h index f567508d61..c380b5aebf 100644 --- a/components/esp_hid/private/esp_hidh_private.h +++ b/components/esp_hid/include/esp_private/esp_hidh_private.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2017-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2017-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -46,8 +46,6 @@ typedef struct esp_hidh_dev_report_s { * @brief HIDH device data */ struct esp_hidh_dev_s { - struct esp_hidh_dev_s *next; - esp_hid_device_config_t config; esp_hid_usage_t usage; esp_hid_transport_t transport; //BT, BLE or USB diff --git a/components/esp_hid/src/ble_hidd.c b/components/esp_hid/src/ble_hidd.c index a70e47a317..743b6c35ba 100644 --- a/components/esp_hid/src/ble_hidd.c +++ b/components/esp_hid/src/ble_hidd.c @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2017-2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2017-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -10,7 +10,7 @@ #include "ble_hidd.h" #if CONFIG_GATTS_ENABLE -#include "esp_hidd_private.h" +#include "esp_private/esp_hidd_private.h" #include "esp_log.h" #include "esp_bt_main.h" #include "esp_bt_defs.h" diff --git a/components/esp_hid/src/ble_hidh.c b/components/esp_hid/src/ble_hidh.c index 8df54c2fc9..a5d2bd9d0a 100644 --- a/components/esp_hid/src/ble_hidh.c +++ b/components/esp_hid/src/ble_hidh.c @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2017-2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2017-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -7,7 +7,7 @@ #include #include "ble_hidh.h" #if CONFIG_GATTC_ENABLE -#include "esp_hidh_private.h" +#include "esp_private/esp_hidh_private.h" #include "esp_err.h" #include "esp_log.h" diff --git a/components/esp_hid/src/bt_hidd.c b/components/esp_hid/src/bt_hidd.c index 08e7209a36..ec888267ff 100644 --- a/components/esp_hid/src/bt_hidd.c +++ b/components/esp_hid/src/bt_hidd.c @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2017-2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2017-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -10,7 +10,7 @@ #include "esp_bt_main.h" #include "esp_hidd.h" #include "esp_hidd_api.h" -#include "esp_hidd_private.h" +#include "esp_private/esp_hidd_private.h" #include "esp_log.h" #include "osi/mutex.h" #include "string.h" diff --git a/components/esp_hid/src/bt_hidh.c b/components/esp_hid/src/bt_hidh.c index 6f0410e302..c7d2e60112 100644 --- a/components/esp_hid/src/bt_hidh.c +++ b/components/esp_hid/src/bt_hidh.c @@ -1,12 +1,12 @@ /* - * SPDX-FileCopyrightText: 2017-2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2017-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ #include "bt_hidh.h" #if CONFIG_BT_HID_HOST_ENABLED -#include "esp_hidh_private.h" +#include "esp_private/esp_hidh_private.h" #include #include diff --git a/components/esp_hid/src/esp_hidd.c b/components/esp_hid/src/esp_hidd.c index 571f963d65..129c7b16a9 100644 --- a/components/esp_hid/src/esp_hidd.c +++ b/components/esp_hid/src/esp_hidd.c @@ -1,11 +1,11 @@ /* - * SPDX-FileCopyrightText: 2017-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2017-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ #include "esp_hidd.h" -#include "esp_hidd_private.h" +#include "esp_private/esp_hidd_private.h" #include "esp_event_base.h" #if CONFIG_GATTS_ENABLE || CONFIG_BT_NIMBLE_ENABLED diff --git a/components/esp_hid/src/esp_hidh.c b/components/esp_hid/src/esp_hidh.c index c4e18e0291..b13bac6a71 100644 --- a/components/esp_hid/src/esp_hidh.c +++ b/components/esp_hid/src/esp_hidh.c @@ -1,11 +1,11 @@ /* - * SPDX-FileCopyrightText: 2017-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2017-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ #include "sys/queue.h" -#include "esp_hidh_private.h" +#include "esp_private/esp_hidh_private.h" #include "bt_hidh.h" #include "ble_hidh.h" #include diff --git a/components/esp_hid/src/nimble_hidd.c b/components/esp_hid/src/nimble_hidd.c index 53631d980e..f9c9cadf5c 100644 --- a/components/esp_hid/src/nimble_hidd.c +++ b/components/esp_hid/src/nimble_hidd.c @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2017-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2017-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -8,7 +8,7 @@ #include #include "ble_hidd.h" -#include "esp_hidd_private.h" +#include "esp_private/esp_hidd_private.h" #include "esp_log.h" #include diff --git a/components/esp_hid/src/nimble_hidh.c b/components/esp_hid/src/nimble_hidh.c index d1881159b5..55c8f3b604 100644 --- a/components/esp_hid/src/nimble_hidh.c +++ b/components/esp_hid/src/nimble_hidh.c @@ -1,12 +1,12 @@ /* - * SPDX-FileCopyrightText: 2017-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2017-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ #include #include "ble_hidh.h" -#include "esp_hidh_private.h" +#include "esp_private/esp_hidh_private.h" #include "esp_err.h" #include "esp_log.h" diff --git a/tools/ci/check_copyright_ignore.txt b/tools/ci/check_copyright_ignore.txt index b4645eeed4..4c7e87f847 100644 --- a/tools/ci/check_copyright_ignore.txt +++ b/tools/ci/check_copyright_ignore.txt @@ -410,7 +410,6 @@ components/esp_hid/include/esp_hidh_bluedroid.h components/esp_hid/include/esp_hidh_gattc.h components/esp_hid/private/bt_hidd.h components/esp_hid/private/bt_hidh.h -components/esp_hid/private/esp_hidd_private.h components/esp_local_ctrl/src/esp_local_ctrl_handler.c components/esp_local_ctrl/src/esp_local_ctrl_priv.h components/esp_local_ctrl/src/esp_local_ctrl_transport_ble.c