regmap.c 25.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
/*
 * Register map access API
 *
 * Copyright 2011 Wolfson Microelectronics plc
 *
 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

13
#include <linux/device.h>
14
#include <linux/slab.h>
15
#include <linux/export.h>
16 17 18
#include <linux/mutex.h>
#include <linux/err.h>

M
Mark Brown 已提交
19 20 21
#define CREATE_TRACE_POINTS
#include <trace/events/regmap.h>

22
#include "internal.h"
23

24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
bool regmap_writeable(struct regmap *map, unsigned int reg)
{
	if (map->max_register && reg > map->max_register)
		return false;

	if (map->writeable_reg)
		return map->writeable_reg(map->dev, reg);

	return true;
}

bool regmap_readable(struct regmap *map, unsigned int reg)
{
	if (map->max_register && reg > map->max_register)
		return false;

40 41 42
	if (map->format.format_write)
		return false;

43 44 45 46 47 48 49 50
	if (map->readable_reg)
		return map->readable_reg(map->dev, reg);

	return true;
}

bool regmap_volatile(struct regmap *map, unsigned int reg)
{
51
	if (!regmap_readable(map, reg))
52 53 54 55 56 57 58 59 60 61
		return false;

	if (map->volatile_reg)
		return map->volatile_reg(map->dev, reg);

	return true;
}

bool regmap_precious(struct regmap *map, unsigned int reg)
{
62
	if (!regmap_readable(map, reg))
63 64 65 66 67 68 69 70
		return false;

	if (map->precious_reg)
		return map->precious_reg(map->dev, reg);

	return false;
}

71 72 73 74 75 76 77 78 79 80 81 82
static bool regmap_volatile_range(struct regmap *map, unsigned int reg,
	unsigned int num)
{
	unsigned int i;

	for (i = 0; i < num; i++)
		if (!regmap_volatile(map, reg + i))
			return false;

	return true;
}

83 84 85 86 87 88 89 90
static void regmap_format_2_6_write(struct regmap *map,
				     unsigned int reg, unsigned int val)
{
	u8 *out = map->work_buf;

	*out = (reg << 6) | val;
}

91 92 93 94 95 96 97 98 99 100 101 102 103 104
static void regmap_format_4_12_write(struct regmap *map,
				     unsigned int reg, unsigned int val)
{
	__be16 *out = map->work_buf;
	*out = cpu_to_be16((reg << 12) | val);
}

static void regmap_format_7_9_write(struct regmap *map,
				    unsigned int reg, unsigned int val)
{
	__be16 *out = map->work_buf;
	*out = cpu_to_be16((reg << 9) | val);
}

105 106 107 108 109 110 111 112 113 114
static void regmap_format_10_14_write(struct regmap *map,
				    unsigned int reg, unsigned int val)
{
	u8 *out = map->work_buf;

	out[2] = val;
	out[1] = (val >> 8) | (reg << 6);
	out[0] = reg >> 2;
}

115
static void regmap_format_8(void *buf, unsigned int val, unsigned int shift)
116 117 118
{
	u8 *b = buf;

119
	b[0] = val << shift;
120 121
}

122
static void regmap_format_16(void *buf, unsigned int val, unsigned int shift)
123 124 125
{
	__be16 *b = buf;

126
	b[0] = cpu_to_be16(val << shift);
127 128
}

129
static void regmap_format_24(void *buf, unsigned int val, unsigned int shift)
130 131 132
{
	u8 *b = buf;

133 134
	val <<= shift;

135 136 137 138 139
	b[0] = val >> 16;
	b[1] = val >> 8;
	b[2] = val;
}

140
static void regmap_format_32(void *buf, unsigned int val, unsigned int shift)
141 142 143
{
	__be32 *b = buf;

144
	b[0] = cpu_to_be32(val << shift);
145 146
}

147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
static unsigned int regmap_parse_8(void *buf)
{
	u8 *b = buf;

	return b[0];
}

static unsigned int regmap_parse_16(void *buf)
{
	__be16 *b = buf;

	b[0] = be16_to_cpu(b[0]);

	return b[0];
}

163 164 165 166 167 168 169 170 171 172
static unsigned int regmap_parse_24(void *buf)
{
	u8 *b = buf;
	unsigned int ret = b[2];
	ret |= ((unsigned int)b[1]) << 8;
	ret |= ((unsigned int)b[0]) << 16;

	return ret;
}

173 174 175 176 177 178 179 180 181
static unsigned int regmap_parse_32(void *buf)
{
	__be32 *b = buf;

	b[0] = be32_to_cpu(b[0]);

	return b[0];
}

182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
static void regmap_lock_mutex(struct regmap *map)
{
	mutex_lock(&map->mutex);
}

static void regmap_unlock_mutex(struct regmap *map)
{
	mutex_unlock(&map->mutex);
}

static void regmap_lock_spinlock(struct regmap *map)
{
	spin_lock(&map->spinlock);
}

static void regmap_unlock_spinlock(struct regmap *map)
{
	spin_unlock(&map->spinlock);
}

M
Mark Brown 已提交
202 203 204 205 206 207 208 209 210
static void dev_get_regmap_release(struct device *dev, void *res)
{
	/*
	 * We don't actually have anything to do here; the goal here
	 * is not to manage the regmap but to provide a simple way to
	 * get the regmap back given a struct device.
	 */
}

