[TOC]

drivers/base/regmap Register Map API (Register Map API) 统一硬件寄存器访问接口

历史与背景

这项技术是为了解决什么特定问题而诞生的?

drivers/base/regmap 目录中的代码实现了内核的“寄存器映射”(Register Map)API。这项技术的诞生是为了解决设备驱动程序中一个普遍存在的代码冗余和缺乏抽象的问题,特别是在通过I2C、SPI或内存映射I/O(MMIO)等简单总线访问硬件寄存器时。

regmap出现之前,每个驱动程序都需要手动编写自己的底层I/O函数来与硬件通信。这导致了以下问题:

  • 大量代码重复:几乎每个I2C/SPI设备驱动都包含着几乎相同的逻辑来构造消息、执行传输、检查错误。例如,通过I2C读取一个16位寄存器的代码在无数个驱动中被重复实现。
  • 缺乏总线无关性:如果一个芯片(如音频编解码器)同时有I2C和SPI两种接口版本,开发者往往需要为它们编写两个几乎独立但I/O部分完全不同的驱动程序,或者在一个驱动中用大量的 if/else 来处理,这使得代码难以维护。
  • 复杂功能难以实现和统一:像寄存器值缓存(caching)、安全的“读-改-写”(read-modify-write)原子操作、处理易失性(volatile)寄存器等高级功能,都需要每个驱动自行实现。这不仅增加了驱动的复杂性,也导致了实现质量的参差不齐,容易引入bug。
  • 维护困难:底层总线API的任何改动都可能需要修改大量驱动程序。

regmap框架的出现,就是为了提供一个统一的、抽象的中间层,将驱动程序的设备逻辑与底层总线的具体实现分离开来。

它的发展经历了哪些重要的里程碑或版本迭代?

regmap 框架源于内核开发者们在处理大量音频编解码器(Audio Codec)驱动时观察到的重复模式。

  • 概念提出:该框架由Wolfson Microelectronics的开发者Mark Brown主导设计和实现,最初的目标就是为了简化和统一音频驱动中的寄存器访问。
  • 初步实现与推广regmap 最初作为一个库被引入,很快就因为它带来的巨大便利性而被推广到音频子系统之外。
  • 功能扩展:随着时间的推移,regmap 支持的总线类型不断增加,从最初的I2C和SPI,扩展到了MMIO(内存映射I/O)、SPMI、SLIMbus等多种总线。
  • 特性完善:框架中加入了寄存器缓存、区域查找、调试支持(通过debugfs导出寄存器视图)等高级功能,使其成为一个功能非常强大的工具。
  • 成为标准:如今,regmap 已经成为Linux内核中编写新设备驱动(特别是针对I2C/SPI设备)的事实标准和最佳实践。

目前该技术的社区活跃度和主流应用情况如何?

regmap 是一个极其成熟、稳定且被广泛应用的核心内核API。它被内核中成百上千的驱动程序所使用,覆盖了各种类型的设备:

  • 音频编解码器(Audio Codecs)
  • 电源管理芯片(PMICs)
  • 传感器(加速度计、陀螺仪、温湿度传感器等)
  • 实时时钟(RTCs)
  • 触摸屏控制器
  • GPIO扩展器

任何需要通过简单总线进行寄存器级配置的设备驱动,都是regmap的理想用户。

核心原理与设计

它的核心工作原理是什么?

regmap 的核心思想是在驱动程序的逻辑层和底层总线传输层之间插入一个抽象层

  1. 配置描述:驱动程序在初始化(.probe() 函数)时,首先填充一个 struct regmap_config 结构体。这个结构体详细描述了目标硬件的寄存器映射特性,例如:
    • 寄存器地址和值的位宽(reg_bits, val_bits)。
    • 寄存器地址的步长(reg_stride)。
    • 是否可以进行批量读写。
    • 缓存类型(cache_type),如红黑树缓存。
    • 描述哪些寄存器是易失性的、只读的或只写的表格。
  2. 初始化:驱动程序接着调用一个总线特定的 devm_regmap_init_*() 函数(如 devm_regmap_init_i2c()devm_regmap_init_spi())。这个函数接收总线客户端对象(如 struct i2c_client *)和刚才填充的 regmap_config
  3. 返回句柄:初始化函数会根据配置创建一个 struct regmap 实例(句柄),并将其返回给驱动程序。这个实例内部包含了所有与底层总线交互的必要信息和函数指针。
  4. 统一API访问:从此以后,驱动程序不再调用 i2c_transfer()spi_sync() 等底层函数,而是使用一套统一的、总线无关的regmap API来操作寄存器:
    • regmap_read(map, reg_addr, &val):读取一个寄存器。
    • regmap_write(map, reg_addr, val):写入一个寄存器。
    • regmap_update_bits(map, reg_addr, mask, val):执行原子的“读-改-写”操作。
    • regmap_bulk_read(map, ...) / regmap_bulk_write(map, ...):批量读写。
  5. 内部转换:当驱动调用这些API时,regmap 核心会根据初始化时配置的总线类型,将这个通用的请求转换成一个具体的底层总线操作,并执行它。如果配置了缓存,regmap 可能会直接从内存缓存中返回数据,从而避免实际的I/O操作。

它的主要优势体现在哪些方面?

  • 代码极大简化:将驱动从繁琐的底层I/O样板代码中解放出来,使其可以专注于实现设备的核心逻辑。
  • 总线无关性:驱动的核心逻辑与物理总线解耦。将一个驱动从I2C迁移到SPI,往往只需要修改一行 devm_regmap_init_* 的调用,极大地提高了代码的可重用性。
  • 内置高级功能
    • 缓存:透明地提供寄存器值缓存,可以显著减少慢速总线(如I2C)上的I/O次数,大幅提升性能。
    • 原子性regmap_update_bits() 提供了一个安全的、有锁保护的机制来修改寄存器中的特定位,避免了在中断上下文或多线程环境中可能出现的竞态条件。
    • 批量操作:自动将多个连续的寄存器访问合并为一次高效的批量传输。
  • 健壮性和一致性:为寄存器访问提供了一个统一的、经过充分测试的实现,避免了各个驱动中可能出现的各种潜在bug。

它存在哪些已知的劣势、局限性或在特定场景下的不适用性?

  • 不适用于复杂协议regmap 专为简单的、类似内存的“地址-数据”式寄存器访问模型设计。它不适用于像USB、PCIe这样具有复杂事务层、端点或配置空间的协议。
  • 轻微的抽象开销:相比直接调用底层总线API,regmap 增加了一个函数调用的间接层。但在绝大多数情况下,这种开销是完全可以忽略的,并且通常会被缓存等优化所带来的性能提升所抵消。
  • 非寄存器文件接口:对于那些通过FIFO或流式接口进行通信的设备(如UART),regmap 也不适用。

使用场景

在哪些具体的业务或技术场景下,它是首选解决方案?请举例说明。

regmap 是所有通过I2C、SPI、MMIO等简单总线与CPU通信,并暴露一个**“寄存器文件”接口的硬件设备驱动的首选且标准**的解决方案。

  • 场景一:音频编解码器(Audio Codec)
    一个典型的音频Codec芯片有数百个寄存器,用于控制音量、音频路径、采样率等。该芯片可能同时提供I2C和SPI两种接口。使用regmap,可以编写一个核心驱动,只需在probe时判断是哪种总线并调用相应的regmap_init函数,后续所有的寄存器操作代码都是共享的。
  • 场景二:电源管理芯片(PMIC)
    PMIC通过寄存器来控制多个电压轨的开关和电压值。修改一个电压轨通常需要修改一个寄存器中的某几个位,而不能影响其他位。regmap_update_bits() 在此场景下是完美的解决方案,它能保证操作的原子性,防止系统状态出错。
  • 场景三:环境传感器(如BME280)
    这类传感器通过I2C或SPI接口暴露其配置寄存器和数据寄存器(温度、湿度、气压)。驱动程序可以使用regmap_bulk_read()一次性地、高效地读出所有数据寄存器。

