Changeset 4517fa3 in rtems-libbsd for libbsd.txt


Ignore:
Timestamp:
Jun 1, 2015, 12:51:57 AM (4 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.11, 7ece7548c1b05cf6bb10e6708b83b2401d45c250, freebsd-9.3, 29cc431e0bcfe059d65ac3019f53eeafa5064ae8
Children:
8440506
Parents:
1383c80
Message:

Update LibBSD doco.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • libbsd.txt

    r1383c80 r4517fa3  
    115115
    116116=== BSD Library Configuration and Build ===
     117
     118There are currently 2 build systems supported. The first is based on the RTEMS
     119Makefile support in RTEMS and installed with the BSP and the second is a stand
     120alone environment based on the Waf build system. The Makefile build system will
     121be removed when RTEMS moves away from its existing build system and Waf will
     122be the preferred build environment.
     123
     124To build with Waf please refer to the README.waf file.
     125
     126===== Makefile Building =====
    117127
    118128In the BSD library source directory edit the file `config.inc`.  Continuing on
     
    340350
    341351* Adapt generic IRQ PIC interface code to Simple Vectored Interrupt Model
    342   so that those architectures can use new TCP/IP and USB code. 
     352  so that those architectures can use new TCP/IP and USB code.
    343353
    344354* freebsd-userspace/rtems/include/sys/syslog.h is a copy from the old
     
    397407interrupt source is enabled again.
    398408
    399 * Convert all BSP linkcmds to use a linkcmds.base so the sections are 
     409* Convert all BSP linkcmds to use a linkcmds.base so the sections are
    400410easier to insert.
    401411
     
    407417static hint to tell the fxp driver the correct mode. But this needs to
    408418be addressed.
    409 - The ISA drivers require more BSD infrastructure to be addressed. This was 
     419- The ISA drivers require more BSD infrastructure to be addressed. This was
    410420outside the scope of the initial porting effort.
    411421
     
    527537In its default mode of operation, freebsd-to-rtems.py is used to copy code
    528538from FreeBSD to the rtems-libbsd tree and perform transformations.  In forward
    529 mode, the script may be requested to just generate the Makefile.
    530 
    531 In "reverse mode", this script undoes those transformations and copies 
    532 the source code back to the FreeBSD SVN tree. This allows us to do 
     539mode, the script may be requested to just generate the Makefile and Waf script.
     540
     541In "reverse mode", this script undoes those transformations and copies
     542the source code back to the FreeBSD SVN tree. This allows us to do
    533543'svn diff', evaluate changes made by the RTEMS Project, and report changes
    534544back to FreeBSD upstream.
     
    732742* net - name of SYSCTL_NODE
    733743* children - added by SYSCTL macros
    734  
     744
    735745This was all generated by a support macro declaring the node as this:
    736746
     
    739749----
    740750
    741 Given this information, we located this SYSCTL_NODE declaration in 
     751Given this information, we located this SYSCTL_NODE declaration in
    742752kern/kern_mib.c
    743753
     
    863873
    864874rtems-libbsd File:      rtems-bsd-autoconf.c
    865 FreeBSD File:           FreeBSD has BSP specific autoconf.c 
     875FreeBSD File:           FreeBSD has BSP specific autoconf.c
    866876Description:            This file contains configuration methods that are used to setup the system.
    867 Status:                 USB 
     877Status:                 USB
    868878
    869879rtems-libbsd File:      rtems-bsd-bus-dma.c
    870880FreeBSD File:           FreeBSD has BSP specific busdma_machdep.c
    871 Description:           
    872 Status:                 USB, Nic 
    873 
    874 rtems-libbsd File:      rtems-bsd-bus-dma-mbuf.c       
     881Description:
     882Status:                 USB, Nic
     883
     884rtems-libbsd File:      rtems-bsd-bus-dma-mbuf.c
    875885FreeBSD File:           FreeBSD has BSP specific busdma_machdep.c
    876 Description:           
     886Description:
    877887Status:                 Nic
    878888
    879 rtems-libbsd File:      rtems-bsd-callout.c             
     889rtems-libbsd File:      rtems-bsd-callout.c
    880890FreeBSD File:           kern/kern_timeout.c
    881 Description:           
    882 Status:                 USB, Nic 
     891Description:
     892Status:                 USB, Nic
    883893
    884894rtems-libbsd File:      rtems-bsd-cam.c
    885895FreeBSD File:           cam/cam_sim.c
    886 Description:           
    887 Status:                 USB 
    888 
    889 rtems-libbsd File:      rtems-bsd-condvar.c             
     896Description:
     897Status:                 USB
     898
     899rtems-libbsd File:      rtems-bsd-condvar.c
    890900FreeBSD File:           kern/kern_condvar.c
    891 Description:           
    892 Status:                 USB 
     901Description:
     902Status:                 USB
    893903
    894904rtems-libbsd File:      rtems-bsd-copyinout.c
    895905FreeBSD File:           bsp specific copyinout.c )
    896906Description:            Note: The FreeBSD file is split with some methods being in rtems-bsd-support
    897 Status:                 Nic 
     907Status:                 Nic
    898908
    899909rtems-libbsd File:      rtems-bsd-delay.c
    900910FreeBSD File:           bsp specific file with multiple names
    901 Description:           
    902 Status:                 USB, Nic 
    903 
    904 rtems-libbsd File:      rtems-bsd-descrip.c 
     911Description:
     912Status:                 USB, Nic
     913
     914rtems-libbsd File:      rtems-bsd-descrip.c
    905915FreeBSD File:           kern/kern_descrip.c
    906 Description:           
    907 Status:                 Nic 
    908 
    909 rtems-libbsd File:      rtems-bsd-generic.c             
     916Description:
     917Status:                 Nic
     918
     919rtems-libbsd File:      rtems-bsd-generic.c
    910920FreeBSD File:           kern/sys_generic.c
    911 Description:           
    912 Status:                 Nic 
    913 
    914 rtems-libbsd File:      rtems-bsd-init.c 
     921Description:
     922Status:                 Nic
     923
     924rtems-libbsd File:      rtems-bsd-init.c
    915925FreeBSD File:           N/A
    916 Description:           
    917 Status:                 USB, Nic 
     926Description:
     927Status:                 USB, Nic
    918928
    919929rtems-libbsd File:      rtems-bsd-init-with-irq.c
    920930FreeBSD File:           N/A
    921 Description:           
    922 Status:                 USB, Nic 
     931Description:
     932Status:                 USB, Nic
    923933
    924934rtems-libbsd File:      rtems-bsd-jail.c
    925935FreeBSD File:           kern/kern_jail.c
    926 Description:           
    927 Status:                 USB, Nic 
     936Description:
     937Status:                 USB, Nic
    928938
    929939rtems-libbsd File:      rtems-bsd-lock.c
    930940FreeBSD File:           kern/subr_lock.c
    931 Description:           
    932 Status:                 USB, Nic 
    933 
    934 rtems-libbsd File:      rtems-bsd-log.c         
     941Description:
     942Status:                 USB, Nic
     943
     944rtems-libbsd File:      rtems-bsd-log.c
    935945FreeBSD File:           kern/subr_prf.c
    936 Description:           
    937 Status:                 Nic 
     946Description:
     947Status:                 Nic
    938948
    939949rtems-libbsd File:      rtems-bsd-malloc.c
    940950FreeBSD File:           kern/kern_malloc.c
    941 Description:           
    942 Status:                 USB, Nic 
     951Description:
     952Status:                 USB, Nic
    943953
    944954rtems-libbsd File:      rtems-bsd-mutex.c
    945955FreeBSD File:           kern/kern_mutex.c
    946 Description:           
    947 Status:                 USB, Nic 
     956Description:
     957Status:                 USB, Nic
    948958
    949959rtems-libbsd File:      rtems-bsd-newproc.c
    950960FreeBSD File:           N/A
    951 Description:           
    952 Status:                 Nic 
     961Description:
     962Status:                 Nic
    953963
    954964rtems-libbsd File:      rtems-bsd-nexus.c
    955965FreeBSD File:           bsp specific nexus.c
    956 Description:           
    957 Status:                 USB 
    958 
    959 rtems-libbsd File:      rtems-bsd-panic.c               
     966Description:
     967Status:                 USB
     968
     969rtems-libbsd File:      rtems-bsd-panic.c
    960970FreeBSD File:           boot/common/panic.c
    961 Description:           
    962 Status:                 USB, Nic 
    963 
    964 rtems-libbsd File:      rtems-bsd-rwlock.c             
     971Description:
     972Status:                 USB, Nic
     973
     974rtems-libbsd File:      rtems-bsd-rwlock.c
    965975FreeBSD File:           kern_rwlock.c
    966 Description:           
    967 Status:                 USB, Nic 
    968 
    969 rtems-libbsd File:      rtems-bsd-shell.c               
     976Description:
     977Status:                 USB, Nic
     978
     979rtems-libbsd File:      rtems-bsd-shell.c
    970980FreeBSD File:           N/A
    971 Description:           
    972 Status:                 USB 
    973 
    974 rtems-libbsd File:      rtems-bsd-signal.c             
     981Description:
     982Status:                 USB
     983
     984rtems-libbsd File:      rtems-bsd-signal.c
    975985FreeBSD File:           kern/kern_sig.c
    976 Description:           
    977 Status:                 Nic 
    978 
    979 rtems-libbsd File:      rtems-bsd-smp.c                 
     986Description:
     987Status:                 Nic
     988
     989rtems-libbsd File:      rtems-bsd-smp.c
    980990FreeBSD File:           N/A
    981 Description:           
    982 Status:                 Nic 
    983 
    984 rtems-libbsd File:      rtems-bsd-support.c             
    985 FreeBSD File:           bsp specific copyinout.c 
     991Description:
     992Status:                 Nic
     993
     994rtems-libbsd File:      rtems-bsd-support.c
     995FreeBSD File:           bsp specific copyinout.c
    986996Description:            Note: the FreeBSD file is split with some methods being in rtems-bsd-copyinout.
    987 Status:                 USB, Nic 
    988 
    989 rtems-libbsd File:      rtems-bsd-sx.c                 
     997Status:                 USB, Nic
     998
     999rtems-libbsd File:      rtems-bsd-sx.c
    9901000FreeBSD File:           kern/kern_sx.c
    991 Description:            Status: USB, Nic 
    992 
    993 rtems-libbsd File:      rtems-bsd-synch.c               
     1001Description:            Status: USB, Nic
     1002
     1003rtems-libbsd File:      rtems-bsd-synch.c
    9941004FreeBSD File:           kern/kern_synch.c
    995 Description:           
    996 Status:                 USB, Nic 
    997 
    998 rtems-libbsd File:      rtems-bsd-syscalls.c           
     1005Description:
     1006Status:                 USB, Nic
     1007
     1008rtems-libbsd File:      rtems-bsd-syscalls.c
    9991009FreeBSD File:           User API for kern/uipc_syscalls.c
    1000 Description:           
    1001 Status:                 Nic 
    1002 
    1003 rtems-libbsd File:      rtems-bsd-sysctlbyname.c       
     1010Description:
     1011Status:                 Nic
     1012
     1013rtems-libbsd File:      rtems-bsd-sysctlbyname.c
    10041014FreeBSD File:           User API for sysctlbyname(3)
    1005 Description:           
    1006 Status: 
    1007 
    1008 rtems-libbsd File:      rtems-bsd-sysctl.c             
     1015Description:
     1016Status:
     1017
     1018rtems-libbsd File:      rtems-bsd-sysctl.c
    10091019FreeBSD File:           User API for sysctl(8)
    1010 Description:           
    1011 Status: 
    1012 
    1013 rtems-libbsd File:      rtems-bsd-sysctlnametomib.c     
     1020Description:
     1021Status:
     1022
     1023rtems-libbsd File:      rtems-bsd-sysctlnametomib.c
    10141024FreeBSD File:           User API for sysctlnametomib
    1015 Description:           
    1016 Status: 
    1017 
    1018 rtems-libbsd File:      rtems-bsd-taskqueue.c           
     1025Description:
     1026Status:
     1027
     1028rtems-libbsd File:      rtems-bsd-taskqueue.c
    10191029FreeBSD File:           kern/subr_taskqueue.c
    1020 Description:           
    1021 Status:                 Nic 
    1022 
    1023 rtems-libbsd File:      rtems-bsd-thread.c                     
     1030Description:
     1031Status:                 Nic
     1032
     1033rtems-libbsd File:      rtems-bsd-thread.c
    10241034FreeBSD File:           kern/kern_kthread.c
    1025 Description:           
    1026 Status:                 USB, Nic 
    1027 
    1028 rtems-libbsd File:      rtems-bsd-timeout.c             
     1035Description:
     1036Status:                 USB, Nic
     1037
     1038rtems-libbsd File:      rtems-bsd-timeout.c
    10291039FreeBSD File:           kern/kern_timeout.c
    1030 Description:           
    1031 Status:                 Nic 
    1032 
    1033 rtems-libbsd File:      rtems-bsd-timesupport.c         
     1040Description:
     1041Status:                 Nic
     1042
     1043rtems-libbsd File:      rtems-bsd-timesupport.c
    10341044FreeBSD File:           kern/kern_clock.c
    1035 Description:           
    1036 Status:                 Nic 
    1037 
    1038 rtems-libbsd File:      rtems-bsd-vm_glue.c             
     1045Description:
     1046Status:                 Nic
     1047
     1048rtems-libbsd File:      rtems-bsd-vm_glue.c
    10391049FreeBSD File:           vm/vm_glue.c
    1040 Description:           
    1041 Status:                 USB, Nic 
     1050Description:
     1051Status:                 USB, Nic
    10421052----
    10431053
     
    10521062capability of supporting children did not appear to be needed and was
    10531063not implemented in the rtems version of these routines.
    1054  
     1064
    10551065== NICs Status ==
    10561066
     
    10581068Driver                  Symbol                          Status
    10591069======                  ======                          ======
    1060 RealTek                 _bsd_re_pcimodule_sys_init      Links 
     1070RealTek                 _bsd_re_pcimodule_sys_init      Links
    10611071EtherExpress            _bsd_fxp_pcimodule_sys_init     Links
    10621072DEC tulip               _bsd_dc_pcimodule_sys_init      Links
     
    10711081Symbols (A)
    10721082         pci_get_vpd_ident
    1073  
     1083
    10741084== Problems to report to FreeBSD ==
    10751085
    10761086The MMAP_NOT_AVAILABLE define is inverted on its usage.  When it is
    1077 defined the mmap method is called. Additionally, it is not used 
     1087defined the mmap method is called. Additionally, it is not used
    10781088thoroughly. It is not used in the unmap portion of the source.
    10791089The file rec_open.c uses the define MMAP_NOT_AVAILABLE to wrap
    10801090the call to mmap and file rec_close.c uses the munmap method.
    1081 
    1082 
    1083 
Note: See TracChangeset for help on using the changeset viewer.