third_party/pigweed/repo/pw_hdlc_lite/public/pw_hdlc_lite/rpc_packets.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 <cstdint>
  17
  18 #include "pw_hdlc_lite/decoder.h"
  19 #include "pw_rpc/channel.h"
  20 #include "pw_rpc/server.h"
  21 #include "pw_status/status.h"
  22
  23 namespace pw::hdlc_lite {
  24
  25 inline constexpr uint8_t kDefaultRpcAddress = 'R';
  26
  27 // Reads HDLC frames with sys_io::ReadByte, using decode_buffer to store frames.
  28 // HDLC frames sent to rpc_address are passed to the RPC server.
  29 Status ReadAndProcessPackets(rpc::Server& server,
  30                              rpc::ChannelOutput& output,
  31                              std::span<std::byte> decode_buffer,
  32                              unsigned rpc_address = kDefaultRpcAddress);
  33
  34 }  // namespace pw::hdlc_lite