usr/src/man/man9f/csx_ModifyWindow.9f

   1 '\" te
   2 .\"  Copyright (c) 2000, Sun Microsystems, Inc.
   3 .\"  All Rights Reserved
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH CSX_MODIFYWINDOW 9F "Jul 19, 1996"
   8 .SH NAME
   9 csx_ModifyWindow \- modify window attributes
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/pccard.h>
  14
  15
  16
  17 \fBint32_t\fR \fBcsx_ModifyWindow\fR(\fBwindow_handle_t\fR \fIwh\fR, \fBmodify_win_t *\fR\fImw\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIwh\fR \fR
  29 .ad
  30 .RS 7n
  31 Window handle returned from \fBcsx_RequestWindow\fR(9F).
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fImw\fR \fR
  38 .ad
  39 .RS 7n
  40 Pointer to a \fBmodify_win_t\fR structure.
  41 .RE
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 This function modifies the attributes of a window allocated by the
  47 \fBcsx_RequestWindow\fR(9F) function.
  48 .sp
  49 .LP
  50 Only some of the window attributes or the access speed field may be modified by
  51 this request. The \fBcsx_MapMemPage\fR(9F) function is also used to set the
  52 offset into \fBPC \fRCard memory to be mapped into system memory for paged
  53 windows. The \fBcsx_RequestWindow\fR(9F) and \fBcsx_ReleaseWindow\fR(9F)
  54 functions must be used to change the window base or size.
  55 .SH STRUCTURE MEMBERS
  56 .sp
  57 .LP
  58 The structure members of \fBmodify_win_t\fR are:
  59 .sp
  60 .in +2
  61 .nf
  62 uint32_t       Attributes;          /* window flags */
  63 uint32_t       AccessSpeed;         /* window access speed */
  64 .fi
  65 .in -2
  66
  67 .sp
  68 .LP
  69 The fields are defined as follows:
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBAttributes\fR \fR
  74 .ad
  75 .RS 15n
  76 This field is bit-mapped and defined as follows:
  77 .sp
  78 .ne 2
  79 .na
  80 \fBWIN_MEMORY_TYPE_CM\fR
  81 .ad
  82 .RS 26n
  83 Window points to Common Memory area. Set this to map the window to Common
  84 Memory.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fBWIN_MEMORY_TYPE_AM\fR
  91 .ad
  92 .RS 26n
  93 Window points to Attribute Memory area. Set this to map the window to Attribute
  94 Memory.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fBWIN_ENABLE\fR
 101 .ad
 102 .RS 26n
 103 Enable Window. The client must set this to enable the window.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fBWIN_ACCESS_SPEED_VALID\fR
 110 .ad
 111 .RS 26n
 112 \fBAccessSpeed\fR valid. The client must set this when the \fBAccessSpeed\fR
 113 field has a value that the client wants set for the window.
 114 .RE
 115
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBAccessSpeed\fR\fR
 122 .ad
 123 .RS 15n
 124 The bit definitions for this field use the format of the extended speed byte of
 125 the Device \fBID \fRtuple. If the mantissa is \fB0\fR (noted as reserved in the
 126 \fIPC Card 95 Standard\fR), the lower bits are a binary code representing a
 127 speed from the list below. Numbers in the first column are codes; items in the
 128 second column are speeds.
 129 .sp
 130 .ne 2
 131 .na
 132 \fB0\fR
 133 .ad
 134 .RS 9n
 135 Reserved: do not use
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB1\fR
 142 .ad
 143 .RS 9n
 144 \fB250 nsec\fR
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB2\fR
 151 .ad
 152 .RS 9n
 153 \fB200 nsec\fR
 154 .RE
 155
 156 .sp
 157 .ne 2
 158 .na
 159 \fB3\fR
 160 .ad
 161 .RS 9n
 162 \fB150 nsec\fR
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB4\fR
 169 .ad
 170 .RS 9n
 171 \fB100 nsec\fR
 172 .RE
 173
 174 .sp
 175 .ne 2
 176 .na
 177 \fB5 - 7\fR
 178 .ad
 179 .RS 9n
 180 Reserved: do not use
 181 .RE
 182
 183 It is recommended that clients use the \fBcsx_ConvertSpeed\fR(9F) function to
 184 generate the appropriate \fBAccessSpeed\fR values rather than manually
 185 perturbing the \fBAccessSpeed\fR field.
 186 .RE
 187
 188 .SH RETURN VALUES
 189 .sp
 190 .ne 2
 191 .na
 192 \fB\fBCS_SUCCESS\fR \fR
 193 .ad
 194 .RS 28n
 195 Successful operation.
 196 .RE
 197
 198 .sp
 199 .ne 2
 200 .na
 201 \fB\fBCS_BAD_HANDLE\fR \fR
 202 .ad
 203 .RS 28n
 204 Window handle is invalid.
 205 .RE
 206
 207 .sp
 208 .ne 2
 209 .na
 210 \fB\fBCS_NO_CARD\fR \fR
 211 .ad
 212 .RS 28n
 213 No \fBPC \fRCard in socket.
 214 .RE
 215
 216 .sp
 217 .ne 2
 218 .na
 219 \fB\fBCS_BAD_OFFSET\fR \fR
 220 .ad
 221 .RS 28n
 222 Error getting/setting window hardware parameters.
 223 .RE
 224
 225 .sp
 226 .ne 2
 227 .na
 228 \fB\fBCS_BAD_WINDOW\fR \fR
 229 .ad
 230 .RS 28n
 231 Error getting/setting window hardware parameters.
 232 .RE
 233
 234 .sp
 235 .ne 2
 236 .na
 237 \fB\fBCS_BAD_SPEED\fR \fR
 238 .ad
 239 .RS 28n
 240 \fBAccessSpeed\fR is invalid.
 241 .RE
 242
 243 .sp
 244 .ne 2
 245 .na
 246 \fB\fBCS_UNSUPPORTED_FUNCTION\fR \fR
 247 .ad
 248 .RS 28n
 249 No \fBPCMCIA \fRhardware installed.
 250 .RE
 251
 252 .SH CONTEXT
 253 .sp
 254 .LP
 255 This function may be called from user or kernel context.
 256 .SH SEE ALSO
 257 .sp
 258 .LP
 259 \fBcsx_ConvertSpeed\fR(9F), \fBcsx_MapMemPage\fR(9F),
 260 \fBcsx_ReleaseWindow\fR(9F), \fBcsx_RequestWindow\fR(9F)
 261 .sp
 262 .LP
 263 \fIPC Card 95 Standard, PCMCIA/JEIDA\fR