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 file provides an optional trace buffer which can be used with the 17 #pragma once 18 19 #include "pw_bytes/span.h" 20 #include "pw_ring_buffer/prefixed_entry_ring_buffer.h" 21 #include "pw_trace_tokenized/config.h" 22 #include "pw_trace_tokenized/trace_tokenized.h" 23 #include "pw_varint/varint.h" 24 25 namespace pw { 26 namespace trace { 27 28 // pw_TraceClearBuffer resets the trace buffer, and all data currently stored 29 // in the buffer is lost. 30 void ClearBuffer(); 31 32 // Get the ring buffer which contains the data. 33 pw::ring_buffer::PrefixedEntryRingBuffer* GetBuffer(); 34 35 // View underlying buffer trace_tokenized provided ring_buffer at time of 36 // construction. This allows for bulk access to the trace events buffer. Since 37 // this also derings the underlying ring_buffer, ensure that tracing is disabled 38 // when calling this function. 39 ConstByteSpan DeringAndViewRawBuffer(); 40 41 } // namespace trace 42 } // namespace pw 43