drivers/usb/gadget/function/f_printer.c
Source file repositories/reference/linux-study-clean/drivers/usb/gadget/function/f_printer.c
File Facts
- System
- Linux kernel
- Corpus path
drivers/usb/gadget/function/f_printer.c- Extension
.c- Size
- 38618 bytes
- Lines
- 1564
- Domain
- Driver Families
- Bucket
- drivers/usb
- Inferred role
- Driver Families: operation-table or driver-model contract
- Status
- pattern implementation candidate
Why This File Exists
Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.
- Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.
- Defines an operation table; this is where Linux turns generic core objects into subsystem-specific behavior.
- Touches user memory; correctness depends on fault-safe copying and privilege boundary handling.
- Uses kernel synchronization; read lock ordering, sleepability, and interrupt context assumptions before translating.
- Allocates kernel memory; connect allocation flags and lifetime to context constraints.
- Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.
Dependency Surface
linux/module.hlinux/kernel.hlinux/delay.hlinux/ioport.hlinux/sched.hlinux/slab.hlinux/mutex.hlinux/errno.hlinux/init.hlinux/idr.hlinux/timer.hlinux/list.hlinux/interrupt.hlinux/device.hlinux/moduleparam.hlinux/fs.hlinux/poll.hlinux/types.hlinux/ctype.hlinux/cdev.hlinux/kref.hasm/byteorder.hlinux/io.hlinux/irq.hlinux/uaccess.hlinux/unaligned.hlinux/usb/ch9.hlinux/usb/composite.hlinux/usb/gadget.hlinux/usb/g_printer.hu_printer.h
Detected Declarations
struct printer_devfunction printer_dev_freefunction printer_req_allocfunction printer_req_freefunction rx_completefunction tx_completefunction printer_openfunction printer_closefunction setup_rx_reqsfunction printer_readfunction printer_writefunction printer_fsyncfunction printer_pollfunction printer_ioctlfunction set_printer_interfacefunction printer_reset_interfacefunction set_interfacefunction printer_soft_resetfunction gprinter_req_matchfunction setupfunction printer_func_bindfunction printer_func_set_altfunction printer_func_disablefunction printer_attr_releasefunction f_printer_opts_pnp_string_showfunction f_printer_opts_pnp_string_storefunction f_printer_opts_q_len_showfunction f_printer_opts_q_len_storefunction gprinter_get_minorfunction gprinter_put_minorfunction gprinter_free_instfunction gprinter_freefunction printer_func_unbindfunction gprinter_setupfunction gprinter_cleanup
Annotated Snippet
static const struct file_operations printer_io_operations = {
.owner = THIS_MODULE,
.open = printer_open,
.read = printer_read,
.write = printer_write,
.fsync = printer_fsync,
.poll = printer_poll,
.unlocked_ioctl = printer_ioctl,
.release = printer_close,
.llseek = noop_llseek,
};
/*-------------------------------------------------------------------------*/
static int
set_printer_interface(struct printer_dev *dev)
{
int result = 0;
dev->in_ep->desc = ep_desc(dev->gadget, &fs_ep_in_desc, &hs_ep_in_desc,
&ss_ep_in_desc);
dev->in_ep->driver_data = dev;
dev->out_ep->desc = ep_desc(dev->gadget, &fs_ep_out_desc,
&hs_ep_out_desc, &ss_ep_out_desc);
dev->out_ep->driver_data = dev;
result = usb_ep_enable(dev->in_ep);
if (result != 0) {
DBG(dev, "enable %s --> %d\n", dev->in_ep->name, result);
goto done;
}
result = usb_ep_enable(dev->out_ep);
if (result != 0) {
DBG(dev, "enable %s --> %d\n", dev->out_ep->name, result);
goto done;
}
done:
/* on error, disable any endpoints */
if (result != 0) {
(void) usb_ep_disable(dev->in_ep);
(void) usb_ep_disable(dev->out_ep);
dev->in_ep->desc = NULL;
dev->out_ep->desc = NULL;
}
/* caller is responsible for cleanup on error */
return result;
}
static void printer_reset_interface(struct printer_dev *dev)
{
unsigned long flags;
if (dev->interface < 0)
return;
if (dev->in_ep->desc)
usb_ep_disable(dev->in_ep);
if (dev->out_ep->desc)
usb_ep_disable(dev->out_ep);
spin_lock_irqsave(&dev->lock, flags);
dev->in_ep->desc = NULL;
dev->out_ep->desc = NULL;
dev->interface = -1;
spin_unlock_irqrestore(&dev->lock, flags);
}
/* Change our operational Interface. */
static int set_interface(struct printer_dev *dev, unsigned number)
{
int result = 0;
/* Free the current interface */
printer_reset_interface(dev);
result = set_printer_interface(dev);
if (result)
printer_reset_interface(dev);
else
dev->interface = number;
if (!result)
INFO(dev, "Using interface %x\n", number);
return result;
Annotation
- Immediate include surface: `linux/module.h`, `linux/kernel.h`, `linux/delay.h`, `linux/ioport.h`, `linux/sched.h`, `linux/slab.h`, `linux/mutex.h`, `linux/errno.h`.
- Detected declarations: `struct printer_dev`, `function printer_dev_free`, `function printer_req_alloc`, `function printer_req_free`, `function rx_complete`, `function tx_complete`, `function printer_open`, `function printer_close`, `function setup_rx_reqs`, `function printer_read`.
- Atlas domain: Driver Families / drivers/usb.
- Implementation status: pattern implementation candidate.
- This snippet crosses the user/kernel memory boundary; validate fault handling and access checks before translating the pattern.
- Synchronization appears in or near this file; preserve lock ordering, sleepability, and interrupt-context constraints.
Implementation Notes
- This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
- Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
- Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.