regmap.c 26 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124
  1. /*
  2. * Register map access API
  3. *
  4. * Copyright 2011 Wolfson Microelectronics plc
  5. *
  6. * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
  7. *
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License version 2 as
  10. * published by the Free Software Foundation.
  11. */
  12. #include <linux/device.h>
  13. #include <linux/slab.h>
  14. #include <linux/export.h>
  15. #include <linux/mutex.h>
  16. #include <linux/err.h>
  17. #define CREATE_TRACE_POINTS
  18. #include <trace/events/regmap.h>
  19. #include "internal.h"
  20. bool regmap_writeable(struct regmap *map, unsigned int reg)
  21. {
  22. if (map->max_register && reg > map->max_register)
  23. return false;
  24. if (map->writeable_reg)
  25. return map->writeable_reg(map->dev, reg);
  26. return true;
  27. }
  28. bool regmap_readable(struct regmap *map, unsigned int reg)
  29. {
  30. if (map->max_register && reg > map->max_register)
  31. return false;
  32. if (map->format.format_write)
  33. return false;
  34. if (map->readable_reg)
  35. return map->readable_reg(map->dev, reg);
  36. return true;
  37. }
  38. bool regmap_volatile(struct regmap *map, unsigned int reg)
  39. {
  40. if (!regmap_readable(map, reg))
  41. return false;
  42. if (map->volatile_reg)
  43. return map->volatile_reg(map->dev, reg);
  44. return true;
  45. }
  46. bool regmap_precious(struct regmap *map, unsigned int reg)
  47. {
  48. if (!regmap_readable(map, reg))
  49. return false;
  50. if (map->precious_reg)
  51. return map->precious_reg(map->dev, reg);
  52. return false;
  53. }
  54. static bool regmap_volatile_range(struct regmap *map, unsigned int reg,
  55. unsigned int num)
  56. {
  57. unsigned int i;
  58. for (i = 0; i < num; i++)
  59. if (!regmap_volatile(map, reg + i))
  60. return false;
  61. return true;
  62. }
  63. static void regmap_format_2_6_write(struct regmap *map,
  64. unsigned int reg, unsigned int val)
  65. {
  66. u8 *out = map->work_buf;
  67. *out = (reg << 6) | val;
  68. }
  69. static void regmap_format_4_12_write(struct regmap *map,
  70. unsigned int reg, unsigned int val)
  71. {
  72. __be16 *out = map->work_buf;
  73. *out = cpu_to_be16((reg << 12) | val);
  74. }
  75. static void regmap_format_7_9_write(struct regmap *map,
  76. unsigned int reg, unsigned int val)
  77. {
  78. __be16 *out = map->work_buf;
  79. *out = cpu_to_be16((reg << 9) | val);
  80. }
  81. static void regmap_format_10_14_write(struct regmap *map,
  82. unsigned int reg, unsigned int val)
  83. {
  84. u8 *out = map->work_buf;
  85. out[2] = val;
  86. out[1] = (val >> 8) | (reg << 6);
  87. out[0] = reg >> 2;
  88. }
  89. static void regmap_format_8(void *buf, unsigned int val, unsigned int shift)
  90. {
  91. u8 *b = buf;
  92. b[0] = val << shift;
  93. }
  94. static void regmap_format_16(void *buf, unsigned int val, unsigned int shift)
  95. {
  96. __be16 *b = buf;
  97. b[0] = cpu_to_be16(val << shift);
  98. }
  99. static void regmap_format_24(void *buf, unsigned int val, unsigned int shift)
  100. {
  101. u8 *b = buf;
  102. val <<= shift;
  103. b[0] = val >> 16;
  104. b[1] = val >> 8;
  105. b[2] = val;
  106. }
  107. static void regmap_format_32(void *buf, unsigned int val, unsigned int shift)
  108. {
  109. __be32 *b = buf;
  110. b[0] = cpu_to_be32(val << shift);
  111. }
  112. static unsigned int regmap_parse_8(void *buf)
  113. {
  114. u8 *b = buf;
  115. return b[0];
  116. }
  117. static unsigned int regmap_parse_16(void *buf)
  118. {
  119. __be16 *b = buf;
  120. b[0] = be16_to_cpu(b[0]);
  121. return b[0];
  122. }
  123. static unsigned int regmap_parse_24(void *buf)
  124. {
  125. u8 *b = buf;
  126. unsigned int ret = b[2];
  127. ret |= ((unsigned int)b[1]) << 8;
  128. ret |= ((unsigned int)b[0]) << 16;
  129. return ret;
  130. }
  131. static unsigned int regmap_parse_32(void *buf)
  132. {
  133. __be32 *b = buf;
  134. b[0] = be32_to_cpu(b[0]);
  135. return b[0];
  136. }
  137. static void regmap_lock_mutex(struct regmap *map)
  138. {
  139. mutex_lock(&map->mutex);
  140. }
  141. static void regmap_unlock_mutex(struct regmap *map)
  142. {
  143. mutex_unlock(&map->mutex);
  144. }
  145. static void regmap_lock_spinlock(struct regmap *map)
  146. {
  147. spin_lock(&map->spinlock);
  148. }
  149. static void regmap_unlock_spinlock(struct regmap *map)
  150. {
  151. spin_unlock(&map->spinlock);
  152. }
  153. static void dev_get_regmap_release(struct device *dev, void *res)
  154. {
  155. /*
  156. * We don't actually have anything to do here; the goal here
  157. * is not to manage the regmap but to provide a simple way to
  158. * get the regmap back given a struct device.
  159. */
  160. }
  161. /**
  162. * regmap_init(): Initialise register map
  163. *
  164. * @dev: Device that will be interacted with
  165. * @bus: Bus-specific callbacks to use with device
  166. * @bus_context: Data passed to bus-specific callbacks
  167. * @config: Configuration for register map
  168. *
  169. * The return value will be an ERR_PTR() on error or a valid pointer to
  170. * a struct regmap. This function should generally not be called
  171. * directly, it should be called by bus-specific init functions.
  172. */
  173. struct regmap *regmap_init(struct device *dev,
  174. const struct regmap_bus *bus,
  175. void *bus_context,
  176. const struct regmap_config *config)
  177. {
  178. struct regmap *map, **m;
  179. int ret = -EINVAL;
  180. if (!bus || !config)
  181. goto err;
  182. map = kzalloc(sizeof(*map), GFP_KERNEL);
  183. if (map == NULL) {
  184. ret = -ENOMEM;
  185. goto err;
  186. }
  187. if (bus->fast_io) {
  188. spin_lock_init(&map->spinlock);
  189. map->lock = regmap_lock_spinlock;
  190. map->unlock = regmap_unlock_spinlock;
  191. } else {
  192. mutex_init(&map->mutex);
  193. map->lock = regmap_lock_mutex;
  194. map->unlock = regmap_unlock_mutex;
  195. }
  196. map->format.reg_bytes = DIV_ROUND_UP(config->reg_bits, 8);
  197. map->format.pad_bytes = config->pad_bits / 8;
  198. map->format.val_bytes = DIV_ROUND_UP(config->val_bits, 8);
  199. map->format.buf_size = DIV_ROUND_UP(config->reg_bits +
  200. config->val_bits + config->pad_bits, 8);
  201. map->reg_shift = config->pad_bits % 8;
  202. if (config->reg_stride)
  203. map->reg_stride = config->reg_stride;
  204. else
  205. map->reg_stride = 1;
  206. map->use_single_rw = config->use_single_rw;
  207. map->dev = dev;
  208. map->bus = bus;
  209. map->bus_context = bus_context;
  210. map->max_register = config->max_register;
  211. map->writeable_reg = config->writeable_reg;
  212. map->readable_reg = config->readable_reg;
  213. map->volatile_reg = config->volatile_reg;
  214. map->precious_reg = config->precious_reg;
  215. map->cache_type = config->cache_type;
  216. map->name = config->name;
  217. if (config->read_flag_mask || config->write_flag_mask) {
  218. map->read_flag_mask = config->read_flag_mask;
  219. map->write_flag_mask = config->write_flag_mask;
  220. } else {
  221. map->read_flag_mask = bus->read_flag_mask;
  222. }
  223. switch (config->reg_bits + map->reg_shift) {
  224. case 2:
  225. switch (config->val_bits) {
  226. case 6:
  227. map->format.format_write = regmap_format_2_6_write;
  228. break;
  229. default:
  230. goto err_map;
  231. }
  232. break;
  233. case 4:
  234. switch (config->val_bits) {
  235. case 12:
  236. map->format.format_write = regmap_format_4_12_write;
  237. break;
  238. default:
  239. goto err_map;
  240. }
  241. break;
  242. case 7:
  243. switch (config->val_bits) {
  244. case 9:
  245. map->format.format_write = regmap_format_7_9_write;
  246. break;
  247. default:
  248. goto err_map;
  249. }
  250. break;
  251. case 10:
  252. switch (config->val_bits) {
  253. case 14:
  254. map->format.format_write = regmap_format_10_14_write;
  255. break;
  256. default:
  257. goto err_map;
  258. }
  259. break;
  260. case 8:
  261. map->format.format_reg = regmap_format_8;
  262. break;
  263. case 16:
  264. map->format.format_reg = regmap_format_16;
  265. break;
  266. case 32:
  267. map->format.format_reg = regmap_format_32;
  268. break;
  269. default:
  270. goto err_map;
  271. }
  272. switch (config->val_bits) {
  273. case 8:
  274. map->format.format_val = regmap_format_8;
  275. map->format.parse_val = regmap_parse_8;
  276. break;
  277. case 16:
  278. map->format.format_val = regmap_format_16;
  279. map->format.parse_val = regmap_parse_16;
  280. break;
  281. case 24:
  282. map->format.format_val = regmap_format_24;
  283. map->format.parse_val = regmap_parse_24;
  284. break;
  285. case 32:
  286. map->format.format_val = regmap_format_32;
  287. map->format.parse_val = regmap_parse_32;
  288. break;
  289. }
  290. if (map->format.format_write)
  291. map->use_single_rw = true;
  292. if (!map->format.format_write &&
  293. !(map->format.format_reg && map->format.format_val))
  294. goto err_map;
  295. map->work_buf = kzalloc(map->format.buf_size, GFP_KERNEL);
  296. if (map->work_buf == NULL) {
  297. ret = -ENOMEM;
  298. goto err_map;
  299. }
  300. regmap_debugfs_init(map, config->name);
  301. ret = regcache_init(map, config);
  302. if (ret < 0)
  303. goto err_debugfs;
  304. /* Add a devres resource for dev_get_regmap() */
  305. m = devres_alloc(dev_get_regmap_release, sizeof(*m), GFP_KERNEL);
  306. if (!m) {
  307. ret = -ENOMEM;
  308. goto err_cache;
  309. }
  310. *m = map;
  311. devres_add(dev, m);
  312. return map;
  313. err_cache:
  314. regcache_exit(map);
  315. err_debugfs:
  316. regmap_debugfs_exit(map);
  317. kfree(map->work_buf);
  318. err_map:
  319. kfree(map);
  320. err:
  321. return ERR_PTR(ret);
  322. }
  323. EXPORT_SYMBOL_GPL(regmap_init);
  324. static void devm_regmap_release(struct device *dev, void *res)
  325. {
  326. regmap_exit(*(struct regmap **)res);
  327. }
  328. /**
  329. * devm_regmap_init(): Initialise managed register map
  330. *
  331. * @dev: Device that will be interacted with
  332. * @bus: Bus-specific callbacks to use with device
  333. * @bus_context: Data passed to bus-specific callbacks
  334. * @config: Configuration for register map
  335. *
  336. * The return value will be an ERR_PTR() on error or a valid pointer
  337. * to a struct regmap. This function should generally not be called
  338. * directly, it should be called by bus-specific init functions. The
  339. * map will be automatically freed by the device management code.
  340. */
  341. struct regmap *devm_regmap_init(struct device *dev,
  342. const struct regmap_bus *bus,
  343. void *bus_context,
  344. const struct regmap_config *config)
  345. {
  346. struct regmap **ptr, *regmap;
  347. ptr = devres_alloc(devm_regmap_release, sizeof(*ptr), GFP_KERNEL);
  348. if (!ptr)
  349. return ERR_PTR(-ENOMEM);
  350. regmap = regmap_init(dev, bus, bus_context, config);
  351. if (!IS_ERR(regmap)) {
  352. *ptr = regmap;
  353. devres_add(dev, ptr);
  354. } else {
  355. devres_free(ptr);
  356. }
  357. return regmap;
  358. }
  359. EXPORT_SYMBOL_GPL(devm_regmap_init);
  360. /**
  361. * regmap_reinit_cache(): Reinitialise the current register cache
  362. *
  363. * @map: Register map to operate on.
  364. * @config: New configuration. Only the cache data will be used.
  365. *
  366. * Discard any existing register cache for the map and initialize a
  367. * new cache. This can be used to restore the cache to defaults or to
  368. * update the cache configuration to reflect runtime discovery of the
  369. * hardware.
  370. */
  371. int regmap_reinit_cache(struct regmap *map, const struct regmap_config *config)
  372. {
  373. int ret;
  374. map->lock(map);
  375. regcache_exit(map);
  376. regmap_debugfs_exit(map);
  377. map->max_register = config->max_register;
  378. map->writeable_reg = config->writeable_reg;
  379. map->readable_reg = config->readable_reg;
  380. map->volatile_reg = config->volatile_reg;
  381. map->precious_reg = config->precious_reg;
  382. map->cache_type = config->cache_type;
  383. regmap_debugfs_init(map, config->name);
  384. map->cache_bypass = false;
  385. map->cache_only = false;
  386. ret = regcache_init(map, config);
  387. map->unlock(map);
  388. return ret;
  389. }
  390. EXPORT_SYMBOL_GPL(regmap_reinit_cache);
  391. /**
  392. * regmap_exit(): Free a previously allocated register map
  393. */
  394. void regmap_exit(struct regmap *map)
  395. {
  396. regcache_exit(map);
  397. regmap_debugfs_exit(map);
  398. if (map->bus->free_context)
  399. map->bus->free_context(map->bus_context);
  400. kfree(map->work_buf);
  401. kfree(map);
  402. }
  403. EXPORT_SYMBOL_GPL(regmap_exit);
  404. static int dev_get_regmap_match(struct device *dev, void *res, void *data)
  405. {
  406. struct regmap **r = res;
  407. if (!r || !*r) {
  408. WARN_ON(!r || !*r);
  409. return 0;
  410. }
  411. /* If the user didn't specify a name match any */
  412. if (data)
  413. return (*r)->name == data;
  414. else
  415. return 1;
  416. }
  417. /**
  418. * dev_get_regmap(): Obtain the regmap (if any) for a device
  419. *
  420. * @dev: Device to retrieve the map for
  421. * @name: Optional name for the register map, usually NULL.
  422. *
  423. * Returns the regmap for the device if one is present, or NULL. If
  424. * name is specified then it must match the name specified when
  425. * registering the device, if it is NULL then the first regmap found
  426. * will be used. Devices with multiple register maps are very rare,
  427. * generic code should normally not need to specify a name.
  428. */
  429. struct regmap *dev_get_regmap(struct device *dev, const char *name)
  430. {
  431. struct regmap **r = devres_find(dev, dev_get_regmap_release,
  432. dev_get_regmap_match, (void *)name);
  433. if (!r)
  434. return NULL;
  435. return *r;
  436. }
  437. EXPORT_SYMBOL_GPL(dev_get_regmap);
  438. static int _regmap_raw_write(struct regmap *map, unsigned int reg,
  439. const void *val, size_t val_len)
  440. {
  441. u8 *u8 = map->work_buf;
  442. void *buf;
  443. int ret = -ENOTSUPP;
  444. size_t len;
  445. int i;
  446. /* Check for unwritable registers before we start */
  447. if (map->writeable_reg)
  448. for (i = 0; i < val_len / map->format.val_bytes; i++)
  449. if (!map->writeable_reg(map->dev,
  450. reg + (i * map->reg_stride)))
  451. return -EINVAL;
  452. if (!map->cache_bypass && map->format.parse_val) {
  453. unsigned int ival;
  454. int val_bytes = map->format.val_bytes;
  455. for (i = 0; i < val_len / val_bytes; i++) {
  456. memcpy(map->work_buf, val + (i * val_bytes), val_bytes);
  457. ival = map->format.parse_val(map->work_buf);
  458. ret = regcache_write(map, reg + (i * map->reg_stride),
  459. ival);
  460. if (ret) {
  461. dev_err(map->dev,
  462. "Error in caching of register: %u ret: %d\n",
  463. reg + i, ret);
  464. return ret;
  465. }
  466. }
  467. if (map->cache_only) {
  468. map->cache_dirty = true;
  469. return 0;
  470. }
  471. }
  472. map->format.format_reg(map->work_buf, reg, map->reg_shift);
  473. u8[0] |= map->write_flag_mask;
  474. trace_regmap_hw_write_start(map->dev, reg,
  475. val_len / map->format.val_bytes);
  476. /* If we're doing a single register write we can probably just
  477. * send the work_buf directly, otherwise try to do a gather
  478. * write.
  479. */
  480. if (val == (map->work_buf + map->format.pad_bytes +
  481. map->format.reg_bytes))
  482. ret = map->bus->write(map->bus_context, map->work_buf,
  483. map->format.reg_bytes +
  484. map->format.pad_bytes +
  485. val_len);
  486. else if (map->bus->gather_write)
  487. ret = map->bus->gather_write(map->bus_context, map->work_buf,
  488. map->format.reg_bytes +
  489. map->format.pad_bytes,
  490. val, val_len);
  491. /* If that didn't work fall back on linearising by hand. */
  492. if (ret == -ENOTSUPP) {
  493. len = map->format.reg_bytes + map->format.pad_bytes + val_len;
  494. buf = kzalloc(len, GFP_KERNEL);
  495. if (!buf)
  496. return -ENOMEM;
  497. memcpy(buf, map->work_buf, map->format.reg_bytes);
  498. memcpy(buf + map->format.reg_bytes + map->format.pad_bytes,
  499. val, val_len);
  500. ret = map->bus->write(map->bus_context, buf, len);
  501. kfree(buf);
  502. }
  503. trace_regmap_hw_write_done(map->dev, reg,
  504. val_len / map->format.val_bytes);
  505. return ret;
  506. }
  507. int _regmap_write(struct regmap *map, unsigned int reg,
  508. unsigned int val)
  509. {
  510. int ret;
  511. BUG_ON(!map->format.format_write && !map->format.format_val);
  512. if (!map->cache_bypass && map->format.format_write) {
  513. ret = regcache_write(map, reg, val);
  514. if (ret != 0)
  515. return ret;
  516. if (map->cache_only) {
  517. map->cache_dirty = true;
  518. return 0;
  519. }
  520. }
  521. trace_regmap_reg_write(map->dev, reg, val);
  522. if (map->format.format_write) {
  523. map->format.format_write(map, reg, val);
  524. trace_regmap_hw_write_start(map->dev, reg, 1);
  525. ret = map->bus->write(map->bus_context, map->work_buf,
  526. map->format.buf_size);
  527. trace_regmap_hw_write_done(map->dev, reg, 1);
  528. return ret;
  529. } else {
  530. map->format.format_val(map->work_buf + map->format.reg_bytes
  531. + map->format.pad_bytes, val, 0);
  532. return _regmap_raw_write(map, reg,
  533. map->work_buf +
  534. map->format.reg_bytes +
  535. map->format.pad_bytes,
  536. map->format.val_bytes);
  537. }
  538. }
  539. /**
  540. * regmap_write(): Write a value to a single register
  541. *
  542. * @map: Register map to write to
  543. * @reg: Register to write to
  544. * @val: Value to be written
  545. *
  546. * A value of zero will be returned on success, a negative errno will
  547. * be returned in error cases.
  548. */
  549. int regmap_write(struct regmap *map, unsigned int reg, unsigned int val)
  550. {
  551. int ret;
  552. if (reg % map->reg_stride)
  553. return -EINVAL;
  554. map->lock(map);
  555. ret = _regmap_write(map, reg, val);
  556. map->unlock(map);
  557. return ret;
  558. }
  559. EXPORT_SYMBOL_GPL(regmap_write);
  560. /**
  561. * regmap_raw_write(): Write raw values to one or more registers
  562. *
  563. * @map: Register map to write to
  564. * @reg: Initial register to write to
  565. * @val: Block of data to be written, laid out for direct transmission to the
  566. * device
  567. * @val_len: Length of data pointed to by val.
  568. *
  569. * This function is intended to be used for things like firmware
  570. * download where a large block of data needs to be transferred to the
  571. * device. No formatting will be done on the data provided.
  572. *
  573. * A value of zero will be returned on success, a negative errno will
  574. * be returned in error cases.
  575. */
  576. int regmap_raw_write(struct regmap *map, unsigned int reg,
  577. const void *val, size_t val_len)
  578. {
  579. int ret;
  580. if (val_len % map->format.val_bytes)
  581. return -EINVAL;
  582. if (reg % map->reg_stride)
  583. return -EINVAL;
  584. map->lock(map);
  585. ret = _regmap_raw_write(map, reg, val, val_len);
  586. map->unlock(map);
  587. return ret;
  588. }
  589. EXPORT_SYMBOL_GPL(regmap_raw_write);
  590. /*
  591. * regmap_bulk_write(): Write multiple registers to the device
  592. *
  593. * @map: Register map to write to
  594. * @reg: First register to be write from
  595. * @val: Block of data to be written, in native register size for device
  596. * @val_count: Number of registers to write
  597. *
  598. * This function is intended to be used for writing a large block of
  599. * data to be device either in single transfer or multiple transfer.
  600. *
  601. * A value of zero will be returned on success, a negative errno will
  602. * be returned in error cases.
  603. */
  604. int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
  605. size_t val_count)
  606. {
  607. int ret = 0, i;
  608. size_t val_bytes = map->format.val_bytes;
  609. void *wval;
  610. if (!map->format.parse_val)
  611. return -EINVAL;
  612. if (reg % map->reg_stride)
  613. return -EINVAL;
  614. map->lock(map);
  615. /* No formatting is require if val_byte is 1 */
  616. if (val_bytes == 1) {
  617. wval = (void *)val;
  618. } else {
  619. wval = kmemdup(val, val_count * val_bytes, GFP_KERNEL);
  620. if (!wval) {
  621. ret = -ENOMEM;
  622. dev_err(map->dev, "Error in memory allocation\n");
  623. goto out;
  624. }
  625. for (i = 0; i < val_count * val_bytes; i += val_bytes)
  626. map->format.parse_val(wval + i);
  627. }
  628. /*
  629. * Some devices does not support bulk write, for
  630. * them we have a series of single write operations.
  631. */
  632. if (map->use_single_rw) {
  633. for (i = 0; i < val_count; i++) {
  634. ret = regmap_raw_write(map,
  635. reg + (i * map->reg_stride),
  636. val + (i * val_bytes),
  637. val_bytes);
  638. if (ret != 0)
  639. return ret;
  640. }
  641. } else {
  642. ret = _regmap_raw_write(map, reg, wval, val_bytes * val_count);
  643. }
  644. if (val_bytes != 1)
  645. kfree(wval);
  646. out:
  647. map->unlock(map);
  648. return ret;
  649. }
  650. EXPORT_SYMBOL_GPL(regmap_bulk_write);
  651. static int _regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
  652. unsigned int val_len)
  653. {
  654. u8 *u8 = map->work_buf;
  655. int ret;
  656. map->format.format_reg(map->work_buf, reg, map->reg_shift);
  657. /*
  658. * Some buses or devices flag reads by setting the high bits in the
  659. * register addresss; since it's always the high bits for all
  660. * current formats we can do this here rather than in
  661. * formatting. This may break if we get interesting formats.
  662. */
  663. u8[0] |= map->read_flag_mask;
  664. trace_regmap_hw_read_start(map->dev, reg,
  665. val_len / map->format.val_bytes);
  666. ret = map->bus->read(map->bus_context, map->work_buf,
  667. map->format.reg_bytes + map->format.pad_bytes,
  668. val, val_len);
  669. trace_regmap_hw_read_done(map->dev, reg,
  670. val_len / map->format.val_bytes);
  671. return ret;
  672. }
  673. static int _regmap_read(struct regmap *map, unsigned int reg,
  674. unsigned int *val)
  675. {
  676. int ret;
  677. if (!map->cache_bypass) {
  678. ret = regcache_read(map, reg, val);
  679. if (ret == 0)
  680. return 0;
  681. }
  682. if (!map->format.parse_val)
  683. return -EINVAL;
  684. if (map->cache_only)
  685. return -EBUSY;
  686. ret = _regmap_raw_read(map, reg, map->work_buf, map->format.val_bytes);
  687. if (ret == 0) {
  688. *val = map->format.parse_val(map->work_buf);
  689. trace_regmap_reg_read(map->dev, reg, *val);
  690. }
  691. if (ret == 0 && !map->cache_bypass)
  692. regcache_write(map, reg, *val);
  693. return ret;
  694. }
  695. /**
  696. * regmap_read(): Read a value from a single register
  697. *
  698. * @map: Register map to write to
  699. * @reg: Register to be read from
  700. * @val: Pointer to store read value
  701. *
  702. * A value of zero will be returned on success, a negative errno will
  703. * be returned in error cases.
  704. */
  705. int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val)
  706. {
  707. int ret;
  708. if (reg % map->reg_stride)
  709. return -EINVAL;
  710. map->lock(map);
  711. ret = _regmap_read(map, reg, val);
  712. map->unlock(map);
  713. return ret;
  714. }
  715. EXPORT_SYMBOL_GPL(regmap_read);
  716. /**
  717. * regmap_raw_read(): Read raw data from the device
  718. *
  719. * @map: Register map to write to
  720. * @reg: First register to be read from
  721. * @val: Pointer to store read value
  722. * @val_len: Size of data to read
  723. *
  724. * A value of zero will be returned on success, a negative errno will
  725. * be returned in error cases.
  726. */
  727. int regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
  728. size_t val_len)
  729. {
  730. size_t val_bytes = map->format.val_bytes;
  731. size_t val_count = val_len / val_bytes;
  732. unsigned int v;
  733. int ret, i;
  734. if (val_len % map->format.val_bytes)
  735. return -EINVAL;
  736. if (reg % map->reg_stride)
  737. return -EINVAL;
  738. map->lock(map);
  739. if (regmap_volatile_range(map, reg, val_count) || map->cache_bypass ||
  740. map->cache_type == REGCACHE_NONE) {
  741. /* Physical block read if there's no cache involved */
  742. ret = _regmap_raw_read(map, reg, val, val_len);
  743. } else {
  744. /* Otherwise go word by word for the cache; should be low
  745. * cost as we expect to hit the cache.
  746. */
  747. for (i = 0; i < val_count; i++) {
  748. ret = _regmap_read(map, reg + (i * map->reg_stride),
  749. &v);
  750. if (ret != 0)
  751. goto out;
  752. map->format.format_val(val + (i * val_bytes), v, 0);
  753. }
  754. }
  755. out:
  756. map->unlock(map);
  757. return ret;
  758. }
  759. EXPORT_SYMBOL_GPL(regmap_raw_read);
  760. /**
  761. * regmap_bulk_read(): Read multiple registers from the device
  762. *
  763. * @map: Register map to write to
  764. * @reg: First register to be read from
  765. * @val: Pointer to store read value, in native register size for device
  766. * @val_count: Number of registers to read
  767. *
  768. * A value of zero will be returned on success, a negative errno will
  769. * be returned in error cases.
  770. */
  771. int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
  772. size_t val_count)
  773. {
  774. int ret, i;
  775. size_t val_bytes = map->format.val_bytes;
  776. bool vol = regmap_volatile_range(map, reg, val_count);
  777. if (!map->format.parse_val)
  778. return -EINVAL;
  779. if (reg % map->reg_stride)
  780. return -EINVAL;
  781. if (vol || map->cache_type == REGCACHE_NONE) {
  782. /*
  783. * Some devices does not support bulk read, for
  784. * them we have a series of single read operations.
  785. */
  786. if (map->use_single_rw) {
  787. for (i = 0; i < val_count; i++) {
  788. ret = regmap_raw_read(map,
  789. reg + (i * map->reg_stride),
  790. val + (i * val_bytes),
  791. val_bytes);
  792. if (ret != 0)
  793. return ret;
  794. }
  795. } else {
  796. ret = regmap_raw_read(map, reg, val,
  797. val_bytes * val_count);
  798. if (ret != 0)
  799. return ret;
  800. }
  801. for (i = 0; i < val_count * val_bytes; i += val_bytes)
  802. map->format.parse_val(val + i);
  803. } else {
  804. for (i = 0; i < val_count; i++) {
  805. unsigned int ival;
  806. ret = regmap_read(map, reg + (i * map->reg_stride),
  807. &ival);
  808. if (ret != 0)
  809. return ret;
  810. memcpy(val + (i * val_bytes), &ival, val_bytes);
  811. }
  812. }
  813. return 0;
  814. }
  815. EXPORT_SYMBOL_GPL(regmap_bulk_read);
  816. static int _regmap_update_bits(struct regmap *map, unsigned int reg,
  817. unsigned int mask, unsigned int val,
  818. bool *change)
  819. {
  820. int ret;
  821. unsigned int tmp, orig;
  822. map->lock(map);
  823. ret = _regmap_read(map, reg, &orig);
  824. if (ret != 0)
  825. goto out;
  826. tmp = orig & ~mask;
  827. tmp |= val & mask;
  828. if (tmp != orig) {
  829. ret = _regmap_write(map, reg, tmp);
  830. *change = true;
  831. } else {
  832. *change = false;
  833. }
  834. out:
  835. map->unlock(map);
  836. return ret;
  837. }
  838. /**
  839. * regmap_update_bits: Perform a read/modify/write cycle on the register map
  840. *
  841. * @map: Register map to update
  842. * @reg: Register to update
  843. * @mask: Bitmask to change
  844. * @val: New value for bitmask
  845. *
  846. * Returns zero for success, a negative number on error.
  847. */
  848. int regmap_update_bits(struct regmap *map, unsigned int reg,
  849. unsigned int mask, unsigned int val)
  850. {
  851. bool change;
  852. return _regmap_update_bits(map, reg, mask, val, &change);
  853. }
  854. EXPORT_SYMBOL_GPL(regmap_update_bits);
  855. /**
  856. * regmap_update_bits_check: Perform a read/modify/write cycle on the
  857. * register map and report if updated
  858. *
  859. * @map: Register map to update
  860. * @reg: Register to update
  861. * @mask: Bitmask to change
  862. * @val: New value for bitmask
  863. * @change: Boolean indicating if a write was done
  864. *
  865. * Returns zero for success, a negative number on error.
  866. */
  867. int regmap_update_bits_check(struct regmap *map, unsigned int reg,
  868. unsigned int mask, unsigned int val,
  869. bool *change)
  870. {
  871. return _regmap_update_bits(map, reg, mask, val, change);
  872. }
  873. EXPORT_SYMBOL_GPL(regmap_update_bits_check);
  874. /**
  875. * regmap_register_patch: Register and apply register updates to be applied
  876. * on device initialistion
  877. *
  878. * @map: Register map to apply updates to.
  879. * @regs: Values to update.
  880. * @num_regs: Number of entries in regs.
  881. *
  882. * Register a set of register updates to be applied to the device
  883. * whenever the device registers are synchronised with the cache and
  884. * apply them immediately. Typically this is used to apply
  885. * corrections to be applied to the device defaults on startup, such
  886. * as the updates some vendors provide to undocumented registers.
  887. */
  888. int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
  889. int num_regs)
  890. {
  891. int i, ret;
  892. bool bypass;
  893. /* If needed the implementation can be extended to support this */
  894. if (map->patch)
  895. return -EBUSY;
  896. map->lock(map);
  897. bypass = map->cache_bypass;
  898. map->cache_bypass = true;
  899. /* Write out first; it's useful to apply even if we fail later. */
  900. for (i = 0; i < num_regs; i++) {
  901. ret = _regmap_write(map, regs[i].reg, regs[i].def);
  902. if (ret != 0) {
  903. dev_err(map->dev, "Failed to write %x = %x: %d\n",
  904. regs[i].reg, regs[i].def, ret);
  905. goto out;
  906. }
  907. }
  908. map->patch = kcalloc(num_regs, sizeof(struct reg_default), GFP_KERNEL);
  909. if (map->patch != NULL) {
  910. memcpy(map->patch, regs,
  911. num_regs * sizeof(struct reg_default));
  912. map->patch_regs = num_regs;
  913. } else {
  914. ret = -ENOMEM;
  915. }
  916. out:
  917. map->cache_bypass = bypass;
  918. map->unlock(map);
  919. return ret;
  920. }
  921. EXPORT_SYMBOL_GPL(regmap_register_patch);
  922. /*
  923. * regmap_get_val_bytes(): Report the size of a register value
  924. *
  925. * Report the size of a register value, mainly intended to for use by
  926. * generic infrastructure built on top of regmap.
  927. */
  928. int regmap_get_val_bytes(struct regmap *map)
  929. {
  930. if (map->format.format_write)
  931. return -EINVAL;
  932. return map->format.val_bytes;
  933. }
  934. EXPORT_SYMBOL_GPL(regmap_get_val_bytes);
  935. static int __init regmap_initcall(void)
  936. {
  937. regmap_debugfs_initcall();
  938. return 0;
  939. }
  940. postcore_initcall(regmap_initcall);