summaryrefslogtreecommitdiff
path: root/usr/src/man/man9f/net_ispartialchecksum.9f
blob: 38cb2e4a4f670db9644f1d730d2e1c43e362f62c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
'\" te
.\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved.
.\" 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.
.\" 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.
.\" 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]
.TH NET_ISPARTIALCHECKSUM 9F "May 1, 2008"
.SH NAME
net_ispartialchecksum \- indicate if a packet is being scheduled for hardware
checksum calculation
.SH SYNOPSIS
.LP
.nf
#include <sys/neti.h>

\fBint\fR \fBnet_ispartialchecksum\fR(\fBconst\fR \fBnet_data_t\fR \fInet\fR, \fBmblk_t\fR *\fImb\fR);
.fi

.SH INTERFACE LEVEL
.sp
.LP
Solaris DDI specific (Solaris DDI).
.SH PARAMETERS
.sp
.ne 2
.na
\fB\fInet\fR\fR
.ad
.RS 7n
value returned from a successful call to \fBnet_protocol_lookup\fR(9F).
.RE

.sp
.ne 2
.na
\fB\fImb\fR\fR
.ad
.RS 6n
the \fBmblk\fR structure holding a packet that is the subject of this query.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBnet_ispartialchecksum()\fR function looks at the fields within the
\fBmblk\fR structure to determine if the packet contained inside contains
headers with only partial checksum values. Partial checksum values are stored
inside headers when the calculation of the complete checksum is being handled
by the hardware.
.SH RETURN VALUES
.sp
.LP
The \fBnet_ispartialchecksum()\fR function returns:
.sp
.ne 2
.na
\fB-1\fR
.ad
.RS 6n
The network protocol does not support this function.
.RE

.sp
.ne 2
.na
\fB0\fR
.ad
.RS 6n
The packet does not contain partial checksums.
.RE

.sp
.LP
If a packet is marked for hardware checksum'ing, the following values are
returned:
.sp
.ne 2
.na
\fB\fBNET_HCK_L3_FULL\fR\fR
.ad
.RS 19n
Complete layer 3 checksum calculated
.RE

.sp
.ne 2
.na
\fB\fBNET_HCK_L3_PART\fR\fR
.ad
.RS 19n
Partial layer 3 checksum calculated
.RE

.sp
.ne 2
.na
\fB\fBNET_HCK_L4_FULL\fR\fR
.ad
.RS 19n
Complete layer 4 checksum calculated
.RE

.sp
.ne 2
.na
\fB\fBNET_HCK_L4_PART\fR\fR
.ad
.RS 19n
Partial layer 4 checksum calculated
.RE

.SH CONTEXT
.sp
.LP
The \fBnet_ispartialchecksum()\fR function may be called from user,  kernel, or
interrupt context.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Committed
.TE

.SH SEE ALSO
.sp
.LP
\fBnet_isvalidchecksum\fR(9F), \fBnet_protocol_lookup\fR(9F),
\fBattributes\fR(5)