xref: /aosp_15_r20/external/pigweed/pw_hdlc/wire_packet_parser.cc (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker // Copyright 2021 The Pigweed Authors
2*61c4878aSAndroid Build Coastguard Worker //
3*61c4878aSAndroid Build Coastguard Worker // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4*61c4878aSAndroid Build Coastguard Worker // use this file except in compliance with the License. You may obtain a copy of
5*61c4878aSAndroid Build Coastguard Worker // the License at
6*61c4878aSAndroid Build Coastguard Worker //
7*61c4878aSAndroid Build Coastguard Worker //     https://www.apache.org/licenses/LICENSE-2.0
8*61c4878aSAndroid Build Coastguard Worker //
9*61c4878aSAndroid Build Coastguard Worker // Unless required by applicable law or agreed to in writing, software
10*61c4878aSAndroid Build Coastguard Worker // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11*61c4878aSAndroid Build Coastguard Worker // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12*61c4878aSAndroid Build Coastguard Worker // License for the specific language governing permissions and limitations under
13*61c4878aSAndroid Build Coastguard Worker // the License.
14*61c4878aSAndroid Build Coastguard Worker 
15*61c4878aSAndroid Build Coastguard Worker #include "pw_hdlc/wire_packet_parser.h"
16*61c4878aSAndroid Build Coastguard Worker 
17*61c4878aSAndroid Build Coastguard Worker #include "pw_bytes/endian.h"
18*61c4878aSAndroid Build Coastguard Worker #include "pw_checksum/crc32.h"
19*61c4878aSAndroid Build Coastguard Worker #include "pw_hdlc/decoder.h"
20*61c4878aSAndroid Build Coastguard Worker #include "pw_hdlc/internal/protocol.h"
21*61c4878aSAndroid Build Coastguard Worker 
22*61c4878aSAndroid Build Coastguard Worker namespace pw::hdlc {
23*61c4878aSAndroid Build Coastguard Worker 
Parse(ConstByteSpan packet)24*61c4878aSAndroid Build Coastguard Worker bool WirePacketParser::Parse(ConstByteSpan packet) {
25*61c4878aSAndroid Build Coastguard Worker   if (packet.size_bytes() < Frame::kMinContentSizeBytes) {
26*61c4878aSAndroid Build Coastguard Worker     return false;
27*61c4878aSAndroid Build Coastguard Worker   }
28*61c4878aSAndroid Build Coastguard Worker 
29*61c4878aSAndroid Build Coastguard Worker   if (packet.front() != kFlag || packet.back() != kFlag) {
30*61c4878aSAndroid Build Coastguard Worker     return false;
31*61c4878aSAndroid Build Coastguard Worker   }
32*61c4878aSAndroid Build Coastguard Worker 
33*61c4878aSAndroid Build Coastguard Worker   // Partially decode into a buffer with space only for the address and control
34*61c4878aSAndroid Build Coastguard Worker   // fields of the frame. The decoder will verify the frame's FCS field.
35*61c4878aSAndroid Build Coastguard Worker   std::array<std::byte, 16> buffer = {};
36*61c4878aSAndroid Build Coastguard Worker   Decoder decoder(buffer);
37*61c4878aSAndroid Build Coastguard Worker   Status status = Status::Unknown();
38*61c4878aSAndroid Build Coastguard Worker 
39*61c4878aSAndroid Build Coastguard Worker   decoder.Process(packet, [&status](const Result<Frame>& result) {
40*61c4878aSAndroid Build Coastguard Worker     status = result.status();
41*61c4878aSAndroid Build Coastguard Worker   });
42*61c4878aSAndroid Build Coastguard Worker 
43*61c4878aSAndroid Build Coastguard Worker   Result<Frame> result = Frame::Parse(buffer);
44*61c4878aSAndroid Build Coastguard Worker   if (!result.ok()) {
45*61c4878aSAndroid Build Coastguard Worker     return false;
46*61c4878aSAndroid Build Coastguard Worker   }
47*61c4878aSAndroid Build Coastguard Worker 
48*61c4878aSAndroid Build Coastguard Worker   address_ = result.value().address();
49*61c4878aSAndroid Build Coastguard Worker 
50*61c4878aSAndroid Build Coastguard Worker   // RESOURCE_EXHAUSTED is expected as the buffer is too small for the packet.
51*61c4878aSAndroid Build Coastguard Worker   return status.ok() || status.IsResourceExhausted();
52*61c4878aSAndroid Build Coastguard Worker }
53*61c4878aSAndroid Build Coastguard Worker 
54*61c4878aSAndroid Build Coastguard Worker }  // namespace pw::hdlc
55