This is the mail archive of the ecos-patches@sourceware.org mailing list for the eCos project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

mkromfs doc improvement


As per http://bugs.ecos.sourceware.org/show_bug.cgi?id=1000293

2008-08-14  Klaas Gadeyne  <klaas.gadeyne@fmtc.be>
2008-08-14  Jonathan Larmour  <jifl@eCosCentric.com>

        * doc/mk_romfs.txt (Usage): Remove documentation about obsolete
        CYGNUM_FS_ROM_BASE_ADDRESS option, and replace with better
        usage description.

-- 
eCosCentric Limited      http://www.eCosCentric.com/     The eCos experts
Barnwell House, Barnwell Drive, Cambridge, UK.       Tel: +44 1223 245571
Registered in England and Wales: Reg No 4422071.
------["Si fractum non sit, noli id reficere"]------       Opinions==mine
Index: doc/mk_romfs.txt
===================================================================
RCS file: /cvs/ecos/ecos/packages/fs/rom/current/doc/mk_romfs.txt,v
retrieving revision 1.1
diff -u -5 -p -r1.1 mk_romfs.txt
--- doc/mk_romfs.txt	6 Apr 2001 17:20:20 -0000	1.1
+++ doc/mk_romfs.txt	14 Aug 2008 19:04:18 -0000
@@ -86,9 +86,26 @@ For example, suppose you wish to access 
 	FIS directory     0x503E0000   0x503E0000  0x020000  0x00000000
 	RomFs             0x50040000   0x01000000  0x000940  0x00000000
 	RedBoot>
 
 6. MAKE A NOTE OF THE ADDRESS IN FLASH THAT THE IMAGE IS LOADED AT.
-   The ROMFS option 'CYGNUM_FS_ROM_BASE_ADDRESS' needs to be set to this
-   value in order to access the filesystem.
-  
 
+   This address can then be used in your program in order to mount the
+   filesystem.
+
+   For example, to automatically mount the new romfs created above at
+   /rom, you can use the following macro in your application:
+
+       MTAB_ENTRY( romfs_mte1,
+                   "/rom",
+                   "romfs",
+                   "",
+                   (CYG_ADDRWORD) 0x50040000 );
+
+   See the File I/O package documentation in the eCos Reference Manual
+   ("Writing a New Filesystem") for more information about the MTAB_ENTRY
+   macro.
+
+   Alternatively, the filesystem can be dynamically mounted with a call
+   to mount() such as the following:
+
+     err = mount( "0x50040000", "/rom", "romfs" );

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]