211 212 213 214 215
/**
 * regmap_init(): Initialise register map
 *
 * @dev: Device that will be interacted with
 * @bus: Bus-specific callbacks to use with device
216
 * @bus_context: Data passed to bus-specific callbacks
217 218 219 220 221 222 223 224
 * @config: Configuration for register map
 *
 * The return value will be an ERR_PTR() on error or a valid pointer to
 * a struct regmap.  This function should generally not be called
 * directly, it should be called by bus-specific init functions.
 */
struct regmap *regmap_init(struct device *dev,
			   const struct regmap_bus *bus,
225
			   void *bus_context,
226 227
			   const struct regmap_config *config)
{
M
Mark Brown 已提交
228
	struct regmap *map, **m;
229 230 231
	int ret = -EINVAL;

	if (!bus || !config)
232
		goto err;
233 234 235 236 237 238 239

	map = kzalloc(sizeof(*map), GFP_KERNEL);
	if (map == NULL) {
		ret = -ENOMEM;
		goto err;
	}

240 241 242 243 244 245 246 247 248
	if (bus->fast_io) {
		spin_lock_init(&map->spinlock);
		map->lock = regmap_lock_spinlock;
		map->unlock = regmap_unlock_spinlock;
	} else {
		mutex_init(&map->mutex);
		map->lock = regmap_lock_mutex;
		map->unlock = regmap_unlock_mutex;
	}
249
	map->format.buf_size = (config->reg_bits + config->val_bits) / 8;
250
	map->format.reg_bytes = DIV_ROUND_UP(config->reg_bits, 8);
251
	map->format.pad_bytes = config->pad_bits / 8;
252
	map->format.val_bytes = DIV_ROUND_UP(config->val_bits, 8);
253
	map->format.buf_size += map->format.pad_bytes;
254
	map->reg_shift = config->pad_bits % 8;
255 256 257 258
	if (config->reg_stride)
		map->reg_stride = config->reg_stride;
	else
		map->reg_stride = 1;
259
	map->use_single_rw = config->use_single_rw;
260 261
	map->dev = dev;
	map->bus = bus;
262
	map->bus_context = bus_context;
263 264 265 266
	map->max_register = config->max_register;
	map->writeable_reg = config->writeable_reg;
	map->readable_reg = config->readable_reg;
	map->volatile_reg = config->volatile_reg;
267
	map->precious_reg = config->precious_reg;
268
	map->cache_type = config->cache_type;
M
Mark Brown 已提交
269
	map->name = config->name;
270

271 272 273 274 275 276 277
	if (config->read_flag_mask || config->write_flag_mask) {
		map->read_flag_mask = config->read_flag_mask;
		map->write_flag_mask = config->write_flag_mask;
	} else {
		map->read_flag_mask = bus->read_flag_mask;
	}

278
	switch (config->reg_bits + map->reg_shift) {
279 280 281 282 283 284 285 286 287 288
	case 2:
		switch (config->val_bits) {
		case 6:
			map->format.format_write = regmap_format_2_6_write;
			break;
		default:
			goto err_map;
		}
		break;

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
	case 4:
		switch (config->val_bits) {
		case 12:
			map->format.format_write = regmap_format_4_12_write;
			break;
		default:
			goto err_map;
		}
		break;

	case 7:
		switch (config->val_bits) {
		case 9:
			map->format.format_write = regmap_format_7_9_write;
			break;
		default:
			goto err_map;
		}
		break;

309 310 311 312 313 314 315 316 317 318
	case 10:
		switch (config->val_bits) {
		case 14:
			map->format.format_write = regmap_format_10_14_write;
			break;
		default:
			goto err_map;
		}
		break;

319 320 321 322 323 324 325 326
	case 8:
		map->format.format_reg = regmap_format_8;
		break;

	case 16:
		map->format.format_reg = regmap_format_16;
		break;

327 328 329 330
	case 32:
		map->format.format_reg = regmap_format_32;
		break;

331 332 333 334 335 336 337 338 339 340 341 342 343
	default:
		goto err_map;
	}

	switch (config->val_bits) {
	case 8:
		map->format.format_val = regmap_format_8;
		map->format.parse_val = regmap_parse_8;
		break;
	case 16:
		map->format.format_val = regmap_format_16;
		map->format.parse_val = regmap_parse_16;
		break;
344 345 346 347
	case 24:
		map->format.format_val = regmap_format_24;
		map->format.parse_val = regmap_parse_24;
		break;
348 349 350 351
	case 32:
		map->format.format_val = regmap_format_32;
		map->format.parse_val = regmap_parse_32;
		break;
352 353
	}

354 355 356
	if (map->format.format_write)
		map->use_single_rw = true;

357 358 359 360
	if (!map->format.format_write &&
	    !(map->format.format_reg && map->format.format_val))
		goto err_map;

361
	map->work_buf = kzalloc(map->format.buf_size, GFP_KERNEL);
362 363
	if (map->work_buf == NULL) {
		ret = -ENOMEM;
364
		goto err_map;
365 366
	}

367
	regmap_debugfs_init(map, config->name);
368

369
	ret = regcache_init(map, config);
370
	if (ret < 0)
371
		goto err_debugfs;
372

M
Mark Brown 已提交
373 374 375 376 377 378 379 380 381
	/* Add a devres resource for dev_get_regmap() */
	m = devres_alloc(dev_get_regmap_release, sizeof(*m), GFP_KERNEL);
	if (!m) {
		ret = -ENOMEM;
		goto err_cache;
	}
	*m = map;
	devres_add(dev, m);

382 383
	return map;

M
Mark Brown 已提交
384 385
err_cache:
	regcache_exit(map);
386 387
err_debugfs:
	regmap_debugfs_exit(map);
388
	kfree(map->work_buf);
389 390 391 392 393 394 395
err_map:
	kfree(map);
err:
	return ERR_PTR(ret);
}
EXPORT_SYMBOL_GPL(regmap_init);