是否有不推荐使用该技术的场景?为什么?

  • 复杂总线设备:如上所述,任何PCIe、USB、NVMe设备都不应使用regmap,它们有自己专属的、更高级的内核API。
  • 流式接口设备:如UART、I2S音频总线等,它们的数据传输是基于流和FIFO的,而不是基于对单个寄存器的随机访问。
  • 极简设备:如果一个设备只有一个或两个寄存器,并且没有复杂的访问需求,引入regmap可能会带来不必要的代码体积(尽管代码逻辑会更清晰)。但在内核社区,即使是简单的设备,也鼓励使用regmap以保持一致性。

对比分析

请将其 与 其他相似技术 进行详细对比。

regmap 的主要对比对象就是不使用它,而是直接使用底层总线API的传统方法。

特性 regmap API 直接使用原始总线API (如 i2c_transfer, spi_sync)
抽象级别 。将驱动与具体总线实现解耦。 。驱动与总线API紧密耦合。
代码可重用性 非常高。驱动核心逻辑可以轻松地在不同总线间复用。 非常低。更换总线需要重写所有I/O相关的代码。
驱动代码量 。驱动只包含设备逻辑,没有I/O样板代码。 。驱动中包含了大量的、重复的底层I/O代码。
内置功能 丰富。自带缓存、原子更新、批量操作、调试接口等。 。所有高级功能都需要驱动自行、重复地实现。
性能 可能更高。通过缓存和批量操作优化,可以显著减少总线流量。 取决于实现。手动实现的I/O模式可能效率低下。
健壮性 。基于一个集中的、经过严格测试的框架。 不一。容易在手动实现的锁、错误处理和R-M-W操作中引入bug。
开发效率 。开发者可以专注于设备本身,而非底层通信细节。 。需要花费大量时间编写和调试I/O代码。

include/linux/regmap.h

regmap_init_mmio_clk - 使用寄存器时钟初始化寄存器映射

1
2
3
4
5
6
7
8
9
10
11
12
13
/**
* regmap_init_mmio_clk() - 使用寄存器时钟初始化寄存器映射
*
* @dev:将与之交互的设备
* @clk_id:注册时钟 Consumer ID
* @regs:指向内存映射 IO 区域的指针
* @config:寄存器映射的配置
*
* 返回值将是出错时的 ERR_PTR() 或 一个结构 regmap。
*/
#define regmap_init_mmio_clk(dev, clk_id, regs, config) \
__regmap_lockdep_wrapper(__regmap_init_mmio_clk, #config, \
dev, clk_id, regs, config)

regmap_update_bits - 更新寄存器的特定位

1
2
3
4
5
static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
unsigned int mask, unsigned int val)
{
return regmap_update_bits_base(map, reg, mask, val, NULL, false, false);
}

drivers/base/regmap/regcache.c

regcache_init - 初始化寄存器缓存

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
int regcache_init(struct regmap *map, const struct regmap_config *config)
{
int ret;
int i;
void *tmp_buf;
/* 默认情况: */
if (map->cache_type == REGCACHE_NONE) {
if (config->reg_defaults || config->num_reg_defaults_raw)
dev_warn(map->dev,
"No cache used with register defaults set!\n");

map->cache_bypass = true;
return 0;
}

if (config->reg_defaults && !config->num_reg_defaults) {
dev_err(map->dev,
"Register defaults are set without the number!\n");
return -EINVAL;
}

if (config->num_reg_defaults && !config->reg_defaults) {
dev_err(map->dev,
"Register defaults number are set without the reg!\n");
return -EINVAL;
}

for (i = 0; i < config->num_reg_defaults; i++)
if (config->reg_defaults[i].reg % map->reg_stride)
return -EINVAL;

for (i = 0; i < ARRAY_SIZE(cache_types); i++)
if (cache_types[i]->type == map->cache_type)
break;

if (i == ARRAY_SIZE(cache_types)) {
dev_err(map->dev, "Could not match cache type: %d\n",
map->cache_type);
return -EINVAL;
}

map->num_reg_defaults = config->num_reg_defaults;
map->num_reg_defaults_raw = config->num_reg_defaults_raw;
map->reg_defaults_raw = config->reg_defaults_raw;
map->cache_word_size = BITS_TO_BYTES(config->val_bits);
map->cache_size_raw = map->cache_word_size * config->num_reg_defaults_raw;

map->cache = NULL;
map->cache_ops = cache_types[i];

if (!map->cache_ops->read ||
!map->cache_ops->write ||
!map->cache_ops->name)
return -EINVAL;

/* We still need to ensure that the reg_defaults
* won't vanish from under us. We'll need to make
* a copy of it.
*/
if (config->reg_defaults) {
tmp_buf = kmemdup_array(config->reg_defaults, map->num_reg_defaults,
sizeof(*map->reg_defaults), GFP_KERNEL);
if (!tmp_buf)
return -ENOMEM;
map->reg_defaults = tmp_buf;
} else if (map->num_reg_defaults_raw) {
/* Some devices such as PMICs don't have cache defaults,
* we cope with this by reading back the HW registers and
* crafting the cache defaults by hand.
*/
ret = regcache_hw_init(map);
if (ret < 0)
return ret;
if (map->cache_bypass)
return 0;
}

if (!map->max_register_is_set && map->num_reg_defaults_raw) {
map->max_register = (map->num_reg_defaults_raw - 1) * map->reg_stride;
map->max_register_is_set = true;
}

if (map->cache_ops->init) {
dev_dbg(map->dev, "Initializing %s cache\n",
map->cache_ops->name);
map->lock(map->lock_arg);
ret = map->cache_ops->init(map);
map->unlock(map->lock_arg);
if (ret)
goto err_free;
}
return 0;

err_free:
kfree(map->reg_defaults);
if (map->cache_free)
kfree(map->reg_defaults_raw);

return ret;
}

drivers/base/regmap/regmap-mmio.c

regmap_mmio_read32le - 读取32位寄存器值

1
2
3
4
5
static unsigned int regmap_mmio_read32le(struct regmap_mmio_context *ctx,
unsigned int reg)
{
return readl(ctx->regs + reg);
}

regmap_mmio_write32le - 写入32位寄存器值

1
2
3
4
5
6
static void regmap_mmio_write32le(struct regmap_mmio_context *ctx,
unsigned int reg,
unsigned int val)
{
writel(val, ctx->regs + reg);
}

