Skip to contentSkip to conversation

misc/at24: distinguish between eeprom and fram chips

RFC PATCH In review Lars Poeschel 2 participants 10 messages Dec 4, 2012 – Feb 11, 2013

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

RFC PATCH 1/1 misc/at24: distinguish between eeprom and fram chips

Hello!

I wanted to use a fm24c04 i2c fram chip with linux. I grepped the source and found nothing. I later found that my chip can be handled by at24 eeprom driver. It creates a sysfs file called eeprom to read from and write to the chip. Userspace has no chance to distinguish if it is writing an eeprom or a fram chip.

I present this patch for 3 reasons:
1. For other people grepping finding a little more reference.
2. For userspace being able to distinguish eeprom and fram.
3. Raising the bytes per write for fram chips.

What do you kernel developers think ?

Cheers,
Lars
-- >8 --

Quoted 1 line

From 4fab49fae62390995868e3b6dee7e0693fce5be9 Mon Sep 17 00:00:00 2001

From: Lars Poeschel <[email protected]>
Date: Tue, 4 Dec 2012 15:41:40 +0100
Subject: [PATCH] misc/at24: distinguish between eeprom and fram chips

Add a AT24_FLAGS_FRAM state to the flags to make userspace able to distinguish if it is using eeprom or fram. The sysfs entry gets the name "fram" instead of "eeprom".
For frams the bytes/write can be at least 128 bytes, since these chips have no need to internally buffer writes.

drivers/misc/eeprom/Kconfig +6 -0
index c9e695e..55948a5 100644
@@ -12,6 +12,12 @@ config EEPROM_AT24
 	     24c00, 24c01, 24c02, spd (readonly 24c02), 24c04, 24c08,
 	     24c16, 24c32, 24c64, 24c128, 24c256, 24c512, 24c1024
 
+	  This driver also supports I2C FRAM chips that are feature
+	  compatible to the 24cxx ones. In your at24_platform_data set
+	  .flags = AT24_FLAG_FRAM. These generic names are supported:
+
+	     fm24c04
+
 	  Unless you like data loss puzzles, always be sure that any chip
 	  you configure as a 24c32 (32 kbit) or larger is NOT really a
 	  24c16 (16 kbit) or smaller, and vice versa. Marking the chip
drivers/misc/eeprom/at24.c +1 -0
index ab1ad41..02a03a1 100644
@@ -125,6 +125,7 @@ static const struct i2c_device_id at24_ids[] = {
 	{ "24c256", AT24_DEVICE_MAGIC(262144 / 8, AT24_FLAG_ADDR16) },
 	{ "24c512", AT24_DEVICE_MAGIC(524288 / 8, AT24_FLAG_ADDR16) },
 	{ "24c1024", AT24_DEVICE_MAGIC(1048576 / 8, AT24_FLAG_ADDR16) },
+	{ "fm24c04", AT24_DEVICE_MAGIC(4096 / 8, AT24_FLAG_FRAM) },
 	{ "at24", 0 },
 	{ /* END OF LIST */ }
 };
@@ -504,8 +505,13 @@ static int at24_probe(struct i2c_client *client, const 

struct i2c_device_id *id)
* This is slow, but we can't know all eeproms, so we better
* play safe. Specifying custom eeprom-types via platform_data
* is recommended anyhow.
+ * For fram chips, we can allow minmum 128 bytes, as there is
+ * no page size and 128 is the smallest so far seen chip.
*/
- chip.page_size = 1;
+ if (chip.flags & AT24_FLAG_FRAM)
+ chip.page_size = 128;
+ else
+ chip.page_size = 1;

/* update chipdata if OF is present */ at24_get_ofdata(client, &chip);
@@ -570,7 +576,10 @@ static int at24_probe(struct i2c_client *client, const struct i2c_device_id *id)
* By default, only root should see the data (maybe passwords etc) */
sysfs_bin_attr_init(&at24->bin);
- at24->bin.attr.name = "eeprom";
+ if (chip.flags & AT24_FLAG_FRAM)
+ at24->bin.attr.name = "fram";
+ else
+ at24->bin.attr.name = "eeprom";
at24->bin.attr.mode = chip.flags & AT24_FLAG_IRUGO ? S_IRUGO : S_IRUSR; at24->bin.read = at24_bin_read;
at24->bin.size = chip.byte_len;

