ib(7d) - osol9

1ib(7D)                              Devices                             ib(7D)
2
3
4

NAME

6       ib - InfiniBand Bus Nexus Driver
7

DESCRIPTION

9       The ib (IB nexus) driver is a pseudo nexus driver that supports enumer‐
10       ation of  port  devices,  VPPA  (Virtual  Physical  Point  Attachment),
11       HCA_SVC  (HCA   Service)  devices,  and  I/O  controllers  (IOC) on the
12       InfiniBand fabric that are visible to the host and provides  interfaces
13       to  cfgadm_ib(1M)  to  manage  hot-plugging of IB devices. The ib nexus
14       driver enumerates the port device, VPPA  devices  and  HCA_SVC  devices
15       based on entries specified in the ib.conf file. IOC devices are enumer‐
16       ated on demand. The IB  nexus driver  uses  InfiniBand  Device  Manager
17       services  (ibdm(7D))  to  enumerate port devices, VPPA devices, HCA_SVC
18       devices, and IOCs on the IB fabric.
19

CONFIGURATION

21       You configure the ib driver by defining properties in the ib.conf file.
22       The IB nexus driver supports the following properties:
23
24
25
26
27       ┌──────────────┬─────────┬─────────────────────────────────────────────────────────┐
28       │PROPERTY NAME │ DEFAULT │ POSSIBLE VALUES                                         │
29       ├──────────────┼─────────┼─────────────────────────────────────────────────────────┤
30       │port-svc-list │ ""      │ List of service names,  for example:  srv               │
31       ├──────────────┼─────────┼─────────────────────────────────────────────────────────┤
32       │vppa-svc-list │ ""      │ List of service names, for example: ipib                │
33       ├──────────────┼─────────┼─────────────────────────────────────────────────────────┤
34       │hca-svc-list  │ ""      │ List of service names, for example: hca_nfs             │
35       └──────────────┴─────────┴─────────────────────────────────────────────────────────┘
36
37
38       The  port-svc-list property defines the list of port communication ser‐
39       vice names per port. The IB nexus driver creates a device instance  for
40       each  entry  in  this property per Host Channel Adapter (HCA) port. The
41       ib.conf file contains a port-svc-list="" entry by default.  You  update
42       port-svc-list with service names you want to add to the system.
43
44
45       The  vppa-svc-list property defines the list of VPPA communication ser‐
46       vice names per port per partition key. The IB nexus  driver  creates  a
47       device  instance  for  each  entry  in  this  property per Host Channel
48       Adapter (HCA) port. The ib.conf file contains a vppa-svc-list=""  entry
49       by default. You update vppa-svc-list with service names you want to add
50       to the system.
51
52
53       The hca-svc-list property defines the  list  of  HCA_SVC  communication
54       service  names  per  HCA. The IB nexus driver creates a device instance
55       for each entry in this property per Host  Channel  Adapter  (HCA).  The
56       ib.conf  file contains a hca-svc-list=""  entry by  default. You update
57       hca-svc-list with service names you want to add to the system.
58
59
60       The service name specified in port-svc-list, vppa-svc-list and hca-svc-
61       list must be  unique, be a maximum of four characters long, and is lim‐
62       ited to digits 0-9 and letters a-z and A-Z.
63
64
65       IOC drivers (which are parented by the IB nexus driver) may  themselves
66       have  .conf  files. To distinguish those cases from pseudo drivers par‐
67       ented by IB  nexus, such  drivers  should  include  the  "ib-node-type"
68       property  with  value  merge in the IOC driver.conf file. That property
69       ensures that properties from the .conf file are merged with other prop‐
70       erties found through hardware probing.
71

EXAMPLES

73       Example  1: A sample ib.conf file with one  service name entry for PORT
74       communication services.
75
76             #
77             # Copyright 2001-2003 Sun Microsystems, Inc.  All rights reserved.
78             # Use is subject to license terms.
79             #
80             port-svc-list=""
81             vppa-svc-list="";
82             hca-svc-list="";
83
84
85
86       In Example 1, the IB nexus driver does not create any port/vppa/hca_svc
87       device instances.
88
89
90       Example 2: A sample ib.conf file with one entry for "srv" service:
91
92
93            port-svc-list="srv"
94            vppa-svc-list="";
95            hca-svc-list="";
96
97
98
99       The IB nexus driver creates one srv service instance for every HCA port
100       that exists on the host. For example, if there are two HCAs, each  with
101       two  ports  on  the host, the IB nexus driver creates four instances of
102       the srv service.
103
104
105       Example 3: A sample ib.conf file  with  one   service  name  entry  for
106       each of Port and VPPA  communication services:
107
108
109            port-svc-list="srv"
110            vppa-svc-list="ipib";
111            hca-svc-list="";
112
113
114
115       If  there  are two HCAs in the system with two ports each and each port
116       has two  valid PKEY values, the IB  nexus driver creates four instances
117       of   srv  service (one for each port).  It also creates eight instances
118       of ipd service (one per each port/PKEY combination).
119
120
121       Example 4: A sample ib.conf  file  with  one  service  name  entry  for
122       each of Port, VPPA and HCA_SVC communication services:
123
124
125            port-svc-list="srv";
126            vppa-svc-list="ipib";
127            hca-svc-list="hca_nfs";
128
129
130
131       The  IB  nexus  driver creates one instance of hca_nfs service for each
132       HCA in the system.
133
134
135       Example 5: IOC driver .conf
136
137          ib-node-type="merge";
138          enable-special-mode="on";
139
140

FILES

142       /kernel/drv/ib            32-bit x86 ELF kernel module
143
144
145       /kernel/drv/amd64/ib      64-bit x86 ELF kernel module
146
147
148       /kernel/drv/sparcv9/ib    64-bit SPARC ELF kernel module
149
150
151       /kernel/drv/ib.conf       driver configuration file
152
153

ATTRIBUTES

155       See attributes(5) for a description of the following attribute:
156
157
158
159
160       ┌─────────────────────────────┬─────────────────────────────┐
161       │ATTRIBUTE  TYPE              │ATTRIBUTE VALUE              │
162       ├─────────────────────────────┼─────────────────────────────┤
163       │Architecture                 │SPARC, x86                   │
164       ├─────────────────────────────┼─────────────────────────────┤
165       │Availability                 │SUNWhea, SUNWib              │
166       ├─────────────────────────────┼─────────────────────────────┤
167       │Interface Stability          │Consolidation Private        │
168       └─────────────────────────────┴─────────────────────────────┘
169

DIAGNOSTICS

184       In  addition  to being logged, the following messages may appear on the
185       system console. All messages are formatted in the following manner:
186
187         ib: WARNING: Error message...
188
189
190
191       unit-address property in %s.conf not well-formed.
192
193           The driver.conf file does not have  a  valid  "unit-addr"  property
194           defined. This property is an array of strings.
195
196
197       cannot find unit-address in %s.conf.
198
199           The  driver.conf  file  does  not have a valid "unit-addr" property
200           defined. This property is an array of strings.
201
202
203       Waiting for Port %d initialization.
204
205           Waiting for port initialization from subnet manager.
206
207
208
209
210SunOS 5.11                        26 Jan 2009                           ib(7D)