396 397 398 399 400 401 402 403 404 405
static void devm_regmap_release(struct device *dev, void *res)
{
	regmap_exit(*(struct regmap **)res);
}

/**
 * devm_regmap_init(): Initialise managed register map
 *
 * @dev: Device that will be interacted with
 * @bus: Bus-specific callbacks to use with device
406
 * @bus_context: Data passed to bus-specific callbacks
407 408 409 410 411 412 413 414 415
 * @config: Configuration for register map
 *
 * The return value will be an ERR_PTR() on error or a valid pointer
 * to a struct regmap.  This function should generally not be called
 * directly, it should be called by bus-specific init functions.  The
 * map will be automatically freed by the device management code.
 */
struct regmap *devm_regmap_init(struct device *dev,
				const struct regmap_bus *bus,
416
				void *bus_context,
417 418 419 420 421 422 423 424
				const struct regmap_config *config)
{
	struct regmap **ptr, *regmap;

	ptr = devres_alloc(devm_regmap_release, sizeof(*ptr), GFP_KERNEL);
	if (!ptr)
		return ERR_PTR(-ENOMEM);

425
	regmap = regmap_init(dev, bus, bus_context, config);
426 427 428 429 430 431 432 433 434 435 436
	if (!IS_ERR(regmap)) {
		*ptr = regmap;
		devres_add(dev, ptr);
	} else {
		devres_free(ptr);
	}

	return regmap;
}
EXPORT_SYMBOL_GPL(devm_regmap_init);