regmap_mmio_gen_context - 生成寄存器映射上下文

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
static struct regmap_mmio_context *regmap_mmio_gen_context(struct device *dev,
const char *clk_id,
void __iomem *regs,
const struct regmap_config *config)
{
struct regmap_mmio_context *ctx;
int min_stride;
int ret;

ret = regmap_mmio_regbits_check(config->reg_bits);
if (ret)
return ERR_PTR(ret);

if (config->pad_bits)
return ERR_PTR(-EINVAL);

min_stride = regmap_mmio_get_min_stride(config->val_bits);
if (min_stride < 0)
return ERR_PTR(min_stride);

if (config->reg_stride && config->reg_stride < min_stride)
return ERR_PTR(-EINVAL);

if (config->use_relaxed_mmio && config->io_port)
return ERR_PTR(-EINVAL);

ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
if (!ctx)
return ERR_PTR(-ENOMEM);

ctx->regs = regs;
ctx->val_bytes = config->val_bits / 8;
ctx->clk = ERR_PTR(-ENODEV);

switch (regmap_get_val_endian(dev, &regmap_mmio, config)) {
case REGMAP_ENDIAN_DEFAULT:
case REGMAP_ENDIAN_LITTLE:
#ifdef __LITTLE_ENDIAN
case REGMAP_ENDIAN_NATIVE:
#endif
switch (config->val_bits) {
case 8:
if (config->io_port) {
ctx->reg_read = regmap_mmio_ioread8;
ctx->reg_write = regmap_mmio_iowrite8;
} else if (config->use_relaxed_mmio) {
ctx->reg_read = regmap_mmio_read8_relaxed;
ctx->reg_write = regmap_mmio_write8_relaxed;
} else {
ctx->reg_read = regmap_mmio_read8;
ctx->reg_write = regmap_mmio_write8;
}
break;
case 16:
if (config->io_port) {
ctx->reg_read = regmap_mmio_ioread16le;
ctx->reg_write = regmap_mmio_iowrite16le;
} else if (config->use_relaxed_mmio) {
ctx->reg_read = regmap_mmio_read16le_relaxed;
ctx->reg_write = regmap_mmio_write16le_relaxed;
} else {
ctx->reg_read = regmap_mmio_read16le;
ctx->reg_write = regmap_mmio_write16le;
}
break;
case 32:
if (config->io_port) {
ctx->reg_read = regmap_mmio_ioread32le;
ctx->reg_write = regmap_mmio_iowrite32le;
} else if (config->use_relaxed_mmio) {
ctx->reg_read = regmap_mmio_read32le_relaxed;
ctx->reg_write = regmap_mmio_write32le_relaxed;
} else {
ctx->reg_read = regmap_mmio_read32le;
ctx->reg_write = regmap_mmio_write32le;
}
break;
default:
ret = -EINVAL;
goto err_free;
}
break;
case REGMAP_ENDIAN_BIG:
#ifdef __BIG_ENDIAN
case REGMAP_ENDIAN_NATIVE:
#endif
ctx->big_endian = true;
switch (config->val_bits) {
case 8:
if (config->io_port) {
ctx->reg_read = regmap_mmio_ioread8;
ctx->reg_write = regmap_mmio_iowrite8;
} else {
ctx->reg_read = regmap_mmio_read8;
ctx->reg_write = regmap_mmio_write8;
}
break;
case 16:
if (config->io_port) {
ctx->reg_read = regmap_mmio_ioread16be;
ctx->reg_write = regmap_mmio_iowrite16be;
} else {
ctx->reg_read = regmap_mmio_read16be;
ctx->reg_write = regmap_mmio_write16be;
}
break;
case 32:
if (config->io_port) {
ctx->reg_read = regmap_mmio_ioread32be;
ctx->reg_write = regmap_mmio_iowrite32be;
} else {
ctx->reg_read = regmap_mmio_read32be;
ctx->reg_write = regmap_mmio_write32be;
}
break;
default:
ret = -EINVAL;
goto err_free;
}
break;
default:
ret = -EINVAL;
goto err_free;
}

if (clk_id == NULL)
return ctx;

ctx->clk = clk_get(dev, clk_id);
if (IS_ERR(ctx->clk)) {
ret = PTR_ERR(ctx->clk);
goto err_free;
}

ret = clk_prepare(ctx->clk);
if (ret < 0) {
clk_put(ctx->clk);
goto err_free;
}

return ctx;

err_free:
kfree(ctx);

return ERR_PTR(ret);
}

regmap_mmio_read - 读取寄存器值

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
static int regmap_mmio_read(void *context, unsigned int reg, unsigned int *val)
{
struct regmap_mmio_context *ctx = context;
int ret;

if (!IS_ERR(ctx->clk)) {
ret = clk_enable(ctx->clk);
if (ret < 0)
return ret;
}

*val = ctx->reg_read(ctx, reg);

if (!IS_ERR(ctx->clk))
clk_disable(ctx->clk);

return 0;
}

regmap_mmio_write 写入寄存器值

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
static int regmap_mmio_write(void *context, unsigned int reg, unsigned int val)
{
struct regmap_mmio_context *ctx = context;
int ret;

if (!IS_ERR(ctx->clk)) {
ret = clk_enable(ctx->clk);
if (ret < 0)
return ret;
}

ctx->reg_write(ctx, reg, val);

if (!IS_ERR(ctx->clk))
clk_disable(ctx->clk);

return 0;
}

regmap_mmio - MMIO 寄存器映射

1
2
3
4
5
6
7
8
9
static const struct regmap_bus regmap_mmio = {
.fast_io = true,
.reg_write = regmap_mmio_write,
.reg_read = regmap_mmio_read,
.reg_noinc_write = regmap_mmio_noinc_write,
.reg_noinc_read = regmap_mmio_noinc_read,
.free_context = regmap_mmio_free_context,
.val_format_endian_default = REGMAP_ENDIAN_LITTLE,
};

regmap_lock_hwlock regmap_unlock_hwlock

  • 无实际作用
1
2
3
4
5
6
7
8
9
10
11
12
13
14

static void regmap_lock_hwlock(void *__map)
{
struct regmap *map = __map;

hwspin_lock_timeout(map->hwlock, UINT_MAX);
}

static void regmap_unlock_hwlock(void *__map)
{
struct regmap *map = __map;

hwspin_unlock(map->hwlock);
}

regmap_get_val_endian - 获取寄存器值的字节序

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
enum regmap_endian regmap_get_val_endian(struct device *dev,
const struct regmap_bus *bus,
const struct regmap_config *config)
{
struct fwnode_handle *fwnode = dev ? dev_fwnode(dev) : NULL;
enum regmap_endian endian;

/* Retrieve the endianness specification from the regmap config */
endian = config->val_format_endian;

/* If the regmap config specified a non-default value, use that */
if (endian != REGMAP_ENDIAN_DEFAULT)
return endian;

/* If the firmware node exist try to get endianness from it */
if (fwnode_property_read_bool(fwnode, "big-endian"))
endian = REGMAP_ENDIAN_BIG;
else if (fwnode_property_read_bool(fwnode, "little-endian"))
endian = REGMAP_ENDIAN_LITTLE;
else if (fwnode_property_read_bool(fwnode, "native-endian"))
endian = REGMAP_ENDIAN_NATIVE;

/* If the endianness was specified in fwnode, use that */
if (endian != REGMAP_ENDIAN_DEFAULT)
return endian;

/* Retrieve the endianness specification from the bus config */
if (bus && bus->val_format_endian_default)
endian = bus->val_format_endian_default;

/* If the bus specified a non-default value, use that */
if (endian != REGMAP_ENDIAN_DEFAULT)
return endian;

/* Use this if no other value was found */
return REGMAP_ENDIAN_BIG;
}
EXPORT_SYMBOL_GPL(regmap_get_val_endian);

regmap_parse_32_native - 解析原生字节序的32位值

1

_regmap_range_lookup - 查找寄存器范围

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
static struct regmap_range_node *_regmap_range_lookup(struct regmap *map,
unsigned int reg)
{
struct rb_node *node = map->range_tree.rb_node;

while (node) {
struct regmap_range_node *this =
rb_entry(node, struct regmap_range_node, node);

if (reg < this->range_min)
node = node->rb_left;
else if (reg > this->range_max)
node = node->rb_right;
else
return this;
}

return NULL;
}

_regmap_bus_reg_read - 读取寄存器值

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
static int _regmap_bus_reg_read(void *context, unsigned int reg,
unsigned int *val)
{
struct regmap *map = context;
struct regmap_range_node *range;
int ret;

range = _regmap_range_lookup(map, reg);
if (range) {
ret = _regmap_select_page(map, &reg, range, 1);
if (ret != 0)
return ret;
}

reg = regmap_reg_addr(map, reg);
return map->bus->reg_read(map->bus_context, reg, val);
}

