xref: /onnv-gate/usr/src/uts/common/sys/pattr.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 2004 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _SYS_PATTR_H
28*0Sstevel@tonic-gate #define	_SYS_PATTR_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef	__cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate /*
37*0Sstevel@tonic-gate  * Attribute types and structures.
38*0Sstevel@tonic-gate  */
39*0Sstevel@tonic-gate #define	PATTR_DSTADDRSAP	0x1	/* destination physical address+SAP */
40*0Sstevel@tonic-gate #define	PATTR_SRCADDRSAP	0x2	/* source physical address+SAP */
41*0Sstevel@tonic-gate #define	PATTR_HCKSUM		0x3	/* hardware checksum attribute */
42*0Sstevel@tonic-gate #define	PATTR_ZCOPY		0x4	/* zerocopy attribute */
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate /*
45*0Sstevel@tonic-gate  * Structure shared by {source,destination} physical address+SAP attributes.
46*0Sstevel@tonic-gate  */
47*0Sstevel@tonic-gate typedef struct pattr_addr_s {
48*0Sstevel@tonic-gate 	uint8_t	addr_is_group;	/* address is broadcast or multicast */
49*0Sstevel@tonic-gate 	uint8_t	addr_len;	/* length of address */
50*0Sstevel@tonic-gate 	uint8_t	addr[1];	/* address */
51*0Sstevel@tonic-gate } pattr_addr_t;
52*0Sstevel@tonic-gate 
53*0Sstevel@tonic-gate /*
54*0Sstevel@tonic-gate  * Structure used for Hardware Checksum attribute.
55*0Sstevel@tonic-gate  */
56*0Sstevel@tonic-gate 
57*0Sstevel@tonic-gate typedef struct pattr_hcksum_s {
58*0Sstevel@tonic-gate 	uint32_t	hcksum_start_offset;
59*0Sstevel@tonic-gate 	uint32_t	hcksum_stuff_offset;
60*0Sstevel@tonic-gate 	uint32_t	hcksum_end_offset;
61*0Sstevel@tonic-gate 	union {
62*0Sstevel@tonic-gate 		uint64_t value;
63*0Sstevel@tonic-gate 		uint16_t inet_cksum; /* to store H/W computed cksum value */
64*0Sstevel@tonic-gate 	} hcksum_cksum_val;
65*0Sstevel@tonic-gate 	uint32_t	hcksum_flags;
66*0Sstevel@tonic-gate } pattr_hcksum_t;
67*0Sstevel@tonic-gate 
68*0Sstevel@tonic-gate /*
69*0Sstevel@tonic-gate  * Values for hcksum_flags
70*0Sstevel@tonic-gate  */
71*0Sstevel@tonic-gate #define	HCK_IPV4_HDRCKSUM	0x01	/* On Transmit: Compute IP header */
72*0Sstevel@tonic-gate 					/* checksum in hardware. */
73*0Sstevel@tonic-gate 					/* On Receive: IP header checksum */
74*0Sstevel@tonic-gate 					/* was verified by h/w and is */
75*0Sstevel@tonic-gate 					/* correct. */
76*0Sstevel@tonic-gate #define	HCK_PARTIALCKSUM	0x02	/* On Transmit: Compute partial 1's */
77*0Sstevel@tonic-gate 					/* complement checksum based on */
78*0Sstevel@tonic-gate 					/* start, stuff and end offsets. */
79*0Sstevel@tonic-gate 					/* On Receive : Partial checksum */
80*0Sstevel@tonic-gate 					/* computed and attached. */
81*0Sstevel@tonic-gate #define	HCK_FULLCKSUM		0x04	/* On Transmit: Compute full(in case */
82*0Sstevel@tonic-gate 					/* of TCP/UDP, full is pseudo-header */
83*0Sstevel@tonic-gate 					/* + header + payload) checksum for */
84*0Sstevel@tonic-gate 					/* this packet. */
85*0Sstevel@tonic-gate 					/* On Receive : Full checksum  */
86*0Sstevel@tonic-gate 					/* computed in h/w and is attached */
87*0Sstevel@tonic-gate #define	HCK_FULLCKSUM_OK	0x08	/* On Transmit: N/A */
88*0Sstevel@tonic-gate 					/* On Receive: Full checksum status */
89*0Sstevel@tonic-gate 					/* If set, implies full checksum */
90*0Sstevel@tonic-gate 					/* computation was successful */
91*0Sstevel@tonic-gate 					/* i.e. checksum was correct. */
92*0Sstevel@tonic-gate 					/* If it is not set, IP will also */
93*0Sstevel@tonic-gate 					/* check the attached h/w computed */
94*0Sstevel@tonic-gate 					/* checksum value to determine if */
95*0Sstevel@tonic-gate 					/* checksum was bad */
96*0Sstevel@tonic-gate 
97*0Sstevel@tonic-gate /*
98*0Sstevel@tonic-gate  * Structure used for zerocopy attribute.
99*0Sstevel@tonic-gate  */
100*0Sstevel@tonic-gate typedef struct pattr_zcopy_s {
101*0Sstevel@tonic-gate 	uint_t zcopy_flags;
102*0Sstevel@tonic-gate } pattr_zcopy_t;
103*0Sstevel@tonic-gate 
104*0Sstevel@tonic-gate #ifdef	__cplusplus
105*0Sstevel@tonic-gate }
106*0Sstevel@tonic-gate #endif
107*0Sstevel@tonic-gate 
108*0Sstevel@tonic-gate #endif	/* _SYS_PATTR_H */
109