437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
/**
 * regmap_reinit_cache(): Reinitialise the current register cache
 *
 * @map: Register map to operate on.
 * @config: New configuration.  Only the cache data will be used.
 *
 * Discard any existing register cache for the map and initialize a
 * new cache.  This can be used to restore the cache to defaults or to
 * update the cache configuration to reflect runtime discovery of the
 * hardware.
 */
int regmap_reinit_cache(struct regmap *map, const struct regmap_config *config)
{
	int ret;

452
	map->lock(map);
453 454

	regcache_exit(map);
455
	regmap_debugfs_exit(map);
456 457 458 459 460 461 462 463

	map->max_register = config->max_register;
	map->writeable_reg = config->writeable_reg;
	map->readable_reg = config->readable_reg;
	map->volatile_reg = config->volatile_reg;
	map->precious_reg = config->precious_reg;
	map->cache_type = config->cache_type;

464
	regmap_debugfs_init(map, config->name);
465

466 467 468
	map->cache_bypass = false;
	map->cache_only = false;

469 470
	ret = regcache_init(map, config);

471
	map->unlock(map);
472 473 474 475

	return ret;
}

476 477 478 479 480
/**
 * regmap_exit(): Free a previously allocated register map
 */
void regmap_exit(struct regmap *map)
{
481
	regcache_exit(map);
482
	regmap_debugfs_exit(map);
483 484
	if (map->bus->free_context)
		map->bus->free_context(map->bus_context);
485 486 487 488 489
	kfree(map->work_buf);
	kfree(map);
}
EXPORT_SYMBOL_GPL(regmap_exit);

M
Mark Brown 已提交
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
static int dev_get_regmap_match(struct device *dev, void *res, void *data)
{
	struct regmap **r = res;
	if (!r || !*r) {
		WARN_ON(!r || !*r);
		return 0;
	}

	/* If the user didn't specify a name match any */
	if (data)
		return (*r)->name == data;
	else
		return 1;
}

/**
 * dev_get_regmap(): Obtain the regmap (if any) for a device
 *
 * @dev: Device to retrieve the map for
 * @name: Optional name for the register map, usually NULL.
 *
 * Returns the regmap for the device if one is present, or NULL.  If
 * name is specified then it must match the name specified when
 * registering the device, if it is NULL then the first regmap found
 * will be used.  Devices with multiple register maps are very rare,
 * generic code should normally not need to specify a name.
 */
struct regmap *dev_get_regmap(struct device *dev, const char *name)
{
	struct regmap **r = devres_find(dev, dev_get_regmap_release,
					dev_get_regmap_match, (void *)name);

	if (!r)
		return NULL;
	return *r;
}
EXPORT_SYMBOL_GPL(dev_get_regmap);