include/linux/i2c/at24.h +1 -0
index 285025a..d786b71 100644
@@ -47,6 +47,7 @@ struct at24_platform_data {
 #define AT24_FLAG_READONLY	0x40	/* sysfs-entry will be read-only */
 #define AT24_FLAG_IRUGO		0x20	/* sysfs-entry will be world-readable */
 #define AT24_FLAG_TAKE8ADDR	0x10	/* take always 8 addresses (24c00) */
+#define AT24_FLAG_FRAM          0x08    /* chip is fram not eeprom */
 
 	void		(*setup)(struct memory_accessor *, void *context);
 	void		*context;
Signature · 1 line
1.7.10.4
#1 lore raw

Hi,

Quoted 5 lines

I wanted to use a fm24c04 i2c fram chip with linux. I grepped the source and found nothing. I later found that my chip can be handled by at24 eeprom driver. It creates a sysfs file called eeprom to read from and write to the chip. Userspace has no chance to distinguish if it is writing an eeprom or a fram chip.

Why should it?

Quoted 2 lines

I present this patch for 3 reasons:
1. For other people grepping finding a little more reference.

Yes. The Kconfig entry could be updated to mention not only EEPROMs.

Quoted 1 line

2. For userspace being able to distinguish eeprom and fram.

Why?

Quoted 1 line

3. Raising the bytes per write for fram chips.

Properly configuring the chip (including proper page_size) is the way to go IMO. Read on...

Quoted 24 lines

What do you kernel developers think ?

Cheers,
Lars
-- >8 --
From 4fab49fae62390995868e3b6dee7e0693fce5be9 Mon Sep 17 00:00:00 2001
From: Lars Poeschel <[email protected]>
Date: Tue, 4 Dec 2012 15:41:40 +0100
Subject: [PATCH] misc/at24: distinguish between eeprom and fram chips

Add a AT24_FLAGS_FRAM state to the flags to make userspace able to distinguish if it is using eeprom or fram. The sysfs entry gets the name "fram" instead of "eeprom".
For frams the bytes/write can be at least 128 bytes, since these chips have no need to internally buffer writes.

drivers/misc/eeprom/Kconfig +0 -0
index c9e695e..55948a5 100644

drivers/misc/eeprom/Kconfig config EEPROM_AT24 · line 20

Quoted 9 lines
drivers/misc/eeprom/Kconfig +6 -0
@@ -12,6 +12,12 @@ config EEPROM_AT24
 	     24c00, 24c01, 24c02, spd (readonly 24c02), 24c04, 24c08,
 	     24c16, 24c32, 24c64, 24c128, 24c256, 24c512, 24c1024
 
+	  This driver also supports I2C FRAM chips that are feature
+	  compatible to the 24cxx ones. In your at24_platform_data set
+	  .flags = AT24_FLAG_FRAM. These generic names are supported:
+
+	     fm24c04
+

The method of accessing EEPROMs is used by way more chips than FRAMs. So, I'd prefer to have the text updated more generic like "EEPROMs and similar devices like RAMs, ROMs, etc...". Describing setting .flags in Kconfig is overkill.

drivers/misc/eeprom/at24.c static const struct i2c_device_id at24_ids[] = { · line 128

Quoted 12 lines
drivers/misc/eeprom/Kconfig +0 -0
 	  Unless you like data loss puzzles, always be sure that any chip
 	  you configure as a 24c32 (32 kbit) or larger is NOT really a
 	  24c16 (16 kbit) or smaller, and vice versa. Marking the chip
drivers/misc/eeprom/at24.c +1 -0
index ab1ad41..02a03a1 100644
@@ -125,6 +125,7 @@ static const struct i2c_device_id at24_ids[] = {
 	{ "24c256", AT24_DEVICE_MAGIC(262144 / 8, AT24_FLAG_ADDR16) },
 	{ "24c512", AT24_DEVICE_MAGIC(524288 / 8, AT24_FLAG_ADDR16) },
 	{ "24c1024", AT24_DEVICE_MAGIC(1048576 / 8, AT24_FLAG_ADDR16) },
+	{ "fm24c04", AT24_DEVICE_MAGIC(4096 / 8, AT24_FLAG_FRAM) },

The 24cxxx entries are last resort fallbacks to give you minimal access. They also do this for your FRAM correctly. For proper setup, you need custom configuration anyhow. There, you can define the page_size as well as the permissions for the created file. So, no to this change.

Quoted 6 lines
drivers/misc/eeprom/at24.c +0 -0
 	{ "at24", 0 },
 	{ /* END OF LIST */ }
 };
@@ -504,8 +505,13 @@ static int at24_probe(struct i2c_client *client, const 
 struct i2c_device_id *id)
 		 * This is slow, but we can't know all eeproms, so we better

drivers/misc/eeprom/at24.c static int at24_probe(struct i2c_client *client, const · line 515

Quoted 10 lines
drivers/misc/eeprom/at24.c +6 -1
 		 * play safe. Specifying custom eeprom-types via platform_data
 		 * is recommended anyhow.
+		 * For fram chips, we can allow minmum 128 bytes, as there is
+		 * no page size and 128 is the smallest so far seen chip.
 		 */
-		chip.page_size = 1;
+		if (chip.flags & AT24_FLAG_FRAM)
+			chip.page_size = 128;
+		else
+			chip.page_size = 1;

I'd think most FRAMs can have the chip_size as the page_size since they probably don't do buffering. But do you know for all the chips out there? So, let's still play safe. If you want performance, you need to setup the driver properly.

drivers/misc/eeprom/at24.c static int at24_probe(struct i2c_client *client, const · line 583

Quoted 13 lines
drivers/misc/eeprom/at24.c +4 -1
 		/* update chipdata if OF is present */
 		at24_get_ofdata(client, &chip);
@@ -570,7 +576,10 @@ static int at24_probe(struct i2c_client *client, const 
 struct i2c_device_id *id)
 	 * By default, only root should see the data (maybe passwords etc)
 	 */
 	sysfs_bin_attr_init(&at24->bin);
-	at24->bin.attr.name = "eeprom";
+	if (chip.flags & AT24_FLAG_FRAM)
+		at24->bin.attr.name = "fram";
+	else
+		at24->bin.attr.name = "eeprom";

Again no. Applications would need to check for this file or that file. The name "eeprom" is indeed a bit unfortunate, but is historic cruft.

Quoted 8 lines
drivers/misc/eeprom/at24.c +0 -0
 	at24->bin.attr.mode = chip.flags & AT24_FLAG_IRUGO ? S_IRUGO : S_IRUSR;
 	at24->bin.read = at24_bin_read;
drivers/misc/eeprom/at24.c +0 -0
 	at24->bin.size = chip.byte_len;
include/linux/i2c/at24.h +0 -0
index 285025a..d786b71 100644

include/linux/i2c/at24.h struct at24_platform_data { · line 53

Quoted 7 lines
include/linux/i2c/at24.h +1 -0
@@ -47,6 +47,7 @@ struct at24_platform_data {
 #define AT24_FLAG_READONLY	0x40	/* sysfs-entry will be read-only */
 #define AT24_FLAG_IRUGO		0x20	/* sysfs-entry will be world-readable */
 #define AT24_FLAG_TAKE8ADDR	0x10	/* take always 8 addresses (24c00) */
+#define AT24_FLAG_FRAM          0x08    /* chip is fram not eeprom */
 
 	void		(*setup)(struct memory_accessor *, void *context);
 	void		*context;

Thanks for your interest nonetheless,

Wolfram

Signature · 2 lines
Pengutronix e.K.                           | Wolfram Sang                |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
#2 lore raw

I see there where to much "no"s to get anything in, but thank you for your comments and explanations.

Quoted 7 lines
Quoted 5 lines

I wanted to use a fm24c04 i2c fram chip with linux. I grepped the source and found nothing. I later found that my chip can be handled by at24 eeprom driver. It creates a sysfs file called eeprom to read from and write to the chip. Userspace has no chance to distinguish if it is writing an eeprom or a fram chip.

Why should it?

Because writes are much faster and it doesn't have to take care on erase cycles. It could use other write strategies on such devices and update informations that have to survive power downs more often.

Quoted 9 lines
Quoted 9 lines
drivers/misc/eeprom/Kconfig +0 -0
index c9e695e..55948a5 100644
@@ -12,6 +12,12 @@ config EEPROM_AT24
 
 	     24c00, 24c01, 24c02, spd (readonly 24c02), 24c04, 24c08,
 	     24c16, 24c32, 24c64, 24c128, 24c256, 24c512, 24c1024
 
Quoted 11 lines

drivers/misc/eeprom/Kconfig config EEPROM_AT24 · line 21

Quoted 6 lines
drivers/misc/eeprom/Kconfig +6 -0
+	  This driver also supports I2C FRAM chips that are feature
+	  compatible to the 24cxx ones. In your at24_platform_data set
+	  .flags = AT24_FLAG_FRAM. These generic names are supported:
+
+	     fm24c04
+

The method of accessing EEPROMs is used by way more chips than FRAMs. So, I'd prefer to have the text updated more generic like "EEPROMs and similar devices like RAMs, ROMs, etc...". Describing setting .flags in Kconfig is overkill.

A patch updating Kconfig is below.

Quoted 10 lines

drivers/misc/eeprom/Kconfig config EEPROM_AT24

Quoted 5 lines
drivers/misc/eeprom/Kconfig +4 -1
-		chip.page_size = 1;
+		if (chip.flags & AT24_FLAG_FRAM)
+			chip.page_size = 128;
+		else
+			chip.page_size = 1;

I'd think most FRAMs can have the chip_size as the page_size since they probably don't do buffering. But do you know for all the chips out there? So, let's still play safe. If you want performance, you need to setup the driver properly.

No one knows all chips out there.
For the fm24c04 I use page_size != chip_size. It does not buffer but it has two pages, 256 bytes each.

-- >8 --

Quoted 1 line

From 82f77ade238755b7a1196b24f41a03a0e7344d89 Mon Sep 17 00:00:00 2001

From: Lars Poeschel <[email protected]>
Date: Wed, 5 Dec 2012 10:08:07 +0100
Subject: [PATCH] misc/at24: Update Kconfig to mention FRAMs, SRAMs and ROMs

As the at24 driver is able handle a bunch of serial storage chips other than EEPROMs this is now mentioned in Kconfig.

drivers/misc/eeprom/Kconfig +6 -5
index c9e695e..04f2e1f 100644
@@ -1,13 +1,14 @@
 menu "EEPROM support"
 
 config EEPROM_AT24
-	tristate "I2C EEPROMs from most vendors"
+	tristate "I2C EEPROMs / RAMs / ROMs from most vendors"
 	depends on I2C && SYSFS
 	help
-	  Enable this driver to get read/write support to most I2C EEPROMs,
-	  after you configure the driver to know about each EEPROM on
-	  your target board.  Use these generic chip names, instead of
-	  vendor-specific ones like at24c64 or 24lc02:
+	  Enable this driver to get read/write support to most I2C EEPROMs
+	  and compatible devices like FRAMs, SRAMs, ROMs etc. After you
+	  configure the driver to know about each chip on your target
+	  board.  Use these generic chip names, instead of vendor-specific
+	  ones like at24c64, 24lc02 or fm24c04:
 
 	     24c00, 24c01, 24c02, spd (readonly 24c02), 24c04, 24c08,
 	     24c16, 24c32, 24c64, 24c128, 24c256, 24c512, 24c1024
Signature · 1 line
1.7.10.4
#3 lore raw

Hi,

Quoted 2 lines · Lars Poeschel

I see there where to much "no"s to get anything in, but thank you for your comments and explanations.

Not necessarily, just not in this form :)

Quoted 7 lines
Quoted 7 lines
Quoted 6 lines

I wanted to use a fm24c04 i2c fram chip with linux. I grepped the source and found nothing. I later found that my chip can be handled by at24 eeprom driver. It creates a sysfs file called eeprom to read from and write to the chip. Userspace has no chance to distinguish if it is writing an eeprom or a fram chip.

Quoted 5 lines
Quoted 1 line

Why should it?

Because writes are much faster and it doesn't have to take care on erase cycles. It could use other write strategies on such devices and update informations that have to survive power downs more often.

I agree. I think that a seperate attribute named e.g. 'page_size' would be more helpful than renaming the binary file to fram?

Quoted 6 lines
Quoted 4 lines

The method of accessing EEPROMs is used by way more chips than FRAMs. So, I'd prefer to have the text updated more generic like "EEPROMs and similar devices like RAMs, ROMs, etc...". Describing setting .flags in Kconfig is overkill.

A patch updating Kconfig is below.

Looks good from a glimpse, will apply it later.

Quoted 3 lines

No one knows all chips out there.
For the fm24c04 I use page_size != chip_size. It does not buffer but it has two pages, 256 bytes each.

Yup, it uses two I2C adresses...

Thanks,

Wolfram

Signature · 2 lines
Pengutronix e.K.                           | Wolfram Sang                |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
#4 lore raw
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 5 lines

I wanted to use a fm24c04 i2c fram chip with linux. I grepped the source and found nothing. I later found that my chip can be handled by at24 eeprom driver. It creates a sysfs file called eeprom to read from and write to the chip. Userspace has no chance to distinguish if it is writing an eeprom or a fram chip.

Quoted 8 lines
Quoted 5 lines
Quoted 1 line

Why should it?

Because writes are much faster and it doesn't have to take care on erase cycles. It could use other write strategies on such devices and update informations that have to survive power downs more often.

I agree. I think that a seperate attribute named e.g. 'page_size' would be more helpful than renaming the binary file to fram?

Yes, this is a much better solution! Adding a seperate sysfs file page_size and a file for the type of device which would read eeprom, fram, etc then. If you also think this is the way to go, I would spent one of my next free timeslots to this.

Quoted 8 lines
Quoted 6 lines
Quoted 4 lines

The method of accessing EEPROMs is used by way more chips than FRAMs. So, I'd prefer to have the text updated more generic like "EEPROMs and similar devices like RAMs, ROMs, etc...". Describing setting .flags in Kconfig is overkill.

A patch updating Kconfig is below.

Looks good from a glimpse, will apply it later.

Thank you!

Lars

#5 lore raw
Quoted 12 lines · Lars Poeschel
Quoted 12 lines
Quoted 11 lines
Quoted 7 lines
Quoted 5 lines

I wanted to use a fm24c04 i2c fram chip with linux. I grepped the source and found nothing. I later found that my chip can be handled by at24 eeprom driver. It creates a sysfs file called eeprom to read from and write to the chip. Userspace has no chance to distinguish if it is writing an eeprom or a fram chip.

Why should it?

Because writes are much faster and it doesn't have to take care on erase cycles. It could use other write strategies on such devices and update informations that have to survive power downs more often.

Quoted 7 lines
Quoted 2 lines

I agree. I think that a seperate attribute named e.g. 'page_size' would be more helpful than renaming the binary file to fram?

Yes, this is a much better solution! Adding a seperate sysfs file page_size and a file for the type of device which would read eeprom, fram, etc then. If you also think this is the way to go, I would spent one of my next free timeslots to this.

Oops, this mail seems to have dropped off :(

I am all for the 'page_size' attribute, but still not convinced what gain the 'type' attribute would allow. For FRAM, the page size will be large. Isn't this enough information?

Regards,

Wolfram

#6 lore raw
Quoted 17 lines · Wolfram Sang
Quoted 17 lines
Quoted 16 lines
Quoted 7 lines
Quoted 7 lines
Quoted 6 lines

I wanted to use a fm24c04 i2c fram chip with linux. I grepped the source and found nothing. I later found that my chip can be handled by at24 eeprom driver. It creates a sysfs file called eeprom to read from and write to the chip. Userspace has no chance to distinguish if it is writing an eeprom or a fram chip.

Quoted 6 lines
Quoted 1 line

Why should it?

Because writes are much faster and it doesn't have to take care on erase cycles. It could use other write strategies on such devices and update informations that have to survive power downs more often.

I agree. I think that a seperate attribute named e.g. 'page_size' would be more helpful than renaming the binary file to fram?

Quoted 6 lines
Quoted 4 lines

Yes, this is a much better solution! Adding a seperate sysfs file page_size and a file for the type of device which would read eeprom, fram, etc then. If you also think this is the way to go, I would spent one of my next free timeslots to this.

Oops, this mail seems to have dropped off :(

Luckily I did not have a free timeslot to invest yet. ;)

Quoted 3 lines

I am all for the 'page_size' attribute, but still not convinced what gain the 'type' attribute would allow. For FRAM, the page size will be large. Isn't this enough information?

Yes, this would be enough information and I think this is the way we should go.
I set this on my todo list. Although the change will be quite simple, I think I will not find the time to hit the upcoming merge window.

Lars

#7 lore raw
In reply to Wolfram Sang
Quoted 8 lines · Wolfram Sang
Quoted 6 lines
Quoted 4 lines

The method of accessing EEPROMs is used by way more chips than FRAMs. So, I'd prefer to have the text updated more generic like "EEPROMs and similar devices like RAMs, ROMs, etc...". Describing setting .flags in Kconfig is overkill.

A patch updating Kconfig is below.

Looks good from a glimpse, will apply it later.

Hello Wolfram,

what happend to this one ? It was a patch updating Kconfig help for at24.

https://patchwork.kernel.org/patch/1840591/

Regards,
Lars

#8 lore raw
Quoted 1 line

what happend to this one ? It was a patch updating Kconfig help for at24.

Do you know linux-next? Have a look there...

#9 lore raw
Quoted 4 lines · Wolfram Sang
Quoted 2 lines

what happend to this one ? It was a patch updating Kconfig help for at24.

Do you know linux-next? Have a look there...

Thank you for the hint and for commiting it.

Lars