summaryrefslogtreecommitdiffstats
path: root/drivers/gpu/nvgpu/include/nvgpu/comptags.h
blob: 679a0f9ebd0cd9476deab574568ad578d0b6600a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/*
* Copyright (c) 2017, NVIDIA CORPORATION.  All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __NVGPU_COMPTAGS__
#define __NVGPU_COMPTAGS__

#include <nvgpu/lock.h>

struct gk20a;
struct nvgpu_os_buffer;

struct gk20a_comptags {
	u32 offset;
	u32 lines;

	/*
	 * This signals whether allocation has been attempted. Observe 'lines'
	 * to see whether the comptags were actually allocated. We try alloc
	 * only once per buffer in order not to break multiple compressible-kind
	 * mappings.
	 */
	bool allocated;

	/*
	 * Do comptags need to be cleared before mapping?
	 */
	bool needs_clear;
};

struct gk20a_comptag_allocator {
	struct gk20a *g;

	struct nvgpu_mutex lock;

	/* This bitmap starts at ctag 1. 0th cannot be taken. */
	unsigned long *bitmap;

	/* Size of bitmap, not max ctags, so one less. */
	unsigned long size;
};

/* real size here, but first (ctag 0) isn't used */
int gk20a_comptag_allocator_init(struct gk20a *g,
				 struct gk20a_comptag_allocator *allocator,
				 unsigned long size);
void gk20a_comptag_allocator_destroy(struct gk20a *g,
				     struct gk20a_comptag_allocator *allocator);

int gk20a_comptaglines_alloc(struct gk20a_comptag_allocator *allocator,
			     u32 *offset, u32 len);
void gk20a_comptaglines_free(struct gk20a_comptag_allocator *allocator,
			     u32 offset, u32 len);

/*
 * Defined by OS specific code since comptags are stored in a highly OS specific
 * way.
 */
int gk20a_alloc_or_get_comptags(struct gk20a *g,
				struct nvgpu_os_buffer *buf,
				struct gk20a_comptag_allocator *allocator,
				struct gk20a_comptags *comptags);
void gk20a_get_comptags(struct nvgpu_os_buffer *buf,
			struct gk20a_comptags *comptags);

/*
 * These functions must be used to synchronize comptags clear. The usage:
 *
 *   if (gk20a_comptags_start_clear(os_buf)) {
 *           // we now hold the buffer lock for clearing
 *
 *           bool successful = hw_clear_comptags();
 *
 *           // mark the buf cleared (or not) and release the buffer lock
 *           gk20a_comptags_finish_clear(os_buf, successful);
 *   }
 *
 *  If gk20a_start_comptags_clear() returns false, another caller has
 *  already cleared the comptags.
 */
bool gk20a_comptags_start_clear(struct nvgpu_os_buffer *buf);
void gk20a_comptags_finish_clear(struct nvgpu_os_buffer *buf,
				 bool clear_successful);

#endif