528 529 530
static int _regmap_raw_write(struct regmap *map, unsigned int reg,
			     const void *val, size_t val_len)
{
531
	u8 *u8 = map->work_buf;
532 533 534
	void *buf;
	int ret = -ENOTSUPP;
	size_t len;
535 536 537 538 539
	int i;

	/* Check for unwritable registers before we start */
	if (map->writeable_reg)
		for (i = 0; i < val_len / map->format.val_bytes; i++)
540 541
			if (!map->writeable_reg(map->dev,
						reg + (i * map->reg_stride)))
542
				return -EINVAL;
543

544 545 546 547 548 549
	if (!map->cache_bypass && map->format.parse_val) {
		unsigned int ival;
		int val_bytes = map->format.val_bytes;
		for (i = 0; i < val_len / val_bytes; i++) {
			memcpy(map->work_buf, val + (i * val_bytes), val_bytes);
			ival = map->format.parse_val(map->work_buf);
550 551
			ret = regcache_write(map, reg + (i * map->reg_stride),
					     ival);
552 553 554 555 556 557 558 559 560 561 562 563 564
			if (ret) {
				dev_err(map->dev,
				   "Error in caching of register: %u ret: %d\n",
					reg + i, ret);
				return ret;
			}
		}
		if (map->cache_only) {
			map->cache_dirty = true;
			return 0;
		}
	}

565
	map->format.format_reg(map->work_buf, reg, map->reg_shift);
566

567 568
	u8[0] |= map->write_flag_mask;

M
Mark Brown 已提交
569 570 571
	trace_regmap_hw_write_start(map->dev, reg,
				    val_len / map->format.val_bytes);

572 573 574 575
	/* If we're doing a single register write we can probably just
	 * send the work_buf directly, otherwise try to do a gather
	 * write.
	 */
576 577
	if (val == (map->work_buf + map->format.pad_bytes +
		    map->format.reg_bytes))
578
		ret = map->bus->write(map->bus_context, map->work_buf,
579 580 581
				      map->format.reg_bytes +
				      map->format.pad_bytes +
				      val_len);
582
	else if (map->bus->gather_write)
583
		ret = map->bus->gather_write(map->bus_context, map->work_buf,
584 585
					     map->format.reg_bytes +
					     map->format.pad_bytes,
586 587
					     val, val_len);

588
	/* If that didn't work fall back on linearising by hand. */
589
	if (ret == -ENOTSUPP) {
590 591
		len = map->format.reg_bytes + map->format.pad_bytes + val_len;
		buf = kzalloc(len, GFP_KERNEL);
592 593 594 595
		if (!buf)
			return -ENOMEM;

		memcpy(buf, map->work_buf, map->format.reg_bytes);
596 597
		memcpy(buf + map->format.reg_bytes + map->format.pad_bytes,
		       val, val_len);
598
		ret = map->bus->write(map->bus_context, buf, len);
599 600 601 602

		kfree(buf);
	}

M
Mark Brown 已提交
603 604 605
	trace_regmap_hw_write_done(map->dev, reg,
				   val_len / map->format.val_bytes);

606 607 608
	return ret;
}

609 610
int _regmap_write(struct regmap *map, unsigned int reg,
		  unsigned int val)
611
{
M
Mark Brown 已提交
612
	int ret;
613 614
	BUG_ON(!map->format.format_write && !map->format.format_val);

615
	if (!map->cache_bypass && map->format.format_write) {
616 617 618
		ret = regcache_write(map, reg, val);
		if (ret != 0)
			return ret;
619 620
		if (map->cache_only) {
			map->cache_dirty = true;
621
			return 0;
622
		}
623 624
	}

M
Mark Brown 已提交
625 626
	trace_regmap_reg_write(map->dev, reg, val);

627 628 629
	if (map->format.format_write) {
		map->format.format_write(map, reg, val);

M
Mark Brown 已提交
630 631
		trace_regmap_hw_write_start(map->dev, reg, 1);

632
		ret = map->bus->write(map->bus_context, map->work_buf,
M
Mark Brown 已提交
633 634 635 636 637
				      map->format.buf_size);

		trace_regmap_hw_write_done(map->dev, reg, 1);

		return ret;
638
	} else {
639
		map->format.format_val(map->work_buf + map->format.reg_bytes
640
				       + map->format.pad_bytes, val, 0);
641
		return _regmap_raw_write(map, reg,
642 643 644
					 map->work_buf +
					 map->format.reg_bytes +
					 map->format.pad_bytes,
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
					 map->format.val_bytes);
	}
}

/**
 * regmap_write(): Write a value to a single register
 *
 * @map: Register map to write to
 * @reg: Register to write to
 * @val: Value to be written
 *
 * A value of zero will be returned on success, a negative errno will
 * be returned in error cases.
 */
int regmap_write(struct regmap *map, unsigned int reg, unsigned int val)
{
	int ret;

663 664 665
	if (reg % map->reg_stride)
		return -EINVAL;

666
	map->lock(map);
667 668 669

	ret = _regmap_write(map, reg, val);

670
	map->unlock(map);
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696

	return ret;
}
EXPORT_SYMBOL_GPL(regmap_write);

/**
 * regmap_raw_write(): Write raw values to one or more registers
 *
 * @map: Register map to write to
 * @reg: Initial register to write to
 * @val: Block of data to be written, laid out for direct transmission to the
 *       device
 * @val_len: Length of data pointed to by val.
 *
 * This function is intended to be used for things like firmware
 * download where a large block of data needs to be transferred to the
 * device.  No formatting will be done on the data provided.
 *
 * A value of zero will be returned on success, a negative errno will
 * be returned in error cases.
 */
