drivers/usb/gadget/function/u_serial.c

File Facts

System

Linux kernel

Corpus path

drivers/usb/gadget/function/u_serial.c

Extension

.c

Size

39437 bytes

Lines

1608

Domain

Driver Families

Bucket

drivers/usb

Inferred role

Driver Families: exported/initcall integration point

Status

integration 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.
• Exports symbols or registers init work; inspect boot/module ordering and who consumes the exported contract.
• 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/kernel.h
• linux/sched.h
• linux/device.h
• linux/delay.h
• linux/tty.h
• linux/tty_flip.h
• linux/slab.h
• linux/string_choices.h
• linux/export.h
• linux/module.h
• linux/console.h
• linux/kstrtox.h
• linux/kthread.h
• linux/workqueue.h
• linux/kfifo.h
• linux/serial.h
• u_serial.h

Detected Declarations

• struct gs_console
• struct gs_port
• function gs_alloc_req
• function gs_free_req
• function gs_send_packet
• function data
• function gs_read_complete
• function gs_write_complete
• function gs_free_requests
• function gs_alloc_requests
• function gs_start_io
• function gserial_wakeup_host
• function close
• function gs_close_flush_done
• function gs_close
• function gs_write
• function gs_put_char
• function gs_flush_chars
• function gs_write_room
• function gs_chars_in_buffer
• function gs_unthrottle
• function gs_break_ctl
• function gs_get_icount
• function gs_console_complete_out
• function __gs_console_push
• function gs_console_work
• function gs_console_write
• function gs_console_connect
• function gs_console_disconnect
• function gs_console_init
• function gs_console_exit
• function gserial_set_console
• function gserial_get_console
• function gs_console_connect
• function gs_console_disconnect
• function gs_console_exit
• function gs_closed
• function gserial_free_port
• function gserial_free_line
• function gserial_alloc_line_no_console
• function gserial_alloc_line
• function gserial_connect
• function gserial_disconnect
• function gserial_suspend
• function gserial_resume
• function userial_init
• function userial_cleanup
• module init userial_init

Annotated Snippet

module_init(userial_init);

static void __exit userial_cleanup(void)
{
	tty_unregister_driver(gs_tty_driver);
	tty_driver_kref_put(gs_tty_driver);
	gs_tty_driver = NULL;
}
module_exit(userial_cleanup);

MODULE_DESCRIPTION("utilities for USB gadget \"serial port\"/TTY support");
MODULE_LICENSE("GPL");

Annotation

• Immediate include surface: `linux/kernel.h`, `linux/sched.h`, `linux/device.h`, `linux/delay.h`, `linux/tty.h`, `linux/tty_flip.h`, `linux/slab.h`, `linux/string_choices.h`.
• Detected declarations: `struct gs_console`, `struct gs_port`, `function gs_alloc_req`, `function gs_free_req`, `function gs_send_packet`, `function data`, `function gs_read_complete`, `function gs_write_complete`, `function gs_free_requests`, `function gs_alloc_requests`.
• Atlas domain: Driver Families / drivers/usb.
• Implementation status: integration implementation candidate.
• 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.