u-boot/include/iotrace.h
Ramon Fried e0212dfa13 iotrace: fix behaviour when buffer is full
Don't continue updating the offset when buffer is full.
When the buffer size exhausts and there's no space left to write
warn the user and update only the needed size and not both the
offset and needed size.

Add needed buffer size information in the iotrace command.

Signed-off-by: Ramon Fried <ramon.fried@gmail.com>
2018-06-18 14:02:04 -04:00

158 lines
3.9 KiB
C

/* SPDX-License-Identifier: GPL-2.0+ */
/*
* Copyright (c) 2014 Google, Inc.
*/
#ifndef __IOTRACE_H
#define __IOTRACE_H
//#include <common.h>
#include <linux/types.h>
/* Support up to the machine word length for now */
typedef ulong iovalue_t;
enum iotrace_flags {
IOT_8 = 0,
IOT_16,
IOT_32,
IOT_READ = 0 << 3,
IOT_WRITE = 1 << 3,
};
/**
* struct iotrace_record - Holds a single I/O trace record
*
* @flags: I/O access type
* @timestamp: Timestamp of access
* @addr: Address of access
* @value: Value written or read
*/
struct iotrace_record {
enum iotrace_flags flags;
u64 timestamp;
phys_addr_t addr;
iovalue_t value;
};
/*
* This file is designed to be included in arch/<arch>/include/asm/io.h.
* It redirects all IO access through a tracing/checksumming feature for
* testing purposes.
*/
#if defined(CONFIG_IO_TRACE) && !defined(IOTRACE_IMPL) && \
!defined(CONFIG_SPL_BUILD)
#undef readl
#define readl(addr) iotrace_readl((const void *)(addr))
#undef writel
#define writel(val, addr) iotrace_writel(val, (const void *)(addr))
#undef readw
#define readw(addr) iotrace_readw((const void *)(addr))
#undef writew
#define writew(val, addr) iotrace_writew(val, (const void *)(addr))
#undef readb
#define readb(addr) iotrace_readb((const void *)(uintptr_t)addr)
#undef writeb
#define writeb(val, addr) \
iotrace_writeb(val, (const void *)(uintptr_t)addr)
#endif
/* Tracing functions which mirror their io.h counterparts */
u32 iotrace_readl(const void *ptr);
void iotrace_writel(ulong value, const void *ptr);
u16 iotrace_readw(const void *ptr);
void iotrace_writew(ulong value, const void *ptr);
u8 iotrace_readb(const void *ptr);
void iotrace_writeb(ulong value, const void *ptr);
/**
* iotrace_reset_checksum() - Reset the iotrace checksum
*/
void iotrace_reset_checksum(void);
/**
* iotrace_get_checksum() - Get the current checksum value
*
* @return currect checksum value
*/
u32 iotrace_get_checksum(void);
/**
* iotrace_set_region() - Set whether iotrace is limited to a specific
* io region.
*
* Defines the address and size of the limited region.
*
* @start: address of the beginning of the region
* @size: size of the region in bytes.
*/
void iotrace_set_region(ulong start, ulong size);
/**
* iotrace_reset_region() - Reset the region limit
*/
void iotrace_reset_region(void);
/**
* iotrace_get_region() - Get region information
*
* @start: Returns start address of region
* @size: Returns size of region in bytes
*/
void iotrace_get_region(ulong *start, ulong *size);
/**
* iotrace_set_enabled() - Set whether iotracing is enabled or not
*
* This controls whether the checksum is updated and a trace record added
* for each I/O access.
*
* @enable: true to enable iotracing, false to disable
*/
void iotrace_set_enabled(int enable);
/**
* iotrace_get_enabled() - Get whether iotracing is enabled or not
*
* @return true if enabled, false if disabled
*/
int iotrace_get_enabled(void);
/**
* iotrace_set_buffer() - Set position and size of iotrace buffer
*
* Defines where the iotrace buffer goes, and resets the output pointer to
* the start of the buffer.
*
* The buffer can be 0 size in which case the checksum is updated but no
* trace records are writen. If the buffer is exhausted, the offset will
* continue to increase but not new data will be written.
*
* @start: Start address of buffer
* @size: Size of buffer in bytes
*/
void iotrace_set_buffer(ulong start, ulong size);
/**
* iotrace_get_buffer() - Get buffer information
*
* @start: Returns start address of buffer
* @size: Returns actual size of buffer in bytes
* @needed_size: Returns needed size of buffer in bytes
* @offset: Returns the byte offset where the next output trace record will
* @count: Returns the number of trace records recorded
* be written (or would be if the buffer was large enough)
*/
void iotrace_get_buffer(ulong *start, ulong *size, ulong *needed_size, ulong *offset, ulong *count);
#endif /* __IOTRACE_H */