drivers/tty/serial/serial_base.h

File Facts

System

Linux kernel

Corpus path

drivers/tty/serial/serial_base.h

Extension

.h

Size

2051 bytes

Lines

68

Domain

Driver Families

Bucket

drivers/tty

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.
• Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.

Dependency Surface

• No C-style include directives detected by the generator.

Detected Declarations

• struct uart_driver
• struct uart_port
• struct device_driver
• struct device
• struct serial_ctrl_device
• struct serial_port_device
• function serial_base_match_and_update_preferred_console

Annotated Snippet

struct device_driver;
struct device;

struct serial_ctrl_device {
	struct device dev;
	struct ida port_ida;
};

struct serial_port_device {
	struct device dev;
	struct uart_port *port;
	unsigned int tx_enabled:1;
};

int serial_base_ctrl_init(void);
void serial_base_ctrl_exit(void);

int serial_base_port_init(void);
void serial_base_port_exit(void);

void serial_base_port_startup(struct uart_port *port);
void serial_base_port_shutdown(struct uart_port *port);

int serial_base_driver_register(struct device_driver *driver);
void serial_base_driver_unregister(struct device_driver *driver);

struct serial_ctrl_device *serial_base_ctrl_add(struct uart_port *port,
						struct device *parent);
struct serial_port_device *serial_base_port_add(struct uart_port *port,
						struct serial_ctrl_device *parent);
void serial_base_ctrl_device_remove(struct serial_ctrl_device *ctrl_dev);
void serial_base_port_device_remove(struct serial_port_device *port_dev);

int serial_ctrl_register_port(struct uart_driver *drv, struct uart_port *port);
void serial_ctrl_unregister_port(struct uart_driver *drv, struct uart_port *port);

int serial_core_register_port(struct uart_driver *drv, struct uart_port *port);
void serial_core_unregister_port(struct uart_driver *drv, struct uart_port *port);

#ifdef CONFIG_SERIAL_CORE_CONSOLE

int serial_base_match_and_update_preferred_console(struct uart_driver *drv,
						   struct uart_port *port);

#else

static inline
int serial_base_match_and_update_preferred_console(struct uart_driver *drv,
						   struct uart_port *port)
{
	return 0;
}

#endif

Annotation

• Detected declarations: `struct uart_driver`, `struct uart_port`, `struct device_driver`, `struct device`, `struct serial_ctrl_device`, `struct serial_port_device`, `function serial_base_match_and_update_preferred_console`.
• Atlas domain: Driver Families / drivers/tty.
• Implementation status: pattern implementation candidate.

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.