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

   1 '\" te
   2 .\" Copyright (c) 1993, Sun Microsystems, Inc.
   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_SYNC_PKT 9E "Nov 1, 1993"
   7 .SH NAME
   8 tran_sync_pkt \- SCSI HBA memory synchronization entry point
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/scsi/scsi.h>
  13
  14
  15
  16 \fBvoid prefix\fR\fBtran_sync_pkt\fR(\fBstruct scsi_address *\fR\fIap\fR,
  17      \fBstruct scsi_pkt *\fR\fIpkt\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\fIap\fR \fR
  29 .ad
  30 .RS 8n
  31 A pointer to a \fBscsi_address\fR(9S) structure.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIpkt\fR \fR
  38 .ad
  39 .RS 8n
  40 A pointer to a \fBscsi_pkt\fR(9S) structure.
  41 .RE
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 The \fBtran_sync_pkt()\fR vector in the \fBscsi_hba_tran\fR(9S) structure must
  47 be initialized during the \fBHBA\fR driver's \fBattach\fR(9E) to point to an
  48 \fBHBA\fR driver entry point to be called when a target driver calls
  49 \fBscsi_sync_pkt\fR(9F).
  50 .sp
  51 .LP
  52 \fBtran_sync_pkt()\fR must synchronize a \fBHBA\fR's or device's view of the
  53 data associated with the \fIpkt\fR, typically by calling
  54 \fBddi_dma_sync\fR(9F). The operation may also involve \fBHBA\fR
  55 hardware-specific details, such as  flushing \fBI/O\fR caches, or stalling
  56 until hardware buffers have been drained.
  57 .SH SEE ALSO
  58 .sp
  59 .LP
  60 \fBattach\fR(9E), \fBtran_init_pkt\fR(9E), \fBddi_dma_sync\fR(9F),
  61 \fBscsi_hba_attach\fR(9F), \fBscsi_init_pkt\fR(9F), \fBscsi_sync_pkt\fR(9F),
  62 \fBscsi_address\fR(9S), \fBscsi_hba_tran\fR(9S), \fBscsi_pkt\fR(9S)
  63 .sp
  64 .LP
  65 \fIWriting Device Drivers\fR
  66 .SH NOTES
  67 .sp
  68 .LP
  69 A target driver may call \fBtran_sync_pkt()\fR on packets for which no
  70 \fBDMA\fR resources were allocated.