usb_make_path – returns stable device path in the usb tree Synopsis int usb_make_path(struct usb_device *dev, char *buf, size_t size); Arguments dev the device whose path is being constructed buf where to put the string size how big is “buf”? Return Length of the string (> 0) or negative if size was too small. Note This…
usb_lock_device_for_reset – cautiously acquire the lock for a usb device structure Synopsis int usb_lock_device_for_reset(struct usb_device *udev, const struct usb_interface *iface); Arguments udev device that’s being locked iface interface bound to the driver making the request (optional) Description Attempts to acquire the device lock, but fails if the device is NOTATTACHED or SUSPENDED, or if iface…
usb_kill_urb – cancel a transfer request and wait for it to finish Synopsis void usb_kill_urb(struct urb *urb); Arguments urb pointer to URB describing a previously submitted request, may be NULL Description This routine cancels an in-progress request. It is guaranteed that upon return all completion handlers will have finished and the URB will be totally…
usb_kill_anchored_urbs – cancel transfer requests en masse Synopsis void usb_kill_anchored_urbs(struct usb_anchor *anchor); Arguments anchor anchor the requests are bound to Description this allows all outstanding URBs to be killed starting from the back of the queue This routine should not be called by a driver after its disconnect method has returned. Copyright
usb_interrupt_msg – Builds an interrupt urb, sends it off and waits for completion Synopsis int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout); Arguments usb_dev pointer to the usb device to send the message to pipe endpoint “pipe” to send the message to data pointer to the data to…
usb_interface_id – allocate an unused interface ID Synopsis int usb_interface_id(struct usb_configuration *config, struct usb_function *function); Arguments config configuration associated with the interface function function handling the interface Context single threaded during gadget setup Description usb_interface_id is called from usb_function.bind callbacks to allocate new interface IDs. The function driver will then store that ID in interface,…
usb_interface_claimed – returns true iff an interface is claimed Synopsis int usb_interface_claimed(struct usb_interface *iface); Arguments iface the interface being checked Return true (nonzero) iff the interface is claimed, else false (zero). Note Callers must own the driver model’s usb bus readlock. So driver probe entries don’t need extra locking, but other call contexts may need…
usb_init_urb – initializes a urb so that it can be used by a USB driver Synopsis void usb_init_urb(struct urb *urb); Arguments urb pointer to the urb to initialize Description Initializes a urb so that the USB subsystem can use it properly. If a urb is created with a call to usb_alloc_urb it is not necessary…
usb_ifnum_to_if – get the interface object with a given interface number Synopsis struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev, unsigned ifnum); Arguments dev the device whose current configuration is considered ifnum the desired interface Description This walks the device descriptor for the currently active configuration to find the interface object with the particular interface number. Note…
usb_hub_for_each_child – iterate over all child devices on the hub Synopsis usb_hub_for_each_child(hdev, port1, child); Arguments hdev USB device belonging to the usb hub port1 portnum associated with child device child child device pointer Copyright
usb_hub_find_child – Get the pointer of child device attached to the port which is specified by port1. Synopsis struct usb_device *usb_hub_find_child(struct usb_device *hdev, int port1); Arguments hdev USB device belonging to the usb hub port1 port num to indicate which port the child device is attached to. Description USB drivers call this function to get…
usb_hub_clear_tt_buffer – clear control/bulk TT state in high speed hub Synopsis int usb_hub_clear_tt_buffer(struct urb *urb); Arguments urb an URB associated with the failed or incomplete split transaction Description High speed HCDs use this to tell the hub driver that some split control or bulk transaction failed in a way that requires clearing internal state of…
usb_hcd_unlink_urb_from_ep – remove an URB from its endpoint queue Synopsis void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb); Arguments hcd host controller to which urb was submitted urb URB being unlinked Description Host controller drivers should call this routine before calling usb_hcd_giveback_urb. The HCD’s private spinlock must be held and interrupts must be disabled. The actions…
usb_hcd_resume_root_hub – called by HCD to resume its root hub Synopsis void usb_hcd_resume_root_hub(struct usb_hcd *hcd); Arguments hcd host controller for this root hub Description The USB host controller calls this function when its root hub is suspended (with the remote wakeup feature enabled) and a remote wakeup request is received. The routine submits a workqueue…
usb_hcd_pci_shutdown – shutdown host controller Synopsis void usb_hcd_pci_shutdown(struct pci_dev *dev); Arguments dev USB Host Controller being shutdown Copyright
usb_hcd_pci_remove – shutdown processing for PCI-based HCDs Synopsis void usb_hcd_pci_remove(struct pci_dev *dev); Arguments dev USB Host Controller being removed Context !in_interrupt Description Reverses the effect of usb_hcd_pci_probe, first invoking the HCD’s stop method. It is always called from a thread context, normally “rmmod”, “apmd”, or something similar. Store this function in the HCD’s struct pci_driver…
usb_hcd_pci_probe – initialize PCI-based HCDs Synopsis int usb_hcd_pci_probe(struct pci_dev *dev, const struct pci_device_id *id); Arguments dev USB Host Controller being probed id pci hotplug id connecting controller to HCD framework Context !in_interrupt Description Allocates basic PCI resources for this USB host controller, and then invokes the start method for the HCD associated with it through…
usb_hcd_link_urb_to_ep – add an URB to its endpoint queue Synopsis int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb); Arguments hcd host controller to which urb was submitted urb URB being submitted Description Host controller drivers should call this routine in their enqueue method. The HCD’s private spinlock must be held and interrupts must be disabled. The…
usb_hcd_irq – hook IRQs to HCD framework (bus glue) Synopsis irqreturn_t usb_hcd_irq(int irq, void * __hcd); Arguments irq the IRQ being raised __hcd pointer to the HCD whose IRQ is being signaled Description If the controller isn’t HALTed, calls the driver’s irq handler. Checks whether the controller is now dead. Return IRQ_HANDLED if the IRQ was handled. IRQ_NONE…
usb_hcd_giveback_urb – return URB from HCD to device driver Synopsis void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status); Arguments hcd host controller returning the URB urb urb being returned to the USB device driver. status completion status code for the URB. Context in_interrupt Description This hands the URB from HCD to its USB device…