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

   1 '\" te
   2 .\"  Copyright (c) 1996, 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.
   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]
   6 .TH CSX_CONVERTSPEED 9F "Jul 19, 1996"
   7 .SH NAME
   8 csx_ConvertSpeed \- convert device speeds
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13
  14
  15
  16 \fBint32_t\fR \fBcsx_ConvertSpeed\fR(\fBconvert_speed_t *\fR\fIcs\fR);
  17 .fi
  18
  19 .SH INTERFACE LEVEL
  20 .sp
  21 .LP
  22 Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIcs\fR \fR
  28 .ad
  29 .RS 7n
  30 Pointer to a \fBconvert_speed_t\fR structure.
  31 .RE
  32
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 This function is a Solaris-specific extension that provides a method for
  37 clients to convert from one type of device speed representation to another,
  38 that is, from \fIdevspeed\fR format to \fInS\fR and vice versa.
  39 .SH STRUCTURE MEMBERS
  40 .sp
  41 .LP
  42 The structure members of \fBconvert_speed_t\fR are:
  43 .sp
  44 .in +2
  45 .nf
  46 uint32_t     Attributes;
  47 uint32_t     nS;
  48 uint32_t     devspeed;
  49 .fi
  50 .in -2
  51
  52 .sp
  53 .LP
  54 The fields are defined as follows:
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBAttributes\fR \fR
  59 .ad
  60 .RS 15n
  61 This is a bit-mapped field that identifies the type of speed conversion to be
  62 performed. The field is defined as follows:
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBCONVERT_NS_TO_DEVSPEED\fR\fR
  67 .ad
  68 .RS 26n
  69 Converts \fInS\fR to \fIdevspeed\fR format
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBCONVERT_DEVSPEED_TO_NS\fR\fR
  76 .ad
  77 .RS 26n
  78 Converts \fIdevspeed\fR format to \fInS\fR
  79 .RE
  80
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBnS\fR \fR
  87 .ad
  88 .RS 15n
  89 If \fBCONVERT_NS_TO_DEVSPEED\fR is set, the value in the \fBnS\fR field is
  90 converted to a \fIdevspeed\fR format and returned in the \fBdevspeed\fR field.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBdevspeed\fR \fR
  97 .ad
  98 .RS 15n
  99 If \fBCONVERT_DEVSPEED_TO_NS\fR is set, the value in the \fBdevspeed\fR field
 100 is converted to an \fInS\fR value and returned in the \fBnS\fR field.
 101 .RE
 102
 103 .SH RETURN VALUES
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBCS_SUCCESS\fR \fR
 108 .ad
 109 .RS 28n
 110 Successful operation.
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fBCS_BAD_SPEED\fR \fR
 117 .ad
 118 .RS 28n
 119 Invalid \fInS\fR or \fIdevspeed\fR.
 120 .RE
 121
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fBCS_BAD_ATTRIBUTE\fR \fR
 126 .ad
 127 .RS 28n
 128 Bad \fBAttributes\fR value.
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fBCS_UNSUPPORTED_FUNCTION\fR \fR
 135 .ad
 136 .RS 28n
 137 No \fBPCMCIA \fRhardware installed.
 138 .RE
 139
 140 .SH CONTEXT
 141 .sp
 142 .LP
 143 This function may be called from user or kernel context.
 144 .SH SEE ALSO
 145 .sp
 146 .LP
 147 \fBcsx_ModifyWindow\fR(9F), \fBcsx_RequestWindow\fR(9F)
 148 .sp
 149 .LP
 150 \fIPC Card 95 Standard, PCMCIA/JEIDA\fR