usr/src/man/man9f/dlbindack.9f

   1 '\" te
   2 .\"  Copyright (c) 2006, 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 DLBINDACK 9F "April 9, 2016"
   7 .SH NAME
   8 dlbindack, dlphysaddrack, dlokack, dlerrorack, dluderrorind \- DLPI device
   9 driver helper functions
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/dlpi.h>
  14
  15
  16
  17 \fBvoid\fR \fBdlokack\fR(\fBqueue_t *\fR\fIwq\fR, \fBmblk_t *\fR\fImp\fR, \fBt_uscalar_t\fR \fIcorrect_primitive\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBvoid\fR \fBdlerrorack\fR(\fBqueue_t *\fR\fIwq\fR, \fBmblk_t *\fR\fImp\fR, \fBt_uscalar_t\fR \fIerror_primitive\fR,
  23      \fBt_uscalar_t\fR \fIerror\fR, \fBt_uscalar_t\fR \fIunix_errno\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBvoid\fR \fBdlbindack\fR(\fBqueue_t *\fR\fIwq\fR, \fBmblk_t *\fR\fImp\fR, \fBt_scalar_t\fR \fIsap\fR, \fBconst void *\fR\fIaddrp\fR,
  29      \fBt_uscalar_t\fR \fIaddrlen\fR, \fBt_uscalar_t\fR \fImaxconind\fR, \fB t_uscalar_t\fR \fIxidtest\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBvoid\fR \fBdlphysaddrack\fR(\fBqueue_t *\fR\fIwq\fR, \fBmblk_t *\fR\fImp\fR, \fBconst void *\fR\fIaddrp\fR,
  35      \fBt_uscalar_t\fR \fIaddrlen\fR);
  36 .fi
  37
  38 .LP
  39 .nf
  40 \fBvoid\fR \fBdluderrorind\fR(\fBqueue_t *\fR\fIwq\fR, \fBmblk_t *\fR\fImp\fR, \fBconst void *\fR\fIaddrp\fR,
  41      \fBt_uscalar_t\fR \fIaddrlen\fR, \fBt_uscalar_t\fR \fIerror\fR, \fBt_uscalar_t\fR \fIunix_errno\fR);
  42 .fi
  43
  44 .SH INTERFACE LEVEL
  45 .LP
  46 Solaris DDI specific (Solaris DDI).
  47 .SH PARAMETERS
  48 .ne 2
  49 .na
  50 \fB\fIwq\fR\fR
  51 .ad
  52 .RS 21n
  53 Streams write queue.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fImp\fR\fR
  60 .ad
  61 .RS 21n
  62 Pointer to the bind request message.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fIsap\fR\fR
  69 .ad
  70 .RS 21n
  71 Service access point being requested.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fIaddrp\fR\fR
  78 .ad
  79 .RS 21n
  80 Pointer to the dlpi layer source address.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fIaddrlen\fR\fR
  87 .ad
  88 .RS 21n
  89 Size of the \fBdlpi\fR layer address pointed to by \fIaddr\fR.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fImaxconind\fR\fR
  96 .ad
  97 .RS 21n
  98 Maximum number of \fBDL_CONNECT_IND\fR messages allowed to be outstanding per
  99 stream.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fIxidtest\fR\fR
 106 .ad
 107 .RS 21n
 108 The \fBXID\fR and \fBTEST\fR responses supported.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fIcorrect_primitive\fR\fR
 115 .ad
 116 .RS 21n
 117 Identifies the \fBDL\fR primitive completing successfully.
 118 .RE
 119
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fIerror_primitive\fR\fR
 124 .ad
 125 .RS 21n
 126 Identifies the \fBDL\fR primitive in error.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fIerror\fR\fR
 133 .ad
 134 .RS 21n
 135 \fBDLPI\fR error associated with the failure in the \fBDLPI\fR request.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fIunix_errno\fR\fR
 142 .ad
 143 .RS 21n
 144 Corresponding \fBUNIX\fR system error that can be associated with the failure
 145 in the \fBDLPI\fR request.
 146 .RE
 147
 148 .SH DESCRIPTION
 149 .LP
 150 All functions described in this manpage take a pointer to the message passed to
 151 the \fBDLPI\fR provider (\fBmblk_t\fR) and attempt to reuse it in formulating
 152 the \fBM_PROTO\fR reply. If the message block is too small to be reused, it is
 153 freed and a new one is allocated.
 154 .sp
 155 .LP
 156 All functions reply upstream using \fBqreply\fR(9F). The write-side queue
 157 pointer must be provided.
 158 .sp
 159 .LP
 160 The \fBdlokack()\fR function provides the successful acknowledgement
 161 \fBDL_OK_ACK\fR message reply to the \fBDLPI\fR provider and is used to
 162 complete many of the \fBDLPI\fR requests in the \fBDLPI\fR consumer.
 163 .sp
 164 .LP
 165 The \fBdlerrorack()\fR function provides the unsuccessful acknowledgement
 166 \fBDL_ERROR_ACK\fR message reply to the \fBDLPI\fR() provider and is used for
 167 error completions were required for \fBDLPI\fR requests in the \fBDLPI\fR
 168 consumer.
 169 .sp
 170 .LP
 171 The \fBdlbindack()\fR function provides the \fBDL_BIND_ACK\fR message reply to
 172 the \fBDLPI\fR provider and is used to complete the \fBDL_BIND_REQ\fR
 173 processing in the \fBDLPI\fR consumer.
 174 .sp
 175 .LP
 176 The \fBdlphysaddrack()\fR function provides the \fB\fR()\fBDL_PHYS_ADDR_ACK\fR
 177 message reply used to complete the \fBDL_PHYS_ADDR_ACK\fR processing.
 178 .sp
 179 .LP
 180 The \fBdluderrorind()\fR function provides the \fBDL_UDERROR_IND\fR message
 181 reply used to complete an unsuccessful \fBDL_UNITDATA_REQ\fR.
 182 .SH RETURN VALUES
 183 .LP
 184 None.
 185 .SH NOTES
 186 .LP
 187 These functions are not required if you are are writing a \fBDLPI\fR device
 188 driver using \fBgld\fR(7D).
 189 .SH CONTEXT
 190 .LP
 191 All \fBDLPI\fR helper functions can be called from user, interrupt, or kernel
 192 context.
 193 .SH SEE ALSO
 194 .LP
 195 \fBgld\fR(7D), \fBdlpi\fR(7P), \fBqreply\fR(9F)
 196 .sp
 197 .LP
 198 \fIWriting Device Drivers\fR
 199 .sp
 200 .LP
 201 \fISTREAMS Programming Guide\fR