_regmap_bus_reg_write - 写入寄存器值

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
static int _regmap_bus_reg_write(void *context, unsigned int reg,
unsigned int val)
{
struct regmap *map = context;
struct regmap_range_node *range;
int ret;

range = _regmap_range_lookup(map, reg);
if (range) {
ret = _regmap_select_page(map, &reg, range, 1);
if (ret != 0)
return ret;
}

reg = regmap_reg_addr(map, reg);
return map->bus->reg_write(map->bus_context, reg, val);
}

__regmap_init - 初始化寄存器映射

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
struct regmap *__regmap_init(struct device *dev,
const struct regmap_bus *bus,
void *bus_context,
const struct regmap_config *config,
struct lock_class_key *lock_key,
const char *lock_name)
{
struct regmap *map;
int ret = -EINVAL;
enum regmap_endian reg_endian, val_endian;
int i, j;

if (!config)
goto err;

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

ret = regmap_set_name(map, config);
if (ret)
goto err_map;

ret = -EINVAL; /* Later error paths rely on this */

if (config->disable_locking) {
map->lock = map->unlock = regmap_lock_unlock_none;
map->can_sleep = config->can_sleep;
regmap_debugfs_disable(map);
} else if (config->lock && config->unlock) {
map->lock = config->lock;
map->unlock = config->unlock;
map->lock_arg = config->lock_arg;
map->can_sleep = config->can_sleep;
} else if (config->use_hwlock) {
map->hwlock = hwspin_lock_request_specific(config->hwlock_id);
if (!map->hwlock) {
ret = -ENXIO;
goto err_name;
}

switch (config->hwlock_mode) {
case HWLOCK_IRQSTATE:
map->lock = regmap_lock_hwlock_irqsave;
map->unlock = regmap_unlock_hwlock_irqrestore;
break;
case HWLOCK_IRQ:
map->lock = regmap_lock_hwlock_irq;
map->unlock = regmap_unlock_hwlock_irq;
break;
default:
map->lock = regmap_lock_hwlock;
map->unlock = regmap_unlock_hwlock;
break;
}

map->lock_arg = map;
} else {
if ((bus && bus->fast_io) ||
config->fast_io) {
if (config->use_raw_spinlock) {
raw_spin_lock_init(&map->raw_spinlock);
map->lock = regmap_lock_raw_spinlock;
map->unlock = regmap_unlock_raw_spinlock;
lockdep_set_class_and_name(&map->raw_spinlock,
lock_key, lock_name);
} else {
spin_lock_init(&map->spinlock);
map->lock = regmap_lock_spinlock;
map->unlock = regmap_unlock_spinlock;
lockdep_set_class_and_name(&map->spinlock,
lock_key, lock_name);
}
} else {
mutex_init(&map->mutex);
map->lock = regmap_lock_mutex;
map->unlock = regmap_unlock_mutex;
map->can_sleep = true;
lockdep_set_class_and_name(&map->mutex,
lock_key, lock_name);
}
map->lock_arg = map;
map->lock_key = lock_key;
}

/*
* 当我们使用 regmap_bulk_write() 写入 fast-paths 时,不要使用 sleeps()分配 scratch buffers。
*/
if ((bus && bus->fast_io) || config->fast_io)
map->alloc_flags = GFP_ATOMIC;
else
map->alloc_flags = GFP_KERNEL;

map->reg_base = config->reg_base;
map->reg_shift = config->pad_bits % 8;

map->format.pad_bytes = config->pad_bits / 8;
map->format.reg_shift = config->reg_shift;
map->format.reg_bytes = BITS_TO_BYTES(config->reg_bits);
map->format.val_bytes = BITS_TO_BYTES(config->val_bits);
map->format.buf_size = BITS_TO_BYTES(config->reg_bits + config->val_bits + config->pad_bits);
if (config->reg_stride)
map->reg_stride = config->reg_stride;
else
map->reg_stride = 1;
if (is_power_of_2(map->reg_stride))
map->reg_stride_order = ilog2(map->reg_stride);
else
map->reg_stride_order = -1;
map->use_single_read = config->use_single_read || !(config->read || (bus && bus->read));
map->use_single_write = config->use_single_write || !(config->write || (bus && bus->write));
map->can_multi_write = config->can_multi_write && (config->write || (bus && bus->write));
if (bus) {
map->max_raw_read = bus->max_raw_read;
map->max_raw_write = bus->max_raw_write;
} else if (config->max_raw_read && config->max_raw_write) {
map->max_raw_read = config->max_raw_read;
map->max_raw_write = config->max_raw_write;
}
map->dev = dev;
map->bus = bus;
map->bus_context = bus_context;
map->max_register = config->max_register;
map->max_register_is_set = map->max_register ?: config->max_register_is_0;
map->wr_table = config->wr_table;
map->rd_table = config->rd_table;
map->volatile_table = config->volatile_table;
map->precious_table = config->precious_table;
map->wr_noinc_table = config->wr_noinc_table;
map->rd_noinc_table = config->rd_noinc_table;
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->writeable_noinc_reg = config->writeable_noinc_reg;
map->readable_noinc_reg = config->readable_noinc_reg;
map->cache_type = config->cache_type;

spin_lock_init(&map->async_lock);
INIT_LIST_HEAD(&map->async_list);
INIT_LIST_HEAD(&map->async_free);
init_waitqueue_head(&map->async_waitq);

if (config->read_flag_mask ||
config->write_flag_mask ||
config->zero_flag_mask) {
map->read_flag_mask = config->read_flag_mask;
map->write_flag_mask = config->write_flag_mask;
} else if (bus) {
map->read_flag_mask = bus->read_flag_mask;
}

if (config && config->read && config->write) {
map->reg_read = _regmap_bus_read;
if (config->reg_update_bits)
map->reg_update_bits = config->reg_update_bits;

/* Bulk read/write */
map->read = config->read;
map->write = config->write;

reg_endian = REGMAP_ENDIAN_NATIVE;
val_endian = REGMAP_ENDIAN_NATIVE;
} else if (!bus) {
map->reg_read = config->reg_read;
map->reg_write = config->reg_write;
map->reg_update_bits = config->reg_update_bits;

map->defer_caching = false;
goto skip_format_initialization;
} else if (!bus->read || !bus->write) {
map->reg_read = _regmap_bus_reg_read;
map->reg_write = _regmap_bus_reg_write;
map->reg_update_bits = bus->reg_update_bits;

map->defer_caching = false;
goto skip_format_initialization;
} else {
map->reg_read = _regmap_bus_read;
map->reg_update_bits = bus->reg_update_bits;
/* Bulk read/write */
map->read = bus->read;
map->write = bus->write;

reg_endian = regmap_get_reg_endian(bus, config);
val_endian = regmap_get_val_endian(dev, bus, config);
}

switch (config->reg_bits + map->reg_shift) {
case 2:
switch (config->val_bits) {
case 6:
map->format.format_write = regmap_format_2_6_write;
break;
default:
goto err_hwlock;
}
break;

case 4:
switch (config->val_bits) {
case 12:
map->format.format_write = regmap_format_4_12_write;
break;
default:
goto err_hwlock;
}
break;

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

case 10:
switch (config->val_bits) {
case 14:
map->format.format_write = regmap_format_10_14_write;
break;
default:
goto err_hwlock;
}
break;

case 12:
switch (config->val_bits) {
case 20:
map->format.format_write = regmap_format_12_20_write;
break;
default:
goto err_hwlock;
}
break;

case 8:
map->format.format_reg = regmap_format_8;
break;

case 16:
switch (reg_endian) {
case REGMAP_ENDIAN_BIG:
map->format.format_reg = regmap_format_16_be;
break;
case REGMAP_ENDIAN_LITTLE:
map->format.format_reg = regmap_format_16_le;
break;
case REGMAP_ENDIAN_NATIVE:
map->format.format_reg = regmap_format_16_native;
break;
default:
goto err_hwlock;
}
break;

case 24:
switch (reg_endian) {
case REGMAP_ENDIAN_BIG:
map->format.format_reg = regmap_format_24_be;
break;
default:
goto err_hwlock;
}
break;

case 32:
switch (reg_endian) {
case REGMAP_ENDIAN_BIG:
map->format.format_reg = regmap_format_32_be;
break;
case REGMAP_ENDIAN_LITTLE:
map->format.format_reg = regmap_format_32_le;
break;
case REGMAP_ENDIAN_NATIVE:
map->format.format_reg = regmap_format_32_native;
break;
default:
goto err_hwlock;
}
break;

default:
goto err_hwlock;
}

if (val_endian == REGMAP_ENDIAN_NATIVE)
map->format.parse_inplace = regmap_parse_inplace_noop;

switch (config->val_bits) {
case 8:
map->format.format_val = regmap_format_8;
map->format.parse_val = regmap_parse_8;
map->format.parse_inplace = regmap_parse_inplace_noop;
break;
case 16:
switch (val_endian) {
case REGMAP_ENDIAN_BIG:
map->format.format_val = regmap_format_16_be;
map->format.parse_val = regmap_parse_16_be;
map->format.parse_inplace = regmap_parse_16_be_inplace;
break;
case REGMAP_ENDIAN_LITTLE:
map->format.format_val = regmap_format_16_le;
map->format.parse_val = regmap_parse_16_le;
map->format.parse_inplace = regmap_parse_16_le_inplace;
break;
case REGMAP_ENDIAN_NATIVE:
map->format.format_val = regmap_format_16_native;
map->format.parse_val = regmap_parse_16_native;
break;
default:
goto err_hwlock;
}
break;
case 24:
switch (val_endian) {
case REGMAP_ENDIAN_BIG:
map->format.format_val = regmap_format_24_be;
map->format.parse_val = regmap_parse_24_be;
break;
default:
goto err_hwlock;
}
break;
case 32:
switch (val_endian) {
case REGMAP_ENDIAN_BIG:
map->format.format_val = regmap_format_32_be;
map->format.parse_val = regmap_parse_32_be;
map->format.parse_inplace = regmap_parse_32_be_inplace;
break;
case REGMAP_ENDIAN_LITTLE:
map->format.format_val = regmap_format_32_le;
map->format.parse_val = regmap_parse_32_le;
map->format.parse_inplace = regmap_parse_32_le_inplace;
break;
case REGMAP_ENDIAN_NATIVE: //原生32字节
map->format.format_val = regmap_format_32_native;
map->format.parse_val = regmap_parse_32_native;
break;
default:
goto err_hwlock;
}
break;
}

if (map->format.format_write) {
if ((reg_endian != REGMAP_ENDIAN_BIG) ||
(val_endian != REGMAP_ENDIAN_BIG))
goto err_hwlock;
map->use_single_write = true;
}

if (!map->format.format_write &&
!(map->format.format_reg && map->format.format_val))
goto err_hwlock;

map->work_buf = kzalloc(map->format.buf_size, GFP_KERNEL);
if (map->work_buf == NULL) {
ret = -ENOMEM;
goto err_hwlock;
}

if (map->format.format_write) {
map->defer_caching = false;
map->reg_write = _regmap_bus_formatted_write;
} else if (map->format.format_val) {
map->defer_caching = true;
map->reg_write = _regmap_bus_raw_write;
}

skip_format_initialization:
/* #define RB_ROOT (struct rb_root) { NULL, } */
map->range_tree = RB_ROOT;
for (i = 0; i < config->num_ranges; i++) {
const struct regmap_range_cfg *range_cfg = &config->ranges[i];
struct regmap_range_node *new;

/* Sanity check */
if (range_cfg->range_max < range_cfg->range_min) {
dev_err(map->dev, "Invalid range %d: %u < %u\n", i,
range_cfg->range_max, range_cfg->range_min);
goto err_range;
}

if (range_cfg->range_max > map->max_register) {
dev_err(map->dev, "Invalid range %d: %u > %u\n", i,
range_cfg->range_max, map->max_register);
goto err_range;
}

if (range_cfg->selector_reg > map->max_register) {
dev_err(map->dev,
"Invalid range %d: selector out of map\n", i);
goto err_range;
}

if (range_cfg->window_len == 0) {
dev_err(map->dev, "Invalid range %d: window_len 0\n",
i);
goto err_range;
}

/* Make sure, that this register range has no selector
or data window within its boundary */
for (j = 0; j < config->num_ranges; j++) {
unsigned int sel_reg = config->ranges[j].selector_reg;
unsigned int win_min = config->ranges[j].window_start;
unsigned int win_max = win_min +
config->ranges[j].window_len - 1;

/* Allow data window inside its own virtual range */
if (j == i)
continue;

if (range_cfg->range_min <= sel_reg &&
sel_reg <= range_cfg->range_max) {
dev_err(map->dev,
"Range %d: selector for %d in window\n",
i, j);
goto err_range;
}

if (!(win_max < range_cfg->range_min ||
win_min > range_cfg->range_max)) {
dev_err(map->dev,
"Range %d: window for %d in window\n",
i, j);
goto err_range;
}
}

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

new->map = map;
new->name = range_cfg->name;
new->range_min = range_cfg->range_min;
new->range_max = range_cfg->range_max;
new->selector_reg = range_cfg->selector_reg;
new->selector_mask = range_cfg->selector_mask;
new->selector_shift = range_cfg->selector_shift;
new->window_start = range_cfg->window_start;
new->window_len = range_cfg->window_len;

if (!_regmap_range_add(map, new)) {
dev_err(map->dev, "Failed to add range %d\n", i);
kfree(new);
goto err_range;
}

if (map->selector_work_buf == NULL) {
map->selector_work_buf =
kzalloc(map->format.buf_size, GFP_KERNEL);
if (map->selector_work_buf == NULL) {
ret = -ENOMEM;
goto err_range;
}
}
}

ret = regcache_init(map, config);
if (ret != 0)
goto err_range;

if (dev) {
ret = regmap_attach_dev(dev, map, config);
if (ret != 0)
goto err_regcache;
} else {
regmap_debugfs_init(map);
}

return map;

err_regcache:
regcache_exit(map);
err_range:
regmap_range_exit(map);
kfree(map->work_buf);
err_hwlock:
if (map->hwlock)
hwspin_lock_free(map->hwlock);
err_name:
kfree_const(map->name);
err_map:
kfree(map);
err:
return ERR_PTR(ret);
}
EXPORT_SYMBOL_GPL(__regmap_init);

