xref: /illumos-gate/usr/src/man/man9f/scsi_hba_iport_register.9f (revision 3385b4726f1b09aa9511340017fb23c7cde6aadd)
1*3385b472SRobert Mustacchi.\"
2*3385b472SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
3*3385b472SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
4*3385b472SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
5*3385b472SRobert Mustacchi.\" 1.0 of the CDDL.
6*3385b472SRobert Mustacchi.\"
7*3385b472SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
8*3385b472SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
9*3385b472SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
10*3385b472SRobert Mustacchi.\"
11*3385b472SRobert Mustacchi.\"
12*3385b472SRobert Mustacchi.\" Copyright (c) 2017, Joyent, Inc.
13*3385b472SRobert Mustacchi.\"
14*3385b472SRobert Mustacchi.Dd Apr 18, 2017
15*3385b472SRobert Mustacchi.Dt SCSI_HBA_IPORT_REGISTER 9F
16*3385b472SRobert Mustacchi.Os
17*3385b472SRobert Mustacchi.Sh NAME
18*3385b472SRobert Mustacchi.Nm scsi_hba_iport_register
19*3385b472SRobert Mustacchi.Nd register a new iport
20*3385b472SRobert Mustacchi.Sh SYNOPSIS
21*3385b472SRobert Mustacchi.In sys/scsi/scsi.h
22*3385b472SRobert Mustacchi.Ft int
23*3385b472SRobert Mustacchi.Fo scsi_hba_iport_register
24*3385b472SRobert Mustacchi.Fa "dev_info_t *dip"
25*3385b472SRobert Mustacchi.Fa "char *port"
26*3385b472SRobert Mustacchi.Fc
27*3385b472SRobert Mustacchi.Sh INTERFACE LEVEL
28*3385b472SRobert Mustacchi.Sy Evolving -
29*3385b472SRobert MustacchiThis interface is still evolving in illumos.
30*3385b472SRobert MustacchiAPI and ABI stability is
31*3385b472SRobert Mustacchinot guaranteed.
32*3385b472SRobert Mustacchi.Sh PARAMETERS
33*3385b472SRobert Mustacchi.Bl -tag -width Fa
34*3385b472SRobert Mustacchi.It Fa dip
35*3385b472SRobert MustacchiPointer to
36*3385b472SRobert Mustacchi.Vt dev_info
37*3385b472SRobert Mustacchistructure.
38*3385b472SRobert Mustacchi.It Fa port
39*3385b472SRobert MustacchiThe name of the iport to add.
40*3385b472SRobert Mustacchi.El
41*3385b472SRobert Mustacchi.Sh DESCRIPTION
42*3385b472SRobert MustacchiThe
43*3385b472SRobert Mustacchi.Fn scsi_hba_iport_register
44*3385b472SRobert Mustacchifunction is used to create a new iport.
45*3385b472SRobert MustacchiFor more information on iports and their uses, see
46*3385b472SRobert Mustacchi.Xr iport 9 .
47*3385b472SRobert MustacchiThis interface is generally used then there are a fixed, static set of
48*3385b472SRobert Mustacchiiports that exist in the system.
49*3385b472SRobert MustacchiIf the set of iports is dynamic or related to phys coming online and
50*3385b472SRobert Mustacchioffline, then the driver should instead consider using the
51*3385b472SRobert Mustacchi.Xr iportmap 9
52*3385b472SRobert Mustacchiabstraction.
53*3385b472SRobert Mustacchi.Pp
54*3385b472SRobert MustacchiThe iport will be created as a child of the device represented by
55*3385b472SRobert Mustacchi.Fa dip .
56*3385b472SRobert MustacchiThe iport will be bound to the same driver.
57*3385b472SRobert MustacchiTo distinguish nodes, the driver should use the
58*3385b472SRobert Mustacchi.Xr scsi_hba_iport_unit_address 9F
59*3385b472SRobert Mustacchifunction.
60*3385b472SRobert Mustacchi.Pp
61*3385b472SRobert MustacchiThe name of the iport, specified by
62*3385b472SRobert Mustacchi.Fa port ,
63*3385b472SRobert Mustacchimust be unique for a given parent.
64*3385b472SRobert MustacchiThe iport will not be created if the name is already in use.
65*3385b472SRobert MustacchiWhile names generally are based on unit addresses, they may be synthetic
66*3385b472SRobert Mustacchinames.
67*3385b472SRobert Mustacchi.Sh CONTEXT
68*3385b472SRobert MustacchiThe
69*3385b472SRobert Mustacchi.Fn scsi_hba_iport_register
70*3385b472SRobert Mustacchifunction is generally called during the
71*3385b472SRobert Mustacchi.Xr attach 9E
72*3385b472SRobert Mustacchientry point and may be called from
73*3385b472SRobert Mustacchi.Sy user
74*3385b472SRobert Mustacchior
75*3385b472SRobert Mustacchi.Sy kernel
76*3385b472SRobert Mustacchicontext.
77*3385b472SRobert Mustacchi.Sh RETURN VALUES
78*3385b472SRobert MustacchiUpon successful completion, the
79*3385b472SRobert Mustacchi.Fn scsi_hba_iport_register
80*3385b472SRobert Mustacchifunction returns
81*3385b472SRobert Mustacchi.Dv DDI_SUCCESS .
82*3385b472SRobert MustacchiOtherwise,
83*3385b472SRobert Mustacchi.Dv DDI_FAILURE
84*3385b472SRobert Mustacchiis returned.
85*3385b472SRobert Mustacchi.Sh SEE ALSO
86*3385b472SRobert Mustacchi.Xr iport 9 ,
87*3385b472SRobert Mustacchi.Xr iportmap 9 ,
88*3385b472SRobert Mustacchi.Xr scsi_hba_iportmap_iport_add 9F
89