diff options
| author | Jacob Keller <[email protected]> | 2024-12-10 20:27:13 +0000 |
|---|---|---|
| committer | Jakub Kicinski <[email protected]> | 2024-12-12 04:13:00 +0000 |
| commit | a9ad2a8dfb436c55607c8038aa926f55a6d6ca8e (patch) | |
| tree | e4277d9ac47b81a739e9c6137609ad1d799e324e /drivers/net/ethernet/intel/ice/ice_common.h | |
| parent | lib: packing: add pack_fields() and unpack_fields() (diff) | |
| download | kernel-a9ad2a8dfb436c55607c8038aa926f55a6d6ca8e.tar.gz kernel-a9ad2a8dfb436c55607c8038aa926f55a6d6ca8e.zip | |
lib: packing: document recently added APIs
Extend the documentation for the packing library, covering the intended use
for the recently added APIs. This includes the pack() and unpack() macros,
as well as the pack_fields() and unpack_fields() macros.
Add a note that the packing() API is now deprecated in favor of pack() and
unpack().
For the pack_fields() and unpack_fields() APIs, explain the rationale for
when a driver may want to select this API. Provide an example which shows
how to define the fields and call the pack_fields() and unpack_fields()
macros.
Co-developed-by: Vladimir Oltean <[email protected]>
Signed-off-by: Vladimir Oltean <[email protected]>
Signed-off-by: Jacob Keller <[email protected]>
Reviewed-by: Vladimir Oltean <[email protected]>
Link: https://patch.msgid.link/20241210-packing-pack-fields-and-ice-implementation-v10-4-ee56a47479ac@intel.com
Signed-off-by: Jakub Kicinski <[email protected]>
Diffstat (limited to 'drivers/net/ethernet/intel/ice/ice_common.h')
0 files changed, 0 insertions, 0 deletions