__regmap_init_mmio_clk - 使用寄存器时钟初始化寄存器映射

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
struct regmap *__regmap_init_mmio_clk(struct device *dev, const char *clk_id,
void __iomem *regs,
const struct regmap_config *config,
struct lock_class_key *lock_key,
const char *lock_name)
{
struct regmap_mmio_context *ctx;

ctx = regmap_mmio_gen_context(dev, clk_id, regs, config);
if (IS_ERR(ctx))
return ERR_CAST(ctx);

return __regmap_init(dev, &regmap_mmio, ctx, config,
lock_key, lock_name);
}
EXPORT_SYMBOL_GPL(__regmap_init_mmio_clk);

regmap_mmio_attach_clk - 附加时钟到寄存器映射

1
2
3
4
5
6
7
8
9
10
int regmap_mmio_attach_clk(struct regmap *map, struct clk *clk)
{
struct regmap_mmio_context *ctx = map->bus_context;

ctx->clk = clk;
ctx->attached_clk = true;

return clk_prepare(ctx->clk);
}
EXPORT_SYMBOL_GPL(regmap_mmio_attach_clk);

drivers/base/regmap/regmap.c

Regmap 范围表检查系列函数

这一组函数是Linux内核Regmap子系统的底层工具, 它们共同实现了一个强大而灵活的寄存器地址访问控制机制。其核心原理是通过静态定义的”范围表”(range tables), 以”黑名单/白名单”的逻辑, 来判断一个给定的寄存器地址是否落在驱动程序所声明的有效、可访问的地址区间内。这使得Regmap框架能够安全地处理具有非连续、复杂地址布局的硬件外设, 是保证寄存器访问安全性和正确性的基础。


