I2C EEPROM 驱动更多...

#include <xwos/standard.h>
#include <xwcd/ds/i2c/peripheral.h>
#include <xwcd/peripheral/i2c/eeprom/device.h>

driver.h 的引用(Include)关系图:

此图展示该文件直接或间接的被哪些文件引用了:

结构体
struct	xwds_eeprom_driver
	EEPROM驱动函数表更多...

const struct xwds_eeprom_driver	at24sd_drv

const struct xwds_eeprom_driver	at24md_drv

xwer_t	xwds_eeprom_drv_start (struct xwds_device *dev)
	EEPROM基本驱动：启动设备

xwer_t	xwds_eeprom_drv_stop (struct xwds_device *dev)
	EEPROM基本驱动：停止设备

xwer_t	xwds_eeprom_drv_resume (struct xwds_device *dev)
	EEPROM基本驱动：暂停设备

xwer_t	xwds_eeprom_drv_suspend (struct xwds_device *dev)
	EEPROM基本驱动：继续设备

xwer_t	xwds_eeprom_power_on (struct xwds_eeprom *eeprom)
	EEPROM API：开启EEPROM的电源

xwer_t	xwds_eeprom_power_off (struct xwds_eeprom *eeprom)
	EEPROM API：关闭EEPROM的电源

xwer_t	xwds_eeprom_wp_enable (struct xwds_eeprom *eeprom)
	EEPROM API：开启EEPROM的写保护

xwer_t	xwds_eeprom_wp_disable (struct xwds_eeprom *eeprom)
	EEPROM API：关闭EEPROM的写保护

xwer_t	xwds_eeprom_putc (struct xwds_eeprom *eeprom, xwu8_t data, xwsq_t addr, xwtm_t to)
	EEPROM API：写一个字节到EEPROM

xwer_t	xwds_eeprom_getc (struct xwds_eeprom eeprom, xwu8_t buf, xwsq_t addr, xwtm_t to)
	EEPROM API：从EEPROM中读取一个字节

xwer_t	xwds_eeprom_pgwrite (struct xwds_eeprom eeprom, xwu8_t data, xwsz_t *size, xwsq_t pgidx, xwtm_t to)
	EEPROM API：写一页数据到EEPROM

xwer_t	xwds_eeprom_pgread (struct xwds_eeprom eeprom, xwu8_t buf, xwsz_t *size, xwsq_t pgidx, xwtm_t to)
	EEPROM API：从EEPROM读一页数据

xwer_t	xwds_eeprom_reset (struct xwds_eeprom *eeprom, xwtm_t to)
	EEPROM API：复位EEPROM的I2C总线

详细描述

I2C EEPROM 驱动

作者

隐星魂 (Roy Sun) xwos@.nosp@m.xwos.nosp@m..tech

Copyright © 2015 xwos.tech, All Rights Reserved.
‍Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
```
  http://www.apache.org/licenses/LICENSE-2.0
```
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

注解

所有API只可被单一线程访问。

在文件 driver.h 中定义.

函数说明

◆ xwds_eeprom_drv_resume()

xwer_t xwds_eeprom_drv_resume ( struct xwds_device * dev )

EEPROM基本驱动：暂停设备

在文件 driver.c 第 114 行定义.

{
        return xwds_eeprom_drv_start(dev);
}

函数调用图:

◆ xwds_eeprom_drv_start()

xwer_t xwds_eeprom_drv_start ( struct xwds_device * dev )

EEPROM基本驱动：启动设备

<No error

在文件 driver.c 第 48 行定义.

{
        struct xwds_eeprom * eeprom;
        const struct xwds_resource_gpio * gpiorsc;
        xwer_t rc;
 
        eeprom = xwds_cast(struct xwds_eeprom *, dev);
        rc = xwds_eeprom_check_desc(eeprom);
        if (rc < 0) {
                goto err_chk_desc;
        }
        /* request GPIO resources */
        gpiorsc = eeprom->pwr_gpiorsc;
        if (NULL != gpiorsc) {
                rc = xwds_gpio_req(gpiorsc->soc, gpiorsc->port, gpiorsc->pinmask);
                if (rc < 0) {
                        goto err_pwrgpio_req;
                }
        }
        gpiorsc = eeprom->wp_gpiorsc;
        if (NULL != gpiorsc) {
                rc = xwds_gpio_req(gpiorsc->soc, gpiorsc->port, gpiorsc->pinmask);
                if (rc < 0) {
                        goto err_wpgpio_req;
                }
        }
        return XWOK;
 
err_wpgpio_req:
        gpiorsc = eeprom->pwr_gpiorsc;
        if (NULL != gpiorsc) {
                xwds_gpio_rls(gpiorsc->soc, gpiorsc->port, gpiorsc->pinmask);
        }
err_pwrgpio_req:
err_chk_desc:
        return rc;
}

