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 //============================================================================== 15 // 16 // This files provides support to dump the trace buffer to the logging module. 17 #pragma once 18 19 #include "pw_status/status.h" 20 21 namespace pw { 22 namespace trace { 23 24 // Dumps the trace buffer to the log. The output format to the log is the 25 // base64-encoded buffer, split into lines of an implementation-defined length. 26 // The trace logs are surrounded by 'begin' and 'end' tags. 27 // 28 // Ex. Invoking PW_TRACE_INSTANT with 'test1' and 'test2', then calling this 29 // function would produce this in the output logs: 30 // 31 // [TRACE] begin 32 // [TRACE] data: BWdDMRoABWj52YMB 33 // [TRACE] end 34 pw::Status DumpTraceBufferToLog(); 35 36 } // namespace trace 37 } // namespace pw 38