[rtems-libbsd commit] Added documentation on rtems specific files.

[Jennifer Averett]

Module:    rtems-libbsd
Branch:    master
Commit:    5ab1e1daa7d61569e1e16de5ad0f3088e3225616
Changeset: http://git.rtems.org/rtems-libbsd/commit/?id=5ab1e1daa7d61569e1e16de5ad0f3088e3225616

Author:    Jennifer Averett <jennifer.averett at oarcorp.com>
Date:      Tue May  8 09:29:22 2012 -0500

Added documentation on rtems specific files.

---

 libbsd.txt |  193 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 193 insertions(+), 0 deletions(-)

diff --git a/libbsd.txt b/libbsd.txt
index 6070c19..aeeb17f 100644
--- a/libbsd.txt
+++ b/libbsd.txt
@@ -467,6 +467,8 @@ POSIX r/w lock.
 
 === RMLOCK(9) (Reader/writer lock optimized for mostly read access patterns) ===
 
+Note:  This object was implemented as a wrapper for RWLOCK in the rm_lock header file.
+
 http://www.freebsd.org/cgi/man.cgi?query=rmlock
 
 POSIX r/w lock.
@@ -544,3 +546,194 @@ http://www.freebsd.org/cgi/man.cgi?query=bus_dma
 Likely BSP dependent.  A default implementation for memory mapped linear access
 is easy to provide.  The current heap implementation supports all properties
 demanded by bus_dma (including the boundary constraint).
