flywithu/ntel-gpu-tools
1
0
Fork 0
mirror of https://github.com/tiagovignatti/intel-gpu-tools.git synced 2025-06-27 01:36:17 +00:00
Code Issues Releases Wiki Activity

lib: various documentation fixes

Browse Source 
Fix some documentation comments and mark some struct members private.

Signed-off-by: Thomas Wood <thomas.wood@intel.com>
This commit is contained in:
Thomas Wood 2014-06-09 17:23:21 +01:00
parent 25663d9fe3
commit 52a3a2e205
4 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/igt_aux.c
View File

@ -430,10 +430,9 @@ bool igt_setup_runtime_pm(void)
} }
/** /**
* igt_runtime_pm_status: * igt_get_runtime_pm_status:
* *
* Returns: * Returns: The current runtime PM status.
* The current runtime PM status.
*/ */
enum igt_runtime_pm_status igt_get_runtime_pm_status(void) enum igt_runtime_pm_status igt_get_runtime_pm_status(void)
{ {

10
lib/igt_core.c
View File

@ -1031,11 +1031,11 @@ static void fatal_sig_handler(int sig)
* @fn: exit handler function * @fn: exit handler function
* *
* Set a handler that will be called either when the process calls exit() or * Set a handler that will be called either when the process calls exit() or
* returns from the main function, or one of the signals in 'handled_signals' * <!-- -->returns from the main function, or one of the signals in
* is raised. MAX_EXIT_HANDLERS handlers can be installed, each of which will * 'handled_signals' is raised. MAX_EXIT_HANDLERS handlers can be installed,
* be called only once, even if a subsequent signal is raised. If the exit * each of which will be called only once, even if a subsequent signal is
* handlers are called due to a signal, the signal will be re-raised with the * raised. If the exit handlers are called due to a signal, the signal will be
* original signal disposition after all handlers returned. * re-raised with the original signal disposition after all handlers returned.
* *
* The handler will be passed the signal number if called due to a signal, or * The handler will be passed the signal number if called due to a signal, or
* 0 otherwise. Exit handlers can also be used from test children spawned with * 0 otherwise. Exit handlers can also be used from test children spawned with

2
lib/igt_kms.h
View File

@ -99,6 +99,7 @@ typedef struct igt_pipe igt_pipe_t;
typedef uint32_t igt_fixed_t; /* 16.16 fixed point */ typedef uint32_t igt_fixed_t; /* 16.16 fixed point */
typedef struct { typedef struct {
/*< private >*/
igt_pipe_t *pipe; igt_pipe_t *pipe;
int index; int index;
unsigned int is_primary : 1; unsigned int is_primary : 1;
@ -127,6 +128,7 @@ struct igt_pipe {
}; };
typedef struct { typedef struct {
/*< private >*/
igt_display_t *display; igt_display_t *display;
uint32_t id; /* KMS id */ uint32_t id; /* KMS id */
struct kmstest_connector_config config; struct kmstest_connector_config config;

5
lib/intel_batchbuffer.h
View File

@ -204,14 +204,10 @@ void intel_copy_bo(struct intel_batchbuffer *batch,
* @tiling: tiling mode bits * @tiling: tiling mode bits
* @data: pointer to the memory mapping of the buffer * @data: pointer to the memory mapping of the buffer
* @size: size of the buffer object * @size: size of the buffer object
* @num_tiles: number of tiles of the buffer object
* *
* This is a i-g-t buffer object wrapper structure which augments the baseline * This is a i-g-t buffer object wrapper structure which augments the baseline
* libdrm buffer object with suitable data needed by the render copy and the * libdrm buffer object with suitable data needed by the render copy and the
* media fill functions. * media fill functions.
*
* Note that @num_tiles is only used by gem_stress.c internally and can be
* ignored.
*/ */
struct igt_buf { struct igt_buf {
drm_intel_bo *bo; drm_intel_bo *bo;
@ -219,6 +215,7 @@ struct igt_buf {
uint32_t tiling; uint32_t tiling;
uint32_t *data; uint32_t *data;
uint32_t size; uint32_t size;
/*< private >*/
unsigned num_tiles; unsigned num_tiles;
}; };