int regmap_raw_write(struct regmap *map, unsigned int reg,
		     const void *val, size_t val_len)
{
	int ret;

697 698
	if (val_len % map->format.val_bytes)
		return -EINVAL;
699 700
	if (reg % map->reg_stride)
		return -EINVAL;
701

702
	map->lock(map);
703 704 705

	ret = _regmap_raw_write(map, reg, val, val_len);

706
	map->unlock(map);
707 708 709 710 711

	return ret;
}
EXPORT_SYMBOL_GPL(regmap_raw_write);

712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
/*
 * regmap_bulk_write(): Write multiple registers to the device
 *
 * @map: Register map to write to
 * @reg: First register to be write from
 * @val: Block of data to be written, in native register size for device
 * @val_count: Number of registers to write
 *
 * This function is intended to be used for writing a large block of
 * data to be device either in single transfer or multiple transfer.
 *
 * A value of zero will be returned on success, a negative errno will
 * be returned in error cases.
 */
int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
		     size_t val_count)
{
	int ret = 0, i;
	size_t val_bytes = map->format.val_bytes;
	void *wval;

	if (!map->format.parse_val)
		return -EINVAL;
735 736
	if (reg % map->reg_stride)
		return -EINVAL;
737

738
	map->lock(map);
739 740 741 742 743 744 745 746 747 748 749 750 751 752

	/* No formatting is require if val_byte is 1 */
	if (val_bytes == 1) {
		wval = (void *)val;
	} else {
		wval = kmemdup(val, val_count * val_bytes, GFP_KERNEL);
		if (!wval) {
			ret = -ENOMEM;
			dev_err(map->dev, "Error in memory allocation\n");
			goto out;
		}
		for (i = 0; i < val_count * val_bytes; i += val_bytes)
			map->format.parse_val(wval + i);
	}
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
	/*
	 * Some devices does not support bulk write, for
	 * them we have a series of single write operations.
	 */
	if (map->use_single_rw) {
		for (i = 0; i < val_count; i++) {
			ret = regmap_raw_write(map,
						reg + (i * map->reg_stride),
						val + (i * val_bytes),
						val_bytes);
			if (ret != 0)
				return ret;
		}
	} else {
		ret = _regmap_raw_write(map, reg, wval, val_bytes * val_count);
	}
769 770 771 772 773

	if (val_bytes != 1)
		kfree(wval);

out:
774
	map->unlock(map);
775 776 777 778
	return ret;
}
EXPORT_SYMBOL_GPL(regmap_bulk_write);

779 780 781 782 783 784
static int _regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
			    unsigned int val_len)
{
	u8 *u8 = map->work_buf;
	int ret;

785
	map->format.format_reg(map->work_buf, reg, map->reg_shift);
786 787

	/*
788
	 * Some buses or devices flag reads by setting the high bits in the
789 790 791 792
	 * register addresss; since it's always the high bits for all
	 * current formats we can do this here rather than in
	 * formatting.  This may break if we get interesting formats.
	 */
793
	u8[0] |= map->read_flag_mask;
794

M
Mark Brown 已提交
795 796 797
	trace_regmap_hw_read_start(map->dev, reg,
				   val_len / map->format.val_bytes);

798
	ret = map->bus->read(map->bus_context, map->work_buf,
799
			     map->format.reg_bytes + map->format.pad_bytes,
M
Mark Brown 已提交
800
			     val, val_len);
801

M
Mark Brown 已提交
802 803 804 805
	trace_regmap_hw_read_done(map->dev, reg,
				  val_len / map->format.val_bytes);

	return ret;
806 807 808 809 810 811 812
}

static int _regmap_read(struct regmap *map, unsigned int reg,
			unsigned int *val)
{
	int ret;

813 814 815 816 817 818
	if (!map->cache_bypass) {
		ret = regcache_read(map, reg, val);
		if (ret == 0)
			return 0;
	}

819 820 821
	if (!map->format.parse_val)
		return -EINVAL;

822 823 824
	if (map->cache_only)
		return -EBUSY;

825
	ret = _regmap_raw_read(map, reg, map->work_buf, map->format.val_bytes);
M
Mark Brown 已提交
826
	if (ret == 0) {
827
		*val = map->format.parse_val(map->work_buf);
M
Mark Brown 已提交
828 829
		trace_regmap_reg_read(map->dev, reg, *val);
	}
830

831 832 833
	if (ret == 0 && !map->cache_bypass)
		regcache_write(map, reg, *val);

834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
	return ret;
}

