usr/src/man/man9f/csx_MapLogSocket.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_MAPLOGSOCKET 9F "Jul 19, 1996"
   7 .SH NAME
   8 csx_MapLogSocket \- return the physical socket number associated with the
   9 client handle
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/pccard.h>
  14
  15
  16
  17 \fBint32_t\fR \fBcsx_MapLogSocket\fR(\fBclient_handle_t\fR \fIch\fR, \fBmap_log_socket_t *\fR\fIls\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\fIch\fR \fR
  29 .ad
  30 .RS 7n
  31 Client handle returned from \fBcsx_RegisterClient\fR(9F).
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIls\fR \fR
  38 .ad
  39 .RS 7n
  40 Pointer to a \fBmap_log_socket_t\fR structure.
  41 .RE
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 This function returns the physical socket number associated with the client
  47 handle.
  48 .SH STRUCTURE MEMBERS
  49 .sp
  50 .LP
  51 The structure members of \fBmap_log_socket_t\fR are:
  52 .sp
  53 .in +2
  54 .nf
  55 uint32_t     LogSocket;      /* logical socket number */
  56 uint32_t     PhyAdapter;     /* physical adapter number */
  57 uint32_t     PhySocket;      /* physical socket number */
  58 .fi
  59 .in -2
  60
  61 .sp
  62 .LP
  63 The fields are defined as follows:
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBLogSocket\fR \fR
  68 .ad
  69 .RS 15n
  70 Not used by this implementation of Card Services and can be set to any
  71 arbitrary value.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBPhyAdapter\fR \fR
  78 .ad
  79 .RS 15n
  80 Returns the physical adapter number, which is always \fB0\fR in the Solaris
  81 implementation of Card Services.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBPhySocket\fR \fR
  88 .ad
  89 .RS 15n
  90 Returns the physical socket number associated with the client handle. The
  91 physical socket number is typically used as part of an error or message string
  92 or if the client creates minor nodes based on the physical socket number.
  93 .RE
  94
  95 .SH RETURN VALUES
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBCS_SUCCESS\fR \fR
 100 .ad
 101 .RS 28n
 102 Successful operation.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBCS_BAD_HANDLE\fR \fR
 109 .ad
 110 .RS 28n
 111 Client handle is invalid.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBCS_UNSUPPORTED_FUNCTION\fR \fR
 118 .ad
 119 .RS 28n
 120 No \fBPCMCIA \fRhardware installed.
 121 .RE
 122
 123 .SH CONTEXT
 124 .sp
 125 .LP
 126 This function may be called from user or kernel context.
 127 .SH SEE ALSO
 128 .sp
 129 .LP
 130 \fBcsx_RegisterClient\fR(9F)
 131 .sp
 132 .LP
 133 \fIPC Card 95 Standard, PCMCIA/JEIDA\fR