add eeprom write completion waiting with timeout

- added new option "-t n" to specify write timeout
- wait after each byte write for the eeprom to accept new commands
This commit is contained in:
Axel Schwenke 2020-12-10 15:49:18 +01:00
parent 22216e6f62
commit ac41ae75eb
3 changed files with 56 additions and 32 deletions

22
24cXX.c
View file

@ -72,7 +72,7 @@ int eeprom_open(char *dev_fqn, int addr, int type, struct eeprom* e)
int funcs, fd, r; int funcs, fd, r;
e->fd = e->addr = 0; e->fd = e->addr = 0;
e->dev = 0; e->dev = 0;
fd = open(dev_fqn, O_RDWR); fd = open(dev_fqn, O_RDWR);
if(fd <= 0) if(fd <= 0)
{ {
@ -87,8 +87,9 @@ int eeprom_open(char *dev_fqn, int addr, int type, struct eeprom* e)
return -1; return -1;
} }
// check for req funcs // check for req funcs
CHECK_I2C_FUNC( funcs, I2C_FUNC_SMBUS_QUICK );
CHECK_I2C_FUNC( funcs, I2C_FUNC_SMBUS_READ_BYTE ); CHECK_I2C_FUNC( funcs, I2C_FUNC_SMBUS_READ_BYTE );
CHECK_I2C_FUNC( funcs, I2C_FUNC_SMBUS_WRITE_BYTE ); CHECK_I2C_FUNC( funcs, I2C_FUNC_SMBUS_WRITE_BYTE );
CHECK_I2C_FUNC( funcs, I2C_FUNC_SMBUS_READ_BYTE_DATA ); CHECK_I2C_FUNC( funcs, I2C_FUNC_SMBUS_READ_BYTE_DATA );
@ -179,11 +180,24 @@ int eeprom_write_byte(struct eeprom *e, __u16 mem_addr, __u8 data)
__u8 buf[2] = { mem_addr & 0x00ff, data }; __u8 buf[2] = { mem_addr & 0x00ff, data };
return i2c_write_2b(e, buf); return i2c_write_2b(e, buf);
} else if(e->type == EEPROM_TYPE_16BIT_ADDR) { } else if(e->type == EEPROM_TYPE_16BIT_ADDR) {
__u8 buf[3] = __u8 buf[3] =
{ (mem_addr >> 8) & 0x00ff, mem_addr & 0x00ff, data }; { (mem_addr >> 8) & 0x00ff, mem_addr & 0x00ff, data };
return i2c_write_3b(e, buf); return i2c_write_3b(e, buf);
} }
fprintf(stderr, "ERR: unknown eeprom type\n"); fprintf(stderr, "ERR: unknown eeprom type\n");
return -1; return -1;
} }
int eeprom_wait_ready(struct eeprom *e, int max_ms_to_wait)
{
while (max_ms_to_wait > 0) {
int r = i2c_smbus_write_quick(e->fd, 0);
if (r == 0) {
return r;
}
usleep(1000);
--max_ms_to_wait;
}
return -1;
}

18
24cXX.h
View file

@ -15,7 +15,7 @@
***************************************************************************/ ***************************************************************************/
#ifndef _24CXX_H_ #ifndef _24CXX_H_
#define _24CXX_H_ #define _24CXX_H_
#include "i2c-dev.h" #include <linux/i2c-dev.h>
#define EEPROM_TYPE_UNKNOWN 0 #define EEPROM_TYPE_UNKNOWN 0
#define EEPROM_TYPE_8BIT_ADDR 1 #define EEPROM_TYPE_8BIT_ADDR 1
@ -35,24 +35,28 @@ struct eeprom
*/ */
int eeprom_open(char *dev_fqn, int addr, int type, struct eeprom*); int eeprom_open(char *dev_fqn, int addr, int type, struct eeprom*);
/* /*
* closees the eeprom device [e] * closees the eeprom device [e]
*/ */
int eeprom_close(struct eeprom *e); int eeprom_close(struct eeprom *e);
/* /*
* read and returns the eeprom byte at memory address [mem_addr] * read and returns the eeprom byte at memory address [mem_addr]
* Note: eeprom must have been selected by ioctl(fd,I2C_SLAVE,address) * Note: eeprom must have been selected by ioctl(fd,I2C_SLAVE,address)
*/ */
int eeprom_read_byte(struct eeprom* e, __u16 mem_addr); int eeprom_read_byte(struct eeprom* e, __u16 mem_addr);
/* /*
* read the current byte * read the current byte
* Note: eeprom must have been selected by ioctl(fd,I2C_SLAVE,address) * Note: eeprom must have been selected by ioctl(fd,I2C_SLAVE,address)
*/ */
int eeprom_read_current_byte(struct eeprom *e); int eeprom_read_current_byte(struct eeprom *e);
/* /*
* writes [data] at memory address [mem_addr] * writes [data] at memory address [mem_addr]
* Note: eeprom must have been selected by ioctl(fd,I2C_SLAVE,address) * Note: eeprom must have been selected by ioctl(fd,I2C_SLAVE,address)
*/ */
int eeprom_write_byte(struct eeprom *e, __u16 mem_addr, __u8 data); int eeprom_write_byte(struct eeprom *e, __u16 mem_addr, __u8 data);
/*
* wait for the eeprom to accept new commands, to be called after a write
*/
int eeprom_wait_ready(struct eeprom *e, int max_ms_to_wait);
#endif #endif

