a9ad2a8dfb
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 <vladimir.oltean@nxp.com> Signed-off-by: Vladimir Oltean <vladimir.oltean@nxp.com> Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> Reviewed-by: Vladimir Oltean <vladimir.oltean@nxp.com> Link: https://patch.msgid.link/20241210-packing-pack-fields-and-ice-implementation-v10-4-ee56a47479ac@intel.com Signed-off-by: Jakub Kicinski <kuba@kernel.org> |
||
|---|---|---|
| .. | ||
| irq | ||
| wrappers | ||
| asm-annotations.rst | ||
| assoc_array.rst | ||
| boot-time-mm.rst | ||
| cachetlb.rst | ||
| circular-buffers.rst | ||
| cleanup.rst | ||
| cpu_hotplug.rst | ||
| debug-objects.rst | ||
| debugging-via-ohci1394.rst | ||
| dma-api-howto.rst | ||
| dma-api.rst | ||
| dma-attributes.rst | ||
| dma-isa-lpc.rst | ||
| entry.rst | ||
| errseq.rst | ||
| floating-point.rst | ||
| folio_queue.rst | ||
| genalloc.rst | ||
| generic-radix-tree.rst | ||
| genericirq.rst | ||
| gfp_mask-from-fs-io.rst | ||
| idr.rst | ||
| index.rst | ||
| kernel-api.rst | ||
| kobject.rst | ||
| kref.rst | ||
| librs.rst | ||
| local_ops.rst | ||
| maple_tree.rst | ||
| memory-allocation.rst | ||
| memory-hotplug.rst | ||
| min_heap.rst | ||
| mm-api.rst | ||
| netlink.rst | ||
| packing.rst | ||
| padata.rst | ||
| pin_user_pages.rst | ||
| printk-basics.rst | ||
| printk-formats.rst | ||
| printk-index.rst | ||
| protection-keys.rst | ||
| rbtree.rst | ||
| refcount-vs-atomic.rst | ||
| swiotlb.rst | ||
| symbol-namespaces.rst | ||
| this_cpu_ops.rst | ||
| timekeeping.rst | ||
| tracepoint.rst | ||
| unaligned-memory-access.rst | ||
| union_find.rst | ||
| watch_queue.rst | ||
| workqueue.rst | ||
| xarray.rst | ||