xref: /aosp_15_r20/external/pigweed/pw_bluetooth_hci/packet.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 #include "pw_bluetooth_hci/packet.h"
15*61c4878aSAndroid Build Coastguard Worker 
16*61c4878aSAndroid Build Coastguard Worker #include "pw_bytes/byte_builder.h"
17*61c4878aSAndroid Build Coastguard Worker #include "pw_bytes/endian.h"
18*61c4878aSAndroid Build Coastguard Worker #include "pw_status/try.h"
19*61c4878aSAndroid Build Coastguard Worker 
20*61c4878aSAndroid Build Coastguard Worker namespace pw::bluetooth_hci {
21*61c4878aSAndroid Build Coastguard Worker namespace {
22*61c4878aSAndroid Build Coastguard Worker 
23*61c4878aSAndroid Build Coastguard Worker using pw::bytes::ReadInOrder;
24*61c4878aSAndroid Build Coastguard Worker 
25*61c4878aSAndroid Build Coastguard Worker }  // namespace
26*61c4878aSAndroid Build Coastguard Worker 
Encode(ByteSpan buffer,endian order) const27*61c4878aSAndroid Build Coastguard Worker Result<ConstByteSpan> CommandPacket::Encode(ByteSpan buffer,
28*61c4878aSAndroid Build Coastguard Worker                                             endian order) const {
29*61c4878aSAndroid Build Coastguard Worker   ByteBuilder builder(buffer);
30*61c4878aSAndroid Build Coastguard Worker   builder.PutUint16(opcode_, order);
31*61c4878aSAndroid Build Coastguard Worker   builder.PutUint8(parameters_.size_bytes());
32*61c4878aSAndroid Build Coastguard Worker   builder.append(parameters_);
33*61c4878aSAndroid Build Coastguard Worker   PW_TRY(builder.status());
34*61c4878aSAndroid Build Coastguard Worker   return ConstByteSpan(builder.data(), builder.size());
35*61c4878aSAndroid Build Coastguard Worker }
36*61c4878aSAndroid Build Coastguard Worker 
Decode(ConstByteSpan data,endian order)37*61c4878aSAndroid Build Coastguard Worker std::optional<CommandPacket> CommandPacket::Decode(ConstByteSpan data,
38*61c4878aSAndroid Build Coastguard Worker                                                    endian order) {
39*61c4878aSAndroid Build Coastguard Worker   if (data.size_bytes() < kHeaderSizeBytes) {
40*61c4878aSAndroid Build Coastguard Worker     return std::nullopt;  // Not enough data to parse the packet header.
41*61c4878aSAndroid Build Coastguard Worker   }
42*61c4878aSAndroid Build Coastguard Worker 
43*61c4878aSAndroid Build Coastguard Worker   const uint8_t parameter_total_length =
44*61c4878aSAndroid Build Coastguard Worker       static_cast<uint8_t>(data[kParameterTotalLengthByteOffset]);
45*61c4878aSAndroid Build Coastguard Worker   if (data.size_bytes() < (kHeaderSizeBytes + parameter_total_length)) {
46*61c4878aSAndroid Build Coastguard Worker     return std::nullopt;  // Not enough data to cover the parameter bytes.
47*61c4878aSAndroid Build Coastguard Worker   }
48*61c4878aSAndroid Build Coastguard Worker 
49*61c4878aSAndroid Build Coastguard Worker   const uint16_t opcode =
50*61c4878aSAndroid Build Coastguard Worker       ReadInOrder<uint16_t>(order, &data[kOpcodeByteOffset]);
51*61c4878aSAndroid Build Coastguard Worker   return CommandPacket(opcode,
52*61c4878aSAndroid Build Coastguard Worker                        data.subspan(kHeaderSizeBytes, parameter_total_length));
53*61c4878aSAndroid Build Coastguard Worker }
54*61c4878aSAndroid Build Coastguard Worker 
Encode(ByteSpan buffer,endian order) const55*61c4878aSAndroid Build Coastguard Worker Result<ConstByteSpan> AsyncDataPacket::Encode(ByteSpan buffer,
56*61c4878aSAndroid Build Coastguard Worker                                               endian order) const {
57*61c4878aSAndroid Build Coastguard Worker   ByteBuilder builder(buffer);
58*61c4878aSAndroid Build Coastguard Worker   builder.PutUint16(handle_and_fragmentation_bits_, order);
59*61c4878aSAndroid Build Coastguard Worker   builder.PutUint16(data_.size_bytes(), order);
60*61c4878aSAndroid Build Coastguard Worker   builder.append(data_);
61*61c4878aSAndroid Build Coastguard Worker   PW_TRY(builder.status());
62*61c4878aSAndroid Build Coastguard Worker   return ConstByteSpan(builder.data(), builder.size());
63*61c4878aSAndroid Build Coastguard Worker }
64*61c4878aSAndroid Build Coastguard Worker 
Decode(ConstByteSpan data,endian order)65*61c4878aSAndroid Build Coastguard Worker std::optional<AsyncDataPacket> AsyncDataPacket::Decode(ConstByteSpan data,
66*61c4878aSAndroid Build Coastguard Worker                                                        endian order) {
67*61c4878aSAndroid Build Coastguard Worker   if (data.size_bytes() < kHeaderSizeBytes) {
68*61c4878aSAndroid Build Coastguard Worker     return std::nullopt;  // Not enough data to parse the packet header.
69*61c4878aSAndroid Build Coastguard Worker   }
70*61c4878aSAndroid Build Coastguard Worker 
71*61c4878aSAndroid Build Coastguard Worker   const uint16_t data_total_length =
72*61c4878aSAndroid Build Coastguard Worker       ReadInOrder<uint16_t>(order, &data[kDataTotalLengthByteOffset]);
73*61c4878aSAndroid Build Coastguard Worker   if (data.size_bytes() < (kHeaderSizeBytes + data_total_length)) {
74*61c4878aSAndroid Build Coastguard Worker     return std::nullopt;  // Not enough data to cover the data bytes.
75*61c4878aSAndroid Build Coastguard Worker   }
76*61c4878aSAndroid Build Coastguard Worker 
77*61c4878aSAndroid Build Coastguard Worker   const uint16_t handle_and_flag_bits = ReadInOrder<uint16_t>(
78*61c4878aSAndroid Build Coastguard Worker       order, &data[kHandleAndFragmentationBitsByteOffset]);
79*61c4878aSAndroid Build Coastguard Worker   return AsyncDataPacket(handle_and_flag_bits,
80*61c4878aSAndroid Build Coastguard Worker                          data.subspan(kHeaderSizeBytes, data_total_length));
81*61c4878aSAndroid Build Coastguard Worker }
82*61c4878aSAndroid Build Coastguard Worker 
Encode(ByteSpan buffer,endian order) const83*61c4878aSAndroid Build Coastguard Worker Result<ConstByteSpan> SyncDataPacket::Encode(ByteSpan buffer,
84*61c4878aSAndroid Build Coastguard Worker                                              endian order) const {
85*61c4878aSAndroid Build Coastguard Worker   ByteBuilder builder(buffer);
86*61c4878aSAndroid Build Coastguard Worker   builder.PutUint16(handle_and_status_bits_, order);
87*61c4878aSAndroid Build Coastguard Worker   builder.PutUint8(data_.size_bytes());
88*61c4878aSAndroid Build Coastguard Worker   builder.append(data_);
89*61c4878aSAndroid Build Coastguard Worker   PW_TRY(builder.status());
90*61c4878aSAndroid Build Coastguard Worker   return ConstByteSpan(builder.data(), builder.size());
91*61c4878aSAndroid Build Coastguard Worker }
92*61c4878aSAndroid Build Coastguard Worker 
Decode(ConstByteSpan data,endian order)93*61c4878aSAndroid Build Coastguard Worker std::optional<SyncDataPacket> SyncDataPacket::Decode(ConstByteSpan data,
94*61c4878aSAndroid Build Coastguard Worker                                                      endian order) {
95*61c4878aSAndroid Build Coastguard Worker   if (data.size_bytes() < kHeaderSizeBytes) {
96*61c4878aSAndroid Build Coastguard Worker     return std::nullopt;  // Not enough data to parse the packet header.
97*61c4878aSAndroid Build Coastguard Worker   }
98*61c4878aSAndroid Build Coastguard Worker 
99*61c4878aSAndroid Build Coastguard Worker   const uint8_t data_total_length =
100*61c4878aSAndroid Build Coastguard Worker       static_cast<uint8_t>(data[kDataTotalLengthByteOffset]);
101*61c4878aSAndroid Build Coastguard Worker   if (data.size_bytes() < (kHeaderSizeBytes + data_total_length)) {
102*61c4878aSAndroid Build Coastguard Worker     return std::nullopt;  // Not enough data to cover the data bytes.
103*61c4878aSAndroid Build Coastguard Worker   }
104*61c4878aSAndroid Build Coastguard Worker 
105*61c4878aSAndroid Build Coastguard Worker   const uint16_t handle_and_status_bits =
106*61c4878aSAndroid Build Coastguard Worker       ReadInOrder<uint16_t>(order, &data[kHandleAndStatusBitsByteOffset]);
107*61c4878aSAndroid Build Coastguard Worker   return SyncDataPacket(handle_and_status_bits,
108*61c4878aSAndroid Build Coastguard Worker                         data.subspan(kHeaderSizeBytes, data_total_length));
109*61c4878aSAndroid Build Coastguard Worker }
110*61c4878aSAndroid Build Coastguard Worker 
Encode(ByteSpan buffer) const111*61c4878aSAndroid Build Coastguard Worker Result<ConstByteSpan> EventPacket::Encode(ByteSpan buffer) const {
112*61c4878aSAndroid Build Coastguard Worker   ByteBuilder builder(buffer);
113*61c4878aSAndroid Build Coastguard Worker   builder.PutUint8(event_code_);
114*61c4878aSAndroid Build Coastguard Worker   builder.PutUint8(parameters_.size_bytes());
115*61c4878aSAndroid Build Coastguard Worker   builder.append(parameters_);
116*61c4878aSAndroid Build Coastguard Worker   PW_TRY(builder.status());
117*61c4878aSAndroid Build Coastguard Worker   return ConstByteSpan(builder.data(), builder.size());
118*61c4878aSAndroid Build Coastguard Worker }
119*61c4878aSAndroid Build Coastguard Worker 
Decode(ConstByteSpan data)120*61c4878aSAndroid Build Coastguard Worker std::optional<EventPacket> EventPacket::Decode(ConstByteSpan data) {
121*61c4878aSAndroid Build Coastguard Worker   if (data.size_bytes() < kHeaderSizeBytes) {
122*61c4878aSAndroid Build Coastguard Worker     return std::nullopt;  // Not enough data to parse the packet header.
123*61c4878aSAndroid Build Coastguard Worker   }
124*61c4878aSAndroid Build Coastguard Worker 
125*61c4878aSAndroid Build Coastguard Worker   const uint8_t parameter_total_length =
126*61c4878aSAndroid Build Coastguard Worker       static_cast<uint8_t>(data[kParameterTotalLengthByteOffset]);
127*61c4878aSAndroid Build Coastguard Worker   if (data.size_bytes() < (kHeaderSizeBytes + parameter_total_length)) {
128*61c4878aSAndroid Build Coastguard Worker     return std::nullopt;  // Not enough data to cover the parameter bytes.
129*61c4878aSAndroid Build Coastguard Worker   }
130*61c4878aSAndroid Build Coastguard Worker 
131*61c4878aSAndroid Build Coastguard Worker   const uint8_t event_code = static_cast<uint8_t>(data[kEventCodeByteOffset]);
132*61c4878aSAndroid Build Coastguard Worker   return EventPacket(event_code,
133*61c4878aSAndroid Build Coastguard Worker                      data.subspan(kHeaderSizeBytes, parameter_total_length));
134*61c4878aSAndroid Build Coastguard Worker }
135*61c4878aSAndroid Build Coastguard Worker 
136*61c4878aSAndroid Build Coastguard Worker }  // namespace pw::bluetooth_hci
137