xref: /aosp_15_r20/external/pigweed/pw_cpu_exception_risc_v/public/pw_cpu_exception_risc_v/proto_dump.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1 // Copyright 2024 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_cpu_exception_risc_v/cpu_state.h"
17 #include "pw_protobuf/encoder.h"
18 #include "pw_status/status.h"
19 
20 namespace pw::cpu_exception::risc_v {
21 
22 // Dumps the cpu state struct as a proto (defined in
23 // pw_cpu_exception_risc_v_protos/cpu_state.proto).
24 //
25 // Returns:
26 //   OK - Entire proto was written to the encoder.
27 //   RESOURCE_EXHAUSTED - Insufficient space to encode proto.
28 //   UNKNOWN - Some other proto encoding error occurred.
29 Status DumpCpuStateProto(protobuf::StreamEncoder& dest,
30                          const pw_cpu_exception_State& cpu_state);
31 
32 }  // namespace pw::cpu_exception::risc_v
33