+
+== RTEMS Replacements by File Description and Status ==
+
+Note:  Files with a status of USB are used by the USB test and have at least
+been partially tested.  If they contain both USB and Nic, then they are used
+by both and MAY contain methods that have not been tested yet.  Files that
+are only used by the Nic test are the most suspect.
+
+rtems-libbsd File:	rtems-bsd-assert.c
+FreeBSD File: 		rtems-bsd-config.h redefines BSD_ASSERT.
+Description:		This file contains the support method rtems_bsd_assert_func().
+Status: 		USB, Nic
+
+rtems-libbsd File:	rtems-bsd-autoconf.c
+FreeBSD File:		FreeBSD has BSP specific autoconf.c 
+Description:		This file contains configuration methods that are used to setup the system.
+Status: 		USB 
+
+rtems-libbsd File:	rtems-bsd-bus-dma.c
+FreeBSD File:		FreeBSD has BSP specific busdma_machdep.c
+Description:		
+Status: 		USB, Nic 
+
+rtems-libbsd File:	rtems-bsd-bus-dma-mbuf.c  	
+FreeBSD File:		FreeBSD has BSP specific busdma_machdep.c
+Description:		
+Status: 		Nic
+
+rtems-libbsd File:	rtems-bsd-callout.c     	 
+FreeBSD File:		kern/kern_timeout.c
+Description:		
+Status: 		USB, Nic 
+
+rtems-libbsd File:	rtems-bsd-cam.c
+FreeBSD File:		cam/cam_sim.c
+Description:		
+Status: 		USB 
+
+rtems-libbsd File:	rtems-bsd-condvar.c      	 
+FreeBSD File:		kern/kern_condvar.c
+Description:		
+Status: 		USB 
+
+rtems-libbsd File:	rtems-bsd-copyinout.c
+FreeBSD File: 		bsp specific copyinout.c )
+Description:		Note: The FreeBSD file is split with some methods being in rtems-bsd-support
+Status:			Nic 
+
+rtems-libbsd File: 	rtems-bsd-delay.c
+FreeBSD File:		bsp specific file with multiple names
+Description:		
+Status: 		USB, Nic 
+
+rtems-libbsd File: 	rtems-bsd-descrip.c 
+FreeBSD File:		kern/kern_descrip.c
+Description:		
+Status: 		Nic 
+
+rtems-libbsd File: 	rtems-bsd-generic.c		
+FreeBSD File:		kern/sys_generic.c
+Description:		
+Status: 		Nic 
+
+rtems-libbsd File:	rtems-bsd-init.c 
+FreeBSD File:		N/A
+Description:		
+Status: 		USB, Nic 
+
+rtems-libbsd File:	rtems-bsd-init-with-irq.c
+FreeBSD File:		N/A
+Description:		
+Status: 		USB, Nic 
+
+rtems-libbsd File:	rtems-bsd-jail.c
+FreeBSD File:		kern/kern_jail.c
+Description:		
+Status: 		USB, Nic 
+
+rtems-libbsd File:	rtems-bsd-lock.c
+FreeBSD File:		kern/subr_lock.c
+Description:		
+Status: 		USB, Nic 
+
+rtems-libbsd File:	rtems-bsd-log.c		
+FreeBSD File:		kern/subr_prf.c
+Description:		
+Status: 		Nic 
+
+rtems-libbsd File:	rtems-bsd-malloc.c
+FreeBSD File:		kern/kern_malloc.c
+Description:		
+Status: 		USB, Nic 
+
+rtems-libbsd File: 	rtems-bsd-mutex.c
+FreeBSD File:		kern/kern_mutex.c
+Description:		
+Status: 		USB, Nic 
+
+rtems-libbsd File:	rtems-bsd-newproc.c
+FreeBSD File:		N/A
+Description:		
+Status: 		Nic 
+
+rtems-libbsd File: 	rtems-bsd-nexus.c
+FreeBSD File:		bsp specific nexus.c
+Description:		
+Status: 		USB 
+
+rtems-libbsd File:	rtems-bsd-panic.c        	 
+FreeBSD File:		boot/common/panic.c
+Description:		
+Status: 		USB, Nic 
+
+rtems-libbsd File:	rtems-bsd-rwlock.c        	
+FreeBSD File:		kern_rwlock.c
+Description:		
+Status: 		USB, Nic 
+
+rtems-libbsd File:	rtems-bsd-shell.c         	
+FreeBSD File:		N/A
+Description:		
+Status: 		USB 
+
+rtems-libbsd File:	rtems-bsd-signal.c        	
+FreeBSD File:		kern/kern_sig.c
+Description:		
+Status: 		Nic 
+
+rtems-libbsd File: 	rtems-bsd-smp.c          	
+FreeBSD File:		N/A
+Description:		
+Status: 		Nic 
+
+rtems-libbsd File:	rtems-bsd-support.c      	
+FreeBSD File:		bsp specific copyinout.c 
+Description:		Note: the FreeBSD file is split with some methods being in rtems-bsd-copyinout.
+Status: 		USB, Nic 
+
+rtems-libbsd File:	rtems-bsd-sx.c            	
+FreeBSD File:		kern/kern_sx.c
+Description:		Status: USB, Nic 
+
+rtems-libbsd File: 	rtems-bsd-synch.c		
+FreeBSD File:		kern/kern_synch.c
+Description:		
+Status: 		USB, Nic 
+
+rtems-libbsd File: 	rtems-bsd-syscalls.c		
+FreeBSD File:		User API for kern/uipc_syscalls.c
+Description:		
+Status: 		Nic 
+
+rtems-libbsd File: 	rtems-bsd-sysctlbyname.c	
+FreeBSD File:		User API for sysctlbyname(3)
+Description:		
+Status: 
+
+rtems-libbsd File: 	rtems-bsd-sysctl.c		
+FreeBSD File:		User API for sysctl(8)
+Description:		
+Status: 
+
+rtems-libbsd File: 	rtems-bsd-sysctlnametomib.c	
+FreeBSD File:		User API for sysctlnametomib
+Description:		
+Status: 
+
+rtems-libbsd File:	rtems-bsd-taskqueue.c		
+FreeBSD File:		kern/subr_taskqueue.c
+Description:		
+Status: 		Nic 
+
+rtems-libbsd File: 	rtems-bsd-thread.c			
+FreeBSD File:		kern/kern_kthread.c
+Description:		
+Status: 		USB, Nic 
+
+rtems-libbsd File:	rtems-bsd-timeout.c		
+FreeBSD File:		kern/kern_timeout.c
+Description:		
+Status: 		Nic 
+
+rtems-libbsd File: 	rtems-bsd-timesupport.c		
+FreeBSD File:		kern/kern_clock.c
+Description:		
+Status: 		Nic 
+
+rtems-libbsd File: 	rtems-bsd-vm_glue.c		
+FreeBSD File:		vm/vm_glue.c
+Description:		
+Status: 		USB, Nic