share/man/man4/service_provider.conf.4

   1 '\" te
   2 .\" Copyright (c) 2003, 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 SERVICE_PROVIDER.CONF 4 "Jun 18, 2004"
   7 .SH NAME
   8 service_provider.conf \- service provider configuration file
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBservice_provider.conf\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .LP
  17 \fBservice_provider.conf\fR contains information about the device type that the
  18 service provider supports. This information includes the pathname of the
  19 service provider library, the library version and other library characteristics
  20 that are required by the system administrative command, \fBdatadm\fR(8).
  21 \fBdatadm\fR(8) puts this information in the DAT static register file,
  22 \fBdat.conf\fR(4).
  23 .sp
  24 .LP
  25 The \fBdatadm\fR program enumerates each device entry into a list of interface
  26 adapters, that is, interfaces to external network that are available to uDAPL
  27 consumers. This new list of interface adapters is appended to other service
  28 providers' information in the DAT static registry, \fBdat.conf\fR. You can do
  29 this if you invoke the \fBdatadm\fR program with the \fB-a\fR option and the
  30 pathname of the \fBservice_provider.conf\fR file.
  31 .sp
  32 .LP
  33 Each entry in the service_provider.conf is a single line of 7 fields.
  34 .sp
  35 .LP
  36 The following shows the order of the fields in a \fBservice_provider.conf\fR
  37 entry:
  38 .sp
  39 .in +2
  40 .nf
  41 "\fIdriver_name\fR" "\fIAPI_version\fR" "\fIthreadsafe_library\fR | \e
  42       \fInonthreadsafe_library\fR"\e
  43 "\fIdefault_version\fR | \fInondefault_version\fR" \e
  44      "\fIservice_provider_library_pathname\fR"\e
  45 "\fIservice_provider_version\fR" "\fIservice_provider_instance_data\fR"\e
  46 .fi
  47 .in -2
  48
  49 .sp
  50 .LP
  51 The fields are defined as follows:
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fIdriver_name\fR\fR
  56 .ad
  57 .sp .6
  58 .RS 4n
  59 Specifies a driver name in the format of \fBdriver_name\fR=\fIvalue pair\fR,
  60 for example, \fBdriver_name=tavor\fR.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fIAPI_version\fR\fR
  67 .ad
  68 .sp .6
  69 .RS 4n
  70 Specifies the API version of the service provider library: For example,
  71 \fB"u"major.minor\fR is \fBu1.2\fR.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fIthreadsafe_library\fR | \fInonthreadsafe_library\fR\fR
  78 .ad
  79 .sp .6
  80 .RS 4n
  81 Specifies a threadsafe or non-threadsafe library.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fIdefault_version\fR | \fInondefault_version\fR\fR
  88 .ad
  89 .sp .6
  90 .RS 4n
  91 Specifies a default or non-default version of a library. A service provider can
  92 offer several versions of the library. If so, one version is designated as
  93 \fBdefault\fR with the rest as \fBnondefault\fR.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fIservice_provider_library_pathname\fR\fR
 100 .ad
 101 .sp .6
 102 .RS 4n
 103 Specifies the pathname of the library image.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fIservice_provider_version\fR\fR
 110 .ad
 111 .sp .6
 112 .RS 4n
 113 Specifies the version of the service provider. By convention, specify the
 114 company stock symbol as the service provider, followed by major and minor
 115 version numbers, for example, \fBSUNW1.0\fR.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fIservice_provider_instance_data\fR\fR
 122 .ad
 123 .sp .6
 124 .RS 4n
 125 Specifies the service provider instance data.
 126 .RE
 127
 128 .SH EXAMPLES
 129 .LP
 130 \fBExample 1 \fRUsing a Logical Device Name
 131 .sp
 132 .LP
 133 The following example \fBservice_provider.conf\fR entry uses a logical device
 134 name:
 135
 136 .sp
 137 .in +2
 138 .nf
 139 #
 140 # Sample service_provider.conf entry showing an uDAPL 1.2 service
 141 # provider, udapl_tavor.so.1 supporting a device with a driver named
 142 # tavor
 143 driver_name=tavor u1.2 nonthreadsafe default udapl_tavor.so.1 \e
 144     SUNW.1.0 ""
 145 .fi
 146 .in -2
 147
 148 .LP
 149 \fBExample 2 \fRUsing a Physical Device Name
 150 .sp
 151 .LP
 152 The following example \fBservice_provider.conf\fR uses a physical device name:
 153
 154 .sp
 155 .in +2
 156 .nf
 157 #
 158 # Sample service_provider.conf entry showing an uDAPL 1.2
 159 # service provider, udapl_tavor.so.1 supporting a device named
 160 # pci15b3,5a44 that can be located under /devices
 161 #
 162 pci15b3,5a44 u1.2 nonthreadsafe default \e
 163     /usr/lib/tavor/udapl_tavor.so.1 SUNWudaplt1.0 ""
 164 .fi
 165 .in -2
 166
 167 .SH ATTRIBUTES
 168 .LP
 169 See \fBattributes\fR(5) for descriptions of the following attributes:
 170 .sp
 171
 172 .sp
 173 .TS
 174 box;
 175 c | c
 176 l | l .
 177 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 178 Stability       Evolving
 179 .TE
 180
 181 .SH SEE ALSO
 182 .LP
 183 \fBdatadm\fR(8), \fBdat.conf\fR(4), \fBattributes\fR(5)