diff options
author | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:05:50 +0100 |
---|---|---|
committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:11:34 +0100 |
commit | 185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch) | |
tree | 2fea02768d6005934547f075586c60ba7aca6253 /drivers/usb | |
parent | 6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff) | |
download | u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.gz u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.bz2 u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.zip |
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>
Diffstat (limited to 'drivers/usb')
-rw-r--r-- | drivers/usb/host/ehci.h | 2 | ||||
-rw-r--r-- | drivers/usb/host/xhci-mem.c | 46 | ||||
-rw-r--r-- | drivers/usb/host/xhci-ring.c | 26 | ||||
-rw-r--r-- | drivers/usb/host/xhci.c | 34 | ||||
-rw-r--r-- | drivers/usb/musb-new/musb_gadget.c | 2 | ||||
-rw-r--r-- | drivers/usb/musb-new/musb_gadget_ep0.c | 2 | ||||
-rw-r--r-- | drivers/usb/musb-new/usb-compat.h | 2 |
7 files changed, 57 insertions, 57 deletions
diff --git a/drivers/usb/host/ehci.h b/drivers/usb/host/ehci.h index e9e6f2a551..5170044a3a 100644 --- a/drivers/usb/host/ehci.h +++ b/drivers/usb/host/ehci.h @@ -280,7 +280,7 @@ void ehci_set_controller_priv(int index, void *priv, * ehci_get_controller_priv() - Get controller private data * * @index Controller number to get - * @return controller pointer for this index + * Return: controller pointer for this index */ void *ehci_get_controller_priv(int index); diff --git a/drivers/usb/host/xhci-mem.c b/drivers/usb/host/xhci-mem.c index 0d9da62bab..21cd03b662 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 @@ void xhci_flush_cache(uintptr_t addr, u32 len) * * @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 @@ void xhci_inval_cache(uintptr_t addr, u32 len) * 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 @@ static void xhci_segment_free(struct xhci_segment *seg) * 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 @@ static void xhci_ring_free(struct xhci_ring *ring) * 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 @@ static void xhci_scratchpad_free(struct xhci_ctrl *ctrl) * 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 @@ static void xhci_free_container_ctx(struct xhci_container_ctx *ctx) * 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 @@ static void xhci_free_virt_devices(struct xhci_ctrl *ctrl) * 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 @@ void xhci_cleanup(struct xhci_ctrl *ctrl) * 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 @@ static void *xhci_malloc(unsigned int size) * @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 @@ static void xhci_link_segments(struct xhci_ctrl *ctrl, struct xhci_segment *prev * 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 @@ static void xhci_initialize_ring_info(struct xhci_ring *ring) * "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 @@ static struct xhci_segment *xhci_segment_alloc(void) * * @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 @@ struct xhci_ring *xhci_ring_alloc(struct xhci_ctrl *ctrl, unsigned int num_segs, * 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 @@ fail_sp: * * @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 @@ static struct xhci_container_ctx * 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 @@ int xhci_alloc_virt_device(struct xhci_ctrl *ctrl, unsigned int slot_id) * @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 @@ int xhci_mem_init(struct xhci_ctrl *ctrl, struct xhci_hccr *hccr, * 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 @@ struct xhci_input_control_ctx * * @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 @@ struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_ctrl *ctrl, * @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 @@ struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_ctrl *ctrl, * @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 @@ void xhci_endpoint_copy(struct xhci_ctrl *ctrl, * @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 @@ void xhci_slot_copy(struct xhci_ctrl *ctrl, struct xhci_container_ctx *in_ctx, * 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) diff --git a/drivers/usb/host/xhci-ring.c b/drivers/usb/host/xhci-ring.c index 35bd5cd29e..0b3e7a2f55 100644 --- a/drivers/usb/host/xhci-ring.c +++ b/drivers/usb/host/xhci-ring.c @@ -33,7 +33,7 @@ * @param ring pointer to the ring * @param seg poniter to the segment to which TRB belongs * @param trb poniter to the ring trb - * @return 1 if this TRB a link TRB else 0 + * Return: 1 if this TRB a link TRB else 0 */ static int last_trb(struct xhci_ctrl *ctrl, struct xhci_ring *ring, struct xhci_segment *seg, union xhci_trb *trb) @@ -52,7 +52,7 @@ static int last_trb(struct xhci_ctrl *ctrl, struct xhci_ring *ring, * @param ring pointer to the ring * @param seg poniter to the segment to which TRB belongs * @param trb poniter to the ring trb - * @return 1 if this TRB is the last TRB on the last segment else 0 + * Return: 1 if this TRB is the last TRB on the last segment else 0 */ static bool last_trb_on_last_seg(struct xhci_ctrl *ctrl, struct xhci_ring *ring, @@ -86,7 +86,7 @@ static bool last_trb_on_last_seg(struct xhci_ctrl *ctrl, * are expected or NOT. * Will you enqueue more TRBs before calling * prepare_ring()? - * @return none + * Return: none */ static void inc_enq(struct xhci_ctrl *ctrl, struct xhci_ring *ring, bool more_trbs_coming) @@ -178,7 +178,7 @@ static void inc_deq(struct xhci_ctrl *ctrl, struct xhci_ring *ring) * @param ring pointer to the ring * @param more_trbs_coming flag to indicate whether more trbs * @param trb_fields pointer to trb field array containing TRB contents - * @return pointer to the enqueued trb + * Return: pointer to the enqueued trb */ static struct xhci_generic_trb *queue_trb(struct xhci_ctrl *ctrl, struct xhci_ring *ring, @@ -207,7 +207,7 @@ static struct xhci_generic_trb *queue_trb(struct xhci_ctrl *ctrl, * @param ctrl Host controller data structure * @param ep_ring pointer to the EP Transfer Ring * @param ep_state State of the End Point - * @return error code in case of invalid ep_state, 0 on success + * Return: error code in case of invalid ep_state, 0 on success */ static int prepare_ring(struct xhci_ctrl *ctrl, struct xhci_ring *ep_ring, u32 ep_state) @@ -269,7 +269,7 @@ static int prepare_ring(struct xhci_ctrl *ctrl, struct xhci_ring *ep_ring, * @param slot_id Slot ID to encode in the flags field (opt.) * @param ep_index Endpoint index to encode in the flags field (opt.) * @param cmd Command type to enqueue - * @return none + * Return: none */ void xhci_queue_command(struct xhci_ctrl *ctrl, u8 *ptr, u32 slot_id, u32 ep_index, trb_type cmd) @@ -327,7 +327,7 @@ void xhci_queue_command(struct xhci_ctrl *ctrl, u8 *ptr, u32 slot_id, * @param td_total_len total packet count * @param maxp max packet size of current pipe * @param more_trbs_coming indicate last trb in TD - * @return remainder + * Return: remainder */ static u32 xhci_td_remainder(struct xhci_ctrl *ctrl, int transferred, int trb_buff_len, unsigned int td_total_len, @@ -361,7 +361,7 @@ static u32 xhci_td_remainder(struct xhci_ctrl *ctrl, int transferred, * @param ep_index index of the endpoint * @param start_cycle cycle flag of the first TRB * @param start_trb pionter to the first TRB - * @return none + * Return: none */ static void giveback_first_trb(struct usb_device *udev, int ep_index, int start_cycle, @@ -395,7 +395,7 @@ static void giveback_first_trb(struct usb_device *udev, int ep_index, * the end of each event handler, and not touch the TRB again afterwards. * * @param ctrl Host controller data structure - * @return none + * Return: none */ void xhci_acknowledge_event(struct xhci_ctrl *ctrl) { @@ -411,7 +411,7 @@ void xhci_acknowledge_event(struct xhci_ctrl *ctrl) * Checks if there is a new event to handle on the event ring. * * @param ctrl Host controller data structure - * @return 0 if failure else 1 on success + * Return: 0 if failure else 1 on success */ static int event_ready(struct xhci_ctrl *ctrl) { @@ -437,7 +437,7 @@ static int event_ready(struct xhci_ctrl *ctrl) * * @param ctrl Host controller data structure * @param expected TRB type expected from Event TRB - * @return pointer to event trb + * Return: pointer to event trb */ union xhci_trb *xhci_wait_for_event(struct xhci_ctrl *ctrl, trb_type expected) { @@ -557,7 +557,7 @@ static void record_transfer_result(struct usb_device *udev, * @param pipe contains the DIR_IN or OUT , devnum * @param length length of the buffer * @param buffer buffer to be read/written based on the request - * @return returns 0 if successful else -1 on failure + * Return: returns 0 if successful else -1 on failure */ int xhci_bulk_tx(struct usb_device *udev, unsigned long pipe, int length, void *buffer) @@ -753,7 +753,7 @@ again: * @param req request type * @param length length of the buffer * @param buffer buffer to be read/written based on the request - * @return returns 0 if successful else error code on failure + * Return: returns 0 if successful else error code on failure */ int xhci_ctrl_tx(struct usb_device *udev, unsigned long pipe, struct devrequest *req, int length, diff --git a/drivers/usb/host/xhci.c b/drivers/usb/host/xhci.c index 452dacc0af..ad73ba12e2 100644 --- a/drivers/usb/host/xhci.c +++ b/drivers/usb/host/xhci.c @@ -143,7 +143,7 @@ struct xhci_ctrl *xhci_get_ctrl(struct usb_device *udev) * @param mask mask for the value read * @param done value to be campared with result * @param usec time to wait till - * @return 0 if handshake is success else < 0 on failure + * Return: 0 if handshake is success else < 0 on failure */ static int handshake(uint32_t volatile *ptr, uint32_t mask, uint32_t done, int usec) @@ -164,7 +164,7 @@ handshake(uint32_t volatile *ptr, uint32_t mask, uint32_t done, int usec) * Set the run bit and wait for the host to be running. * * @param hcor pointer to host controller operation registers - * @return status of the Handshake + * Return: status of the Handshake */ static int xhci_start(struct xhci_hcor *hcor) { @@ -192,7 +192,7 @@ static int xhci_start(struct xhci_hcor *hcor) * Resets the XHCI Controller * * @param hcor pointer to host controller operation registers - * @return -EBUSY if XHCI Controller is not halted else status of handshake + * Return: -EBUSY if XHCI Controller is not halted else status of handshake */ static int xhci_reset(struct xhci_hcor *hcor) { @@ -244,7 +244,7 @@ static int xhci_reset(struct xhci_hcor *hcor) * index = (epnum * 2) + direction - 1 = (epnum * 2) + 1 - 1 = (epnum * 2) * * @param desc USB enpdoint Descriptor - * @return index of the Endpoint + * Return: index of the Endpoint */ static unsigned int xhci_get_ep_index(struct usb_endpoint_descriptor *desc) { @@ -447,7 +447,7 @@ static u32 xhci_get_max_esit_payload(struct usb_device *udev, * * @param udev pointer to the Device Data Structure * @param ctx_change flag to indicate the Context has changed or NOT - * @return 0 on success, -1 on failure + * Return: 0 on success, -1 on failure */ static int xhci_configure_endpoints(struct usb_device *udev, bool ctx_change) { @@ -487,7 +487,7 @@ static int xhci_configure_endpoints(struct usb_device *udev, bool ctx_change) * Configure the endpoint, programming the device contexts. * * @param udev pointer to the USB device structure - * @return returns the status of the xhci_configure_endpoints + * Return: returns the status of the xhci_configure_endpoints */ static int xhci_set_configuration(struct usb_device *udev) { @@ -630,7 +630,7 @@ static int xhci_set_configuration(struct usb_device *udev) * the device). * * @param udev pointer to the Device Data Structure - * @return 0 if successful else error code on failure + * Return: 0 if successful else error code on failure */ static int xhci_address_device(struct usb_device *udev, int root_portnr) { @@ -712,7 +712,7 @@ static int xhci_address_device(struct usb_device *udev, int root_portnr) * or allocating memory failed. * * @param udev pointer to the Device Data Structure - * @return Returns 0 on succes else return error code on failure + * Return: Returns 0 on succes else return error code on failure */ static int _xhci_alloc_device(struct usb_device *udev) { @@ -766,7 +766,7 @@ int usb_alloc_device(struct usb_device *udev) * we need to issue an evaluate context command and wait on it. * * @param udev pointer to the Device Data Structure - * @return returns the status of the xhci_configure_endpoints + * Return: returns the status of the xhci_configure_endpoints */ int xhci_check_maxpacket(struct usb_device *udev) { @@ -822,7 +822,7 @@ int xhci_check_maxpacket(struct usb_device *udev) * @param wIndex request index * @param addr address of posrt status register * @param port_status state of port status register - * @return none + * Return: none */ static void xhci_clear_port_change_bit(u16 wValue, u16 wIndex, volatile uint32_t *addr, u32 port_status) @@ -870,7 +870,7 @@ static void xhci_clear_port_change_bit(u16 wValue, * For all other types (RW1S, RW1CS, RW, and RZ), writing a '0' has no effect. * * @param state state of the Port Status and Control Regsiter - * @return a value that would result in the port being in the + * Return: a value that would result in the port being in the * same state, if the value was written to the port * status control register. */ @@ -886,7 +886,7 @@ static u32 xhci_port_state_to_neutral(u32 state) * @param udev pointer to the USB device structure * @param pipe contains the DIR_IN or OUT , devnum * @param buffer buffer to be read/written based on the request - * @return returns 0 if successful else -1 on failure + * Return: returns 0 if successful else -1 on failure */ static int xhci_submit_root(struct usb_device *udev, unsigned long pipe, void *buffer, struct devrequest *req) @@ -1116,7 +1116,7 @@ unknown: * @param buffer buffer to be read/written based on the request * @param length length of the buffer * @param interval interval of the interrupt - * @return 0 + * Return: 0 */ static int _xhci_submit_int_msg(struct usb_device *udev, unsigned long pipe, void *buffer, int length, int interval, @@ -1143,7 +1143,7 @@ static int _xhci_submit_int_msg(struct usb_device *udev, unsigned long pipe, * @param pipe contains the DIR_IN or OUT , devnum * @param buffer buffer to be read/written based on the request * @param length length of the buffer - * @return returns 0 if successful else -1 on failure + * Return: returns 0 if successful else -1 on failure */ static int _xhci_submit_bulk_msg(struct usb_device *udev, unsigned long pipe, void *buffer, int length) @@ -1165,7 +1165,7 @@ static int _xhci_submit_bulk_msg(struct usb_device *udev, unsigned long pipe, * @param length length of the buffer * @param setup Request type * @param root_portnr Root port number that this device is on - * @return returns 0 if successful else -1 on failure + * Return: returns 0 if successful else -1 on failure */ static int _xhci_submit_control_msg(struct usb_device *udev, unsigned long pipe, void *buffer, int length, @@ -1299,7 +1299,7 @@ int submit_int_msg(struct usb_device *udev, unsigned long pipe, void *buffer, * and allocates the necessary data structures * * @param index index to the host controller data structure - * @return pointer to the intialised controller + * Return: pointer to the intialised controller */ int usb_lowlevel_init(int index, enum usb_init_type init, void **controller) { @@ -1338,7 +1338,7 @@ int usb_lowlevel_init(int index, enum usb_init_type init, void **controller) * and cleans up all the related data structures * * @param index index to the host controller data structure - * @return none + * Return: none */ int usb_lowlevel_stop(int index) { diff --git a/drivers/usb/musb-new/musb_gadget.c b/drivers/usb/musb-new/musb_gadget.c index 7cca92b970..05bd948785 100644 --- a/drivers/usb/musb-new/musb_gadget.c +++ b/drivers/usb/musb-new/musb_gadget.c @@ -1966,7 +1966,7 @@ void musb_gadget_cleanup(struct musb *musb) * -ENOMEM no memory to perform the operation * * @param driver the gadget driver - * @return <0 if error, 0 if everything is fine + * Return: <0 if error, 0 if everything is fine */ #ifndef __UBOOT__ static int musb_gadget_start(struct usb_gadget *g, diff --git a/drivers/usb/musb-new/musb_gadget_ep0.c b/drivers/usb/musb-new/musb_gadget_ep0.c index cbd92fca6b..7fdd24005e 100644 --- a/drivers/usb/musb-new/musb_gadget_ep0.c +++ b/drivers/usb/musb-new/musb_gadget_ep0.c @@ -147,7 +147,7 @@ static int service_tx_status_request( * that is supposed to be a standard control request. Assumes the fifo to * be at least 2 bytes long. * - * @return 0 if the request was NOT HANDLED, + * Return: 0 if the request was NOT HANDLED, * < 0 when error * > 0 when the request is processed * diff --git a/drivers/usb/musb-new/usb-compat.h b/drivers/usb/musb-new/usb-compat.h index 1c66c4fe36..df68c9220a 100644 --- a/drivers/usb/musb-new/usb-compat.h +++ b/drivers/usb/musb-new/usb-compat.h @@ -72,7 +72,7 @@ static inline int usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, * usb_dev_get_parent() - Get the parent of a USB device * * @udev: USB struct containing information about the device - * @return associated device for which udev == dev_get_parent_priv(dev) + * Return: associated device for which udev == dev_get_parent_priv(dev) */ struct usb_device *usb_dev_get_parent(struct usb_device *udev); |