xref: /onnv-gate/usr/src/uts/common/sys/1394/adapters/hci1394_buf.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright (c) 1999-2000 by Sun Microsystems, Inc.
24*0Sstevel@tonic-gate  * All rights reserved.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _SYS_1394_ADAPTERS_HCI1394_BUF_H
28*0Sstevel@tonic-gate #define	_SYS_1394_ADAPTERS_HCI1394_BUF_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate /*
33*0Sstevel@tonic-gate  * hci1394_buf.h
34*0Sstevel@tonic-gate  *   These routines handle IO bound memory.  They include routines to alloc and
35*0Sstevel@tonic-gate  *   free. IO bound memory and a routine to get the adapter's default dma
36*0Sstevel@tonic-gate  *   attributes.
37*0Sstevel@tonic-gate  */
38*0Sstevel@tonic-gate 
39*0Sstevel@tonic-gate #ifdef __cplusplus
40*0Sstevel@tonic-gate extern "C" {
41*0Sstevel@tonic-gate #endif
42*0Sstevel@tonic-gate 
43*0Sstevel@tonic-gate #include <sys/ddi.h>
44*0Sstevel@tonic-gate #include <sys/modctl.h>
45*0Sstevel@tonic-gate #include <sys/sunddi.h>
46*0Sstevel@tonic-gate 
47*0Sstevel@tonic-gate 
48*0Sstevel@tonic-gate /*
49*0Sstevel@tonic-gate  * Input parameters into buf_alloc().
50*0Sstevel@tonic-gate  *    bp_length - size of buffer to alloc and map into IO space.
51*0Sstevel@tonic-gate  *    bp_max_cookies - maximum number of cookies we can handle.
52*0Sstevel@tonic-gate  *    bp_alignment - buffer alignment requirements.
53*0Sstevel@tonic-gate  *
54*0Sstevel@tonic-gate  * bp_max_cookies overwrites the adapter's default dma_attr_sgllen setting.
55*0Sstevel@tonic-gate  * bp_alignment overwrites the adapter's default dma_attr_align setting.
56*0Sstevel@tonic-gate  */
57*0Sstevel@tonic-gate typedef struct hci1394_buf_parms_s {
58*0Sstevel@tonic-gate 	size_t		bp_length;
59*0Sstevel@tonic-gate 	uint_t		bp_max_cookies;
60*0Sstevel@tonic-gate 	uint64_t	bp_alignment;
61*0Sstevel@tonic-gate } hci1394_buf_parms_t;
62*0Sstevel@tonic-gate 
63*0Sstevel@tonic-gate /*
64*0Sstevel@tonic-gate  * Output from buf_alloc().  This structure contains information
65*0Sstevel@tonic-gate  * about the buffer allocated.
66*0Sstevel@tonic-gate  */
67*0Sstevel@tonic-gate typedef struct hci1394_buf_info_s {
68*0Sstevel@tonic-gate 	ddi_dma_cookie_t	bi_cookie; /* ddi_dma_addr_bind_handle */
69*0Sstevel@tonic-gate 	uint_t			bi_cookie_count; /* ddi_dma_addr_bind_handle */
70*0Sstevel@tonic-gate 	caddr_t			bi_kaddr; /* ddi_dma_mem_alloc */
71*0Sstevel@tonic-gate 	size_t			bi_length; /* copy of input parms bp_length */
72*0Sstevel@tonic-gate 	size_t			bi_real_length; /* ddi_dma_mem_alloc */
73*0Sstevel@tonic-gate 	ddi_acc_handle_t	bi_handle; /* ddi_dma_mem_alloc */
74*0Sstevel@tonic-gate 	ddi_dma_handle_t	bi_dma_handle; /* ddi_dma_alloc_handle */
75*0Sstevel@tonic-gate } hci1394_buf_info_t;
76*0Sstevel@tonic-gate 
77*0Sstevel@tonic-gate /*
78*0Sstevel@tonic-gate  * private structure to track buffer information
79*0Sstevel@tonic-gate  */
80*0Sstevel@tonic-gate typedef struct hci1394_buf_s {
81*0Sstevel@tonic-gate 	ddi_acc_handle_t	bu_handle;
82*0Sstevel@tonic-gate 	ddi_dma_handle_t	bu_dma_handle;
83*0Sstevel@tonic-gate 	hci1394_drvinfo_t 	*bu_drvinfo;
84*0Sstevel@tonic-gate } hci1394_buf_t;
85*0Sstevel@tonic-gate 
86*0Sstevel@tonic-gate /*
87*0Sstevel@tonic-gate  * handle passed back from alloc() and used for free()
88*0Sstevel@tonic-gate  */
89*0Sstevel@tonic-gate typedef struct hci1394_buf_s	*hci1394_buf_handle_t;
90*0Sstevel@tonic-gate 
91*0Sstevel@tonic-gate 
92*0Sstevel@tonic-gate void hci1394_buf_attr_get(ddi_dma_attr_t *dma_attr);
93*0Sstevel@tonic-gate int hci1394_buf_alloc(hci1394_drvinfo_t *drvinfo, hci1394_buf_parms_t *parms,
94*0Sstevel@tonic-gate     hci1394_buf_info_t *info, hci1394_buf_handle_t *handle);
95*0Sstevel@tonic-gate void hci1394_buf_free(hci1394_buf_handle_t *handle);
96*0Sstevel@tonic-gate 
97*0Sstevel@tonic-gate /* warlock directives */
98*0Sstevel@tonic-gate _NOTE(SCHEME_PROTECTS_DATA("Single user", hci1394_buf_info_s hci1394_buf_s))
99*0Sstevel@tonic-gate 
100*0Sstevel@tonic-gate #ifdef __cplusplus
101*0Sstevel@tonic-gate }
102*0Sstevel@tonic-gate #endif
103*0Sstevel@tonic-gate 
104*0Sstevel@tonic-gate #endif	/* _SYS_1394_ADAPTERS_HCI1394_BUF_H */
105