doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value.
find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
diff --git a/drivers/usb/host/xhci-mem.c b/drivers/usb/host/xhci-mem.c
index 0d9da62..21cd03b 100644
--- a/drivers/usb/host/xhci-mem.c
+++ b/drivers/usb/host/xhci-mem.c
@@ -32,7 +32,7 @@
*
* @param addr pointer to memory region to be flushed
* @param len the length of the cache line to be flushed
- * @return none
+ * Return: none
*/
void xhci_flush_cache(uintptr_t addr, u32 len)
{
@@ -47,7 +47,7 @@
*
* @param addr pointer to memory region to be invalidates
* @param len the length of the cache line to be invalidated
- * @return none
+ * Return: none
*/
void xhci_inval_cache(uintptr_t addr, u32 len)
{
@@ -62,7 +62,7 @@
* frees the "segment" pointer passed
*
* @param ptr pointer to "segement" to be freed
- * @return none
+ * Return: none
*/
static void xhci_segment_free(struct xhci_segment *seg)
{
@@ -76,7 +76,7 @@
* frees the "ring" pointer passed
*
* @param ptr pointer to "ring" to be freed
- * @return none
+ * Return: none
*/
static void xhci_ring_free(struct xhci_ring *ring)
{
@@ -101,7 +101,7 @@
* Free the scratchpad buffer array and scratchpad buffers
*
* @ctrl host controller data structure
- * @return none
+ * Return: none
*/
static void xhci_scratchpad_free(struct xhci_ctrl *ctrl)
{
@@ -120,7 +120,7 @@
* frees the "xhci_container_ctx" pointer passed
*
* @param ptr pointer to "xhci_container_ctx" to be freed
- * @return none
+ * Return: none
*/
static void xhci_free_container_ctx(struct xhci_container_ctx *ctx)
{
@@ -132,7 +132,7 @@
* frees the virtual devices for "xhci_ctrl" pointer passed
*
* @param ptr pointer to "xhci_ctrl" whose virtual devices are to be freed
- * @return none
+ * Return: none
*/
static void xhci_free_virt_devices(struct xhci_ctrl *ctrl)
{
@@ -170,7 +170,7 @@
* frees all the memory allocated
*
* @param ptr pointer to "xhci_ctrl" to be cleaned up
- * @return none
+ * Return: none
*/
void xhci_cleanup(struct xhci_ctrl *ctrl)
{
@@ -187,7 +187,7 @@
* Malloc the aligned memory
*
* @param size size of memory to be allocated
- * @return allocates the memory and returns the aligned pointer
+ * Return: allocates the memory and returns the aligned pointer
*/
static void *xhci_malloc(unsigned int size)
{
@@ -212,7 +212,7 @@
* @param prev pointer to the previous segment
* @param next pointer to the next segment
* @param link_trbs flag to indicate whether to link the trbs or NOT
- * @return none
+ * Return: none
*/
static void xhci_link_segments(struct xhci_ctrl *ctrl, struct xhci_segment *prev,
struct xhci_segment *next, bool link_trbs)
@@ -243,7 +243,7 @@
* Initialises the Ring's enqueue,dequeue,enq_seg pointers
*
* @param ring pointer to the RING to be intialised
- * @return none
+ * Return: none
*/
static void xhci_initialize_ring_info(struct xhci_ring *ring)
{
@@ -271,7 +271,7 @@
* "All components of all Command and Transfer TRBs shall be initialized to '0'"
*
* @param none
- * @return pointer to the newly allocated SEGMENT
+ * Return: pointer to the newly allocated SEGMENT
*/
static struct xhci_segment *xhci_segment_alloc(void)
{
@@ -300,7 +300,7 @@
*
* @param num_segs number of segments in the ring
* @param link_trbs flag to indicate whether to link the trbs or NOT
- * @return pointer to the newly created RING
+ * Return: pointer to the newly created RING
*/
struct xhci_ring *xhci_ring_alloc(struct xhci_ctrl *ctrl, unsigned int num_segs,
bool link_trbs)
@@ -346,7 +346,7 @@
* Set up the scratchpad buffer array and scratchpad buffers
*
* @ctrl host controller data structure
- * @return -ENOMEM if buffer allocation fails, 0 on success
+ * Return: -ENOMEM if buffer allocation fails, 0 on success
*/
static int xhci_scratchpad_alloc(struct xhci_ctrl *ctrl)
{
@@ -419,7 +419,7 @@
*
* @param ctrl Host controller data structure
* @param type type of XHCI Container Context
- * @return NULL if failed else pointer to the context on success
+ * Return: NULL if failed else pointer to the context on success
*/
static struct xhci_container_ctx
*xhci_alloc_container_ctx(struct xhci_ctrl *ctrl, int type)
@@ -445,7 +445,7 @@
* Allocating virtual device
*
* @param udev pointer to USB deivce structure
- * @return 0 on success else -1 on failure
+ * Return: 0 on success else -1 on failure
*/
int xhci_alloc_virt_device(struct xhci_ctrl *ctrl, unsigned int slot_id)
{
@@ -504,7 +504,7 @@
* @param ctrl Host controller data structure
* @param hccr pointer to HOST Controller Control Registers
* @param hcor pointer to HOST Controller Operational Registers
- * @return 0 if successful else -1 on failure
+ * Return: 0 if successful else -1 on failure
*/
int xhci_mem_init(struct xhci_ctrl *ctrl, struct xhci_hccr *hccr,
struct xhci_hcor *hcor)
@@ -611,7 +611,7 @@
* Give the input control context for the passed container context
*
* @param ctx pointer to the context
- * @return pointer to the Input control context data
+ * Return: pointer to the Input control context data
*/
struct xhci_input_control_ctx
*xhci_get_input_control_ctx(struct xhci_container_ctx *ctx)
@@ -625,7 +625,7 @@
*
* @param ctrl Host controller data structure
* @param ctx pointer to the context
- * @return pointer to the slot control context data
+ * Return: pointer to the slot control context data
*/
struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_ctrl *ctrl,
struct xhci_container_ctx *ctx)
@@ -643,7 +643,7 @@
* @param ctrl Host controller data structure
* @param ctx context container
* @param ep_index index of the endpoint
- * @return pointer to the End point context
+ * Return: pointer to the End point context
*/
struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_ctrl *ctrl,
struct xhci_container_ctx *ctx,
@@ -668,7 +668,7 @@
* @param in_ctx contains the input context
* @param out_ctx contains the input context
* @param ep_index index of the end point
- * @return none
+ * Return: none
*/
void xhci_endpoint_copy(struct xhci_ctrl *ctrl,
struct xhci_container_ctx *in_ctx,
@@ -697,7 +697,7 @@
* @param ctrl Host controller data structure
* @param in_ctx contains the inpout context
* @param out_ctx contains the inpout context
- * @return none
+ * Return: none
*/
void xhci_slot_copy(struct xhci_ctrl *ctrl, struct xhci_container_ctx *in_ctx,
struct xhci_container_ctx *out_ctx)
@@ -718,7 +718,7 @@
* Setup an xHCI virtual device for a Set Address command
*
* @param udev pointer to the Device Data Structure
- * @return returns negative value on failure else 0 on success
+ * Return: returns negative value on failure else 0 on success
*/
void xhci_setup_addressable_virt_dev(struct xhci_ctrl *ctrl,
struct usb_device *udev, int hop_portnr)