third_party/pigweed/repo/pw_hdlc_lite/public/pw_hdlc_lite/encoder.h

   1 // Copyright 2020 The Pigweed Authors
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
   4 // use this file except in compliance with the License. You may obtain a copy of
   5 // the License at
   6 //
   7 //     https://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  12 // License for the specific language governing permissions and limitations under
  13 // the License.
  14 #pragma once
  15
  16 #include "pw_bytes/span.h"
  17 #include "pw_status/status.h"
  18 #include "pw_stream/stream.h"
  19
  20 namespace pw::hdlc_lite {
  21
  22 // Writes an HDLC information frame (I-frame) to the provided writer. The frame
  23 // contains the following:
  24 //
  25 //   - HDLC flag byte (0x7e)
  26 //   - Address
  27 //   - Control byte (fixed at 0; sequence numbers are not used currently).
  28 //   - Data (0 or more bytes)
  29 //   - Frame check sequence (CRC-32)
  30 //   - HDLC flag byte (0x7e)
  31 //
  32 Status WriteInformationFrame(uint8_t address,
  33                              ConstByteSpan data,
  34                              stream::Writer& writer);
  35
  36 }  // namespace pw::hdlc_lite