share/man/man4/ib.4

   1 '\" te
   2 .\" Copyright (c) 2004, 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 IB 4 "Feb 19, 2004"
   7 .SH NAME
   8 ib \- InfiniBand device driver configuration files
   9 .SH DESCRIPTION
  10 .sp
  11 .LP
  12 The InfiniBand (IB) bus is an I/O transport based on switched  fabrics. IB
  13 devices are managed by the \fBib\fR(7D) nexus driver. There are three
  14 categories of InfiniBand devices:
  15 .RS +4
  16 .TP
  17 .ie t \(bu
  18 .el o
  19 IB  port/IB VPPA/IB HCA_SVC devices
  20 .RE
  21 .RS +4
  22 .TP
  23 .ie t \(bu
  24 .el o
  25 IB IOC devices
  26 .RE
  27 .RS +4
  28 .TP
  29 .ie t \(bu
  30 .el o
  31 IB Pseudo devices
  32 .RE
  33 .sp
  34 .LP
  35 The IB  port/IB VPPA/IB HCA_SVC devices are enumerated by way of the
  36 \fBib.conf\fR file. See \fBib\fR(7D).
  37 .sp
  38 .LP
  39 The IB IOC devices are enumerated using the InfiniBand Device management class.
  40 See \fBibdm\fR(7D).
  41 .sp
  42 .LP
  43 For devices not in these two categories, most notably IB Pseudo devices, the
  44 driver must provide configuration files to inform the system of the IB  devices
  45 to be created. Configuration parameters are represented in the form of name
  46 value pairs you can retrieve using the DDI property interfaces. See
  47 \fBddi_prop_op\fR(9F) for details.
  48 .sp
  49 .LP
  50 Configuration files for IB device drivers must identify the parent driver
  51 explicitly as \fBib\fR, and must create a string array property called
  52 \fBunit-address\fR which is unique to this entry in the configuration file.
  53 Drivers name \fBibport\fR and \fBioc\fR are reserved by \fBib\fR(7D) and should
  54 not be used.
  55 .sp
  56 .LP
  57 Each entry in the configuration file creates a prototype \fBdevinfo\fR node.
  58 Each node is assigned a unit address which is determined by the value of the
  59 \fBunit-address\fR  property. This property is only applicable to children of
  60 the IB parent and is required. See \fBdriver.conf\fR(4) for further details on
  61 configuration file syntax.
  62 .SH EXAMPLES
  63 .sp
  64 .LP
  65 Example 1: Sample configuration file
  66 .sp
  67 .LP
  68 Here is a configuration file called \fBibgen.conf\fR for an IB  device driver
  69 that implements a generic IB driver. This file creates a node called
  70 \fBibgen\fR.
  71 .sp
  72 .in +2
  73 .nf
  74      #
  75      # Copyright 2002-2003 Sun Microsystems, Inc.  All rights reserved.
  76      # Use is subject to license terms.
  77      #
  78      #ident  "@(#)ibgen.conf       1.3     03/05/01 SMI"
  79      name="ibgen" parent="ib" unit-address="0";
  80 .fi
  81 .in -2
  82
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBdriver.conf\fR(4), \fBib\fR(7D), \fBibtl\fR(7D), \fBddi_prop_op\fR(9F)