summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsakumisu <[email protected]>2024-10-30 21:04:06 +0800
committersakumisu <[email protected]>2024-10-30 21:04:06 +0800
commit4784017f56e6c7f8698badb5055ca6c89eaf384a (patch)
treed16f41d4c94b1bbc27f7ffd3520b9a946baf2e37
parent149fb046bcadcec1caecc5f23ad18a9cc49458f6 (diff)
chore: update comment
-rw-r--r--core/usbd_core.c16
1 files changed, 12 insertions, 4 deletions
diff --git a/core/usbd_core.c b/core/usbd_core.c
index ea471e54..41507007 100644
--- a/core/usbd_core.c
+++ b/core/usbd_core.c
@@ -98,6 +98,7 @@ static bool is_device_configured(uint8_t busid)
* This function sets endpoint configuration according to one specified in USB
* endpoint descriptor and then enables it for data transfers.
*
+ * @param [in] busid busid
* @param [in] ep Endpoint descriptor byte array
*
* @return true if successfully configured and enabled
@@ -125,6 +126,7 @@ static bool usbd_set_endpoint(uint8_t busid, const struct usb_endpoint_descripto
* This function cancels transfers that are associated with endpoint and
* disabled endpoint itself.
*
+ * @param [in] busid busid
* @param [in] ep Endpoint descriptor byte array
*
* @return true if successfully deconfigured and disabled
@@ -144,6 +146,7 @@ static bool usbd_reset_endpoint(uint8_t busid, const struct usb_endpoint_descrip
* This function parses the list of installed USB descriptors and attempts
* to find the specified USB descriptor.
*
+ * @param [in] busid busid
* @param [in] type_index Type and index of the descriptor
* @param [out] data Descriptor data
* @param [out] len Descriptor length
@@ -370,6 +373,7 @@ static bool usbd_get_descriptor(uint8_t busid, uint16_t type_index, uint8_t **da
* index and alternate setting by parsing the installed USB descriptor list.
* A configuration index of 0 unconfigures the device.
*
+ * @param [in] busid busid
* @param [in] config_index Configuration index
* @param [in] alt_setting Alternate setting number
*
@@ -439,6 +443,7 @@ static bool usbd_set_configuration(uint8_t busid, uint8_t config_index, uint8_t
/**
* @brief set USB interface
*
+ * @param [in] busid busid
* @param [in] iface Interface index
* @param [in] alt_setting Alternate setting number
*
@@ -522,6 +527,7 @@ find_end:
/**
* @brief handle a standard device request
*
+ * @param [in] busid busid
* @param [in] setup The setup packet
* @param [in,out] data Data buffer
* @param [in,out] len Pointer to data length
@@ -617,6 +623,7 @@ static bool usbd_std_device_req_handler(uint8_t busid, struct usb_setup_packet *
/**
* @brief handle a standard interface request
*
+ * @param [in] busid busid
* @param [in] setup The setup packet
* @param [in,out] data Data buffer
* @param [in,out] len Pointer to data length
@@ -723,6 +730,7 @@ static bool usbd_std_interface_req_handler(uint8_t busid, struct usb_setup_packe
/**
* @brief handle a standard endpoint request
*
+ * @param [in] busid busid
* @param [in] setup The setup packet
* @param [in,out] data Data buffer
* @param [in,out] len Pointer to data length
@@ -787,6 +795,7 @@ static bool usbd_std_endpoint_req_handler(uint8_t busid, struct usb_setup_packet
/**
* @brief handle standard requests (list in chapter 9)
*
+ * @param [in] busid busid
* @param [in] setup The setup packet
* @param [in,out] data Data buffer
* @param [in,out] len Pointer to data length
@@ -830,8 +839,7 @@ static int usbd_standard_request_handler(uint8_t busid, struct usb_setup_packet
/**
* @brief handler for class requests
*
- * If a custom request handler was installed, this handler is called first.
- *
+ * @param [in] busid busid
* @param [in] setup The setup packet
* @param [in,out] data Data buffer
* @param [in,out] len Pointer to data length
@@ -863,8 +871,7 @@ static int usbd_class_request_handler(uint8_t busid, struct usb_setup_packet *se
/**
* @brief handler for vendor requests
*
- * If a custom request handler was installed, this handler is called first.
- *
+ * @param [in] busid busid
* @param [in] setup The setup packet
* @param [in,out] data Data buffer
* @param [in,out] len Pointer to data length
@@ -1006,6 +1013,7 @@ static int usbd_vendor_request_handler(uint8_t busid, struct usb_setup_packet *s
/**
* @brief handle setup request( standard/class/vendor/other)
*
+ * @param [in] busid busid
* @param [in] setup The setup packet
* @param [in,out] data Data buffer
* @param [in,out] len Pointer to data length