share/man/man9f/ddi_dma_set_sbus64.9f

   1 '\" te
   2 .\" Copyright (c) 1997, 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 DDI_DMA_SET_SBUS64 9F "Jan 1, 1997"
   7 .SH NAME
   8 ddi_dma_set_sbus64 \- allow 64-bit transfers on SBus
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/ddi.h>
  13 #include <sys/sunddi.h>
  14
  15
  16
  17 \fBint\fR \fBddi_dma_set_sbus64\fR(\fBddi_dma_handle_t\fR \fIhandle\fR, \fBuint_t\fR \fIburstsizes\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris DDI specific (Solaris DDI).
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIhandle\fR \fR
  29 .ad
  30 .RS 15n
  31 The handle filled in by a call to \fBddi_dma_alloc_handle\fR(9F).
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIburstsizes\fR \fR
  38 .ad
  39 .RS 15n
  40 The possible burst sizes the device's \fBDMA\fR engine can accept in 64-bit
  41 mode.
  42 .RE
  43
  44 .SH DESCRIPTION
  45 .sp
  46 .LP
  47 \fBddi_dma_set_sbus64()\fR informs the system that the device wishes to perform
  48 64-bit data transfers on the SBus. The driver must first allocate a  \fBDMA\fR
  49 handle using  \fBddi_dma_alloc_handle\fR(9F) with a \fBddi_dma_attr\fR(9S)
  50 structure describing the  \fBDMA\fR attributes for a 32-bit transfer mode.
  51 .sp
  52 .LP
  53 \fIburstsizes\fR describes the possible burst sizes the device's  \fBDMA\fR
  54 engine can accept in 64-bit mode. It may be  distinct from the burst sizes for
  55 32-bit mode set in the  \fBddi_dma_attr\fR(9S) structure. The system will
  56 activate 64-bit SBus transfers if the SBus supports them. Otherwise, the SBus
  57 will operate in 32-bit mode.
  58 .sp
  59 .LP
  60 After  \fBDMA\fR resources have been allocated (see
  61 \fBddi_dma_addr_bind_handle\fR(9F) or  \fBddi_dma_buf_bind_handle\fR(9F)), the
  62 driver should retrieve the available burst sizes by calling
  63 \fBddi_dma_burstsizes\fR(9F). This function will return the burst sizes  in
  64 64-bit mode if the system was able to  activate 64-bit transfers.  Otherwise
  65 burst sizes will be  returned in 32-bit mode.
  66 .SH RETURN VALUES
  67 .sp
  68 .LP
  69 \fBddi_dma_set_sbus64()\fR returns:
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBDDI_SUCCESS\fR \fR
  74 .ad
  75 .RS 16n
  76 Successfully set the SBus to 64-bit mode.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBDDI_FAILURE\fR \fR
  83 .ad
  84 .RS 16n
  85 64-bit mode could not be set.
  86 .RE
  87
  88 .SH CONTEXT
  89 .sp
  90 .LP
  91 \fBddi_dma_set_sbus64()\fR can be called from user, kernel, or interrupt
  92 context.
  93 .SH ATTRIBUTES
  94 .sp
  95 .LP
  96 See \fBattributes\fR(5) for descriptions of the following attributes:
  97 .sp
  98
  99 .sp
 100 .TS
 101 box;
 102 c | c
 103 l | l .
 104 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 105 _
 106 Architecture    SBus
 107 .TE
 108
 109 .SH SEE ALSO
 110 .sp
 111 .LP
 112 \fBattributes\fR(5), \fBddi_dma_addr_bind_handle\fR(9F),
 113 \fBddi_dma_alloc_handle\fR(9F), \fBddi_dma_buf_bind_handle\fR(9F),
 114 \fBddi_dma_burstsizes\fR(9F), \fBddi_dma_attr\fR(9S)
 115 .SH NOTES
 116 .sp
 117 .LP
 118 64-bit SBus mode is activated on a per SBus slot basis. If there are multiple
 119 SBus cards in one slot, they all must operate in 64-bit mode or they all must
 120 operate in 32-bit mode.