intel_mmio.c 10.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*
 * Copyright © 2008 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.
 *
 * Authors:
 *    Eric Anholt <eric@anholt.net>
25
 *    Ben Widawsky <ben@bwidawsk.net>
26 27 28
 *
 */

29
#include <unistd.h>
30
#include <fcntl.h>
31
#include <stdio.h>
32 33 34 35
#include <stdarg.h>
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
36
#include <string.h>
37
#include <errno.h>
38
#include <err.h>
39 40
#include <assert.h>
#include <sys/ioctl.h>
41 42
#include <sys/stat.h>
#include <sys/mman.h>
43

44
#include "intel_io.h"
45
#include "igt_core.h"
46
#include "igt_gt.h"
47
#include "intel_chipset.h"
48

49 50
/**
 * SECTION:intel_io
51
 * @short_description: Register access and sideband I/O library
52
 * @title: I/O
53
 * @include: igt.h
54
 * @section_id: igt-gpu-tools-IO
55 56
 *
 * This library provides register I/O helpers in both a basic version and a more
57
 * fancy version which also handles forcewake and can optionally check registers
58 59 60 61
 * against a white-list. All register function are compatible. Hence the same
 * code can be used to decode registers with either of them, or also from a dump
 * file using intel_mmio_use_dump_file().
 *
62
 * Furthermore this library also provides helper functions for accessing the
63 64 65
 * various sideband interfaces found on Valleyview/Baytrail based platforms.
 */

66 67
#define FAKEKEY 0x2468ace0

68
/**
69
 * igt_global_mmio:
70
 *
71 72
 * Pointer to the register range, initialized using intel_register_access_init()
 * or intel_mmio_use_dump_file(). It is not recommended to use this directly.
73
 */
74
void *igt_global_mmio;
75

76 77 78 79
static struct _mmio_data {
	int inited;
	bool safe;
	uint32_t i915_devid;
80
	struct intel_register_map map;
81 82 83
	int key;
} mmio_data;

84 85 86 87
/**
 * intel_mmio_use_dump_file:
 * @file: name of the register dump file to open
 *
88 89 90
 * Sets up #igt_global_mmio to point at the data contained in @file. This allows
 * the same code to get reused for dumping and decoding from running hardware as
 * from register dumps.
91
 */