regmap_reg_in_range: 检查寄存器是否在单个范围内

这是一个最基础的内联辅助函数, 用于判断一个寄存器地址是否落在一个连续的地址区间内。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/*
* static inline: 定义一个静态内联函数.
* "static"表示此函数仅在当前文件可见.
* "inline"建议编译器将函数代码直接嵌入调用处, 减少函数调用开销.
* @reg: 要检查的寄存器地址.
* @range: 指向一个描述地址范围的 regmap_range 结构体的指针.
* @return: 如果 reg 在 range 定义的范围内, 返回 true; 否则返回 false.
*/
static inline bool regmap_reg_in_range(unsigned int reg,
const struct regmap_range *range)
{
/*
* 这是一个简单的布尔逻辑判断:
* 检查 reg 是否大于等于范围的最小值(range_min) 并且 (&&) 小于等于范围的最大值(range_max).
*/
return reg >= range->range_min && reg <= range->range_max;
}

regmap_reg_in_ranges: 检查寄存器是否在一系列范围中

此函数将单个范围的检查扩展为对一个范围数组的检查。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/*
* regmap_reg_in_ranges: 检查一个寄存器地址是否存在于一个范围数组中.
* @reg: 要检查的寄存器地址.
* @ranges: 指向一个 regmap_range 结构体数组的指针.
* @nranges: 数组中范围的数量.
* @return: 如果在任何一个范围内找到匹配, 返回 true; 否则返回 false.
*/
bool regmap_reg_in_ranges(unsigned int reg,
const struct regmap_range *ranges,
unsigned int nranges)
{
/* r 用作循环变量, 指向当前检查的范围. */
const struct regmap_range *r;
/* i 是循环计数器. */
int i;

/* 遍历 ranges 数组中的每一个元素. */
for (i = 0, r = ranges; i < nranges; i++, r++)
/* 调用基础辅助函数 regmap_reg_in_range 检查当前范围. */
if (regmap_reg_in_range(reg, r))
/* 只要找到一个匹配的范围, 就立即返回 true, 不再继续搜索. */
return true;
/* 如果遍历完整个数组都没有找到匹配的范围, 则返回 false. */
return false;
}
/* 将此函数导出, 使其对其他遵循GPL许可证的内核模块可用. */
EXPORT_SYMBOL_GPL(regmap_reg_in_ranges);

regmap_check_range_table: 使用黑/白名单表检查寄存器

这是该系列函数的核心, 它实现了一个完整的、具有优先级的访问控制逻辑。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
/*
* regmap_check_range_table: 使用一个访问表(黑/白名单)来检查寄存器的有效性.
* @map: 指向 regmap 实例的指针 (此函数中未使用, 但保持API一致性).
* @reg: 要检查的寄存器地址.
* @table: 指向 regmap_access_table 的指针, 它包含一个黑名单和一个白名单.
* @return: 如果根据规则表判断寄存器是允许访问的, 返回 true; 否则返回 false.
*/
bool regmap_check_range_table(struct regmap *map, unsigned int reg,
const struct regmap_access_table *table)
{
/*
* 规则第一优先级: 检查 "no ranges" (黑名单).
* 调用 regmap_reg_in_ranges 检查 reg 是否在 table->no_ranges 列表中.
*/
if (regmap_reg_in_ranges(reg, table->no_ranges, table->n_no_ranges))
/* 如果在黑名单中, 则拥有最高否决权, 立即返回 false. */
return false;

/*
* 规则第二优先级: 处理 "yes ranges" (白名单).
* 如果白名单中的范围数量为零 (table->n_yes_ranges == 0),
* 这意味着 "凡不在黑名单中的, 皆被允许".
*/
if (!table->n_yes_ranges)
return true;

/*
* 规则第三优先级: 如果白名单不为空,
* 则意味着 "只有在白名单中明确列出的, 才被允许".
* 调用 regmap_reg_in_ranges 检查 reg 是否在 table->yes_ranges 列表中, 并返回其结果.
*/
return regmap_reg_in_ranges(reg, table->yes_ranges,
table->n_yes_ranges);
}
/* 将此函数导出, 使其对其他遵循GPL许可证的内核模块可用. */
EXPORT_SYMBOL_GPL(regmap_check_range_table);

Regmap 可访问性与易失性检查函数

regmap_readable: 检查寄存器是否可读

此函数的作用是在执行读操作之前, 检查一个给定的寄存器地址reg是否可以被安全地读取。这是防止因读取只写寄存器或访问不存在的”地址空洞”而导致总线错误或系统崩溃的关键保护措施。

其原理是一个拥有否决权的优先级列表。它会按顺序进行一系列检查, 任何一个检查结果为”否”, 都会立即判定该寄存器不可读。

工作流程:

  1. 基础能力: 首先检查regmap实例是否配置了底层的读函数(map->reg_read)。如果连基础的读能力都没有, 任何寄存器都不可读。
  2. 边界检查: 如果驱动程序在配置regmap时设定了最大寄存器地址(max_register), 则检查目标地址reg是否越界。
  3. 格式检查: 检查regmap是否被配置为特殊的只写格式(format.format_write)。
  4. 驱动回调 (最高优先级): 检查驱动是否提供了一个自定义的readable_reg回调函数。如果提供了, Regmap就将判断的责任完全委托给驱动自己的逻辑。
  5. 范围表查询: 如果没有回调函数, 则检查驱动是否提供了一个静态的可读范围表(rd_table)。它会使用这个表来判断reg是否落在一个定义好的可读区间内。
  6. 默认许可: 如果以上所有具有否决权的检查都通过了, Regmap就认为该寄存器是可读的, 返回true
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/*
* regmap_readable: 检查一个寄存器是否可读.
* @map: regmap实例的指针.
* @reg: 要检查的寄存器地址.
* @return: 如果可读, 返回true; 否则返回false.
*/
bool regmap_readable(struct regmap *map, unsigned int reg)
{
/* 否决条件1: regmap实例不支持读操作. */
if (!map->reg_read)
return false;

/* 否决条件2: 寄存器地址超出硬件范围. */
if (map->max_register_is_set && reg > map->max_register)
return false;

/* 否决条件3: regmap被配置为只写格式. */
if (map->format.format_write)
return false;

/* 优先策略1: 使用驱动提供的自定义函数来判断. */
if (map->readable_reg)
return map->readable_reg(map->dev, reg);

/* 优先策略2: 使用驱动提供的静态范围表来判断. */
if (map->rd_table)
return regmap_check_range_table(map, reg, map->rd_table);

/* 默认行为: 如果没有明确禁止, 则认为可读. */
return true;
}

regmap_volatile: 检查寄存器是否易失

此函数的作用是判断一个寄存器reg是否是”易失的”(volatile)。一个易失的寄存器, 其值可能在没有软件写入的情况下自行改变(例如, 一个包含硬件状态的STATUS寄存器)。这个信息对于_regmap_update_bits函数选择正确的、安全的更新策略(是使用总线级的原子更新还是软件的”读-改-写”)至关重要。

