Skip to content

Commit b5bfd3b

Browse files
jfischer-nocarlescufi
authored andcommitted
drivers: udc: fixup parameter endpoint description
The description was still from the early stages of development. Signed-off-by: Johann Fischer <[email protected]>
1 parent 98770ca commit b5bfd3b

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

drivers/usb/udc/udc_common.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ void udc_set_suspended(const struct device *dev, const bool value);
5151
* @brief Get pointer to endpoint configuration structure.
5252
*
5353
* @param[in] dev Pointer to device struct of the driver instance
54-
* @param[in] ep Endpoint representation structure
54+
* @param[in] ep Endpoint address
5555
*
5656
* @return pointer to endpoint configuration or NULL on error.
5757
*/
@@ -86,7 +86,7 @@ void udc_ep_set_busy(const struct device *dev, const uint8_t ep,
8686
* be passed to the higher level.
8787
*
8888
* @param[in] dev Pointer to device struct of the driver instance
89-
* @param[in] ep Endpoint representation structure
89+
* @param[in] ep Endpoint address
9090
*
9191
* @return pointer to UDC request or NULL on error.
9292
*/
@@ -101,7 +101,7 @@ struct net_buf *udc_buf_get(const struct device *dev,
101101
* is typically used to dequeue endpoint FIFO.
102102
*
103103
* @param[in] dev Pointer to device struct of the driver instance
104-
* @param[in] ep Endpoint representation structure
104+
* @param[in] ep Endpoint address
105105
*
106106
* @return pointer to UDC request or NULL on error.
107107
*/
@@ -115,7 +115,7 @@ struct net_buf *udc_buf_get_all(const struct device *dev,
115115
* Use it when request buffer is required for a transfer.
116116
*
117117
* @param[in] dev Pointer to device struct of the driver instance
118-
* @param[in] ep Endpoint representation structure
118+
* @param[in] ep Endpoint address
119119
*
120120
* @return pointer to request or NULL on error.
121121
*/
@@ -177,7 +177,7 @@ int udc_ep_enable_internal(const struct device *dev,
177177
* This function can be used by the driver to disable control IN/OUT endpoint.
178178
*
179179
* @param[in] dev Pointer to device struct of the driver instance
180-
* @param[in] ep Endpoint representation structure
180+
* @param[in] ep Endpoint address
181181
*
182182
* @return 0 on success, all other values should be treated as error.
183183
* @retval -ENODEV endpoint is not assigned or no configuration found

0 commit comments

Comments
 (0)