92
void
93
intel_mmio_use_dump_file(char *file)
94 95 96 97 98
{
	int fd;
	struct stat st;

	fd = open(file, O_RDWR);
99 100 101
	igt_fail_on_f(fd == -1,
		      "Couldn't open %s\n", file);

102
	fstat(fd, &st);
103 104
	igt_global_mmio = mmap(NULL, st.st_size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
	igt_fail_on_f(igt_global_mmio == MAP_FAILED,
105
		      "Couldn't mmap %s\n", file);
106 107 108
	close(fd);
}

109 110 111 112
/**
 * intel_mmio_use_pci_bar:
 * @pci_dev: intel gracphis pci device
 *
113
 * Sets up #igt_global_mmio to point at the mmio bar.
114 115 116
 *
 * @pci_dev can be obtained from intel_get_pci_device().
 */
117
void
118
intel_mmio_use_pci_bar(struct pci_device *pci_dev)
119
{
120 121
	uint32_t devid, gen;
	int mmio_bar, mmio_size;
122
	int error;
123

124
	devid = pci_dev->device_id;
125
	if (IS_GEN2(devid))
126
		mmio_bar = 1;
127 128
	else
		mmio_bar = 0;
129

130 131
	gen = intel_gen(devid);
	if (gen < 3)
132
		mmio_size = 512*1024;
133 134 135 136 137
	else if (gen < 5)
		mmio_size = 512*1024;
	else
		mmio_size = 2*1024*1024;

138
	error = pci_device_map_range (pci_dev,
139 140 141
				      pci_dev->regions[mmio_bar].base_addr,
				      mmio_size,
				      PCI_DEV_MAP_FLAG_WRITABLE,
142
				      &igt_global_mmio);
143

144 145
	igt_fail_on_f(error != 0,
		      "Couldn't map MMIO region\n");
146
}
147

148 149 150 151 152 153
static void
release_forcewake_lock(int fd)
{
	close(fd);
}

154 155
/**
 * intel_register_access_init:
156
 * @pci_dev: intel graphics pci device
157
 * @safe: use safe register access tables
158 159 160 161 162
 *
 * This initializes the new register access library, which supports forcewake
 * handling and also allows register access to be checked with an explicit
 * whitelist.
 *
163
 * It also initializes #igt_global_mmio like intel_mmio_use_pci_bar().
164 165
 *
 * @pci_dev can be obtained from intel_get_pci_device().
166 167
 */
int
168
intel_register_access_init(struct pci_device *pci_dev, int safe, int fd)
169 170 171 172
{
	int ret;

	/* after old API is deprecated, remove this */
173
	if (igt_global_mmio == NULL)
174
		intel_mmio_use_pci_bar(pci_dev);
175

176
	igt_assert(igt_global_mmio != NULL);
177 178 179 180

	if (mmio_data.inited)
		return -1;

181 182
	mmio_data.safe = (safe != 0 &&
			intel_gen(pci_dev->device_id) >= 4) ? true : false;
183
	mmio_data.i915_devid = pci_dev->device_id;
184
	if (mmio_data.safe)
185 186
		mmio_data.map = intel_get_register_map(mmio_data.i915_devid);

187 188 189
	/* Find where the forcewake lock is. Forcewake doesn't exist
	 * gen < 6, but the debugfs should do the right things for us.
	 */
190
	ret = igt_open_forcewake_handle(fd);
191
	if (ret == -1)
192
		mmio_data.key = FAKEKEY;
193 194
	else
		mmio_data.key = ret;
195

196 197 198
	mmio_data.inited++;
	return 0;
}
199

200 201 202 203 204
static int
intel_register_access_needs_wake(void)
{
	return mmio_data.key != FAKEKEY;
}
205

206 207 208 209 210 211
/**
 * intel_register_access_needs_fakewake:
 *
 * Returns:
 * Non-zero when forcewake initialization failed.
 */
212 213 214 215 216
int intel_register_access_needs_fakewake(void)
{
	return mmio_data.key == FAKEKEY;
}

217 218 219 220 221 222
/**
 * intel_register_access_fini:
 *
 * Clean up the register access helper initialized with
 * intel_register_access_init().
 */
223 224 225
void
intel_register_access_fini(void)
{
226
	if (mmio_data.key && intel_register_access_needs_wake())
227
		release_forcewake_lock(mmio_data.key);
228 229 230
	mmio_data.inited--;
}

231 232 233 234 235 236 237 238 239 240 241 242 243
/**
 * intel_register_read:
 * @reg: register offset
 *
 * 32-bit read of the register at @offset. This function only works when the new
 * register access helper is initialized with intel_register_access_init().
 *
 * Compared to INREG() it can do optional checking with the register access
 * white lists.
 *
 * Returns:
 * The value read from the register.
 */
244 245 246 247 248 249
uint32_t
intel_register_read(uint32_t reg)
{
	struct intel_register_range *range;
	uint32_t ret;

250
	igt_assert(mmio_data.inited);
251

Daniel Vetter's avatar
Daniel Vetter committed
252
	if (intel_gen(mmio_data.i915_devid) >= 6)
253
		igt_assert(mmio_data.key != -1);
254 255 256 257 258 259 260 261 262

	if (!mmio_data.safe)
		goto read_out;

	range = intel_get_register_range(mmio_data.map,
					 reg,
					 INTEL_RANGE_READ);

	if(!range) {
263
		igt_warn("Register read blocked for safety ""(*0x%08x)\n", reg);
264 265 266 267 268
		ret = 0xffffffff;
		goto out;
	}

read_out:
269
	ret = *(volatile uint32_t *)((volatile char *)igt_global_mmio + reg);
270 271
out:
	return ret;
272 273
}

274 275 276 277 278 279 280 281
/**
 * intel_register_write:
 * @reg: register offset
 * @val: value to write
 *
 * 32-bit write to the register at @offset. This function only works when the new
 * register access helper is initialized with intel_register_access_init().
 *
282
 * Compared to OUTREG() it can do optional checking with the register access
283 284
 * white lists.
 */
285 286 287 288 289
void
intel_register_write(uint32_t reg, uint32_t val)
{
	struct intel_register_range *range;

290
	igt_assert(mmio_data.inited);
291

Daniel Vetter's avatar
Daniel Vetter committed
292
	if (intel_gen(mmio_data.i915_devid) >= 6)
293
		igt_assert(mmio_data.key != -1);
294

295 296 297 298 299 300 301
	if (!mmio_data.safe)
		goto write_out;

	range = intel_get_register_range(mmio_data.map,
					 reg,
					 INTEL_RANGE_WRITE);

302 303
	igt_warn_on_f(!range,
		      "Register write blocked for safety ""(*0x%08x = 0x%x)\n", reg, val);
304 305

write_out:
306
	*(volatile uint32_t *)((volatile char *)igt_global_mmio + reg) = val;
307
}
308 309 310 311 312 313


/**
 * INREG:
 * @reg: register offset
 *
314 315
 * 32-bit read of the register at offset @reg. This function only works when the
 * new register access helper is initialized with intel_register_access_init().
316
 *
317
 * This function directly accesses the #igt_global_mmio without safety checks.
318 319 320 321 322 323
 *
 * Returns:
 * The value read from the register.
 */
uint32_t INREG(uint32_t reg)
{
324
	return *(volatile uint32_t *)((volatile char *)igt_global_mmio + reg);
325 326 327
}

/**
328 329 330 331 332 333
 * INREG16:
 * @reg: register offset
 *
 * 16-bit read of the register at offset @reg. This function only works when the
 * new register access helper is initialized with intel_register_access_init().
 *
334
 * This function directly accesses the #igt_global_mmio without safety checks.
335 336 337 338 339 340
 *
 * Returns:
 * The value read from the register.
 */
uint16_t INREG16(uint32_t reg)
{
341
	return *(volatile uint16_t *)((volatile char *)igt_global_mmio + reg);
342 343 344 345 346 347 348 349 350
}

/**
 * INREG8:
 * @reg: register offset
 *
 * 8-bit read of the register at offset @reg. This function only works when the
 * new register access helper is initialized with intel_register_access_init().
 *
351
 * This function directly accesses the #igt_global_mmio without safety checks.
352 353 354 355 356 357
 *
 * Returns:
 * The value read from the register.
 */
uint8_t INREG8(uint32_t reg)
{
358
	return *((volatile uint8_t *)igt_global_mmio + reg);
359 360 361 362
}

/**
 * OUTREG:
363 364 365
 * @reg: register offset
 * @val: value to write
 *
366 367 368
 * 32-bit write of @val to the register at offset @reg. This function only works
 * when the new register access helper is initialized with
 * intel_register_access_init().
369
 *
370
 * This function directly accesses the #igt_global_mmio without safety checks.
371 372 373
 */
void OUTREG(uint32_t reg, uint32_t val)
{
374
	*(volatile uint32_t *)((volatile char *)igt_global_mmio + reg) = val;
375
}
376 377 378 379 380 381 382 383 384 385

/**
 * OUTREG16:
 * @reg: register offset
 * @val: value to write
 *
 * 16-bit write of @val to the register at offset @reg. This function only works
 * when the new register access helper is initialized with
 * intel_register_access_init().
 *
386
 * This function directly accesses the #igt_global_mmio without safety checks.
387 388 389
 */
void OUTREG16(uint32_t reg, uint16_t val)
{
390
	*(volatile uint16_t *)((volatile char *)igt_global_mmio + reg) = val;
391 392 393 394 395 396 397 398 399 400 401
}

/**
 * OUTREG8:
 * @reg: register offset
 * @val: value to write
 *
 * 8-bit write of @val to the register at offset @reg. This function only works
 * when the new register access helper is initialized with
 * intel_register_access_init().
 *
402
 * This function directly accesses the #igt_global_mmio without safety checks.
403 404 405
 */
void OUTREG8(uint32_t reg, uint8_t val)
{
406
	*((volatile uint8_t *)igt_global_mmio + reg) = val;
407
}