regmap.c 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122
  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.buf_size = (config->reg_bits + config->val_bits) / 8;
  197. map->format.reg_bytes = DIV_ROUND_UP(config->reg_bits, 8);
  198. map->format.pad_bytes = config->pad_bits / 8;
  199. map->format.val_bytes = DIV_ROUND_UP(config->val_bits, 8);
  200. map->format.buf_size += map->format.pad_bytes;
  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_free_workbuf;
  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_free_workbuf:
  316. kfree(map->work_buf);
  317. err_map:
  318. kfree(map);
  319. err:
  320. return ERR_PTR(ret);
  321. }
  322. EXPORT_SYMBOL_GPL(regmap_init);
  323. static void devm_regmap_release(struct device *dev, void *res)
  324. {
  325. regmap_exit(*(struct regmap **)res);
  326. }
  327. /**
  328. * devm_regmap_init(): Initialise managed register map
  329. *
  330. * @dev: Device that will be interacted with
  331. * @bus: Bus-specific callbacks to use with device
  332. * @bus_context: Data passed to bus-specific callbacks
  333. * @config: Configuration for register map
  334. *
  335. * The return value will be an ERR_PTR() on error or a valid pointer
  336. * to a struct regmap. This function should generally not be called
  337. * directly, it should be called by bus-specific init functions. The
  338. * map will be automatically freed by the device management code.
  339. */
  340. struct regmap *devm_regmap_init(struct device *dev,
  341. const struct regmap_bus *bus,
  342. void *bus_context,
  343. const struct regmap_config *config)
  344. {
  345. struct regmap **ptr, *regmap;
  346. ptr = devres_alloc(devm_regmap_release, sizeof(*ptr), GFP_KERNEL);
  347. if (!ptr)
  348. return ERR_PTR(-ENOMEM);
  349. regmap = regmap_init(dev, bus, bus_context, config);
  350. if (!IS_ERR(regmap)) {
  351. *ptr = regmap;
  352. devres_add(dev, ptr);
  353. } else {
  354. devres_free(ptr);
  355. }
  356. return regmap;
  357. }
  358. EXPORT_SYMBOL_GPL(devm_regmap_init);
  359. /**
  360. * regmap_reinit_cache(): Reinitialise the current register cache
  361. *
  362. * @map: Register map to operate on.
  363. * @config: New configuration. Only the cache data will be used.
  364. *
  365. * Discard any existing register cache for the map and initialize a
  366. * new cache. This can be used to restore the cache to defaults or to
  367. * update the cache configuration to reflect runtime discovery of the
  368. * hardware.
  369. */
  370. int regmap_reinit_cache(struct regmap *map, const struct regmap_config *config)
  371. {
  372. int ret;
  373. map->lock(map);
  374. regcache_exit(map);
  375. regmap_debugfs_exit(map);
  376. map->max_register = config->max_register;
  377. map->writeable_reg = config->writeable_reg;
  378. map->readable_reg = config->readable_reg;
  379. map->volatile_reg = config->volatile_reg;
  380. map->precious_reg = config->precious_reg;
  381. map->cache_type = config->cache_type;
  382. regmap_debugfs_init(map, config->name);
  383. map->cache_bypass = false;
  384. map->cache_only = false;
  385. ret = regcache_init(map, config);
  386. map->unlock(map);
  387. return ret;
  388. }
  389. /**
  390. * regmap_exit(): Free a previously allocated register map
  391. */
  392. void regmap_exit(struct regmap *map)
  393. {
  394. regcache_exit(map);
  395. regmap_debugfs_exit(map);
  396. if (map->bus->free_context)
  397. map->bus->free_context(map->bus_context);
  398. kfree(map->work_buf);
  399. kfree(map);
  400. }
  401. EXPORT_SYMBOL_GPL(regmap_exit);
  402. static int dev_get_regmap_match(struct device *dev, void *res, void *data)
  403. {
  404. struct regmap **r = res;
  405. if (!r || !*r) {
  406. WARN_ON(!r || !*r);
  407. return 0;
  408. }
  409. /* If the user didn't specify a name match any */
  410. if (data)
  411. return (*r)->name == data;
  412. else
  413. return 1;
  414. }
  415. /**
  416. * dev_get_regmap(): Obtain the regmap (if any) for a device
  417. *
  418. * @dev: Device to retrieve the map for
  419. * @name: Optional name for the register map, usually NULL.
  420. *
  421. * Returns the regmap for the device if one is present, or NULL. If
  422. * name is specified then it must match the name specified when
  423. * registering the device, if it is NULL then the first regmap found
  424. * will be used. Devices with multiple register maps are very rare,
  425. * generic code should normally not need to specify a name.
  426. */
  427. struct regmap *dev_get_regmap(struct device *dev, const char *name)
  428. {
  429. struct regmap **r = devres_find(dev, dev_get_regmap_release,
  430. dev_get_regmap_match, (void *)name);
  431. if (!r)
  432. return NULL;
  433. return *r;
  434. }
  435. EXPORT_SYMBOL_GPL(dev_get_regmap);
  436. static int _regmap_raw_write(struct regmap *map, unsigned int reg,
  437. const void *val, size_t val_len)
  438. {
  439. u8 *u8 = map->work_buf;
  440. void *buf;
  441. int ret = -ENOTSUPP;
  442. size_t len;
  443. int i;
  444. /* Check for unwritable registers before we start */
  445. if (map->writeable_reg)
  446. for (i = 0; i < val_len / map->format.val_bytes; i++)
  447. if (!map->writeable_reg(map->dev,
  448. reg + (i * map->reg_stride)))
  449. return -EINVAL;
  450. if (!map->cache_bypass && map->format.parse_val) {
  451. unsigned int ival;
  452. int val_bytes = map->format.val_bytes;
  453. for (i = 0; i < val_len / val_bytes; i++) {
  454. memcpy(map->work_buf, val + (i * val_bytes), val_bytes);
  455. ival = map->format.parse_val(map->work_buf);
  456. ret = regcache_write(map, reg + (i * map->reg_stride),
  457. ival);
  458. if (ret) {
  459. dev_err(map->dev,
  460. "Error in caching of register: %u ret: %d\n",
  461. reg + i, ret);
  462. return ret;
  463. }
  464. }
  465. if (map->cache_only) {
  466. map->cache_dirty = true;
  467. return 0;
  468. }
  469. }
  470. map->format.format_reg(map->work_buf, reg, map->reg_shift);
  471. u8[0] |= map->write_flag_mask;
  472. trace_regmap_hw_write_start(map->dev, reg,
  473. val_len / map->format.val_bytes);
  474. /* If we're doing a single register write we can probably just
  475. * send the work_buf directly, otherwise try to do a gather
  476. * write.
  477. */
  478. if (val == (map->work_buf + map->format.pad_bytes +
  479. map->format.reg_bytes))
  480. ret = map->bus->write(map->bus_context, map->work_buf,
  481. map->format.reg_bytes +
  482. map->format.pad_bytes +
  483. val_len);
  484. else if (map->bus->gather_write)
  485. ret = map->bus->gather_write(map->bus_context, map->work_buf,
  486. map->format.reg_bytes +
  487. map->format.pad_bytes,
  488. val, val_len);
  489. /* If that didn't work fall back on linearising by hand. */
  490. if (ret == -ENOTSUPP) {
  491. len = map->format.reg_bytes + map->format.pad_bytes + val_len;
  492. buf = kzalloc(len, GFP_KERNEL);
  493. if (!buf)
  494. return -ENOMEM;
  495. memcpy(buf, map->work_buf, map->format.reg_bytes);
  496. memcpy(buf + map->format.reg_bytes + map->format.pad_bytes,
  497. val, val_len);
  498. ret = map->bus->write(map->bus_context, buf, len);
  499. kfree(buf);
  500. }
  501. trace_regmap_hw_write_done(map->dev, reg,
  502. val_len / map->format.val_bytes);
  503. return ret;
  504. }
  505. int _regmap_write(struct regmap *map, unsigned int reg,
  506. unsigned int val)
  507. {
  508. int ret;
  509. BUG_ON(!map->format.format_write && !map->format.format_val);
  510. if (!map->cache_bypass && map->format.format_write) {
  511. ret = regcache_write(map, reg, val);
  512. if (ret != 0)
  513. return ret;
  514. if (map->cache_only) {
  515. map->cache_dirty = true;
  516. return 0;
  517. }
  518. }
  519. trace_regmap_reg_write(map->dev, reg, val);
  520. if (map->format.format_write) {
  521. map->format.format_write(map, reg, val);
  522. trace_regmap_hw_write_start(map->dev, reg, 1);
  523. ret = map->bus->write(map->bus_context, map->work_buf,
  524. map->format.buf_size);
  525. trace_regmap_hw_write_done(map->dev, reg, 1);
  526. return ret;
  527. } else {
  528. map->format.format_val(map->work_buf + map->format.reg_bytes
  529. + map->format.pad_bytes, val, 0);
  530. return _regmap_raw_write(map, reg,
  531. map->work_buf +
  532. map->format.reg_bytes +
  533. map->format.pad_bytes,
  534. map->format.val_bytes);
  535. }
  536. }
  537. /**
  538. * regmap_write(): Write a value to a single register
  539. *
  540. * @map: Register map to write to
  541. * @reg: Register to write to
  542. * @val: Value to be written
  543. *
  544. * A value of zero will be returned on success, a negative errno will
  545. * be returned in error cases.
  546. */
  547. int regmap_write(struct regmap *map, unsigned int reg, unsigned int val)
  548. {
  549. int ret;
  550. if (reg % map->reg_stride)
  551. return -EINVAL;
  552. map->lock(map);
  553. ret = _regmap_write(map, reg, val);
  554. map->unlock(map);
  555. return ret;
  556. }
  557. EXPORT_SYMBOL_GPL(regmap_write);
  558. /**
  559. * regmap_raw_write(): Write raw values to one or more registers
  560. *
  561. * @map: Register map to write to
  562. * @reg: Initial register to write to
  563. * @val: Block of data to be written, laid out for direct transmission to the
  564. * device
  565. * @val_len: Length of data pointed to by val.
  566. *
  567. * This function is intended to be used for things like firmware
  568. * download where a large block of data needs to be transferred to the
  569. * device. No formatting will be done on the data provided.
  570. *
  571. * A value of zero will be returned on success, a negative errno will
  572. * be returned in error cases.
  573. */
  574. int regmap_raw_write(struct regmap *map, unsigned int reg,
  575. const void *val, size_t val_len)
  576. {
  577. int ret;
  578. if (val_len % map->format.val_bytes)
  579. return -EINVAL;
  580. if (reg % map->reg_stride)
  581. return -EINVAL;
  582. map->lock(map);
  583. ret = _regmap_raw_write(map, reg, val, val_len);
  584. map->unlock(map);
  585. return ret;
  586. }
  587. EXPORT_SYMBOL_GPL(regmap_raw_write);
  588. /*
  589. * regmap_bulk_write(): Write multiple registers to the device
  590. *
  591. * @map: Register map to write to
  592. * @reg: First register to be write from
  593. * @val: Block of data to be written, in native register size for device
  594. * @val_count: Number of registers to write
  595. *
  596. * This function is intended to be used for writing a large block of
  597. * data to be device either in single transfer or multiple transfer.
  598. *
  599. * A value of zero will be returned on success, a negative errno will
  600. * be returned in error cases.
  601. */
  602. int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
  603. size_t val_count)
  604. {
  605. int ret = 0, i;
  606. size_t val_bytes = map->format.val_bytes;
  607. void *wval;
  608. if (!map->format.parse_val)
  609. return -EINVAL;
  610. if (reg % map->reg_stride)
  611. return -EINVAL;
  612. map->lock(map);
  613. /* No formatting is require if val_byte is 1 */
  614. if (val_bytes == 1) {
  615. wval = (void *)val;
  616. } else {
  617. wval = kmemdup(val, val_count * val_bytes, GFP_KERNEL);
  618. if (!wval) {
  619. ret = -ENOMEM;
  620. dev_err(map->dev, "Error in memory allocation\n");
  621. goto out;
  622. }
  623. for (i = 0; i < val_count * val_bytes; i += val_bytes)
  624. map->format.parse_val(wval + i);
  625. }
  626. /*
  627. * Some devices does not support bulk write, for
  628. * them we have a series of single write operations.
  629. */
  630. if (map->use_single_rw) {
  631. for (i = 0; i < val_count; i++) {
  632. ret = regmap_raw_write(map,
  633. reg + (i * map->reg_stride),
  634. val + (i * val_bytes),
  635. val_bytes);
  636. if (ret != 0)
  637. return ret;
  638. }
  639. } else {
  640. ret = _regmap_raw_write(map, reg, wval, val_bytes * val_count);
  641. }
  642. if (val_bytes != 1)
  643. kfree(wval);
  644. out:
  645. map->unlock(map);
  646. return ret;
  647. }
  648. EXPORT_SYMBOL_GPL(regmap_bulk_write);
  649. static int _regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
  650. unsigned int val_len)
  651. {
  652. u8 *u8 = map->work_buf;
  653. int ret;
  654. map->format.format_reg(map->work_buf, reg, map->reg_shift);
  655. /*
  656. * Some buses or devices flag reads by setting the high bits in the
  657. * register addresss; since it's always the high bits for all
  658. * current formats we can do this here rather than in
  659. * formatting. This may break if we get interesting formats.
  660. */
  661. u8[0] |= map->read_flag_mask;
  662. trace_regmap_hw_read_start(map->dev, reg,
  663. val_len / map->format.val_bytes);
  664. ret = map->bus->read(map->bus_context, map->work_buf,
  665. map->format.reg_bytes + map->format.pad_bytes,
  666. val, val_len);
  667. trace_regmap_hw_read_done(map->dev, reg,
  668. val_len / map->format.val_bytes);
  669. return ret;
  670. }
  671. static int _regmap_read(struct regmap *map, unsigned int reg,
  672. unsigned int *val)
  673. {
  674. int ret;
  675. if (!map->cache_bypass) {
  676. ret = regcache_read(map, reg, val);
  677. if (ret == 0)
  678. return 0;
  679. }
  680. if (!map->format.parse_val)
  681. return -EINVAL;
  682. if (map->cache_only)
  683. return -EBUSY;
  684. ret = _regmap_raw_read(map, reg, map->work_buf, map->format.val_bytes);
  685. if (ret == 0) {
  686. *val = map->format.parse_val(map->work_buf);
  687. trace_regmap_reg_read(map->dev, reg, *val);
  688. }
  689. if (ret == 0 && !map->cache_bypass)
  690. regcache_write(map, reg, *val);
  691. return ret;
  692. }
  693. /**
  694. * regmap_read(): Read a value from a single register
  695. *
  696. * @map: Register map to write to
  697. * @reg: Register to be read from
  698. * @val: Pointer to store read value
  699. *
  700. * A value of zero will be returned on success, a negative errno will
  701. * be returned in error cases.
  702. */
  703. int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val)
  704. {
  705. int ret;
  706. if (reg % map->reg_stride)
  707. return -EINVAL;
  708. map->lock(map);
  709. ret = _regmap_read(map, reg, val);
  710. map->unlock(map);
  711. return ret;
  712. }
  713. EXPORT_SYMBOL_GPL(regmap_read);
  714. /**
  715. * regmap_raw_read(): Read raw data from the device
  716. *
  717. * @map: Register map to write to
  718. * @reg: First register to be read from
  719. * @val: Pointer to store read value
  720. * @val_len: Size of data to read
  721. *
  722. * A value of zero will be returned on success, a negative errno will
  723. * be returned in error cases.
  724. */
  725. int regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
  726. size_t val_len)
  727. {
  728. size_t val_bytes = map->format.val_bytes;
  729. size_t val_count = val_len / val_bytes;
  730. unsigned int v;
  731. int ret, i;
  732. if (val_len % map->format.val_bytes)
  733. return -EINVAL;
  734. if (reg % map->reg_stride)
  735. return -EINVAL;
  736. map->lock(map);
  737. if (regmap_volatile_range(map, reg, val_count) || map->cache_bypass ||
  738. map->cache_type == REGCACHE_NONE) {
  739. /* Physical block read if there's no cache involved */
  740. ret = _regmap_raw_read(map, reg, val, val_len);
  741. } else {
  742. /* Otherwise go word by word for the cache; should be low
  743. * cost as we expect to hit the cache.
  744. */
  745. for (i = 0; i < val_count; i++) {
  746. ret = _regmap_read(map, reg + (i * map->reg_stride),
  747. &v);
  748. if (ret != 0)
  749. goto out;
  750. map->format.format_val(val + (i * val_bytes), v, 0);
  751. }
  752. }
  753. out:
  754. map->unlock(map);
  755. return ret;
  756. }
  757. EXPORT_SYMBOL_GPL(regmap_raw_read);
  758. /**
  759. * regmap_bulk_read(): Read multiple registers from the device
  760. *
  761. * @map: Register map to write to
  762. * @reg: First register to be read from
  763. * @val: Pointer to store read value, in native register size for device
  764. * @val_count: Number of registers to read
  765. *
  766. * A value of zero will be returned on success, a negative errno will
  767. * be returned in error cases.
  768. */
  769. int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
  770. size_t val_count)
  771. {
  772. int ret, i;
  773. size_t val_bytes = map->format.val_bytes;
  774. bool vol = regmap_volatile_range(map, reg, val_count);
  775. if (!map->format.parse_val)
  776. return -EINVAL;
  777. if (reg % map->reg_stride)
  778. return -EINVAL;
  779. if (vol || map->cache_type == REGCACHE_NONE) {
  780. /*
  781. * Some devices does not support bulk read, for
  782. * them we have a series of single read operations.
  783. */
  784. if (map->use_single_rw) {
  785. for (i = 0; i < val_count; i++) {
  786. ret = regmap_raw_read(map,
  787. reg + (i * map->reg_stride),
  788. val + (i * val_bytes),
  789. val_bytes);
  790. if (ret != 0)
  791. return ret;
  792. }
  793. } else {
  794. ret = regmap_raw_read(map, reg, val,
  795. val_bytes * val_count);
  796. if (ret != 0)
  797. return ret;
  798. }
  799. for (i = 0; i < val_count * val_bytes; i += val_bytes)
  800. map->format.parse_val(val + i);
  801. } else {
  802. for (i = 0; i < val_count; i++) {
  803. unsigned int ival;
  804. ret = regmap_read(map, reg + (i * map->reg_stride),
  805. &ival);
  806. if (ret != 0)
  807. return ret;
  808. memcpy(val + (i * val_bytes), &ival, val_bytes);
  809. }
  810. }
  811. return 0;
  812. }
  813. EXPORT_SYMBOL_GPL(regmap_bulk_read);
  814. static int _regmap_update_bits(struct regmap *map, unsigned int reg,
  815. unsigned int mask, unsigned int val,
  816. bool *change)
  817. {
  818. int ret;
  819. unsigned int tmp, orig;
  820. map->lock(map);
  821. ret = _regmap_read(map, reg, &orig);
  822. if (ret != 0)
  823. goto out;
  824. tmp = orig & ~mask;
  825. tmp |= val & mask;
  826. if (tmp != orig) {
  827. ret = _regmap_write(map, reg, tmp);
  828. *change = true;
  829. } else {
  830. *change = false;
  831. }
  832. out:
  833. map->unlock(map);
  834. return ret;
  835. }
  836. /**
  837. * regmap_update_bits: Perform a read/modify/write cycle on the register map
  838. *
  839. * @map: Register map to update
  840. * @reg: Register to update
  841. * @mask: Bitmask to change
  842. * @val: New value for bitmask
  843. *
  844. * Returns zero for success, a negative number on error.
  845. */
  846. int regmap_update_bits(struct regmap *map, unsigned int reg,
  847. unsigned int mask, unsigned int val)
  848. {
  849. bool change;
  850. return _regmap_update_bits(map, reg, mask, val, &change);
  851. }
  852. EXPORT_SYMBOL_GPL(regmap_update_bits);
  853. /**
  854. * regmap_update_bits_check: Perform a read/modify/write cycle on the
  855. * register map and report if updated
  856. *
  857. * @map: Register map to update
  858. * @reg: Register to update
  859. * @mask: Bitmask to change
  860. * @val: New value for bitmask
  861. * @change: Boolean indicating if a write was done
  862. *
  863. * Returns zero for success, a negative number on error.
  864. */
  865. int regmap_update_bits_check(struct regmap *map, unsigned int reg,
  866. unsigned int mask, unsigned int val,
  867. bool *change)
  868. {
  869. return _regmap_update_bits(map, reg, mask, val, change);
  870. }
  871. EXPORT_SYMBOL_GPL(regmap_update_bits_check);
  872. /**
  873. * regmap_register_patch: Register and apply register updates to be applied
  874. * on device initialistion
  875. *
  876. * @map: Register map to apply updates to.
  877. * @regs: Values to update.
  878. * @num_regs: Number of entries in regs.
  879. *
  880. * Register a set of register updates to be applied to the device
  881. * whenever the device registers are synchronised with the cache and
  882. * apply them immediately. Typically this is used to apply
  883. * corrections to be applied to the device defaults on startup, such
  884. * as the updates some vendors provide to undocumented registers.
  885. */
  886. int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
  887. int num_regs)
  888. {
  889. int i, ret;
  890. bool bypass;
  891. /* If needed the implementation can be extended to support this */
  892. if (map->patch)
  893. return -EBUSY;
  894. map->lock(map);
  895. bypass = map->cache_bypass;
  896. map->cache_bypass = true;
  897. /* Write out first; it's useful to apply even if we fail later. */
  898. for (i = 0; i < num_regs; i++) {
  899. ret = _regmap_write(map, regs[i].reg, regs[i].def);
  900. if (ret != 0) {
  901. dev_err(map->dev, "Failed to write %x = %x: %d\n",
  902. regs[i].reg, regs[i].def, ret);
  903. goto out;
  904. }
  905. }
  906. map->patch = kcalloc(num_regs, sizeof(struct reg_default), GFP_KERNEL);
  907. if (map->patch != NULL) {
  908. memcpy(map->patch, regs,
  909. num_regs * sizeof(struct reg_default));
  910. map->patch_regs = num_regs;
  911. } else {
  912. ret = -ENOMEM;
  913. }
  914. out:
  915. map->cache_bypass = bypass;
  916. map->unlock(map);
  917. return ret;
  918. }
  919. EXPORT_SYMBOL_GPL(regmap_register_patch);
  920. /*
  921. * regmap_get_val_bytes(): Report the size of a register value
  922. *
  923. * Report the size of a register value, mainly intended to for use by
  924. * generic infrastructure built on top of regmap.
  925. */
  926. int regmap_get_val_bytes(struct regmap *map)
  927. {
  928. if (map->format.format_write)
  929. return -EINVAL;
  930. return map->format.val_bytes;
  931. }
  932. EXPORT_SYMBOL_GPL(regmap_get_val_bytes);
  933. static int __init regmap_initcall(void)
  934. {
  935. regmap_debugfs_initcall();
  936. return 0;
  937. }
  938. postcore_initcall(regmap_initcall);