# HG changeset patch
# User bartv
# Date 1101080899 0
# Node ID 6588c38f09cf20527ad125e8d83ca6a62e43eb8e
# Parent  a221170fac3dc228b6cc737d548d610ccee6ec0f
Document some CDL issues for complex setups

diff --git a/packages/devs/flash/amd/am29xxxxxv2/current/ChangeLog b/packages/devs/flash/amd/am29xxxxxv2/current/ChangeLog
--- a/packages/devs/flash/amd/am29xxxxxv2/current/ChangeLog
+++ b/packages/devs/flash/amd/am29xxxxxv2/current/ChangeLog
@@ -1,5 +1,8 @@
 2004-11-21  Bart Veer  <bartv@ecoscentric.com>
 
+	* doc/am29xxxxx.sgml: describe CDL implications for custom locking
+	functions and additional devices.
+	
 	* cdl/flash_am29xxxxx_v2.cdl: CYGHWR_IO_FLASH_DEVICE_V2 is now
 	implicit
 
diff --git a/packages/devs/flash/amd/am29xxxxxv2/current/doc/am29xxxxx.sgml b/packages/devs/flash/amd/am29xxxxxv2/current/doc/am29xxxxx.sgml
--- a/packages/devs/flash/amd/am29xxxxxv2/current/doc/am29xxxxx.sgml
+++ b/packages/devs/flash/amd/am29xxxxxv2/current/doc/am29xxxxx.sgml
@@ -515,6 +515,13 @@ alaia_unlock(struct cyg_flash_dev* dev, 
     &hellip;
 }
       </programlisting>
+      <para>
+If real locking functions are implemented then the platform HAL's CDL
+script should implement the CDL interface
+<varname>CYGHWR_IO_FLASH_BLOCK_LOCKING</varname>. Otherwise the
+generic flash package may believe that none of the flash drivers in the
+system provide locking functionality and disable the interface functions.
+      </para>
     </refsect2>
 
     <refsect2 id="am29xxxxx-instance-functions-other"><title>Other</title>
@@ -687,6 +694,13 @@ while there is also a much larger and fa
 system. Such variations are usually best described by separate
 <structname>cyg_flash_dev</structname> structures.
     </para>
+    <para>
+If more than one <structname>cyg_flash_dev</structname> structure is
+instantiated then the platform HAL's CDL script should implement the
+CDL interface <varname>CYGHWR_IO_FLASH_DEVICE</varname> once for every
+device past the first. Otherwise the generic code may default to the
+case of a single flash device and optimize for that.
+    </para>
   </refsect1>
 
   <refsect1 id="am29xxxxx-instance-platform"><title>Platform-Specific Macros</title>