函数调用图:

这是这个函数的调用关系图:

◆ xwds_eeprom_drv_stop()

xwer_t xwds_eeprom_drv_stop ( struct xwds_device * dev )

EEPROM基本驱动：停止设备

<No error

在文件 driver.c 第 87 行定义.

{
        struct xwds_eeprom * eeprom;
        const struct xwds_resource_gpio * gpiorsc;
 
        eeprom = xwds_cast(struct xwds_eeprom *, dev);
        /* release GPIO resources */
        gpiorsc = eeprom->wp_gpiorsc;
        if (NULL != gpiorsc) {
                xwds_gpio_rls(gpiorsc->soc, gpiorsc->port, gpiorsc->pinmask);
        }
        gpiorsc = eeprom->pwr_gpiorsc;
        if (NULL != gpiorsc) {
                xwds_gpio_rls(gpiorsc->soc, gpiorsc->port, gpiorsc->pinmask);
        }
 
        return XWOK;
}

函数调用图:

这是这个函数的调用关系图:

◆ xwds_eeprom_drv_suspend()

xwer_t xwds_eeprom_drv_suspend ( struct xwds_device * dev )

EEPROM基本驱动：继续设备

在文件 driver.c 第 108 行定义.

{
        return xwds_eeprom_drv_stop(dev);
}

函数调用图:

◆ xwds_eeprom_getc()

xwer_t xwds_eeprom_getc	(	struct xwds_eeprom *	eeprom,
		xwu8_t *	buf,
		xwsq_t	addr,
		xwtm_t	to
	)

EEPROM API：从EEPROM中读取一个字节

参数

[in]	eeprom	I2C EEPROM对象的指针
[out]	buf	指向缓冲区的指针，通过此缓冲区返回数据
[in]	addr	地址
[in]	to	期望唤醒的时间点 @retrun 错误码

返回值

XWOK	没有错误
-EINVAL	设备对象不可引用
-ESHUTDOWN	设备没有运行
-EADDRNOTAVAIL	地址无响应
-ETIMEDOUT	超时

注解

上下文：线程

to 表示等待超时的时间点：

to 通常是未来的时间，即 当前系统时间 + delta ，可以使用 xwtm_ft(delta) 表示；
如果 to 是过去的时间点，将直接返回 -ETIMEDOUT 。

在文件 driver.c 第 203 行定义.

{
        const struct xwds_eeprom_driver * drv;
        xwer_t rc;
 
        drv = xwds_cast(const struct xwds_eeprom_driver *, eeprom->i2cp.dev.drv);
        if ((drv) && (drv->getc)) {
                rc = drv->getc(eeprom, buf, addr, to);
        } else {
                rc = -ENOSYS;
        }
        return rc;
}

◆ xwds_eeprom_pgread()

xwer_t xwds_eeprom_pgread	(	struct xwds_eeprom *	eeprom,
		xwu8_t *	buf,
		xwsz_t *	size,
		xwsq_t	pgidx,
		xwtm_t	to
	)

EEPROM API：从EEPROM读一页数据

参数

[in]	eeprom	I2C EEPROM对象的指针
[out]	buf	指向缓冲区的指针，通过此缓冲区返回数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示数据的大小 (O) 作为输出时，返回实际写入的数据大小
[in]	pgidx	页的序号
[in]	to	期望唤醒的时间点 @retrun 错误码

返回值

XWOK	没有错误
-EINVAL	设备对象不可引用
-ESHUTDOWN	设备没有运行
-EADDRNOTAVAIL	地址无响应
-ETIMEDOUT	超时

注解

上下文：线程

to 表示等待超时的时间点：

to 通常是未来的时间，即 当前系统时间 + delta ，可以使用 xwtm_ft(delta) 表示；
如果 to 是过去的时间点，将直接返回 -ETIMEDOUT 。

在文件 driver.c 第 237 行定义.

