Commit Graph

2648 Commits

Author SHA1 Message Date
gonzo
88d57fa15c [man] Add documentation for OpenFirmware API
Add man pages for following OpenFirmware functions:

OF_child, OF_parent, OF_peer, OF_device_from_xref,
OF_device_register_xref, OF_xref_from_device, OF_getprop,
OF_getencprop, OF_getencprop_alloc, OF_getprop_alloc, OF_getproplen,
OF_hasprop, OF_nextprop, OF_prop_free, OF_searchencprop,
OF_searchprop, OF_setprop

Edited by:	wblock
MFC after:	3 days
Differential Revision:	https://reviews.freebsd.org/D14511
2018-04-09 22:23:45 +00:00
gonzo
5e1d126c43 [man] Fix return type of BUS_ADD_CHILD(9)
Fix return type of BUS_ADD_CHILD(9) in SYNOPSYS section,
it should be device_t, not int

PR:		207389
MFC after:	3 days
2018-04-09 05:48:12 +00:00
gonzo
6db4423a73 Document ofw_bus_subr helpers "compatible" and "status" properties
Add documentation for following functions:

- ofw_bus_is_compatible
- ofw_bus_is_compatible_strict
- ofw_bus_node_is_compatible
- ofw_bus_search_compatible
- ofw_bus_get_status
- ofw_bus_status_okay
- ofw_bus_node_status_okay

MFC after:	1 week
Differential Revision:	https://reviews.freebsd.org/D14724
2018-04-08 20:53:00 +00:00
markj
958788bce2 Typo.
MFC after:	3 days
2018-04-04 20:15:41 +00:00
landonf
9bc0c1eaa5 bhnd(4): include a subset of the ChipCommon capability flags in bhnd_chipid;
this provides early access to device capability flags required by bhnd(4)
bus and bhndb(4) bridge drivers.
2018-03-29 19:44:15 +00:00
jeff
5e244328ad Implement several enhancements to NUMA policies.
Add a new "interleave" allocation policy which stripes pages across
domains with a stride or width keeping contiguity within a multi-page
region.

Move the kernel to the dedicated numbered cpuset #2 making it possible
to assign kernel threads and memory policy separately from user.  This
also eliminates the need for the complicated interrupt binding code.

Add a sysctl API for viewing and manipulating domainsets.  Refactor some
of the cpuset_t manipulation code using the generic bitset type so that
it can be used for both.  This probably belongs in a dedicated subr file.

Attempt to improve the include situation.

Reviewed by:	kib
Discussed with:	jhb (cpuset parts)
Tested by:	pho (before review feedback)
Sponsored by:	Netflix, Dell/EMC Isilon
Differential Revision:	https://reviews.freebsd.org/D14839
2018-03-29 02:54:50 +00:00
imp
c7fa93ed3a Note that MODULE_PNP_INFO has to come after a DRIVER_MODULE. 2018-03-25 17:12:09 +00:00
jeff
3e6c614462 Document new NUMA related syscalls and utility options.
Sponsored by:	Netflix, Dell/EMC Isilon
2018-03-24 23:58:44 +00:00
kp
109a7b5eec netpfil: Introduce PFIL_FWD flag
Forwarded packets passed through PFIL_OUT, which made it difficult for
firewalls to figure out if they were forwarding or producing packets. This in
turn is an issue for pf for IPv6 fragment handling: it needs to call
ip6_output() or ip6_forward() to handle the fragments. Figuring out which was
difficult (and until now, incorrect).
Having pfil distinguish the two removes an ugly piece of code from pf.

Introduce a new variant of the netpfil callbacks with a flags variable, which
has PFIL_FWD set for forwarded packets. This allows pf to reliably work out if
a packet is forwarded.

Reviewed by:	ae, kevans
Differential Revision:	https://reviews.freebsd.org/D13715
2018-03-23 16:56:44 +00:00
sevan
313ef12918 Extend the description of ALTQ to call it a system which is a framework in
altq(4) to match altq(9). This makes preserving the history section as the
author of ALTQ easier in the history section, rather than calling it a framework
in the description & a system in the history.
Add a history section to altq(4) and extend the history section in altq(9)

