d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

- Clarify when the softc is allocated. It is allocated when a device is

Browse Source 
probed and attached, not on the first call to device_get_softc().
- Add a cross reference to DEVICE_PROBE regarding the caveats of using the
  softc in a driver's probe routine.
- Fix a grammar bogon.

PR:		docs/87176 (1)
Submitted by:	Devon H. O'Dell dodell at offmyserver dot com (1)
MFC after:	3 days
This commit is contained in:
John Baldwin 2005-10-13 16:57:53 +00:00
parent 10ebc7c038
commit 2ddd41fbec
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
share/man/man9/device_get_softc.9
View File

@ -42,8 +42,11 @@
.Sh DESCRIPTION
Return the driver-specific state of
.Fa dev .
The softc is automatically allocated and zeroed the first
time it is requested.
The softc is automatically allocated and zeroed when the device is
attached.
The softc is also initialized and present when a device is probed,
but is subject to caveats as described in
.Xr DEVICE_PROBE 9 .
The size of the allocation is determined by the device's
.Vt driver_t
information used to define the driver.
@ -53,10 +56,11 @@ device.
Driver writers are discouraged from using their own softc management
mechanisms.
Driver writers should not copy such mechanisms found in drivers in the
tree that predates this function.
tree that predate this function.
.Sh RETURN VALUES
The pointer to the driver-specific instance variable is returned.
.Sh SEE ALSO
.Xr DEVICE_PROBE 9 ,
.Xr device 9 ,
.Xr device_set_softc 9 ,
.Xr driver 9