{
        const struct xwds_eeprom_driver * drv;
        xwer_t rc;
 
        drv = xwds_cast(const struct xwds_eeprom_driver *, eeprom->i2cp.dev.drv);
        if ((drv) && (drv->pgread)) {
                rc = drv->pgread(eeprom, buf, size, pgidx, to);
        } else {
                rc = -ENOSYS;
        }
        return rc;
}

◆ xwds_eeprom_pgwrite()

xwer_t xwds_eeprom_pgwrite	(	struct xwds_eeprom *	eeprom,
		xwu8_t *	data,
		xwsz_t *	size,
		xwsq_t	pgidx,
		xwtm_t	to
	)

EEPROM API：写一页数据到EEPROM

参数

[in]	eeprom	I2C EEPROM对象的指针
[in]	data	待写入的数据的缓冲区
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示数据的大小 (O) 作为输出时，返回实际写入的数据大小
[in]	pgidx	页的序号
[in]	to	期望唤醒的时间点 @retrun 错误码

返回值

XWOK	没有错误
-EINVAL	设备对象不可引用
-ESHUTDOWN	设备没有运行
-EADDRNOTAVAIL	地址无响应
-ETIMEDOUT	超时

注解

上下文：线程

to 表示等待超时的时间点：

to 通常是未来的时间，即 当前系统时间 + delta ，可以使用 xwtm_ft(delta) 表示；
如果 to 是过去的时间点，将直接返回 -ETIMEDOUT 。

在文件 driver.c 第 220 行定义.

{
        const struct xwds_eeprom_driver * drv;
        xwer_t rc;
 
        drv = xwds_cast(const struct xwds_eeprom_driver *, eeprom->i2cp.dev.drv);
        if ((drv) && (drv->pgwrite)) {
                rc = drv->pgwrite(eeprom, data, size, pgidx, to);
        } else {
                rc = -ENOSYS;
        }
        return rc;
}

◆ xwds_eeprom_power_off()

xwer_t xwds_eeprom_power_off ( struct xwds_eeprom * eeprom )

EEPROM API：关闭EEPROM的电源

参数

[in] eeprom I2C EEPROM对象的指针 @retrun 错误码

注解

上下文：线程、中断底半部、线程

在文件 driver.c 第 138 行定义.

{
        xwer_t rc;
 
        if (eeprom->pwr_gpiorsc) {
                const struct xwds_resource_gpio * gpiorsc = eeprom->pwr_gpiorsc;
                rc = xwds_gpio_reset(gpiorsc->soc,
                                     gpiorsc->port,
                                     gpiorsc->pinmask);
        } else {
                rc = -ENOSYS;
        }
        return rc;
}

函数调用图:

◆ xwds_eeprom_power_on()

xwer_t xwds_eeprom_power_on ( struct xwds_eeprom * eeprom )

EEPROM API：开启EEPROM的电源

参数

[in] eeprom I2C EEPROM对象的指针 @retrun 错误码

注解

上下文：线程、中断底半部、线程

在文件 driver.c 第 122 行定义.

{
        xwer_t rc;
 
        if (eeprom->pwr_gpiorsc) {
                const struct xwds_resource_gpio * gpiorsc = eeprom->pwr_gpiorsc;
                rc = xwds_gpio_set(gpiorsc->soc,
                                   gpiorsc->port,
                                   gpiorsc->pinmask);
        } else {
                rc = -ENOSYS;
        }
        return rc;
}

函数调用图:

◆ xwds_eeprom_putc()

xwer_t xwds_eeprom_putc	(	struct xwds_eeprom *	eeprom,
		xwu8_t	data,
		xwsq_t	addr,
		xwtm_t	to
	)

EEPROM API：写一个字节到EEPROM

参数

[in]	eeprom	I2C EEPROM对象的指针
[in]	data	数据
[in]	addr	地址
[in]	to	期望唤醒的时间点 @retrun 错误码

返回值

XWOK	没有错误
-EINVAL	设备对象不可引用
-ESHUTDOWN	设备没有运行
-EADDRNOTAVAIL	地址无响应
-ETIMEDOUT	超时

注解

上下文：线程

to 表示等待超时的时间点：

to 通常是未来的时间，即 当前系统时间 + delta ，可以使用 xwtm_ft(delta) 表示；
如果 to 是过去的时间点，将直接返回 -ETIMEDOUT 。

在文件 driver.c 第 186 行定义.

{
        const struct xwds_eeprom_driver * drv;
        xwer_t rc;
 
        drv = xwds_cast(const struct xwds_eeprom_driver *, eeprom->i2cp.dev.drv);
        if ((drv) && (drv->putc)) {
                rc = drv->putc(eeprom, data, addr, to);
        } else {
                rc = -ENOSYS;
        }
        return rc;
}