Approved by:	bcr (mentor)
MFC after:	5 days
Differential Revision:	 https://reviews.freebsd.org/D14774
2018-03-20 22:41:26 +00:00
imp
913545513f Remove reference to lint. We no longer support it, so exceptions for
it are no longer relevant.
2018-03-20 21:37:33 +00:00
imp
e0ff84c2ea Update to include information about using SPDX-License-Identifier
lines.
2018-03-20 21:31:18 +00:00
trasz
023e12f8a9 Fix formatting errors that resulted in apropos(1) output looking weird.
MFC after:	2 weeks
2018-03-17 11:41:06 +00:00
imp
62bc5104df Remove K&R stuff: never use it in new code.
Remove how to format K&R stuff. The project hasn't been using it in
new code for a long time. It's so obsolete, we don't need a statement
to never use it. Add a statement requesting that comments about
parameters be preserved when converting to ASNI style, per Kirk.

Differential Revision: https://reviews.freebsd.org/D14051
2018-03-09 17:54:14 +00:00
asomers
7b3bd9e748 g_bio(9): fix a documentation oversight from r163870
MFC after:	3 weeks
2018-03-08 03:19:04 +00:00
cem
6251eb9ea8 fpu_kern.9: Document fpu_kern_enter API change in r329878
While here, clean up some of the language.

Reported by:	delphij
Sponsored by:	Dell EMC Isilon
2018-03-07 18:31:31 +00:00
imp
16d50b0d62 Mention that CTLFLAG_MPSAFE is only for _PROC entries. 2018-03-04 06:19:41 +00:00
imp
50c377a8e9 Add documentation for CTLFLAG_MPSAFE. 2018-03-04 03:13:13 +00:00
hselasky
ef1e592a79 Document pause_sig(9) and update prototypes for existing pause(9) and
pause_sbt(9) functions.

MFC after:	1 week
Suggested by:	cem@
Sponsored by:	Mellanox Technologies
2018-03-03 23:08:49 +00:00
ian
97829b536a Minor (mostly) wording changes. 2018-03-03 22:10:16 +00:00
gonzo
3074910c5f [fdt_pinctrl] Add man pages for fdt_pinctrl driver
- Add fdt_pinctrl(4) with general information for the driver
- Add fdt_pinctrl(9) with fdt_pinctrl KPI description

Reviewed by:	ian, manu, wblock
MFC after:	2 weeks
Differential Revision:	https://reviews.freebsd.org/D14235
2018-03-03 02:49:49 +00:00
kevans
a9ed140ea3 style.lua(9): Add some additional notes about naming and commas
camelCase tends to be preferred for function identifiers, while
internal_underscores are preferred for variable identifiers. This convention
makes it a little bit easier to eyeball whether variable/function usage is
correct.

The optional commas for final table values are preferred to reduce chances
for error.
2018-02-26 04:55:08 +00:00
kevans
6ce39f6cb7 style.lua(9): Drop notes about semicolons
It is generally agreed upon that they are ugly and should not be used except
where needed.
2018-02-21 01:37:22 +00:00
kevans
fd48e97f4e style.lua(9): Clarify local variable guideline
The intent of this guideline is to avoid creating global variables in module
scope. Its main purpose is to serve as a reminder that variables at module
scope also need to be declared.

We want to avoid global variables in general, but this is easier to mess up
when designing things in the module scope.
2018-02-20 05:21:58 +00:00
kevans
4ab4041893 style.lua(9): Note that wrapping at 80-columns is not rigid 2018-02-19 22:54:10 +00:00
bryanv
d039ee33e7 Add PCI methods to iterate over the PCI capabilities
VirtIO V1 provides configuration in multiple VENDOR capabilities so this
allows all of the configuration to be discovered.

Reviewed by:	jhb
MFC after:	2 weeks
Differential Revision:	https://reviews.freebsd.org/D14325
2018-02-19 18:41:56 +00:00
kevans
ba9d7495dc Create style.lua(9)
This covers the lua style guidelines we've generally agreed on so far. It
will be revised as work continues and we run into more scenarios that need
specified.

Discussed with:	cem, jilles
Differential Revision:	https://reviews.freebsd.org/D14423
2018-02-19 01:25:52 +00:00
imp
73f0c246f3 Add description for T specifier. It's for PNP keys that are checked
programatically that must be true for a device to match, but aren't in
the table as discrete fields.

Sponsored by: Netflix
2018-02-17 06:57:08 +00:00
kib
a93b2878ec Note that on amd64 pmap_enter(psind = 1) works (since r321378).
Sponsored by:	The FreeBSD Foundation
MFC after:	3 days
2018-02-16 01:08:32 +00:00
cem
a5bf346092 pmap_qenter.9: Clarify that not all arch can map NX
The goal is to use security features when architectures provide them.

