include: usb: add API version

Add API versions to all relevant USB headers. Signed-off-by: Johann Fischer <[email protected]>
nordic-pikr · Oct 28, 2024 · 5cdabfa · 5cdabfa
1 parent b5a87c7
commit 5cdabfa
Show file tree

Hide file tree

Showing 13 changed files with 26 additions and 0 deletions.
diff --git a/include/zephyr/drivers/usb/udc.h b/include/zephyr/drivers/usb/udc.h
@@ -297,6 +297,8 @@ struct udc_data {
  * @brief New USB device controller (UDC) driver API
  * @defgroup udc_api USB device controller driver API
  * @ingroup io_interfaces
+ * @since 3.3
+ * @version 0.1.0
  * @{
  */
 

diff --git a/include/zephyr/drivers/usb/udc_buf.h b/include/zephyr/drivers/usb/udc_buf.h
@@ -38,6 +38,8 @@
  * @brief Buffer macros and definitions used in USB device support
  * @defgroup udc_buf Buffer macros and definitions used in USB device support
  * @ingroup usb
+ * @since 4.0
+ * @version 0.1.0
  * @{
  */
 

diff --git a/include/zephyr/drivers/usb/uhc.h b/include/zephyr/drivers/usb/uhc.h
@@ -22,6 +22,8 @@
  * @brief USB host controller (UHC) driver API
  * @defgroup uhc_api USB host controller driver API
  * @ingroup io_interfaces
+ * @since 3.3
+ * @version 0.1.0
  * @{
  */
 

diff --git a/include/zephyr/drivers/usb/usb_dc.h b/include/zephyr/drivers/usb/usb_dc.h
@@ -22,6 +22,8 @@
 /**
  * @brief USB Device Controller API
  * @defgroup _usb_device_controller_api USB Device Controller API
+ * @since 1.5
+ * @version 1.0.0
  * @{
  */
 

diff --git a/include/zephyr/usb/bos.h b/include/zephyr/usb/bos.h
@@ -14,6 +14,8 @@
  * @brief USB Binary Device Object Store support
  * @defgroup usb_bos USB BOS support
  * @ingroup usb
+ * @since 1.13
+ * @version 1.0.0
  * @{
  */
 

diff --git a/include/zephyr/usb/class/hid.h b/include/zephyr/usb/class/hid.h
@@ -24,6 +24,8 @@ extern "C" {
  * @brief hid.h API
  * @defgroup usb_hid_definitions USB HID common definitions
  * @ingroup usb
+ * @since 1.11
+ * @version 1.0.0
  * @{
  */
 

diff --git a/include/zephyr/usb/class/usb_hid.h b/include/zephyr/usb/class/usb_hid.h
@@ -24,6 +24,8 @@ extern "C" {
  * @brief usb_hid.h API
  * @defgroup usb_hid_class USB HID class API
  * @ingroup usb
+ * @since 1.11
+ * @version 1.0.0
  * @{
  */
 

diff --git a/include/zephyr/usb/class/usbd_hid.h b/include/zephyr/usb/class/usbd_hid.h
@@ -24,6 +24,8 @@ extern "C" {
  * @brief USBD HID Device API
  * @defgroup usbd_hid_device USBD HID device API
  * @ingroup usb
+ * @since 3.7
+ * @version 0.1.0
  * @{
  */
 

diff --git a/include/zephyr/usb/class/usbd_msc.h b/include/zephyr/usb/class/usbd_msc.h
@@ -27,6 +27,8 @@ struct usbd_msc_lun {
  * @brief USB Mass Storage Class device API
  * @defgroup usbd_msc_device USB Mass Storage Class device API
  * @ingroup usb
+ * @since 3.4
+ * @version 0.1.0
  * @{
  */
 

diff --git a/include/zephyr/usb/class/usbd_uac2.h b/include/zephyr/usb/class/usbd_uac2.h
@@ -23,6 +23,8 @@
  * @brief USB Audio Class 2 device API
  * @defgroup uac2_device USB Audio Class 2 device API
  * @ingroup usb
+ * @since 3.6
+ * @version 0.1.0
  * @{
  */
 

diff --git a/include/zephyr/usb/usb_device.h b/include/zephyr/usb/usb_device.h
@@ -92,6 +92,8 @@ extern "C" {
 /**
  * @brief USB Device Core Layer API
  * @defgroup _usb_device_core_api USB Device Core API
+ * @since 1.5
+ * @version 1.0.0
  * @{
  */
 

diff --git a/include/zephyr/usb/usbd.h b/include/zephyr/usb/usbd.h
@@ -32,6 +32,8 @@ extern "C" {
  * @brief New USB device stack core API
  * @defgroup usbd_api USB device core API
  * @ingroup usb
+ * @since 3.3
+ * @version 0.1.0
  * @{
  */
 

diff --git a/include/zephyr/usb/usbd_msg.h b/include/zephyr/usb/usbd_msg.h
@@ -21,6 +21,8 @@ extern "C" {
 /**
  * @defgroup usbd_msg_api USB device core API
  * @ingroup usb
+ * @since 3.7
+ * @version 0.1.0
  * @{
  */