regmap: Use a local header for API internals
[deliverable/linux.git] / drivers / base / regmap / regmap.c
CommitLineData
b83a313b
MB
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
13#include <linux/slab.h>
14#include <linux/module.h>
15#include <linux/mutex.h>
16#include <linux/err.h>
17
fb2736bb
MB
18#define CREATE_TRACE_POINTS
19#include <trace/events/regmap.h>
20
93de9124 21#include "internal.h"
b83a313b
MB
22
23static void regmap_format_4_12_write(struct regmap *map,
24 unsigned int reg, unsigned int val)
25{
26 __be16 *out = map->work_buf;
27 *out = cpu_to_be16((reg << 12) | val);
28}
29
30static void regmap_format_7_9_write(struct regmap *map,
31 unsigned int reg, unsigned int val)
32{
33 __be16 *out = map->work_buf;
34 *out = cpu_to_be16((reg << 9) | val);
35}
36
37static void regmap_format_8(void *buf, unsigned int val)
38{
39 u8 *b = buf;
40
41 b[0] = val;
42}
43
44static void regmap_format_16(void *buf, unsigned int val)
45{
46 __be16 *b = buf;
47
48 b[0] = cpu_to_be16(val);
49}
50
51static unsigned int regmap_parse_8(void *buf)
52{
53 u8 *b = buf;
54
55 return b[0];
56}
57
58static unsigned int regmap_parse_16(void *buf)
59{
60 __be16 *b = buf;
61
62 b[0] = be16_to_cpu(b[0]);
63
64 return b[0];
65}
66
67/**
68 * regmap_init(): Initialise register map
69 *
70 * @dev: Device that will be interacted with
71 * @bus: Bus-specific callbacks to use with device
72 * @config: Configuration for register map
73 *
74 * The return value will be an ERR_PTR() on error or a valid pointer to
75 * a struct regmap. This function should generally not be called
76 * directly, it should be called by bus-specific init functions.
77 */
78struct regmap *regmap_init(struct device *dev,
79 const struct regmap_bus *bus,
80 const struct regmap_config *config)
81{
82 struct regmap *map;
83 int ret = -EINVAL;
84
85 if (!bus || !config)
86 return NULL;
87
88 map = kzalloc(sizeof(*map), GFP_KERNEL);
89 if (map == NULL) {
90 ret = -ENOMEM;
91 goto err;
92 }
93
94 mutex_init(&map->lock);
95 map->format.buf_size = (config->reg_bits + config->val_bits) / 8;
96 map->format.reg_bytes = config->reg_bits / 8;
97 map->format.val_bytes = config->val_bits / 8;
98 map->dev = dev;
99 map->bus = bus;
2e2ae66d
MB
100 map->max_register = config->max_register;
101 map->writeable_reg = config->writeable_reg;
102 map->readable_reg = config->readable_reg;
103 map->volatile_reg = config->volatile_reg;
b83a313b
MB
104
105 switch (config->reg_bits) {
106 case 4:
107 switch (config->val_bits) {
108 case 12:
109 map->format.format_write = regmap_format_4_12_write;
110 break;
111 default:
112 goto err_map;
113 }
114 break;
115
116 case 7:
117 switch (config->val_bits) {
118 case 9:
119 map->format.format_write = regmap_format_7_9_write;
120 break;
121 default:
122 goto err_map;
123 }
124 break;
125
126 case 8:
127 map->format.format_reg = regmap_format_8;
128 break;
129
130 case 16:
131 map->format.format_reg = regmap_format_16;
132 break;
133
134 default:
135 goto err_map;
136 }
137
138 switch (config->val_bits) {
139 case 8:
140 map->format.format_val = regmap_format_8;
141 map->format.parse_val = regmap_parse_8;
142 break;
143 case 16:
144 map->format.format_val = regmap_format_16;
145 map->format.parse_val = regmap_parse_16;
146 break;
147 }
148
149 if (!map->format.format_write &&
150 !(map->format.format_reg && map->format.format_val))
151 goto err_map;
152
153 map->work_buf = kmalloc(map->format.buf_size, GFP_KERNEL);
154 if (map->work_buf == NULL) {
155 ret = -ENOMEM;
156 goto err_bus;
157 }
158
159 return map;
160
161err_bus:
162 module_put(map->bus->owner);
163err_map:
164 kfree(map);
165err:
166 return ERR_PTR(ret);
167}
168EXPORT_SYMBOL_GPL(regmap_init);
169
170/**
171 * regmap_exit(): Free a previously allocated register map
172 */
173void regmap_exit(struct regmap *map)
174{
175 kfree(map->work_buf);
176 module_put(map->bus->owner);
177 kfree(map);
178}
179EXPORT_SYMBOL_GPL(regmap_exit);
180
181static int _regmap_raw_write(struct regmap *map, unsigned int reg,
182 const void *val, size_t val_len)
183{
184 void *buf;
185 int ret = -ENOTSUPP;
186 size_t len;
73304781
MB
187 int i;
188
189 /* Check for unwritable registers before we start */
190 if (map->writeable_reg)
191 for (i = 0; i < val_len / map->format.val_bytes; i++)
192 if (!map->writeable_reg(map->dev, reg + i))
193 return -EINVAL;
b83a313b
MB
194
195 map->format.format_reg(map->work_buf, reg);
196
fb2736bb
MB
197 trace_regmap_hw_write_start(map->dev, reg,
198 val_len / map->format.val_bytes);
199
2547e201
MB
200 /* If we're doing a single register write we can probably just
201 * send the work_buf directly, otherwise try to do a gather
202 * write.
203 */
204 if (val == map->work_buf + map->format.reg_bytes)
205 ret = map->bus->write(map->dev, map->work_buf,
206 map->format.reg_bytes + val_len);
207 else if (map->bus->gather_write)
b83a313b
MB
208 ret = map->bus->gather_write(map->dev, map->work_buf,
209 map->format.reg_bytes,
210 val, val_len);
211
2547e201 212 /* If that didn't work fall back on linearising by hand. */
b83a313b
MB
213 if (ret == -ENOTSUPP) {
214 len = map->format.reg_bytes + val_len;
215 buf = kmalloc(len, GFP_KERNEL);
216 if (!buf)
217 return -ENOMEM;
218
219 memcpy(buf, map->work_buf, map->format.reg_bytes);
220 memcpy(buf + map->format.reg_bytes, val, val_len);
221 ret = map->bus->write(map->dev, buf, len);
222
223 kfree(buf);
224 }
225
fb2736bb
MB
226 trace_regmap_hw_write_done(map->dev, reg,
227 val_len / map->format.val_bytes);
228
b83a313b
MB
229 return ret;
230}
231
232static int _regmap_write(struct regmap *map, unsigned int reg,
233 unsigned int val)
234{
fb2736bb 235 int ret;
b83a313b
MB
236 BUG_ON(!map->format.format_write && !map->format.format_val);
237
fb2736bb
MB
238 trace_regmap_reg_write(map->dev, reg, val);
239
b83a313b
MB
240 if (map->format.format_write) {
241 map->format.format_write(map, reg, val);
242
fb2736bb
MB
243 trace_regmap_hw_write_start(map->dev, reg, 1);
244
245 ret = map->bus->write(map->dev, map->work_buf,
246 map->format.buf_size);
247
248 trace_regmap_hw_write_done(map->dev, reg, 1);
249
250 return ret;
b83a313b
MB
251 } else {
252 map->format.format_val(map->work_buf + map->format.reg_bytes,
253 val);
254 return _regmap_raw_write(map, reg,
255 map->work_buf + map->format.reg_bytes,
256 map->format.val_bytes);
257 }
258}
259
260/**
261 * regmap_write(): Write a value to a single register
262 *
263 * @map: Register map to write to
264 * @reg: Register to write to
265 * @val: Value to be written
266 *
267 * A value of zero will be returned on success, a negative errno will
268 * be returned in error cases.
269 */
270int regmap_write(struct regmap *map, unsigned int reg, unsigned int val)
271{
272 int ret;
273
274 mutex_lock(&map->lock);
275
276 ret = _regmap_write(map, reg, val);
277
278 mutex_unlock(&map->lock);
279
280 return ret;
281}
282EXPORT_SYMBOL_GPL(regmap_write);
283
284/**
285 * regmap_raw_write(): Write raw values to one or more registers
286 *
287 * @map: Register map to write to
288 * @reg: Initial register to write to
289 * @val: Block of data to be written, laid out for direct transmission to the
290 * device
291 * @val_len: Length of data pointed to by val.
292 *
293 * This function is intended to be used for things like firmware
294 * download where a large block of data needs to be transferred to the
295 * device. No formatting will be done on the data provided.
296 *
297 * A value of zero will be returned on success, a negative errno will
298 * be returned in error cases.
299 */
300int regmap_raw_write(struct regmap *map, unsigned int reg,
301 const void *val, size_t val_len)
302{
303 int ret;
304
305 mutex_lock(&map->lock);
306
307 ret = _regmap_raw_write(map, reg, val, val_len);
308
309 mutex_unlock(&map->lock);
310
311 return ret;
312}
313EXPORT_SYMBOL_GPL(regmap_raw_write);
314
315static int _regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
316 unsigned int val_len)
317{
318 u8 *u8 = map->work_buf;
319 int ret;
320
321 map->format.format_reg(map->work_buf, reg);
322
323 /*
324 * Some buses flag reads by setting the high bits in the
325 * register addresss; since it's always the high bits for all
326 * current formats we can do this here rather than in
327 * formatting. This may break if we get interesting formats.
328 */
329 if (map->bus->read_flag_mask)
330 u8[0] |= map->bus->read_flag_mask;
331
fb2736bb
MB
332 trace_regmap_hw_read_start(map->dev, reg,
333 val_len / map->format.val_bytes);
334
b83a313b 335 ret = map->bus->read(map->dev, map->work_buf, map->format.reg_bytes,
40c5cc26 336 val, val_len);
b83a313b 337
fb2736bb
MB
338 trace_regmap_hw_read_done(map->dev, reg,
339 val_len / map->format.val_bytes);
340
341 return ret;
b83a313b
MB
342}
343
344static int _regmap_read(struct regmap *map, unsigned int reg,
345 unsigned int *val)
346{
347 int ret;
348
349 if (!map->format.parse_val)
350 return -EINVAL;
351
352 ret = _regmap_raw_read(map, reg, map->work_buf, map->format.val_bytes);
fb2736bb 353 if (ret == 0) {
b83a313b 354 *val = map->format.parse_val(map->work_buf);
fb2736bb
MB
355 trace_regmap_reg_read(map->dev, reg, *val);
356 }
b83a313b
MB
357
358 return ret;
359}
360
361/**
362 * regmap_read(): Read a value from a single register
363 *
364 * @map: Register map to write to
365 * @reg: Register to be read from
366 * @val: Pointer to store read value
367 *
368 * A value of zero will be returned on success, a negative errno will
369 * be returned in error cases.
370 */
371int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val)
372{
373 int ret;
374
375 mutex_lock(&map->lock);
376
377 ret = _regmap_read(map, reg, val);
378
379 mutex_unlock(&map->lock);
380
381 return ret;
382}
383EXPORT_SYMBOL_GPL(regmap_read);
384
385/**
386 * regmap_raw_read(): Read raw data from the device
387 *
388 * @map: Register map to write to
389 * @reg: First register to be read from
390 * @val: Pointer to store read value
391 * @val_len: Size of data to read
392 *
393 * A value of zero will be returned on success, a negative errno will
394 * be returned in error cases.
395 */
396int regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
397 size_t val_len)
398{
399 int ret;
400
401 mutex_lock(&map->lock);
402
403 ret = _regmap_raw_read(map, reg, val, val_len);
404
405 mutex_unlock(&map->lock);
406
407 return ret;
408}
409EXPORT_SYMBOL_GPL(regmap_raw_read);
410
411/**
412 * regmap_bulk_read(): Read multiple registers from the device
413 *
414 * @map: Register map to write to
415 * @reg: First register to be read from
416 * @val: Pointer to store read value, in native register size for device
417 * @val_count: Number of registers to read
418 *
419 * A value of zero will be returned on success, a negative errno will
420 * be returned in error cases.
421 */
422int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
423 size_t val_count)
424{
425 int ret, i;
426 size_t val_bytes = map->format.val_bytes;
427
428 if (!map->format.parse_val)
429 return -EINVAL;
430
431 ret = regmap_raw_read(map, reg, val, val_bytes * val_count);
432 if (ret != 0)
433 return ret;
434
435 for (i = 0; i < val_count * val_bytes; i += val_bytes)
436 map->format.parse_val(val + i);
437
438 return 0;
439}
440EXPORT_SYMBOL_GPL(regmap_bulk_read);
441
442/**
443 * remap_update_bits: Perform a read/modify/write cycle on the register map
444 *
445 * @map: Register map to update
446 * @reg: Register to update
447 * @mask: Bitmask to change
448 * @val: New value for bitmask
449 *
450 * Returns zero for success, a negative number on error.
451 */
452int regmap_update_bits(struct regmap *map, unsigned int reg,
453 unsigned int mask, unsigned int val)
454{
455 int ret;
456 unsigned int tmp;
457
458 mutex_lock(&map->lock);
459
460 ret = _regmap_read(map, reg, &tmp);
461 if (ret != 0)
462 goto out;
463
464 tmp &= ~mask;
465 tmp |= val & mask;
466
467 ret = _regmap_write(map, reg, tmp);
468
469out:
470 mutex_unlock(&map->lock);
471
472 return ret;
473}
474EXPORT_SYMBOL_GPL(regmap_update_bits);
This page took 0.051036 seconds and 5 git commands to generate.