Reported by:	kib
Sponsored by:	Dell EMC Isilon
2018-02-15 18:19:25 +00:00
cem
8840fda67c pmap_qenter.9: Document API NX mapping
A follow-up to r329281.

Sponsored by:	Dell EMC Isilon
2018-02-14 23:47:04 +00:00
emaste
1f5650406c Add DECLARE_MODULE_TIED mlink missed in r329244
Reported by:	imp
2018-02-13 21:33:40 +00:00
emaste
ce3f4d4d7e Document DECLARE_MODULE_TIED
It was introduced in r213716.

Reviewed by:	kib
Sponsored by:	The FreeBSD Foundation
2018-02-13 21:22:09 +00:00
cem
80c14b338f Take a first stab at documenting use of MODULE_PNP_INFO
Sponsored by:	Dell EMC Isilon
2018-02-12 22:42:06 +00:00
cem
c4503b16c3 device_add_child.9: reference logical opposite, device_delete_child(9) 2018-02-11 22:09:07 +00:00
cem
06c909c2e4 Document syscall_helper_register(9), syscall_helper_unregister(9) 2018-02-10 20:34:09 +00:00
bryanv
d35b5b4d3d Correct structure name used in bus_map_resource(9) example
Reviewed by:	jhb
MFC after:	1 week
Differential Revision:	https://reviews.freebsd.org/D14188
2018-02-06 04:28:21 +00:00
imp
dfbfead820 Bump .Dd date for c99 change 2018-01-25 15:55:58 +00:00
imp
1b4e4b3669 Add info about c99 designationed initializers.
Differential Revision: https://reviews.freebsd.org/D13975
2018-01-25 15:42:21 +00:00
cem
2b1bc6707d malloc(9): Change nominal size to size_t to match standard C
No functional change -- size_t matches unsigned long on all platforms.

Reported by:	bde
Discussed with:	jhb
Sponsored by:	Dell EMC Isilon
2018-01-24 19:37:18 +00:00
landonf
e23dd6b815 bhnd/bwn(4): Define a bhnd(4) softmodem device class for the v.90 modem
codec core, and mark the core as unpopulated on all BCM4306 bwn(4) devices.

Sponsored by:	The FreeBSD Foundation
2018-01-19 22:43:08 +00:00
imp
b3b999d2ab No need for the zero width space now that I put the comma in. 2018-01-18 22:23:16 +00:00
imp
3f3ea6f0fa Make igor happier with this file:
o Don't use contractions.
o Add common after e.g. where needed
2018-01-18 22:20:30 +00:00
markj
8899645d26 Add mallocarray.9 to malloc.9's MLINKS.
X-MFC with:	r327674
2018-01-11 16:41:03 +00:00
cem
4bb02fdccf malloc.9: Fix minor typo from rewording in r327796
Sponsored by:	Dell EMC Isilon
2018-01-10 22:20:49 +00:00
cem
2c9ae2323b mallocarray(9): panic if the requested allocation would overflow
Additionally, move the overflow check logic out to WOULD_OVERFLOW() for
consumers to have a common means of testing for overflowing allocations.
WOULD_OVERFLOW() should be a secondary check -- on 64-bit platforms, just
because an allocation won't overflow size_t does not mean it is a sane size
to request.  Callers should be imposing reasonable allocation limits far,
far, below overflow.

Discussed with:	emaste, jhb, kp
Sponsored by:	Dell EMC Isilon
2018-01-10 21:49:45 +00:00
kp
69291826ac Introduce mallocarray() in the kernel
Similar to calloc() the mallocarray() function checks for integer
overflows before allocating memory.
It does not zero memory, unless the M_ZERO flag is set.

Reviewed by:	pfg, vangyzen (previous version), imp (previous version)
Obtained from:	OpenBSD
Differential Revision:	https://reviews.freebsd.org/D13766
2018-01-07 13:21:01 +00:00
eadler
8b2675fc39 ieee80211(9): update man page
This copies changes from NetBSD into FreeBSD's man page.  I compared the
proposed changes against FreeBSD headers and modified them to match.

PR:		214602
Submitted by:	fehmi noyan isi <fnoyanisi@yahoo.com>
2018-01-01 00:20:35 +00:00
eadler
48140559e0 Fix a few speelling errors
- man pages
- bin/sh

Reviewed by:		jilles
2017-12-28 08:22:26 +00:00
kib
8398445a05 Update HISTORY section for the atomic(9) page.
In collaboration with:	alc
Sponsored by:	The FreeBSD Foundation (kib)
MFC after:	1 week
2017-12-22 17:52:38 +00:00