其原理与regmap_readable类似, 也是一个优先级列表, 但其默认行为取决于regmap是否启用了缓存

工作流程:

  1. 可读性前提: 一个不可读的寄存器, 从”读-改-写”的角度看没有易失性的概念, 因此直接返回false
  2. 驱动回调 (最高优先级): 检查并调用驱动提供的volatile_reg回调函数。
  3. 范围表查询: 如果没有回调, 则使用volatile_table易失范围表进行查询。
  4. 缓存决定默认行为 (关键逻辑):
    • 如果regmap启用了缓存 (map->cache_ops有效), 这意味着Regmap在内存中维护了寄存器值的副本。缓存机制的根本假设是寄存器值是稳定的(非易失的), 否则缓存就会失效。因此, 默认行为是返回false(非易失)
    • 如果regmap没有启用缓存, 框架会采取最保守、最安全的策略, 必须假设任何寄存器都可能在任何时候被硬件改变。因此, 默认行为是返回true(易失)

在STM32H750上, 大部分外设驱动(如GPIO, pinctrl)的regmap不启用缓存, 因为寄存器的值与物理世界或硬件状态紧密相关。因此, 对于这些驱动, regmap_volatile通常会默认返回true

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
/*
* regmap_volatile: 检查一个寄存器是否是易失的.
* @map: regmap实例的指针.
* @reg: 要检查的寄存器地址.
* @return: 如果是易失的, 返回true; 否则返回false.
*/
bool regmap_volatile(struct regmap *map, unsigned int reg)
{
/* 前提条件: 如果一个寄存器不可读, 就认为它不是易失的. */
if (!map->format.format_write && !regmap_readable(map, reg))
return false;

/* 优先策略1: 使用驱动提供的自定义函数来判断. */
if (map->volatile_reg)
return map->volatile_reg(map->dev, reg);

/* 优先策略2: 使用驱动提供的静态易失范围表来判断. */
if (map->volatile_table)
return regmap_check_range_table(map, reg, map->volatile_table);

/* 默认行为的决策点: */
if (map->cache_ops)
/* 如果启用了缓存, 则默认寄存器是非易失的. */
return false;
else
/* 如果没有启用缓存, 则为安全起见, 默认寄存器是易失的. */
return true;
}

_regmap_update_bits: Regmap的位更新操作

此函数是Linux内核Regmap子系统的核心内部函数之一。Regmap是一个通用的、与总线无关的硬件寄存器访问抽象层。此函数的特定作用是安全且高效地修改一个硬件寄存器中的一个或多个位(bitfield), 而不影响该寄存器中的其他位。这是设备驱动中最频繁的操作之一。

原理与工作流程:
该函数的核心是实现一个带优化的”读-改-写”(Read-Modify-Write)操作。它根据硬件的能力和配置, 智能地选择两种执行路径之一:

  1. 快路径 (Fast Path / 总线级更新):

    • 首先, 函数会检查底层总线驱动(如I2C, SPI)是否提供了一个硬件加速的、原子的reg_update_bits操作。
    • 同时, 它会通过regmap_volatile检查目标寄存器是否是易失的(即其值可能被硬件自行改变, 简单的读-改-写序列可能不安全)。
    • 如果这两个条件都满足, 函数会优先使用这个快路径。它直接调用总线驱动提供的函数, 将操作委托给硬件或总线控制器来完成, 这通常比软件序列更快、更安全。
  2. 慢路径 (Slow Path / 软件实现的读-改-写):

    • 如果快路径不可用(这是绝大多数内存映射IO设备的情况, 包括STM32), 函数会执行经典的软件序列:
      a. 读(Read): 调用_regmap_read读取寄存器的当前完整值。
      b. 改(Modify): 在内存中对读取到的值进行位操作:
      • tmp = orig & ~mask; : 使用mask的反码, 将需要修改的位清零, 其他位保持不变。
      • tmp |= val & mask; : 将val中对应mask位的值设置到tmp中。
        c. 写(Write): 在执行写操作之前, 进行一次至关重要的优化检查。只有在新计算出的值tmp与原始值orig不同, 或者被强制要求写入时, 才会真正调用_regmap_write将新值写回寄存器。这个检查避免了在值未改变时产生不必要的总线写操作, 这对于I2C等较慢的总线能显著提升性能, 同时也能减少对硬件的不必要扰动。

在STM32H750上的应用:
STM32的所有外设都是通过内存映射方式访问的, 其驱动程序(如pinctrl, clock, dma等)广泛使用regmap来访问控制寄存器。

  • 执行路径: 对于STM32, 其内部总线(AHB/APB)没有硬件级的reg_update_bits操作, 因此_regmap_update_bits总是会走”慢路径”, 即软件实现的读-改-写。
  • 原子性: 在STM32H750这样的单核抢占式系统上, 虽然不存在多核并行执行的问题, 但一个任务在执行读-改-写序列的中间过程时, 仍然可能被一个更高优先级的任务或中断处理程序抢占。Regmap框架通过其内部的锁(map->lock)来保护这个序列的执行, 确保了从_regmap_read_regmap_write的整个过程对于其他使用同一个regmap实例的任务来说是原子的, 从而避免了数据竞争。
  • 应用实例: 当stm32_pinctrl驱动需要改变PA5引脚的复用功能时, 它需要修改GPIOA->AFR[0]寄存器中对应的4个位, 而不影响该寄存器中用于控制其他引脚的位。此时, 它调用的regmap_update_bits()最终就会执行到此函数, 安全、正确地完成这一操作。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/* _regmap_update_bits: regmap的内部位更新函数 */
static int _regmap_update_bits(struct regmap *map, unsigned int reg,
unsigned int mask, unsigned int val,
bool *change, bool force_write)
{
int ret;
unsigned int tmp, orig;

/*
* 如果调用者提供了change指针, 先将其初始化为false.
* 这个指针用于向调用者报告是否真的发生了硬件写操作.
*/
if (change)
*change = false;

/*
* 快路径决策:
* 1. regmap_volatile(map, reg): 检查寄存器是否是易失的 (其值可能被硬件自行改变).
* 2. map->reg_update_bits: 检查底层总线驱动是否提供了硬件加速的、原子的位更新函数.
* 如果两个条件都满足, 则使用快路径.
*/
if (regmap_volatile(map, reg) && map->reg_update_bits) {
/* 获取最终的寄存器地址(考虑了地址偏移等). */
reg = regmap_reg_addr(map, reg);
/* 直接调用总线驱动提供的函数来完成操作. */
ret = map->reg_update_bits(map->bus_context, reg, mask, val);
/* 如果操作成功, 并且调用者关心, 则报告已发生改变. */
if (ret == 0 && change)
*change = true;
} else {
/*
* 慢路径: 软件实现的 "读-改-写" 序列.
* 在STM32上总是会走这条路径.
* Regmap内部的锁保证了此序列的原子性.
*/
/* 步骤1: 读(Read). 读取寄存器的当前完整值到 orig. */
ret = _regmap_read(map, reg, &orig);
if (ret != 0)
return ret; /* 如果读失败, 直接返回错误. */

/* 步骤2: 改(Modify). 在内存中计算出新值. */
tmp = orig & ~mask; // 使用掩码的反码, 将需要修改的位清零.
tmp |= val & mask; // 使用掩码, 将新值设置到目标位上.

/*
* 步骤3: 写(Write), 但带有优化.
* 仅在以下情况之一满足时才执行写操作:
* 1. force_write: 调用者强制要求写入.
* 2. (tmp != orig): 计算出的新值与原始值不同 (这是核心优化).
* 3. map->force_write_field: regmap被配置为总是写入.
*/
if (force_write || (tmp != orig) || map->force_write_field) {
ret = _regmap_write(map, reg, tmp);
if (ret == 0 && change) /* 如果写入成功, 报告已发生改变. */
*change = true;
}
}

/* 返回最终的操作结果码. */
return ret;
}