◆ xwds_eeprom_reset()

xwer_t xwds_eeprom_reset	(	struct xwds_eeprom *	eeprom,
		xwtm_t	to
	)

EEPROM API：复位EEPROM的I2C总线

参数

[in]	eeprom	I2C EEPROM对象的指针
[in]	to	期望唤醒的时间点 @retrun 错误码

返回值

XWOK	没有错误
-EINVAL	设备对象不可引用
-ESHUTDOWN	设备没有运行
-EADDRNOTAVAIL	地址无响应
-ETIMEDOUT	超时

注解

上下文：线程

to 表示等待超时的时间点：

to 通常是未来的时间，即 当前系统时间 + delta ，可以使用 xwtm_ft(delta) 表示；
如果 to 是过去的时间点，将直接返回 -ETIMEDOUT 。

<No error

在文件 driver.c 第 254 行定义.

{
        struct xwds_i2c_msg msg;
        xwu8_t dummy;
        xwer_t rc;
 
        dummy = 0xFF;
        msg.addr = 0xFE;
        msg.flag = XWDS_I2C_F_START | XWDS_I2C_F_WR;
        msg.data = &dummy;
        msg.size = 1;
        rc = xwds_i2cm_xfer(eeprom->i2cp.bus, &msg, to);
        if (-EADDRNOTAVAIL == rc) {
                msg.flag = XWDS_I2C_F_START | XWDS_I2C_F_WR | XWDS_I2C_F_STOP;
                msg.data = NULL;
                msg.size = 0;
                rc = xwds_i2cm_xfer(eeprom->i2cp.bus, &msg, to);
                if (-EADDRNOTAVAIL == rc) {
                        rc = XWOK;
                }
        }
        return rc;
}

函数调用图:

◆ xwds_eeprom_wp_disable()

xwer_t xwds_eeprom_wp_disable ( struct xwds_eeprom * eeprom )

EEPROM API：关闭EEPROM的写保护

参数

[in] eeprom I2C EEPROM对象的指针 @retrun 错误码

注解

上下文：线程、中断底半部、线程

在文件 driver.c 第 170 行定义.

{
        xwer_t rc;
 
        if (eeprom->wp_gpiorsc) {
                const struct xwds_resource_gpio * gpiorsc = eeprom->wp_gpiorsc;
                rc = xwds_gpio_reset(gpiorsc->soc,
                                     gpiorsc->port,
                                     gpiorsc->pinmask);
        } else {
                rc = -ENOSYS;
        }
        return rc;
}

函数调用图:

◆ xwds_eeprom_wp_enable()

xwer_t xwds_eeprom_wp_enable ( struct xwds_eeprom * eeprom )

EEPROM API：开启EEPROM的写保护

参数

[in] eeprom I2C EEPROM对象的指针 @retrun 错误码

注解

上下文：线程、中断底半部、线程

在文件 driver.c 第 154 行定义.

{
        xwer_t rc;
 
        if (eeprom->wp_gpiorsc) {
                const struct xwds_resource_gpio * gpiorsc = eeprom->wp_gpiorsc;
                rc = xwds_gpio_set(gpiorsc->soc,
                                   gpiorsc->port,
                                   gpiorsc->pinmask);
        } else {
                rc = -ENOSYS;
        }
        return rc;
}

函数调用图:

变量说明

◆ at24md_drv

const struct xwds_eeprom_driver at24md_drv

extern

在文件 at24md.c 第 46 行定义.

◆ at24sd_drv

const struct xwds_eeprom_driver at24sd_drv

extern

在文件 at24sd.c 第 46 行定义.

结构体

详细描述

函数说明

◆ xwds_eeprom_drv_resume()

◆ xwds_eeprom_drv_start()

◆ xwds_eeprom_drv_stop()

◆ xwds_eeprom_drv_suspend()

◆ xwds_eeprom_getc()

◆ xwds_eeprom_pgread()

◆ xwds_eeprom_pgwrite()

◆ xwds_eeprom_power_off()

◆ xwds_eeprom_power_on()

◆ xwds_eeprom_putc()

◆ xwds_eeprom_reset()

◆ xwds_eeprom_wp_disable()

◆ xwds_eeprom_wp_enable()

变量说明

◆ at24md_drv

◆ at24sd_drv