View file

@ -34,22 +34,23 @@ int g_quiet;
#define usage_if(a) do { do_usage_if( a , __LINE__); } while(0); #define usage_if(a) do { do_usage_if( a , __LINE__); } while(0);
void do_usage_if(int b, int line) void do_usage_if(int b, int line)
{ {
const static char *eeprog_usage = const static char *eeprog_usage =
"eeprog " VERSION ", a 24Cxx EEPROM reader/writer\n" "eeprog " VERSION ", a 24Cxx EEPROM reader/writer\n"
"Copyright (c) 2003-2004 by Stefano Barbato - All rights reserved.\n" "Copyright (c) 2003-2004 by Stefano Barbato - All rights reserved.\n"
"Usage: eeprog [-fqxdh] [-16|-8] [ -r addr[:count] | -w addr ] /dev/i2c-N i2c-address\n" "Usage: eeprog [-fqxdh] [-16|-8] [ -r addr[:count] | -w addr ] /dev/i2c-N i2c-address\n"
"\n" "\n"
" Address modes: \n" " Address modes: \n"
" -8 Use 8bit address mode for 24c0x...24C16 [default]\n" " -8 Use 8bit address mode for 24c0x...24C16 [default]\n"
" -16 Use 16bit address mode for 24c32...24C256\n" " -16 Use 16bit address mode for 24c32...24C256\n"
" Actions: \n" " Actions: \n"
" -r addr[:count] Read [count] (1 if omitted) bytes from [addr]\n" " -r addr[:count] Read [count] (1 if omitted) bytes from [addr]\n"
" and print them to the standard output\n" " and print them to the standard output\n"
" -w addr Write input (stdin) at address [addr] of the EEPROM\n" " -w addr Write input (stdin) at address [addr] of the EEPROM\n"
" -t n write timeout in ms (default 10)\n"
" -h Print this help\n" " -h Print this help\n"
" Options: \n" " Options: \n"
" -x Set hex output mode\n" " -x Set hex output mode\n"
" -d Dummy mode, display what *would* have been done\n" " -d Dummy mode, display what *would* have been done\n"
" -f Disable warnings and don't ask confirmation\n" " -f Disable warnings and don't ask confirmation\n"
" -q Quiet mode\n" " -q Quiet mode\n"
"\n" "\n"
@ -98,7 +99,7 @@ void parse_arg(char *arg, int* paddr, int *psize)
int confirm_action() int confirm_action()
{ {
fprintf(stderr, fprintf(stderr,
"\n" "\n"
"____________________________WARNING____________________________\n" "____________________________WARNING____________________________\n"
"Erroneously writing to a system EEPROM (like DIMM SPD modules)\n" "Erroneously writing to a system EEPROM (like DIMM SPD modules)\n"
@ -115,7 +116,7 @@ int confirm_action()
"\n" "\n"
); );
getchar(); getchar();
return 1; return 1;
} }
int read_from_eeprom(struct eeprom *e, int addr, int size, int hex) int read_from_eeprom(struct eeprom *e, int addr, int size, int hex)
@ -126,12 +127,12 @@ int read_from_eeprom(struct eeprom *e, int addr, int size, int hex)
die_if((ch = eeprom_read_byte(e, addr)) < 0, "read error"); die_if((ch = eeprom_read_byte(e, addr)) < 0, "read error");
if(hex) if(hex)
{ {
if( (i % 16) == 0 ) if( (i % 16) == 0 )
printf("\n %.4x| ", addr); printf("\n %.4x| ", addr);
else if( (i % 8) == 0 ) else if( (i % 8) == 0 )
printf(" "); printf(" ");
printf("%.2x ", ch); printf("%.2x ", ch);
} else } else
putchar(ch); putchar(ch);
} }
if(hex) if(hex)
@ -140,7 +141,7 @@ int read_from_eeprom(struct eeprom *e, int addr, int size, int hex)
return 0; return 0;
} }
int write_to_eeprom(struct eeprom *e, int addr) int write_to_eeprom(struct eeprom *e, int addr, int timeout)
{ {
int c; int c;
while((c = getchar()) != EOF) while((c = getchar()) != EOF)
@ -148,6 +149,7 @@ int write_to_eeprom(struct eeprom *e, int addr)
print_info("."); print_info(".");
fflush(stdout); fflush(stdout);
die_if(eeprom_write_byte(e, addr++, c), "write error"); die_if(eeprom_write_byte(e, addr++, c), "write error");
die_if(eeprom_wait_ready(e, timeout), "write timeout");
} }
print_info("\n\n"); print_info("\n\n");
return 0; return 0;
@ -157,6 +159,7 @@ int main(int argc, char** argv)
{ {
struct eeprom e; struct eeprom e;
int ret, op, i2c_addr, memaddr, size, want_hex, dummy, force, sixteen; int ret, op, i2c_addr, memaddr, size, want_hex, dummy, force, sixteen;
int timeout = 10;
char *device, *arg = 0, *i2c_addr_s; char *device, *arg = 0, *i2c_addr_s;
struct stat st; struct stat st;
int eeprom_type = 0; int eeprom_type = 0;
@ -171,7 +174,7 @@ int main(int argc, char** argv)
case '1': case '1':
usage_if(*optarg != '6' || strlen(optarg) != 1); usage_if(*optarg != '6' || strlen(optarg) != 1);
die_if(eeprom_type, "EEPROM type switch (-8 or -16) used twice"); die_if(eeprom_type, "EEPROM type switch (-8 or -16) used twice");
eeprom_type = EEPROM_TYPE_16BIT_ADDR; eeprom_type = EEPROM_TYPE_16BIT_ADDR;
break; break;
case 'x': case 'x':
want_hex++; want_hex++;
@ -192,8 +195,11 @@ int main(int argc, char** argv)
case 'h': case 'h':
usage_if(1); usage_if(1);
break; break;
case 't':
timeout = atoi(optarg);
break;
default: default:
die_if(op != 0, "Both read and write requested"); die_if(op != 0, "Both read and write requested");
arg = optarg; arg = optarg;
op = ret; op = ret;
} }
@ -201,7 +207,7 @@ int main(int argc, char** argv)
if(!eeprom_type) if(!eeprom_type)
eeprom_type = EEPROM_TYPE_8BIT_ADDR; // default eeprom_type = EEPROM_TYPE_8BIT_ADDR; // default
usage_if(op == 0); // no switches usage_if(op == 0); // no switches
// set device and i2c_addr reading from cmdline or env // set device and i2c_addr reading from cmdline or env
device = i2c_addr_s = 0; device = i2c_addr_s = 0;
switch(argc - optind) switch(argc - optind)
@ -232,15 +238,15 @@ int main(int argc, char** argv)
print_info("eeprog %s, a 24Cxx EEPROM reader/writer\n", VERSION); print_info("eeprog %s, a 24Cxx EEPROM reader/writer\n", VERSION);
print_info("Copyright (c) 2003-2004 by Stefano Barbato - All rights reserved.\n"); print_info("Copyright (c) 2003-2004 by Stefano Barbato - All rights reserved.\n");
print_info(" Bus: %s, Address: 0x%x, Mode: %dbit\n", print_info(" Bus: %s, Address: 0x%x, Mode: %dbit\n",
device, i2c_addr, device, i2c_addr,
(eeprom_type == EEPROM_TYPE_8BIT_ADDR ? 8 : 16) ); (eeprom_type == EEPROM_TYPE_8BIT_ADDR ? 8 : 16) );
if(dummy) if(dummy)
{ {
fprintf(stderr, "Dummy mode selected, nothing done.\n"); fprintf(stderr, "Dummy mode selected, nothing done.\n");
return 0; return 0;
} }
die_if(eeprom_open(device, i2c_addr, eeprom_type, &e) < 0, die_if(eeprom_open(device, i2c_addr, eeprom_type, &e) < 0,
"unable to open eeprom device file " "unable to open eeprom device file "
"(check that the file exists and that it's readable)"); "(check that the file exists and that it's readable)");
switch(op) switch(op)
@ -257,9 +263,9 @@ int main(int argc, char** argv)
if(force == 0) if(force == 0)
confirm_action(); confirm_action();
parse_arg(arg, &memaddr, &size); parse_arg(arg, &memaddr, &size);
print_info(" Writing stdin starting at address 0x%x\n", print_info(" Writing stdin starting at address 0x%x with timeout %dms\n",
memaddr); memaddr, timeout);
write_to_eeprom(&e, memaddr); write_to_eeprom(&e, memaddr, timeout);
break; break;
default: default:
usage_if(1); usage_if(1);