changeset 3395:707de7f35fc7

io/nand: Minor doc updates
author Ross Younger <wry@ecoscentric.com>
date Tue, 02 Dec 2014 12:13:34 +1300
parents 7905ed422fdf
children ca49a7404897
files packages/io/nand/current/ChangeLog packages/io/nand/current/doc/nand.sgml
diffstat 2 files changed, 8 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/packages/io/nand/current/ChangeLog
+++ b/packages/io/nand/current/ChangeLog
@@ -3,6 +3,7 @@ 2014-12-02  Ross Younger  <wry@ecoscentr
 	* cdl/nand.cdl tests/nand_readlimits.c tests/nand_readwrite.c
 	* tests/nand_rwbenchmark.c: Rename CYGINT_IO_NAND_TEST_PARTITION to
 	CYGNUM_IO_NAND_TEST_PARTITION.
+	* doc/nand.sgml: Minor updates.
 
 2014-12-01  Ross Younger  <wry@ecoscentric.com>
 
--- a/packages/io/nand/current/doc/nand.sgml
+++ b/packages/io/nand/current/doc/nand.sgml
@@ -339,6 +339,7 @@ size_t chipsize_log; // log2 of total ch
 #define CYG_NAND_PAGECOUNT(dev) (NAND_BLOCKCOUNT(dev) * NAND_PAGES_PER_BLOCK(dev))
 #define CYG_NAND_CHIPSIZE(dev) (1&lt;&lt;(dev)->chipsize_log)
 #define CYG_NAND_APPSPARE_PER_PAGE(dev) ((dev)->oob->app_size)
+#define CYG_NAND_BYTES_PER_BLOCK(dev)   (1&lt;&lt;( (dev)->block_page_bits + (dev)->page_bits ))
 
 </programlisting>
 </para>
@@ -1162,7 +1163,10 @@ int my_ecc_repair(struct _cyg_nand_devic
 <para>In some cases - particularly where hardware assistance is in use -
 it is necessary to specify different functions
 for calculating the ECC depending on whether the operation at hand is
-a page read or a page write. In that case, two <emphasis>calc</emphasis>
+a page read or a page write. In that case, two 
+<emphasis>init</emphasis>
+and
+<emphasis>calc</emphasis>
 functions may be supplied, each taking the same prototype.
 </para>
 
@@ -1176,6 +1180,8 @@ CYG_NAND_ECC_ALG_SW(my_ecc, _datasize, _
 CYG_NAND_ECC_ALG_HW(my_ecc, _datasize, _eccsize, my_ecc_init, my_ecc_calc, my_ecc_repair);
 
 CYG_NAND_ECC_ALG_HW2(my_ecc, _datasize, _eccsize, my_ecc_init, my_ecc_calc_read, my_ecc_calc_write, my_ecc_repair);
+
+CYG_NAND_ECC_ALG_HW3(my_ecc, _datasize, _eccsize, my_ecc_init_read, my_ecc_init_write, my_ecc_calc_read, my_ecc_calc_write, my_ecc_repair);
 </programlisting>
 
 <tip><para>