/**
 * regmap_read(): Read a value from a single register
 *
 * @map: Register map to write to
 * @reg: Register to be read from
 * @val: Pointer to store read value
 *
 * A value of zero will be returned on success, a negative errno will
 * be returned in error cases.
 */
int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val)
{
	int ret;

851 852 853
	if (reg % map->reg_stride)
		return -EINVAL;

854
	map->lock(map);
855 856 857

	ret = _regmap_read(map, reg, val);

858
	map->unlock(map);
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877

	return ret;
}
EXPORT_SYMBOL_GPL(regmap_read);

/**
 * regmap_raw_read(): Read raw data from the device
 *
 * @map: Register map to write to
 * @reg: First register to be read from
 * @val: Pointer to store read value
 * @val_len: Size of data to read
 *
 * A value of zero will be returned on success, a negative errno will
 * be returned in error cases.
 */
int regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
		    size_t val_len)
{
878 879 880 881
	size_t val_bytes = map->format.val_bytes;
	size_t val_count = val_len / val_bytes;
	unsigned int v;
	int ret, i;
882

883 884
	if (val_len % map->format.val_bytes)
		return -EINVAL;
885 886
	if (reg % map->reg_stride)
		return -EINVAL;
887

888
	map->lock(map);
889

890 891 892 893 894 895 896 897 898 899
	if (regmap_volatile_range(map, reg, val_count) || map->cache_bypass ||
	    map->cache_type == REGCACHE_NONE) {
		/* Physical block read if there's no cache involved */
		ret = _regmap_raw_read(map, reg, val, val_len);

	} else {
		/* Otherwise go word by word for the cache; should be low
		 * cost as we expect to hit the cache.
		 */
		for (i = 0; i < val_count; i++) {
900 901
			ret = _regmap_read(map, reg + (i * map->reg_stride),
					   &v);
902 903 904
			if (ret != 0)
				goto out;

905
			map->format.format_val(val + (i * val_bytes), v, 0);
906 907
		}
	}
908

909
 out:
910
	map->unlock(map);
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931

	return ret;
}
EXPORT_SYMBOL_GPL(regmap_raw_read);

/**
 * regmap_bulk_read(): Read multiple registers from the device
 *
 * @map: Register map to write to
 * @reg: First register to be read from
 * @val: Pointer to store read value, in native register size for device
 * @val_count: Number of registers to read
 *
 * A value of zero will be returned on success, a negative errno will
 * be returned in error cases.
 */
int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
		     size_t val_count)
{
	int ret, i;
	size_t val_bytes = map->format.val_bytes;
932
	bool vol = regmap_volatile_range(map, reg, val_count);
933

934 935
	if (!map->format.parse_val)
		return -EINVAL;
936 937
	if (reg % map->reg_stride)
		return -EINVAL;
938

939
	if (vol || map->cache_type == REGCACHE_NONE) {
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
		/*
		 * Some devices does not support bulk read, for
		 * them we have a series of single read operations.
		 */
		if (map->use_single_rw) {
			for (i = 0; i < val_count; i++) {
				ret = regmap_raw_read(map,
						reg + (i * map->reg_stride),
						val + (i * val_bytes),
						val_bytes);
				if (ret != 0)
					return ret;
			}
		} else {
			ret = regmap_raw_read(map, reg, val,
					      val_bytes * val_count);
			if (ret != 0)
				return ret;
		}
959 960 961 962 963

		for (i = 0; i < val_count * val_bytes; i += val_bytes)
			map->format.parse_val(val + i);
	} else {
		for (i = 0; i < val_count; i++) {
964
			unsigned int ival;
965
			ret = regmap_read(map, reg + (i * map->reg_stride),
966
					  &ival);
967 968
			if (ret != 0)
				return ret;
969
			memcpy(val + (i * val_bytes), &ival, val_bytes);
970 971
		}
	}
972 973 974 975 976

	return 0;
}
EXPORT_SYMBOL_GPL(regmap_bulk_read);

977 978 979
static int _regmap_update_bits(struct regmap *map, unsigned int reg,
			       unsigned int mask, unsigned int val,
			       bool *change)
