usr/src/man/man9e/tran_tgt_free.9e

   1 '\" te
   2 .\"  Copyright (c) 1995, 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 TRAN_TGT_FREE 9E "Nov 1, 1993"
   7 .SH NAME
   8 tran_tgt_free \- request to free HBA resources allocated on behalf of a target
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/scsi/scsi.h>
  13
  14
  15
  16 \fBvoid prefix\fR\fBtran_tgt_free\fR(\fBdev_info_t *\fR\fIhba_dip\fR, \fBdev_info_t *\fR\fItgt_dip\fR,
  17      \fBscsi_hba_tran_t *\fR\fIhba_tran\fR, \fBstruct scsi_device *\fR\fIsd\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris architecture specific (Solaris DDI).
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIhba_dip\fR \fR
  29 .ad
  30 .RS 13n
  31 Pointer to a  \fBdev_info_t\fR structure, referring to the \fBHBA\fR device
  32 instance.
  33 .RE
  34
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fItgt_dip\fR \fR
  39 .ad
  40 .RS 13n
  41 Pointer to a  \fBdev_info_t\fR structure, referring to the target device
  42 instance.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fIhba_tran\fR \fR
  49 .ad
  50 .RS 13n
  51 Pointer to a  \fBscsi_hba_tran\fR(9S) structure, consisting of the \fBHBA\fR's
  52 transport vectors.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fIsd\fR \fR
  59 .ad
  60 .RS 13n
  61 Pointer to a  \fBscsi_device\fR(9S) structure, describing the target.
  62 .RE
  63
  64 .SH DESCRIPTION
  65 .sp
  66 .LP
  67 The \fBtran_tgt_free()\fR vector in the \fBscsi_hba_tran\fR(9S) structure may
  68 be initialized during the \fBHBA\fR driver's \fBattach\fR(9E) to point to an
  69 \fBHBA\fR driver function to be called by the system when an instance of a
  70 target device is being detached.  The \fBtran_tgt_free()\fR vector, if not
  71 \fINULL\fR, is called after the target device instance has returned
  72 successfully from its \fBdetach\fR(9E) entry point, but before the
  73 \fBdev_info\fR node structure is removed from the system. The \fBHBA\fR driver
  74 should release any resources allocated during its \fBtran_tgt_init()\fR or
  75 \fBtran_tgt_probe()\fR initialization performed for this target device
  76 instance.
  77 .SH SEE ALSO
  78 .sp
  79 .LP
  80 \fBattach\fR(9E), \fBdetach\fR(9E), \fBtran_tgt_init\fR(9E),
  81 \fBtran_tgt_probe\fR(9E), \fBscsi_device\fR(9S), \fBscsi_hba_tran\fR(9S)
  82 .sp
  83 .LP
  84 \fIWriting Device Drivers\fR