xref: /freebsd/sys/contrib/dev/ice/README (revision b64c5a0ace59af62eff52bfe110a521dc73c937b)
1OS Default Dynamic Device Personalization (DDP) Package
2*******************************************************
3
4August 09, 2024
5
6
7Contents
8^^^^^^^^
9
10* OS Default Dynamic Device Personalization (DDP) Package
11
12  * Overview
13
14  * Supported Operating Systems
15
16  * Contents of This Package
17
18  * Related Documentation
19
20  * Notes
21
22  * Installation
23
24  * Troubleshooting
25
26  * Legal / Disclaimers
27
28
29Overview
30========
31
32Devices based on the Intel(R) Ethernet 800 Series require a Dynamic
33Device Personalization (DDP) package file to enable advanced features
34(such as dynamic tunneling, Intel(R) Ethernet Flow Director, RSS, and
35ADQ).
36
37DDP allows you to change the packet processing pipeline of a device by
38applying a profile package to the device at runtime. Profiles can be
39used to, for example, add support for new protocols, change existing
40protocols, or change default settings. DDP profiles can also be rolled
41back without rebooting the system.
42
43The DDP package loads during device initialization or driver runtime,
44depending on the operating system. The driver checks to see if the DDP
45package is present and compatible. If this file exists, the driver
46will load it into the device. If the DDP package file is missing or
47incompatible with the driver, the driver will go into Safe Mode where
48it will use the configuration contained in the device's NVM.
49
50Safe Mode disables advanced and performance features, and supports
51only basic traffic and minimal functionality, such as updating the NVM
52or downloading a new driver or DDP package.
53
54Refer to the Intel(R) Ethernet Adapters and Devices User Guide for
55more details on DDP and Safe Mode.
56
57A general-purpose, default DDP package is automatically installed with
58all supported Intel Ethernet 800 Series drivers on supported operating
59systems. Additional DDP packages are available to address needs for
60specific market segments or targeted solutions.
61
62The default DDP package supports the following:
63
64* MAC
65
66* EtherType
67
68* VLAN
69
70* IPv4
71
72* IPv6
73
74* TCP
75
76* ARP
77
78* UDP
79
80* SCTP
81
82* ICMP
83
84* ICMPv6
85
86* CTRL
87
88* LLDP
89
90* VXLAN-GPE
91
92* VXLAN (non-GPE)
93
94* Geneve
95
96* GRE
97
98* NVGRE
99
100* RoCEv2
101
102* MPLS (up to 5 consecutive MPLS labels in the outermost Layer 2
103  header group)
104
105
106Supported Operating Systems
107===========================
108
109This DDP package is supported on the following operating systems:
110
111* Microsoft* Windows Server*
112
113* Linux*
114
115* FreeBSD*
116
117* VMware* ESXi*
118
119Refer to the Intel(R) Ethernet Adapters and Devices User Guide for
120currently supported versions of these operating systems.
121
122
123Related Documentation
124=====================
125
126See the "Intel(R) Ethernet Adapters and Devices User Guide" for
127additional information on features:
128
129* https://cdrdv2.intel.com/v1/dl/getContent/705831/
130
131Additionally, a detailed technology guide is available for this DDP
132package:
133
134* https://cdrdv2.intel.com/v1/dl/getContent/617015
135
136
137Notes
138=====
139
140* In Linux, FreeBSD, and Windows, you cannot update the DDP package if
141  any PF drivers are already loaded. To overwrite a package, unload
142  all PFs and then reload the driver with the new package.
143
144* In FreeBSD and Windows, you can only use one DDP package per driver,
145  even if you have more than one device installed that uses the
146  driver.
147
148* In Linux, FreeBSD, and Windows, only the first loaded PF per device
149  can download a package for that device. In ESXi, you can load
150  different DDP packages for different PFs associated with a device.
151
152* If you are using DPDK, see the DPDK documentation at
153  https://www.dpdk.org/ for installation instructions and more
154  information.
155
156
157Troubleshooting
158===============
159
160
161FreeBSD
162-------
163
164If you encounter issues with the DDP package file, you may need to
165download an updated driver or ice_ddp module. See the log messages for
166more information.
167
168
169Legal / Disclaimers
170===================
171
172Copyright (c) 2019 - 2024, Intel Corporation.
173
174Intel technologies may require enabled hardware, software or service
175activation.
176
177No product or component can be absolutely secure.
178
179Your costs and results may vary.
180
181Intel, the Intel logo, and other Intel marks are trademarks of Intel
182Corporation or its subsidiaries.  Other names and brands may be
183claimed as the property of others.
184
185Performance varies by use, configuration, and other factors. Learn
186more at https://www.Intel.com/PerformanceIndex.
187
188The products described may contain design defects or errors known as
189errata which may cause the product to deviate from published
190specifications. Current characterized errata are available on request.
191
192This software and the related documents are Intel copyrighted
193materials, and your use of them is governed by the express license
194under which they were provided to you ("License"). Unless the License
195provides otherwise, you may not use, modify, copy, publish,
196distribute, disclose or transmit this software or the related
197documents without Intel's prior written permission.
198
199This software and the related documents are provided as is, with no
200express or implied warranties, other than those that are expressly
201stated in the License.
202