Merge tag 'u-boot-atmel-2020.04-a' of https://gitlab.denx.de/u-boot/custodians/u...
[oweals/u-boot.git] / include / i2c_eeprom.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Copyright (c) 2014 Google, Inc
4  */
5
6 #ifndef __I2C_EEPROM
7 #define __I2C_EEPROM
8
9 struct i2c_eeprom_ops {
10         int (*read)(struct udevice *dev, int offset, uint8_t *buf, int size);
11         int (*write)(struct udevice *dev, int offset, const uint8_t *buf,
12                      int size);
13         int (*size)(struct udevice *dev);
14 };
15
16 struct i2c_eeprom {
17         /* The EEPROM's page size in byte */
18         unsigned long pagesize;
19         /* The EEPROM's page width in bits (pagesize = 2^pagewidth) */
20         unsigned pagewidth;
21         /* The EEPROM's capacity in bytes */
22         unsigned long size;
23 };
24
25 /*
26  * i2c_eeprom_read() - read bytes from an I2C EEPROM chip
27  *
28  * @dev:        Chip to read from
29  * @offset:     Offset within chip to start reading
30  * @buf:        Place to put data
31  * @size:       Number of bytes to read
32  *
33  * @return 0 on success, -ve on failure
34  */
35 int i2c_eeprom_read(struct udevice *dev, int offset, uint8_t *buf, int size);
36
37 /*
38  * i2c_eeprom_write() - write bytes to an I2C EEPROM chip
39  *
40  * @dev:        Chip to write to
41  * @offset:     Offset within chip to start writing
42  * @buf:        Buffer containing data to write
43  * @size:       Number of bytes to write
44  *
45  * @return 0 on success, -ve on failure
46  */
47 int i2c_eeprom_write(struct udevice *dev, int offset, uint8_t *buf, int size);
48
49 /*
50  * i2c_eeprom_size() - get size of I2C EEPROM chip
51  *
52  * @dev:        Chip to query
53  *
54  * @return +ve size in bytes on success, -ve on failure
55  */
56 int i2c_eeprom_size(struct udevice *dev);
57
58 #endif