:orphan:

.. raw:: html

    <!--
    FIXME: do not limit page width until content uses another representation
    format other than tables
    -->
    <style>.wy-nav-content { max-width: none; !important }</style>

.. dtcompatible:: swir,hl78xx-offload
.. _dtbinding_swir_hl78xx_offload:

swir,hl78xx-offload
###################

.. sidebar:: Overview

   :Name: ``swir,hl78xx-offload``
   :Vendor: :ref:`Sierra Wireless <dt_vendor_swir>`
   :Used in: :zephyr:board-catalog:`List of boards <#compatibles=swir,hl78xx-offload>` using
               this compatible

Description
***********



.. code-block:: none

   Binding for a modem child node that indicates the modem supports
   socket offloading. This node is intended to be a child of a modem
   device node (for example, `modem: hl_modem { ... };`).

   The binding is intentionally small and extensible; it documents a
   presence node (compatible = "net,offload-modem-sockets") and a couple
   of optional integer properties that the driver may consume.

Properties
**********

.. tabs::

   .. group-tab:: Node specific properties

      Properties not inherited from the base binding file.

      .. list-table::
         :widths: 1 1 4
         :header-rows: 1

         * - Name
           - Type
           - Details

         * - ``max-data-length``
           - ``int``
           - .. code-block:: none

                "Maximum length of a single data payload (bytes) that
                the modem can send/receive in one offload operation."



             Legal values: ``512``, ``1024``, ``2048``, ``4096``, ``8192``

         * - ``offload-priority``
           - ``int``
           - .. code-block:: none

                "Priority of this offload modem compared to other offload
                modems in the system. Lower values indicate higher priority.
                The system will prefer to use the offload modem with the
                highest priority (lowest value) when multiple offload modems
                are available."





   .. group-tab:: Deprecated node specific properties

      Deprecated properties not inherited from the base binding file.

      (None)

   .. group-tab:: Base properties

      Properties inherited from the base binding file, which defines
      common properties that may be set on many nodes. Not all of these
      may apply to the "swir,hl78xx-offload" compatible.

      (None)