Make new usb_reset_interface_device header so old usb_reset_interface header remains the same

Author: will-v-pi

src/common/pico_usb_reset_interface_headers/BUILD.bazel

@@ -2,6 +2,6 @@ package(default_visibility = ["//visibility:public"])
 
 cc_library(
     name = "pico_usb_reset_interface_headers",
-    hdrs = ["include/pico/usb_reset_interface.h", "include/pico/usb_reset_interface_config.h", "include/pico/usb_reset_interface_tusb.h"],
+    hdrs = ["include/pico/usb_reset_interface.h", "include/pico/usb_reset_interface_config.h", "include/pico/usb_reset_interface_device.h", "include/pico/usb_reset_interface_tusb.h"],
     includes = ["include"],
 )

src/common/pico_usb_reset_interface_headers/include/pico/usb_reset_interface.h

@@ -8,27 +8,11 @@
 #define _PICO_USB_RESET_INTERFACE_H
 
 /** \file usb_reset_interface.h
- *  \defgroup pico_usb_reset_interface pico_usb_reset_interface
+ *  \defgroup pico_usb_reset_interface_headers pico_usb_reset_interface_headers
  *
- * \brief Functionality to enable the RP-series microcontroller to be reset over the USB interface.
- *
- * This library can be used to enable the RP-series microcontroller to be reset over the USB interface.
- *
- * This functionality is included by default when using the `pico_stdio_usb` library and not using TinyUSB directly.
- *
- * To add this functionality to a project using TinyUSB directly, you need to:
- * 1. Link the pico_usb_reset_interface library, and include the `pico/usb_reset_interface.h` header file where needed.
- * 2. Define PICO_STDIO_USB_ENABLE_RESET_VIA_VENDOR_INTERFACE=1
- * 3. Add `TUD_RPI_RESET_DESCRIPTOR(<ITF_NUM>, <STR_IDX>)` to your USB descriptors (length is `TUD_RPI_RESET_DESC_LEN`)
- * 4. Check if your project has an existing `usbd_app_driver_get_cb` function:
- *    - If it does, you need to add the `pico_usb_reset_interface_driver` to the drivers returned
- *    - If it does not, and you aren't using the `pico_stdio_usb` library, you need to define `PICO_STDIO_USB_RESET_INCLUDE_APP_DRIVER_CB=1`
- * 5. Check if your project has an existing Microsoft OS 2.0 Descriptor:
- *    - If it does, you need to add the Function Subset header `RPI_RESET_MS_OS_20_DESCRIPTOR(<ITF_NUM>)` to your Microsoft OS 2.0 Descriptor (length is `RPI_RESET_MS_OS_20_DESC_LEN`)
- *    - If it does not, you need to define `PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_MS_OS_20_DESCRIPTOR=1` and `PICO_STDIO_USB_RESET_INTERFACE_MS_OS_20_DESCRIPTOR_ITF=<ITF_NUM>`
+ * \brief Definition for the reset interface that may be exposed by the pico_stdio_usb library
  */
 
-// These defines are used by picotool
 // VENDOR sub-class for the reset interface
 #define RESET_INTERFACE_SUBCLASS 0x00
 // VENDOR protocol for the reset interface
@@ -41,12 +25,4 @@
 // regular flash boot
 #define RESET_REQUEST_FLASH 0x02
 
-#if LIB_PICO_USB_RESET_INTERFACE
-// These defines are only used by the pico_usb_reset_interface library, not the pico_usb_reset_interface_headers library
-
-#include "pico/usb_reset_interface_config.h"
-#include "pico/usb_reset_interface_tusb.h"
-
-#endif
-
 #endif

src/common/pico_usb_reset_interface_headers/include/pico/usb_reset_interface_device.h

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2025 Raspberry Pi (Trading) Ltd.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+#ifndef _PICO_USB_RESET_INTERFACE_DEVICE_H
+#define _PICO_USB_RESET_INTERFACE_DEVICE_H
+
+/** \file usb_reset_interface_device.h
+ *  \defgroup pico_usb_reset_interface pico_usb_reset_interface
+ *
+ * \brief Functionality to enable the RP-series microcontroller to be reset over the USB interface.
+ *
+ * This library can be used to enable the RP-series microcontroller to be reset over the USB interface.
+ *
+ * This functionality is included by default when using the `pico_stdio_usb` library and not using TinyUSB directly.
+ *
+ * To add this functionality to a project using TinyUSB directly, you need to:
+ * 1. Link the pico_usb_reset_interface library, and include the `pico/usb_reset_interface_device.h` header file where needed.
+ * 2. Define PICO_STDIO_USB_ENABLE_RESET_VIA_VENDOR_INTERFACE=1
+ * 3. Add `TUD_RPI_RESET_DESCRIPTOR(<ITF_NUM>, <STR_IDX>)` to your USB descriptors (length is `TUD_RPI_RESET_DESC_LEN`)
+ * 4. Check if your project has an existing `usbd_app_driver_get_cb` function:
+ *    - If it does, you need to add the `pico_usb_reset_interface_driver` to the drivers returned
+ *    - If it does not, and you aren't using the `pico_stdio_usb` library, you need to define `PICO_STDIO_USB_RESET_INCLUDE_APP_DRIVER_CB=1`
+ * 5. Check if your project has an existing Microsoft OS 2.0 Descriptor:
+ *    - If it does, you need to add the Function Subset header `RPI_RESET_MS_OS_20_DESCRIPTOR(<ITF_NUM>)` to your Microsoft OS 2.0 Descriptor (length is `RPI_RESET_MS_OS_20_DESC_LEN`)
+ *    - If it does not, you need to define `PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_MS_OS_20_DESCRIPTOR=1` and `PICO_STDIO_USB_RESET_INTERFACE_MS_OS_20_DESCRIPTOR_ITF=<ITF_NUM>`
+ */
+
+#include "pico/usb_reset_interface.h"
+#include "pico/usb_reset_interface_config.h"
+#include "pico/usb_reset_interface_tusb.h"
+
+#endif

src/rp2_common/pico_stdio_usb/stdio_usb_descriptors.c

@@ -27,7 +27,7 @@
  */
 
 #include "pico/stdio_usb.h"
-#include "pico/usb_reset_interface.h"
+#include "pico/usb_reset_interface_device.h"
 #include "pico/unique_id.h"
 #include "tusb.h"
 

src/rp2_common/pico_usb_reset_interface/usb_reset_interface.c

@@ -6,7 +6,7 @@
 #include "tusb.h"
 
 #include "pico/bootrom.h"
-#include "pico/usb_reset_interface.h"
+#include "pico/usb_reset_interface_device.h"
 
 #if !defined(LIB_TINYUSB_HOST)