third_party/pigweed/repo/pw_cpu_exception_armv7m/public/pw_cpu_exception_armv7m/proto_dump.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_cpu_exception_armv7m/cpu_state.h"
  17 #include "pw_protobuf/encoder.h"
  18 #include "pw_status/status.h"
  19
  20 namespace pw::cpu_exception {
  21
  22 // Dumps the cpu state struct as a proto (defined in
  23 // pw_cpu_exception_armv7m_protos/cpu_state.proto). The final proto is up to 144
  24 // bytes in size, so ensure your encoder is properly sized.
  25 //
  26 // Returns:
  27 //   OK - Entire proto was written to the encoder.
  28 //   RESOURCE_EXHAUSTED - Insufficient space to encode proto.
  29 //   UNKNOWN - Some other proto encoding error occurred.
  30 Status DumpCpuStateProto(protobuf::Encoder& dest,
  31                          const pw_CpuExceptionState& cpu_state);
  32
  33 }  // namespace pw::cpu_exception