xref: /aosp_15_r20/external/pigweed/pw_hdlc/size.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker.. _module-pw_hdlc-size:
2*61c4878aSAndroid Build Coastguard Worker
3*61c4878aSAndroid Build Coastguard Worker.. rst-class:: with-subtitle
4*61c4878aSAndroid Build Coastguard Worker
5*61c4878aSAndroid Build Coastguard Worker==================
6*61c4878aSAndroid Build Coastguard WorkerCode size analysis
7*61c4878aSAndroid Build Coastguard Worker==================
8*61c4878aSAndroid Build Coastguard Worker.. pigweed-module-subpage::
9*61c4878aSAndroid Build Coastguard Worker   :name: pw_hdlc
10*61c4878aSAndroid Build Coastguard Worker
11*61c4878aSAndroid Build Coastguard Worker``pw_hdlc`` currently optimizes for robustness and flexibility instead of
12*61c4878aSAndroid Build Coastguard Workerbinary size or performance.
13*61c4878aSAndroid Build Coastguard Worker
14*61c4878aSAndroid Build Coastguard WorkerThe ``HDLC encode and decode`` size report shows the cost of everything needed
15*61c4878aSAndroid Build Coastguard Workerto use ``pw_hdlc``, including the dependencies on common modules like CRC32
16*61c4878aSAndroid Build Coastguard Workerfrom :ref:`module-pw_checksum` and variable-length integer handling from
17*61c4878aSAndroid Build Coastguard Worker:ref:`module-pw_varint`.
18*61c4878aSAndroid Build Coastguard Worker
19*61c4878aSAndroid Build Coastguard WorkerThe ``HDLC encode and decode, ignoring CRC and varint`` size report shows the
20*61c4878aSAndroid Build Coastguard Workercost of ``pw_hdlc`` if your application is already linking CRC32 and
21*61c4878aSAndroid Build Coastguard Workervariable-length integer handling. ``pw_varint`` is commonly used since it's
22*61c4878aSAndroid Build Coastguard Workernecessary for protocol buffer handling, so it's often already present.
23*61c4878aSAndroid Build Coastguard Worker
24*61c4878aSAndroid Build Coastguard Worker.. include:: size_report
25*61c4878aSAndroid Build Coastguard Worker
26*61c4878aSAndroid Build Coastguard Worker-----------------
27*61c4878aSAndroid Build Coastguard WorkerMore pw_hdlc docs
28*61c4878aSAndroid Build Coastguard Worker-----------------
29*61c4878aSAndroid Build Coastguard Worker.. include:: docs.rst
30*61c4878aSAndroid Build Coastguard Worker   :start-after: .. pw_hdlc-nav-start
31*61c4878aSAndroid Build Coastguard Worker   :end-before: .. pw_hdlc-nav-end
32