From nobody Sun Sep 13 14:16:56 2026 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4hjVhm4vyPz6s2SN for ; Sun, 13 Sep 2026 14:16:56 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange x25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "YR2" (not verified)) by mx1.freebsd.org (Postfix) with ESMTPS id 4hjVhm11Vvz3NJm for ; Sun, 13 Sep 2026 14:16:56 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1789309016; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=Z0R6KHgt2AEeEdl+03r6rva9EmPP3JQ/x6LKqxDq8OI=; b=OtM0RxPbZZTMQEYhIZ4Uky0+UR2yNhSgAOs2lQ6qkzqtLtdtbqHMU2ivHSHs85U/d9US8V EnCQDmkV1X4SxQ9GUuLe3hzmPq2IkpW3vmnRk0rsiAF2SRBGz2ldozu1IkrvfPCZQlHOq8 st9Dztzl+1GvP35re7nNAxnQzEFbuj4IIXz4VUBJFltY/xtjVTHR+5lt+v3SXSkUqmnL1F 5/eiWTrOOobQqq+Vh7xYGEbQKqtN+D9jXdgwgXuqbaUfQ6YT8hg8SZArnVQ1rv1WgvSqWA QnPybs/GsH3wSmmuIbw0vo0L1OxwFG5O811sajNZq/pVKc4jbmq6B2478LyoMA== ARC-Seal: i=1; a=rsa-sha256; d=freebsd.org; s=dkim; cv=none; t=1789309016; b=kjPQFaQCLO8KR9g1mszpmG/Ct7Y5493yIuEHXuL1llPRYEaoRy0MpWC0EMgBIS/nJy89Gx KggJHLGOuNdTf8ayy6428MVc0E8u7XPQWgcp+ZLUsMQhvs9xO9hQt7SDKlsnZHt8cS0bzx V0ZMAkANlUafMRZrFhp6XmoDVOIC9MhXp0kSuk0IM7RyG4v7l8FlLdwn96szdiXMPZUdoC P3Tm37MEkYcWzkBl0oTey2Q3j1nja3LHSSELBHXThLuxtyG1ypjEiMn0fw89a/aRFeR8ln llIxLvW6k0HDcy5MxfrV68XJWma/QkNZrjU0HydpFu+X2FlU+nKm2zICLtPSeg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1789309016; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=Z0R6KHgt2AEeEdl+03r6rva9EmPP3JQ/x6LKqxDq8OI=; b=R/uSZ9pvNHcWuhYjfy5YXLDRdlUmTTVO2w+D58MeRwsolWnogqAHqhENVnre79I/xThBcw 7gMOzmQuabyXfLkbH410wypwolz/OjY0yoQHwxZsy84wY17YklUyPj6FyoKbJHjlW8R3O3 a3uUba09GxstW6HogJ4e4GYcpoae0UL7WW/XYalDcAwN+QLxRGzjRqMDFgfsp4aftWFbDx GX9pa4k/aIEejUvJrhmdRoTIWnu+ifyvJrK8jjTjDMV6YAFmuqdO5XlUEX2omtKnvnP7iW pxCU0qJRww6DgkwYbu6KAOzuyGYJZ79Z4Z0OSEgeiNWhOFskql6pAo5iIhHnfg== ARC-Authentication-Results: i=1; mx1.freebsd.org; none Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) by mxrelay.nyi.freebsd.org (Postfix) with ESMTP id 4hjVhm063yzml6 for ; Sun, 13 Sep 2026 14:16:56 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from git (uid 1279) (envelope-from git@FreeBSD.org) id 302d9 by gitrepo.freebsd.org (DragonFly Mail Agent v0.13+ on gitrepo.freebsd.org); Sun, 13 Sep 2026 14:16:56 +0000 To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Alexander Ziaee Subject: git: 2f2938d2654e - main - uart.4: Conicalize sections a bit better List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-all@freebsd.org Sender: owner-dev-commits-src-all@FreeBSD.org List-Id: List-Post: List-Help: List-Subscribe: List-Unsubscribe: List-Owner: Precedence: list MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: ziaee X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 2f2938d2654e3c41641c9fce4c8b08b38acfdcc6 Auto-Submitted: auto-generated Date: Sun, 13 Sep 2026 14:16:56 +0000 Message-Id: <6aa6b058.302d9.6dc0c8c8@gitrepo.freebsd.org> The branch main has been updated by ziaee: URL: https://cgit.FreeBSD.org/src/commit/?id=2f2938d2654e3c41641c9fce4c8b08b38acfdcc6 commit 2f2938d2654e3c41641c9fce4c8b08b38acfdcc6 Author: Alexander Ziaee AuthorDate: 2026-09-13 12:45:50 +0000 Commit: Alexander Ziaee CommitDate: 2026-09-13 14:16:24 +0000 uart.4: Conicalize sections a bit better Sections are in all caps, and subsections are in title case. Sections also have a standard order. This manual could certainly be reformatted more to conform further to our conventions, but this is a step in the right direction. While here, remove the stray hyphen from the beginning of this document. Event: EuroBSDcon 2026 MFC after: 3 days --- share/man/man4/uart.4 | 85 +++++++++++++++++++++++++-------------------------- 1 file changed, 42 insertions(+), 43 deletions(-) diff --git a/share/man/man4/uart.4 b/share/man/man4/uart.4 index f0b6b23b53d2..3a7fec2b3899 100644 --- a/share/man/man4/uart.4 +++ b/share/man/man4/uart.4 @@ -1,4 +1,4 @@ -.\"- +.\" .\" SPDX-License-Identifier: BSD-2-Clause .\" .\" Copyright (c) 2003 Marcel Moolenaar @@ -46,25 +46,6 @@ In .Cd hint.uart.0.baud="38400" .Cd hint.uart.0.port="0x3f8" .Cd hint.uart.0.flags="0x10" -.Pp -With -.Ar flags -encoded as: -.Bl -tag -compact -width 0x000000 -.It 0x00010 -device is potential system console -.It 0x00080 -use this port for remote kernel debugging -.It 0x00100 -set RX FIFO trigger level to ``low'' (NS8250 only) -.It 0x00200 -set RX FIFO trigger level to ``medium low'' (NS8250 only) -.It 0x00400 -set RX FIFO trigger level to ``medium high'' (default, NS8250 only) -.It 0x00800 -set RX FIFO trigger level to ``high'' (NS8250 only) -.El -.\" .Sh DESCRIPTION The .Nm @@ -105,19 +86,19 @@ In the following sections the components are discussed in detail. Options are described in the section that covers the component to which each option applies. .\" -.Ss CORE COMPONENT +.Ss Core Component At the heart of the .Nm driver is the core component. It contains the bus attachments and the low-level interrupt handler. .\" -.Ss HARDWARE DRIVERS +.Ss Hardware Drivers The core component and the kernel interfaces talk to the hardware through the hardware interface. This interface serves as an abstraction of the hardware and allows varying UARTs to be used for serial communications. .\" -.Ss SYSTEM DEVICES +.Ss System Devices System devices are UARTs that have a special purpose by way of hardware design or software setup. For example, Sun UltraSparc machines use UARTs as their keyboard interface. @@ -126,7 +107,7 @@ Likewise, when the kernel is configured for a serial console, the corresponding UART will in turn be a system device so that the kernel can output boot messages early on in the boot process. .\" -.Ss KERNEL INTERFACES +.Ss Kernel Interfaces The last but not least of the components is the kernel interface. This component ultimately determines how the UART is made visible to the kernel in particular and to users in general. @@ -136,22 +117,7 @@ applications. System devices, with the notable exception of serial consoles, generally have specialized kernel interfaces. .\" -.Sh HARDWARE -The -.Nm -driver supports the following classes of UARTs: -.Pp -.Bl -bullet -compact -.It -NS8250: standard hardware based on the 8250, 16450, 16550, 16650, 16750 or -the 16950 UARTs. -.It -SCC: serial communications controllers supported by the -.Xr scc 4 -device driver. -.El -.\" -.Sh Pulse Per Second (PPS) Timing Interface +.Ss Pulse Per Second (PPS) Timing Interface The .Nm driver can capture PPS timing information as defined in RFC 2783. @@ -225,7 +191,7 @@ Generally speaking, a connection to a DB-9 style connector is an RS-232 level signal at up to 12 volts. A connection to header pins or an edge-connector on an embedded board is typically a TTL signal at 3.3 or 5 volts. -.Sh Special Devices +.Ss Special Devices The .Nm driver also supports an initial-state and a lock-state control @@ -271,7 +237,7 @@ be locked for devices that support more than one setting. The CLOCAL flag on callin ports should be locked off for logins to avoid certain security holes, but this needs to be done by getty if the callin port is used for anything else. -.Sh Console Tuneable +.Ss Console Tuneable The .Nm driver can be designated as a system console. @@ -354,6 +320,40 @@ Automatically computed values can be as large as 5% when the base frequency is a poor match to the traditional baud rates. .El .El +.Sh HARDWARE +The +.Nm +driver supports the following classes of UARTs: +.Pp +.Bl -bullet -compact +.It +NS8250: standard hardware based on the 8250, 16450, 16550, 16650, 16750 or +the 16950 UARTs. +.It +SCC: serial communications controllers supported by the +.Xr scc 4 +device driver. +.El +.\" +.Sh DEVICE HINTS +The +.Ar flags +are encoded as: +.Bl -tag -compact -width 0x000000 +.It 0x00010 +device is potential system console +.It 0x00080 +use this port for remote kernel debugging +.It 0x00100 +set RX FIFO trigger level to ``low'' (NS8250 only) +.It 0x00200 +set RX FIFO trigger level to ``medium low'' (NS8250 only) +.It 0x00400 +set RX FIFO trigger level to ``medium high'' (default, NS8250 only) +.It 0x00800 +set RX FIFO trigger level to ``high'' (NS8250 only) +.El +.\" .Sh FILES .Bl -tag -width "/dev/ttyu?.init" -compact .It Pa /dev/ttyu? @@ -400,4 +400,3 @@ documentation over three different manual pages: .Xr termios 4 , .Xr uart 4 and .Xr tty 4 . -