diff options
author | David Gwynne <dlg@cvs.openbsd.org> | 2013-01-29 01:19:28 +0000 |
---|---|---|
committer | David Gwynne <dlg@cvs.openbsd.org> | 2013-01-29 01:19:28 +0000 |
commit | 2ec333c99f774fa96ddff5617287613745d8045f (patch) | |
tree | caa2e5f1c9d70f38bfa1a76a55f13af4c0a65687 /share/man | |
parent | 0ca8a6aa1dbde8c1d492b6a2824b3febe978abb1 (diff) |
document bus_space_{read,write}_raw_N(). needs some polishing...
Diffstat (limited to 'share/man')
-rw-r--r-- | share/man/man9/Makefile | 8 | ||||
-rw-r--r-- | share/man/man9/bus_space.9 | 39 |
2 files changed, 41 insertions, 6 deletions
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index 5e3d5e91ff4..af4cfbc4f2d 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.175 2013/01/28 09:46:25 dlg Exp $ +# $OpenBSD: Makefile,v 1.176 2013/01/29 01:19:27 dlg Exp $ # $NetBSD: Makefile,v 1.4 1996/01/09 03:23:01 thorpej Exp $ # Makefile for section 9 (kernel function and variable) manual pages. @@ -62,6 +62,9 @@ MLINKS+=bus_space.9 bus_space_alloc.9 bus_space.9 bus_space_barrier.9 \ bus_space.9 bus_space_mmap.9 \ bus_space.9 bus_space_read_1.9 bus_space.9 bus_space_read_2.9 \ bus_space.9 bus_space_read_4.9 bus_space.9 bus_space_read_8.9 \ + bus_space.9 bus_space_read_raw_2.9 \ + bus_space.9 bus_space_read_raw_4.9 \ + bus_space.9 bus_space_read_raw_8.9 \ bus_space.9 bus_space_read_multi_1.9 \ bus_space.9 bus_space_read_multi_2.9 \ bus_space.9 bus_space_read_multi_4.9 \ @@ -87,6 +90,9 @@ MLINKS+=bus_space.9 bus_space_alloc.9 bus_space.9 bus_space_barrier.9 \ bus_space.9 bus_space_subregion.9 bus_space.9 bus_space_unmap.9 \ bus_space.9 bus_space_write_1.9 bus_space.9 bus_space_write_2.9 \ bus_space.9 bus_space_write_4.9 bus_space.9 bus_space_write_8.9 \ + bus_space.9 bus_space_write_raw_2.9 \ + bus_space.9 bus_space_write_raw_4.9 \ + bus_space.9 bus_space_write_raw_8.9 \ bus_space.9 bus_space_write_multi_1.9 \ bus_space.9 bus_space_write_multi_2.9 \ bus_space.9 bus_space_write_multi_4.9 \ diff --git a/share/man/man9/bus_space.9 b/share/man/man9/bus_space.9 index 5e8b1a4d1fe..7f23bc78e7f 100644 --- a/share/man/man9/bus_space.9 +++ b/share/man/man9/bus_space.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: bus_space.9,v 1.21 2012/12/10 13:03:54 mpi Exp $ +.\" $OpenBSD: bus_space.9,v 1.22 2013/01/29 01:19:27 dlg Exp $ .\" $NetBSD: bus_space.9,v 1.15 2000/08/09 03:11:00 tv Exp $ .\" .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -28,7 +28,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: December 10 2012 $ +.Dd $Mdocdate: January 29 2013 $ .Dt BUS_SPACE 9 .Os .Sh NAME @@ -54,6 +54,9 @@ .Nm bus_space_read_raw_multi_2 , .Nm bus_space_read_raw_multi_4 , .Nm bus_space_read_raw_multi_8 , +.Nm bus_space_read_raw_2 , +.Nm bus_space_read_raw_4 , +.Nm bus_space_read_raw_8 , .Nm bus_space_read_region_1 , .Nm bus_space_read_region_2 , .Nm bus_space_read_region_4 , @@ -86,6 +89,9 @@ .Nm bus_space_write_multi_4 , .Nm bus_space_write_multi_8 , .\".Nm bus_space_write_raw_multi_1 , +.Nm bus_space_write_raw_2 , +.Nm bus_space_write_raw_4 , +.Nm bus_space_write_raw_8 , .Nm bus_space_write_raw_multi_2 , .Nm bus_space_write_raw_multi_4 , .Nm bus_space_write_raw_multi_8 , @@ -139,6 +145,15 @@ .Ft u_int64_t .Fn bus_space_read_8 "bus_space_tag_t space" "bus_space_handle_t handle" \ "bus_size_t offset" +.Ft u_int16_t +.Fn bus_space_read_raw_2 "bus_space_tag_t space" \ +"bus_space_handle_t handle" "bus_size_t offset" +.Ft u_int32_t +.Fn bus_space_read_raw_4 "bus_space_tag_t space" \ +"bus_space_handle_t handle" "bus_size_t offset" +.Ft u_int64_t +.Fn bus_space_read_raw_8 "bus_space_tag_t space" \ +"bus_space_handle_t handle" "bus_size_t offset" .Ft void .Fn bus_space_write_1 "bus_space_tag_t space" "bus_space_handle_t handle" \ "bus_size_t offset" "u_int8_t value" @@ -152,6 +167,15 @@ .Fn bus_space_write_8 "bus_space_tag_t space" "bus_space_handle_t handle" \ "bus_size_t offset" "u_int64_t value" .Ft void +.Fn bus_space_write_raw_2 "bus_space_tag_t space" "bus_space_handle_t handle" \ +"bus_size_t offset" "u_int16_t value" +.Ft void +.Fn bus_space_write_raw_4 "bus_space_tag_t space" "bus_space_handle_t handle" \ +"bus_size_t offset" "u_int32_t value" +.Ft void +.Fn bus_space_write_raw_8 "bus_space_tag_t space" "bus_space_handle_t handle" \ +"bus_size_t offset" "u_int64_t value" +.Ft void .Fn bus_space_barrier "bus_space_tag_t space" "bus_space_handle_t handle" \ "bus_size_t offset" "bus_size_t length" "int flags" .Ft void @@ -1387,10 +1411,9 @@ Most of the functions imply a host byte-order and a bus byte-order and take care of any translation for the caller. In some cases, however, hardware may map a FIFO or some other memory -region for which the caller may want to use multi-word, yet untranslated -access. +region for which the caller may want to use untranslated access. Access to these types of memory regions should be with the -.Fn bus_space_*_raw_*_N +.Fn bus_space_{read,write}_raw_*N functions. .Pp .Bl -ohang -compact @@ -1399,6 +1422,9 @@ functions. .\".It Fn bus_space_read_stream_4 "space" "handle" "offset" .\".It Fn bus_space_read_stream_8 "space" "handle" "offset" .\".It Fn bus_space_read_raw_multi_1 "space" "handle" "offset" "datap" "size" +.It Fn bus_space_read_raw_2 "space" "handle" "offset" +.It Fn bus_space_read_raw_4 "space" "handle" "offset" +.It Fn bus_space_read_raw_8 "space" "handle" "offset" .It Fn bus_space_read_raw_multi_2 "space" "handle" "offset" "datap" "size" .It Fn bus_space_read_raw_multi_4 "space" "handle" "offset" "datap" "size" .It Fn bus_space_read_raw_multi_8 "space" "handle" "offset" "datap" "size" @@ -1411,6 +1437,9 @@ functions. .\".It Fn bus_space_write_stream_4 "space" "handle" "offset" "value" .\".It Fn bus_space_write_stream_8 "space" "handle" "offset" "value" .\".It Fn bus_space_write_raw_multi_1 "space" "handle" "offset" "datap" "size" +.It Fn bus_space_write_raw_2 "space" "handle" "offset" "value" +.It Fn bus_space_write_raw_4 "space" "handle" "offset" "value" +.It Fn bus_space_write_raw_8 "space" "handle" "offset" "value" .It Fn bus_space_write_raw_multi_2 "space" "handle" "offset" "datap" "size" .It Fn bus_space_write_raw_multi_4 "space" "handle" "offset" "datap" "size" .It Fn bus_space_write_raw_multi_8 "space" "handle" "offset" "datap" "size" |