This is the mail archive of the
ecos-patches@sources.redhat.com
mailing list for the eCos project.
V2 flash - simplify driver interface
- From: Bart Veer <bartv at ecoscentric dot com>
- To: ecos-patches at ecos dot sourceware dot org
- Date: Mon, 29 Nov 2004 14:12:16 +0000 (GMT)
- Subject: V2 flash - simplify driver interface
The hwr_map_error() support serves no purpose with V2 drivers. The API
always called hwr_map_error() before returning the error to the
application, so the application could never see any error codes
internal to the driver. For the amd29xxxxxv2 driver, the sst driver,
and the synthv2 driver hwr_map_error() was a no-op. For the dataflash
driver hwr_map_error() was effectively a no-op. For the strata v2
driver hwr_map_error() did very little.
This patch eliminates hwr_map_error() from the table of device driver
functions, and the calls to that function from the flash API
functions. For legacy devices there are now calls to the legacy
flash_hwr_map_error() inside legacy_dev.c itself, so their behaviour
is unaffected and V2 drivers don't have to suffer any overheads. The
amd29xxxxxv2, sst and synthv2 drivers have been trivially updated. The
dataflash and stratav2 drivers have been updated such that the
hwr_map_error() call now happens inside the driver, rather than in the
generic flash code. For the dataflash driver this is probably not
optimal, but only involved a small change.
Bart
Index: io/flash/current/ChangeLog
===================================================================
RCS file: /cvs/ecos/ecos/packages/io/flash/current/ChangeLog,v
retrieving revision 1.38.2.23
diff -u -r1.38.2.23 ChangeLog
--- io/flash/current/ChangeLog 29 Nov 2004 00:43:52 -0000 1.38.2.23
+++ io/flash/current/ChangeLog 29 Nov 2004 13:56:45 -0000
@@ -1,4 +1,7 @@
2004-11-29 Bart Veer <bartv@ecoscentric.com>
+
+ * include/flash_priv.h, src/flash.c, src/legacy_dev.c: remove
+ hwr_map_error() from V2 drivers
* include/flash_priv.h, src/flash.c, src/legacy_dev.c: provide
dummy init/query/lock/unlock functions for use by device drivers
Index: io/flash/current/include/flash_priv.h
===================================================================
RCS file: /cvs/ecos/ecos/packages/io/flash/current/include/Attic/flash_priv.h,v
retrieving revision 1.1.2.7
diff -u -r1.1.2.7 flash_priv.h
--- io/flash/current/include/flash_priv.h 29 Nov 2004 00:43:52 -0000 1.1.2.7
+++ io/flash/current/include/flash_priv.h 29 Nov 2004 13:56:50 -0000
@@ -75,7 +75,6 @@
int (*flash_read) (struct cyg_flash_dev *dev,
const cyg_flashaddr_t base,
void* data, size_t len);
- int (*flash_hwr_map_error) (struct cyg_flash_dev *dev, int err);
#ifdef CYGHWR_IO_FLASH_BLOCK_LOCKING
int (*flash_block_lock) (struct cyg_flash_dev *dev,
const cyg_flashaddr_t block_base);
@@ -118,7 +117,7 @@
} CYG_HAL_TABLE_TYPE;
#ifdef CYGHWR_IO_FLASH_BLOCK_LOCKING
-# define CYG_FLASH_FUNS(_funs_, _init_, _query_ , _erase_, _prog_ , _read_, _map_, _lock_, _unlock_) \
+# define CYG_FLASH_FUNS(_funs_, _init_, _query_ , _erase_, _prog_ , _read_, _lock_, _unlock_) \
struct cyg_flash_dev_funs _funs_ = \
{ \
.flash_init = _init_, \
@@ -126,20 +125,18 @@
.flash_erase_block = _erase_, \
.flash_program = _prog_, \
.flash_read = _read_, \
- .flash_hwr_map_error = _map_, \
.flash_block_lock = _lock_, \
.flash_block_unlock = _unlock_ \
}
#else
-# define CYG_FLASH_FUNS(_funs_, _init_, _query_ , _erase_, _prog_ , _read_, _map_, _lock_, _unlock_) \
+# define CYG_FLASH_FUNS(_funs_, _init_, _query_ , _erase_, _prog_ , _read_, _lock_, _unlock_) \
struct cyg_flash_dev_funs _funs_ = \
{ \
.flash_init = _init_, \
.flash_query = _query_, \
.flash_erase_block = _erase_, \
.flash_program = _prog_, \
- .flash_read = _read_, \
- .flash_hwr_map_error = _map_ \
+ .flash_read = _read_ \
}
#endif
Index: io/flash/current/src/flash.c
===================================================================
RCS file: /cvs/ecos/ecos/packages/io/flash/current/src/flash.c,v
retrieving revision 1.26.2.16
diff -u -r1.26.2.16 flash.c
--- io/flash/current/src/flash.c 29 Nov 2004 00:43:49 -0000 1.26.2.16
+++ io/flash/current/src/flash.c 29 Nov 2004 13:56:50 -0000
@@ -246,7 +246,6 @@
"Block info is in the flash");
CYG_ASSERT(dev->funs->flash_erase_block, "No erase function");
CYG_ASSERT(dev->funs->flash_program, "No program function");
- CYG_ASSERT(dev->funs->flash_hwr_map_error, "No hwr map error function");
#ifdef CYGDBG_USE_ASSERTS
{
int i;
@@ -490,7 +489,6 @@
}
if (!erased) {
stat = dev->funs->flash_erase_block(dev,block);
- stat = dev->funs->flash_hwr_map_error(dev,stat);
}
if (CYG_FLASH_ERR_OK != stat && err_address) {
*err_address = block;
@@ -572,7 +570,6 @@
offset = 0;
stat = dev->funs->flash_program(dev, addr, ram, this_write);
- stat = dev->funs->flash_hwr_map_error(dev,stat);
#ifdef CYGSEM_IO_FLASH_VERIFY_PROGRAM
if (CYG_FLASH_ERR_OK == stat) // Claims to be OK
if (!dev->funs->flash_read && memcmp((void *)addr, ram, this_write) != 0) {
@@ -668,7 +665,6 @@
offset = 0;
stat = dev->funs->flash_read(dev, addr, ram, this_read);
- stat = dev->funs->flash_hwr_map_error(dev,stat);
if (CYG_FLASH_ERR_OK != stat && err_address) {
*err_address = addr;
break;
@@ -732,7 +728,6 @@
lock_count = block_size;
}
stat = dev->funs->flash_block_lock(dev,block);
- stat = dev->funs->flash_hwr_map_error(dev,stat);
if (CYG_FLASH_ERR_OK != stat && err_address) {
*err_address = block;
@@ -796,7 +791,6 @@
unlock_count = block_size;
}
stat = dev->funs->flash_block_unlock(dev,block);
- stat = dev->funs->flash_hwr_map_error(dev,stat);
if (CYG_FLASH_ERR_OK != stat && err_address) {
*err_address = block;
Index: io/flash/current/src/legacy_dev.c
===================================================================
RCS file: /cvs/ecos/ecos/packages/io/flash/current/src/Attic/legacy_dev.c,v
retrieving revision 1.1.2.10
diff -u -r1.1.2.10 legacy_dev.c
--- io/flash/current/src/legacy_dev.c 29 Nov 2004 00:43:48 -0000 1.1.2.10
+++ io/flash/current/src/legacy_dev.c 29 Nov 2004 13:56:54 -0000
@@ -124,10 +124,12 @@
typedef int code_fun(cyg_flashaddr_t, unsigned int);
code_fun *_flash_erase_block;
size_t block_size = dev->block_info[0].block_size;
+ int stat;
_flash_erase_block = (code_fun*) cyg_flash_anonymizer(&flash_erase_block);
- return (*_flash_erase_block)(block_base, block_size);
+ stat = (*_flash_erase_block)(block_base, block_size);
+ return flash_hwr_map_error(stat);
}
static int
@@ -139,10 +141,12 @@
code_fun *_flash_program_buf;
size_t block_size = dev->block_info[0].block_size;
size_t block_mask = ~(block_mask -1);
-
+ int stat;
+
_flash_program_buf = (code_fun*) cyg_flash_anonymizer(&flash_program_buf);
- return (*_flash_program_buf)(base, data, len, block_mask ,block_size);
+ stat = (*_flash_program_buf)(base, data, len, block_mask ,block_size);
+ return flash_hwr_map_error(stat);
}
#ifdef CYGSEM_IO_FLASH_READ_INDIRECT
@@ -155,10 +159,11 @@
code_fun *_flash_read_buf;
size_t block_size = dev->block_info[0].block_size;
size_t block_mask = ~(block_mask -1);
-
+ int stat;
_flash_read_buf = (code_fun*) cyg_flash_anonymizer(&flash_read_buf);
- return (*_flash_read_buf)(base, data, len, block_mask, block_size);
+ stat = (*_flash_read_buf)(base, data, len, block_mask, block_size);
+ return flash_hwr_map_error(stat);
}
# define LEGACY_FLASH_READ legacy_flash_read
@@ -174,10 +179,11 @@
{
typedef int code_fun(cyg_flashaddr_t);
code_fun *_flash_lock_block;
-
+ int stat;
_flash_lock_block = (code_fun*) cyg_flash_anonymizer(&flash_lock_block);
- return (*_flash_lock_block)(block_base);
+ stat = (*_flash_lock_block)(block_base);
+ return flash_hwr_map_error(stat);
}
static int
@@ -188,20 +194,14 @@
code_fun *_flash_unlock_block;
size_t block_size = dev->block_info[0].block_size;
cyg_uint32 blocks = dev->block_info[0].blocks;
-
+ int stat;
_flash_unlock_block = (code_fun*) cyg_flash_anonymizer(&flash_unlock_block);
- return (*_flash_unlock_block)(block_base, block_size, blocks);
+ stat = (*_flash_unlock_block)(block_base, block_size, blocks);
+ return flash_hwr_map_error(stat);
}
#endif
-// Map a hardware status to a package error
-static int
-legacy_flash_hwr_map_error (struct cyg_flash_dev *dev, int err)
-{
- return flash_hwr_map_error(err);
-}
-
void
flash_dev_query(void* data)
{
@@ -222,7 +222,6 @@
legacy_flash_erase_block,
legacy_flash_program,
LEGACY_FLASH_READ,
- legacy_flash_hwr_map_error,
legacy_flash_block_lock,
legacy_flash_block_unlock
);
Index: devs/flash/amd/am29xxxxxv2/current/ChangeLog
===================================================================
RCS file: /cvs/ecos/ecos/packages/devs/flash/amd/am29xxxxxv2/current/Attic/ChangeLog,v
retrieving revision 1.1.2.6
diff -u -r1.1.2.6 ChangeLog
--- devs/flash/amd/am29xxxxxv2/current/ChangeLog 29 Nov 2004 00:44:10 -0000 1.1.2.6
+++ devs/flash/amd/am29xxxxxv2/current/ChangeLog 29 Nov 2004 13:56:54 -0000
@@ -1,5 +1,8 @@
2004-11-29 Bart Veer <bartv@ecoscentric.com>
+ * include/am29xxxxx_dev.h, src/am29xxxxx.c: eliminate
+ hwr_map_error() support, no longer needed
+
* include/am29xxxxx_dev.h, src/am29xxxxx.c, src/am29xxxxx_aux.c:
The dummy init/query/lock/unlock functions have been moved to the
generic flash package. That also now exports an anonymizer
Index: devs/flash/amd/am29xxxxxv2/current/include/am29xxxxx_dev.h
===================================================================
RCS file: /cvs/ecos/ecos/packages/devs/flash/amd/am29xxxxxv2/current/include/Attic/am29xxxxx_dev.h,v
retrieving revision 1.1.2.4
diff -u -r1.1.2.4 am29xxxxx_dev.h
--- devs/flash/amd/am29xxxxxv2/current/include/am29xxxxx_dev.h 29 Nov 2004 00:44:09 -0000 1.1.2.4
+++ devs/flash/amd/am29xxxxxv2/current/include/am29xxxxx_dev.h 29 Nov 2004 13:56:54 -0000
@@ -52,8 +52,6 @@
#include <cyg/io/flash.h>
#include <cyg/io/flash_priv.h>
-externC int cyg_am29xxxxx_hwr_map_error_nop(struct cyg_flash_dev*, int);
-
externC int cyg_am29xxxxx_read_devid_8( struct cyg_flash_dev*);
externC int cyg_am29xxxxx_read_devid_16( struct cyg_flash_dev*);
externC int cyg_am29xxxxx_read_devid_32( struct cyg_flash_dev*);
Index: devs/flash/amd/am29xxxxxv2/current/src/am29xxxxx.c
===================================================================
RCS file: /cvs/ecos/ecos/packages/devs/flash/amd/am29xxxxxv2/current/src/Attic/am29xxxxx.c,v
retrieving revision 1.1.2.3
diff -u -r1.1.2.3 am29xxxxx.c
--- devs/flash/amd/am29xxxxxv2/current/src/am29xxxxx.c 29 Nov 2004 00:44:09 -0000 1.1.2.3
+++ devs/flash/amd/am29xxxxxv2/current/src/am29xxxxx.c 29 Nov 2004 13:56:54 -0000
@@ -195,14 +195,6 @@
// ----------------------------------------------------------------------------
// Generic code.
-// A dummy hwr_map_error routine.
-int
-cyg_am29xxxxx_hwr_map_error_nop(struct cyg_flash_dev* dev, int err)
-{
- CYG_UNUSED_PARAM(struct cyg_flash_dev*, dev);
- return err;
-}
-
// Get info about the current block, i.e. base and size.
static void
am29_get_block_info(struct cyg_flash_dev* dev, const cyg_flashaddr_t addr, cyg_flashaddr_t* block_start, size_t* block_size)
Index: devs/flash/atmel/dataflash/current/ChangeLog
===================================================================
RCS file: /cvs/ecos/ecos/packages/devs/flash/atmel/dataflash/current/Attic/ChangeLog,v
retrieving revision 1.1.2.8
diff -u -r1.1.2.8 ChangeLog
--- devs/flash/atmel/dataflash/current/ChangeLog 29 Nov 2004 00:44:07 -0000 1.1.2.8
+++ devs/flash/atmel/dataflash/current/ChangeLog 29 Nov 2004 13:56:59 -0000
@@ -1,5 +1,7 @@
2004-11-29 Bart Veer <bartv@ecoscentric.com>
+ (df_flash_hwr_map_error): this is now internal to the driver, no
+ longer needed by the generic flash code.
* src/devs_flash_atmel_dataflash_flash_dev_funs.c: use the dummy
query/lock/unlock functions provided by the generic flash code
Index: devs/flash/atmel/dataflash/current/src/devs_flash_atmel_dataflash_flash_dev_funs.c
===================================================================
RCS file: /cvs/ecos/ecos/packages/devs/flash/atmel/dataflash/current/src/Attic/devs_flash_atmel_dataflash_flash_dev_funs.c,v
retrieving revision 1.1.2.5
diff -u -r1.1.2.5 devs_flash_atmel_dataflash_flash_dev_funs.c
--- devs/flash/atmel/dataflash/current/src/devs_flash_atmel_dataflash_flash_dev_funs.c 29 Nov 2004 00:44:04 -0000 1.1.2.5
+++ devs/flash/atmel/dataflash/current/src/devs_flash_atmel_dataflash_flash_dev_funs.c 29 Nov 2004 13:56:59 -0000
@@ -63,11 +63,25 @@
// --------------------------------------------------------------------------
#define RETURN_ON_ERROR(_op_) \
- if (CYG_DATAFLASH_ERR_OK != (err = _op_)) return err
+ if (CYG_DATAFLASH_ERR_OK != (err = _op_)) return df_flash_hwr_map_error(dev, err)
#define GOTO_ON_ERROR(_op_) \
if (CYG_DATAFLASH_ERR_OK != (err = _op_)) goto on_error
+static int
+df_flash_hwr_map_error(struct cyg_flash_dev *dev, int err)
+{
+ switch (err)
+ {
+ case CYG_DATAFLASH_ERR_OK: return CYG_FLASH_ERR_OK;
+ case CYG_DATAFLASH_ERR_INVALID: return CYG_FLASH_ERR_INVALID;
+ case CYG_DATAFLASH_ERR_WRONG_PART: return CYG_FLASH_ERR_DRV_WRONG_PART;
+ case CYG_DATAFLASH_ERR_TIMEOUT: return CYG_FLASH_ERR_DRV_TIMEOUT;
+ case CYG_DATAFLASH_ERR_COMPARE: return CYG_FLASH_ERR_DRV_VERIFY;
+ default: return CYG_FLASH_ERR_INVALID;
+ }
+}
+
// --------------------------------------------------------------------------
static int
@@ -136,7 +150,7 @@
on_error:
cyg_dataflash_release(&priv->dev);
- return err;
+ return df_flash_hwr_map_error(dev, err);
}
static int
@@ -165,7 +179,7 @@
on_error:
cyg_dataflash_release(&priv->dev);
- return err;
+ return df_flash_hwr_map_error(dev, err);
}
static int
@@ -193,21 +207,7 @@
on_error:
cyg_dataflash_release(&priv->dev);
- return err;
-}
-
-static int
-df_flash_hwr_map_error(struct cyg_flash_dev *dev, int err)
-{
- switch (err)
- {
- case CYG_DATAFLASH_ERR_OK: return CYG_FLASH_ERR_OK;
- case CYG_DATAFLASH_ERR_INVALID: return CYG_FLASH_ERR_INVALID;
- case CYG_DATAFLASH_ERR_WRONG_PART: return CYG_FLASH_ERR_DRV_WRONG_PART;
- case CYG_DATAFLASH_ERR_TIMEOUT: return CYG_FLASH_ERR_DRV_TIMEOUT;
- case CYG_DATAFLASH_ERR_COMPARE: return CYG_FLASH_ERR_DRV_VERIFY;
- default: return CYG_FLASH_ERR_INVALID;
- }
+ return df_flash_hwr_map_error(dev, err);
}
// --------------------------------------------------------------------------
@@ -218,7 +218,6 @@
df_flash_erase_block,
df_flash_program,
df_flash_read,
- df_flash_hwr_map_error,
cyg_flash_devfn_lock_nop,
cyg_flash_devfn_unlock_nop
);
Index: devs/flash/intel/stratav2/current/ChangeLog
===================================================================
RCS file: /cvs/ecos/ecos/packages/devs/flash/intel/stratav2/current/Attic/ChangeLog,v
retrieving revision 1.1.2.9
diff -u -r1.1.2.9 ChangeLog
--- devs/flash/intel/stratav2/current/ChangeLog 29 Nov 2004 00:44:03 -0000 1.1.2.9
+++ devs/flash/intel/stratav2/current/ChangeLog 29 Nov 2004 13:57:01 -0000
@@ -1,5 +1,8 @@
2004-11-29 Bart Veer <bartv@ecoscentric.com>
+ * include/flash_strata_v2.inl: hwr_map_error() is now internal to
+ the driver, not exported to the generic flash code.
+
* include/flash_strata_v2.inl: use the dummy lock/unlock functions
provided by the generic flash code.
Index: devs/flash/intel/stratav2/current/include/flash_strata_v2.inl
===================================================================
RCS file: /cvs/ecos/ecos/packages/devs/flash/intel/stratav2/current/include/Attic/flash_strata_v2.inl,v
retrieving revision 1.1.2.8
diff -u -r1.1.2.8 flash_strata_v2.inl
--- devs/flash/intel/stratav2/current/include/flash_strata_v2.inl 29 Nov 2004 00:44:00 -0000 1.1.2.8
+++ devs/flash/intel/stratav2/current/include/flash_strata_v2.inl 29 Nov 2004 13:57:03 -0000
@@ -329,7 +329,7 @@
if (len == 0) stat = 0;
}
- return stat;
+ return strata_hwr_map_error(dev, stat);
}
//----------------------------------------------------------------------------
@@ -434,7 +434,7 @@
bad:
BA[0] = FLASH_Reset;
- return stat;
+ return strata_hwr_map_error(dev, stat);
}
#ifdef CYGOPT_DEVS_FLASH_STRATA_V2_LOCKING
@@ -522,7 +522,7 @@
// Restore ROM to "normal" mode
ROM[0] = FLASH_Reset;
- return stat;
+ return strata_hwr_map_error(dev, stat);
}
//----------------------------------------------------------------------------
@@ -552,7 +552,7 @@
// Restore ROM to "normal" mode
ROM[0] = FLASH_Reset;
- return stat;
+ return strata_hwr_map_error(dev, stat);
}
#endif
@@ -565,7 +565,6 @@
strata_erase_block,
strata_program_buf,
NULL,
- strata_hwr_map_error,
strata_lock_block,
strata_unlock_block);
#else
@@ -575,7 +574,6 @@
strata_erase_block,
strata_program_buf,
NULL,
- strata_hwr_map_error,
cyg_flash_devfn_lock_nop,
cyg_flash_devfn_unlock_nop);
#endif
Index: devs/flash/sst/39vfxxx/current/ChangeLog
===================================================================
RCS file: /cvs/ecos/ecos/packages/devs/flash/sst/39vfxxx/current/ChangeLog,v
retrieving revision 1.1.2.6
diff -u -r1.1.2.6 ChangeLog
--- devs/flash/sst/39vfxxx/current/ChangeLog 29 Nov 2004 00:43:58 -0000 1.1.2.6
+++ devs/flash/sst/39vfxxx/current/ChangeLog 29 Nov 2004 13:57:10 -0000
@@ -1,5 +1,7 @@
2004-11-29 Bart Veer <bartv@ecoscentric.com>
+ * include/flash_sst_39vfxxx.inl: eliminate hwr_map_error(), no
+ longer needed by the generic flash code.
* include/flash_sst_39vfxxx.inl: use the dummy lock/unlock
functions provided by the generic flash code.
Index: devs/flash/sst/39vfxxx/current/include/flash_sst_39vfxxx.inl
===================================================================
RCS file: /cvs/ecos/ecos/packages/devs/flash/sst/39vfxxx/current/include/flash_sst_39vfxxx.inl,v
retrieving revision 1.1.2.6
diff -u -r1.1.2.6 flash_sst_39vfxxx.inl
--- devs/flash/sst/39vfxxx/current/include/flash_sst_39vfxxx.inl 29 Nov 2004 00:43:56 -0000 1.1.2.6
+++ devs/flash/sst/39vfxxx/current/include/flash_sst_39vfxxx.inl 29 Nov 2004 13:57:10 -0000
@@ -163,15 +163,6 @@
}
//----------------------------------------------------------------------------
-// Map a hardware status to a package error
-static int
-sst_hwr_map_error(struct cyg_flash_dev *dev, int err)
-{
- return err;
-}
-
-
-//----------------------------------------------------------------------------
// Flash Query
//
// Only reads the manufacturer and part number codes for the first
@@ -332,7 +323,6 @@
sst_erase_block,
sst_program,
NULL, // read
- sst_hwr_map_error,
cyg_flash_devfn_lock_nop,
cyg_flash_devfn_unlock_nop);
Index: devs/flash/synthv2/current/ChangeLog
===================================================================
RCS file: /cvs/ecos/ecos/packages/devs/flash/synthv2/current/Attic/ChangeLog,v
retrieving revision 1.1.2.8
diff -u -r1.1.2.8 ChangeLog
--- devs/flash/synthv2/current/ChangeLog 29 Nov 2004 00:43:55 -0000 1.1.2.8
+++ devs/flash/synthv2/current/ChangeLog 29 Nov 2004 13:57:10 -0000
@@ -1,5 +1,7 @@
2004-11-29 Bart Veer <bartv@ecoscentric.com>
+ * src/synth.c: eliminate hwr_map_error() support, no longer needed
+
* src/synth.c: use the dummy lock/unlock functions provided by the
generic flash package.
Index: devs/flash/synthv2/current/src/synth.c
===================================================================
RCS file: /cvs/ecos/ecos/packages/devs/flash/synthv2/current/src/Attic/synth.c,v
retrieving revision 1.1.2.5
diff -u -r1.1.2.5 synth.c
--- devs/flash/synthv2/current/src/synth.c 29 Nov 2004 00:43:54 -0000 1.1.2.5
+++ devs/flash/synthv2/current/src/synth.c 29 Nov 2004 13:57:10 -0000
@@ -169,13 +169,6 @@
return CYG_FLASH_ERR_OK;
}
-// Map a hardware status to a package error
-static int
-synth_flash_hwr_map_error(struct cyg_flash_dev *dev, int err)
-{
- return err;
-}
-
/* This helps speed up the erase. */
static char empty[4096];
static cyg_bool empty_inited = false;
@@ -262,7 +255,6 @@
synth_flash_erase_block,
synth_flash_program,
NULL, // read
- synth_flash_hwr_map_error,
cyg_flash_devfn_lock_nop,
cyg_flash_devfn_unlock_nop);