Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/sha_sse.4
- This file was added.
| .\" Copyright (c) 2017 Conrad Meyer <cem@FreeBSD.org> | |||||
| .\" All rights reserved. | |||||
| .\" | |||||
| .\" Redistribution and use in source and binary forms, with or without | |||||
| .\" modification, are permitted provided that the following conditions | |||||
| .\" are met: | |||||
| .\" 1. Redistributions of source code must retain the above copyright | |||||
| .\" notice, this list of conditions and the following disclaimer. | |||||
| .\" 2. Redistributions in binary form must reproduce the above copyright | |||||
| .\" notice, this list of conditions and the following disclaimer in the | |||||
| .\" documentation and/or other materials provided with the distribution. | |||||
| .\" | |||||
| .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | |||||
| .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |||||
| .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |||||
| .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | |||||
| .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |||||
| .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |||||
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |||||
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |||||
| .\" 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. | |||||
| .\" | |||||
| .\" $FreeBSD$ | |||||
| .\" | |||||
| .Dd September 21, 2017 | |||||
| .Dt SHA_SSE 4 | |||||
| .Os | |||||
| .Sh NAME | |||||
| .Nm sha_sse | |||||
| .Nd "driver for the SHA accelerator on x86 CPUs" | |||||
| .Sh SYNOPSIS | |||||
| To compile this driver into the kernel, | |||||
| place the following lines in your | |||||
| kernel configuration file: | |||||
| .Bd -ragged -offset indent | |||||
| .Cd "device crypto" | |||||
| .Cd "device cryptodev" | |||||
| .Cd "device sha_sse" | |||||
| .Ed | |||||
| .Pp | |||||
| Alternatively, to load the driver as a | |||||
| module at boot time, place the following line in | |||||
| .Xr loader.conf 5 : | |||||
| .Bd -literal -offset indent | |||||
| sha_sse_load="YES" | |||||
| .Ed | |||||
| .Sh DESCRIPTION | |||||
| Starting with the Intel Goldmont and AMD Ryzen microarchitectures, some x86 | |||||
| processors implement a new set of SHA instructions. | |||||
| The set of seven instructions accelerates the calculation of SHA1 and SHA256 | |||||
| hashes. | |||||
| .Pp | |||||
| The processor capability is reported as SHA in the Structured Extended Features | |||||
| line at boot. | |||||
| The | |||||
| .Nm | |||||
| driver does not attach on systems that lack the required CPU capability. | |||||
| .Pp | |||||
| The | |||||
| .Nm | |||||
| driver registers itself to accelerate SHA operations for | |||||
| .Xr crypto 4 . | |||||
| .Sh SEE ALSO | |||||
| .Xr crypto 4 , | |||||
| .Xr intro 4 , | |||||
| .Xr ipsec 4 , | |||||
| .Xr crypto 9 | |||||
| .Sh HISTORY | |||||
| The | |||||
| .Nm | |||||
| driver first appeared in | |||||
| .Fx 12.0 . | |||||
| .Sh AUTHORS | |||||
| .An -nosplit | |||||
| The | |||||
| .Nm | |||||
| driver was written by | |||||
| .An Conrad Meyer Aq Mt cem@FreeBSD.org . | |||||
| The hash step intrinsics implementations were supplied by Intel. | |||||