blob: 8590c450d29f68e9498988f44b85ef0f44db2762 [file] [log] [blame]
// Copyright 2020 The Pigweed Authors
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#pragma once
#include "pw_cpu_exception_cortex_m/cpu_state.h"
#include "pw_protobuf/encoder.h"
#include "pw_status/status.h"
namespace pw::cpu_exception {
// Dumps the cpu state struct as a proto (defined in
// pw_cpu_exception_cortex_m_protos/cpu_state.proto). The final proto is up to
// 144 bytes in size, so ensure your encoder is properly sized.
// Returns:
// OK - Entire proto was written to the encoder.
// RESOURCE_EXHAUSTED - Insufficient space to encode proto.
// UNKNOWN - Some other proto encoding error occurred.
Status DumpCpuStateProto(protobuf::StreamEncoder& dest,
const pw_cpu_exception_State& cpu_state);
} // namespace pw::cpu_exception