comparison usr/src/man/man4/sysbus.4 @ 23918:f3c8f3a2a25c

13404 man page spelling errors Reviewed by: Ryan Zezeski <ryan@oxide.computer> Reviewed by: Robert Mustacchi <rm@fingolfin.org> Approved by: Richard Lowe <richlowe@richlowe.net>
author Peter Tribble <peter.tribble@gmail.com>
date Thu, 31 Dec 2020 10:47:42 +0000
parents 5b2854ecc12d
children
comparison
equal deleted inserted replaced
23917:265d423ec4f7 23918:f3c8f3a2a25c
1 '\" te 1 '\" te
2 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved 2 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. 3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. 4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] 5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH SYSBUS 4 "Nov 18, 2004" 6 .TH SYSBUS 4 "December 28, 2020"
7 .SH NAME 7 .SH NAME
8 sysbus, isa \- device tree properties for ISA bus device drivers 8 sysbus, isa \- device tree properties for ISA bus device drivers
9 .SH DESCRIPTION 9 .SH DESCRIPTION
10 .sp 10 Solaris for x86 supports the \fBISA\fR bus as the system bus. Drivers for
11 .LP 11 devices on this bus use the device tree built by the booting system to
12 Solaris for x86 supports the \fBISA\fR bus as the system bus. Drivers for
13 devices on this buse use the device tree built by the booting system to
14 retrieve the necessary system resources used by the driver. These resources 12 retrieve the necessary system resources used by the driver. These resources
15 include device I/O port addresses, any interrupt capabilities that the device 13 include device I/O port addresses, any interrupt capabilities that the device
16 can have, any DMA channels it can require, and any memory-mapped addresses it 14 can have, any DMA channels it can require, and any memory-mapped addresses it
17 can occupy. 15 can occupy.
18 .sp 16 .sp
19 .LP 17 .LP
20 Configuration files for \fBISA\fR device drivers are only necessary to describe 18 Configuration files for \fBISA\fR device drivers are only necessary to describe
40 file for the driver. Each entry in the array of integers for the 38 file for the driver. Each entry in the array of integers for the
41 \fBinterrupt-priorities\fR property is matched one-to-one with the elements in 39 \fBinterrupt-priorities\fR property is matched one-to-one with the elements in
42 the \fBinterrupts\fR property to specify the \fBIPL\fR value that is used by 40 the \fBinterrupts\fR property to specify the \fBIPL\fR value that is used by
43 the system for this interrupt in this driver. This is the priority that this 41 the system for this interrupt in this driver. This is the priority that this
44 device's interrupt handler receives relative to the interrupt handlers of other 42 device's interrupt handler receives relative to the interrupt handlers of other
45 drivers. The priority is an integer from \fB1\fR to \fB16\fR. Generally, 43 drivers. The priority is an integer from \fB1\fR to \fB16\fR. Generally,
46 disks are assigned a priority of \fB5\fR, while mice and printers are lower, 44 disks are assigned a priority of \fB5\fR, while mice and printers are lower,
47 and serial communication devices are higher, typically \fB7\fR. \fB10\fR is 45 and serial communication devices are higher, typically \fB7\fR. \fB10\fR is
48 reserved by the system and must not be used. Priorities \fB11\fR and greater 46 reserved by the system and must not be used. Priorities \fB11\fR and greater
49 are high level priorities and are generally not recommended (see 47 are high level priorities and are generally not recommended (see
50 \fBddi_intr_hilevel\fR(9F)). 48 \fBddi_intr_hilevel\fR(9F)).
67 associated with the device on the bus. 65 associated with the device on the bus.
68 .sp 66 .sp
69 The first integer of the tuple specifies the memory type, \fB0\fR specifies a 67 The first integer of the tuple specifies the memory type, \fB0\fR specifies a
70 memory range and \fB1\fR specifies an I/O range. The second integer specifies 68 memory range and \fB1\fR specifies an I/O range. The second integer specifies
71 the base address of the memory range. The third integer of each 3-tuple 69 the base address of the memory range. The third integer of each 3-tuple
72 specifies the size, in bytes, of the mappable region. 70 specifies the size, in bytes, of the mappable region.
73 .sp 71 .sp
74 The driver can refer to the elements of this array by index, and construct 72 The driver can refer to the elements of this array by index, and construct
75 kernel mappings to these addresses using \fBddi_map_regs\fR(9F). The index into 73 kernel mappings to these addresses using \fBddi_map_regs\fR(9F). The index into
76 the array is passed as the \fIrnumber\fR argument of \fBddi_map_regs()\fR. 74 the array is passed as the \fIrnumber\fR argument of \fBddi_map_regs()\fR.
77 .sp 75 .sp
78 All \fBsysbus\fR devices have \fBreg\fR properties. The first tuple of this 76 All \fBsysbus\fR devices have \fBreg\fR properties. The first tuple of this
79 property is used to construct the address part of the device name under 77 property is used to construct the address part of the device name under
80 \fB/devices\fR. In the case of \fBPlug and Play ISA\fR devices, the first tuple 78 \fB/devices\fR. In the case of \fBPlug and Play ISA\fR devices, the first tuple
81 is a special tuple that does not denote a memory range, but is used by the 79 is a special tuple that does not denote a memory range, but is used by the
82 system only to create the address part of the device name. This special tuple 80 system only to create the address part of the device name. This special tuple
83 can be recognized by determining if the top bit of the first integer is set to 81 can be recognized by determining if the top bit of the first integer is set to
84 a one. 82 a one.
104 A list of integers that specifies the DMA channels used by this device. Only 102 A list of integers that specifies the DMA channels used by this device. Only
105 devices that use DMA channels have a \fBdma-channels\fR property. 103 devices that use DMA channels have a \fBdma-channels\fR property.
106 .RE 104 .RE
107 105
108 .SH ATTRIBUTES 106 .SH ATTRIBUTES
109 .sp
110 .LP
111 See \fBattributes\fR(5) for descriptions of the following attributes: 107 See \fBattributes\fR(5) for descriptions of the following attributes:
112 .sp 108 .sp
113 109
114 .sp 110 .sp
115 .TS 111 .TS
120 _ 116 _
121 Architecture x86 117 Architecture x86
122 .TE 118 .TE
123 119
124 .SH SEE ALSO 120 .SH SEE ALSO
125 .sp
126 .LP
127 \fBprtconf\fR(1M), \fBdriver.conf\fR(4), \fBscsi\fR(4), \fBattributes\fR(5), 121 \fBprtconf\fR(1M), \fBdriver.conf\fR(4), \fBscsi\fR(4), \fBattributes\fR(5),
128 \fBddi_add_intr\fR(9F), \fBddi_intr_hilevel\fR(9F), \fBddi_map_regs\fR(9F), 122 \fBddi_add_intr\fR(9F), \fBddi_intr_hilevel\fR(9F), \fBddi_map_regs\fR(9F),
129 \fBddi_prop_op\fR(9F) 123 \fBddi_prop_op\fR(9F)
130 .sp 124 .sp
131 .LP 125 .LP