From nobody Thu Feb 27 01:19:37 2025 X-Original-To: dev-commits-src-branches@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 4Z3D5k2FQqz5pNJN; Thu, 27 Feb 2025 01:19:38 +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 "R10" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Z3D5j33gfz41Q5; Thu, 27 Feb 2025 01:19:37 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1740619177; 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=U5uI1vnbaec4RRLSuHkgfVLJ77om+tKK55xr4z1UNdc=; b=iY1Mf7u9XNFTatXHGSbhbSpVBaysBacubMwMRMrpdgFTenaW6ImutrbsrPlvhvk9etYXD0 XDIEMYBKT1TBONtw/ydGgadKaByVOjAPGNOotxB0fZfioW08UqCuIFKNA55S6RUCB92ZhL bSPkoJZqREZf+d0hTQJniL+o7T7y3wNsd1mh8lDJDyYj1lwKX6MhwNDtEvMuF3hSkVHPOh 23EZOTN1zp9BKyggzmBAxyIsv29lN3+3knMV7i4wfOCRw1HwdNo2Ja5FW8aKKJCA+nI3ZL q6/7fSKPpTRKotI0Vxx6oCATcGcSblTutM5vbrW5nUevVZle4ARpJQ/HrJnkkQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1740619177; a=rsa-sha256; cv=none; b=Vr7N36Hfl5YuZIwRDIJPf5gYqbnvju0v6Jg3HTNHDqAL2DXcs/O+kfV8p9QRDfjGYHH9Tw 8RUnKMyX1eWAGAA8KbmDEf/mWGZerNjnsJ4lCN0oU5n5pO0QjoZ5fsimhiuyM9N7KXisFy 7PNCKRMyOa/+Isk2jVc8fpDLLod4OCytaJupAgER3wEMXMvZ+NDVg+N1tndDqOfY6y6zcX L7hgZHGTwfcPGxL68aKv0kyg4eQYmEIoPcwFiNiIvZI8lq4RpmM2zOD8mzaI4gdP7VG4hk ktQACLrgtRGVcCVNrXmIo6zYhbeJ4AJD661v7YvKNT/M7csMzyqwXekooSgvbQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1740619177; 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=U5uI1vnbaec4RRLSuHkgfVLJ77om+tKK55xr4z1UNdc=; b=Z/16VPgJAbknqX5GMuY1kNWeXTb3gCQ/d1OLf0WhwjoAPYbAJGXjspbFd4q6QJtQiI5wUK i0kzeJCFXvxeaNAxFmlnIifc/RQyxRR/PETV/o8sYiQ7fzDHbSKE3NlIcSsh/vtap1tTCm 9ej1utmXc2mPYkKx5YV0Ug2yXWtcyRb9UIY1OFlybq7d7M4PsVZLekYq3LoFL3dWogFzuN rbEUpH73SnwBUXRtHR6EMKWhJ4kq6i5AILw+KtkWVhC1bHpsymbvpQoqfiiN/rMQwTLIbC UBjeHVQ5T90lmitmNk2wXuQZm85KDgyKwvtDpf+GfYrXmHOjEFYzKMYUt0rwhg== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (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 did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4Z3D5j2ZFyz60K; Thu, 27 Feb 2025 01:19:37 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 51R1JbOV056449; Thu, 27 Feb 2025 01:19:37 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 51R1Jbo4056446; Thu, 27 Feb 2025 01:19:37 GMT (envelope-from git) Date: Thu, 27 Feb 2025 01:19:37 GMT Message-Id: <202502270119.51R1Jbo4056446@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Alexander Ziaee Subject: git: 78fa5b277a84 - stable/14 - safexel manuals: Improve apropos and HW relnotes List-Id: Commits to the stable branches of the FreeBSD src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-branches List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-branches@freebsd.org Sender: owner-dev-commits-src-branches@FreeBSD.org 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/stable/14 X-Git-Reftype: branch X-Git-Commit: 78fa5b277a84285de554b8dfb8d306bcee265212 Auto-Submitted: auto-generated The branch stable/14 has been updated by ziaee: URL: https://cgit.FreeBSD.org/src/commit/?id=78fa5b277a84285de554b8dfb8d306bcee265212 commit 78fa5b277a84285de554b8dfb8d306bcee265212 Author: Alexander Ziaee AuthorDate: 2024-11-22 17:45:36 +0000 Commit: Alexander Ziaee CommitDate: 2025-02-27 01:15:25 +0000 safexel manuals: Improve apropos and HW relnotes safe.4: Improve document description (Nd) for apropos. Remove Nm from sysctls in synopsis. This was causing this page to get pulled into results for `apropos sysctl`. Instead, use kernel declaration macros like vt(4). Convert the HARDWARE tagged list to a column list for better rendering in HW Relnotes. Tested in man(1) at MANWIDTH 59 and 80. safexcel.4: Nd: s/security packet/cryptographic offload/ for apropos. HARDWARE: Create this section for inclusion in the HW relnotes. SPDX: both tagged MFC after: 3 days MFC to: 13.5 Reported by: markj (cryptographic offload, Inside Secure) Reviewed by: jhb, markj, mhorne Accepted by: markj (src), mhorne (mentor) Differential Revision: https://reviews.freebsd.org/D47706 (cherry picked from commit 26eeda7bd65603cdc6ff764349f55416b9766b43) --- share/man/man4/safe.4 | 34 +++++++++++++++++++--------------- share/man/man4/safexcel.4 | 13 ++++++++++--- 2 files changed, 29 insertions(+), 18 deletions(-) diff --git a/share/man/man4/safe.4 b/share/man/man4/safe.4 index 61f2041ff333..89375d058bf7 100644 --- a/share/man/man4/safe.4 +++ b/share/man/man4/safe.4 @@ -1,4 +1,6 @@ -.\"- +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" .\" Copyright (c) 2003 Sam Leffler, Errno Consulting .\" All rights reserved. .\" @@ -22,13 +24,13 @@ .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. -.\"/ -.Dd July 29, 2020 +.\" +.Dd November 22, 2024 .Dt SAFE 4 .Os .Sh NAME .Nm safe -.Nd SafeNet crypto accelerator +.Nd SafeNet SafeXcel 1141/1741 crypto accelerator .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your @@ -46,11 +48,15 @@ module at boot time, place the following line in safe_load="YES" .Ed .Pp -.Nm sysctl Va hw.safe.debug -.Nm sysctl Va hw.safe.dump -.Nm sysctl Va hw.safe.rnginterval -.Nm sysctl Va hw.safe.rngbufsize -.Nm sysctl Va hw.safe.rngmaxalarm +In +.Xr sysctl.conf 5 : +.Bd -ragged -offset indent +.Cd hw.safe.debug +.Cd hw.safe.dump +.Cd hw.safe.rnginterval +.Cd hw.safe.rngbufsize +.Cd hw.safe.rngmaxalarm +.Ed .Sh DESCRIPTION The .Nm @@ -106,15 +112,13 @@ to dump the hardware interrupt registers. .Sh HARDWARE The .Nm -driver supports cards containing any of the following chips: -.Bl -tag -width "SafeNet 1141" -offset indent -.It SafeNet 1141 -The original chipset. +driver supports the following SafeXcel chips: +.Bl -column "SafeNet 1141" "The original chipset. Supports" -offset indent +.It SafeNet 1141 Ta The original chipset. Supports DES, Triple-DES, AES, MD5, and SHA-1 symmetric crypto operations, RNG, public key operations, and full IPsec packet processing. -.It SafeNet 1741 -A faster version of the 1141. +.It SafeNet 1741 Ta A faster version of the 1141. .El .Sh SEE ALSO .Xr crypt 3 , diff --git a/share/man/man4/safexcel.4 b/share/man/man4/safexcel.4 index d5e079822ecc..e14eebe40da2 100644 --- a/share/man/man4/safexcel.4 +++ b/share/man/man4/safexcel.4 @@ -1,4 +1,6 @@ -.\"- +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" .\" Copyright (c) 2020 Rubicon Communications, LLC (Netgate) .\" .\" Redistribution and use in source and binary forms, with or without @@ -22,12 +24,12 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd July 29, 2020 +.Dd November 22, 2024 .Dt SAFEXCEL 4 .Os .Sh NAME .Nm safexcel -.Nd Inside Secure SafeXcel-IP-97 security packet engine +.Nd Inside Secure SafeXcel-IP-97 cryptographic offload engine .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your @@ -69,6 +71,11 @@ AES-CCM .Nm also implements SHA1 and SHA2 transforms, and can combine AES-CBC and AES-CTR with SHA1-HMAC and SHA2-HMAC for encrypt-then-authenticate operations. +.Sh HARDWARE +The +.Nm +driver supports the cryptographic acceleration functions of the +Inside Secure EIP-97 device found on some Marvell systems-on-chip. .Sh SEE ALSO .Xr crypto 4 , .Xr ipsec 4 ,