Linux regmap架构学习
一、内核3.1引入一套新的API regmap,目的是提取出关于I2C SPI irq等相关注册、使能以及读写的公共部分,以提高代码的可重用性,并且使得在使用如上内核基础组件时变得更为简单易用。主要目的是减少慢速 I/O 驱动上的重复逻辑,提供一种通用的接口来操作底层硬件上的寄存器。其实这就是内核做的一次重构。Regmap 除了能做到统一的 I/O 接口,还可以在驱动和硬件 IC 之间做一层缓存,从而能减少底层 I/O 的操作次数。
二、传统操作寄存器的方式与 Regmap 之间的差异。
1、传统读写i2c方式如下:
/* return 0 on success, others on failure */
static int xxx_i2c_read(struct i2c_client *client, u8 *buf, u32 len)
{
int ret = 0, retries;
int addr_len = 1; /* default length is 1 byte */
struct i2c_msg msgs[2];
/* write register */
msgs[0].flags = !I2C_M_RD;
msgs[0].addr = client->addr;
msgs[0].len = addr_len;
msgs[0].buf = &buf[0];
/* read data */
msgs[1].flags = I2C_M_RD;
msgs[1].addr = client->addr;
msgs[1].len = len - addr_len;
msgs[1].buf = &buf[addr_len];
for (retries = 0; retries < 5; retries++) {
ret = i2c_transfer(client->adapter, msgs, 2);
if (ret == 2)
return 0;
}
dev_err(&client->dev, "i2c_transfer() returned %d\n", ret);
return ret;
}
/* return 0 on success, others on failure */
static int xxx_i2c_write(struct i2c_client *client, u8 *buf, u32 len)
{
int ret = 0, retries;
struct i2c_msg msg;
msg.flags = !I2C_M_RD;
msg.addr = client->addr;
msg.len = len;
msg.buf = buf;
for (retries = 0; retries < 5; retries++) {
ret = i2c_transfer(client->adapter, &msg, 1);
if (ret == 1)
return 0;
}
dev_err(&client->dev, "i2c_transfer() returned %d\n", ret);
return ret;
}
2、regmap 的方式读写i2c方式如下:
// first step: define regmap_config
static const struct regmap_config xxx_regmap_config = {
.reg_bits = 10,
.val_bits = 14,
.max_register = 40,
.cache_type = REGCACHE_RBTREE,
.volatile_reg = false,
.readable_reg = false,
};
// second step: initialize regmap in driver loading
regmap = regmap_init_i2c(i2c_client, &xxx_regmap_config);
// third step: register operations
regmap_read(regmap, XXX_REG, &value);
regmap_write(act8865->regmap, act8865->off_reg, act8865->off_mask);
三、regmap_config 结构体介绍。
struct regmap_config {
int reg_bits; // 寄存器地址的位数,必须配置,例如I2C寄存器地址位数为 8
int pad_bits; // 寄存器值的位数,必须配置
int val_bits;
bool (*writeable_reg)(struct device *dev, unsigned int reg); // 可写寄存器回调,maintain一个可写寄存器表
bool (*readable_reg)(struct device *dev, unsigned int reg); // 可读寄存器回调, maintain一个可读寄存器表
bool (*volatile_reg)(struct device *dev, unsigned int reg); // 可要求读写立即生效的寄存器回调,不可以被cache,maintain一个可立即生效寄存器表
bool (*precious_reg)(struct device *dev, unsigned int reg); // 要求寄存器数值维持在一个数值范围才正确,maintain一个数值准确表
unsigned int max_register; // max_register: 最大寄存器地址
const struct reg_default *reg_defaults;
unsigned int num_reg_defaults;
enum regcache_type cache_type;
const void *reg_defaults_raw;
unsigned int num_reg_defaults_raw;
u8 read_flag_mask;
u8 write_flag_mask;
};
四、初始化regmap,前两个是用来关联i2c或者spi设备和regmap_config的,第三个用来在关联后的regmap上注册 irq。
regmap_init_i2c(struct i2c_client *i2c, struct regmap_config *config);
regmap_init_spi(struct spi_device *spi, strcut regmap_config *config);
regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags, int irq_base, struct regmap_irq_chip *chip, struct regmap_irq_chip_data **data);
五、初始化好regmap之后,就可以调用regmap提供的read/write/update等操作了。
regmap_write(struct regmap *map, int reg, int val); // 向reg写入val
regmap_raw_write(struct regmap *map, int reg, void *val, size_t val_len); // 向reg写入指定长度的数据,数据存放在val中
regmap_read(struct regmap *map, int reg, int *val); // 读取reg的数据到val中
regmap_raw_read(struct regmap *map, int reg, void *val, size_t val_len); // 读取reg中指定长度的数据
regmap_bulk_read(struct regmap *map, int reg, void *val, size_t val_count); // 读取从reg开始之后val_count个寄存器的数据到val中
regmap_update_bits(struct regmap *map, int reg, int mask, int val); // 更新reg寄存器中mask指定的位
regcache_cache_bypass(arizona->regmap, true); // 设置读写寄存器不通过cache模式而是bypass模式,读写立即生效,一般在audio等确保时序性驱动中用到
六、释放regmap。
regmap_exit(struct regmap *map);
七,实际应用代码。
六、参考文章。
http://tinylab.org/kernel-explore-regmap-framework/
https://www.cnblogs.com/gesaint/p/3985798.html