Regmap: 安全的寄存器位域读写操作

这一组函数是Linux内核regmap子系统的核心组成部分, 专门用于执行安全、原子、且与总线无关的**”读-修改-写” (Read-Modify-Write, RMW)操作。其根本原理是将对硬件寄存器中特定位域(bit-field)的修改, 抽象成一个与硬件无关的、受锁保护的原子操作, 从而彻底避免在并发环境下的竞态条件**。

这个功能在驱动开发中至关重要。一个硬件寄存器中常常包含多个控制不同功能的位域。如果两个内核线程(或一个线程和一个中断处理程序)试图同时修改同一个寄存器中的不同位域, 若不加保护地执行”读-修改-写”操作, 后一个写操作就会覆盖掉前一个写操作的结果, 导致设备行为异常。regmap框架通过在其内部封装锁机制, 完美地解决了这个问题。

函数的调用层次如下:

  1. 驱动程序最常调用的是regmap_field_write
  2. regmap_field_write是一个简化的封装, 它调用了功能更全的regmap_field_update_bits_base
  3. regmap_field_update_bits_base负责将”位域相关”的操作转换为”寄存器相关”的操作, 并调用最终的执行者regmap_update_bits_base
  4. regmap_update_bits_base负责加锁, 并调用更底层的函数来执行实际的RMW周期。

在STM32H750这样的单核系统中, 即使没有多核并发, 这种锁保护依然是绝对必需的。因为Linux内核可能是抢占式的(CONFIG_PREEMPT), 一个正在执行RMW操作的低优先级任务, 可能会在其”读”和”写”的中间被一个更高优先级的任务抢占; 或者更常见地, 被一个中断处理程序(ISR)打断, 而这个ISR可能恰好也要修改同一个寄存器。regmap的锁机制可以有效地防止这两种情况下的数据损坏。


regmap_field_write: (API) 写入一个寄存器位域

这是一个高层、便捷的API, 用于将一个值完整地写入到一个预先定义好的regmap_field中。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
/*
* 静态内联函数: regmap_field_write - 写入一个寄存器位域.
* @field: 指向要写入的 regmap_field 结构体的指针.
* @val: 要写入的值.
*/
static inline int regmap_field_write(struct regmap_field *field,
unsigned int val)
{
/*
* 此函数是 regmap_field_update_bits_base 的一个简单封装.
* 它直接调用核心函数, 并传递:
* - field: 要操作的位域.
* - mask = ~0: 一个所有位都为1的掩码. 当这个掩码与位域自身的掩码作用时,
* 效果就是 "修改此位域内的所有比特位".
* - val: 要写入的值.
* - change = NULL: 表示我们不关心寄存器的值是否真的发生了变化.
* - async = false: 表示这是一个同步操作.
* - force = false: 表示不强制更新(如果regmap有缓存, 且值未变, 可以跳过写操作).
*/
return regmap_field_update_bits_base(field, ~0, val,
NULL, false, false);
}

regmap_field_update_bits_base: (核心) 更新一个寄存器位域中的指定位

这是一个更底层的核心函数, 用于根据mask来更新field中的特定位。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
/**
* regmap_field_update_bits_base() - 对一个寄存器位域执行读-修改-写周期.
* @field: 要写入的寄存器位域.
* @mask: 要改变的位的掩码.
* @val: 要写入的值.
* @change: (输出参数)一个布尔值指针, 用于指示写操作是否真的发生.
* @async: 布尔值, 指示是否异步执行.
* @force: 布尔值, 指示是否强制更新.
*/
int regmap_field_update_bits_base(struct regmap_field *field,
unsigned int mask, unsigned int val,
bool *change, bool async, bool force)
{
/*
* 步骤1: 转换掩码.
* - mask << field->shift: 将用户提供的、相对于位域的掩码, 左移到它在整个寄存器中的正确位置.
* - & field->mask: 将移位后的掩码与位域自身的"全局"掩码进行按位与操作.
* 这是一个重要的安全措施, 确保最终的掩码不会超出该位域预先定义的边界.
*/
mask = (mask << field->shift) & field->mask;

/*
* 步骤2: 调用针对整个寄存器的更新函数.
* - field->regmap: 传递 regmap 句柄.
* - field->reg: 传递该位域所在的寄存器地址.
* - mask: 传递我们刚刚计算出的、在整个寄存器中有效的掩码.
* - val << field->shift: 将用户提供的、相对于位域的值, 左移到它在整个寄存器中的正确位置.
* - change, async, force: 直接透传这些选项.
*/
return regmap_update_bits_base(field->regmap, field->reg,
mask, val << field->shift,
change, async, force);
}
EXPORT_SYMBOL_GPL(regmap_field_update_bits_base);

regmap_update_bits_base: (基础) 对整个寄存器执行RMW

这是regmap RMW操作的最底层函数, 负责加锁和分发。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/**
* regmap_update_bits_base() - 对一个寄存器执行读-修改-写周期.
* @map: 要更新的寄存器映射.
* @reg: 要更新的寄存器.
* @mask: 要改变的位的掩码.
* @val: 掩码对应位的新值.
* @change: (输出参数)布尔值, 指示写操作是否真的发生.
* @async: 布尔值, 指示是否异步执行.
* @force: 布尔值, 指示是否强制更新.
*/
int regmap_update_bits_base(struct regmap *map, unsigned int reg,
unsigned int mask, unsigned int val,
bool *change, bool async, bool force)
{
int ret;

/*
* 步骤1: 加锁.
* map->lock 是一个函数指针, 它指向在创建 regmap 时根据总线类型(如I2C, SPI, MMIO)
* 和配置所决定的具体锁函数 (例如 spin_lock_irqsave, mutex_lock).
* map->lock_arg 是传递给锁函数的参数.
* 这是保证原子性的关键.
*/
map->lock(map->lock_arg);

/* 临时设置 regmap 的异步标志. 这主要用于有缓存的 regmap, 以优化操作. */
map->async = async;

/*
* 步骤2: 调用内部核心函数 _regmap_update_bits (未在此处展示).
* 这个内部函数会执行实际的 "读-修改-写" 逻辑:
* 1. 读取寄存器 'reg' 的当前值 (old_val).
* 2. 计算新值: new_val = (old_val & ~mask) | (val & mask).
* 3. 比较 new_val 和 old_val, 如果不同, 则将 new_val 写回寄存器, 并设置 *change 为 true.
*/
ret = _regmap_update_bits(map, reg, mask, val, change, force);

/* 恢复 regmap 的异步标志为默认值. */
map->async = false;

/*
* 步骤3: 解锁.
* map->unlock 也是一个函数指针, 指向对应的解锁函数.
*/
map->unlock(map->lock_arg);

/* 返回核心操作的结果. */
return ret;
}
EXPORT_SYMBOL_GPL(regmap_update_bits_base);

drivers/base/map.c

kobj_map_init

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
struct kobj_map *kobj_map_init(kobj_probe_t *base_probe, struct mutex *lock)
{
struct kobj_map *p = kmalloc(sizeof(struct kobj_map), GFP_KERNEL);
struct probe *base = kzalloc(sizeof(*base), GFP_KERNEL);
int i;

if ((p == NULL) || (base == NULL)) {
kfree(p);
kfree(base);
return NULL;
}

base->dev = 1;
base->range = ~0;
base->get = base_probe;
for (i = 0; i < 255; i++)
p->probes[i] = base;
p->lock = lock;
return p;
}