980 981
{
	int ret;
982
	unsigned int tmp, orig;
983

984
	map->lock(map);
985

986
	ret = _regmap_read(map, reg, &orig);
987 988 989
	if (ret != 0)
		goto out;

990
	tmp = orig & ~mask;
991 992
	tmp |= val & mask;

993
	if (tmp != orig) {
994
		ret = _regmap_write(map, reg, tmp);
995 996 997 998
		*change = true;
	} else {
		*change = false;
	}
999 1000

out:
1001
	map->unlock(map);
1002 1003 1004

	return ret;
}
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021

/**
 * regmap_update_bits: Perform a read/modify/write cycle on the register map
 *
 * @map: Register map to update
 * @reg: Register to update
 * @mask: Bitmask to change
 * @val: New value for bitmask
 *
 * Returns zero for success, a negative number on error.
 */
int regmap_update_bits(struct regmap *map, unsigned int reg,
		       unsigned int mask, unsigned int val)
{
	bool change;
	return _regmap_update_bits(map, reg, mask, val, &change);
}
1022
EXPORT_SYMBOL_GPL(regmap_update_bits);
1023

1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
/**
 * regmap_update_bits_check: Perform a read/modify/write cycle on the
 *                           register map and report if updated
 *
 * @map: Register map to update
 * @reg: Register to update
 * @mask: Bitmask to change
 * @val: New value for bitmask
 * @change: Boolean indicating if a write was done
 *
 * Returns zero for success, a negative number on error.
 */
int regmap_update_bits_check(struct regmap *map, unsigned int reg,
			     unsigned int mask, unsigned int val,
			     bool *change)
{
	return _regmap_update_bits(map, reg, mask, val, change);
}
EXPORT_SYMBOL_GPL(regmap_update_bits_check);

M
Mark Brown 已提交
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
/**
 * regmap_register_patch: Register and apply register updates to be applied
 *                        on device initialistion
 *
 * @map: Register map to apply updates to.
 * @regs: Values to update.
 * @num_regs: Number of entries in regs.
 *
 * Register a set of register updates to be applied to the device
 * whenever the device registers are synchronised with the cache and
 * apply them immediately.  Typically this is used to apply
 * corrections to be applied to the device defaults on startup, such
 * as the updates some vendors provide to undocumented registers.
 */
int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
			  int num_regs)
{
	int i, ret;
	bool bypass;

	/* If needed the implementation can be extended to support this */
	if (map->patch)
		return -EBUSY;

1068
	map->lock(map);
M
Mark Brown 已提交
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083

	bypass = map->cache_bypass;

	map->cache_bypass = true;

	/* Write out first; it's useful to apply even if we fail later. */
	for (i = 0; i < num_regs; i++) {
		ret = _regmap_write(map, regs[i].reg, regs[i].def);
		if (ret != 0) {
			dev_err(map->dev, "Failed to write %x = %x: %d\n",
				regs[i].reg, regs[i].def, ret);
			goto out;
		}
	}

1084
	map->patch = kcalloc(num_regs, sizeof(struct reg_default), GFP_KERNEL);
M
Mark Brown 已提交
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
	if (map->patch != NULL) {
		memcpy(map->patch, regs,
		       num_regs * sizeof(struct reg_default));
		map->patch_regs = num_regs;
	} else {
		ret = -ENOMEM;
	}

out:
	map->cache_bypass = bypass;

1096
	map->unlock(map);
M
Mark Brown 已提交
1097 1098 1099 1100 1101

	return ret;
}
EXPORT_SYMBOL_GPL(regmap_register_patch);

1102
/*
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
 * regmap_get_val_bytes(): Report the size of a register value
 *
 * Report the size of a register value, mainly intended to for use by
 * generic infrastructure built on top of regmap.
 */
int regmap_get_val_bytes(struct regmap *map)
{
	if (map->format.format_write)
		return -EINVAL;

	return map->format.val_bytes;
}
EXPORT_SYMBOL_GPL(regmap_get_val_bytes);

1117 1118 1119 1120 1121 1122 1123
static int __init regmap_initcall(void)
{
	regmap_debugfs_initcall();

	return 0;
}
postcore_initcall(regmap_initcall);