ntel-gpu-tools/lib/igt_debugfs.h
Paulo Zanoni 995f2738ad lib: add igt_debugfs_read()
A helpful function for when you want to read a whole debugfs file to a
string and don't want to worry about opening and closing file
descriptors and asserting buffer sizes.

We've been using this already for kms_frontbuffer_tracking and
kms_fbcon_fbt, so the only test with new code here is kms_fbc_crc.

Also notice that for kms_fbc_crc we had to increase the buffer size
since the file can sometimes be bigger than 64 bytes - depending on
the reason why FBC is disabled.

Of course, there are probably many other programs we can patch, but
I'm not doing this now.

v2: Add the macro to wrap sizeof() (Daniel).
v3: Add documentation for the macro too (Daniel).

Signed-off-by: Paulo Zanoni <paulo.r.zanoni@intel.com>
2015-08-05 17:30:58 -03:00

157 lines
4.4 KiB
C

/*
* Copyright © 2013 Intel Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*
*/
#ifndef __IGT_DEBUGFS_H__
#define __IGT_DEBUGFS_H__
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
enum pipe;
int igt_debugfs_open(const char *filename, int mode);
FILE *igt_debugfs_fopen(const char *filename,
const char *mode);
void __igt_debugfs_read(const char *filename, char *buf, int buf_size);
/**
* igt_debugfs_read:
* @filename: name of the debugfs file
* @buf: buffer where the contents will be stored, allocated by the caller.
*
* This is just a convenience wrapper for __igt_debugfs_read. See its
* documentation.
*/
#define igt_debugfs_read(filename, buf) \
__igt_debugfs_read((filename), (buf), sizeof(buf))
/*
* Pipe CRC
*/
/**
* igt_pipe_crc_t:
*
* Pipe CRC support structure. Needs to be allocated and set up with
* igt_pipe_crc_new() for a specific pipe and pipe CRC source value.
*/
typedef struct _igt_pipe_crc igt_pipe_crc_t;
/**
* igt_crc_t:
* @frame: frame number of the capture CRC
* @n_words: internal field, don't access
* @crc: internal field, don't access
*
* Pipe CRC value. All other members than @frame are private and should not be
* inspected by testcases.
*/
typedef struct {
uint32_t frame;
int n_words;
uint32_t crc[5];
} igt_crc_t;
/**
* intel_pipe_crc_source:
*
* Enumeration of all supported pipe CRC sources. Not all platforms and all
* outputs support all of them. Generic tests should just use
* INTEL_PIPE_CRC_SOURCE_AUTO. It should always map to an end-of-pipe CRC
* suitable for checking planes, cursor, color correction and any other
* output-agnostic features.
*/
enum intel_pipe_crc_source {
INTEL_PIPE_CRC_SOURCE_NONE,
INTEL_PIPE_CRC_SOURCE_PLANE1,
INTEL_PIPE_CRC_SOURCE_PLANE2,
INTEL_PIPE_CRC_SOURCE_PF,
INTEL_PIPE_CRC_SOURCE_PIPE,
INTEL_PIPE_CRC_SOURCE_TV,
INTEL_PIPE_CRC_SOURCE_DP_B,
INTEL_PIPE_CRC_SOURCE_DP_C,
INTEL_PIPE_CRC_SOURCE_DP_D,
INTEL_PIPE_CRC_SOURCE_AUTO,
INTEL_PIPE_CRC_SOURCE_MAX,
};
void igt_assert_crc_equal(igt_crc_t *a, igt_crc_t *b);
char *igt_crc_to_string(igt_crc_t *crc);
void igt_require_pipe_crc(void);
igt_pipe_crc_t *
igt_pipe_crc_new(enum pipe pipe, enum intel_pipe_crc_source source);
void igt_pipe_crc_free(igt_pipe_crc_t *pipe_crc);
void igt_pipe_crc_start(igt_pipe_crc_t *pipe_crc);
void igt_pipe_crc_stop(igt_pipe_crc_t *pipe_crc);
void igt_pipe_crc_get_crcs(igt_pipe_crc_t *pipe_crc, int n_crcs,
igt_crc_t **out_crcs);
void igt_pipe_crc_collect_crc(igt_pipe_crc_t *pipe_crc, igt_crc_t *out_crc);
/*
* Drop caches
*/
/**
* DROP_UNBOUND:
*
* Drop all currently unbound gem buffer objects from the cache.
*/
#define DROP_UNBOUND 0x1
/**
* DROP_BOUND:
*
* Drop all inactive objects which are bound into some gpu address space.
*/
#define DROP_BOUND 0x2
/**
* DROP_RETIRE:
*
* Wait for all outstanding gpu commands to complete, but do not take any
* further actions.
*/
#define DROP_RETIRE 0x4
/**
* DROP_ACTIVE:
*
* Also drop active objects once retired.
*/
#define DROP_ACTIVE 0x8
#define DROP_ALL (DROP_UNBOUND | \
DROP_BOUND | \
DROP_RETIRE | \
DROP_ACTIVE)
void igt_drop_caches_set(uint64_t val);
/*
* Prefault control
*/
void igt_disable_prefault(void);
void igt_enable_prefault(void);
#endif /* __IGT_DEBUGFS_H__ */