d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
95a74ab4fb
freebsd-dev/share/man/man9/bus_activate_resource.9

147 lines
4.4 KiB
Groff
Raw Normal View History

Add a new man page for bus_activate_resource and bus_deactivate_resource. It could use some improvement, and others are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
.\" -*- nroff -*-
.\"
Fix accidentally changed copyright year. Noticed by: bapt@
2019-12-04 16:55:55 +00:00
.\" Copyright (c) 2003 M. Warner Losh <imp@FreeBSD.org>
Add a new man page for bus_activate_resource and bus_deactivate_resource. It could use some improvement, and others are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
.\"
.\" 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 DEVELOPERS ``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 DEVELOPERS 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$
.\"
Add new bus methods for mapping resources. Add a pair of bus methods that can be used to "map" resources for direct CPU access using bus_space(9). bus_map_resource() creates a mapping and bus_unmap_resource() releases a previously created mapping. Mappings are described by 'struct resource_map' object. Pointers to these objects can be passed as the first argument to the bus_space wrapper API used for bus resources. Drivers that wish to map all of a resource using default settings (for example, using uncacheable memory attributes) do not need to change. However, drivers that wish to use non-default settings can now do so without jumping through hoops. First, an RF_UNMAPPED flag is added to request that a resource is not implicitly mapped with the default settings when it is activated. This permits other activation steps (such as enabling I/O or memory decoding in a device's PCI command register) to be taken without creating a mapping. Right now the AGP drivers don't set RF_ACTIVE to avoid using up a large amount of KVA to map the AGP aperture on 32-bit platforms. Once RF_UNMAPPED is supported on all platforms that support AGP this can be changed to using RF_UNMAPPED with RF_ACTIVE instead. Second, bus_map_resource accepts an optional structure that defines additional settings for a given mapping. For example, a driver can now request to map only a subset of a resource instead of the entire range. The AGP driver could also use this to only map the first page of the aperture (IIRC, it calls pmap_mapdev() directly to map the first page currently). I will also eventually change the PCI-PCI bridge driver to request mappings of the subset of the I/O window resource on its parent side to create mappings for child devices rather than passing child resources directly up to nexus to be mapped. This also permits bridges that do address translation to request suitable mappings from a resource on the "upper" side of the bus when mapping resources on the "lower" side of the bus. Another attribute that can be specified is an alternate memory attribute for memory-mapped resources. This can be used to request a Write-Combining mapping of a PCI BAR in an MI fashion. (Currently the drivers that do this call pmap_change_attr() directly for x86 only.) Note that this commit only adds the MI framework. Each platform needs to add support for handling RF_UNMAPPED and thew new bus_map/unmap_resource methods. Generally speaking, any drivers that are calling rman_set_bustag() and rman_set_bushandle() need to be updated. Discussed on: arch Reviewed by: cem Differential Revision: https://reviews.freebsd.org/D5237
2016-05-20 17:57:47 +00:00
.Dd May 20, 2016
Add a new man page for bus_activate_resource and bus_deactivate_resource. It could use some improvement, and others are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
.Dt BUS_ACTIVATE_RESOURCE 9
.Os
.Sh NAME
Assorted mdoc(7) fixes.
2003-05-30 21:13:32 +00:00
.Nm bus_activate_resource , bus_deactivate_resource
.Nd activate or deactivate a resource
Add a new man page for bus_activate_resource and bus_deactivate_resource. It could use some improvement, and others are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
.Sh SYNOPSIS
.In sys/param.h
.In sys/bus.h
.Pp
.In machine/bus.h
.In sys/rman.h
.In machine/resource.h
.Ft int
Assorted mdoc(7) fixes.
2003-05-30 21:13:32 +00:00
.Fo bus_activate_resource
.Fa "device_t dev" "int type" "int rid" "struct resource *r"
.Fc
Add a new man page for bus_activate_resource and bus_deactivate_resource. It could use some improvement, and others are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
.Ft int
Assorted mdoc(7) fixes.
2003-05-30 21:13:32 +00:00
.Fo bus_deactivate_resource
.Fa "device_t dev" "int type" "int rid" "struct resource *r"
.Fc
Add a new man page for bus_activate_resource and bus_deactivate_resource. It could use some improvement, and others are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
.Sh DESCRIPTION
Assorted mdoc(7) fixes.
2003-05-30 21:13:32 +00:00
These functions activate or deactivate a previously allocated resource.
Add a new man page for bus_activate_resource and bus_deactivate_resource. It could use some improvement, and others are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
In general, resources must be activated before they can be accessed by
Add some notes about the implicit resource mapping for activated resources. Specifically, mention that rman_get_bustag/handle/virtual are valid after a resource is activated. Also, mention the wrapper API that accepts a struct resource instead of a bus tag and handle.
2016-04-28 18:23:18 +00:00
the driver.
Bus drivers may perform additional actions to ensure that the resource is
ready to be accessed.
For example,
the PCI bus driver enables memory decoding in a PCI device's command register
when activating a memory resource.
Add a new man page for bus_activate_resource and bus_deactivate_resource. It could use some improvement, and others are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
.Pp
Assorted mdoc(7) fixes.
2003-05-30 21:13:32 +00:00
The arguments are as follows:
.Bl -tag -width indent
.It Fa dev
The device that requests ownership of the resource.
Add a new man page for bus_activate_resource and bus_deactivate_resource. It could use some improvement, and others are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
Before allocation, the resource is owned by the parent bus.
Assorted mdoc(7) fixes.
2003-05-30 21:13:32 +00:00
.It Fa type
The type of resource you want to allocate.
Add a new man page for bus_activate_resource and bus_deactivate_resource. It could use some improvement, and others are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
It is one of:
Assorted mdoc(7) fixes.
2003-05-30 21:13:32 +00:00
.Pp
.Bl -tag -width ".Dv SYS_RES_MEMORY" -compact
Document PCI_RES_BUS as a possible resource type.
2016-04-28 17:50:16 +00:00
.It Dv PCI_RES_BUS
for PCI bus numbers
Add a new man page for bus_activate_resource and bus_deactivate_resource. It could use some improvement, and others are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
.It Dv SYS_RES_IRQ
for IRQs
.It Dv SYS_RES_DRQ
for ISA DMA lines
.It Dv SYS_RES_IOPORT
for I/O ports
.It Dv SYS_RES_MEMORY
for I/O memory
.El
Assorted mdoc(7) fixes.
2003-05-30 21:13:32 +00:00
.It Fa rid
A pointer to a bus specific handle that identifies the resource being allocated.
.It Fa r
A pointer to the
.Vt "struct resource"
Add a new man page for bus_activate_resource and bus_deactivate_resource. It could use some improvement, and others are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
returned by
.Xr bus_alloc_resource 9 .
.El
Add some notes about the implicit resource mapping for activated resources. Specifically, mention that rman_get_bustag/handle/virtual are valid after a resource is activated. Also, mention the wrapper API that accepts a struct resource instead of a bus tag and handle.
2016-04-28 18:23:18 +00:00
.Ss Resource Mapping
Resources which can be mapped for CPU access by a
Add a missing section to a cross-reference. While here, add bus_space(9) to the SEE ALSO section.
2016-05-10 16:13:54 +00:00
.Xr bus_space 9
Add some notes about the implicit resource mapping for activated resources. Specifically, mention that rman_get_bustag/handle/virtual are valid after a resource is activated. Also, mention the wrapper API that accepts a struct resource instead of a bus tag and handle.
2016-04-28 18:23:18 +00:00
tag and handle will create a mapping of the entire resource when activated.
The tag and handle for this mapping are stored in
.Fa r
and can be retrieved via
.Xr rman_get_bustag 9
and
.Xr rman_get_bushandle 9 .
These can be used with the
.Xr bus_space 9
API to access device registers or memory described by
.Fa r .
If the mapping is associated with a virtual address,
the virtual address can be retrieved via
.Xr rman_get_virtual 9 .
.Pp
Add new bus methods for mapping resources. Add a pair of bus methods that can be used to "map" resources for direct CPU access using bus_space(9). bus_map_resource() creates a mapping and bus_unmap_resource() releases a previously created mapping. Mappings are described by 'struct resource_map' object. Pointers to these objects can be passed as the first argument to the bus_space wrapper API used for bus resources. Drivers that wish to map all of a resource using default settings (for example, using uncacheable memory attributes) do not need to change. However, drivers that wish to use non-default settings can now do so without jumping through hoops. First, an RF_UNMAPPED flag is added to request that a resource is not implicitly mapped with the default settings when it is activated. This permits other activation steps (such as enabling I/O or memory decoding in a device's PCI command register) to be taken without creating a mapping. Right now the AGP drivers don't set RF_ACTIVE to avoid using up a large amount of KVA to map the AGP aperture on 32-bit platforms. Once RF_UNMAPPED is supported on all platforms that support AGP this can be changed to using RF_UNMAPPED with RF_ACTIVE instead. Second, bus_map_resource accepts an optional structure that defines additional settings for a given mapping. For example, a driver can now request to map only a subset of a resource instead of the entire range. The AGP driver could also use this to only map the first page of the aperture (IIRC, it calls pmap_mapdev() directly to map the first page currently). I will also eventually change the PCI-PCI bridge driver to request mappings of the subset of the I/O window resource on its parent side to create mappings for child devices rather than passing child resources directly up to nexus to be mapped. This also permits bridges that do address translation to request suitable mappings from a resource on the "upper" side of the bus when mapping resources on the "lower" side of the bus. Another attribute that can be specified is an alternate memory attribute for memory-mapped resources. This can be used to request a Write-Combining mapping of a PCI BAR in an MI fashion. (Currently the drivers that do this call pmap_change_attr() directly for x86 only.) Note that this commit only adds the MI framework. Each platform needs to add support for handling RF_UNMAPPED and thew new bus_map/unmap_resource methods. Generally speaking, any drivers that are calling rman_set_bustag() and rman_set_bushandle() need to be updated. Discussed on: arch Reviewed by: cem Differential Revision: https://reviews.freebsd.org/D5237
2016-05-20 17:57:47 +00:00
This implicit mapping can be disabled by passing the
.Dv RF_UNMAPPED
flag to
.Xr bus_alloc_resource 9 .
A driver may use this if it wishes to allocate its own mappings of a resource
using
.Xr bus_map_resource 9 .
.Pp
Add some notes about the implicit resource mapping for activated resources. Specifically, mention that rman_get_bustag/handle/virtual are valid after a resource is activated. Also, mention the wrapper API that accepts a struct resource instead of a bus tag and handle.
2016-04-28 18:23:18 +00:00
A wrapper API for
.Xr bus_space 9
is also provided that accepts the associated resource as the first argument
in place of the
.Xr bus_space 9
tag and handle.
The functions in this wrapper API are named similarly to the
.Xr bus_space 9
API except that
.Dq _space
is removed from their name.
For example,
.Fn bus_read_4
can be used in place of
.Fn bus_space_read_4 .
The wrapper API is preferred in new drivers.
.Pp
These two statements both read a 32-bit register at the start of a
resource:
.Bd -literal
bus_space_read_4(rman_get_bustag(res), rman_get_bushandle(res), 0);
bus_read_4(res, 0);
.Ed
Add a new man page for bus_activate_resource and bus_deactivate_resource. It could use some improvement, and others are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
.Sh RETURN VALUES
Assorted mdoc(7) fixes.
2003-05-30 21:13:32 +00:00
Zero is returned on success, otherwise an error is returned.
Add a new man page for bus_activate_resource and bus_deactivate_resource. It could use some improvement, and others are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
.Sh SEE ALSO
.Xr bus_alloc_resource 9 ,
Add new bus methods for mapping resources. Add a pair of bus methods that can be used to "map" resources for direct CPU access using bus_space(9). bus_map_resource() creates a mapping and bus_unmap_resource() releases a previously created mapping. Mappings are described by 'struct resource_map' object. Pointers to these objects can be passed as the first argument to the bus_space wrapper API used for bus resources. Drivers that wish to map all of a resource using default settings (for example, using uncacheable memory attributes) do not need to change. However, drivers that wish to use non-default settings can now do so without jumping through hoops. First, an RF_UNMAPPED flag is added to request that a resource is not implicitly mapped with the default settings when it is activated. This permits other activation steps (such as enabling I/O or memory decoding in a device's PCI command register) to be taken without creating a mapping. Right now the AGP drivers don't set RF_ACTIVE to avoid using up a large amount of KVA to map the AGP aperture on 32-bit platforms. Once RF_UNMAPPED is supported on all platforms that support AGP this can be changed to using RF_UNMAPPED with RF_ACTIVE instead. Second, bus_map_resource accepts an optional structure that defines additional settings for a given mapping. For example, a driver can now request to map only a subset of a resource instead of the entire range. The AGP driver could also use this to only map the first page of the aperture (IIRC, it calls pmap_mapdev() directly to map the first page currently). I will also eventually change the PCI-PCI bridge driver to request mappings of the subset of the I/O window resource on its parent side to create mappings for child devices rather than passing child resources directly up to nexus to be mapped. This also permits bridges that do address translation to request suitable mappings from a resource on the "upper" side of the bus when mapping resources on the "lower" side of the bus. Another attribute that can be specified is an alternate memory attribute for memory-mapped resources. This can be used to request a Write-Combining mapping of a PCI BAR in an MI fashion. (Currently the drivers that do this call pmap_change_attr() directly for x86 only.) Note that this commit only adds the MI framework. Each platform needs to add support for handling RF_UNMAPPED and thew new bus_map/unmap_resource methods. Generally speaking, any drivers that are calling rman_set_bustag() and rman_set_bushandle() need to be updated. Discussed on: arch Reviewed by: cem Differential Revision: https://reviews.freebsd.org/D5237
2016-05-20 17:57:47 +00:00
.Xr bus_map_resource 9 ,
Add a missing section to a cross-reference. While here, add bus_space(9) to the SEE ALSO section.
2016-05-10 16:13:54 +00:00
.Xr bus_space 9 ,
Add a new man page for bus_activate_resource and bus_deactivate_resource. It could use some improvement, and others are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
.Xr device 9 ,
.Xr driver 9
.Sh AUTHORS
Assorted mdoc(7) fixes.
2003-05-30 21:13:32 +00:00
This manual page was written by
use .Mt to mark up email addresses consistently (part6) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de>
2014-06-26 21:44:30 +00:00
.An Warner Losh Aq Mt imp@FreeBSD.org .
Reference in New Issue Copy Permalink