Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/gasket.4
- This file was added.
| .\" | ||||||||||||||
| .\" Copyright (c) 2026 Abdelkader Boudih <freebsd@seuros.com> | ||||||||||||||
| .\" | ||||||||||||||
| .\" SPDX-License-Identifier: BSD-2-Clause | ||||||||||||||
| .\" | ||||||||||||||
| .Dd July 30, 2026 | ||||||||||||||
| .Dt GASKET 4 | ||||||||||||||
| .Os | ||||||||||||||
ziaee: Am I correct in understanding that this only works on amd64 for now? If so, please specify in… | ||||||||||||||
Done Inline ActionsIt tested in amd64 only . But the framework should work with any architecture . seuros: It tested in amd64 only . But the framework should work with any architecture . | ||||||||||||||
| .Sh NAME | ||||||||||||||
| .Nm gasket | ||||||||||||||
| .Nd Google Edge TPU accelerator framework | ||||||||||||||
| .Sh SYNOPSIS | ||||||||||||||
| To compile this driver into the kernel, | ||||||||||||||
| place the following line in your | ||||||||||||||
| kernel configuration file: | ||||||||||||||
| .Bd -ragged -offset indent | ||||||||||||||
| .Cd "device gasket" | ||||||||||||||
| .Ed | ||||||||||||||
ziaeeUnsubmitted Done Inline Actions
can also list sysctl, see share/examples/mdoc/example.4 ziaee: can also list sysctl, see share/examples/mdoc/example.4 | ||||||||||||||
| .Sh DESCRIPTION | ||||||||||||||
| The | ||||||||||||||
| .Nm | ||||||||||||||
| framework provides the character device, the mapping policy and the on-chip | ||||||||||||||
| page table shared by Google accelerator ASICs. | ||||||||||||||
| It does not attach to hardware; a chip driver such as | ||||||||||||||
| .Xr apex 4 | ||||||||||||||
| describes its registers and implements the | ||||||||||||||
| .Nm | ||||||||||||||
| kobj interface. | ||||||||||||||
ziaeeUnsubmitted Done Inline Actions
ziaee: | ||||||||||||||
| .Pp | ||||||||||||||
| Only the register ranges a chip driver declares mappable are reachable from | ||||||||||||||
| user space; the rest of the window, including the page table, stays private. | ||||||||||||||
| .Sh SYSCTL VARIABLES | ||||||||||||||
| .Bl -tag -width indent | ||||||||||||||
| .It Va hw.gasket.max_wired_pages | ||||||||||||||
Not Done Inline ActionsWhy aren't they charged against those limits? The backing pages are effectively mlocked. markj: Why aren't they charged against those limits? The backing pages are effectively mlocked. | ||||||||||||||
| Maximum pages one accelerator may have mapped, 131072 by default. | ||||||||||||||
| These are not charged against | ||||||||||||||
| .Xr getrlimit 2 | ||||||||||||||
| .Dv RLIMIT_MEMLOCK , | ||||||||||||||
| so this is the only bound on what a consumer can pin. | ||||||||||||||
| .El | ||||||||||||||
| .Sh SEE ALSO | ||||||||||||||
| .Xr apex 4 , | ||||||||||||||
| .Xr pci 4 | ||||||||||||||
| .Sh HISTORY | ||||||||||||||
| The | ||||||||||||||
| .Nm | ||||||||||||||
| framework first appeared in | ||||||||||||||
| .Fx 16.0 . | ||||||||||||||
| The name comes from the framework of the same name that Google distributed | ||||||||||||||
| for Linux, where it stands for Google ASIC Software, Kernel Extensions, and | ||||||||||||||
| Tools. | ||||||||||||||
| .Sh AUTHORS | ||||||||||||||
| .An Abdelkader Boudih Aq Mt freebsd@seuros.com | ||||||||||||||
adrianUnsubmitted Done Inline Actionsheh update email address adrian: heh update email address | ||||||||||||||
Am I correct in understanding that this only works on amd64 for now? If so, please specify in the manpage. There is an optional architectural specifier here where you can do that.